Merge lp:~zyga/checkbox/sa-api-changes into lp:checkbox

[Zygmunt Krynicki]

[Sylvain Pineau (sylvain-pineau)]

I already reviewed this branch without approving it, done now :)

review: Approve

[Sylvain Pineau (sylvain-pineau)]

Attempt to merge into lp:checkbox failed due to conflicts:

text conflict in plainbox/plainbox/impl/session/assistant.py

[lp:~zyga/checkbox/sa-api-changes]

4050. By Maciej Kisielewski on 2015-10-13

"automatic merge of lp:~kissiel/checkbox/fix-1368001-auto-skipped-rerun/ by tarmac [r=sylvain-pineau][bug=1368001,1505198][author=kissiel]"

4051. By Launchpad Translations on behalf of checkbox-dev on 2015-10-14

Launchpad automatic translations update.

4052. By Launchpad Translations on behalf of checkbox-dev on 2015-10-15

Launchpad automatic translations update.

4053. By Maciej Kisielewski on 2015-10-15

"automatic merge of lp:~kissiel/checkbox/translations-converged/ by tarmac [r=sylvain-pineau][bug=][author=kissiel]"

4054. By Launchpad Translations on behalf of checkbox-dev on 2015-10-16

Launchpad automatic translations update.

4055. By Launchpad Translations on behalf of checkbox-dev on 2015-10-19

Launchpad automatic translations update.

4056. By Maciej Kisielewski on 2015-10-19

"automatic merge of lp:~kissiel/checkbox/autopilot-reordering/ by tarmac [r=sylvain-pineau][bug=][author=kissiel]"

4057. By Sylvain Pineau on 2015-10-20

"automatic merge of lp:~sylvain-pineau/checkbox/snap_packages_in_submission_parser/ by tarmac [r=kissiel][bug=][author=sylvain-pineau]"

4058. By Po-Hsu Lin on 2015-10-21

"automatic merge of lp:~cypressyew/checkbox/use-touchscreen-manifest/ by tarmac [r=sylvain-pineau][bug=1508297][author=cypressyew]"

4059. By Pierre Equoy on 2015-10-21

"automatic merge of lp:~pierre-equoy/checkbox/fix-1459948-new-screen-rotation-script-using-dbus/ by tarmac [r=sylvain-pineau][bug=1459948][author=pierre-equoy]"

4060. By Maciej Kisielewski on 2015-10-22

"automatic merge of lp:~kissiel/checkbox/fix-1506632-crash-when-no-provider/ by tarmac [r=sylvain-pineau][bug=1506632][author=kissiel]"

4061. By Maciej Kisielewski on 2015-10-22

"automatic merge of lp:~kissiel/checkbox/fix-session-ending/ by tarmac [r=sylvain-pineau][bug=][author=kissiel]"

4062. By Maciej Kisielewski on 2015-10-22

"automatic merge of lp:~kissiel/checkbox/fix-1493467-uncategorized-skipped/ by tarmac [r=sylvain-pineau][bug=1493467][author=kissiel]"

4063. By Maciej Kisielewski on 2015-10-22

"automatic merge of lp:~kissiel/checkbox/fix-1506621-crash-next-session/ by tarmac [r=sylvain-pineau][bug=1506621][author=kissiel]"

4064. By Maciej Kisielewski on 2015-10-22

"automatic merge of lp:~kissiel/checkbox/fix-1501511-standard-close-icon/ by tarmac [r=sylvain-pineau,nik90][bug=1501511][author=kissiel]"

4065. By Po-Hsu Lin on 2015-10-23

"automatic merge of lp:~cypressyew/checkbox/rotation-from-normal/ by tarmac [r=sylvain-pineau][bug=1503167][author=cypressyew]"

4066. By Maciej Kisielewski on 2015-10-23

"automatic merge of lp:~kissiel/checkbox/minor-converged-fixes/ by tarmac [r=sylvain-pineau][bug=][author=kissiel]"

4067. By Launchpad Translations on behalf of checkbox-dev on 2015-10-26

Launchpad automatic translations update.

4068. By Po-Hsu Lin on 2015-10-27

"automatic merge of lp:~cypressyew/checkbox/reduce-webcam-led-time/ by tarmac [r=zyga][bug=][author=cypressyew]"

4069. By Maciej Kisielewski on 2015-10-27

"automatic merge of lp:~kissiel/checkbox/minor-converged-fixes/ by tarmac [r=zyga][bug=][author=kissiel]"

4070. By Pierre Equoy on 2015-10-28

"automatic merge of lp:~pierre-equoy/checkbox/fix-1471663-erroneous-wireless-results-when-eth-plugged/ by tarmac [r=sylvain-pineau][bug=1471663][author=pierre-equoy]"

4071. By Zygmunt Krynicki on 2015-10-28

plainbox: expand SessionAssistant initializer API

This patch modifies the session assistant initializer to allow up to
four arguments. The three new arguments are:

app_version: so that we can use this implicitly in some places,
 e.g. don't resumes sessions created by future versions, etc.
api_version: so that we can change usage expectations over time
 but let applications stay compatible by using a fixed API version.
 This can be changed to a __new__ call that returns a versioned
 SA class instead of doing if-then-else magic in all the places.
api_flags: so that we can allow applications to opt-into optional
 features and so that we can adjust expectations accordingly. This
 will also allow us to easily compare applications for feature
 parity.

For now all new arguments have sane defaults. Once all applications are
patched the defaults will go away.

Signed-off-by: Zygmunt Krynicki <email address hidden>

