Merge pull request #67 from per1234/boards-report-array

Structure sketches report to allow compiling for multiple boards per run

Author: aentinger

compilesketches/compilesketches.py

@@ -80,6 +80,7 @@ class RunCommandOutput(enum.Enum):
     board_manager_platforms_path = arduino_cli_data_directory_path.joinpath("packages")
 
     class ReportKeys:
+        boards = "boards"
         board = "board"
         commit_hash = "commit_hash"
         commit_url = "commit_url"
@@ -962,26 +963,33 @@ def get_size_report(self, current_size, previous_size):
         return size_report
 
     def get_sketches_report(self, sketch_report_list):
-        """Return the dictionary containing data on all sketch compilations
+        """Return the dictionary containing data on all sketch compilations for each board
 
         Keyword arguments:
         sketch_report_list -- list of reports from each sketch compilation
         """
         current_git_ref = get_head_commit_hash()
 
         sketches_report = {
-            self.ReportKeys.board: self.fqbn,
             self.ReportKeys.commit_hash: current_git_ref,
             self.ReportKeys.commit_url: ("https://github.com/"
                                          + os.environ["GITHUB_REPOSITORY"]
                                          + "/commit/"
                                          + current_git_ref),
-            self.ReportKeys.sketches: sketch_report_list
+            # The action is currently designed to only compile for one board per run, so the boards list will only have
+            # a single element, but this provides a report format that can accommodate the possible addition of multiple
+            # boards support
+            self.ReportKeys.boards: [
+                {
+                    self.ReportKeys.board: self.fqbn,
+                    self.ReportKeys.sketches: sketch_report_list
+                }
+            ]
         }
 
         sizes_summary_report = self.get_sizes_summary_report(sketch_report_list=sketch_report_list)
         if sizes_summary_report:
-            sketches_report[self.ReportKeys.sizes] = sizes_summary_report
+            sketches_report[self.ReportKeys.boards][0][self.ReportKeys.sizes] = sizes_summary_report
 
         return sketches_report
 

compilesketches/tests/test_compilesketches.py

@@ -1563,14 +1563,18 @@ def test_get_sketches_report(monkeypatch, mocker):
     compile_sketches = get_compilesketches_object(fqbn_arg=fqbn_arg)
 
     assert compile_sketches.get_sketches_report(sketch_report_list=sketch_report_list) == {
-        compilesketches.CompileSketches.ReportKeys.board: compile_sketches.fqbn,
         compilesketches.CompileSketches.ReportKeys.commit_hash: current_git_ref,
         compilesketches.CompileSketches.ReportKeys.commit_url: ("https://github.com/"
                                                                 + github_repository
                                                                 + "/commit/"
                                                                 + current_git_ref),
-        compilesketches.CompileSketches.ReportKeys.sizes: sizes_summary_report,
-        compilesketches.CompileSketches.ReportKeys.sketches: sketch_report_list
+        compilesketches.CompileSketches.ReportKeys.boards: [
+            {
+                compilesketches.CompileSketches.ReportKeys.board: compile_sketches.fqbn,
+                compilesketches.CompileSketches.ReportKeys.sizes: sizes_summary_report,
+                compilesketches.CompileSketches.ReportKeys.sketches: sketch_report_list
+            }
+        ]
     }
 
     compile_sketches.get_sizes_summary_report.assert_called_once_with(compile_sketches,
@@ -1580,13 +1584,17 @@ def test_get_sketches_report(monkeypatch, mocker):
     compilesketches.CompileSketches.get_sizes_summary_report.return_value = []
 
     assert compile_sketches.get_sketches_report(sketch_report_list=sketch_report_list) == {
-        compilesketches.CompileSketches.ReportKeys.board: compile_sketches.fqbn,
         compilesketches.CompileSketches.ReportKeys.commit_hash: current_git_ref,
         compilesketches.CompileSketches.ReportKeys.commit_url: ("https://github.com/"
                                                                 + github_repository
                                                                 + "/commit/"
                                                                 + current_git_ref),
-        compilesketches.CompileSketches.ReportKeys.sketches: sketch_report_list
+        compilesketches.CompileSketches.ReportKeys.boards: [
+            {
+                compilesketches.CompileSketches.ReportKeys.board: compile_sketches.fqbn,
+                compilesketches.CompileSketches.ReportKeys.sketches: sketch_report_list
+            }
+        ]
     }
 
 
@@ -1820,7 +1828,7 @@ def test_get_sizes_summary_report():
 
 def test_create_sketches_report_file(monkeypatch, tmp_path):
     sketches_report_path = tmp_path
-    sketches_report = {
+    sketches_report = [{
         "sketch": "examples/Foo",
         "compilation_success": True,
         "flash": 444,
@@ -1830,7 +1838,7 @@ def test_create_sketches_report_file(monkeypatch, tmp_path):
         "flash_delta": -994,
         "ram_delta": -175,
         "fqbn": "arduino:avr:uno"
-    }
+    }]
 
     compile_sketches = get_compilesketches_object(sketches_report_path=str(sketches_report_path),
                                                   fqbn_arg="arduino:avr:uno")