Source code for pyam.cmd.run

#!/usr/bin/env python3
# Copyright 2023, Dr John A.R. Williams
# SPDX-License-Identifier: GPL-3.0-only
"""Main routine for run command"""
import argparse
import datetime
import pyam.cohort as cohortlib
from pyam.config import CONFIG
from pyam.cmd.args import add_common_args
from pyam.run_pytest import run_pytest


def main(args=None):
    """Run the test suite for specified cohort and students

    Generates the test reports for each student in the reports folder.
    """
    # pylint: disable=W1510
    #Ensure pyam is in Python search path
    if args is None:
        parser = argparse.ArgumentParser(description=__doc__)
        add_args(parser)
        args = parser.parse_args()
    cohort = cohortlib.get_cohort(args.cohort)
    cohort.start_log_section(
        f"Running tests {args.test} for {args.students or 'all'}")
    students = cohort.students(args.students)
    for student in students:
        if not student.path.exists():
            cohort.log.warning("No Submission Folder: '%s'.", student.name())
            continue
        report_path = cohort.report_path / f"{args.prefix}{student.username}.txt"
        if report_path.exists():
            if args.new_only:
                continue
            if not args.overwrite:
                cohort.log.warning("Using Existing Report for '%s' - '%s'.", 
                                student.name(), report_path.relative_to(CONFIG.root_path))
                CONFIG.log.warning("Use --overwrite option to overwrite report.")
                continue
        extras = []
        if args.mark:
            extras += ['-m', args.mark]
        result = run_pytest(
            cohort,
            '--no-header',
            '-rA',
            '--tb=short',
            '-v',
            *extras,
            '--student',
            student.username,
        )
        with open(report_path, "w") as fid:
            fid.write(f"Report generated {datetime.datetime.now().strftime('%Y/%m/%d %H:%M')}"\
                      + f" for {student.name()} by {cohort.get('assessor.name')}\n")
            fid.write(result.stdout)
        if result.returncode == 0:
            cohort.log.info("Passed all tests : '%s' - report '%s'.",
                            student.name(),
                            report_path.relative_to(CONFIG.root_path))
        else:
            cohort.log.warning("Failed test: '%s' - report '%s'.",
                               student.name(),
                               report_path.relative_to(CONFIG.root_path))


def add_args(parser):
    """Parse Args and return them for this script"""
    add_common_args(parser)
    parser.add_argument('-t',
                        '--test',
                        default="",
                        help="Name of specific test to be run")
    parser.add_argument(
        '--new_only',
        action="store_true",
        help=
        "If set then only run tests for those student for whom there are no reports"
    )
    parser.add_argument(
        '-m',
        '--mark',
        help=
        "Selected mark tests when testing e.g. 'no slow' to not run slow tests"
    )


if __name__ == "__main__":
    main()