Merge branch 'master' into cli-migrate-py_unittest

Author: PauloVLB

cli/casp/README.md

@@ -48,9 +48,9 @@ For example, to add a `my-command` command, follow these steps:
 
     import click
 
-    from .commands import hi
-    from .commands import version
-    from .commands import my_command  # Add this line
+    from casp.commands import hi
+    from casp.commands import version
+    from casp.commands import my_command  # Add this line
 
     @click.group()
     def cli():
@@ -69,5 +69,45 @@ Once you have completed these steps, the new command will be available as
 To run all unit tests for the `casp` CLI, use the following command from the root of the project:
 
 ```bash
-python -m unittest discover -s cli/casp/src/casp/tests -v
+python -m unittest discover -s cli/casp/src/casp/tests -p '*_test.py' -v
+```
+
+## Writing Tests
+
+To add tests for a new command or feature, create a new Python file in the
+`cli/casp/src/casp/tests` directory. The file name should follow the pattern
+`<feature_name>_test.py`.
+
+Each test file should contain test classes that inherit from `unittest.TestCase`.
+You can use `click.testing.CliRunner` to invoke your CLI commands in tests.
+
+Here's an example for a `my-command` feature:
+
+```python
+# cli/casp/src/casp/tests/test_my_command.py
+
+import unittest
+from click.testing import CliRunner
+
+from casp.commands import my_command
+
+class MyCommandTest(unittest.TestCase):
+  """Tests for the `my-command` CLI command."""
+
+  def setUp(self):
+    self.runner = CliRunner()
+
+  def test_my_command_no_verbose(self):
+    """Test `my-command` without the --verbose flag."""
+    result = self.runner.invoke(my_command.cli)
+    self.assertEqual(result.exit_code, 0)
+    self.assertIn('This is my new command.', result.output)
+    self.assertNotIn('Verbose logging is enabled.', result.output)
+
+  def test_my_command_verbose(self):
+    """Test `my-command` with the --verbose flag."""
+    result = self.runner.invoke(my_command.cli, ['--verbose'])
+    self.assertEqual(result.exit_code, 0)
+    self.assertIn('Verbose logging is enabled.', result.output)
+    self.assertIn('This is my new command.', result.output)
 ```

…p/src/casp/tests/commands/test_format.py …p/src/casp/tests/commands/format_test.pycli/casp/src/casp/tests/commands/test_format.py renamed to cli/casp/src/casp/tests/commands/format_test.py cli/casp/src/casp/tests/commands/test_format.py renamed to cli/casp/src/casp/tests/commands/format_test.py

@@ -14,7 +14,7 @@
 """Tests for the format command.
   
   For running all the tests, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_format.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p format_test.py -v
 """
 
 from pathlib import Path

…asp/src/casp/tests/commands/test_init.py …asp/src/casp/tests/commands/init_test.pycli/casp/src/casp/tests/commands/test_init.py renamed to cli/casp/src/casp/tests/commands/init_test.py cli/casp/src/casp/tests/commands/test_init.py renamed to cli/casp/src/casp/tests/commands/init_test.py

@@ -14,7 +14,7 @@
 """Tests for the init command.
 
    For running all the tests, use (from the root of the project):
-   python -m unittest discover -s cli/casp/src/casp/tests -p test_init.py -v
+   python -m unittest discover -s cli/casp/src/casp/tests -p init_test.py -v
 """
 
 import os

…asp/src/casp/tests/commands/test_lint.py …asp/src/casp/tests/commands/lint_test.pycli/casp/src/casp/tests/commands/test_lint.py renamed to cli/casp/src/casp/tests/commands/lint_test.py cli/casp/src/casp/tests/commands/test_lint.py renamed to cli/casp/src/casp/tests/commands/lint_test.py

@@ -14,7 +14,7 @@
 """Tests for the lint command.
 
   For running all the tests, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_lint.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p lint_test.py -v
 """
 
 from pathlib import Path

…rc/casp/tests/commands/test_reproduce.py …rc/casp/tests/commands/reproduce_test.pycli/casp/src/casp/tests/commands/test_reproduce.py renamed to cli/casp/src/casp/tests/commands/reproduce_test.py cli/casp/src/casp/tests/commands/test_reproduce.py renamed to cli/casp/src/casp/tests/commands/reproduce_test.py

@@ -14,7 +14,7 @@
 """Tests for the reproduce command.
 
   For running all the tests, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_reproduce.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p reproduce_test.py -v
 """
 
 from pathlib import Path

…casp/src/casp/tests/utils/test_config.py …casp/src/casp/tests/utils/config_test.pycli/casp/src/casp/tests/utils/test_config.py renamed to cli/casp/src/casp/tests/utils/config_test.py cli/casp/src/casp/tests/utils/test_config.py renamed to cli/casp/src/casp/tests/utils/config_test.py

@@ -14,7 +14,7 @@
 """Tests for config utility functions."
 
   For running all the tests, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_config.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p config_test.py -v
 """
 
 import json

…casp/src/casp/tests/utils/test_docker.py …casp/src/casp/tests/utils/docker_test.pycli/casp/src/casp/tests/utils/test_docker.py renamed to cli/casp/src/casp/tests/utils/docker_test.py cli/casp/src/casp/tests/utils/test_docker.py renamed to cli/casp/src/casp/tests/utils/docker_test.py

@@ -14,7 +14,7 @@
 """Tests for docker utility functions.
 
   For running, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_docker.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p docker_test.py -v
 """
 
 import os

…casp/src/casp/tests/utils/test_gcloud.py …casp/src/casp/tests/utils/gcloud_test.pycli/casp/src/casp/tests/utils/test_gcloud.py renamed to cli/casp/src/casp/tests/utils/gcloud_test.py cli/casp/src/casp/tests/utils/test_gcloud.py renamed to cli/casp/src/casp/tests/utils/gcloud_test.py

@@ -14,7 +14,7 @@
 """Tests for the gcloud utility functions.
 
   For running, use (from the root of the project):
-  python -m unittest discover -s cli/casp/src/casp/tests -p test_gcloud.py -v
+  python -m unittest discover -s cli/casp/src/casp/tests -p gcloud_test.py -v
 """
 
 import subprocess

…rc/casp/tests/utils/test_local_butler.py …rc/casp/tests/utils/local_butler_test.pycli/casp/src/casp/tests/utils/test_local_butler.py renamed to cli/casp/src/casp/tests/utils/local_butler_test.py cli/casp/src/casp/tests/utils/test_local_butler.py renamed to cli/casp/src/casp/tests/utils/local_butler_test.py

@@ -15,7 +15,7 @@
 
   For running, use (from the root of the project):
   python -m unittest discover -s cli/casp/src/casp/tests 
-  -p test_local_butler.py -v
+  -p local_butler_test.py -v
 """
 
 from pathlib import Path