linted tests/run_tests.py and modified it in a way that made it more …

…flexible for each test

modified pyproject.toml to run tests/run_tests.py for each test in a separated way

pyproject.toml

@@ -33,7 +33,9 @@ poethepoet = "^0.31.1"
 [tool.poe.tasks]
 format = "black ./tests"
 lint = "pylint ./tests"
-tests = "python tests/run_tests.py"
+example-test = "python tests/run_tests.py --test-name example_test"
+restart-test = "python tests/run_tests.py --test-name restart"
+tests = ["example-test", "restart-test"]
 pre-commit = ["format", "lint", "tests"]
 
 [build-system]

tests/run_tests.py

@@ -1,44 +1,109 @@
+"""
+run_tests.py
+
+Command Line Interface to run a test by its name. The name should be placed at ./tests folder.
+It's suposed that you run it through `poetry` package management and `poe` task manager, but you
+can run it with `python` if you installed the packages properly, in a isolated or not isolated
+environment (althought we recommend the isolated environment).
+
+All tests will run as a spwaned subprocess and what happens will be logged to a temporary directory
+(we defined, in linux, /tmp/floresta-func-tests/<test_name>):
+
+```bash
+# The default way to run all tests
+poetry run poe tests
+
+# The default way to run a separated test (see the ones -- or define one -- in pyproject.toml)
+poetry run poe example-test
+
+# This will do the same thing in the isolated environment
+poetry run python tests/run_tests.py --test-name example_test
+
+# You can even define the `data_dir` to logs
+poetry run python tests/run_tests.py --test-name example_test --data-dir $HOME/my/path
+
+# If you have a proper environment wit all necessary packages installed
+# it can be possible to run without poetry
+python tests/run_tests.py --test-name example_test --data-dir $HOME/my/path
+```
+"""
+
 import os
 import subprocess
 import time
+import argparse
+import tempfile
 
-BASE_DIR = "/tmp/data"
+BASE_DIR = os.path.normpath(os.path.join(tempfile.gettempdir(), "floresta-func-tests"))
 SUCCESS_EMOJI = "✔"
 FAILURE_EMOJI = "❌"
 
-tests = ["example_test", "restart"]
 
 def main():
-    print("Creating work dir")
-    data_dir = BASE_DIR + f"run-{time.time()}/"
-    print(f'writing stuff to {data_dir}')
+    """
+    Create a CLI called `run_tests` with calling arguments
+
+    usage: run_tests [-h] [-d DATA_DIR] [-t TEST_NAME]
+
+    tool to help with function testing of Floresta
+
+    options:
+        -h, --help                show this help message and exit
+        -d, --data-dir DATA_DIR   data directory of the run_tests's functional test logs
+        -t, --test-name TEST_NAME the name of the file to be tested (without .py)
+    """
+    # Structure the CLI
+    parser = argparse.ArgumentParser(
+        prog="run_tests",
+        description="tool to help with function testing of Floresta",
+    )
 
+    parser.add_argument(
+        "-d",
+        "--data-dir",
+        help="data directory of the %(prog)s's functional test logs",
+        default=BASE_DIR,
+    )
+
+    parser.add_argument(
+        "-t", "--test-name", help="the name of the file to be tested (without .py)"
+    )
+
+    # Parse arguments of CLI
+    args = parser.parse_args()
+
+    # Define the data-dir and create it
+    data_dir = os.path.normpath(os.path.join(args.data_dir, args.test_name))
     if not os.path.isdir(data_dir):
         os.makedirs(data_dir)
-    failures = []
-    for test_name in tests:
-        test_dir = "./tests/" + test_name
-        log_dir = data_dir + test_name.replace(".py", ".log")
-        log_file = open(log_dir, "wt")
-        test = subprocess.Popen(["python", test_dir + ".py"],
-                                stdout=log_file, stderr=log_file)
-        test.wait()
-        if test.returncode != 0:
-            print(f"Test {test_name} not passed {FAILURE_EMOJI}")
-            failures.append(test_name)
-        else:
-            print(f"Test {test_name} passed {SUCCESS_EMOJI}")
-
-    if len(failures) > 0:
-        print(f"{FAILURE_EMOJI} {len(failures)} tests failed")
-        for failure in failures:
-            # show logs for failed tests
-            log_dir = data_dir + failure.replace(".py", ".log")
-            print(f"Logs for {failure}:")
-            with open(log_dir, "rt") as log_file:
-                print(log_file.read())
-
-        raise Exception("Tests failed")
-
-if __name__ == '__main__':
+
+    # Setup directories and filenames for the specific test
+    test_dir = os.path.abspath(os.path.dirname(__file__))
+    test_filename = os.path.normpath(os.path.join(test_dir, f"{args.test_name}.py"))
+    test_logname = os.path.normpath(os.path.join(data_dir, f"{int(time.time())}.log"))
+    print(f"Writing stuff to {test_logname}")
+
+    # Now start the test
+    with open(test_logname, "wt", encoding="utf-8") as log_file:
+        cli = ["python", test_filename]
+        cli_msg = " ".join(cli)
+        print(f"running '{cli_msg}")
+        with subprocess.Popen(cli, stdout=log_file, stderr=log_file) as test:
+            test.wait()
+
+    # Check the test, if failed, log the results
+    # if passed, just show that worked
+    if test.returncode != 0:
+        print(f"Test {args.test_name} not passed {FAILURE_EMOJI}")
+        with open(test_logname, "rt", encoding="utf-8") as log_file:
+            print(log_file.read())
+        raise RuntimeError("Tests failed")
+
+    print(f"Test {args.test_name} passed {SUCCESS_EMOJI}")
+
+    # Add some \n to better visualization on terminal
+    print()
+
+
+if __name__ == "__main__":
     main()