Merge lp:~kissiel/checkbox/fix-1397109-garbage-collection into lp:checkbox

[Maciej Kisielewski]

This MR brings old and forgotten branch of session garbage collection in Checkbox-Touch.

dec9897 checkbox-touch: add removal of 'bootstrapping' flag
2f1c137 checkbox-touch: add session_garbage_collect function
cf8d3ba checkbox-touch: make exporting of results mark session as 'submitted'
ead21d9 checkbox-touch: make garbage collection a two step process
10ea1ba checkbox-touch: add garbage collection api to CBT app component
4752fca checkbox-touch: run garbage collection when CBT starts
db81a46 checkbox-touch:autopilot: move select_two_tests_and_quit to base
fca9857 checkbox-touch:autopilot: add tests for session garbage collection

[Maciej Kisielewski (kissiel)]

<spineau> kissiel: but I got a situation with 3 red buttons and no subtotals per flags (which could be super nice)
<spineau> kissiel: So I'm wondering if we could instead list them with checkboxes and have buttons like [remove selected sessions] and a [cancel] to just ignore the request for cleanup
<kissiel> spineau, yep, probably :)
<spineau> kissiel: that would leave only 1 red element which is less scary :)
<kissiel> haha :)
<kissiel> spineau, in that case I think I'll use ordinary listview
<spineau> kissiel: still in the popup or a new page?
<kissiel> spineau, I think popup looks better
<spineau> kissiel: +1

[Maciej Kisielewski (kissiel)]

Superseded by https://code.launchpad.net/~kissiel/checkbox/sa-garbage-collection

Unmerged revisions

3817. By Maciej Kisielewski on 2015-05-29

checkbox-touch:autopilot: add tests for session garbage collection

This patch adds three tests for the session garbage collection functionality:
 - check if the dialog is shown
 - check if 'do not remove' doesn't remove
 - check if 'remove all' actually removes all

The latter two tests only check 'for self symptoms', i.e. after removal the
test only checks if the dialog proposing removal is no longer shown. And for
the one that doesn't remove it checks if the dialog still pops up.

Signed-off-by: Maciej Kisielewski <email address hidden>

3816. By Maciej Kisielewski on 2015-05-29

checkbox-touch:autopilot: move select_two_tests_and_quit to base

This patch moves the function that selects two tests and quits (the setting up
function for some tests) to the ClickAppTestCase base.

Signed-off-by: Maciej Kisielewski <email address hidden>

3815. By Maciej Kisielewski on 2015-05-29

checkbox-touch: run garbage collection when CBT starts

This patch makes checkbox-touch run the garbage collection step each time the
application starts.

Signed-off-by: Maciej Kisielewski <email address hidden>

3814. By Maciej Kisielewski on 2015-05-28

checkbox-touch: add garbage collection api to CBT app component

This patch adds necessary functions to CheckboxTouchApplication component that
forward calls to python.

Signed-off-by: Maciej Kisielewski <email address hidden>

3813. By Maciej Kisielewski on 2015-05-28

checkbox-touch: make garbage collection a two step process

This patch adds function that checks if there are collection candidates and
saves them in CheckboxTouchApplication state. This lets clients prompt for
confirmation before removing them.

Signed-off-by: Maciej Kisielewski <email address hidden>

3812. By Maciej Kisielewski on 2015-05-28

checkbox-touch: make exporting of results mark session as 'submitted'

Signed-off-by: Maciej Kisielewski <email address hidden>

3811. By Maciej Kisielewski on 2015-05-28

checkbox-touch: add session_garbage_collect function

This patch adds the backend function that looks for old and useless sessions
and removes them.

Signed-off-by: Maciej Kisielewski <email address hidden>

3810. By Maciej Kisielewski on 2015-05-28

checkbox-touch: add removal of 'bootstrapping' flag

This patch makes Checkbox Touch remove 'bootstrapping' flag once user selects
test to run.

Signed-off-by: Maciej Kisielewski <email address hidden>

=== modified file 'checkbox-touch/checkbox-touch.qml'
--- checkbox-touch/checkbox-touch.qml	2015-05-27 06:51:23 +0000
+++ checkbox-touch/checkbox-touch.qml	2015-05-29 11:12:57 +0000
@@ -131,7 +131,64 @@
                 "checkbox_touch" : applicationVersion,
                 "plainbox" : plainboxVersion
             };
