Unit testing; Use Regex in MemberNamesCheck

Author: sawenzel

CMakeLists.txt

@@ -1,4 +1,12 @@
 cmake_minimum_required(VERSION 3.4.3)
+enable_testing()
+
+if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
+  # require at least gcc 4.9 !!
+  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.9)
+    message(FATAL_ERROR "GCC version must be at least 4.9!")
+  endif()
+endif()
 
 
 if( CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR )
@@ -39,4 +47,7 @@ add_subdirectory(aliceO2)
 add_subdirectory(reporting)
 
 
+# for testing
+add_subdirectory(test)
+
 endif()

aliceO2/MemberNamesCheck.cpp

@@ -11,6 +11,7 @@
 #include "clang/AST/ASTContext.h"
 #include "clang/ASTMatchers/ASTMatchFinder.h"
 #include <iostream>
+#include <regex>
 
 using namespace clang::ast_matchers;
 
@@ -24,17 +25,20 @@ void MemberNamesCheck::registerMatchers(MatchFinder *Finder) {
 
 void MemberNamesCheck::check(const MatchFinder::MatchResult &Result) {
   const auto *MatchedDecl = Result.Nodes.getNodeAs<FieldDecl>("field_decl1");
-  if(MatchedDecl) {
+  if (MatchedDecl) {
     // check that we are inside the AliceO2 namespace to exlude system stuff
-    if ( MatchedDecl->getQualifiedNameAsString().find("AliceO2::") != 0 )
-     return;
+    // FIXME: needs to be configurable
+    if (MatchedDecl->getQualifiedNameAsString().find("AliceO2::") != 0)
+      return;
 
-    if (MatchedDecl->getName().startswith("m")){
-     return;
+    if (std::regex_match(MatchedDecl->getNameAsString(), Regex)) {
+      return;
     }
-    diag(MatchedDecl->getLocation(), "field declaration %0 does not match naming rule", DiagnosticIDs::Error)
-    << MatchedDecl;
-    //  << FixItHint::CreateInsertion(MatchedDecl->getLocation(), "f");
+
+    diag(MatchedDecl->getLocation(),
+         "field declaration %0 does not match naming rule",
+         DiagnosticIDs::Error)
+        << MatchedDecl;
   }
 }
 

aliceO2/MemberNamesCheck.h

@@ -11,21 +11,29 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALICEO2_MEMBER_NAMES_H
 
 #include "../ClangTidy.h"
+#include <regex>
 
 namespace clang {
 namespace tidy {
 namespace aliceO2 {
 
-/// FIXME: Write a short description.
+/// Checking the class member naming convention
 ///
-/// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/aliceO2-member-names.html
 class MemberNamesCheck : public ClangTidyCheck {
+private:
+  const std::string Pattern; // the regular expression string
+  const std::regex Regex; // the regular expression class
 public:
   MemberNamesCheck(StringRef Name, ClangTidyContext *Context)
-      : ClangTidyCheck(Name, Context) {}
+      : ClangTidyCheck(Name, Context), Pattern(Options.get("Pattern","m[A-Z].*")), Regex(Pattern)
+  {}
+
   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+
+  void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
+    Options.store(Opts, "Pattern", Pattern);
+  }
 };
 
 } // namespace aliceO2

test/CMakeLists.txt

@@ -0,0 +1,6 @@
+# testing if regex works correctly (has problem with gcc < 4.9)
+add_executable(testregex testregex.cpp)
+add_test(testregexcorrect testregex)
+
+
+# correctness testing of checks

test/test1.cpp

@@ -12,7 +12,12 @@ namespace AliceO2 {
 
   class B {
   public:
-    void foo();
+    virtual void foo();
+  };
+
+  class D : public B {
+  public:
+    virtual void foo();
   };
 
   void consumer(A &a, B &b, C &c){

test/testregex.cpp

@@ -0,0 +1,14 @@
+#include <regex>
+#ifdef NDEBUG
+#undef NDEBUG
+#endif
+#include <cassert>
+
+// testing correct compiler support for regular expressions
+// (For example: although the code compiles fine with gcc4.8; it does not
+// execute)
+int main() {
+  assert(std::regex_match("mGood", std::regex("m[A-Z][a-z]+")));
+  assert(std::regex_match("mGood", std::regex("m[A-Z].*")));
+  return 0;
+}