Add support of macrobenchmark result analysis in fireci (#4285)

Author: yifanyang

.github/workflows/copyright-check.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/[email protected]
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - run: |
           pip install -e "ci/fireci"
       - run: |

.github/workflows/fireci.yml

@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/[email protected]
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - run: |
           pip install -e "ci/fireci[test]"
       - run: |

.gitignore

@@ -11,4 +11,5 @@ firebase-crashlytics-ndk/.externalNativeBuild/
 firebase-crashlytics-ndk/.cxx/
 smoke-test-logs/
 smoke-tests/build-debug-headGit-smoke-test
-smoke-tests/firehorn.log
+smoke-tests/firehorn.log
+macrobenchmark-output.json

ci/fireci/fireci/internal.py

@@ -13,14 +13,14 @@
 # limitations under the License.
 
 import click
-import contextlib
 import functools
 import glob
 import itertools
 import logging
 import os
 import shutil
 
+from contextlib import contextmanager, nullcontext
 
 _logger = logging.getLogger('fireci')
 
@@ -30,7 +30,7 @@ def _ensure_dir(directory):
     os.makedirs(directory)
 
 
-@contextlib.contextmanager
+@contextmanager
 def _artifact_handler(target_directory, artifact_patterns):
   _logger.debug(
       'Artifacts will be searched for in directories matching {} patterns and placed in {}'
@@ -45,7 +45,7 @@ def _artifact_handler(target_directory, artifact_patterns):
       target_name = os.path.join(target_directory, "_".join(path.split('/')))
       _logger.debug('Copying artifact {} to {}'.format(path, target_name))
       if os.path.isdir(path):
-        shutil.copytree(path, target_name)
+        shutil.copytree(path, target_name, dirs_exist_ok=True)
       else:
         shutil.copyfile(path, target_name)
 
@@ -68,8 +68,8 @@ class _CommonOptions:
     '--artifact-patterns',
     default=('**/build/test-results', '**/build/reports'),
     help=
-    'Shell-style artifact patterns that are copied into `artifact-target-dir`.'\
-        'Can be specified multiple times.',
+    'Shell-style artifact patterns that are copied into `artifact-target-dir`. '
+    'Can be specified multiple times.',
     multiple=True,
     type=str,
 )
@@ -83,30 +83,34 @@ def main(options, **kwargs):
     setattr(options, k, v)
 
 
-def ci_command(name=None):
+def ci_command(name=None, cls=click.Command, group=main):
   """Decorator to use for CI commands.
 
        The differences from the standard @click.command are:
 
        * Allows configuration of artifacts that are uploaded for later viewing in CI.
-       * Registers the command automatically
+       * Registers the command automatically.
 
-       :param name: Optional name of the task. Defaults to the function name that is decorated with
-                    this decorator.
+       :param name:  Optional name of the task. Defaults to the function name that is decorated with this decorator.
+       :param cls:   Specifies whether the func is a command or a command group. Defaults to `click.Command`.
+       :param group: Specifies the group the command belongs to. Defaults to the `main` command group.
     """
 
   def ci_command(f):
     actual_name = f.__name__ if name is None else name
 
-    @main.command(name=actual_name, help=f.__doc__)
+    @click.command(name=actual_name, cls=cls, help=f.__doc__)
     @_pass_options
     @click.pass_context
     def new_func(ctx, options, *args, **kwargs):
       with _artifact_handler(
           options.artifact_target_dir,
-          options.artifact_patterns):
+          options.artifact_patterns,
+      ) if cls is click.Command else nullcontext():
         return ctx.invoke(f, *args, **kwargs)
 
+    group.add_command(new_func)
+
     return functools.update_wrapper(new_func, f)
 
   return ci_command

ci/fireci/fireci/plugins.py

@@ -27,7 +27,7 @@ def discover():
      Note: plugins *must* define the `firebaseplugins` package as a namespace package.
            See: https://packaging.python.org/guides/packaging-namespace-packages/
   """
-  modules = pkgutil.iter_modules(fireciplugins.__path__,
-                                 fireciplugins.__name__ + ".")
+  modules = pkgutil.walk_packages(fireciplugins.__path__,
+                                  fireciplugins.__name__ + ".")
   for _, name, _ in modules:
     importlib.import_module(name)