-            resumeOrStartSession(appSettings["providersDir"]);
+            var resumeWithProvidersDir = function() {
+                resumeOrStartSession(appSettings["providersDir"]);
+            };
+            getGarbageCollectionCandidates(function(oldStorages) {
+                var buttons = [];
+                var flagToButtonText = {
+                    "incomplete": i18n.tr("Remove incomplete sessions"),
+                    "submitted": i18n.tr("Remove submitted sessions"),
+                }
+                var candidateFlags = [];
+                var totalCandidatesCount = 0;
+                for (var flag in flagToButtonText) {
+                    if (oldStorages[flag] && oldStorages[flag].length > 0) {
+                        candidateFlags.push(flag);
+                        // The next bit is somewhat convoluted because we need to capture flag variable
+                        // see http://stackoverflow.com/questions/12930272/javascript-closures-vs-anonymous-functions
+                        // for full explanation of closures in JS
+                        var newButton = {
+                            "text": flagToButtonText[flag],
+                            "color": UbuntuColors.red,
+                            "objectName": "removeAllOldSessionsButton",
+                            "onClicked": (function(flag) {
+                                return function() {
+                                    console.log("Removing sessions marked with '"+ flag + "' flag");
+                                    sessionGarbageCollect([flag], resumeWithProvidersDir);
+                                }
+
+                            })(flag)};
+                        totalCandidatesCount += oldStorages[flag].length;
+                        buttons.push(newButton);
+                    }
+                }
+                if (buttons.length > 1) {
+                    //there is more than one button, so append 'remove all' button
+                    buttons.push({
+                        "text": i18n.tr("Remove all old sessions"),
+                        "color": UbuntuColors.red,
+                        "onClicked": function() {
+                             sessionGarbageCollect(candidateFlags, resumeWithProvidersDir);
+                            }
+                        });
+                }
+                if (buttons.length > 0) {
+                    buttons.push({
+                        "text": i18n.tr("Do not remove sessions"),
+                          "color": UbuntuColors.green,
+                          "objectName": "doNotRemoveButton",
+                          "onClicked": function() {
+                              sessionGarbageCollect([], resumeWithProvidersDir);
+                             }
+                        });
+                    CbtDialogLogic.showDialog(mainView, i18n.tr("Do you want to clear old sessions storage?\n"
+                                                                + " Number of sessions qualifying for removal: ") +
+                                                                totalCandidatesCount, buttons);
+                } else {
+                    sessionGarbageCollect([], resumeWithProvidersDir);
+                }
+            });
         }
         onSessionReady: {
             welcomePage.enableButton()

=== modified file 'checkbox-touch/components/CheckboxTouchApplication.qml'
--- checkbox-touch/components/CheckboxTouchApplication.qml	2015-05-27 06:51:23 +0000
+++ checkbox-touch/components/CheckboxTouchApplication.qml	2015-05-29 11:12:57 +0000
@@ -85,6 +85,18 @@
         });
     }
 
