feat: CI - Add code rules checking action

.github/workflows/ci_tests.yml

@@ -137,6 +137,22 @@ jobs:
       RUNS_ON: ubuntu-22.04
       USE_SCCACHE: false
 
+  check_code_rules:
+    needs: [is_not_draft_pull_request]
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Checkout Repository
+      uses: actions/[email protected]
+      with:
+        submodules: false
+        lfs: false
+        fetch-depth: 0
+        sparse-checkout: |
+          scripts 
+          src
+    - name: Check the code rules
+      run: "scripts/check_code_rules.sh"
+
   # Matrix containing all the CPU build.
   # Those are quite fast and can efficiently benefit from the `sccache' tool to make them even faster.
   cpu_builds:

scripts/check_code_rules.sh

@@ -0,0 +1,151 @@
+#!/bin/bash
+
+
+################################
+## I. Function initializations
+################################
+
+# while
+# ... done < <(grep -n "std::map\s*<" "$file") 
+# Process the result of grep command as a file.
+# This allows everything to be handled in the same shell environment.
+check_container_usage() {
+  local container_name="$1"
+  local str="  Found forbidden ${container_name} usage in: $file"$'\n'
+
+  if grep -q "${container_name}\s*<" "$file"; then
+    while IFS= read -r line; do
+      str+="    $line"$'\n'
+    done < <(grep -n "${container_name}\s*<" "$file")
+
+    ERRORS_CONTAINER[$container_name]+="$str"
+    ((FORBIDDEN_CONTAINER_MAP["$container_name"]++))
+  fi
+}
+
+print_violation()
+{
+    local container_name="$1"
+
+    if [ "${FORBIDDEN_CONTAINER_MAP[$container_name]}" -eq 1 ];then
+      echo $'\n'
+      echo "ERROR: Forbidden $container_name usage detected"
+      echo "=========================================="
+
+      printf '%s' "${ERRORS_CONTAINER[$container_name]}"
+
+    fi
+}
+
+################################
+## II. GLOBAL INITIALIZATION  
+################################
+
+FORBIDDEN_EXPRESSIONS=(
+          "std::map"     
+          "std::unordered_map"
+          "std::vector"
+)
+
+declare -A FORBIDDEN_CONTAINER_MAP=()
+for exp in "${FORBIDDEN_EXPRESSIONS[@]}"; do
+    FORBIDDEN_CONTAINER_MAP["$exp"]=0
+done
+
+declare -A ERRORS_CONTAINER=()
+for exp in "${FORBIDDEN_EXPRESSIONS[@]}"; do
+    ERRORS_CONTAINER["$exp"]=""
+done
+
+FILE_PREFIX="src/coreComponents/"
+FILE_PATTERNS=(
+          "codingUtilities"
+          "common"
+          "dataRepository"
+          "constitutive"
+          "denseLinearAlgebra"
+          "discretizationMethods"
+          "events"
+          "fieldSpecification"
+          "fileIO"
+          "finiteElement"
+          "finiteVolume"
+          "functions"
+          "linearAlgebra"
+          "mainInterface"
+          "mesh"
+          "physicsSolvers"
+)
+
+EXCLUDE_PATTERNS=(
+          "Datatype.hpp"     
+          "StdContainerWrappers.hpp"     
+          "BufferOps_inline.hpp"
+          "BufferOps.hpp"
+          "PVTPackage"
+          "hdf5_interface"
+)
+
+FILE_PATH_ARGS=()
+for pattern in "${FILE_PATTERNS[@]}"; do
+    if [ -d "${FILE_PREFIX}${pattern}" ]; then
+      FILE_PATH_ARGS+=("${FILE_PREFIX}${pattern}")
+    fi
+done
+
+EXCLUDE_EXPRESSION=()
+for pattern in "${EXCLUDE_PATTERNS[@]}"; do
+    if [[ ! "$pattern" == *".hpp"* ]]; then
+      EXCLUDE_EXPRESSION+=( -path "*/$pattern" -prune -o )
+    else
+      EXCLUDE_EXPRESSION+=( -name "*${pattern}" -prune -o )
+    fi
+done
+
+echo "======================================================"
+echo -e "            TREE LIST OF FILES FOUND            "
+echo "======================================================"
+
+if [ ${#FILE_PATH_ARGS[@]} -gt 0 ]; then
+    find "${FILE_PATH_ARGS[@]}" "${EXCLUDE_EXPRESSION[@]}" -type d -print  | sort | while IFS= read -r dir; do
+        echo -e "->" $(echo "$dir" | sed 's/[]^$*.[]/\\&/g' | sed 's/\// |---/g')
+    done
+fi
+
+ARRAY_FILES=()
+# mapfile used for reading inMAPput lines into an array; -d $'\0': Specifies that the delimiter is (\0).
+# -print0 : ask find to separate file paths by '\0'
+mapfile -d $'\0' ARRAY_FILES < <(find "${FILE_PATH_ARGS[@]}" "${EXCLUDE_EXPRESSION[@]}" \
+                                      -type f \( -name "*.hpp" -o -name "*.cpp" -o  -name "*.hpp.template" -o -name "*.cpp.template" \) \
+                                      -print0 2>/dev/null)
+
+################################
+## III. MAIN LOOP
+################################
+
+for file in "${ARRAY_FILES[@]}"; do
+  for container_name in "${!FORBIDDEN_CONTAINER_MAP[@]}"; do
+    check_container_usage "$container_name"
+  done
+done
+
+# Print section
+for key in "${!FORBIDDEN_CONTAINER_MAP[@]}"; do
+    if [[ "${FORBIDDEN_CONTAINER_MAP[$key]}" == "1" ]]; then
+      echo $'\n'
+      echo "----------------------------------------"
+      echo "SUMMARY: Code rule violations found"
+      echo "----------------------------------------"
+
+      for container_name in "${!FORBIDDEN_CONTAINER_MAP[@]}"; do
+        print_violation "$container_name"
+      done
+
+      echo ""
+      exit 1;
+    fi
+done
+
+echo $'\n'
+echo "No code rule violations found"
+exit 0

src/coreComponents/codingUtilities/RTTypes.cpp

@@ -39,7 +39,7 @@ void printTypeSummary()
 
 string rtTypes::getTypeName( std::type_index const key )
 {
-  static const std::unordered_map< std::type_index, string > type_names =
+  static const stdUnorderedMap< std::type_index, string > type_names =
   {
     {std::type_index( typeid(integer)), "integer"},
     {std::type_index( typeid(real32)), "real32"},

src/coreComponents/codingUtilities/tests/testGeosxTraits.cpp

@@ -53,7 +53,7 @@ TEST( testGeosxTraits, HasMemberFunction_at )
   static_assert( HasMemberFunction_at< stdVector< int > >, "Should be true." );
   static_assert( HasMemberFunction_at< stdVector< double > >, "Should be true." );
   static_assert( HasMemberFunction_at< stdMap< int, string > >, "Should be true." );
-  static_assert( HasMemberFunction_at< std::unordered_map< int, string > >, "Should be true." );
+  static_assert( HasMemberFunction_at< stdUnorderedMap< int, string > >, "Should be true." );
 
   static_assert( !HasMemberFunction_at< int >, "Should be false." );
   static_assert( !HasMemberFunction_at< stdMap< string, string > >, "Should be false." );

src/coreComponents/common/MemoryInfos.cpp

@@ -139,7 +139,7 @@ void MemoryLogging::memoryStatsReport() const
   MPI_Comm_size( MPI_COMM_WORLD, &size );
   size_t nbRank = (std::size_t)size;
   // Get a list of all the allocators and sort it so that it's in the same order on each rank.
-  std::vector< string > allocatorNames = rm.getAllocatorNames();
+  stdVector< string > allocatorNames = rm.getAllocatorNames();
   std::sort( allocatorNames.begin(), allocatorNames.end() );
 
   // If each rank doesn't have the same number of allocators you can't aggregate them.

src/coreComponents/common/TypeDispatch.hpp

@@ -269,7 +269,7 @@ template< typename LIST, std::size_t ... Is >
 auto const & getTypeMap( LIST, std::integer_sequence< std::size_t, Is... > )
 {
   using KeyType = decltype( createTypeIndexTuple( camp::first< LIST > {} ) );
-  static std::unordered_map< KeyType, std::size_t, tuple_hash > const result = { { createTypeIndexTuple( camp::at_t< LIST, camp::num< Is > >{} ), Is } ... };
+  static stdUnorderedMap< KeyType, std::size_t, tuple_hash > const result = { { createTypeIndexTuple( camp::at_t< LIST, camp::num< Is > >{} ), Is } ... };
   return result;
 }
 

src/coreComponents/common/format/table/TableFormatter.cpp

@@ -200,7 +200,7 @@ string TableCSVFormatter::toString< TableData >( TableData const & tableData ) c
 {
   if( tableData.getErrorsList().hasErrors() )
   {
-    std::vector< string > cpyErrors  = tableData.getErrorsList().getErrors();
+    stdVector< string > cpyErrors  = tableData.getErrorsList().getErrors();
     getErrorsList().appendErrors( cpyErrors );
   }
 
@@ -518,8 +518,8 @@ void TableTextFormatter::populateErrorCellsLayout( PreparedTableLayout const & t
     {
       errorCellsLayout.push_back(
         {
-          std::vector< TableLayout::CellLayout >( nbCells,
-                                                  TableLayout::CellLayout( CellType::MergeNext ) ),
+          stdVector< TableLayout::CellLayout >( nbCells,
+                                                TableLayout::CellLayout( CellType::MergeNext ) ),
           1 // subLines count
         } );
       errorCellsLayout.back().cells.back().m_cellType = CellType::Value;
@@ -531,8 +531,8 @@ void TableTextFormatter::populateErrorCellsLayout( PreparedTableLayout const & t
 
   errorCellsLayout.push_back(
     {
-      std::vector< TableLayout::CellLayout >( nbCells,
-                                              TableLayout::CellLayout( CellType::Separator ) ),
+      stdVector< TableLayout::CellLayout >( nbCells,
+                                            TableLayout::CellLayout( CellType::Separator ) ),
       1 // subLines count
     } );
 

src/coreComponents/common/format/table/TableLayout.hpp

@@ -127,7 +127,7 @@ class TableLayout
     /**
      * @return The view on each cell line.
      */
-    std::vector< string_view > & getLines()
+    stdVector< string_view > & getLines()
     { return m_lines; }
 
     /**

src/coreComponents/common/format/table/TableTypes.hpp

@@ -62,7 +62,7 @@ class TableErrorListing
   void clear();
 
   /// The iterator alias for the  errors vector of string
-  using Iterator = std::vector< string >::const_iterator;
+  using Iterator = stdVector< string >::const_iterator;
 
   /**
    * @return An Iterator pointing to the first element of the errors vector
@@ -80,24 +80,24 @@ class TableErrorListing
    * @brief Append a vector of string to the errors vector.
    * @param errors A vector of string to append
    */
-  void appendErrors( std::vector< string > & errors )
+  void appendErrors( stdVector< string > & errors )
   { m_errorList.insert( m_errorList.end(), errors.begin(), errors.end() );}
 
   /**
    * @return A const reference to the errors vector.
    */
-  std::vector< string > const & getErrors() const
+  stdVector< string > const & getErrors() const
   { return m_errorList; }
 
   /**
    * @return A reference to the errors vector.
    */
-  std::vector< string > & getErrors()
+  stdVector< string > & getErrors()
   { return m_errorList; }
 
 private:
   /// Contain all the errors  to display at the end of the table
-  std::vector< string > m_errorList;
+  stdVector< string > m_errorList;
 };
 
 inline void TableErrorListing::addError( string_view text )

src/coreComponents/common/logger/ErrorHandling.hpp

@@ -116,9 +116,9 @@ class ErrorLogger
     /// the source location line corresponding to the error in the code (default is 0)
     integer m_line = 0;
     /// Additional information about the error in the input file
-    std::vector< ErrorContext > m_contextsInfo;
+    stdVector< ErrorContext > m_contextsInfo;
     /// the stack trace
-    std::vector< std::string > m_sourceCallStack;
+    stdVector< std::string > m_sourceCallStack;
 
     /**
      * @brief Construct a default Error Message

src/coreComponents/common/unitTests/testDataTypes.cpp

@@ -61,7 +61,7 @@ TEST( testDataTypes, testBoundChecking )
   // std::cout <<" sdsfs "<<  mapBoundsChecking.get_inserted(0)<< std::endl;
   // std::cout << mapBoundsChecking.get_inserted(1);
 
-  internal::StdMapWrapper< std::unordered_map< integer, integer >, true > unorderedMapBoundsChecking{{0, 1}};
+  internal::StdMapWrapper< stdUnorderedMap< integer, integer >, true > unorderedMapBoundsChecking{{0, 1}};
   EXPECT_THROW( {
     try
     {

src/coreComponents/constitutive/ConstitutiveBase.hpp

@@ -170,7 +170,7 @@ class ConstitutiveBase : public dataRepository::Group
   /**
    * @return A const vector containing all fields
    */
-  std::vector< std::string > const & getUserFields() const
+  stdVector< std::string > const & getUserFields() const
   {
     return m_userFields;
   }
@@ -189,7 +189,7 @@ class ConstitutiveBase : public dataRepository::Group
   bool m_isClone;
 
   // Vector containing all fields registered with `registerField()`
-  std::vector< std::string > m_userFields;
+  stdVector< std::string > m_userFields;
 };
 
 }

src/coreComponents/constitutive/fluid/multifluid/compositional/parameters/KValueFlashParameters.cpp

@@ -399,7 +399,7 @@ bool KValueFlashParameters< NUM_PHASE >::validateKValues( MultiFluidBase const *
 
   if( !tableData.getTableDataRows().empty())
   {
-    std::vector< TableLayout::Column > columns;
+    stdVector< TableLayout::Column > columns;
     columns.emplace_back( TableLayout::Column().setName( "Phase" ).setValuesAlignment( TableLayout::Alignment::left ) );
     columns.emplace_back( TableLayout::Column().setName( "Pressure" ).setValuesAlignment( TableLayout::Alignment::right ) );
     columns.emplace_back( TableLayout::Column().setName( "Temperature" ).setValuesAlignment( TableLayout::Alignment::right ) );

src/coreComponents/constitutive/fluid/multifluid/compositional/parameters/PhaseType.cpp

@@ -29,7 +29,7 @@ namespace constitutive
 namespace compositional
 {
 
-static std::unordered_map< PhaseType, std::string > const phase_aliases{
+static stdUnorderedMap< PhaseType, std::string > const phase_aliases{
   {PhaseType::LIQUID, "liquid,liq,oil"},
   {PhaseType::VAPOUR, "gas,vap,vapor,vapour"},
   {PhaseType::AQUEOUS, "wat,water,aqueous"}

src/coreComponents/constitutive/unitTests/TestFluid.hpp

@@ -78,7 +78,7 @@ struct Fluid
       7.45513e-02,  1.80000e+07,  3.47000e+03,  6.25000e-04, -1.21200e-01,  3.05992e-05, // KCL    (potassium chloride)
   };
 
-  static std::unordered_map<integer,string> const componentNames;
+  static stdUnorderedMap<integer,string> const componentNames;
   /* UNCRUSTIFY-ON */
 };
 
@@ -199,7 +199,7 @@ class TestFluid
 };
 
 /* UNCRUSTIFY-OFF */
-std::unordered_map<integer,string> const Fluid::componentNames = {
+stdUnorderedMap<integer,string> const Fluid::componentNames = {
   { H2O,    "H2O"    }, // water
   { CO2,    "CO2"    }, // carbon dioxide
   { N2,     "N2"     }, // nitrogen

src/coreComponents/constitutive/unitTests/testSoreideWhitsonFlash.cpp

@@ -64,7 +64,7 @@ TEST_P( SoreideWhitsonSolubilityTestFixture, testSolubility )
   /* UNCRUSTIFY-OFF */
   // Soreide-Whitson correlations work only with "true" values of component parameters
   // kij_NA is the binary interation coefficient in the gas phase (see Table 5 Soreide-Whitson (1992))
-  std::unordered_map<integer, std::array<real64 const, 6> const> const componentDatabase = {
+  stdUnorderedMap<integer, std::array<real64 const, 6> const> const componentDatabase = {
     //             Mw            Pc            Tc            Vc            Ac           kij_NA
     {Fluid::H2O, { 1.80153e-02,  2.20640e+07,  6.47096e+02,  5.59480e-05,  3.44300e-01, 0.0000 }},
     {Fluid::CO2, { 4.40095e-02,  7.37730e+06,  3.04128e+02,  9.41185e-05,  2.23940e-01, 0.1896 }},