scripts/check_backend_associated_test_file_test.py - develop - githubmirror/oppia

scripts/check_backend_associated_test_file_test.py
150 строк5 KB
Gabriel Fuentes
Black formatter staging (#23456)
05 окт 2025, 06:15
05 окт 2025, 06:1562ec95a
# 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.

"""Unit tests for scripts/check_backend_associated_test_file.py."""

from __future__ import annotations

import builtins
import logging
import os
import sys
import tempfile

from core import feconf
from core.tests import test_utils
from scripts import check_backend_associated_test_file


class CheckBackendAssociatedTestFileTests(test_utils.GenericTestBase):
    """Unit tests for scripts/check_backend_associated_test_file.py."""

    def setUp(self) -> None:
        super().setUp()
        self.print_arr: list[str] = []

        def mock_print(msg: str) -> None:
            self.print_arr.append(msg)

        self.error_arr: list[str] = []

        def mock_error(msg: str) -> None:
            self.error_arr.append(msg)

        self.print_swap = self.swap(builtins, 'print', mock_print)
        self.swap_logging = self.swap(logging, 'error', mock_error)
        self.swap_exit = self.swap(sys, 'exit', lambda _: None)

    def test_checks_fail_when_a_backend_file_lacks_associated_test_file(
        self,
    ) -> None:
        tempdir = tempfile.TemporaryDirectory(prefix=os.getcwd() + '/core/')
        backend_file = os.path.join(tempdir.name, 'backend_file.py')
        frontend_file = os.path.join(tempdir.name, 'frontend_file.ts')
        topmost_level_path_swap = self.swap(
            check_backend_associated_test_file,
            'TOPMOST_LEVEL_PATH',
            tempdir.name,
        )
        with open(backend_file, 'w', encoding='utf8') as f:
            f.write('Example code')
        with open(frontend_file, 'w', encoding='utf8') as f:
            f.write('Example code')

        with self.print_swap, self.swap_logging, self.swap_exit:
            with topmost_level_path_swap:
                check_backend_associated_test_file.main()

        tempdir.cleanup()
        self.assertIn(
            'Backend associated test file checks failed.', self.print_arr
        )
        self.assertIn(
            '\033[1m{}\033[0m needs an associated backend test file.\n'.format(
                os.path.relpath(backend_file, tempdir.name)
            ),
            self.error_arr,
        )
        self.assertNotIn(
            '\033[1m{}\033[0m needs an associated backend test file.\n'.format(
                os.path.relpath(frontend_file, tempdir.name)
            ),
            self.error_arr,
        )

    def test_pass_when_file_in_exclusion_list_lacks_associated_test(
        self,
    ) -> None:
        tempdir = tempfile.TemporaryDirectory(prefix=os.getcwd() + '/core/')
        backend_file = os.path.join(tempdir.name, 'backend_file.py')
        topmost_level_path_swap = self.swap(
            check_backend_associated_test_file,
            'TOPMOST_LEVEL_PATH',
            tempdir.name,
        )
        with open(backend_file, 'w', encoding='utf8') as f:
            f.write('Example code')
        (
            check_backend_associated_test_file.FILES_WITHOUT_ASSOCIATED_TEST_FILES.append(
                os.path.relpath(backend_file, tempdir.name)
            )
        )
        with self.print_swap, self.swap_logging, self.swap_exit:
            with topmost_level_path_swap:
                check_backend_associated_test_file.main()

        tempdir.cleanup()
        self.assertIn(
            'Backend associated test file checks passed.', self.print_arr
        )
        self.assertNotIn(
            '\033[1m{}\033[0m needs an associated backend test file.\n'.format(
                os.path.relpath(backend_file, tempdir.name)
            ),
            self.error_arr,
        )

    def test_checks_pass_when_all_backend_files_have_an_associated_test_file(
        self,
    ) -> None:
        tempdir = tempfile.TemporaryDirectory(
            prefix=os.path.join(os.getcwd(), feconf.TESTS_DATA_DIR, '')
        )
        backend_file = os.path.join(tempdir.name, 'backend_file.py')
        backend_test_file = os.path.join(tempdir.name, 'backend_file_test.py')
        topmost_level_path_swap = self.swap(
            check_backend_associated_test_file,
            'TOPMOST_LEVEL_PATH',
            tempdir.name,
        )

        with open(backend_file, 'w', encoding='utf8') as f:
            f.write('Example code')
        with open(backend_test_file, 'w', encoding='utf8') as f:
            f.write('Example code')
        with self.print_swap, self.swap_logging, self.swap_exit:
            with topmost_level_path_swap:
                check_backend_associated_test_file.main()

        tempdir.cleanup()
        self.assertIn(
            'Backend associated test file checks passed.', self.print_arr
        )
        self.assertEqual(self.error_arr, [])
        self.assertNotIn(
            '\033[1m{}\033[0m needs an associated backend test file.\n'.format(
                os.path.relpath(backend_file, tempdir.name)
            ),
            self.error_arr,
        )