4072. By Zygmunt Krynicki on 2015-10-28

plainbox:ingredients: add get_sa_api_{version,flags} to CanonicalCommand

This patch allows CanonicalCommand consumers to define the expected
SessionAssistant API and feature flags with simple class-level
attributes. Two new getter methods are used to read them and provide
sensible defaults.

Signed-off-by: Zygmunt Krynicki <email address hidden>

4073. By Zygmunt Krynicki on 2015-10-28

plainbox:ingredients: initialize SA with app meta-data

This patch makes CanonicalCommand initialize the internal
SessionAssistant object with application version and API version and
feature flags, as declared by the command.

Signed-off-by: Zygmunt Krynicki <email address hidden>

[Maciej Kisielewski (kissiel)]

+1, thanks!

review: Approve

=== modified file 'plainbox/plainbox/impl/ingredients.py'
--- plainbox/plainbox/impl/ingredients.py	2015-09-01 13:48:29 +0000
+++ plainbox/plainbox/impl/ingredients.py	2015-10-28 11:12:50 +0000
@@ -137,7 +137,12 @@
 
     def late_init(self, context):
         """Add a SessionAssistant as ``sa`` to the guacamole context."""
-        context.sa = SessionAssistant(context.cmd_toplevel.get_app_id())
+        context.sa = SessionAssistant(
+            context.cmd_toplevel.get_app_id(),
+            context.cmd_toplevel.get_cmd_version(),
+            context.cmd_toplevel.get_sa_api_version(),
+            context.cmd_toplevel.get_sa_api_flags(),
+        )
 
 
 class CanonicalCrashIngredient(Ingredient):
@@ -198,6 +203,42 @@
 
     bug_report_url = "https://bugs.launchpad.net/checkbox/+filebug"
 
+    def get_sa_api_version(self):
+        """
+        Get the SessionAssistant API this command needs to use.
+
+        :returns:
+            ``self.sa_api_version`` if defined
+        :returns:
+            "0.99", otherwise
+
+        This method is used internally by CanonicalCommand to initialize
+        SessionAssistant. Applications can declare the API version they use by
+        defining the ``sa_api_version`` attribute at class level.
+        """
+        try:
+            return self.sa_api_version
+        except AttributeError:
+            return '0.99'
+
+    def get_sa_api_flags(self):
+        """
+        Get the SessionAssistant API flags this command needs to use.
+
+        :returns:
+            ``self.sa_api_flags`` if defined
+        :returns:
+            ``[]``, otherwise
+
+        This method is used internally by CanonicalCommand to initialize
+        SessionAssistant. Applications can declare the API flags they use by
+        defining the ``sa_api_flags`` attribute at class level.
+        """
+        try:
+            return self.sa_api_flags
+        except AttributeError:
+            return []
+
     def main(self, argv=None, exit=True):
         """
         Shortcut for running a command.

=== modified file 'plainbox/plainbox/impl/session/assistant.py'
--- plainbox/plainbox/impl/session/assistant.py	2015-10-26 13:11:03 +0000
+++ plainbox/plainbox/impl/session/assistant.py	2015-10-28 11:12:50 +0000
@@ -94,7 +94,8 @@
 
     # TODO: create a flowchart of possible states
 
-    def __init__(self, app_id):
+    def __init__(self, app_id, app_version=None, api_version='0.99',
+                 api_flags=()):
         """
         Initialize a new session assistant.
 
@@ -102,12 +103,32 @@
             Identifier of the testing application. The identifier should be
             unique and constant throughout the support cycle of the
             application.
+        :param app_version:
+            Version of the testing application.
+        :param api_version:
+            Expected API of SessionAssistant. Currently only "0.99" API is
+            defined.
+        :param api_flags:
+            Flags that describe optional API features that this application
+            wishes to support. Flags may change the usage expectation of
+            session assistant. Currently no flags are supported.
+        :raises ValueError:
+            When api_version is not recognized.
+        :raises ValueError:
+            When api_flags contains an unrecognized flag.
 
         The application identifier is useful to implement session resume
         functionality where the application can easily filter out sessions from
         other programs.
         """
+        if api_version != '0.99':
+            raise ValueError("Unrecognized API version")
+        for flag in api_flags:
+            raise ValueError("Unrecognized API flag: {!r}".format(flag))
         self._app_id = app_id
+        self._app_version = app_version
+        self._api_version = api_version
+        self._api_flags = api_flags
         self._repo = SessionStorageRepository()
         self._config = PlainBoxConfig().get()
         self._execution_ctrl_list = None  # None is "default"

=== modified file 'plainbox/plainbox/impl/session/test_assistant.py'
--- plainbox/plainbox/impl/session/test_assistant.py	2015-08-03 14:10:44 +0000
+++ plainbox/plainbox/impl/session/test_assistant.py	2015-10-28 11:12:50 +0000
@@ -35,10 +35,14 @@
     """Tests for the SessionAssitant class."""
 
     APP_ID = 'app-id'
+    APP_VERSION = '1.0'
+    API_VERSION = '0.99'
+    API_FLAGS = []
 
     def setUp(self):
         """Common set-up code."""
-        self.sa = SessionAssistant(self.APP_ID)
+        self.sa = SessionAssistant(
+            self.APP_ID, self.APP_VERSION, self.API_VERSION, self.API_FLAGS)
         # NOTE: setup a custom repository so that all tests are done in
         # isolation from the user account. While we're doing that, let's check
         # that this this function is allowed just after setting up the session.