Merge pull request #582 from davidrudlstorfer/update_pre_commit_file_name_include_check

davidrudlstorfer · web-flow · commit 1c4bc875f991 · 2025-03-31T13:09:42.000+02:00
Update custom pre-commit hook with improved file name and include checks
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -100,18 +100,27 @@ repos:
         always_run: true
         pass_filenames: false
 
-      - id: cpp-filename-includes
-        name: C++ file names and include style
-        description: 'Check that all C++ files have the correct file name and include style'
+      - id: cpp-filename
+        name: C++ file names
+        description: 'Check that all C++ files have the correct file name'
+        language: system
+        types_or: [c++, c]
+        exclude: 'tests/cut_test/|mm$|dummy.cpp'
+        entry: utilities/python-venv/bin/check-filenames
+        require_serial: true # To give a non duplicated error output
+
+      - id: cpp-include
+        name: C++ includes
+        description: 'Check that all C++ files have correct includes'
         language: system
         types_or: [c++, c]
         exclude: 'tests/cut_test/|mm$'
-        entry: utilities/python-venv/bin/check-filenames-and-includes
-        args: ['--paths', 'src/', 'unittests/', 'apps/', '--files']
+        entry: utilities/python-venv/bin/check-includes
+        require_serial: true # To give a non duplicated error output
 
-      - id: cpp-include-guard
-        name: Include guards
-        description: 'Check that all C++ files have the correct include guards'
+      - id: cpp-header-guard
+        name: Header guards
+        description: 'Check that all C++ files have the correct header guards'
         language: python
         types_or: [c++, c]
         files: '\.(h|hpp)$'
diff --git a/src/core/fem/tests/geometric_search/4C_fem_geometric_search_create_bounding_volumes_test.hpp b/src/core/fem/tests/geometric_search/4C_fem_geometric_search_create_bounding_volumes_test.hpp
@@ -5,8 +5,8 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#ifndef FOUR_C_GEOMETRIC_SEARCH_CREATE_BOUNDING_VOLUMES_TEST_HPP
-#define FOUR_C_GEOMETRIC_SEARCH_CREATE_BOUNDING_VOLUMES_TEST_HPP
+#ifndef FOUR_C_FEM_GEOMETRIC_SEARCH_CREATE_BOUNDING_VOLUMES_TEST_HPP
+#define FOUR_C_FEM_GEOMETRIC_SEARCH_CREATE_BOUNDING_VOLUMES_TEST_HPP
 
 #include "4C_config.hpp"
 
diff --git a/src/core/fem/tests/geometric_search/4C_fem_geometric_search_distributed_test.np3.cpp b/src/core/fem/tests/geometric_search/4C_fem_geometric_search_distributed_test.np3.cpp
@@ -16,8 +16,8 @@
 
 #ifdef FOUR_C_WITH_ARBORX
 
+#include "4C_fem_geometric_search_create_bounding_volumes_test.hpp"
 #include "4C_fem_geometric_search_distributed_tree.hpp"
-#include "4C_geometric_search_create_bounding_volumes_test.hpp"
 
 
 namespace
diff --git a/src/core/fem/tests/geometric_search/4C_fem_geometric_search_test.cpp b/src/core/fem/tests/geometric_search/4C_fem_geometric_search_test.cpp
@@ -16,8 +16,8 @@
 #ifdef FOUR_C_WITH_ARBORX
 
 #include "4C_fem_geometric_search_bvh.hpp"
+#include "4C_fem_geometric_search_create_bounding_volumes_test.hpp"
 #include "4C_fem_geometric_search_utils.hpp"
-#include "4C_geometric_search_create_bounding_volumes_test.hpp"
 
 
 namespace
diff --git a/src/core/fem/tests/geometry/4C_fem_geometry_element_volume_test.cpp b/src/core/fem/tests/geometry/4C_fem_geometry_element_volume_test.cpp
diff --git a/src/core/utils/tests/functions/4C_utils_function_library_test.cpp b/src/core/utils/tests/functions/4C_utils_function_library_test.cpp
@@ -7,9 +7,10 @@
 
 #include <gtest/gtest.h>
 
+#include "4C_utils_function_library.hpp"
+
 #include "4C_utils_cubic_spline_interpolation.hpp"
 #include "4C_utils_function.hpp"
-#include "4C_utils_function_library.hpp"
 
 #include <fstream>
 
