refactor: add code coverage, cover CLI commands with tests

Author: takato1314

.coveragerc

@@ -0,0 +1,42 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source =
+    ./tutor 
+    ./bin 
+omit =
+    */templates/*
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+    # Don't complain about abstract methods, they aren't run:
+    @(abc\.)?abstractmethod
+
+ignore_errors = True
+show_missing = True
+skip_empty = True
+precision = 2
+
+[html]
+skip_empty = True
+show_contexts = True
+
+[json]
+pretty_print = True
+show_contexts = True

.gitignore

@@ -7,3 +7,7 @@ __pycache__
 /build/
 /dist/
 /release_description.md
+
+# Unit test/ coverage reports
+.coverage
+/htmlcov/

Makefile

@@ -1,6 +1,6 @@
 .DEFAULT_GOAL := help
 .PHONY: docs
-SRC_DIRS = ./tutor ./tests ./bin
+SRC_DIRS = ./tutor ./tests ./bin ./docs
 BLACK_OPTS = --exclude templates ${SRC_DIRS}
 
 ###### Development
@@ -53,6 +53,23 @@ bootstrap-dev: ## Install dev requirements
 bootstrap-dev-plugins: bootstrap-dev ## Install dev requirement and all supported plugins
 	pip install -r requirements/plugins.txt
 
+###### Code coverage
+
+coverage: ## Run unit-tests before analyzing code coverage and generate report
+	$(MAKE) --keep-going coverage-tests coverage-report
+
+coverage-tests: ## Run unit-tests and analyze code coverage
+	coverage run -m unittest discover
+
+coverage-report: ## Generate CLI report for the code coverage
+	coverage report
+
+coverage-html: coverage-report ## Generate HTML report for the code coverage
+	coverage html
+
+coverage-browse-report: coverage-html ## Open the HTML report in the browser
+	sensible-browser htmlcov/index.html
+
 ###### Deployment
 
 bundle: ## Bundle the tutor package in a single "dist/tutor" executable

bin/main.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 from tutor.plugins import OfficialPlugin
+from tutor.commands.cli import main
 
 # Manually install plugins (this is for creating the bundle)
 for plugin_name in [
@@ -20,6 +21,5 @@
     except ImportError:
         pass
 
-from tutor.commands.cli import main
-
-main()
+if __name__ == "__main__":
+    main()

docs/conf.py

@@ -1,6 +1,7 @@
 import io
 import os
 import sys
+from typing import Any, Dict, List
 
 import docutils
 import docutils.parsers.rst
@@ -28,7 +29,7 @@
 
 # -- Sphinx-Click configuration
 # https://sphinx-click.readthedocs.io/
-extensions.append('sphinx_click')
+extensions.append("sphinx_click")
 # This is to avoid the addition of the local username to the docs
 os.environ["HOME"] = "~"
 # Make sure that sphinx-click can find the tutor module
@@ -63,7 +64,7 @@
 
 # Custom variables
 here = os.path.abspath(os.path.dirname(__file__))
-about = {}
+about: Dict[str, str] = {}
 with io.open(
     os.path.join(here, "..", "tutor", "__about__.py"), "rt", encoding="utf-8"
 ) as f:
@@ -77,17 +78,17 @@
 
 # Custom directives
 def youtube(
-    _name,
-    _args,
-    _options,
-    content,
-    _lineno,
-    _contentOffset,
-    _blockText,
-    _state,
-    _stateMachine,
-):
-    """ Restructured text extension for inserting youtube embedded videos """
+    _name: Any,
+    _args: Any,
+    _options: Any,
+    content: List[str],
+    _lineno: Any,
+    _contentOffset: Any,
+    _blockText: Any,
+    _state: Any,
+    _stateMachine: Any,
+) -> Any:
+    """Restructured text extension for inserting youtube embedded videos"""
     if not content:
         return []
     video_id = content[0]

requirements/dev.in

@@ -4,6 +4,7 @@ pip-tools
 pylint
 pyinstaller
 twine
+coverage
 
 # Types packages
 types-PyYAML

requirements/dev.txt

@@ -36,6 +36,8 @@ click==8.0.3
     #   pip-tools
 colorama==0.4.4
     # via twine
+coverage==6.2
+    # via -r requirements/dev.in
 cryptography==35.0.0
     # via secretstorage
 docutils==0.17.1

setup.py

@@ -1,11 +1,12 @@
 import io
 import os
 from setuptools import find_packages, setup
+from typing import Dict, List
 
 HERE = os.path.abspath(os.path.dirname(__file__))
 
 
-def load_readme():
+def load_readme() -> str:
     with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as f:
         readme = f.read()
     # Replace img src for publication on pypi
@@ -14,23 +15,22 @@ def load_readme():
     )
 
 
-def load_about():
-    about = {}
+def load_about() -> Dict[str, str]:
+    about: Dict[str, str] = {}
     with io.open(
         os.path.join(HERE, "tutor", "__about__.py"), "rt", encoding="utf-8"
     ) as f:
         exec(f.read(), about)  # pylint: disable=exec-used
     return about
 
 
-def load_requirements(filename: str):
+def load_requirements(filename: str) -> List[str]:
     with io.open(
         os.path.join(HERE, "requirements", filename), "rt", encoding="utf-8"
     ) as f:
         return [line.strip() for line in f if is_requirement(line)]
 
-
-def is_requirement(line):
+def is_requirement(line: str) -> bool:
     return not (line.strip() == "" or line.startswith("#"))
 
 
@@ -72,4 +72,5 @@ def is_requirement(line):
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
     ],
+    test_suite="tests",
 )

tests/commands/__init__.py

@@ -0,0 +1,26 @@
+import unittest
+
+from click.testing import CliRunner
+
+from tutor.commands.cli import cli, print_help
+
+
+class CliTests(unittest.TestCase):
+    def test_help(self) -> None:
+        runner = CliRunner()
+        result = runner.invoke(print_help)
+        self.assertEqual(0, result.exit_code)
+        self.assertIsNone(result.exception)
+
+    def test_cli_help(self) -> None:
+        runner = CliRunner()
+        result = runner.invoke(cli, ["--help"])
+        self.assertEqual(0, result.exit_code)
+        self.assertIsNone(result.exception)
+
+    def test_cli_version(self) -> None:
+        runner = CliRunner()
+        result = runner.invoke(cli, ["--version"])
+        self.assertEqual(0, result.exit_code)
+        self.assertIsNone(result.exception)
+        self.assertRegex(result.output, r"cli, version \d+.\d+.\d+\n")