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
|
"""
Script for checking if all the test files are installed after building.
Examples::
$ python check_installation.py install_directory_name
install_directory_name:
the relative path from the root of the repo to the directory where
SciPy is installed (for dev.py usually "build-install")
Notes
=====
The script will stop on encountering the first missing file in the install dir,
it will not give a full listing. This should be okay, because the script is
meant for use in CI so it's not like many files will be missing at once.
"""
import os
import glob
import sys
from get_submodule_paths import get_submodule_paths
CUR_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__)))
ROOT_DIR = os.path.dirname(CUR_DIR)
SCIPY_DIR = os.path.join(ROOT_DIR, 'scipy')
submodule_paths = get_submodule_paths()
# Files whose installation path will be different from original one
changed_installed_path = {
'scipy/_build_utils/tests/test_scipy_version.py':
'scipy/_lib/tests/test_scipy_version.py'
}
def main(install_dir, no_tests):
INSTALLED_DIR = os.path.join(ROOT_DIR, install_dir)
if not os.path.exists(INSTALLED_DIR):
raise ValueError(f"Provided install dir {INSTALLED_DIR} does not exist")
scipy_test_files = get_test_files(SCIPY_DIR)
scipy_test_extension_modules = get_test_files(INSTALLED_DIR, "so")
installed_test_files = get_test_files(INSTALLED_DIR)
if no_tests:
if len(scipy_test_extension_modules) > 0:
raise Exception(f"{scipy_test_extension_modules.values()} "
"should not be installed but "
"are found in the installation directory.")
else:
if len(scipy_test_extension_modules) == 0:
raise Exception("Test for extension modules should be "
"installed but are not found in the "
"installation directory.")
# Check test files detected in repo are installed
for test_file in scipy_test_files.keys():
if no_tests:
if test_file in installed_test_files:
raise Exception(f"{test_file} should not be installed but "
"is found in the installation directory.")
continue
if test_file not in installed_test_files.keys():
raise Exception(f"{scipy_test_files[test_file]} is not installed; "
f"either install it or add `{test_file}` to the "
"exception list in `tools/check_installation.py`")
if no_tests:
print("----------- No test files were installed --------------")
else:
print("----------- All the test files were installed --------------")
scipy_pyi_files = get_pyi_files(SCIPY_DIR)
installed_pyi_files = get_pyi_files(INSTALLED_DIR)
# Check *.pyi files detected in repo are installed
for pyi_file in scipy_pyi_files.keys():
if pyi_file not in installed_pyi_files.keys():
if no_tests and "test" in scipy_pyi_files[pyi_file]:
continue
raise Exception(f"{scipy_pyi_files[pyi_file]} is not installed")
print("----------- All the necessary .pyi files were installed --------------")
def get_suffix_path(current_path, levels=1):
current_new = current_path
for i in range(levels + 1):
current_new = os.path.dirname(current_new)
return os.path.relpath(current_path, current_new)
def get_test_files(dir, ext="py"):
test_files = dict()
underscore = "_" if ext == "so" else ""
for path in glob.glob(f'{dir}/**/{underscore}test_*.{ext}', recursive=True):
if any(submodule_path in path for submodule_path in submodule_paths):
continue
suffix_path = get_suffix_path(path, 3)
suffix_path = changed_installed_path.get(suffix_path, suffix_path)
test_files[suffix_path] = path
return test_files
def get_pyi_files(dir):
pyi_files = dict()
for path in glob.glob(f'{dir}/**/*.pyi', recursive=True):
suffix_path = get_suffix_path(path, 2)
pyi_files[suffix_path] = path
return pyi_files
if __name__ == '__main__':
if len(sys.argv) < 2:
raise ValueError("Incorrect number of input arguments, need "
"check_installation.py relpath/to/installed/scipy")
install_dir = sys.argv[1]
no_tests = False
if len(sys.argv) == 3:
no_tests = sys.argv[2] == "--no-tests"
main(install_dir, no_tests)
|