Pass data to reportsizetrends module via the sketches report file

Rather than passing the sketch data via the API, it will now be passed via the report file. This change is needed to pass the data once the reportsizetrends code is moved to a separate action.

Author: per1234

README.md

@@ -121,7 +121,6 @@ Set to `true` to cause the action to determine the change in memory usage for th
 
 ### `size-deltas-report-folder-name`
 
-Folder to save the JSON formatted memory usage change reports to. Should be used only to store reports. It will be created under [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. Default `"size-deltas-reports"`.
 
 ### `enable-size-trends-report`
 
@@ -177,6 +176,7 @@ The ID of the Google Sheets spreadsheet to write the memory usage trends data to
 ### `size-trends-report-sheet-name`
 
 The sheet name in the Google Sheets spreadsheet used for the memory usage trends report. Default `"Sheet1"`.
+Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. Default `"size-deltas-reports"`.
 
 ## Example usage
 

compilesketches/compilesketches.py

@@ -83,6 +83,8 @@ class RunCommandOutput(enum.Enum):
     board_manager_platforms_path = arduino_cli_data_directory_path.joinpath("packages")
 
     report_fqbn_key = "fqbn"
+    report_commit_hash_key = "commit_hash"
+    report_commit_url_key = "commit_url"
     report_sketch_key = "sketch"
     report_compilation_success_key = "compilation_success"
     report_flash_key = "flash"
@@ -183,12 +185,12 @@ def compile_sketches(self):
         if self.report_sketch != "":
             # Make sketch reports
             sketch_report = self.get_sketch_report_from_sketches_report(sketches_report=sketches_report)
-            # Make the memory usage trends report
-            if self.do_size_trends_report():
-                self.make_size_trends_report(sketch_report=sketch_report)
             # TODO: The current behavior is to only write the report for the report sketch, but the plan is to change to
             #       reporting data for all sketches, thus the passing of sketch_report to the function
             self.create_sketches_report_file(sketches_report=sketch_report)
+            # Make the memory usage trends report
+            if self.do_size_trends_report():
+                self.make_size_trends_report()
 
         if not all_compilations_successful:
             print("::error::One or more compilations failed")
@@ -1009,30 +1011,19 @@ def get_sketch_report_from_sketches_report(self, sketches_report):
         print("::error::size-report-sketch:", self.report_sketch, "was not found")
         sys.exit(1)
 
-    def make_size_trends_report(self, sketch_report):
+    def make_size_trends_report(self):
         """Publish the size data for the report sketch to a Google Sheets spreadsheet.
 
         Keyword arguments:
         sketch_report -- report for the sketch report
         """
-        # Get the short hash of the pull request head ref
         self.verbose_print("Making size trends report")
-        repository = git.Repo(path=os.environ["GITHUB_WORKSPACE"])
-        current_git_ref = repository.git.rev_parse("HEAD", short=True)
 
         report_size_trends = reportsizetrends.ReportSizeTrends(
+            sketches_report_path=str(self.sketches_report_path),
             google_key_file=self.google_key_file,
             spreadsheet_id=self.size_trends_report_spreadsheet_id,
-            sheet_name=self.size_trends_report_sheet_name,
-            sketch_name=sketch_report[self.report_sketch_key],
-            commit_hash=current_git_ref,
-            commit_url=("https://github.com/"
-                        + os.environ["GITHUB_REPOSITORY"]
-                        + "/commit/"
-                        + current_git_ref),
-            fqbn=self.fqbn,
-            flash=str(sketch_report[self.report_flash_key]),
-            ram=str(sketch_report[self.report_ram_key])
+            sheet_name=self.size_trends_report_sheet_name
         )
 
         report_size_trends.report_size_trends()
@@ -1044,10 +1035,21 @@ def create_sketches_report_file(self, sketches_report):
         sketch_report -- report for the sketch report
         """
         self.verbose_print("Creating sketch report file")
-        # Add the FQBN to the report
+        # Add the shared data to the report
         # TODO: doing this here is in anticipation of the planned switch to reporting for all sketches, when it will
-        #       make sense to only add a single fqbn key to the report
+        #       make sense to only add a single copy of the data that's universal to all sketches to the report
         sketches_report[self.report_fqbn_key] = self.fqbn
+
+        # Get the short hash of the pull request head ref
+        repository = git.Repo(path=os.environ["GITHUB_WORKSPACE"])
+        current_git_ref = repository.git.rev_parse("HEAD", short=True)
+        sketches_report[self.report_commit_hash_key] = current_git_ref
+
+        sketches_report[self.report_commit_url_key] = ("https://github.com/"
+                                                       + os.environ["GITHUB_REPOSITORY"]
+                                                       + "/commit/"
+                                                       + current_git_ref)
+
         sketches_report_path = absolute_path(path=self.sketches_report_path)
 
         # Create the report folder

compilesketches/tests/test_compilesketches.py

@@ -279,10 +279,7 @@ def test_compile_sketches(mocker, compilation_success_list, expected_success, do
         compile_sketches.do_size_trends_report.assert_called_once()
 
         if do_size_trends_report:
-            compile_sketches.make_size_trends_report.assert_called_once_with(
-                compile_sketches,
-                sketch_report=sketch_report_from_sketches_report
-            )
+            compile_sketches.make_size_trends_report.assert_called_once_with(compile_sketches)
         else:
             compile_sketches.make_size_trends_report.assert_not_called()
 
@@ -1485,55 +1482,43 @@ def test_get_sketch_report_from_sketches_report(report_sketch, expected_success)
 
 
 def test_make_size_trends_report(monkeypatch, mocker):
-    current_git_ref = "fooref"
-    sketch_report = {compilesketches.CompileSketches.report_sketch_key: unittest.mock.sentinel.sketch_report_sketch,
-                     compilesketches.CompileSketches.report_flash_key: unittest.mock.sentinel.sketch_report_flash,
-                     compilesketches.CompileSketches.report_ram_key: unittest.mock.sentinel.sketch_report_ram}
-
     # Stub
-    class Repo:
-        def __init__(self):
-            self.git = self
-
-        def rev_parse(self):
-            pass
-
     class ReportSizeTrends:
         def report_size_trends(self):
             pass
 
-    monkeypatch.setenv("GITHUB_REPOSITORY", "fooRepository/fooOwner")
-    monkeypatch.setenv("GITHUB_WORKSPACE", "/fooWorkspace")
+    sketches_report_path = "foo/sketches_report_path"
 
-    compile_sketches = get_compilesketches_object()
+    compile_sketches = get_compilesketches_object(sketches_report_path=sketches_report_path)
 
-    mocker.patch("git.Repo", autospec=True, return_value=Repo())
-    mocker.patch.object(Repo, "rev_parse", return_value=current_git_ref)
     mocker.patch("reportsizetrends.ReportSizeTrends", autospec=True, return_value=ReportSizeTrends())
     mocker.patch.object(ReportSizeTrends, "report_size_trends")
 
-    compile_sketches.make_size_trends_report(sketch_report)
+    compile_sketches.make_size_trends_report()
 
-    git.Repo.assert_called_once_with(path=os.environ["GITHUB_WORKSPACE"])
-    Repo.rev_parse.assert_called_once_with("HEAD", short=True)
     reportsizetrends.ReportSizeTrends.assert_called_once_with(
+        sketches_report_path=str(pathlib.PurePath(sketches_report_path)),
         google_key_file=compile_sketches.google_key_file,
         spreadsheet_id=compile_sketches.size_trends_report_spreadsheet_id,
-        sheet_name=compile_sketches.size_trends_report_sheet_name,
-        sketch_name=sketch_report[compilesketches.CompileSketches.report_sketch_key],
-        commit_hash=current_git_ref,
-        commit_url=("https://github.com/"
-                    + os.environ["GITHUB_REPOSITORY"]
-                    + "/commit/"
-                    + current_git_ref),
-        fqbn=compile_sketches.fqbn,
-        flash=str(sketch_report[compilesketches.CompileSketches.report_flash_key]),
-        ram=str(sketch_report[compilesketches.CompileSketches.report_ram_key])
+        sheet_name=compile_sketches.size_trends_report_sheet_name
     )
     ReportSizeTrends.report_size_trends.assert_called_once()
 
 
-def test_create_sketches_report_file(tmp_path):
+def test_create_sketches_report_file(monkeypatch, tmp_path, mocker):
+    current_git_ref = "fooref"
+
+    # Stub
+    class Repo:
+        def __init__(self):
+            self.git = self
+
+        def rev_parse(self):
+            pass
+
+    monkeypatch.setenv("GITHUB_REPOSITORY", "fooRepository/fooOwner")
+    monkeypatch.setenv("GITHUB_WORKSPACE", "/fooWorkspace")
+
     sketches_report_path = tmp_path
     fqbn_arg = "arduino:avr:uno"
     sketches_report = {
@@ -1548,6 +1533,9 @@ def test_create_sketches_report_file(tmp_path):
         "fqbn": "arduino:avr:uno"
     }
 
+    mocker.patch("git.Repo", autospec=True, return_value=Repo())
+    mocker.patch.object(Repo, "rev_parse", return_value=current_git_ref)
+
     compile_sketches = get_compilesketches_object(sketches_report_path=str(sketches_report_path),
                                                   fqbn_arg=fqbn_arg)
 
@@ -1556,6 +1544,9 @@ def test_create_sketches_report_file(tmp_path):
     with open(file=str(sketches_report_path.joinpath("arduino-avr-uno.json"))) as sketch_report_file:
         assert json.load(sketch_report_file) == sketches_report
 
+    git.Repo.assert_called_once_with(path=os.environ["GITHUB_WORKSPACE"])
+    Repo.rev_parse.assert_called_once_with("HEAD", short=True)
+
 
 @pytest.mark.parametrize("verbose", ["true", "false"])
 def test_verbose_print(capsys, verbose):