tests.py

"""
Runner for the export exchange unit tests.

Copyright 2017-2020 ICTU
Copyright 2017-2022 Leiden University
Copyright 2017-2024 Leon Helwerda

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from argparse import ArgumentParser, Namespace
from pathlib import Path
import sys
import unittest
from unittest.signals import installHandler
import requests_mock
import xmlrunner

def parse_args() -> Namespace:
    """
    Parse command line arguments.
    """

    parser = ArgumentParser(description="Perform unit test runs")
    parser.add_argument("--include", "-p", default="*.py",
                        help="Glob pattern for test file names to run")
    parser.add_argument("--method", default="test_",
                        help="Prefix of methods to run (must start with test_)")
    parser.add_argument("--qual", "-k", action="append",
                        help="Wildcard pattern of package.Class.method to run")
    parser.add_argument("--output", default="test-reports",
                        help="Directory to write JUnit XML output files to")
    parser.add_argument("--no-output", action="store_const", dest="output",
                        const="", help="Do not write JUnit XML output files")
    parser.add_argument("--buffer", "-b", action="store_true", default=False,
                        help="Buffer output (including logs) during tests")
    parser.add_argument("--catch", "-c", action="store_true", default=False,
                        help="Finish current test and show results on Ctrl-C")
    parser.add_argument("--failfast", "-f", action="store_true", default=False,
                        help="Stop the test run on the first error or failure")
    args = parser.parse_args()
    return args

def run_tests() -> int:
    """
    Run unit tests and write XML reports.
    """

    args = parse_args()

    requests_mock.mock.case_sensitive = True

    loader = unittest.TestLoader()
    method = str(args.method)
    if method.startswith('test_'):
        loader.testMethodPrefix = method
    else:
        loader.testMethodPrefix = 'test_'
    if args.qual:
        loader.testNamePatterns = [
            qual if '*' in qual else f'*{qual}*' for qual in args.qual
        ]
    if args.catch:
        installHandler()

    tests = loader.discover('test', pattern=args.include,
                            top_level_dir=str(Path(__file__).parent))
    if args.output == '':
        print(file=sys.stderr)
        print('Running tests...', file=sys.stderr)
        print(unittest.TextTestResult.separator2, file=sys.stderr)
        runner = unittest.TextTestRunner(buffer=args.buffer,
                                         failfast=args.failfast)
    else:
        runner = xmlrunner.XMLTestRunner(output=args.output,
                                         buffer=args.buffer,
                                         failfast=args.failfast)
    result = runner.run(tests)
    return 0 if result.wasSuccessful() else 1

if __name__ == "__main__":
    sys.exit(run_tests())