Rename size-deltas-reports-artifact-name input to sketches-reports-source-name

Preparation to use the input for specifying the source of sketches reports either in a workflow artifact or a local folder.

The old input name is still supported but warning will be displayed in the build log to explain the name change.

Author: per1234

README.md

@@ -8,7 +8,7 @@ This action comments on the pull request with a report on the resulting change i
 
 ## Inputs
 
-### `size-deltas-reports-artifact-name`
+### `sketches-reports-source-name`
 
 Name of the [workflow artifact](https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts) that contains the memory usage data, as specified to the [`actions/upload-artifact`](https://github.com/actions/upload-artifact) action via its `name` input.
 

action.yml

@@ -1,8 +1,8 @@
 name: 'Report Arduino Sketch Size Deltas'
 description: 'Comments on the pull request with a report on the resulting change in memory usage of Arduino sketches'
 inputs:
-  size-deltas-reports-artifact-name:
-    description: 'Name of the workflow artifact that contains the memory usage data, as specified to the actions/upload-artifact action via its name input'
+  sketches-reports-source-name:
+    description: 'When run from scheduled workflow, name of the workflow artifact that contains sketches reports. When run from a pull request triggered workflow, path to the folder containing sketches reports.'
     default: 'size-deltas-reports'
   github-token:
     description: 'GitHub access token used to comment the memory usage comparison results to the PR thread'

reportsizedeltas/reportsizedeltas.py

@@ -19,8 +19,13 @@
 def main():
     set_verbosity(enable_verbosity=False)
 
+    if "INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME" in os.environ:
+        print("::warning::The size-deltas-report-artifact-name input is deprecated. Use the equivalent input: "
+              "sketches-reports-source-name instead.")
+        os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"] = os.environ["INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME"]
+
     report_size_deltas = ReportSizeDeltas(repository_name=os.environ["GITHUB_REPOSITORY"],
-                                          artifact_name=os.environ["INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME"],
+                                          sketches_reports_source_name=os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"],
                                           token=os.environ["INPUT_GITHUB-TOKEN"])
 
     report_size_deltas.report_size_deltas()
@@ -73,9 +78,9 @@ class ReportKeys:
         sketches = "sketches"
         compilation_success = "compilation_success"
 
-    def __init__(self, repository_name, artifact_name, token):
+    def __init__(self, repository_name, sketches_reports_source_name, token):
         self.repository_name = repository_name
-        self.artifact_name = artifact_name
+        self.sketches_reports_source_name = sketches_reports_source_name
         self.token = token
 
     def report_size_deltas(self):
@@ -209,7 +214,7 @@ def get_artifact_download_url_for_run(self, run_id):
 
             for artifact_data in artifacts_data["artifacts"]:
                 # The artifact is identified by a specific name
-                if artifact_data["name"] == self.artifact_name:
+                if artifact_data["name"] == self.sketches_reports_source_name:
                     return artifact_data["archive_download_url"]
 
             page_number += 1
@@ -228,12 +233,13 @@ def get_artifact(self, artifact_download_url):
         artifact_folder_object = tempfile.TemporaryDirectory(prefix="reportsizedeltas-")
         try:
             # Download artifact
-            with open(file=artifact_folder_object.name + "/" + self.artifact_name + ".zip", mode="wb") as out_file:
+            with open(file=artifact_folder_object.name + "/" + self.sketches_reports_source_name + ".zip",
+                      mode="wb") as out_file:
                 with self.raw_http_request(url=artifact_download_url) as fp:
                     out_file.write(fp.read())
 
             # Unzip artifact
-            artifact_zip_file = artifact_folder_object.name + "/" + self.artifact_name + ".zip"
+            artifact_zip_file = artifact_folder_object.name + "/" + self.sketches_reports_source_name + ".zip"
             with zipfile.ZipFile(file=artifact_zip_file, mode="r") as zip_ref:
                 zip_ref.extractall(path=artifact_folder_object.name)
             os.remove(artifact_zip_file)

reportsizedeltas/tests/test_reportsizedeltas.py

@@ -1,6 +1,7 @@
 import distutils.dir_util
 import filecmp
 import json
+import os
 import pathlib
 import tempfile
 import unittest.mock
@@ -18,16 +19,17 @@
 
 
 def get_reportsizedeltas_object(repository_name="FooOwner/BarRepository",
-                                artifact_name="foo-artifact-name",
+                                sketches_reports_source_name="foo-artifact-name",
                                 token="foo token"):
     """Return a reportsizedeltas.ReportSizeDeltas object to use in tests.
 
     Keyword arguments:
     repository_name -- repository owner and name e.g., octocat/Hello-World
-    artifact_name -- name of the workflow artifact that contains the memory usage data
+    sketches_reports_source_name -- name of the workflow artifact that contains the memory usage data
     token -- GitHub access token
     """
-    return reportsizedeltas.ReportSizeDeltas(repository_name=repository_name, artifact_name=artifact_name, token=token)
+    return reportsizedeltas.ReportSizeDeltas(repository_name=repository_name,
+                                             sketches_reports_source_name=sketches_reports_source_name, token=token)
 
 
 def directories_are_same(left_directory, right_directory):
@@ -89,33 +91,85 @@ def test_directories_are_same(tmp_path):
     assert directories_are_same(left_directory=left_directory, right_directory=right_directory) is True
 
 
-def test_main(monkeypatch, mocker):
-    repository_name = "FooOwner/BarRepository"
-    artifact_name = "foo-artifact-name"
-    token = "foo GitHub token"
-    monkeypatch.setenv("GITHUB_REPOSITORY", repository_name)
-    monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME", artifact_name)
-    monkeypatch.setenv("INPUT_GITHUB-TOKEN", token)
+@pytest.fixture
+def setup_environment_variables(monkeypatch):
+    """Test fixture that sets up the environment variables required by reportsizedeltas.main() and returns an object
+    containing the values"""
 
+    class ActionInputs:
+        """A container for the values of the environment variables"""
+        repository_name = "GoldenOwner/GoldenRepository"
+        sketches_reports_source_name = "golden-artifact-name"
+        token = "golden-github-token"
+
+    monkeypatch.setenv("GITHUB_REPOSITORY", ActionInputs.repository_name)
+    monkeypatch.setenv("INPUT_SKETCHES-REPORTS-SOURCE-NAME", ActionInputs.sketches_reports_source_name)
+    monkeypatch.setenv("INPUT_GITHUB-TOKEN", ActionInputs.token)
+
+    return ActionInputs()
+
+
+def test_main(monkeypatch, mocker, setup_environment_variables):
     class ReportSizeDeltas:
         """Stub"""
 
         def report_size_deltas(self):
             """Stub"""
-            pass    # pragma: no cover
+            pass  # pragma: no cover
 
     mocker.patch("reportsizedeltas.set_verbosity", autospec=True)
     mocker.patch("reportsizedeltas.ReportSizeDeltas", autospec=True, return_value=ReportSizeDeltas())
     mocker.patch.object(ReportSizeDeltas, "report_size_deltas")
     reportsizedeltas.main()
 
     reportsizedeltas.set_verbosity.assert_called_once_with(enable_verbosity=False)
-    reportsizedeltas.ReportSizeDeltas.assert_called_once_with(repository_name=repository_name,
-                                                              artifact_name=artifact_name,
-                                                              token=token)
+    reportsizedeltas.ReportSizeDeltas.assert_called_once_with(
+        repository_name=setup_environment_variables.repository_name,
+        sketches_reports_source_name=setup_environment_variables.sketches_reports_source_name,
+        token=setup_environment_variables.token
+    )
     ReportSizeDeltas.report_size_deltas.assert_called_once()
 
 
+@pytest.mark.parametrize("use_size_deltas_report_artifact_name", [True, False])
+def test_main_size_deltas_report_artifact_name_deprecation_warning(capsys,
+                                                                   mocker,
+                                                                   monkeypatch, setup_environment_variables,
+                                                                   use_size_deltas_report_artifact_name):
+    size_deltas_report_artifact_name = "golden-size-deltas-report-artifact-name-value"
+
+    if use_size_deltas_report_artifact_name:
+        monkeypatch.setenv("INPUT_SIZE-DELTAS-REPORTS-ARTIFACT-NAME", size_deltas_report_artifact_name)
+        expected_sketches_reports_source_name = size_deltas_report_artifact_name
+    else:
+        expected_sketches_reports_source_name = setup_environment_variables.sketches_reports_source_name
+
+    class ReportSizeDeltas:
+        """Stub"""
+
+        def report_size_deltas(self):
+            """Stub"""
+            pass  # pragma: no cover
+
+    mocker.patch("reportsizedeltas.set_verbosity", autospec=True)
+    mocker.patch("reportsizedeltas.ReportSizeDeltas", autospec=True, return_value=ReportSizeDeltas())
+    mocker.patch.object(ReportSizeDeltas, "report_size_deltas")
+
+    reportsizedeltas.main()
+
+    expected_output = ""
+    if use_size_deltas_report_artifact_name:
+        expected_output = (
+            expected_output
+            + "::warning::The size-deltas-report-artifact-name input is deprecated. Use the equivalent input: "
+              "sketches-reports-source-name instead."
+        )
+
+    assert capsys.readouterr().out.strip() == expected_output
+
+    assert os.environ["INPUT_SKETCHES-REPORTS-SOURCE-NAME"] == expected_sketches_reports_source_name
+
+
 def test_set_verbosity():
     with pytest.raises(TypeError):
         reportsizedeltas.set_verbosity(enable_verbosity=2)
@@ -303,14 +357,14 @@ def test_get_artifact_download_url_for_sha():
 
 def test_get_artifact_download_url_for_run():
     repository_name = "test_name/test_repo"
-    artifact_name = "test_artifact_name"
+    sketches_reports_source_name = "test_sketches_reports_source_name"
     archive_download_url = "archive_download_url"
     run_id = "1234"
 
     report_size_deltas = get_reportsizedeltas_object(repository_name=repository_name,
-                                                     artifact_name=artifact_name)
+                                                     sketches_reports_source_name=sketches_reports_source_name)
 
