Fixing anti-patterns

CONTRIBUTING.md

@@ -20,8 +20,15 @@ short summary of the most important parts:
 * Always use `self` for the first argument to instance methods.
 * Always use `cls` for the first argument to class methods.
 * Use one leading underscore only for non-public methods and instance variables,
-  such as `_data`.
+  such as `_data`. Do not activate name mangling with `__` unless necessary.
+* If there is a pair of `get_x` and `set_x` methods, they should instead be a
+  proper property, which is easy to do with the built-in `@property` decorator.
 * Constants should be `CAPITALIZED_SNAKE_CASE`.
+* When importing a function, try to avoid renaming it with `import as` because
+  it introduces cognitive overhead to track yet another name.
+* When deriving another module’s class (such as `unittest.TestCase`), reuse the
+  class name to avoid confusion, such as `LisaTestCase`, instead of introducing
+  a different connotation like `TestSuite`.
 
 When in doubt, adhere to existing conventions, or check the style guide.
 
@@ -252,6 +259,18 @@ Python world. If you make it through even some of these guides, you will be well
 on your way to being a “Pythonista” (a Python developer) writing “Pythonic”
 (canonically correct Python) code left and right.
 
+### Async IO
+
+With Python 3.4, the Async IO pattern found in languages such as C# and Go is
+available through the keywords `async` and `await`, along with the Python module
+`asyncio`. Please read [Async IO in Python: A Complete
+Walkthrough](https://realpython.com/async-io-python/) to understand at a high
+level how asynchronous programming works. As of Python 3.7, One major “gotcha”
+is that `asyncio.run(...)` should be used [exactly once in
+`main`](https://docs.python.org/3/library/asyncio-task.html), it starts the
+event loop. Everything else should be a coroutine or task which the event loop
+schedules.
+
 ## Future Sections
 
 Just a collection of reminders for the author to expand on later.

Makefile

@@ -1,18 +1,18 @@
 # This Makefile simply automates all our tasks. Its use is optional.
 
-all: setup run check
+all: setup run test check
 
 # Install Python packages
 setup:
 	@poetry install --no-ansi --remove-untracked
 
 # Run LISAv3
 run:
-	@poetry run python lisa/main.py --debug
+	@poetry run python -X dev lisa/main.py --debug
 
 # Run unit tests
 test:
-	@poetry run python -m unittest discover lisa
+	@poetry run python -X dev -m unittest discover -v lisa
 
 # Generate coverage report (slow, reruns LISAv3 and tests)
 coverage:

examples/testsuites/helloworld.py

@@ -1,9 +1,9 @@
-from lisa import TestCaseMetadata, TestSuite, TestSuiteMetadata
+from lisa import LisaTestCase, LisaTestCaseMetadata, LisaTestMetadata
 from lisa.operating_system import Linux
 from lisa.tools import Echo, Uname
 
 
-@TestSuiteMetadata(
+@LisaTestCaseMetadata(
     area="demo",
     category="simple",
     description="""
@@ -12,8 +12,8 @@
     """,
     tags=["demo"],
 )
-class HelloWorld(TestSuite):
-    @TestCaseMetadata(
+class HelloWorld(LisaTestCase):
+    @LisaTestMetadata(
         description="""
         this test case use default node to
             1. get system info
@@ -43,7 +43,7 @@ def hello(self) -> None:
         self.assertEqual("", result.stderr)
         self.assertEqual(0, result.exit_code)
 
-    @TestCaseMetadata(
+    @LisaTestMetadata(
         description="""
         demonstrate a simple way to run command in one line.
         """,

examples/testsuites/multinodes.py

@@ -1,9 +1,9 @@
-from lisa import TestCaseMetadata, TestSuite, TestSuiteMetadata
+from lisa import LisaTestCase, LisaTestCaseMetadata, LisaTestMetadata
 from lisa.testsuite import simple_requirement
 from lisa.tools import Lscpu, Ntttcp
 
 
-@TestSuiteMetadata(
+@LisaTestCaseMetadata(
     area="demo",
     category="demo",
     description="""
@@ -13,8 +13,8 @@
     tags=["demo", "multinode"],
     requirement=simple_requirement(min_count=2),
 )
-class MutipleNodesDemo(TestSuite):
-    @TestCaseMetadata(
+class MutipleNodesDemo(LisaTestCase):
+    @LisaTestMetadata(
         description="""
         This test case send and receive data by ntttcp
         """,
@@ -28,7 +28,7 @@ def os_info(self) -> None:
             core_count = lscpu.get_core_count()
             self.log.info(f"index: {node.index}, core_count: {core_count}")
 
-    @TestCaseMetadata(
+    @LisaTestMetadata(
         description="""
         this test case send and receive data by ntttcp
         """,

examples/testsuites/withscript.py

@@ -1,27 +1,27 @@
 from pathlib import Path
 
-from lisa import TestCaseMetadata, TestSuite, TestSuiteMetadata
+from lisa import LisaTestCase, LisaTestCaseMetadata, LisaTestMetadata
 from lisa.executable import CustomScript, CustomScriptBuilder
 from lisa.operating_system import Windows
 from lisa.testsuite import simple_requirement
 from lisa.util.perf_timer import create_timer
 
 
-@TestSuiteMetadata(
+@LisaTestCaseMetadata(
     area="demo",
     category="simple",
     description="""
     This test suite run a script on linux
     """,
     tags=["demo"],
 )
-class WithScript(TestSuite):
+class WithScript(LisaTestCase):
     def before_suite(self) -> None:
         self._echo_script = CustomScriptBuilder(
             Path(__file__).parent.joinpath("scripts"), ["echo.sh"]
         )
 
-    @TestCaseMetadata(
+    @LisaTestMetadata(
         description="""
         this test case run script on a linux node, and demostrate
         1. how to use customized script on tested node.

lisa/__init__.py

@@ -1,12 +1,12 @@
 from __future__ import annotations
 
-from lisa.testsuite import TestCaseMetadata, TestSuite, TestSuiteMetadata
+from lisa.testsuite import LisaTestCase, LisaTestCaseMetadata, LisaTestMetadata
 from lisa.util.logger import init_loggger
 
 __all__ = [
-    "TestSuiteMetadata",
-    "TestCaseMetadata",
-    "TestSuite",
+    "LisaTestCase",
+    "LisaTestCaseMetadata",
+    "LisaTestMetadata",
 ]
 
 

lisa/commands.py

@@ -1,52 +1,50 @@
-import asyncio
 import functools
 from argparse import Namespace
 from typing import Iterable, Optional, cast
 
+import lisa.runner
 from lisa import notifier
-from lisa.lisarunner import LisaRunner
-from lisa.parameter_parser.runbook import load as load_runbook
+from lisa.parameter_parser.runbook import load_runbook
 from lisa.testselector import select_testcases
-from lisa.testsuite import TestCaseRuntimeData
+from lisa.testsuite import LisaTestRuntimeData, TestStatus
 from lisa.util import LisaException, constants
 from lisa.util.logger import get_logger
 
 _get_init_logger = functools.partial(get_logger, "init")
 
 
-def run(args: Namespace) -> int:
-    runbook = load_runbook(args)
+async def run(args: Namespace) -> int:
+    runbook = load_runbook(args.runbook, args.variables)
 
     if runbook.notifier:
         notifier.initialize(runbooks=runbook.notifier)
+
     try:
-        runner = LisaRunner(runbook)
-        awaitable = runner.start()
-        asyncio.run(awaitable)
+        results = await lisa.runner.run(runbook)
     finally:
         notifier.finalize()
 
-    return runner.exit_code
+    return sum(1 for x in results if x.status == TestStatus.FAILED)
 
 
 # check runbook
-def check(args: Namespace) -> int:
-    load_runbook(args)
+async def check(args: Namespace) -> int:
+    load_runbook(args.runbook, args.variables)
     return 0
 
 
-def list_start(args: Namespace) -> int:
-    runbook = load_runbook(args)
+async def list_start(args: Namespace) -> int:
+    runbook = load_runbook(args.runbook, args.variables)
     list_all = cast(Optional[bool], args.list_all)
     log = _get_init_logger("list")
     if args.type == constants.LIST_CASE:
         if list_all:
-            cases: Iterable[TestCaseRuntimeData] = select_testcases()
+            cases: Iterable[LisaTestRuntimeData] = select_testcases()
         else:
             cases = select_testcases(runbook.testcase)
         for case_data in cases:
             log.info(
-                f"case: {case_data.name}, suite: {case_data.metadata.suite.name}, "
+                f"test: {case_data.name}, case: {case_data.metadata.case.name}, "
                 f"area: {case_data.suite.area}, "
                 f"category: {case_data.suite.category}, "
                 f"tags: {','.join(case_data.suite.tags)}, "