feat: add py_unittest in casp and refactor butler

Author: PauloVLB

butler.py

@@ -98,6 +98,30 @@ def _setup_args_for_remote(parser):
   subparsers.add_parser('reboot', help='Reboot with `sudo reboot`.')
 
 
+def _add_py_unittest_subparser(toplevel_subparsers):
+  """Adds a parser for the `py_unittest` command."""
+  parser_py_unittest = toplevel_subparsers.add_parser(
+      'py_unittest', help='Run Python unit tests.')
+  parser_py_unittest.add_argument(
+      '-p', '--pattern', help='Pattern for test files. Default is *_test.py.')
+  parser_py_unittest.add_argument(
+      '-u',
+      '--unsuppress-output',
+      action='store_true',
+      help='Unsuppress output from `print`. Good for debugging.')
+  parser_py_unittest.add_argument(
+      '-m', '--parallel', action='store_true', help='Run tests in parallel.')
+  parser_py_unittest.add_argument(
+      '-v', '--verbose', action='store_true', help='Print logs from tests.')
+  parser_py_unittest.add_argument(
+      '-t',
+      '--target',
+      required=True,
+      choices=['appengine', 'core', 'modules', 'cli'])
+  parser_py_unittest.add_argument(
+      '-c', '--config-dir', help='Config dir to use for module tests.')
+
+
 def _add_lint_subparser(toplevel_subparsers):
   """Adds a parser for the `lint` command."""
   parser = toplevel_subparsers.add_parser(
@@ -298,24 +322,6 @@ def main():
       help=('Install all required dependencies for running an appengine, a bot,'
             'and a mapreduce locally.'))
 
-  parser_py_unittest = subparsers.add_parser(
-      'py_unittest', help='Run Python unit tests.')
-  parser_py_unittest.add_argument(
-      '-p', '--pattern', help='Pattern for test files. Default is *_test.py.')
-  parser_py_unittest.add_argument(
-      '-u',
-      '--unsuppress-output',
-      action='store_true',
-      help='Unsuppress output from `print`. Good for debugging.')
-  parser_py_unittest.add_argument(
-      '-m', '--parallel', action='store_true', help='Run tests in parallel.')
-  parser_py_unittest.add_argument(
-      '-v', '--verbose', action='store_true', help='Print logs from tests.')
-  parser_py_unittest.add_argument(
-      '-t', '--target', required=True, choices=['appengine', 'core', 'modules'])
-  parser_py_unittest.add_argument(
-      '-c', '--config-dir', help='Config dir to use for module tests.')
-
   parser_js_unittest = subparsers.add_parser(
       'js_unittest', help='Run Javascript unit tests.')
   parser_js_unittest.add_argument(
@@ -448,6 +454,7 @@ def main():
       default='us-central',
       help='Location for App Engine.')
 
+  _add_py_unittest_subparser(subparsers)
   _add_lint_subparser(subparsers)
   _add_format_subparser(subparsers)
   _add_integration_tests_subparsers(subparsers)

cli/casp/src/casp/commands/py_unittest.py

@@ -8,15 +8,83 @@
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.S
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Py unittest command."""
+"""Run Python unit tests command."""
 
+import subprocess
+import sys
+
+from casp.utils import local_butler
 import click
 
 
-@click.command(name='py_unittest', help='Run Python unit tests.')
-def cli():
-  """Run Python unit tests."""
-  click.echo('To be implemented...')
+@click.command(
+    name='py_unittest',
+    help=('Runs Python unit tests. '
+          'You can specify a pattern for test files, '
+          'run tests in parallel, unsuppress output, '
+          'or print verbose logs.'))
+@click.option(
+    '--pattern',
+    '-p',
+    help='Pattern for test files. Default is *_test.py.')
+@click.option(
+    '--unsuppress-output',
+    '-u',
+    is_flag=True,
+    default=False,
+    help='Unsuppress output from `print`. Good for debugging.')
+@click.option(
+    '--parallel',
+    '-m',
+    is_flag=True,
+    default=False,
+    help='Run tests in parallel.')
+@click.option(
+    '--verbose',
+    '-v',
+    is_flag=True,
+    default=False,
+    help='Print logs from tests.')
+@click.option(
+    '--target',
+    '-t',
+    required=True,
+    type=click.Choice(['appengine', 'core', 'modules', 'cli']),
+    help='The target for the unit tests.')
+@click.option(
+    '--config-dir',
+    '-c',
+    help='Config directory to use for module tests.')
+def cli(pattern: str, unsuppress_output: bool, parallel: bool, verbose: bool,
+        target: str, config_dir: str) -> None:
+  """Runs Python unit tests."""
+  try:
+    arguments = {}
+    arguments['target'] = target 
+    if pattern:
+      arguments['pattern'] = pattern
+    if unsuppress_output:
+      arguments['unsuppress_output'] = None
+    if parallel:
+      arguments['parallel'] = None
+    if verbose:
+      arguments['verbose'] = None
+    if config_dir:
+      arguments['config_dir'] = config_dir
+
+    command = local_butler.build_command('py_unittest', **arguments)
+  except FileNotFoundError:
+    click.echo('butler.py not found in this directory.', err=True)
+    sys.exit(1)
+
+  try:
+    subprocess.run(command, check=True)
+  except FileNotFoundError:
+    click.echo('python not found in PATH.', err=True)
+    sys.exit(1)
+  except subprocess.CalledProcessError as e:
+    click.echo(f'Error running butler.py py_unittest: {e}', err=True)
+    sys.exit(1)

src/local/butler/py_unittest.py

@@ -33,6 +33,7 @@
                                         'tests', 'appengine')
 CORE_TEST_DIRECTORY = os.path.join('src', 'clusterfuzz', '_internal', 'tests',
                                    'core')
+CLI_TEST_DIRECTORY = os.path.join('cli', 'casp', 'src', 'casp', 'tests')
 SLOW_TEST_THRESHOLD = 2  # In seconds.
 TESTS_TIMEOUT = 20 * 60  # In seconds.
 
@@ -250,6 +251,9 @@ def execute(args):
 
   elif args.target == 'core':
     test_directory = CORE_TEST_DIRECTORY
+  elif args.target == 'cli':
+    test_directory = CLI_TEST_DIRECTORY
+    top_level_dir = None
   else:
     # Config module tests.
     os.environ['CONFIG_DIR_OVERRIDE'] = args.config_dir