-    json_data = {"artifacts": [{"name": artifact_name, "archive_download_url": archive_download_url},
+    json_data = {"artifacts": [{"name": sketches_reports_source_name, "archive_download_url": archive_download_url},
                                {"name": "bar123", "archive_download_url": "wrong_artifact_url"}]}
     report_size_deltas.api_request = unittest.mock.MagicMock(return_value={"json_data": json_data,
                                                                            "additional_pages": False,
@@ -621,7 +675,7 @@ def test_get_sketches_reports(sketches_reports_path, expected_sketches_reports):
     try:
         distutils.dir_util.copy_tree(src=str(sketches_reports_path),
                                      dst=artifact_folder_object.name)
-    except Exception:   # pragma: no cover
+    except Exception:  # pragma: no cover
         artifact_folder_object.cleanup()
         raise
     sketches_reports = report_size_deltas.get_sketches_reports(artifact_folder_object=artifact_folder_object)
@@ -662,7 +716,7 @@ def test_generate_report():
     try:
         distutils.dir_util.copy_tree(src=str(sketches_report_path),
                                      dst=artifact_folder_object.name)
-    except Exception:   # pragma: no cover
+    except Exception:  # pragma: no cover
         artifact_folder_object.cleanup()
         raise
     sketches_reports = report_size_deltas.get_sketches_reports(artifact_folder_object=artifact_folder_object)