Include worker test in on-device test app

Exercise the `--worker` option in the on-device test app. This requires
raising the SDK version to 30.

Author: dbnicholson

ci/makefiles/android.mk

@@ -6,7 +6,7 @@ ANDROID_NDK_VERSION_LEGACY ?= 21e
 ANDROID_SDK_TOOLS_VERSION ?= 6514223
 ANDROID_SDK_BUILD_TOOLS_VERSION ?= 29.0.3
 ANDROID_HOME ?= $(HOME)/.android
-ANDROID_API_LEVEL ?= 27
+ANDROID_API_LEVEL ?= 30
 
 # per OS dictionary-like
 UNAME_S := $(shell uname -s)

testapps/on_device_unit_tests/setup.py

@@ -42,39 +42,42 @@
             'requirements':
                 'sqlite3,libffi,openssl,pyjnius,kivy,python3,requests,urllib3,'
                 'chardet,idna',
-            'android-api': 27,
+            'android-api': 30,
             'ndk-api': 21,
             'dist-name': 'bdist_unit_tests_app',
             'arch': 'armeabi-v7a',
             'bootstrap': 'sdl2',
             'permissions': ['INTERNET', 'VIBRATE'],
             'orientation': ['portrait', 'landscape'],
             'service': 'P4a_test_service:app_service.py',
+            'worker': 'P4a_test_worker:app_worker.py',
         },
     'aab':
         {
             'requirements':
                 'sqlite3,libffi,openssl,pyjnius,kivy,python3,requests,urllib3,'
                 'chardet,idna',
-            'android-api': 27,
+            'android-api': 30,
             'ndk-api': 21,
             'dist-name': 'bdist_unit_tests_app',
             'arch': 'armeabi-v7a',
             'bootstrap': 'sdl2',
             'permissions': ['INTERNET', 'VIBRATE'],
             'orientation': ['portrait', 'landscape'],
             'service': 'P4a_test_service:app_service.py',
+            'worker': 'P4a_test_worker:app_worker.py',
         },
     'aar':
         {
             'requirements': 'python3',
-            'android-api': 27,
+            'android-api': 30,
             'ndk-api': 21,
             'dist-name': 'bdist_unit_tests_app',
             'arch': 'arm64-v8a',
             'bootstrap': 'service_library',
             'permissions': ['INTERNET', 'VIBRATE'],
             'service': 'P4a_test_service:app_service.py',
+            'worker': 'P4a_test_worker:app_worker.py',
         }
 }
 

testapps/on_device_unit_tests/test_app/app_flask.py

@@ -26,6 +26,7 @@
     get_failed_unittests_from,
     vibrate_with_pyjnius,
     get_android_python_activity,
+    get_work_manager,
     set_device_orientation,
     setup_lifecycle_callbacks,
     skip_if_not_running_from_android_device,
@@ -37,10 +38,12 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         setup_lifecycle_callbacks()
         self.service_running = False
+        self.work_request = None
 
     def get_status(self):
         return jsonify({
             'service_running': self.service_running,
+            'worker_running': self.worker_running,
         })
 
     @property
@@ -62,6 +65,58 @@ def service_stop(self):
         self.service.stop(activity)
         self.service_running = False
 
+    @property
+    @skip_if_not_running_from_android_device
+    def P4a_test_workerWorker(self):
+        from jnius import autoclass
+
+        return autoclass('org.test.unit_tests_app.P4a_test_workerWorker')
+
+    @skip_if_not_running_from_android_device
+    def worker_start(self):
+        from jnius import autoclass
+
+        if self.worker_running:
+            return
+
+        OneTimeWorkRequestBuilder = autoclass('androidx.work.OneTimeWorkRequest$Builder')
+        data = self.P4a_test_workerWorker.buildInputData('10')
+        self.work_request = (
+            OneTimeWorkRequestBuilder(self.P4a_test_workerWorker._class)
+            .setInputData(data)
+            .build()
+        )
+        work_manager = get_work_manager()
+        op = work_manager.enqueue(self.work_request)
+        op.getResult().get()
+
+    @skip_if_not_running_from_android_device
+    def worker_stop(self):
+        if self.worker_running:
+            work_manager = get_work_manager()
+            op = work_manager.cancelWorkById(self.work_request.getId())
+            op.getResult().get()
+
+    @property
+    @skip_if_not_running_from_android_device
+    def work_info(self):
+        if self.work_request is None:
+            return None
+
+        work_manager = get_work_manager()
+        return work_manager.getWorkInfoById(self.work_request.getId()).get()
+
+    @property
+    @skip_if_not_running_from_android_device
+    def worker_running(self):
+        info = self.work_info
+        if info is None:
+            print('Work request not started')
+            return False
+        state = info.getState()
+        print('Work request state:', state.toString())
+        return not state.isFinished()
+
 
 app = App(__name__)
 TESTS_TO_PERFORM = dict()
@@ -91,6 +146,7 @@ def index():
         'index.html',
         platform='Android' if RUNNING_ON_ANDROID else 'Desktop',
         service_running=current_app.service_running,
+        worker_running=current_app.worker_running,
     )
 
 
@@ -198,3 +254,23 @@ def service():
     else:
         current_app.service_stop()
     return ('', 204)
+
+
+@app.route('/worker')
+def worker():
+    if not RUNNING_ON_ANDROID:
+        print(NON_ANDROID_DEVICE_MSG, '...cancelled worker.')
+        return (NON_ANDROID_DEVICE_MSG, 400)
+    args = request.args
+    if 'action' not in args:
+        print('ERROR: asked to manage worker but no action specified')
+        return ('No action specified', 400)
+
+    action = args['action']
+    if action == 'start':
+        current_app.worker_start()
+    elif action == 'stop':
+        current_app.worker_stop()
+    else:
+        return ('Invalid action "{}"'.format(action), 400)
+    return ('', 204)

