Merge lp:~kissiel/checkbox/sa-garbage-collection into lp:checkbox

[Maciej Kisielewski]

This MR brings garbage collection to Session Assisstant and Checkbox-Converged.

6726481 plainbox:session:assistant: add get_old_sessions function
ee5b43c plainbox:session:assistant: add delete_sessions function
ef34911 plainbox:session:assistant: bump usage expectations
d95b13b checkbox-touch: add py<->qml bits for session garbage collection
555f6f6 checkbox-touch:component: add 'delete sessions' button to resume page
9c203cc checkbox-touch: delete old sessions on startup
3b3541f checkbox-touch: add gcAndStartSession function
6fdaddb checkbox-touch: run session GC whenever starting a new session
5de5b0c checkbox-touch:autopilot: move select_two_tests_and_quit to top class
ecb84b3 checkbox-touch:autopilot: add garbage collection tests

[Sylvain Pineau (sylvain-pineau)]

A big +1, awesome feature.

review: Approve

=== modified file 'checkbox-touch/checkbox-touch.qml'
--- checkbox-touch/checkbox-touch.qml	2015-11-25 10:19:33 +0000
+++ checkbox-touch/checkbox-touch.qml	2016-01-06 20:45:00 +0000
@@ -150,6 +150,7 @@
     CheckboxTouchApplication {
         id: app
         py: py
+        property var incompleteSessions: []
         onAppReady: {
             console.log("Plainbox version " + plainboxVersion);
             console.log("Checkbox Touch version " + applicationVersion);
@@ -157,6 +158,10 @@
                 "checkbox_touch" : applicationVersion,
                 "plainbox" : plainboxVersion
             };
+            getIncompleteSessions(function(sessions) {
+                incompleteSessions = sessions;
+                resumeSessionPage.incompleteSessionCount = sessions.length;
+            });
             resumeOrStartSession();
         }
         onSessionReady: {
@@ -280,7 +285,14 @@
         onRestartSession: {
             pageStack.clear();
             pageStack.push(welcomePage);
-            app.startSession();
+            gcAndStartSession();
+        }
+        onDeleteIncomplete: {
+            app.deleteOldSessions(app.incompleteSessions, function() {
+                pageStack.clear();
+                pageStack.push(welcomePage);
+                app.startSession();
+            });
         }
     }
 
@@ -445,10 +457,10 @@
             } else {
                 if (result.errors_encountered) {
                     ErrorLogic.showError(mainView, i18n.tr("Could not resume session."),
-                                         app.startSession(),
+                                         gcAndStartSession(),
                                          i18n.tr("Start new session"));
                 } else {
-                    app.startSession();
+                    gcAndStartSession();
                 }
             }
         });
@@ -533,7 +545,7 @@
         var endTesting = function() {
             pageStack.clear();
             app.clearSession(function() {
-                app.startSession();
+                gcAndStartSession();
                 pageStack.push(welcomePage);
             });
         };
@@ -713,5 +725,12 @@
         }
         process_input();
     }
+    function gcAndStartSession() {
+        // delete sessions that won't be resumed (NOT incomplete sessions)
+        // and start a new session
+        app.deleteOldSessions([], function() {
+            app.startSession();
+        });
+    }
 
 }

=== modified file 'checkbox-touch/components/CheckboxTouchApplication.qml'
--- checkbox-touch/components/CheckboxTouchApplication.qml	2015-12-03 03:41:21 +0000
+++ checkbox-touch/components/CheckboxTouchApplication.qml	2016-01-06 20:45:00 +0000
@@ -176,6 +176,16 @@
             if (continuation_error) continuation_error(error);
         });
     }
