feat: add test cases for pypots-cli;

pypots/cli/dev.py

@@ -116,7 +116,7 @@ def __init__(
 
  def checkup(self):
  """Run some checks on the arguments to avoid error usages"""
- self.check_if_under_root_dir()
+ self.check_if_under_root_dir(strict=True)
 
  if self._k is not None:
  assert self._run_tests, (

pypots/cli/doc.py

@@ -145,7 +145,7 @@ def __init__(
 
  def checkup(self):
  """Run some checks on the arguments to avoid error usages"""
- self.check_if_under_root_dir()
+ self.check_if_under_root_dir(strict=True)
 
  if self._cleanup:
  assert not self._gene_rst and not self._gene_html and not self._view_doc, (

pypots/cli/env.py

@@ -90,7 +90,7 @@ def __init__(
 
  def checkup(self):
  """Run some checks on the arguments to avoid error usages"""
- self.check_if_under_root_dir()
+ self.check_if_under_root_dir(strict=True)
 
  def run(self):
  """Execute the given command."""

pypots/tests/test_cli.py

@@ -0,0 +1,160 @@
+"""
+Test cases for the functions and classes in package `pypots.cli`.
+"""
+
+# Created by Wenjie Du <[email protected]>
+# License: GLP-v3
+
+import os
+import unittest
+from argparse import Namespace
+from copy import copy
+
+from pypots.cli.dev import dev_command_factory
+from pypots.cli.doc import doc_command_factory
+from pypots.cli.env import env_command_factory
+from pypots.utils.logging import logger
+
+PROJECT_ROOT_DIR = os.path.abspath(os.path.join(os.path.abspath(__file__), "../../.."))
+
+
+class TestPyPOTSCLIDev(unittest.TestCase):
+ # set up the default arguments
+ default_arguments = {
+ "build": False,
+ "cleanup": False,
+ "run_tests": False,
+ "k": None,
+ "show_coverage": False,
+ "lint_code": False,
+ }
+ # `pypots-cli dev` must run under the project root dir
+ os.chdir(PROJECT_ROOT_DIR)
+
+ def test_0_build(self):
+ arguments = copy(self.default_arguments)
+ arguments["build"] = True
+ args = Namespace(**arguments)
+ dev_command_factory(args).run()
+
+ logger.info("run again under a non-root dir")
+ try:
+ os.chdir(os.path.abspath(os.path.join(PROJECT_ROOT_DIR, "pypots")))
+ dev_command_factory(args).run()
+ except RuntimeError: # try to run under a non-root dir, so RuntimeError will be raised
+ pass
+ except Exception as e: # other exceptions will cause an error and result in failed testing
+ raise e
+ finally:
+ os.chdir(PROJECT_ROOT_DIR)
+
+ def test_1_run_tests(self):
+ arguments = copy(self.default_arguments)
+ arguments["run_tests"] = True
+ arguments["k"] = "try_to_find_a_non_existing_test_case"
+ args = Namespace(**arguments)
+ try:
+ dev_command_factory(args).run()
+ except RuntimeError: # try to find a non-existing test case, so RuntimeError will be raised
+ pass
+ except Exception as e: # other exceptions will cause an error and result in failed testing
+ raise e
+
+ # enable show_coverage and run again
+ arguments["show_coverage"] = True
+ args = Namespace(**arguments)
+ try:
+ dev_command_factory(args).run()
+ except RuntimeError: # try to find a non-existing test case, so RuntimeError will be raised
+ pass
+ except Exception as e: # other exceptions will cause an error and result in failed testing
+ raise e
+
+ def test_2_lint_code(self):
+ arguments = copy(self.default_arguments)
+ arguments["lint_code"] = True
+ args = Namespace(**arguments)
+ dev_command_factory(args).run()
+
+ def test_3_cleanup(self):
+ arguments = copy(self.default_arguments)
+ arguments["cleanup"] = True
+ args = Namespace(**arguments)
+ dev_command_factory(args).run()
+
+
+class TestPyPOTSCLIDoc(unittest.TestCase):
+ # set up the default arguments
+ default_arguments = {
+ "gene_rst": False,
+ "branch": "main",
+ "gene_html": False,
+ "view_doc": True,
+ "port": 9075,
+ "cleanup": False,
+ }
+ # `pypots-cli doc` must run under the project root dir
+ os.chdir(PROJECT_ROOT_DIR)
+
+ def test_0_gene_rst(self):
+ arguments = copy(self.default_arguments)
+ arguments["gene_rst"] = True
+ arguments["branch"] = "dev"
+ args = Namespace(**arguments)
+ doc_command_factory(args).run()
+
+ logger.info("run again under a non-root dir")
+ try:
+ os.chdir(os.path.abspath(os.path.join(PROJECT_ROOT_DIR, "pypots")))
+ doc_command_factory(args).run()
+ except RuntimeError: # try to run under a non-root dir, so RuntimeError will be raised
+ pass
+ except Exception as e: # other exceptions will cause an error and result in failed testing
+ raise e
+ finally:
+ os.chdir(PROJECT_ROOT_DIR)
+
+ def test_1_gene_html(self):
+ arguments = copy(self.default_arguments)
+ arguments["gene_html"] = True
+ args = Namespace(**arguments)
+ doc_command_factory(args).run()
+
+ def test_2_view_doc(self):
+ arguments = copy(self.default_arguments)
+ arguments["view_doc"] = True
+ args = Namespace(**arguments)
+ doc_command_factory(args).run()
+
+ def test_3_cleanup(self):
+ arguments = copy(self.default_arguments)
+ arguments["cleanup"] = True
+ args = Namespace(**arguments)
+ doc_command_factory(args).run()
+
+
+class TestPyPOTSCLIEnv(unittest.TestCase):
+ # set up the default arguments
+ default_arguments = {
+ "install": "optional",
+ "tool": "conda",
+ }
+
+ # `pypots-cli env` must run under the project root dir
+ os.chdir(PROJECT_ROOT_DIR)
+
+ def test_0_install_with_conda(self):
+ arguments = copy(self.default_arguments)
+ arguments["tool"] = "conda"
+ args = Namespace(**arguments)
+ env_command_factory(args).run()
+
+ def test_1_install_with_pip(self):
+ arguments = copy(self.default_arguments)
+ arguments["tool"] = "pip"
+ args = Namespace(**arguments)
+ env_command_factory(args).run()
+
+
+if __name__ == "__main__":
+ unittest.main()