testapps/on_device_unit_tests/test_app/app_kivy.py

@@ -2,12 +2,15 @@
 
 import subprocess
 
+from android.runnable import run_on_ui_thread
 from os.path import split
 
 from kivy.app import App
 from kivy.clock import Clock
+from kivy.event import EventDispatcher
 from kivy.properties import (
     BooleanProperty,
+    BoundedNumericProperty,
     DictProperty,
     ListProperty,
     StringProperty,
@@ -19,11 +22,13 @@
     get_android_python_activity,
     get_failed_unittests_from,
     get_images_with_extension,
+    get_work_manager,
     load_kv_from,
     raise_error,
     run_test_suites_into_buffer,
     setup_lifecycle_callbacks,
     vibrate_with_pyjnius,
+    work_info_observer,
 )
 from widgets import TestImage
 
@@ -34,11 +39,79 @@
     ScreenKeyboard:
     ScreenOrientation:
     ScreenService:
+    ScreenWorker:
 '''
 load_kv_from('screen_unittests.kv')
 load_kv_from('screen_keyboard.kv')
 load_kv_from('screen_orientation.kv')
 load_kv_from('screen_service.kv')
+load_kv_from('screen_worker.kv')
+
+
+class Work(EventDispatcher):
+    '''Event dispatcher for WorkRequests'''
+
+    progress = BoundedNumericProperty(0, min=0, max=100)
+    state = StringProperty()
+    running = BooleanProperty(False)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        self._request = None
+        self._observer = work_info_observer(self.update)
+        self._live_data = None
+
+    def update(self, work_info):
+        progress_data = work_info.getProgress()
+        self.progress = progress_data.getInt('PROGRESS', 0)
+
+        state = work_info.getState()
+        self.state = state.name()
+        if state.isFinished():
+            self.running = False
+            self._live_data.removeObserver(self._observer)
+
+    def enqueue(self, data):
+        from jnius import autoclass
+
+        OneTimeWorkRequestBuilder = autoclass('androidx.work.OneTimeWorkRequest$Builder')
+        Worker = autoclass('org.test.unit_tests_app.P4a_test_workerWorker')
+
+        input_data = Worker.buildInputData(data)
+        self._request = (
+            OneTimeWorkRequestBuilder(Worker._class)
+            .setInputData(input_data)
+            .build()
+        )
+
+        work_manager = get_work_manager()
+        op = work_manager.enqueue(self._request)
+        op.getResult().get()
+
+        self.running = True
+        request_id = self._request.getId()
+        self._live_data = work_manager.getWorkInfoByIdLiveData(request_id)
+        self._add_observer()
+
+    def cancel(self):
+        if not self.running:
+            return
+
+        work_manager = get_work_manager()
+        request_id = self._request.getId()
+        op = work_manager.cancelWorkById(request_id)
+        op.getResult().get()
+
+    @run_on_ui_thread
+    def _add_observer(self):
+        self._live_data.observeForever(self._observer)
+
+    def on_progress(self, instance, progress):
+        print('work progress: {}%'.format(progress))
+
+    def on_state(self, instance, state):
+        print('work state:', state)
 
 
 class TestKivyApp(App):
@@ -51,6 +124,7 @@ class TestKivyApp(App):
 
     def build(self):
         self.reset_unittests_results()
+        self.work = Work()
         self.sm = Builder.load_string(screen_manager_app)
         return self.sm
 
@@ -165,3 +239,20 @@ def stop_service(self):
         service = self.service_time
         activity = get_android_python_activity()
         service.stop(activity)
+
+    def worker_button_pressed(self, *args):
+        if RUNNING_ON_ANDROID:
+            if not self.work.running:
+                print('Starting worker')
+                self.start_worker()
+            else:
+                print('Stopping worker')
+                self.stop_worker()
+        else:
+            raise_error('Worker test not supported on desktop')
+
+    def start_worker(self):
+        self.work.enqueue('10')
+
+    def stop_worker(self):
+        self.work.cancel()

testapps/on_device_unit_tests/test_app/app_worker.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import time
+
+from jnius import autoclass
+from os import environ
+
+DataBuilder = autoclass('androidx.work.Data$Builder')
+P4a_test_workerWorker = autoclass('org.test.unit_tests_app.P4a_test_workerWorker')
+
+
+def set_progress(progress):
+    progress_data = DataBuilder().putInt('PROGRESS', progress).build()
+    P4a_test_workerWorker.mWorker.setProgressAsync(progress_data)
+
+
+argument = environ.get('PYTHON_SERVICE_ARGUMENT', '')
+print(
+    'app_worker.py was successfully called with argument: "{}"'.format(
+        argument,
+    ),
+)
+
+try:
+    duration = int(argument)
+except ValueError:
+    duration = 60
+
+print('Running the test worker for {} seconds'.format(duration))
+
+remaining = duration
+while remaining > 0:
+    print(remaining, 'seconds remaining')
+
+    progress = int((100.0 * (duration - remaining)) / duration)
+    set_progress(progress)
+
+    remaining -= 1
+    time.sleep(1)
+set_progress(100)
+
+print('Exiting the test worker')

testapps/on_device_unit_tests/test_app/screen_unittests.kv

@@ -42,6 +42,10 @@
                         text: 'Test Service'
                         font_size: sp(FONT_SIZE_SUBTITLE)
                         on_press: root.parent.current = 'service'
+                    Button:
+                        text: 'Test Worker'
+                        font_size: sp(FONT_SIZE_SUBTITLE)
+                        on_press: root.parent.current = 'worker'
                 Image:
                     keep_ratio: False
                     allow_stretch: True