Switch PROJECT_CONFIG.root with PROJECT_CONFIG.root_path

ArBridgeman · ArBridgeman · commit 0ed2830db357 · 2025-12-01T13:32:26.000+01:00
diff --git a/doc/user_guide/migrating.rst b/doc/user_guide/migrating.rst
@@ -74,7 +74,7 @@ For example, if test execution isn't performed in the standard way (e.g., :code:
         # within the function to keep them isolated and simplify future removal or replacement.
         from exasol.toolbox.nox._shared import get_filtered_python_files
 
-        py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+        py_files = get_filtered_python_files(PROJECT_CONFIG.root_path)
         print("The original 'format:fix' task has been taken hostage by this overwrite")
         print("Files:\n{files}".format(files="\n".join(py_files))
 
diff --git a/exasol/toolbox/nox/_artifacts.py b/exasol/toolbox/nox/_artifacts.py
@@ -45,16 +45,16 @@
 @nox.session(name="artifacts:validate", python=False)
 def check_artifacts(session: Session) -> None:
     """Validate that all project artifacts are available and consistent"""
-    all_files = {f.name for f in PROJECT_CONFIG.root.iterdir() if f.is_file()}
+    all_files = {f.name for f in PROJECT_CONFIG.root_path.iterdir() if f.is_file()}
     if missing_files := (ALL_LINT_FILES - all_files):
         print(f"files not available: {missing_files}", file=sys.stderr)
         sys.exit(1)
 
     all_is_valid_checks = [
-        _is_valid_lint_txt(Path(PROJECT_CONFIG.root, LINT_TXT)),
-        _is_valid_lint_json(Path(PROJECT_CONFIG.root, LINT_JSON)),
-        _is_valid_security_json(Path(PROJECT_CONFIG.root, SECURITY_JSON)),
-        _is_valid_coverage(Path(PROJECT_CONFIG.root, COVERAGE_DB)),
+        _is_valid_lint_txt(Path(PROJECT_CONFIG.root_path, LINT_TXT)),
+        _is_valid_lint_json(Path(PROJECT_CONFIG.root_path, LINT_JSON)),
+        _is_valid_security_json(Path(PROJECT_CONFIG.root_path, SECURITY_JSON)),
+        _is_valid_coverage(Path(PROJECT_CONFIG.root_path, COVERAGE_DB)),
     ]
     if not all(all_is_valid_checks):
         sys.exit(1)
diff --git a/exasol/toolbox/nox/_documentation.py b/exasol/toolbox/nox/_documentation.py
@@ -51,7 +51,7 @@ def _git_diff_changes_main() -> int:
             "--quiet",
             "origin/main",
             "--",
-            PROJECT_CONFIG.root / "doc/changes",
+            PROJECT_CONFIG.documentation_path / "changes",
         ],
         capture_output=True,
     )
@@ -73,7 +73,7 @@ def build_docs(session: Session) -> None:
 @nox.session(name="docs:open", python=False)
 def open_docs(session: Session) -> None:
     """Opens the built project documentation"""
-    docs_folder = PROJECT_CONFIG.root / DOCS_OUTPUT_DIR
+    docs_folder = PROJECT_CONFIG.root_path / DOCS_OUTPUT_DIR
     if not docs_folder.exists():
         session.error(f"No documentation could be found. {docs_folder} is missing")
     index = docs_folder / "index.html"
@@ -83,7 +83,7 @@ def open_docs(session: Session) -> None:
 @nox.session(name="docs:clean", python=False)
 def clean_docs(_session: Session) -> None:
     """Removes the documentations build folder"""
-    docs_folder = PROJECT_CONFIG.root / DOCS_OUTPUT_DIR
+    docs_folder = PROJECT_CONFIG.root_path / DOCS_OUTPUT_DIR
     if docs_folder.exists():
         shutil.rmtree(docs_folder)
 
@@ -146,7 +146,7 @@ def _docs_links_check(doc_config: Path, args):
 @nox.session(name="links:list", python=False)
 def docs_list_links(session: Session) -> None:
     """List all the links within the documentation."""
-    r_code, text = _docs_list_links(PROJECT_CONFIG.doc)
+    r_code, text = _docs_list_links(PROJECT_CONFIG.documentation_path)
     print(text)
     if r_code != 0:
         session.error()
@@ -164,7 +164,7 @@ def docs_links_check(session: Session) -> None:
         "-o", "--output", type=Path, help="path to copy the output json", default=None
     )
     args = parser.parse_args(session.posargs)
-    r_code, problems = _docs_links_check(PROJECT_CONFIG.doc, args)
+    r_code, problems = _docs_links_check(PROJECT_CONFIG.documentation_path, args)
     if r_code >= 2:
         session.error(2)
     if r_code == 1 or problems != "":
