Merge ~jocave/testflinger-cli:notify-me into testflinger-cli:master

[Jonathan Cave]

I often reserve a device to do some testing, but while the device provisions I start doing something else and forget about it!

This basically works like the undistract-me tool to popup a desktop notification and play a bell sound to tell you your device is ready for you to use.

[Paul Larson (pwlars)]

Neat! Have you tried this on something like a server without the desktop bits to see how it behaves? I know, for instance, we probably wouldn't add -n for our polling in Jenkins jobs or anything, just want to make sure it wouldn't crash or something in that case.
It's too bad that things like print("\a") don't work reliably, that would make a nice simple solution

review: Approve

[Jeff Lane  (bladernr)]

This is pretty cool... I made one comment below, feel free to ignore.

[Jonathan Cave (jocave)]

I kinda forgot about this, partially because my local test install of it stopped working. I should possibly have a look at why.

Unmerged commits

b387364... by Jonathan Cave on 2021-04-29

Add: notify reserve ready with popup and sound

Add another flag to the submit command that allows the user to be
notifed when a job reaches the reserve phase or completes. This is
handy if you're waiting for provisioning and get distracted doing
something else.

diff --git a/snapcraft.yaml b/snapcraft.yaml
index 2a5d669..5366a1f 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -14,6 +14,8 @@ apps:
     plugs:
       - home
       - network
+      - desktop
+      - audio-playback
 
 parts:
   launcher:
@@ -24,3 +26,9 @@ parts:
   testflinger-cli:
     plugin: python
     source: .
+  notification-support:
+    plugin: nil
+    stage-packages:
+      - libnotify-bin
+      - pulseaudio-utils
+      - sound-theme-freedesktop
diff --git a/testflinger-cli.wrapper b/testflinger-cli.wrapper
index 9278862..71b3f66 100755
--- a/testflinger-cli.wrapper
+++ b/testflinger-cli.wrapper
@@ -1,4 +1,9 @@
 #!/bin/sh
 export LC_ALL=C.UTF-8
 export LANG=C.UTF-8
+papath="$XDG_RUNTIME_DIR/../pulse/native"
+if [ ! -e "$papath" ]; then
+    echo "Cannot not find '$papath'"
+fi
+export PULSE_SERVER="unix:$papath"
 exec testflinger-cli $@
diff --git a/testflinger_cli/__init__.py b/testflinger_cli/__init__.py
index e7d4332..da6e1ae 100644
--- a/testflinger_cli/__init__.py
+++ b/testflinger_cli/__init__.py
@@ -18,6 +18,7 @@
 import inspect
 import json
 import os
+import subprocess as sp
 import sys
 import time
 import yaml
@@ -131,6 +132,7 @@ class TestflingerCli:
         arg_submit.set_defaults(func=self.submit)
         arg_submit.add_argument('--poll', '-p', action='store_true')
         arg_submit.add_argument('--quiet', '-q', action='store_true')
+        arg_submit.add_argument('--notify', '-n', action='store_true')
         arg_submit.add_argument('filename')
 
         self.args = parser.parse_args()
@@ -214,6 +216,8 @@ class TestflingerCli:
             except Exception:
                 raise SystemExit(
                     'Unable to read file: {}'.format(self.args.filename))
+        if self.args.quiet:
+            self.args.notify = False
         job_id = self.submit_job_data(data)
         queue = yaml.safe_load(data).get('job_queue')
         self.history.new(job_id, queue)
@@ -223,7 +227,7 @@ class TestflingerCli:
             print('Job submitted successfully!')
             print('job_id: {}'.format(job_id))
         if self.args.poll:
-            self.do_poll(job_id)
+            self.do_poll(job_id, self.args.notify)
 
     def submit_job_data(self, data):
         """ Submit data that was generated or read from a file as a test job
@@ -317,10 +321,12 @@ class TestflingerCli:
             sys.exit(0)
         self.do_poll(self.args.job_id)
 
-    def do_poll(self, job_id):
+    def do_poll(self, job_id, notify=False):
         job_state = self.get_job_state(job_id)
         self.history.update(job_id, job_state)
         prev_queue_pos = None
+        sound_f = os.path.expandvars(
+            '$SNAP/usr/share/sounds/freedesktop/stereo/complete.oga')
         if job_state == 'waiting':
             print('This job is waiting on a node to become available.')
         while job_state != 'complete':
@@ -344,7 +350,17 @@ class TestflingerCli:
                     continue
                 if output:
                     print(output, end='', flush=True)
-                job_state = self.get_job_state(job_id)
+                new_job_state = self.get_job_state(job_id)
+                if new_job_state != job_state and new_job_state == 'reserve':
+                    if notify:
+                        cmd = ['notify-send', '-i', 'dialog-information',
+                               '-u', 'normal',
+                               'Job reached {} phase'.format(new_job_state)]
+                        sp.run(cmd, check=False)
+                        cmd = ['paplay', sound_f]
+                        sp.run(cmd, check=False, stdout=sp.DEVNULL,
+                               stderr=sp.DEVNULL)
+                job_state = new_job_state
                 self.history.update(job_id, job_state)
             except KeyboardInterrupt:
                 choice = input('\nCancel job {} before exiting '
@@ -357,7 +373,12 @@ class TestflingerCli:
                         self.do_cancel(job_id)
                 # Both y and n will allow the external handler deal with it
                 raise
-
+        if notify:
+            cmd = ['notify-send', '-i', 'dialog-information', '-u', 'normal',
+                   'Job completed']
+            sp.run(cmd, check=False)
+            cmd = ['paplay', sound_f]
+            sp.run(cmd, check=False, stdout=sp.DEVNULL, stderr=sp.DEVNULL)
         print(job_state)
 
     def jobs(self):