Merge pull request #3 from code-dot-org/molly/unittest-output

Make unittest_runner package

Author: molly-moen

README.md

@@ -10,8 +10,12 @@ The current patches are:
 - We patch `requests` in order to route requests through code.org's request proxy. This protects students
   by only allowing requests to an allow-list of urls.
 
-All Python Lab programs are prefixed with `setup_pythonlab()`, the method this package exposes, which applies
-the above patches.
+All Python Lab programs are prefixed with `setup_pythonlab()`, the method this package exposes, which only applies
+the matplotlib patch for now.
+
+## unittest_runner
+This tests adds some customization to the output of unit tests, and has a function to either run validation tests
+(more customized) or student tests (less customized).
 
 ## Setup
 - Install `pyenv`. 

packages/unittest_runner/pyproject.toml

@@ -0,0 +1,8 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "unittest_runner"
+version = "0.0.1"
+dependencies = ["unittest"]

packages/unittest_runner/unittest_runner/__init__.py

@@ -0,0 +1 @@
+from .run_tests import run_student_tests, run_validation_tests

packages/unittest_runner/unittest_runner/run_tests.py

@@ -0,0 +1,18 @@
+import unittest
+from .validation_runner import ValidationTestResult
+
+# Run the tests in the given file pattern and display the results to the user.
+# Validation tests use the ValidationTestResult class to display only the short description of the test.
+def run_validation_tests(file_pattern):
+  run_tests(file_pattern, ValidationTestResult)
+
+# Run the tests in the given file pattern and display the results to the user.
+# Student tests use the standard TextTestResult class to display the test name and short description.
+def run_student_tests(file_pattern):
+  run_tests(file_pattern, unittest.TextTestResult)
+
+def run_tests(file_pattern, resultclass):
+  loader = unittest.TestLoader()
+  test_suite = loader.discover('.', file_pattern)
+  runner = unittest.TextTestRunner(verbosity=2, resultclass=resultclass)
+  result = runner.run(test_suite)

packages/unittest_runner/unittest_runner/validation_runner.py

@@ -0,0 +1,14 @@
+
+from unittest import TextTestResult
+
+class ValidationTestResult(TextTestResult):
+  # The default behavior is to display the test name and short description.
+  # We want to display only the short description if it exists, otherwise just the test name.
+  # Students don't see the tests, so we don't need to display the test name.
+  # See this PR for details: https://github.com/code-dot-org/pythonlab-packages/pull/3
+  def getDescription(self, test):
+    doc_first_line = test.shortDescription()
+    if doc_first_line:
+      return doc_first_line
+    else:
+      return str(test)