diff --git a/exasol/toolbox/nox/_format.py b/exasol/toolbox/nox/_format.py
@@ -45,7 +45,7 @@ def command(*args: str) -> Iterable[str]:
 @nox.session(name="format:fix", python=False)
 def fix_format(session: Session) -> None:
     """Runs all automated format fixes on the code base"""
-    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root_path)
     _version(session, Mode.Fix)
     _pyupgrade(session, config=PROJECT_CONFIG, files=py_files)
     _ruff(session, mode=Mode.Fix, files=py_files)
@@ -55,6 +55,6 @@ def fix_format(session: Session) -> None:
 @nox.session(name="format:check", python=False)
 def check_format(session: Session) -> None:
     """Checks the project for correct formatting"""
-    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root_path)
     _ruff(session, mode=Mode.Check, files=py_files)
     _code_format(session=session, mode=Mode.Check, files=py_files)
diff --git a/exasol/toolbox/nox/_lint.py b/exasol/toolbox/nox/_lint.py
@@ -16,8 +16,8 @@
 
 
 def _pylint(session: Session, files: Iterable[str]) -> None:
-    json_file = PROJECT_CONFIG.root / ".lint.json"
-    txt_file = PROJECT_CONFIG.root / ".lint.txt"
+    json_file = PROJECT_CONFIG.root_path / ".lint.json"
+    txt_file = PROJECT_CONFIG.root_path / ".lint.txt"
 
     session.run(
         "pylint",
@@ -50,7 +50,7 @@ def _security_lint(session: Session, files: Iterable[str]) -> None:
         "--format",
         "json",
         "--output",
-        PROJECT_CONFIG.root / ".security.json",
+        PROJECT_CONFIG.root_path / ".security.json",
         "--exit-zero",
         *files,
     )
@@ -130,7 +130,7 @@ def lint(session: Session) -> None:
 @nox.session(name="lint:typing", python=False)
 def type_check(session: Session) -> None:
     """Runs the type checker on the project"""
-    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root_path)
     _type_check(session=session, files=py_files)
 
 
@@ -144,7 +144,7 @@ def security_lint(session: Session) -> None:
 @nox.session(name="lint:dependencies", python=False)
 def dependency_check(session: Session) -> None:
     """Checks if only valid sources of dependencies are used"""
-    content = Path(PROJECT_CONFIG.root, PoetryFiles.pyproject_toml).read_text()
+    content = Path(PROJECT_CONFIG.root_path, PoetryFiles.pyproject_toml).read_text()
     dependencies = Dependencies.parse(content)
     console = rich.console.Console()
     if illegal := dependencies.illegal:
diff --git a/exasol/toolbox/nox/_metrics.py b/exasol/toolbox/nox/_metrics.py
@@ -23,7 +23,7 @@ class RequiredFile:
     """
 
     def __init__(self, file: Path | str, task: str):
-        self.file = file if isinstance(file, Path) else PROJECT_CONFIG.root / file
+        self.file = file if isinstance(file, Path) else PROJECT_CONFIG.root_path / file
         self.task = task
 
     def __str__(self) -> str:
diff --git a/exasol/toolbox/nox/_package.py b/exasol/toolbox/nox/_package.py
@@ -12,5 +12,5 @@ def package_check(session: Session) -> None:
 
     This has more robust checks for rst documentation than markdown.
     """
-    session.run("poetry", "build", "--project", PROJECT_CONFIG.root)
-    session.run("twine", "check", PROJECT_CONFIG.root / "./dist/*")
+    session.run("poetry", "build", "--project", PROJECT_CONFIG.root_path)
+    session.run("twine", "check", PROJECT_CONFIG.root_path / "./dist/*")
diff --git a/exasol/toolbox/nox/_release.py b/exasol/toolbox/nox/_release.py
@@ -128,7 +128,7 @@ def prepare_release(session: Session) -> None:
 
     changelogs = Changelogs(
         changes_path=PROJECT_CONFIG.doc / "changes",
-        root_path=PROJECT_CONFIG.root,
+        root_path=PROJECT_CONFIG.root_path,
         version=new_version,
     )
     changelogs.update_changelogs_for_release()
@@ -143,7 +143,7 @@ def prepare_release(session: Session) -> None:
         return
 
     changed_files += [
-        PROJECT_CONFIG.root / PoetryFiles.pyproject_toml,
+        PROJECT_CONFIG.root_path / PoetryFiles.pyproject_toml,
         PROJECT_CONFIG.version_file,
     ]
     results = pm.hook.prepare_release_add_files(session=session, config=PROJECT_CONFIG)
diff --git a/exasol/toolbox/nox/tasks.py b/exasol/toolbox/nox/tasks.py
@@ -34,7 +34,7 @@
 def check(session: Session) -> None:
     """Runs all available checks on the project"""
     context = _context(session, coverage=True)
