ziptie/pre_push.py at master · isFakeAccount/ziptie · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
#!/usr/bin/env python
"""Provides simple way to run formatter/linter/static analysis/tests on the project."""

import argparse
import sys
from subprocess import CalledProcessError, check_call


def do_process(args: list[str], cwd: str = ".") -> bool:
    """Run program provided by args.

    Returns ``True`` upon success.

    Output failed message on non-zero exit and return False.

    Exit if command is not found.

    """
    print(f"Running: {' '.join(args)}")
    try:
        check_call(args, shell=False, cwd=cwd)
    except CalledProcessError:
        print(f"\nFailed: {' '.join(args)}")
        return False
    except Exception as exc:
        print(f"{exc!s}\n", file=sys.stderr)
        raise SystemExit(1) from exc
    return True


def run_pre_commit() -> bool:
    """Runs pre-commit.

    :return: False if everything ran correctly. Otherwise, it will return True
    """
    success = True
    success &= do_process(["poetry", "run", "pre-commit", "run", "--all-files"])
    return success


def run_static_and_lint() -> bool:
    """Runs the static analysis and linting.

    :return: False if everything ran correctly. Otherwise, it will return True

    """
    success = True

    success &= do_process(["poetry", "run", "mypy", "src/psnawp_api/"])
    success &= do_process(["poetry", "run", "pyright", "src/psnawp_api/"])

    success &= do_process(["poetry", "run", "docstrfmt", "src/psnawp_api/"])

    success &= do_process(["poetry", "run", "ruff", "format", "src/psnawp_api/"])
    success &= do_process(["poetry", "run", "ruff", "format", "tests/"])

    success &= do_process(
        ["poetry", "run", "ruff", "check", "src/psnawp_api/", "--fix"],
    )
    return success


def run_docs() -> bool:
    """Runs the sphinx api docs generation and check cmds.

    :return: False if everything ran correctly. Otherwise, it will return True
    """
    success = True
    success &= do_process(["make", "apidoc"], cwd="docs/")
    success &= do_process(["make", "clean"], cwd="docs/")
    success &= do_process(["make", "html"], cwd="docs/")
    success &= do_process(["make", "linkcheck"], cwd="docs/")
    return success


def run_unit() -> bool:
    """Runs the unit-tests.

    Follows the behavior of the static tests, where any failed tests cause pre_push.py
    to fail.

    :return: False if everything ran correctly. Otherwise, it will return True
    """
    return do_process(
        ["poetry", "run", "pytest", "--cov-config=pyproject.toml"],
    )


def main() -> int:
    """Runs the main function.

    usage: pre_push.py [-h] [-n] [-u] [-a]

    Run static and/or unit-tests

    """
    parser = argparse.ArgumentParser(description="Run static and/or unit-tests")
    parser.add_argument(
        "-n",
        "--unstatic",
        action="store_true",
        help="Do not run static tests (black/flake8/pydocstyle/sphinx-build)",
        default=False,
    )
    parser.add_argument(
        "-d",
        "--docs",
        action="store_true",
        default=False,
        help="Run the docs",
    )
    parser.add_argument(
        "-u",
        "--unit-tests",
        "--unit",
        action="store_true",
        default=False,
        help="Run the unit tests",
    )
    parser.add_argument(
        "-p",
        "--pre-commit",
        "--pre",
        action="store_true",
        default=False,
        help="Run the unit tests",
    )
    parser.add_argument(
        "-a",
        "--all",
        action="store_true",
        default=False,
        help="Run all the tests (static and unit). Overrides the unstatic argument.",
    )
    args = parser.parse_args()
    success = True
    try:
        if args.all or args.pre_commit:
            success &= run_pre_commit()

        if args.all or not args.unstatic:
            success &= run_static_and_lint()

        if args.all or args.docs:
            success &= run_docs()

        if args.all or args.unit_tests:
            success &= run_unit()
    except KeyboardInterrupt:
        return int(not False)
    return int(not success)


if __name__ == "__main__":
    exit_code = main()
    print("\npre_push.py: Success!" if not exit_code else "\npre_push.py: Fail")
    sys.exit(exit_code)