Add new stock report to export submission.json (new) (#1827)

* Add new stock report to export submission.json

* Update the documentation to include new stock report

* Test that the new config is problem-free

Author: Hook25

checkbox-ng/checkbox_ng/launcher/stages.py

@@ -532,6 +532,28 @@ def _prepare_stock_report(self, report):
                 self.sa.config.update_from_another(
                     additional_config, new_origin
                 )
+        elif report == "submission_json":
+            exporter = "json"
+            file_ext = ".json"
+            path = self._get_submission_file_path(file_ext)
+            os.makedirs(os.path.dirname(path), exist_ok=True)
+            template = textwrap.dedent(
+                """
+                [transport:{exporter}_file]
+                path = {path}
+                type = file
+                [exporter:{exporter}]
+                unit = com.canonical.plainbox::{exporter}
+                [report:2_{exporter}_file]
+                exporter = {exporter}
+                forced = yes
+                transport = {exporter}_file
+                """
+            )
+            additional_config = Configuration.from_text(
+                template.format(exporter=exporter, path=path), new_origin
+            )
+            self.sa.config.update_from_another(additional_config, new_origin)
 
     def _get_submission_file_path(self, file_ext):
         # LP:1585326 maintain isoformat but removing ':' chars that cause

checkbox-ng/checkbox_ng/launcher/test_stages.py

@@ -146,7 +146,7 @@ def get_parametric_sections(section):
             )
 
     @mock.patch("os.makedirs")
-    def test__prepare_stock_report(self, makedirs):
+    def test__prepare_stock_report_submission_files(self, makedirs):
         self_mock = mock.MagicMock()
         self_mock._get_submission_file_path = partial(
             ReportsStage._get_submission_file_path, self_mock
@@ -157,3 +157,20 @@ def test__prepare_stock_report(self, makedirs):
 
         self.assertEqual(self_mock.sa.config.update_from_another.call_count, 3)
         self.assertTrue(makedirs.called)
+
+    @mock.patch("os.makedirs")
+    def test__prepare_stock_report_submission_json(self, makedirs):
+        self_mock = mock.MagicMock()
+        self_mock._get_submission_file_path = partial(
+            ReportsStage._get_submission_file_path, self_mock
+        )
+        self_mock.base_dir = "~/.local/share"
+
+        ReportsStage._prepare_stock_report(self_mock, "submission_json")
+
+        # called to adopt the generated config
+        self_mock_update_from_another = self_mock.sa.config.update_from_another
+        self.assertEqual(self_mock_update_from_another.call_count, 1)
+        config = self_mock_update_from_another.call_args[0][0]
+        self.assertFalse(config.get_problems())
+        self.assertTrue(makedirs.called)

docs/reference/launcher.rst

@@ -102,6 +102,8 @@ future.
     * ``certification``: Send results to certification site
     * ``certification-staging``: Send results to staging version of
       certification site
+    * ``submission_json``: Writes the ``submission.json`` to ``$XDG_DATA_HOME``
+      (or ``~/.local/share`` if it is not defined)
 
     If you don't want to have any stock report automatically generated use
     ``none`` as the value.