-    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root_path)
     _version(session, Mode.Check)
     _code_format(session, Mode.Check, py_files)
     _pylint(session, py_files)
diff --git a/exasol/toolbox/util/dependencies/shared_models.py b/exasol/toolbox/util/dependencies/shared_models.py
@@ -66,7 +66,7 @@ def files(self) -> tuple[str, ...]:
 def poetry_files_from_latest_tag() -> Generator[Path]:
     """Context manager to set up a temporary directory with poetry files from the latest tag"""
     latest_tag = Git.get_latest_tag()
-    path = PROJECT_CONFIG.root.relative_to(Git.toplevel())
+    path = PROJECT_CONFIG.root_path.relative_to(Git.toplevel())
     with tempfile.TemporaryDirectory() as tmpdir_str:
         tmp_dir = Path(tmpdir_str)
         for file in PoetryFiles().files:
diff --git a/test/integration/project-template/conftest.py b/test/integration/project-template/conftest.py
@@ -18,7 +18,7 @@ def new_project(cwd):
     package_name = "package"
 
     subprocess.run(
-        ["cookiecutter", PROJECT_CONFIG.root / "project-template", "-o", cwd, "--no-input",
+        ["cookiecutter", PROJECT_CONFIG.root_path / "project-template", "-o", cwd, "--no-input",
          f"project_name={project_name}", f"repo_name={repo_name}",
          f"package_name={package_name}",
          ], capture_output=True, check=True)
@@ -32,8 +32,9 @@ def poetry_install(run_command, poetry_path):
     # The tests want to verify the current branch of the PTB incl. its cookiecutter
     # template before releasing the PTB. The following command therefore modifies the
     # dependency to the PTB itself in the pyproject.toml file by replacing the latest
-    # released PTB version with the current checked-out branch in PROJECT_CONFIG.root:
-    run_command([poetry_path, "add", "--group", "dev", PROJECT_CONFIG.root])
+    # released PTB version with the current checked-out branch in
+    # PROJECT_CONFIG.root_path:
+    run_command([poetry_path, "add", "--group", "dev", PROJECT_CONFIG.root_path])
 
 
 @pytest.fixture(scope="session")
diff --git a/test/unit/nox/_package_check_test.py b/test/unit/nox/_package_check_test.py
@@ -24,12 +24,14 @@ def test_raises_non_zero_exist_with_readme_error(nox_session, tmp_path):
         package_readme = package / "README.rst"
 
         # copy over `packages` and `include` from `pyproject.toml` to for `poetry build`
-        shutil.copytree(PROJECT_CONFIG.root / "exasol", package / "exasol")
-        shutil.copyfile(PROJECT_CONFIG.root / "README.rst", package_readme)
-        shutil.copytree(PROJECT_CONFIG.root / "doc/changes", package / "doc/changes")
-        shutil.copyfile(PROJECT_CONFIG.root / "LICENSE", package / "LICENSE")
+        shutil.copytree(PROJECT_CONFIG.root_path / "exasol", package / "exasol")
+        shutil.copyfile(PROJECT_CONFIG.root_path / "README.rst", package_readme)
+        shutil.copytree(
+            PROJECT_CONFIG.root_path / "doc/changes", package / "doc/changes"
+        )
+        shutil.copyfile(PROJECT_CONFIG.root_path / "LICENSE", package / "LICENSE")
         shutil.copyfile(
-            PROJECT_CONFIG.root / "pyproject.toml", package / "pyproject.toml"
+            PROJECT_CONFIG.root_path / "pyproject.toml", package / "pyproject.toml"
         )
 
         # create an error in readme.rst
diff --git a/test/unit/util/dependencies/audit_test.py b/test/unit/util/dependencies/audit_test.py
@@ -238,7 +238,7 @@ def test_with_mock(self, sample_vulnerability):
             "exasol.toolbox.util.dependencies.audit.audit_poetry_files",
             return_value=sample_vulnerability.pip_audit_json,
         ):
-            result = get_vulnerabilities(PROJECT_CONFIG.root)
+            result = get_vulnerabilities(PROJECT_CONFIG.root_path)
 
         # if successful, no errors & should be 1 due to mock
         assert isinstance(result, list)
diff --git a/test/unit/util/dependencies/poetry_dependencies_test.py b/test/unit/util/dependencies/poetry_dependencies_test.py
@@ -134,7 +134,7 @@ def test_all_dependencies(create_poetry_project, project_path):
 
 
 def test_get_dependencies():
-    result = get_dependencies(PROJECT_CONFIG.root)
+    result = get_dependencies(PROJECT_CONFIG.root_path)
 
     # if successful, no errors & should be non-empty dictionary
     assert isinstance(result, dict)
