Implement TestFixture for metrics

GitOrigin-RevId: c51ec0fb5dcc67f9e1b6b2564678fd86d3f3c416

misk-metrics/build.gradle.kts

@@ -17,6 +17,7 @@ dependencies {
   implementation(libs.kotlinStdLibJdk8)
 
   testFixturesApi(project(":misk-inject"))
+  testFixturesApi(project(":misk-testing-api"))
   testFixturesApi(libs.prometheusClient)
   testFixturesImplementation(libs.guava)
   testFixturesImplementation(libs.guice)

misk-metrics/src/testFixtures/kotlin/misk/metrics/v2/CollectorRegistryModule.kt

@@ -0,0 +1,69 @@
+package misk.metrics.v2
+
+import io.prometheus.client.Collector
+import io.prometheus.client.CollectorRegistry
+import io.prometheus.client.Predicate
+import io.prometheus.client.SimpleCollector
+import misk.inject.KAbstractModule
+import misk.testing.TestFixture
+import java.util.Enumeration
+
+internal class CollectorRegistryModule : KAbstractModule() {
+
+  override fun configure() {
+    val registry = CollectorRegistryFixture(CollectorRegistry(true))
+    bind<CollectorRegistry>().toInstance(registry)
+    multibind<TestFixture>().toInstance(registry)
+  }
+}
+
+internal class CollectorRegistryFixture(val registry: CollectorRegistry) : CollectorRegistry(true), TestFixture {
+
+  private val registeredCollectors = mutableSetOf<Collector>()
+
+  override fun reset() {
+    registeredCollectors.forEach {
+      if (it is SimpleCollector<*>) {
+        it.clear()
+      }
+    }
+  }
+
+  override fun register(collector: Collector) {
+    registeredCollectors.add(collector)
+    registry.register(collector)
+  }
+
+  override fun unregister(collector: Collector) {
+    registeredCollectors.remove(collector)
+    registry.unregister(collector)
+  }
+
+  override fun metricFamilySamples(): Enumeration<Collector.MetricFamilySamples> {
+    return registry.metricFamilySamples()
+  }
+
+  override fun filteredMetricFamilySamples(includedNames: Set<String?>?): Enumeration<Collector.MetricFamilySamples> {
+    return registry.filteredMetricFamilySamples(includedNames)
+  }
+
+  override fun filteredMetricFamilySamples(sampleNameFilter: Predicate<String?>?): Enumeration<Collector.MetricFamilySamples> {
+    return registry.filteredMetricFamilySamples(sampleNameFilter)
+  }
+
+  override fun getSampleValue(name: String): Double? {
+    return registry.getSampleValue(name)
+  }
+
+  override fun getSampleValue(
+    name: String,
+    labelNames: Array<String?>?,
+    labelValues: Array<String?>?
+  ): Double? {
+    return registry.getSampleValue(name, labelNames, labelValues)
+  }
+
+  override fun clear() {
+    registry.clear()
+  }
+}

misk-metrics/src/testFixtures/kotlin/misk/metrics/v2/FakeMetricsModule.kt

@@ -5,7 +5,7 @@ import misk.inject.KAbstractModule
 
 class FakeMetricsModule : KAbstractModule() {
   override fun configure() {
-    bind<CollectorRegistry>().toInstance(CollectorRegistry(true))
+    install(CollectorRegistryModule())
     bind<Metrics>().to<FakeMetrics>()
   }
 }

misk-testing/api/misk-testing.api

@@ -1,5 +1,7 @@
 public final class misk/MiskTestingServiceModule : misk/inject/KAbstractModule {
 	public fun <init> ()V
+	public fun <init> (Z)V
+	public synthetic fun <init> (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 }
 
 public final class misk/cloud/fake/security/keys/FakeKeyManagementModule : misk/inject/KAbstractModule {

misk-testing/build.gradle.kts

@@ -40,6 +40,7 @@ dependencies {
   implementation(project(":misk-config"))
   implementation(project(":misk-service"))
   implementation(project(":misk-testing-api"))
+  implementation(testFixtures(project(":misk-metrics")))
 
   testImplementation(libs.kotlinTest)
 }

misk-testing/src/main/kotlin/misk/MiskTestingServiceModule.kt

@@ -3,6 +3,7 @@ package misk
 import misk.concurrent.FakeSleeperModule
 import misk.environment.FakeEnvVarModule
 import misk.inject.KAbstractModule
+import misk.metrics.FakeMetricsModule
 import misk.random.FakeRandomModule
 import misk.resources.TestingResourceLoaderModule
 import misk.time.FakeClockModule
@@ -16,7 +17,9 @@ import misk.tokens.FakeTokenGeneratorModule
  * set of fake bindings to replace real bindings that cannot exist in a unit testing environment
  * (e.g system env vars and filesystem dependencies).
  */
-class MiskTestingServiceModule : KAbstractModule() {
+class MiskTestingServiceModule @JvmOverloads constructor(
+  private val installFakeMetrics: Boolean = false
+): KAbstractModule() {
   override fun configure() {
     install(TestingResourceLoaderModule())
     install(FakeEnvVarModule())
@@ -25,6 +28,9 @@ class MiskTestingServiceModule : KAbstractModule() {
     install(FakeTickerModule())
     install(FakeRandomModule())
     install(FakeTokenGeneratorModule())
-    install(MiskCommonServiceModule())
+    if (installFakeMetrics) {
+      install(FakeMetricsModule())
+    }
+    install(MiskCommonServiceModule(installMetrics = !installFakeMetrics))
   }
 }

misk/api/misk.api

@@ -309,7 +309,8 @@ public abstract class misk/MiskCommand : java/lang/Runnable {
 public final class misk/MiskCommonServiceModule : misk/inject/KAbstractModule {
 	public fun <init> ()V
 	public fun <init> (Lmisk/ServiceManagerConfig;)V
-	public synthetic fun <init> (Lmisk/ServiceManagerConfig;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lmisk/ServiceManagerConfig;Z)V
+	public synthetic fun <init> (Lmisk/ServiceManagerConfig;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 }
 
 public final class misk/MiskRealServiceModule : misk/inject/KAbstractModule {

misk/src/main/kotlin/misk/MiskServiceModule.kt

@@ -42,14 +42,17 @@ class MiskRealServiceModule @JvmOverloads constructor(
  */
 class MiskCommonServiceModule @JvmOverloads constructor(
   private val serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig(),
+  private val installMetrics: Boolean = true
 ) : KAbstractModule() {
   override fun configure() {
     binder().disableCircularProxies()
     binder().requireExactBindingAnnotations()
     install(MdcModule())
     install(ExecutorsModule())
     install(ServiceManagerModule(serviceManagerConfig))
-    install(PrometheusMetricsClientModule())
+    if (installMetrics) {
+      install(PrometheusMetricsClientModule())
+    }
     install(MoshiModule(useWireToRead = true, useWireToWrite = true))
     install(JvmManagementFactoryModule())
     // Initialize empty sets for our multibindings.