Added test cases for relational cohesion metric.

Author: Barnabás Domozi

plugins/cpp_metrics/test/sources/parser/modulemetrics.cpp

@@ -4,3 +4,12 @@
 #include "./module_b/b2.h"
 #include "./module_c/c1.h"
 #include "./module_c/c2.h"
+
+#include "./rc_module_a/a1.h"
+#include "./rc_module_a/a2.h"
+#include "./rc_module_a/a3.h"
+#include "./rc_module_b/b1.h"
+#include "./rc_module_c/c1.h"
+#include "./rc_module_c/c2.h"
+#include "./rc_module_c/c3.h"
+#include "./rc_module_c/c4.h"

plugins/cpp_metrics/test/sources/parser/rc_module_a/a1.h

@@ -0,0 +1,15 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_A1
+#define CC_CPP_RC_MODULE_METRICS_TEST_A1
+
+#include "./a2.h"
+#include "./a3.h"
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class A1 {
+  A2 a2;
+  A3 a3;
+};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_a/a2.h

@@ -0,0 +1,13 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_A2
+#define CC_CPP_RC_MODULE_METRICS_TEST_A2
+
+#include "./a3.h"
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class A2 {
+  A3 a3;
+};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_a/a3.h

@@ -0,0 +1,9 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_A3
+#define CC_CPP_RC_MODULE_METRICS_TEST_A3
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class A3 {};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_b/b1.h

@@ -0,0 +1,9 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_B1
+#define CC_CPP_RC_MODULE_METRICS_TEST_B1
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class B1 {};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_c/c1.h

@@ -0,0 +1,17 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_C1
+#define CC_CPP_RC_MODULE_METRICS_TEST_C1
+
+#include "../rc_module_a/a1.h"
+#include "../rc_module_a/a2.h"
+#include "../rc_module_a/a3.h"
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class C1 {
+  A1 a1;
+  A2 a2;
+  A3 a3;
+};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_c/c2.h

@@ -0,0 +1,13 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_C2
+#define CC_CPP_RC_MODULE_METRICS_TEST_C2
+
+#include "./c1.h"
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class C2 {
+  C1 c1;
+};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_c/c3.h

@@ -0,0 +1,9 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_C3
+#define CC_CPP_RC_MODULE_METRICS_TEST_C3
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class C3 {};
+}
+
+#endif

plugins/cpp_metrics/test/sources/parser/rc_module_c/c4.h

@@ -0,0 +1,9 @@
+#ifndef CC_CPP_RC_MODULE_METRICS_TEST_C4
+#define CC_CPP_RC_MODULE_METRICS_TEST_C4
+
+namespace CC_CPP_RC_MODULE_METRICS_TEST
+{
+class C4 {};
+}
+
+#endif

plugins/cpp_metrics/test/src/cppmetricsparsertest.cpp

@@ -24,6 +24,7 @@ using namespace cc;
 extern char* dbConnectionString;
 
 typedef std::pair<std::string, unsigned int> StringUintParam;
+typedef std::pair<std::string, double> StringDoubleParam;
 
 class CppMetricsParserTest : public ::testing::Test
 {
@@ -353,3 +354,41 @@ INSTANTIATE_TEST_SUITE_P(
   ParameterizedEfferentModuleCouplingTest,
   ::testing::ValuesIn(paramEfferentModule)
 );
+
+// Relational cohesion at module level
+
+class ParameterizedRelationalCohesionTest
+  : public CppMetricsParserTest,
+    public ::testing::WithParamInterface<StringDoubleParam>
+{};
+
+// Relational cohesion formula:
+// H = (R + 1)/ N
+// where R is the number of type relationships that are internal to a module,
+// N is the number of types within a module.
+
+std::vector<StringDoubleParam> paramRelationalCohesion = {
+  {"%/test/sources/parser/rc_module_a", (3 + 1) / 3.0},
+  {"%/test/sources/parser/rc_module_b", (0 + 1) / 1.0},
+  {"%/test/sources/parser/rc_module_c", (1 + 1) / 4.0},
+};
+
+TEST_P(ParameterizedRelationalCohesionTest, RelationalCohesionTest) {
+  _transaction([&, this]() {
+
+    typedef odb::query<model::CppModuleMetricsForPathView> CppModuleMetricsQuery;
+
+    const auto metric = _db->query_value<model::CppModuleMetricsForPathView>(
+      CppModuleMetricsQuery::CppFileMetrics::type == model::CppFileMetrics::Type::RELATIONAL_COHESION_MODULE &&
+      CppModuleMetricsQuery::File::path.like(GetParam().first));
+
+    constexpr double tolerance = 1e-8;
+    EXPECT_NEAR(GetParam().second, metric.value, tolerance);
+  });
+}
+
+INSTANTIATE_TEST_SUITE_P(
+  ParameterizedRelationalCohesionTestSuite,
+  ParameterizedRelationalCohesionTest,
+  ::testing::ValuesIn(paramRelationalCohesion)
+);