Merge pull request #175 from MyDogTom/mydogtom/change-metrics-dsl

Change metrics DSL
cdsap · May 5, 2020 · b443b7f · b443b7f
2 parents 451ce02 + 00124a6
commit b443b7f
Show file tree

Hide file tree

Showing 5 changed files with 276 additions and 104 deletions.
diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts
@@ -38,9 +38,11 @@ talaiot {
     }
 
     metrics {
-        // Talaiot provides a few methods to add a group of metrics at once:
-        defaultMetrics()
-        gitMetrics()
+        // Talaiot provides a few methods to disable a group of metrics at once
+        // By default all groups are enabled
+        performanceMetrics = false
+        gradleSwitchesMetrics = false
+        environmentMetrics = false
 
         // You can also add your own custom Metric objects:
         customMetrics(

diff --git a/talaiot/src/main/kotlin/com/cdsap/talaiot/configuration/MetricsConfiguration.kt b/talaiot/src/main/kotlin/com/cdsap/talaiot/configuration/MetricsConfiguration.kt
@@ -1,25 +1,56 @@
 package com.cdsap.talaiot.configuration
 
 import com.cdsap.talaiot.entities.ExecutionReport
-import com.cdsap.talaiot.metrics.*
+import com.cdsap.talaiot.metrics.BuildIdMetric
 import com.cdsap.talaiot.metrics.CacheHitMetric
+import com.cdsap.talaiot.metrics.DefaultCharsetMetric
+import com.cdsap.talaiot.metrics.GitBranchMetric
+import com.cdsap.talaiot.metrics.GitUserMetric
+import com.cdsap.talaiot.metrics.GradleBuildCacheModeMetric
+import com.cdsap.talaiot.metrics.GradleBuildCachePushEnabled
+import com.cdsap.talaiot.metrics.GradleMaxWorkersMetric
+import com.cdsap.talaiot.metrics.GradleRequestedTasksMetric
+import com.cdsap.talaiot.metrics.GradleScanLinkMetric
+import com.cdsap.talaiot.metrics.GradleSwitchBuildScanMetric
+import com.cdsap.talaiot.metrics.GradleSwitchCachingMetric
+import com.cdsap.talaiot.metrics.GradleSwitchConfigureOnDemandMetric
+import com.cdsap.talaiot.metrics.GradleSwitchDaemonMetric
+import com.cdsap.talaiot.metrics.GradleSwitchDryRunMetric
+import com.cdsap.talaiot.metrics.GradleSwitchParallelMetric
+import com.cdsap.talaiot.metrics.GradleSwitchRefreshDependenciesMetric
+import com.cdsap.talaiot.metrics.GradleSwitchRerunTasksMetric
+import com.cdsap.talaiot.metrics.GradleVersionMetric
+import com.cdsap.talaiot.metrics.HostnameMetric
+import com.cdsap.talaiot.metrics.JavaVmNameMetric
+import com.cdsap.talaiot.metrics.JvmMaxPermSizeMetric
+import com.cdsap.talaiot.metrics.JvmXmsMetric
+import com.cdsap.talaiot.metrics.JvmXmxMetric
+import com.cdsap.talaiot.metrics.LocaleMetric
+import com.cdsap.talaiot.metrics.OsManufacturerMetric
+import com.cdsap.talaiot.metrics.OsMetric
+import com.cdsap.talaiot.metrics.ProcessorCountMetric
+import com.cdsap.talaiot.metrics.PublicIpMetric
+import com.cdsap.talaiot.metrics.RamAvailableMetric
+import com.cdsap.talaiot.metrics.RootProjectNameMetric
+import com.cdsap.talaiot.metrics.SimpleMetric
+import com.cdsap.talaiot.metrics.UserMetric
 import com.cdsap.talaiot.metrics.base.Metric
 
 /**
  * Configuration for the Metrics extensions
  *
  * ```
- * metrics{
- *   defaultMetrics()
- *   gitMetrics()
- *   performanceMetrics()
- *   gradleSwitchesMetrics()
+ * metrics {
+ *   defaultMetrics = true
+ *   gitMetrics = true
+ *   performanceMetrics = true
+ *   gradleSwitchesMetrics = true
  * }
  * ```
  *
- * By default Talaiot executes
- *  [defaultMetrics], [performanceMetrics], [gradleSwitchesMetrics], [gitMetrics] and [environmentMetrics] metrics,
- *  unless user manually specified which metrics should be executed.
+ * By default Talaiot enables
+ *  [defaultMetrics], [performanceMetrics], [gradleSwitchesMetrics], [gitMetrics] and [environmentMetrics] metrics.
+ *  User can disable each of them.
  *
  * [defaultMetrics] includes:
  *  [RootProjectNameMetric]
@@ -87,10 +118,16 @@ class MetricsConfiguration {
      * In some cases could generate high cardinality problems like in basic InfluxDb setups, disabled by default
      */
     var generateBuildId = false
+    var defaultMetrics = true
+    var gitMetrics = true
+    var performanceMetrics = true
+    var gradleSwitchesMetrics = true
+    var environmentMetrics = true
+
 
     private var metrics: MutableSet<Metric<*, *>> = mutableSetOf()
 
-    fun defaultMetrics() {
+    private fun addDefaultMetrics() {
         with(metrics){
             add(RootProjectNameMetric())
             add(GradleRequestedTasksMetric())
@@ -101,14 +138,14 @@ class MetricsConfiguration {
         }
     }
 
-    fun gitMetrics() {
+    private fun addGitMetrics() {
         with(metrics) {
             add(GitUserMetric())
             add(GitBranchMetric())
         }
     }
 
-    fun environmentMetrics() {
+    private fun addEnvironmentMetrics() {
         with(metrics) {
             add(OsManufacturerMetric())
             add(HostnameMetric())
@@ -118,7 +155,7 @@ class MetricsConfiguration {
         }
     }
 
-    fun performanceMetrics() {
+    private fun addPerformanceMetrics() {
         with(metrics) {
             add(UserMetric())
             add(OsMetric())
@@ -134,7 +171,7 @@ class MetricsConfiguration {
         }
     }
 
-    fun gradleSwitchesMetrics() {
+    private fun addGradleSwitchesMetrics() {
         with(metrics) {
             add(GradleSwitchCachingMetric())
             add(GradleSwitchBuildScanMetric())
@@ -228,15 +265,21 @@ class MetricsConfiguration {
     }
 
     internal fun build(): List<Metric<*, *>> {
-        // If there was any customization then we assume that user populated everything manually, otherwise defaults
-        if (metrics.isEmpty()) {
-            defaultMetrics()
-            performanceMetrics()
-            gradleSwitchesMetrics()
-            gitMetrics()
-            environmentMetrics()
+        if (defaultMetrics) {
+            addDefaultMetrics()
+        }
+        if (gitMetrics) {
+            addGitMetrics()
+        }
+        if (performanceMetrics) {
+            addPerformanceMetrics()
+        }
+        if (gradleSwitchesMetrics) {
+            addGradleSwitchesMetrics()
+        }
+        if (environmentMetrics) {
+            addEnvironmentMetrics()
         }
-
         if (generateBuildId) {
             metrics.add(BuildIdMetric())
         }

diff --git a/talaiot/src/test/kotlin/com/cdsap/talaiot/assertions/CollectionAssertions.kt b/talaiot/src/test/kotlin/com/cdsap/talaiot/assertions/CollectionAssertions.kt
@@ -0,0 +1,19 @@
+package com.cdsap.talaiot.assertions
+
+import io.kotlintest.Matcher
+import io.kotlintest.Result
+import io.kotlintest.shouldBe
+import kotlin.reflect.KClass
+
+private fun <T : Any> containExactlyTypesOfInAnyOrder(ts: Collection<KClass<*>>): Matcher<Collection<T>> =
+    object : Matcher<Collection<T>> {
+        override fun test(value: Collection<T>) = Result(
+            ts.size == value.size && value.all { ts.contains(it::class) },
+            "Collection ${value.joinToString(", ")} should contain all of ${ts.joinToString(", ")}",
+            "Collection ${value.joinToString(", ")} should not contain all of ${ts.joinToString(", ")}"
+        )
+    }
+
+fun <T : Any> Collection<T>.shouldContainExactlyTypesOfInAnyOrder(ts: Collection<KClass<*>>) {
+    this shouldBe containExactlyTypesOfInAnyOrder<T>(ts)
+}
diff --git a/talaiot/src/test/kotlin/com/cdsap/talaiot/metrics/CustomMetricsTest.kt b/talaiot/src/test/kotlin/com/cdsap/talaiot/metrics/CustomMetricsTest.kt