run_tests.py

#!/usr/bin/env python
#
# A library containing community-based extension for the python-telegram-bot library
# Copyright (C) 2021-2025
# The ptbcontrib developers
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program.  If not, see [http://www.gnu.org/licenses/].
"""Helper script to run the test suites for ptbcontrib"""
import itertools
import subprocess  # nosec
import sys
from argparse import ArgumentParser
from pathlib import Path
from typing import List

from pygit2 import Repository

root_path = Path(__file__).parent.resolve()
ptbcontrib_path = root_path / "ptbcontrib"
test_path = root_path / "tests"

contrib_paths = [
    x for x in ptbcontrib_path.iterdir() if x.is_dir() and "__pycache__" not in x.name
]
contrib_names = [contrib.name for contrib in contrib_paths]


def get_changed_contrib_names() -> List[str]:
    """Get all changed files as compared to remote/main"""
    repo = Repository(root_path)
    main_branch = repo.lookup_branch("main")
    if main_branch is None:
        raise RuntimeError("Can't find `main` branch to compare to.")

    file_paths = set(
        itertools.chain.from_iterable(
            (patch.delta.old_file.path, patch.delta.new_file.path)
            for patch in repo.diff(a=main_branch)
        )
    )
    changed_contribs = set()

    for filepath in file_paths:
        if "__pycache__" not in filepath:
            path_parents = (root_path / Path(filepath)).parents
            for contrib_path in contrib_paths:
                if contrib_path in path_parents:
                    changed_contribs.add(contrib_path.name)
            if test_path in path_parents:
                for contrib_path in contrib_paths:
                    if filepath.endswith(f"test_{contrib_path.parts[-1]}.py"):
                        changed_contribs.add(contrib_path.name)

    return list(changed_contribs)


def run_tests(changed: bool, names: List[str]) -> int:
    """Run the required tests and install requirements for each one"""
    if changed:
        names = get_changed_contrib_names()
    elif not names:
        names = contrib_names

    exit_code = 0
    for name in names:
        try:
            subprocess.check_call(  # nosec
                [
                    sys.executable,
                    "-m",
                    "pip",
                    "install",
                    "-r",
                    str(ptbcontrib_path / name / "requirements.txt"),
                ]
            )

            result = subprocess.run(  # nosec
                [sys.executable, "-m", "telegram"],
                capture_output=True,
                text=True,
                check=True,
            )
            if (
                result.stdout
                and result.stdout.startswith("python-telegram-bot 13")
                and sys.version_info >= (3, 10)
            ):
                print(
                    f"Ignoring contribution {name}, as this PTB version is not "
                    f"supported on Python {sys.version}. "
                )
                continue

            subprocess.check_call(  # nosec
                [
                    "pytest",
                    "-v",
                    str(root_path / "tests" / f"test_{name}.py"),
                    f"--junitxml=./.test-reports/test_{name}.xml",
                ]
            )

        except subprocess.CalledProcessError as exc:
            exit_code = exc.returncode

    return exit_code


if __name__ == "__main__":
    # Parse the arguments, run the tests and return exit code.

    parser = ArgumentParser(
        description=(
            "Helper script to run the tests suite for ptbcontrib. At most one of the optional "
            "arguments may be used. If no optional argument is specified, will run all available"
            "test suits."
        )
    )
    group = parser.add_mutually_exclusive_group()
    group.add_argument(
        "-c",
        "--changed",
        dest="changed",
        action="store_true",
        default=False,
        help=(
            "When passed, the git diff will be checked for all files that differ from the main "
            "branch. Only the corresponding tests suits will be run. Note that this may fail to "
            "identify some changed files in edge cases - please use the -n flag in that case."
        ),
    )
    group.add_argument(
        "-n",
        "--names",
        dest="names",
        default=[],
        nargs="*",
        help="Use to specify the names of the contributions that you want to test.",
        choices=contrib_names,
    )

    args = parser.parse_args()
    sys.exit(run_tests(changed=args.changed, names=args.names))