diff --git a/src/core/utils/tests/functions/4C_utils_functionvariables_test.cpp b/src/core/utils/tests/functions/4C_utils_functionvariables_test.cpp
diff --git a/src/core/utils/tests/functions/4C_utils_symbolic_expression_test.cpp b/src/core/utils/tests/functions/4C_utils_symbolic_expression_test.cpp
@@ -7,9 +7,10 @@
 
 #include <gtest/gtest.h>
 
+#include "4C_utils_symbolic_expression.hpp"
+
 #include "4C_unittest_utils_assertions_test.hpp"
 #include "4C_utils_exceptions.hpp"
-#include "4C_utils_symbolic_expression.hpp"
 
 FOUR_C_NAMESPACE_OPEN
 
diff --git a/src/core/utils/tests/numerics/4C_utils_cubic_spline_interpolation_test.cpp b/src/core/utils/tests/numerics/4C_utils_cubic_spline_interpolation_test.cpp
@@ -8,6 +8,7 @@
 #include <gtest/gtest.h>
 
 #include "4C_utils_cubic_spline_interpolation.hpp"
+
 #include "4C_utils_exceptions.hpp"
 
 #include <memory>
diff --git a/utilities/four_c_utils/pyproject.toml b/utilities/four_c_utils/pyproject.toml
@@ -19,7 +19,8 @@ include = ["four_c_utils"]
 
 [project.scripts]
 check-file-header = "four_c_utils.check_file_header:main"
-check-filenames-and-includes = "four_c_utils.check_filenames_and_includes:main"
+check-filenames = "four_c_utils.check_filenames:main"
+check-includes = "four_c_utils.check_includes:main"
 check-header-guards = "four_c_utils.check_header_guards:main"
 check-test-files = "four_c_utils.check_test_files:main"
 check-preprocessor = "four_c_utils.check_preprocessor:main"
diff --git a/utilities/four_c_utils/src/four_c_utils/check_filenames.py b/utilities/four_c_utils/src/four_c_utils/check_filenames.py
@@ -0,0 +1,88 @@
+# This file is part of 4C multiphysics licensed under the
+# GNU Lesser General Public License v3.0 or later.
+#
+# See the LICENSE.md file in the top-level for license information.
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+"""Check that C++ files have correct filenames"""
+
+import sys
+
+from pathlib import Path
+
+
+def get_module_name(file: Path) -> str | None:
+    """Get the corresponding module name for a file.
+
+    The module name is determined by the parent folder
+    name which is on the same level as the first
+    .contains_modules file.
+
+    Args:
+        file: The file to get the module name from
+
+    Returns:
+        The module name or None if no module is found
+    """
+
+    current_dir = file.parent.absolute()
+
+    while True:
+        if current_dir == Path("/"):
+            return None
+        if (current_dir / ".contains_modules").is_file():
+            return file.absolute().relative_to(current_dir).parts[0]
+        current_dir = current_dir.parent
+
+
+def check_file_name(file: Path) -> bool:
+    """Check that the file has a valid filename.
+
+    A valid filename is prefixed by '4C' and the module name.
+    If it is a test file it is postfixed by '_test'.
+
+    Args:
+        file: The file to check
+
+    Returns:
+        True if the file has a valid filename, False otherwise
+    """
+
+    module_name = get_module_name(file)
+
+    if not file.name.startswith("4C_" if module_name is None else f"4C_{module_name}"):
+        return False
+
+    if "/tests/" in str(file) or "/unittests/" in str(file):
+        if not file.name.split(".")[0].endswith("_test"):
+            return False
+
+    return True
+
+
+def main():
+    """Check that C++ files have correct filenames."""
+
+    wrong_file_names = []
+
+    for file in sys.argv[1:]:
+        if not check_file_name(Path(file)):
+            wrong_file_names.append(file)
+
+    if wrong_file_names:
+        print("The following files do not adhere to our file naming convention:\n")
+        for wrong_file in wrong_file_names:
+            print(f"    {wrong_file}")
+
+        print(
+            "\nPlease rename the files to match the naming convention.\n"
+            "A valid filename must:\n"
+            "   - Be prefixed with '4C_' followed by the module name\n"
+            "   - If it is a test file, it should end with '_test'"
+        )
+
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/utilities/four_c_utils/src/four_c_utils/check_filenames_and_includes.py b/utilities/four_c_utils/src/four_c_utils/check_filenames_and_includes.py
diff --git a/utilities/four_c_utils/src/four_c_utils/check_includes.py b/utilities/four_c_utils/src/four_c_utils/check_includes.py
