Add data for all sketches to the sketches report

Previously, the user was required to select an arbitrary sketch, and only data for that sketch was reported. It's not certain that a single sketch will provide sufficient coverage to produce comprehensive report data.

Author: per1234

README.md

@@ -109,10 +109,6 @@ List of paths containing sketches to compile. These paths will be searched recur
 
 Set to true to show verbose output in the log. Default `false`
 
-### `size-report-sketch`
-
-Name of the sketch used to compare memory usage change. Default `""`.
-
 ### `sketches-report-path`
 
 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. This report is used by the `arduino/libraries/report-size-deltas` and `arduino/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
@@ -123,7 +119,7 @@ GitHub access token used to get information from the GitHub API. Only needed if
 
 ### `enable-size-deltas-report`
 
-Set to `true` to cause the action to determine the change in memory usage for the [`size-reports-sketch`](#size-reports-sketch) between the pull request branch and the tip of the pull request's base branch. 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`.
+Set to `true` to cause the action to determine the change in memory usage of the compiled sketches between the pull request branch and the tip of the pull request's base branch. 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`.
 
 ## Example usage
 
@@ -142,7 +138,6 @@ Storing the memory usage change report as a [workflow artifact](https://help.git
 ```yaml
 - uses: arduino/actions/libraries/compile-examples@master
   with:
-    size-report-sketch: Foobar
     enable-size-deltas-report: true
 - if: github.event_name == 'pull_request'
   uses: actions/upload-artifact@v1

action.yml

@@ -19,17 +19,14 @@ inputs:
   verbose:
     description: 'Set to true to show verbose output in the log'
     default: false
-  size-report-sketch:
-    description: 'Name of the sketch used to compare memory usage change'
-    default: ''
   sketches-report-path:
     description: 'Path in which to save a JSON formatted file containing data from the sketch compilations'
     default: 'size-deltas-reports'
   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:
-    description: 'Set to true to cause the action to determine the change in memory usage for the size-reports-sketch'
+    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'
     default: false
 runs:
   using: 'docker'

compilesketches/compilesketches.py

@@ -20,6 +20,9 @@
 
 
 def main():
+    if "INPUT_SIZE-REPORT-SKETCH" in os.environ:
+        print("::warning::The size-report-sketch input is no longer used")
+
     if "INPUT_SIZE-DELTAS-REPORT-FOLDER-NAME" in os.environ:
         print("::warning::The size-deltas-report-folder-name input is deprecated. Use the equivalent input: "
               "sketches-report-path instead.")
@@ -37,7 +40,6 @@ def main():
         sketch_paths=os.environ["INPUT_SKETCH-PATHS"],
         verbose=os.environ["INPUT_VERBOSE"],
         github_token=os.environ["INPUT_GITHUB-TOKEN"],
-        report_sketch=os.environ["INPUT_SIZE-REPORT-SKETCH"],
         enable_size_deltas_report=os.environ["INPUT_ENABLE-SIZE-DELTAS-REPORT"],
         sketches_report_path=os.environ["INPUT_SKETCHES-REPORT-PATH"]
     )
@@ -58,9 +60,8 @@ class CompileSketches:
                     recursively for sketches.
     verbose -- set to "true" for verbose output ("true", "false")
     github_token -- GitHub access token
-    report_sketch -- name of the sketch to make the report for
-    enable_size_deltas_report -- set to "true" to cause the action to determine the change in memory usage for the
-                                 report_sketch ("true", "false")
+    enable_size_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
     """
 
@@ -101,7 +102,7 @@ class ReportKeys:
 
     latest_release_indicator = "latest"
 
-    def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, verbose, github_token, report_sketch,
+    def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, verbose, github_token,
                  enable_size_deltas_report, sketches_report_path):
         """Process, store, and validate the action's inputs."""
         self.cli_version = cli_version
@@ -125,8 +126,6 @@ def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, ve
         else:
             self.github_api = github.Github(login_or_token=github_token)
 
-        self.report_sketch = report_sketch
-
         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:
@@ -135,10 +134,6 @@ def __init__(self, cli_version, fqbn_arg, platforms, libraries, sketch_paths, ve
 
         self.sketches_report_path = pathlib.PurePath(sketches_report_path)
 
-        if self.enable_size_deltas_report and self.report_sketch == "":
-            print("::error::size-report-sketch input was not defined")
-            sys.exit(1)
-
     def compile_sketches(self):
         """Do compilation tests and record data."""
         self.install_arduino_cli()
@@ -151,7 +146,7 @@ def compile_sketches(self):
 
         # Compile all sketches under the paths specified by the sketch-paths input
         all_compilations_successful = True
-        sketches_report = []
+        sketch_report_list = []
 
         sketch_list = self.find_sketches()
         for sketch in sketch_list:
@@ -160,14 +155,11 @@ def compile_sketches(self):
                 all_compilations_successful = False
 
             # Store the size data for this sketch
-            sketches_report.append(self.get_sketch_report(compilation_result=compilation_result))
+            sketch_report_list.append(self.get_sketch_report(compilation_result=compilation_result))
 
-        if self.report_sketch != "":
-            # Make sketch reports
-            sketch_report = self.get_sketch_report_from_sketches_report(sketches_report=sketches_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)
+        sketches_report = self.get_sketches_report(sketch_report_list=sketch_report_list)
+
+        self.create_sketches_report_file(sketches_report=sketches_report)
 
         if not all_compilations_successful:
             print("::error::One or more compilations failed")
@@ -802,22 +794,6 @@ def get_sketch_report(self, compilation_result):
 
         return sketch_report
 
-    def get_sketch_report_from_sketches_report(self, sketches_report):
-        """Return the report for the report sketch
-        Keyword arguments:
-        sketches_report -- list containing the reports for all sketches
-        """
-        # TODO: The plan is to switch to reporting memory usage data for all sketches, rather than only a single sketch.
-        #       The current system of unnecessarily storing data for all sketches, then searching back through it for a
-        #       single item to report is in anticipation of that change
-        for sketch_report in sketches_report:
-            if self.is_report_sketch(sketch_path=sketch_report[self.ReportKeys.name]):
-                return sketch_report
-
-        # Data for the size reports sketch was not found
-        print("::error::size-report-sketch:", self.report_sketch, "was not found")
-        sys.exit(1)
-
     def get_sizes_from_output(self, compilation_result):
         """Parse the stdout from the compilation process and return a list containing memory usage data.
 
@@ -870,7 +846,7 @@ def get_sizes_from_output(self, compilation_result):
         return sizes
 
     def do_size_deltas_report(self, compilation_result, current_sizes):
-        """Return whether size deltas reporting is enabled for the given sketch.
+        """Return whether size deltas reporting is enabled.
 
         Keyword arguments:
         compilation_result -- object returned by compile_sketch()
@@ -879,23 +855,11 @@ def do_size_deltas_report(self, compilation_result, current_sizes):
         return (
             self.enable_size_deltas_report
             and os.environ["GITHUB_EVENT_NAME"] == "pull_request"
-            and self.is_report_sketch(sketch_path=compilation_result.sketch)
             and compilation_result.success
             and any(size.get(self.ReportKeys.absolute) != self.not_applicable_indicator for
                     size in current_sizes)
         )
 
-    def is_report_sketch(self, sketch_path):
-        """Return whether the given sketch is the report sketch.
-
-        Keyword arguments:
-        sketch_path -- path to the sketch
-        """
-        # TODO: yes, it was silly to identify the report sketch only by the name, rather than the path, but the whole
-        #       concept of the size report sketch will be removed soon when the behavior is switched to reporting memory
-        #       usage for all sketches. So for now, it's best to simply continue with the existing behavior.
-        return pathlib.PurePath(sketch_path).name == self.report_sketch
-
     def checkout_pull_request_base_ref(self):
         """git checkout the base ref of the pull request"""
         repository = git.Repo(path=os.environ["GITHUB_WORKSPACE"])