Merge ~kissiel/plainbox:only-auto-after-suspend into plainbox:master

[Maciej Kisielewski]

remove the also-after-suspend-auto flag

It seems that the only suspend job that we'll run in the foreseeable future is the automated one, so I think it'll be easier to just have one.

[Maciej Kisielewski (kissiel)]

Superseded by https://code.launchpad.net/~kissiel/plainbox/+git/plainbox/+merge/317076

Unmerged commits

28455ee... by Maciej Kisielewski on 2017-02-08

remove the also-after-suspend-auto flag

It seems that the only suspend job that we'll run in the foreseeable future is
the automated one, so I think it'll be easier to just have one.

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

diff --git a/docs/manpages/plainbox-job-units.rst b/docs/manpages/plainbox-job-units.rst
index dcb022f..eab208a 100644
--- a/docs/manpages/plainbox-job-units.rst
+++ b/docs/manpages/plainbox-job-units.rst
@@ -313,10 +313,6 @@ Following fields may be used by the job unit:
 
     ``also-after-suspend``: See ``siblings`` below.
 
-.. _job_flag_also_after_suspend_auto:
-
-    ``also-after-suspend-auto``: See ``siblings`` below.
-
     Additional flags may be present in job definition; they are ignored.
 
 ``siblings``:
@@ -357,15 +353,14 @@ Following fields may be used by the job unit:
               "_summary": "usb stress test_(port 3)"},
         ]
 
-    For convenience two flags can be set (``also-after-suspend`` and
-    ``also-after-suspend-auto``) to create siblings with predefined settings to
-    add "after suspend" jobs.
+    For convenience ``also-after-suspend`` flag can be set to create sibling
+    with predefined setting to add "after suspend" jobs.
 
     Given the base job::
 
         id:foo
         _summary: bar
-        flags: also-after-suspend also-after-suspend-auto
+        flags: also-after-suspend
         [...]
 
     The ``also-after-suspend`` flag is a shortcut to create the following job::
@@ -374,12 +369,6 @@ Following fields may be used by the job unit:
         _summary: bar after suspend (S3)
         depends: 2013.com.canonical.certification::suspend/suspend_advanced
 
-    ``also-after-suspend-auto`` is a shortcut to create the following job::
-
-        id: after-suspend-auto-foo
-        _summary: bar after suspend (S3)
-        depends: 2013.com.canonical.certification::suspend/suspend_advanced_auto
-
 .. warning::
     The curly braces used in this field have to be escaped when used in a
     template job (python format, Jinja2 templates do not have this issue).
diff --git a/plainbox/impl/session/state.py b/plainbox/impl/session/state.py
index 38a8891..5fc47ac 100644
--- a/plainbox/impl/session/state.py
+++ b/plainbox/impl/session/state.py
@@ -1122,8 +1122,6 @@ class SessionState:
                     if not key.endswith('siblings')
                 }
                 data['flags'] = data['flags'].replace('also-after-suspend', '')
-                data['flags'] = data['flags'].replace(
-                    'also-after-suspend-auto', '')
                 data['id'] = "after-suspend-{}".format(new_job.partial_id)
                 data['_summary'] = "{} after suspend (S3)".format(
                     new_job.summary)
@@ -1144,34 +1142,6 @@ class SessionState:
                         parameters=new_job.parameters,
                         field_offset_map=new_job.field_offset_map),
                     recompute)
-            if 'also-after-suspend-auto' in new_job.get_flag_set():
-                data = {
-                    key: value for key, value in new_job._data.items()
-                    if not key.endswith('siblings')
-                }
-                data['flags'] = data['flags'].replace('also-after-suspend', '')
-                data['flags'] = data['flags'].replace(
-                    'also-after-suspend-auto', '')
-                data['id'] = "after-suspend-auto-{}".format(new_job.partial_id)
-                data['_summary'] = "{} after suspend (S3)".format(
-                    new_job.summary)
-                provider_id = "2013.com.canonical.certification"
-                suspend_test_id = "suspend/suspend_advanced_auto"
-                if new_job.depends:
-                    data['depends'] += " {}::{}".format(provider_id,
-                                                        suspend_test_id)
-                else:
-                    data['depends'] = "{}::{}".format(provider_id,
-                                                      suspend_test_id)
-                self._add_job_unit(
-                    JobDefinition(
-                        data,
-                        origin=new_job.origin,
-                        provider=new_job.provider,
-                        controller=new_job.controller,
-                        parameters=new_job.parameters,
-                        field_offset_map=new_job.field_offset_map),
-                    recompute)
             return new_job
         else:
             # If there is a clash report DependencyDuplicateError only when the
diff --git a/plainbox/impl/session/test_state.py b/plainbox/impl/session/test_state.py
index 9483dc0..95d85a3 100644
--- a/plainbox/impl/session/test_state.py
+++ b/plainbox/impl/session/test_state.py
@@ -299,40 +299,6 @@ class SessionStateAPITests(TestCase):
             session.job_state_map[sibling.id].readiness_inhibitor_list,
             [UndesiredJobReadinessInhibitor])
 
-    def test_also_after_suspend_auto_flag(self):
-        # Define a job
-        job = make_job("A", summary="foo", flags='also-after-suspend-auto')
-        # Define an empty session
-        session = SessionState([])
-        # Add the job to the session
-        session.add_unit(job)
-        # Both jobs got added to job list
-        self.assertEqual(len(session.job_list), 2)
-        self.assertIn(job, session.job_list)
-        self.assertEqual(session.job_list[1].id, 'after-suspend-auto-A')
-        self.assertEqual(session.job_list[1].summary, 'foo after suspend (S3)')
-        self.assertEqual(
-            session.job_list[1].depends,
-            '2013.com.canonical.certification::suspend/suspend_advanced_auto')
-        sibling = session.job_list[1]
-        self.assertNotIn('also-after-suspend-auto', sibling.get_flag_set())        
-        # Both jobs got added to job state map
-        self.assertIs(session.job_state_map[job.id].job, job)
-        self.assertIs(session.job_state_map[sibling.id].job, sibling)
-        # Both jobs are not added to the desired job list
-        self.assertNotIn(job, session.desired_job_list)
-        self.assertNotIn(sibling, session.desired_job_list)
-        # Both jobs are not in the run list
-        self.assertNotIn(job, session.run_list)
-        self.assertNotIn(sibling, session.run_list)
-        # Both jobs are not selected to run
-        self.assertEqual(
-            session.job_state_map[job.id].readiness_inhibitor_list,
-            [UndesiredJobReadinessInhibitor])
-        self.assertEqual(
-            session.job_state_map[sibling.id].readiness_inhibitor_list,
-            [UndesiredJobReadinessInhibitor])
-
     def test_get_estimated_duration_auto(self):
         # Define jobs with an estimated duration
         one_second = make_job("one_second", plugin="shell",