ci: Check and fix missing includes (#2248)

This adds a simple script to check all main header files of ACTS for missing includes (like in #2247). This is done very simple: We try to compile (and not link) ```c++ #include <file> int main() { return 0; } ``` If this succeeds, the compiler is able to parse the whole file sucessfully, and thus no include is missing. This check takes about 10 minutes on my machine for the `Core` package... I think that is worth it.
acts-project · Jul 14, 2023 · 8833e70 · 8833e70
1 parent 8fbbc46
commit 8833e70
Show file tree

Hide file tree

Showing 24 changed files with 84 additions and 8 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -97,6 +97,16 @@ jobs:
       - name: Check
         run: >
           CI/check_spelling
+  missing_includes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install clang
+        run: >
+          sudo apt-get install -y clang libeigen3-dev libboost-dev
+      - name: Check
+        run: >
+          CI/missing_include_check.sh
   fpe_masks:
     runs-on: ubuntu-latest
     steps:

diff --git a/CI/missing_include_check.sh b/CI/missing_include_check.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+RET=0
+ERRORS=0
+
+FILES=$(find  Core/include/ -name "*.hpp" | grep -v "/detail/")
+N_FILES=$(echo "$FILES" | wc -l)
+echo "Check $N_FILES files"
+
+ITER=0
+
+for file in $(find  Core/include/ -name "*.hpp" | grep -v "/detail/"); do
+    ITER=$((ITER+1))
+    echo "$(date +%H:%M:%S)    $((100*ITER/N_FILES))%   check $file"
+    out=$(printf "#include <${file:13}>\nint main() { return 0; }" | clang++ -std=c++17 -O0 -c -I "Core/include" -I "/usr/include/eigen3" -x c++ - 2>&1)
+    if [[ "$?" -ne "0" ]]; then
+        echo "------------------------------------"
+        echo "$out"
+        echo "------------------------------------"
+        RET=1
+        ERRORS=$((ERRORS+1))
+    fi
+done
+
+echo "Total errors: $ERRORS"
+exit $RET
diff --git a/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp b/Core/include/Acts/EventData/SingleFreeTrackParameters.hpp
@@ -9,6 +9,8 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Definitions/Common.hpp"
+#include "Acts/Definitions/TrackParametrization.hpp"
 #include "Acts/EventData/detail/PrintParameters.hpp"
 #include "Acts/Utilities/UnitVectors.hpp"
 

diff --git a/Core/include/Acts/EventData/TrackParametersConcept.hpp b/Core/include/Acts/EventData/TrackParametersConcept.hpp
@@ -9,9 +9,11 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Definitions/TrackParametrization.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Utilities/TypeTraits.hpp"
 
+#include <optional>
 #include <type_traits>
 
 namespace Acts {

diff --git a/Core/include/Acts/EventData/TrackStateType.hpp b/Core/include/Acts/EventData/TrackStateType.hpp
@@ -9,8 +9,12 @@
 #pragma once
 
 #include <bitset>
+#include <cassert>
 #include <cstddef>
 #include <cstdint>
+#include <limits>
+#include <ostream>
+
 namespace Acts {
 
 /// @enum TrackStateFlag

diff --git a/Core/include/Acts/EventData/Utils.hpp b/Core/include/Acts/EventData/Utils.hpp
@@ -8,6 +8,8 @@
 
 #pragma once
 
+#include <type_traits>
+
 namespace Acts::detail {
 
 template <template <typename...> class, template <typename...> class>

diff --git a/Core/include/Acts/Geometry/GeometryObjectSorter.hpp b/Core/include/Acts/Geometry/GeometryObjectSorter.hpp
@@ -15,8 +15,10 @@
 
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
+#include "Acts/Utilities/VectorHelpers.hpp"
 
 #include <functional>
+#include <memory>
 
 namespace Acts {
 

diff --git a/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp b/Core/include/Acts/Geometry/ITrackingVolumeHelper.hpp
@@ -9,6 +9,7 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/Utilities/BinningType.hpp"
 
 #include <memory>

diff --git a/Core/include/Acts/Material/MaterialComposition.hpp b/Core/include/Acts/Material/MaterialComposition.hpp
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include <algorithm>
 #include <cassert>
 #include <cstdint>
 #include <vector>
@@ -123,7 +124,7 @@ class MaterialComposition {
   /// Check if the composed material is valid, i.e. it is not vacuum.
   operator bool() const { return !m_elements.empty(); }
   /// Return the number of elements.
-  size_t size() const { return m_elements.size(); }
+  std::size_t size() const { return m_elements.size(); }
 
  private:
   std::vector<ElementFraction> m_elements;

diff --git a/Core/include/Acts/Navigation/NavigationStateFillers.hpp b/Core/include/Acts/Navigation/NavigationStateFillers.hpp
@@ -10,6 +10,7 @@
 
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
+#include "Acts/Navigation/NavigationState.hpp"
 #include "Acts/Surfaces/BoundaryCheck.hpp"
 #include "Acts/Utilities/Intersection.hpp"
 

diff --git a/Core/include/Acts/Propagator/StepperExtensionList.hpp b/Core/include/Acts/Propagator/StepperExtensionList.hpp
@@ -8,11 +8,15 @@
 
 #pragma once
 
+#include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Definitions/TrackParametrization.hpp"
 #include "Acts/Propagator/detail/Auctioneer.hpp"
 #include "Acts/Utilities/detail/Extendable.hpp"
 #include "Acts/Utilities/detail/MPL/all_of.hpp"
 #include "Acts/Utilities/detail/MPL/has_duplicates.hpp"
 
+#include <array>
+
 namespace Acts {
 
 /// @brief Container of extensions used in the stepper of the propagation. This

diff --git a/Core/include/Acts/Propagator/detail/Auctioneer.hpp b/Core/include/Acts/Propagator/detail/Auctioneer.hpp
@@ -9,6 +9,7 @@
 #pragma once
 
 #include <algorithm>
+#include <array>
 
 namespace Acts {
 namespace detail {

diff --git a/Core/include/Acts/Seeding/CandidatesForMiddleSp.hpp b/Core/include/Acts/Seeding/CandidatesForMiddleSp.hpp
@@ -9,6 +9,7 @@
 #pragma once
 
 #include <algorithm>
+#include <limits>
 #include <memory>
 #include <tuple>
 #include <vector>

diff --git a/Core/include/Acts/Seeding/IExperimentCuts.hpp b/Core/include/Acts/Seeding/IExperimentCuts.hpp
@@ -11,6 +11,7 @@
 #include "Acts/Seeding/CandidatesForMiddleSp.hpp"
 #include "Acts/Seeding/InternalSeed.hpp"
 
+#include <limits>
 #include <memory>
 
 namespace Acts {

diff --git a/Core/include/Acts/Seeding/SeedConfirmationRangeConfig.hpp b/Core/include/Acts/Seeding/SeedConfirmationRangeConfig.hpp
@@ -10,6 +10,7 @@
 
 #include "Acts/Definitions/Units.hpp"
 
+#include <cstdint>
 #include <limits>
 
 namespace Acts {
@@ -29,10 +30,10 @@ struct SeedConfirmationRangeConfig {
 
   // number of compatible top SPs of seed if bottom radius is larger than
   // rMaxSeedConf
-  size_t nTopForLargeR = 0;
+  std::size_t nTopForLargeR = 0;
   // number of compatible top SPs of seed if bottom radius is smaller than
   // rMaxSeedConf
-  size_t nTopForSmallR = 0;
+  std::size_t nTopForSmallR = 0;
 
   // minimum radius for bottom SP in seed confirmation
   float seedConfMinBottomRadius = 60. * Acts::UnitConstants::mm;

diff --git a/Core/include/Acts/Seeding/SeedFilterConfig.hpp b/Core/include/Acts/Seeding/SeedFilterConfig.hpp
@@ -11,8 +11,9 @@
 #include "Acts/Definitions/Units.hpp"
 #include "Acts/Seeding/SeedConfirmationRangeConfig.hpp"
 
-// System include(s).
 #include <cstddef>
+#include <cstdint>
+#include <stdexcept>
 
 namespace Acts {
 struct SeedFilterConfig {

diff --git a/Core/include/Acts/Utilities/Enumerate.hpp b/Core/include/Acts/Utilities/Enumerate.hpp
@@ -8,6 +8,9 @@
 
 #pragma once
 
+#include <tuple>
+#include <utility>
+
 namespace Acts {
 /// Helper utility to allow indexed enumeration with structured binding
 ///
@@ -23,7 +26,7 @@ template <typename container_type,
           typename = decltype(std::end(std::declval<container_type>()))>
 constexpr auto enumerate(container_type &&iterable) {
   struct iterator {
-    size_t i;
+    std::size_t i;
     container_type_iter iter;
 
     bool operator!=(const iterator &rhs) const { return iter != rhs.iter; }

diff --git a/Core/include/Acts/Utilities/KDTree.hpp b/Core/include/Acts/Utilities/KDTree.hpp
@@ -13,6 +13,10 @@
 #include <algorithm>
 #include <array>
 #include <cmath>
+#include <functional>
+#include <memory>
+#include <string>
+#include <vector>
 
 namespace Acts {
 /// @brief A general k-d tree with fast range search.

diff --git a/Core/include/Acts/Utilities/RangeXD.hpp b/Core/include/Acts/Utilities/RangeXD.hpp
@@ -13,6 +13,8 @@
 #include <algorithm>
 #include <array>
 #include <limits>
+#include <sstream>
+#include <string>
 
 namespace Acts {
 /// @brief An orthogonal range in an arbitrary number of dimensions

diff --git a/Core/include/Acts/Vertexing/AdaptiveGridDensityVertexFinder.hpp b/Core/include/Acts/Vertexing/AdaptiveGridDensityVertexFinder.hpp
@@ -12,10 +12,11 @@
 #include "Acts/EventData/TrackParameters.hpp"
 #include "Acts/Utilities/Result.hpp"
 #include "Acts/Vertexing/AdaptiveGridTrackDensity.hpp"
+#include "Acts/Vertexing/DummyVertexFitter.hpp"
 #include "Acts/Vertexing/Vertex.hpp"
 #include "Acts/Vertexing/VertexingOptions.hpp"
 
-#include "DummyVertexFitter.hpp"
+#include <map>
 
 namespace Acts {
 

diff --git a/Core/include/Acts/Vertexing/GridDensityVertexFinder.hpp b/Core/include/Acts/Vertexing/GridDensityVertexFinder.hpp
@@ -11,11 +11,12 @@
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/EventData/TrackParameters.hpp"
 #include "Acts/Utilities/Result.hpp"
+#include "Acts/Vertexing/DummyVertexFitter.hpp"
 #include "Acts/Vertexing/GaussianGridTrackDensity.hpp"
 #include "Acts/Vertexing/Vertex.hpp"
 #include "Acts/Vertexing/VertexingOptions.hpp"
 
-#include "DummyVertexFitter.hpp"
+#include <map>
 
 namespace Acts {
 

diff --git a/Core/include/Acts/Vertexing/LinearizedTrack.hpp b/Core/include/Acts/Vertexing/LinearizedTrack.hpp
@@ -9,6 +9,8 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Definitions/TrackParametrization.hpp"
+
 namespace Acts {
 
 /// @class LinearizedTrack

diff --git a/Core/include/Acts/Vertexing/LinearizerConcept.hpp b/Core/include/Acts/Vertexing/LinearizerConcept.hpp
@@ -9,6 +9,8 @@
 #pragma once
 
 #include "Acts/Definitions/Algebra.hpp"
+#include "Acts/Definitions/TrackParametrization.hpp"
+#include "Acts/EventData/TrackParameters.hpp"
 #include "Acts/Geometry/GeometryContext.hpp"
 #include "Acts/MagneticField/MagneticFieldContext.hpp"
 #include "Acts/Utilities/Result.hpp"

diff --git a/Core/include/Acts/Visualization/ViewConfig.hpp b/Core/include/Acts/Visualization/ViewConfig.hpp
@@ -9,6 +9,7 @@
 #pragma once
 
 #include <array>
+#include <string>
 
 namespace Acts {
 
@@ -44,4 +45,4 @@ struct ViewConfig {
   std::string outputName = "";
 };
 
-}  // namespace Acts
+}  // namespace Acts