scripts/check_backend_associated_test_file.py - develop - githubmirror/oppia

scripts/check_backend_associated_test_file.py
126 строк5 KB
Sean Lip
Remove dependencies from common.py and from scripts on core (#23993)
09 дек 2025, 20:34
09 дек 2025, 20:342c53071
# Copyright 2022 The Oppia Authors. All Rights Reserved.
#
# 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.

"""This script checks if every backend file has an associated test file."""

from __future__ import annotations

import logging
import os
import subprocess
import sys

TOPMOST_LEVEL_PATH = './'

# NOTE TO DEVELOPERS: Do not add any new files to this list without asking
# the Dev Workflow Team first.
FILES_WITHOUT_ASSOCIATED_TEST_FILES = [
    # These are data files for testing and have no logic to be tested.
    'scripts/linters/test_files/invalid_annotations.py',
    'scripts/linters/test_files/invalid_author.py',
    'scripts/linters/test_files/invalid_black_pragma_fmt_off.py',
    'scripts/linters/test_files/invalid_black_pragma_fmt_skip.py',
    'scripts/linters/test_files/invalid_copyright.py',
    'scripts/linters/test_files/invalid_docstring.py',
    'scripts/linters/test_files/invalid_import_order.py',
    'scripts/linters/test_files/invalid_merge_conflict.py',
    'scripts/linters/test_files/invalid_datastore.py',
    'scripts/linters/test_files/invalid_no_newline.py',
    'scripts/linters/test_files/invalid_pycodestyle_error.py',
    'scripts/linters/test_files/invalid_pylint_id.py',
    'scripts/linters/test_files/invalid_python_three.py',
    'scripts/linters/test_files/invalid_request.py',
    'scripts/linters/test_files/invalid_tabs.py',
    'scripts/linters/test_files/invalid_todo.py',
    'scripts/linters/test_files/invalid_urlopen.py',
    'scripts/linters/test_files/valid.py',
    'scripts/linters/test_files/valid_job_imports.py',
    'scripts/linters/test_files/valid_py_ignore_pragma.py',
    'core/tests/build_sources/extensions/CodeRepl.py',
    'core/tests/build_sources/extensions/DragAndDropSortInput.py',
    'core/tests/data/failing_tests.py',
    'core/tests/data/image_constants.py',
]


def check_if_path_ignored(path_to_check: str) -> bool:
    """Checks whether the given path is ignored by git.

    Args:
        path_to_check: str. A path to a file or a dir.

    Returns:
        bool. Whether the given path is ignored by git.
    """
    command = ['git', 'check-ignore', '-q', path_to_check]

    # The "git check-ignore <path>" command returns 0 when the path is
    # ignored otherwise it returns 1. subprocess.call then returns this
    # returncode.

    return subprocess.call(command) == 0


def main() -> None:
    """Finds the non-empty backend files that lack an associated test file."""

    all_backend_files = []
    for root, _, files in os.walk(TOPMOST_LEVEL_PATH):
        for file in files:
            full_path = os.path.join(root, file)
            _, file_extension = os.path.splitext(full_path)
            if file_extension == '.py' and not check_if_path_ignored(full_path):
                all_backend_files.append(full_path)

    all_backend_files.sort()
    files_without_test = []
    for file in all_backend_files:
        if not file.endswith('_test.py'):
            # Replace last occurance of '.py' with '_test.py' to get the
            # associated test file.
            test_file_name = '%s_test.py' % file[:-3]
            if test_file_name not in all_backend_files:
                files_without_test.append(file)

    non_empty_files = []
    for file in files_without_test:
        line_count = 0
        with open(file, 'r', encoding='utf8') as f:
            line_count = len(f.readlines())
        if line_count > 0:
            non_empty_files.append(os.path.relpath(file, TOPMOST_LEVEL_PATH))
    errors = ''
    for file in non_empty_files:
        if file not in FILES_WITHOUT_ASSOCIATED_TEST_FILES:
            errors += '\033[1m{}\033[0m needs an associated backend test file.\n'.format(
                file
            )

    if errors:
        print('-------------------------------------------')
        print('Backend associated test file checks failed.')
        print('-------------------------------------------')
        logging.error(errors)
        sys.exit(1)
    else:
        print('-------------------------------------------')
        print('Backend associated test file checks passed.')
        print('-------------------------------------------')


# The 'no coverage' pragma is used as this line is un-testable. This is because
# it will only be called when check_backend_associated_test_file.py
# is used as a script.
if __name__ == '__main__':  # pragma: no cover
    main()