Rename all occurrences of "size deltas report" to "deltas report"

The report may contain deltas data other than size, so the previous name was too constraining.

The only remaining use of "size deltas report" is the default sketches report path: 'size-deltas-reports'.

For backwards compatibility, the `enable-size-deltas-report` input will still be supported, but a warning will be displayed in the workflow run log notifying the user of the name change.

Author: per1234

README.md

@@ -114,9 +114,9 @@ Path in which to save a JSON formatted file containing data from the sketch comp
 
 ### `github-token`
 
-GitHub access token used to get information from the GitHub API. Only needed for private repositories with `enable-size-deltas-report` set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
+GitHub access token used to get information from the GitHub API. Only needed for private repositories with `enable-deltas-report` set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
 
-### `enable-size-deltas-report`
+### `enable-deltas-report`
 
 Set to `true` to cause the action to determine the change in memory usage of the compiled sketches. If the workflow is triggered by a `pull_request` event, the comparison is between the pull request branch and the tip of the pull request's base branch. If the workflow is triggered by a `push` event, the comparison is between the pushed commit and its immediate parent. This may be used with the [`arduino/actions/libraries/report-size-deltas` action](https://github.com/arduino/actions/tree/master/libraries/report-size-deltas). Default `false`.
 
@@ -137,7 +137,7 @@ Storing the memory usage change report as a [workflow artifact](https://help.git
 ```yaml
 - uses: arduino/actions/libraries/compile-examples@master
   with:
-    enable-size-deltas-report: true
+    enable-deltas-report: true
 - if: github.event_name == 'pull_request'
   uses: actions/upload-artifact@v1
   with:

action.yml

@@ -25,7 +25,7 @@ inputs:
   github-token:
     description: 'GitHub access token used to get information from the GitHub API. Only needed if you are using the size deltas report feature with a private repository.'
     default: ''
-  enable-size-deltas-report:
+  enable-deltas-report:
     description: 'Set to true to cause the action to determine the change in memory usage of the compiled sketches between the head and base refs of a PR and the immediate parent commit of a push'
     default: false
 runs:

compilesketches/compilesketches.py

@@ -28,6 +28,11 @@ def main():
               "sketches-report-path instead.")
         os.environ["INPUT_SKETCHES-REPORT-PATH"] = os.environ["INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME"]
 
+    if "INPUT_ENABLE-SIZE-DELTAS-REPORT" in os.environ:
+        print("::warning::The enable-size-deltas-report input is deprecated. Use the equivalent input: "
+              "enable-deltas-report instead.")
+        os.environ["INPUT_ENABLE-DELTAS-REPORT"] = os.environ["INPUT_ENABLE-SIZE-DELTAS-REPORT"]
+
     if "INPUT_ENABLE-SIZE-TRENDS-REPORT" in os.environ:
         print("::warning::The size trends report feature has been moved to a dedicated action. See the documentation "
               "at https://github.com/arduino/actions/tree/report-size-trends-action/libraries/report-size-trends")
@@ -40,7 +45,7 @@ def main():
         sketch_paths=os.environ["INPUT_SKETCH-PATHS"],
         verbose=os.environ["INPUT_VERBOSE"],
         github_token=os.environ["INPUT_GITHUB-TOKEN"],
-        enable_size_deltas_report=os.environ["INPUT_ENABLE-SIZE-DELTAS-REPORT"],
+        enable_deltas_report=os.environ["INPUT_ENABLE-DELTAS-REPORT"],
         sketches_report_path=os.environ["INPUT_SKETCHES-REPORT-PATH"]
     )
 
@@ -60,7 +65,7 @@ class CompileSketches:
                     recursively for sketches.
     verbose -- set to "true" for verbose output ("true", "false")
     github_token -- GitHub access token
-    enable_size_deltas_report -- set to "true" to cause the action to determine the change in memory usage
+    enable_deltas_report -- set to "true" to cause the action to determine the change in memory usage
                                  ("true", "false")
     sketches_report_path -- folder to save the sketches report to
     """
@@ -106,7 +111,7 @@ class ReportKeys:
     latest_release_indicator = "latest"
 
     def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, verbose, github_token,
-                 enable_size_deltas_report, sketches_report_path):
+                 enable_deltas_report, sketches_report_path):
         """Process, store, and validate the action's inputs."""
         self.cli_version = cli_version
 
@@ -129,13 +134,13 @@ def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, ve
         else:
             self.github_api = github.Github(login_or_token=github_token)
 
-        self.enable_size_deltas_report = parse_boolean_input(boolean_input=enable_size_deltas_report)
-        # The enable-size-deltas-report input has a default value so it should always be either True or False
-        if self.enable_size_deltas_report is None:
-            print("::error::Invalid value for enable-size-deltas-report input")
+        self.enable_deltas_report = parse_boolean_input(boolean_input=enable_deltas_report)
+        # The enable-deltas-report input has a default value so it should always be either True or False
+        if self.enable_deltas_report is None:
+            print("::error::Invalid value for enable-deltas-report input")
             sys.exit(1)
 
-        if self.enable_size_deltas_report:
+        if self.enable_deltas_report:
             self.deltas_base_ref = self.get_deltas_base_ref()
         else:
             # If deltas reports are not enabled, there is no use for the base ref and it could result in an GitHub API
@@ -882,7 +887,7 @@ def get_sketch_report(self, compilation_result):
         """
         current_sizes = self.get_sizes_from_output(compilation_result=compilation_result)
         previous_sizes = None
-        if self.do_size_deltas_report(compilation_result=compilation_result, current_sizes=current_sizes):
+        if self.do_deltas_report(compilation_result=compilation_result, current_sizes=current_sizes):
             # Get data for the sketch at the base ref
             # Get the head ref
             repository = git.Repo(path=os.environ["GITHUB_WORKSPACE"])
@@ -1003,15 +1008,15 @@ def get_size_data_from_output(self, compilation_output, memory_type, size_data_t
 
         return size_data
 
-    def do_size_deltas_report(self, compilation_result, current_sizes):
+    def do_deltas_report(self, compilation_result, current_sizes):
         """Return whether size deltas reporting is enabled.
 
         Keyword arguments:
         compilation_result -- object returned by compile_sketch()
         current_sizes -- memory usage data from the compilation
         """
         return (
-            self.enable_size_deltas_report
+            self.enable_deltas_report
             and compilation_result.success
             and any(size.get(self.ReportKeys.absolute) != self.not_applicable_indicator for
                     size in current_sizes)

compilesketches/tests/test_compilesketches.py

@@ -29,7 +29,7 @@ def get_compilesketches_object(
     github_token="",
     github_api=unittest.mock.sentinel.github_api,
     deltas_base_ref="foodeltasbaseref",
-    enable_size_deltas_report="false",
+    enable_deltas_report="false",
     sketches_report_path="foo report_folder_name"
 ):
     with unittest.mock.patch("compilesketches.CompileSketches.get_deltas_base_ref",
@@ -42,7 +42,7 @@ def get_compilesketches_object(
                                                                  sketch_paths=sketch_paths,
                                                                  verbose=verbose,
                                                                  github_token=github_token,
-                                                                 enable_size_deltas_report=enable_size_deltas_report,
+                                                                 enable_deltas_report=enable_deltas_report,
                                                                  sketches_report_path=sketches_report_path)
 
     compilesketches_object.github_api = github_api
@@ -80,6 +80,9 @@ def test_directories_are_same():
 
 
 @pytest.mark.parametrize("use_size_report_sketch", [True, False])
+@pytest.mark.parametrize("use_enable_size_deltas_report, expected_enable_deltas_report",
+                         [(True, "FooEnableSizeDeltasReport"),
+                          (False, "FooEnableDeltasReport")])
 @pytest.mark.parametrize("use_size_deltas_report_folder_name, expected_sketches_report_path",
                          [(True, "FooSizeDeltasReportFolderName"),
                           (False, "FooSketchesReportPath")])
@@ -88,6 +91,8 @@ def test_main(capsys,
               monkeypatch,
               mocker,
               use_size_report_sketch,
+              use_enable_size_deltas_report,
+              expected_enable_deltas_report,
               use_size_deltas_report_folder_name,
               expected_sketches_report_path,
               use_enable_size_trends_report):
@@ -98,7 +103,8 @@ def test_main(capsys,
     sketch_paths = "foo/Sketch bar/OtherSketch"
     verbose = "true"
     github_token = "FooGitHubToken"
-    enable_size_deltas_report = "true"
+    enable_size_deltas_report = "FooEnableSizeDeltasReport"
+    enable_deltas_report = "FooEnableDeltasReport"
     sketches_report_path = "FooSketchesReportPath"
     size_deltas_report_folder_name = "FooSizeDeltasReportFolderName"
 
@@ -115,7 +121,9 @@ def compile_sketches(self):
     monkeypatch.setenv("INPUT_VERBOSE", verbose)
     if use_size_report_sketch:
         monkeypatch.setenv("INPUT_SIZE-REPORT-SKETCH", "foo")
-    monkeypatch.setenv("INPUT_ENABLE-SIZE-DELTAS-REPORT", enable_size_deltas_report)
+    if use_enable_size_deltas_report:
+        monkeypatch.setenv("INPUT_ENABLE-SIZE-DELTAS-REPORT", enable_size_deltas_report)
+    monkeypatch.setenv("INPUT_ENABLE-DELTAS-REPORT", enable_deltas_report)
     monkeypatch.setenv("INPUT_SKETCHES-REPORT-PATH", sketches_report_path)
     if use_size_deltas_report_folder_name:
         monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME", size_deltas_report_folder_name)
@@ -138,6 +146,14 @@ def compile_sketches(self):
             + "::warning::The size-deltas-report-folder-name input is deprecated. Use the equivalent input: "
               "sketches-report-path instead."
         )
+    if use_enable_size_deltas_report:
+        if expected_output != "":
+            expected_output = expected_output + "\n"
+        expected_output = (
+            expected_output
+            + "::warning::The enable-size-deltas-report input is deprecated. Use the equivalent input: "
+              "enable-deltas-report instead."
+        )
     if use_enable_size_trends_report:
         if expected_output != "":
             expected_output = expected_output + "\n"
@@ -157,7 +173,7 @@ def compile_sketches(self):
         sketch_paths=sketch_paths,
         verbose=verbose,
         github_token=github_token,
-        enable_size_deltas_report=enable_size_deltas_report,
+        enable_deltas_report=expected_enable_deltas_report,
         sketches_report_path=expected_sketches_report_path
     )
     CompileSketches.compile_sketches.assert_called_once()
@@ -175,7 +191,7 @@ def test_compilesketches():
     verbose = "false"
     github_token = "fooGitHubToken"
     expected_deltas_base_ref = unittest.mock.sentinel.deltas_base_ref
-    enable_size_deltas_report = "true"
+    enable_deltas_report = "true"
     sketches_report_path = "FooSketchesReportFolder"
 
     with unittest.mock.patch("compilesketches.CompileSketches.get_deltas_base_ref",
@@ -189,7 +205,7 @@ def test_compilesketches():
             sketch_paths=sketch_paths,
             verbose=verbose,
             github_token=github_token,
-            enable_size_deltas_report=enable_size_deltas_report,
+            enable_deltas_report=enable_deltas_report,
             sketches_report_path=sketches_report_path
         )
 
@@ -201,15 +217,15 @@ def test_compilesketches():
     assert compile_sketches.sketch_paths == expected_sketch_paths_list
     assert compile_sketches.verbose is False
     assert compile_sketches.deltas_base_ref == expected_deltas_base_ref
-    assert compile_sketches.enable_size_deltas_report is True
+    assert compile_sketches.enable_deltas_report is True
     assert compile_sketches.sketches_report_path == pathlib.PurePath(sketches_report_path)
 
-    # Test invalid enable_size_deltas_report value
+    # Test invalid enable_deltas_report value
     with pytest.raises(expected_exception=SystemExit, match="1"):
-        get_compilesketches_object(enable_size_deltas_report="fooInvalidEnableSizeDeltasBoolean")
+        get_compilesketches_object(enable_deltas_report="fooInvalidEnableSizeDeltasBoolean")
 
     # Test deltas_base_ref when size deltas report is disabled
-    compile_sketches = get_compilesketches_object(enable_size_deltas_report="false")
+    compile_sketches = get_compilesketches_object(enable_deltas_report="false")
     assert compile_sketches.deltas_base_ref is None
 
 
@@ -1312,8 +1328,8 @@ class CompilationData:
     assert compilation_result.output == stdout
 
 
-@pytest.mark.parametrize("do_size_deltas_report", [True, False])
-def test_get_sketch_report(mocker, do_size_deltas_report):
+@pytest.mark.parametrize("do_deltas_report", [True, False])
+def test_get_sketch_report(mocker, do_deltas_report):
     original_git_ref = unittest.mock.sentinel.original_git_ref
     sizes_list = [unittest.mock.sentinel.sketch_report_list1, unittest.mock.sentinel.sketch_report_list2]
     sketch = "/foo/SketchName"
@@ -1345,8 +1361,8 @@ def checkout(self):
 
     mocker.patch("compilesketches.CompileSketches.get_sizes_from_output", autospec=True,
                  side_effect=sizes_list)
-    mocker.patch("compilesketches.CompileSketches.do_size_deltas_report", autospec=True,
-                 return_value=do_size_deltas_report)
+    mocker.patch("compilesketches.CompileSketches.do_deltas_report", autospec=True,
+                 return_value=do_deltas_report)
     mocker.patch("git.Repo", autospec=True, return_value=Repo())
     mocker.patch("compilesketches.CompileSketches.checkout_deltas_base_ref", autospec=True)
     mocker.patch("compilesketches.CompileSketches.compile_sketch", autospec=True,
@@ -1357,10 +1373,11 @@ def checkout(self):
     sketch_report = compile_sketches.get_sketch_report(compilation_result=compilation_result)
 
     get_sizes_from_output_calls = [unittest.mock.call(compile_sketches, compilation_result=compilation_result)]
-    compilesketches.CompileSketches.do_size_deltas_report.assert_called_once_with(compile_sketches,
-                                                                                  compilation_result=compilation_result,
-                                                                                  current_sizes=sizes_list[0])
-    if do_size_deltas_report:
+    # noinspection PyUnresolvedReferences
+    compilesketches.CompileSketches.do_deltas_report.assert_called_once_with(compile_sketches,
+                                                                             compilation_result=compilation_result,
+                                                                             current_sizes=sizes_list[0])
+    if do_deltas_report:
         git.Repo.assert_called_once_with(path=os.environ["GITHUB_WORKSPACE"])
         compile_sketches.checkout_deltas_base_ref.assert_called_once()
         compile_sketches.compile_sketch.assert_called_once_with(compile_sketches, sketch_path=compilation_result.sketch)
@@ -1576,10 +1593,10 @@ def test_get_size_data_from_output(capsys, compilation_output, memory_type, size
 
 
 @pytest.mark.parametrize(
-    "enable_size_deltas_report,"
+    "enable_deltas_report,"
     "compilation_success,"
     "current_sizes,"
-    "do_size_deltas_report_expected",
+    "do_deltas_report_expected",
     [("true",
       True,
       [{compilesketches.CompileSketches.ReportKeys.name: "foo",
@@ -1605,19 +1622,19 @@ def test_get_size_data_from_output(capsys, compilation_output, memory_type, size
         compilesketches.CompileSketches.ReportKeys.absolute: compilesketches.CompileSketches.not_applicable_indicator}],
       False)]
 )
-def test_do_size_deltas_report(monkeypatch,
-                               enable_size_deltas_report,
-                               compilation_success,
-                               current_sizes,
-                               do_size_deltas_report_expected):
-    compile_sketches = get_compilesketches_object(enable_size_deltas_report=enable_size_deltas_report)
+def test_do_deltas_report(monkeypatch,
+                          enable_deltas_report,
+                          compilation_success,
+                          current_sizes,
+                          do_deltas_report_expected):
+    compile_sketches = get_compilesketches_object(enable_deltas_report=enable_deltas_report)
 
     compilation_result = type("CompilationResult", (),
                               {"sketch": "/foo/SketchName",
                                "success": compilation_success,
                                "output": "foo compilation output"})
-    assert compile_sketches.do_size_deltas_report(compilation_result=compilation_result,
-                                                  current_sizes=current_sizes) == do_size_deltas_report_expected
+    assert compile_sketches.do_deltas_report(compilation_result=compilation_result,
+                                             current_sizes=current_sizes) == do_deltas_report_expected
 
 
 def test_checkout_deltas_base_ref(monkeypatch, mocker):
@@ -1635,7 +1652,7 @@ def fetch(self):
         def checkout(self):
             pass  # pragma: no cover
 
-    compile_sketches = get_compilesketches_object(enable_size_deltas_report="true", deltas_base_ref=deltas_base_ref)
+    compile_sketches = get_compilesketches_object(enable_deltas_report="true", deltas_base_ref=deltas_base_ref)
 
     mocker.patch("git.Repo", autospec=True, return_value=Repo())
     mocker.patch.object(Repo, "fetch")