+    function getIncompleteSessions(continuation) {
+        request("get_incomplete_sessions", [], continuation, function(error) {
+            console.error("Unable to get incomplete sessions")
+        });
+    }
+    function deleteOldSessions(sessionIds, continuation) {
+        request("delete_old_sessions", [sessionIds], continuation, function(error) {
+            console.error("Unable to remove old sessions")
+        });
+    }
 
     function rememberPassword(password, continuation) {
         // using low-level py.call() to 'silently' pass password string through pyotherside

=== modified file 'checkbox-touch/components/ResumeSessionPage.qml'
--- checkbox-touch/components/ResumeSessionPage.qml	2015-10-07 17:04:55 +0000
+++ checkbox-touch/components/ResumeSessionPage.qml	2016-01-06 20:45:00 +0000
@@ -31,9 +31,11 @@
 
 Page {
     property alias resumeText: resumeLabel.text
+    property var incompleteSessionCount: 0
     signal rerunLast();
     signal continueSession();
     signal restartSession();
+    signal deleteIncomplete();
 
     objectName: "resumeSessionPage"
     title: i18n.tr("Resume session")
@@ -66,6 +68,19 @@
         }
 
         LatchButton {
+            id: deleteIncompleteButton
+            objectName: "deleteIncompleteButton"
+            visible: incompleteSessionCount > 0
+            text: i18n.tr("Delete incomplete sessions (%0)".arg(incompleteSessionCount))
+            unlatchedColor: UbuntuColors.red
+            Layout.fillWidth: true
+            onLatchedClicked: {
+                deleteIncomplete();
+                columnLayout.latchGroup();
+            }
+        }
+
+        LatchButton {
             id: rerunButton
             objectName: "rerunButton"
             unlatchedColor: UbuntuColors.warmGrey

=== modified file 'checkbox-touch/py/checkbox_touch.py'
--- checkbox-touch/py/checkbox_touch.py	2015-12-10 12:51:05 +0000
+++ checkbox-touch/py/checkbox_touch.py	2016-01-06 20:45:00 +0000
@@ -487,6 +487,31 @@
                 if conn:
                     conn.close()
 
+    @view
+    def get_incomplete_sessions(self):
+        """Get ids of sessions with an 'incomplete' flag."""
+        self._incomplete_sessions = [
+            s[0] for s in self.assistant.get_old_sessions(
+                flags={'incomplete'}, allow_not_flagged=False)]
+        return self._incomplete_sessions
+
+    @view
+    def delete_old_sessions(self, additional_sessions):
+        """
+        Delete session storages.
+
+        :param additional_sessions:
+            List of ids of sessions that should be removed.
+
+        This function removes all complete sessions (i.e. the ones that session
+        assistant returns when get_old_sessions is run with the default params)
+        with the addition of the ones specified in the ``additional_sessions``
+        param.
+        """
+        garbage = [s[0] for s in self.assistant.get_old_sessions()]
+        garbage += additional_sessions
+        self.assistant.delete_sessions(garbage)
+
     def _get_user_directory_documents(self):
         xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or \
             os.path.expanduser('~/.config')

=== modified file 'checkbox-touch/tests/autopilot/checkbox_touch/__init__.py'
--- checkbox-touch/tests/autopilot/checkbox_touch/__init__.py	2015-09-18 14:28:20 +0000
+++ checkbox-touch/tests/autopilot/checkbox_touch/__init__.py	2016-01-06 20:45:00 +0000
@@ -89,6 +89,16 @@
             objectName='continueButton')
         self.pointing_device.click_object(continue_btn)
 
+    def select_two_tests_and_quit(self):
+        self.start_and_select_tests(
+            '2015.com.canonical.certification::normal', [
+                '2015.com.canonical.certification::autopilot/user-verify-1',
+                '2015.com.canonical.certification::autopilot/user-verify-2'])
+        # make sure that test is shown (therefore session has been started)
+        self.app.wait_select_single(
+            objectName='userInteractVerifyIntroPage', visible=True)
+        self.app.process.terminate()
+
     def process_sequence_of_clicks_on_pages(self, steps):
         """
         Do a sequence of clicks on simple page->component hierarchies.

=== modified file 'checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py'
--- checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2015-12-10 10:08:49 +0000
+++ checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2016-01-06 20:45:00 +0000
@@ -129,16 +129,6 @@
 
 
 class SessionResumeTests(checkbox_touch.ClickAppTestCase):
-    def select_two_tests_and_quit(self):
-        self.start_and_select_tests(
-            '2015.com.canonical.certification::normal', [
-                '2015.com.canonical.certification::autopilot/user-verify-1',
-                '2015.com.canonical.certification::autopilot/user-verify-2'])
-        # make sure that test is shown (therefore session has been started)
-        self.app.wait_select_single(
-            objectName='userInteractVerifyIntroPage', visible=True)
-        self.app.process.terminate()
-
     def test_rerun_after_resume(self):
         self.select_two_tests_and_quit()
         self.launch_application()
@@ -298,3 +288,45 @@
         ]
         self.process_sequence_of_clicks_on_pages(next_steps)
         self.check_results({'passed': '2', 'failed': '0', 'skipped': '0'})
+
+class GarbageCollectionTests(checkbox_touch.ClickAppTestCase):
+    def test_garbage_collection_popup_shown(self):
+        """Ensure popup is shown when there are candidates for removal."""
+        # start a session, then quit the app, to create dangling incomplete
+        # session
+        self.select_two_tests_and_quit()
+        self.launch_application()
+        # check if the button from session garbage collect popup is visible
+        self.app.wait_select_single(
+            objectName="deleteIncompleteButton", visible=True)
+
+    def test_restart_doesnt_remove(self):
+        self.select_two_tests_and_quit()
+        self.launch_application()
+        resume_page = self.app.wait_select_single(
+            objectName='resumeSessionPage', visible=True)
+        restart_btn = resume_page.wait_select_single(
+            objectName='restartButton')
+        self.pointing_device.click_object(restart_btn)
+        # quit the app
+        self.app.process.terminate()
+        self.launch_application()
+        # make sure the app still wants to garbage collect some sessions
+        # check if the button from session garbage collect popup is visible
+        self.app.wait_select_single(
+            objectName="deleteIncompleteButton", visible=True)
+
+    def test_remove_all_removes(self):
+        self.select_two_tests_and_quit()
+        self.launch_application()
+        delete_btn = self.app.wait_select_single(
+            objectName="deleteIncompleteButton", visible=True)
+        self.pointing_device.click_object(delete_btn)
+        # make sure the app behaves normally afterwards
+        self.skipResumeIfShown()
+        # quit the app
+        self.app.process.terminate()
+        self.launch_application()
+        # make sure that app doens't show garbage collection dialog
+        self.app.wait_select_single(
+        objectName='startTestButton', enabled=True)

=== modified file 'plainbox/plainbox/impl/session/assistant.py'
--- plainbox/plainbox/impl/session/assistant.py	2015-12-11 09:08:09 +0000
+++ plainbox/plainbox/impl/session/assistant.py	2016-01-06 20:45:00 +0000
@@ -176,6 +176,10 @@
                 "create a transport for the C3 system"),
             self.get_canonical_hexr_transport: (
                 "create a transport for the HEXR system"),
+            self.get_old_sessions: (
+                "get previously created sessions"),
+            self.delete_sessions: (
+                "delete previously created sessions"),
         }
         # Restart support
         self._restart_cmd_callback = None
@@ -463,6 +467,63 @@
         _logger.debug("Provider selected: %r", provider)
 
     @raises(UnexpectedMethodCall)
+    def get_old_sessions(self, flags: 'Set[str]'={
+        SessionMetaData.FLAG_SUBMITTED, SessionMetaData.FLAG_BOOTSTRAPPING},
+            allow_not_flagged: bool=True) -> 'List[Tuple[str, Set[str]]]':
+        """
+        Get the list of previously run sessions.
+
+        :param flags:
+            Set of flags from which at least one flag must be present in the
+            metadata of the processed session storage in order for that storage
+            to be returned.
+        :param allow_not_flagged:
+            Also return sessions that have no flags attached.
+        :returns:
+            A list of tuples containing session id and flags that were attached
+            to that session.
+        :raises UnexpectedMethodCall:
+            If the call is made at an unexpected time. Do not catch this error.
+            It is a bug in your program. The error message will indicate what
+            is the likely cause.
+        """
+        UsageExpectation.of(self).enforce()
+        for storage in self._repo.get_storage_list():
+            data = storage.load_checkpoint()
+            if len(data) == 0:
+                continue
+            try:
+                metadata = SessionPeekHelper().peek(data)
+                if (metadata.app_id == self._app_id):
+                    if ((allow_not_flagged and not metadata.flags) or
+                            (metadata.flags & flags)):
+                        yield storage.id, metadata.flags
+            except SessionResumeError as exc:
+                _logger.info("Exception raised when trying to peek session"
+                             "data: %s", str(exc))
+
+    @raises(UnexpectedMethodCall)
+    def delete_sessions(self, session_ids: 'List[str]') -> None:
+        """
+        Delete session storages.
+
+        :param session_ids:
+            A list of session ids which storages should be removed.
+        :raises UnexpectedMethodCall:
+            If the call is made at an unexpected time. Do not catch this error.
+            It is a bug in your program. The error message will indicate what
+            is the likely cause.
+
+        .. note::
+            If the session is not found in the currently selected session
+            repository, it is silently ignored.
+        """
+        UsageExpectation.of(self).enforce()
+        for storage in self._repo.get_storage_list():
+            if storage.id in session_ids:
+                storage.remove()
+
+    @raises(UnexpectedMethodCall)
     def start_new_session(self, title: str):
         """
         Create a new testing session.
@@ -1272,6 +1333,10 @@
                 "create a transport for the C3 system"),
             self.get_canonical_hexr_transport: (
                 "create a transport for the HEXR system"),
+            self.get_old_sessions: (
+                "get previously created sessions"),
+            self.delete_sessions: (
+                "delete previously created sessions"),
         }
 
     @raises(KeyError, TransportError, UnexpectedMethodCall)