+    function getGarbageCollectionCandidates(continuation) {
+        request("get_garbage_collection_candidates", [], continuation, function(error) {
+            console.error("Unable to get garbage collection candidates");
+        });
+    }
+
+    function sessionGarbageCollect(flags, continuation) {
+        request("session_garbage_collect", [flags], continuation, function(error) {
+            console.error("Unable to run session garbage collection");
+        });
+    }
+
     function getTestplans(continuation) {
         request("get_testplans", [], continuation, function(error) {
             console.error("Unable to get testplans");

=== modified file 'checkbox-touch/py/checkbox_touch.py'
--- checkbox-touch/py/checkbox_touch.py	2015-05-28 10:04:37 +0000
+++ checkbox-touch/py/checkbox_touch.py	2015-05-29 11:12:57 +0000
@@ -262,6 +262,7 @@
         self.desired_test_ids = frozenset()
         self.test_plan_id = ""
         self.resume_candidate_storage = None
+        self._garbage_collection_candidates = None
         self.session_storage_repo = None
         self.timestamp = datetime.datetime.utcnow().isoformat()
         self.config = PlainBoxConfig()
@@ -408,6 +409,55 @@
         }
 
     @view
+    def get_garbage_collection_candidates(self):
+        """
+        Returns a dict keyed by flag type with value being list of ids of all
+        sessions available in the storage.
+        """
+        # every session *should* have at least one flag set (altough logically
+        # those flags are mutally exclusive
+        self._init_session_storage_repo()
+        self._garbage_collection_candidates = collections.defaultdict(list)
+        for storage in self.session_storage_repo.get_storage_list():
+            data = storage.load_checkpoint()
+            if len(data) == 0:
+                continue
+            try:
+                metadata = SessionPeekHelper().peek(data)
+                if (metadata.app_id == 'checkbox-touch'):
+                    _logger.debug(_("Found an existing session storage: %s"),
+                                  storage.id)
+                    # some sessions might be appended to more than one list
+                    for flag in metadata.flags:
+                        self._garbage_collection_candidates[flag].append(
+                            storage)
+            except SessionResumeError as exc:
+                _logger.info(_("Exception raised when trying to gather garbage"
+                               " collection candidates: %s"), str(exc))
+        return { flag: [storage.id for storage in storages] for
+                flag, storages in self._garbage_collection_candidates.items()}
+    @view
+    def session_garbage_collect(self, flags):
+        """
+        Removes all session with any flag matching ``flags`` or having
+        'bootstrapping' flag set.
+        """
+        if self._garbage_collection_candidates is None:
+            _logger.warning(_("session_garbage_collect called before "
+                              "get_garbage_collection_candidates"))
+            return
+        # if there are candidates with 'bootstrapping', remove them
+        if 'bootstrapping' in self._garbage_collection_candidates.keys():
+            flags.append('bootstrapping')
+        # we build a set of sessions marked for removal so we don't try to
+        # re-remove any of them
+        to_remove = set()
+        for flag in flags:
+            to_remove |= set(self._garbage_collection_candidates[flag])
+        while to_remove:
+            to_remove.pop().remove()
+
+    @view
     def get_testplans(self):
         all_units = self.manager.default_device_context.unit_list
         return {
@@ -519,6 +569,7 @@
         self.context.state.update_desired_job_list(desired_job_list)
         _logger.info("Run job list: %s", self.context.state.run_list)
         self.context.state.metadata.flags.add('incomplete')
+        self.context.state.metadata.flags.remove('bootstrapping')
         self._checkpoint()
 
     @view
@@ -627,6 +678,8 @@
         output_file = os.path.join(dirname, filename)
         with open(output_file, 'wb') as stream:
             self._export_session_to_stream(output_format, option_list, stream)
+        self.context.state.metadata.flags.add(SessionMetaData.FLAG_SUBMITTED)
+        self._checkpoint()
         return output_file
 
     def _get_user_directory_documents(self):

=== modified file 'checkbox-touch/tests/autopilot/checkbox_touch/__init__.py'
--- checkbox-touch/tests/autopilot/checkbox_touch/__init__.py	2015-05-07 13:39:27 +0000
+++ checkbox-touch/tests/autopilot/checkbox_touch/__init__.py	2015-05-29 11:12:57 +0000
@@ -33,6 +33,15 @@
         self.launch_application()
         self.assertThat(self.main_view.visible, Eventually(Equals(True)))
 
+    def skipSessionRemoval(self):
+        """Answers 'do not remove' on session removal popup if it's shown."""
+        try:
+            do_not_remove_btn = self.app.wait_select_single(
+                objectName='doNotRemoveButton', visible=True)
+            self.pointing_device.click_object(do_not_remove_btn)
+        except StateNotFoundError:
+            pass
+
     def skipResumeIfShown(self):
         """Skip restart screen if presented."""
         # this doesn't use 'long wait' helper, because a 'welcome page' may be
@@ -56,6 +65,7 @@
                 pass
 
     def start_and_select_tests(self, category_id, job_ids):
+        self.skipSessionRemoval()
         self.skipResumeIfShown()
         welcome_page = self.long_wait_select_single(
             self.app, objectName='welcomePage', state='loaded')
@@ -83,6 +93,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 launch_application(self):
         if platform.model() == 'Desktop':
             self._launch_application_from_desktop()

=== modified file 'checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py'
--- checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2015-05-07 13:43:07 +0000
+++ checkbox-touch/tests/autopilot/checkbox_touch/test_checkbox_touch.py	2015-05-29 11:12:57 +0000
@@ -57,6 +57,7 @@
         The tests that have outcome determined automatically should come
         in two flavours; one that passes and one that fails.
         """
+        self.skipSessionRemoval()
         self.skipResumeIfShown()
         welcome_page = self.long_wait_select_single(
             self.app, objectName='welcomePage', state='loaded')
@@ -121,19 +122,10 @@
 
 
 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()
+        self.skipSessionRemoval()
         self.assertThat(self.main_view.visible, Eventually(Equals(True)))
         # not doing long-wait, as the app was recently launched and it
         # *shouldn't* take long to relaunch it
@@ -152,6 +144,7 @@
     def test_continue_after_resume(self):
         self.select_two_tests_and_quit()
         self.launch_application()
+        self.skipSessionRemoval()
         self.assertThat(self.main_view.visible, Eventually(Equals(True)))
         resume_page = self.app.wait_select_single(
             objectName='resumeSessionPage', visible=True)
@@ -168,6 +161,7 @@
     def test_restart_after_resume(self):
         self.select_two_tests_and_quit()
         self.launch_application()
+        self.skipSessionRemoval()
         self.assertThat(self.main_view.visible, Eventually(Equals(True)))
         resume_page = self.app.wait_select_single(
             objectName='resumeSessionPage', visible=True)
@@ -177,3 +171,46 @@
         welcome_page = self.app.wait_select_single(
             objectName='welcomePage')
         self.assertThat(welcome_page.visible, Eventually(Equals(True)))
+
+
+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="removeAllOldSessionsButton", visible=True)
+
+    def test_do_nor_remove_doesnt_remove(self):
+        self.select_two_tests_and_quit()
+        self.launch_application()
+        do_not_remove_btn = self.app.wait_select_single(
+            objectName="doNotRemoveButton", visible=True)
+        self.pointing_device.click_object(do_not_remove_btn)
+        # make sure the app behaves normally afterwards
+        self.skipResumeIfShown()
+        # 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="removeAllOldSessionsButton", visible=True)
+
+    def test_remove_all_removes(self):
+        self.select_two_tests_and_quit()
+        self.launch_application()
+        remove_all_btn = self.app.wait_select_single(
+            objectName="removeAllOldSessionsButton", visible=True)
+        self.pointing_device.click_object(remove_all_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)