Add TCK attributes and async counter tests (#163)

* Test metrc attributes in tck * condense iterations and streams * emit useful errors on failure * add type data to mapToString * Test metrc attributes in tck * Add async counter tests to metrics tck --------- Co-authored-by: Benjamin Confino <[email protected]>
microprofile · Feb 29, 2024 · d3e9e0b · d3e9e0b
1 parent 0141c5e
commit d3e9e0b
Show file tree

Hide file tree

Showing 12 changed files with 459 additions and 87 deletions.
diff --git a/tck/metrics/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/TestUtils.java b/tck/metrics/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/TestUtils.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ *  See the NOTICE file(s) distributed with this work for additional
+ *  information regarding copyright ownership.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  You may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package org.eclipse.microprofile.telemetry.metrics.tck;
+
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import io.opentelemetry.api.common.AttributeKey;
+
+public class TestUtils {
+
+    public static String mapToString(Map<AttributeKey<?>, ?> map) {
+        return (String) map.keySet().stream()
+                .map(key -> "" + key.getKey() + "=" + map.get(key))
+                .collect(Collectors.joining(", ", "{", "}"));
+    }
+}
diff --git a/.../main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/AsyncDoubleCounterTest.java b/.../main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/AsyncDoubleCounterTest.java
@@ -0,0 +1,104 @@
+/*
+ **********************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICES file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+package org.eclipse.microprofile.telemetry.metrics.tck.cdi;
+
+import org.eclipse.microprofile.telemetry.metrics.tck.TestLibraries;
+import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporter;
+import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporterProvider;
+import org.jboss.arquillian.container.test.api.Deployment;
+import org.jboss.arquillian.testng.Arquillian;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.EmptyAsset;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.jboss.shrinkwrap.api.spec.WebArchive;
+import org.testng.Assert;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.sdk.autoconfigure.spi.metrics.ConfigurableMetricExporterProvider;
+import io.opentelemetry.sdk.metrics.data.MetricData;
+import io.opentelemetry.sdk.metrics.data.MetricDataType;
+import jakarta.inject.Inject;
+
+public class AsyncDoubleCounterTest extends Arquillian {
+    private static final String counterName = "testDoubleCounter";
+    private static final String counterDescription = "Testing double counter";
+    private static final String counterUnit = "Metric Tonnes";
+
+    private static final double DOUBLE_WITH_ATTRIBUTES = 20.2;
+    private static final double DOUBLE_WITHOUT_ATTRIBUTES = 10.1;
+
+    @Deployment
+    public static WebArchive createTestArchive() {
+
+        return ShrinkWrap.create(WebArchive.class)
+                .addClasses(InMemoryMetricExporter.class, InMemoryMetricExporterProvider.class)
+                .addAsLibrary(TestLibraries.AWAITILITY_LIB)
+                .addAsServiceProvider(ConfigurableMetricExporterProvider.class, InMemoryMetricExporterProvider.class)
+                .addAsResource(new StringAsset(
+                        "otel.sdk.disabled=false\notel.metrics.exporter=in-memory\notel.traces.exporter=none\notel.metric.export.interval=3000"),
+                        "META-INF/microprofile-config.properties")
+                .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml");
+    }
+
+    @Inject
+    private Meter sdkMeter;
+
+    @Inject
+    private InMemoryMetricExporter metricExporter;
+
+    @BeforeMethod
+    void setUp() {
+        if (metricExporter != null) {
+            metricExporter.reset();
+        }
+    }
+
+    @Test
+    void testAsyncDoubleCounter() throws InterruptedException {
+        Assert.assertNotNull(
+                sdkMeter
+                        .counterBuilder(counterName)
+                        .ofDoubles()
+                        .setDescription(counterDescription)
+                        .setUnit(counterUnit)
+                        .buildWithCallback(measurement -> {
+                            measurement.record(1, Attributes.empty());
+                        }));
+
+        MetricData metric = metricExporter.getMetricData((MetricDataType.DOUBLE_SUM)).get(0);
+
+        Assert.assertEquals(metric.getName(), counterName);
+        Assert.assertEquals(metric.getDescription(), counterDescription);
+        Assert.assertEquals(metric.getUnit(), counterUnit);
+
+        Assert.assertEquals(metric.getDoubleSumData()
+                .getPoints()
+                .stream()
+                .findFirst()
+                .get()
+                .getValue(), 1);
+    }
+
+}
diff --git a/...rc/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/AsyncLongCounterTest.java b/...rc/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/AsyncLongCounterTest.java
@@ -0,0 +1,105 @@
+/*
+ **********************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICES file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+package org.eclipse.microprofile.telemetry.metrics.tck.cdi;
+
+import org.eclipse.microprofile.telemetry.metrics.tck.TestLibraries;
+import org.eclipse.microprofile.telemetry.metrics.tck.TestUtils;
+import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporter;
+import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporterProvider;
+import org.jboss.arquillian.container.test.api.Deployment;
+import org.jboss.arquillian.testng.Arquillian;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.EmptyAsset;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.jboss.shrinkwrap.api.spec.WebArchive;
+import org.testng.Assert;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.sdk.autoconfigure.spi.metrics.ConfigurableMetricExporterProvider;
+import io.opentelemetry.sdk.metrics.data.MetricData;
+import io.opentelemetry.sdk.metrics.data.MetricDataType;
+import jakarta.inject.Inject;
+
+public class AsyncLongCounterTest extends Arquillian {
+
+    private static final String counterName = "testLongCounter";
+    private static final String counterDescription = "Testing long counter";
+    private static final String counterUnit = "Metric Tonnes";
+
+    private static final long LONG_VALUE = 12;
+    private static final long LONG_WITH_ATTRIBUTES = 24;
+    private static final long LONG_WITHOUT_ATTRIBUTES = 12;
+
+    @Deployment
+    public static WebArchive createTestArchive() {
+
+        return ShrinkWrap.create(WebArchive.class)
+                .addClasses(InMemoryMetricExporter.class, InMemoryMetricExporterProvider.class, TestUtils.class)
+                .addAsLibrary(TestLibraries.AWAITILITY_LIB)
+                .addAsServiceProvider(ConfigurableMetricExporterProvider.class, InMemoryMetricExporterProvider.class)
+                .addAsResource(new StringAsset(
+                        "otel.sdk.disabled=false\notel.metrics.exporter=in-memory\notel.traces.exporter=none\notel.metric.export.interval=3000"),
+                        "META-INF/microprofile-config.properties")
+                .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml");
+    }
+
+    @Inject
+    private Meter sdkMeter;
+
+    @Inject
+    private InMemoryMetricExporter metricExporter;
+
+    @BeforeMethod
+    void setUp() {
+        if (metricExporter != null) {
+            metricExporter.reset();
+        }
+    }
+
+    @Test
+    void testAsyncLongCounter() throws InterruptedException {
+        Assert.assertNotNull(
+                sdkMeter
+                        .counterBuilder(counterName)
+                        .setDescription(counterDescription)
+                        .setUnit(counterUnit)
+                        .buildWithCallback(measurement -> {
+                            measurement.record(1, Attributes.empty());
+                        }));
+
+        MetricData metric = metricExporter.getMetricData((MetricDataType.LONG_SUM)).get(0);
+
+        Assert.assertEquals(metric.getName(), counterName);
+        Assert.assertEquals(metric.getDescription(), counterDescription);
+        Assert.assertEquals(metric.getUnit(), counterUnit);
+
+        Assert.assertEquals(metric.getLongSumData()
+                .getPoints()
+                .stream()
+                .findFirst()
+                .get()
+                .getValue(), 1);
+    }
+}
diff --git a/...s/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/DoubleCounterTest.java b/...s/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/DoubleCounterTest.java
@@ -21,7 +21,12 @@
  **********************************************************************/
 package org.eclipse.microprofile.telemetry.metrics.tck.cdi;
 
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 import org.eclipse.microprofile.telemetry.metrics.tck.TestLibraries;
+import org.eclipse.microprofile.telemetry.metrics.tck.TestUtils;
 import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporter;
 import org.eclipse.microprofile.telemetry.metrics.tck.exporter.InMemoryMetricExporterProvider;
 import org.jboss.arquillian.container.test.api.Deployment;
@@ -47,11 +52,14 @@ public class DoubleCounterTest extends Arquillian {
     private static final String counterDescription = "Testing double counter";
     private static final String counterUnit = "Metric Tonnes";
 
+    private static final double DOUBLE_WITH_ATTRIBUTES = 20.2;
+    private static final double DOUBLE_WITHOUT_ATTRIBUTES = 10.1;
+
     @Deployment
     public static WebArchive createTestArchive() {
 
         return ShrinkWrap.create(WebArchive.class)
-                .addClasses(InMemoryMetricExporter.class, InMemoryMetricExporterProvider.class)
+                .addClasses(InMemoryMetricExporter.class, InMemoryMetricExporterProvider.class, TestUtils.class)
                 .addAsLibrary(TestLibraries.AWAITILITY_LIB)
                 .addAsServiceProvider(ConfigurableMetricExporterProvider.class, InMemoryMetricExporterProvider.class)
                 .addAsResource(new StringAsset(
@@ -75,6 +83,7 @@ void setUp() {
 
     @Test
     void testDoubleCounter() throws InterruptedException {
+
         DoubleCounter doubleCounter =
                 sdkMeter
                         .counterBuilder(counterName)
@@ -83,18 +92,31 @@ void testDoubleCounter() throws InterruptedException {
                         .setUnit(counterUnit)
                         .build();
         Assert.assertNotNull(doubleCounter);
-        doubleCounter.add(10.1, Attributes.empty());
-        MetricData metric = metricExporter.getMetricData((MetricDataType.DOUBLE_SUM));
-        Assert.assertEquals(metric.getName(), counterName);
-        Assert.assertEquals(metric.getDescription(), counterDescription);
-        Assert.assertEquals(metric.getUnit(), counterUnit);
-
-        Assert.assertEquals(metric.getDoubleSumData()
-                .getPoints()
-                .stream()
-                .findFirst()
-                .get()
-                .getValue(), 10.1);
+
+        Map<Double, Attributes> expectedResults = new HashMap<Double, Attributes>();
+        expectedResults.put(DOUBLE_WITH_ATTRIBUTES, Attributes.builder().put("K", "V").build());
+        expectedResults.put(DOUBLE_WITHOUT_ATTRIBUTES, Attributes.empty());
+
+        expectedResults.keySet().stream().forEach(key -> doubleCounter.add(key, expectedResults.get(key)));
+
+        List<MetricData> metrics = metricExporter.getMetricData((MetricDataType.DOUBLE_SUM));
+        metrics.stream()
+                .peek(metricData -> {
+                    Assert.assertEquals(metricData.getName(), counterName);
+                    Assert.assertEquals(metricData.getDescription(), counterDescription);
+                    Assert.assertEquals(metricData.getUnit(), counterUnit);
+                })
+                .flatMap(metricData -> metricData.getDoubleSumData().getPoints().stream())
+                .forEach(point -> {
+                    Assert.assertTrue(expectedResults.containsKey(point.getValue()),
+                            "Double" + point.getValue() + " was not an expected result");
+                    Assert.assertTrue(point.getAttributes().equals(expectedResults.get(point.getValue())),
+                            "Attributes were not equal."
+                                    + System.lineSeparator() + "Actual values: "
+                                    + TestUtils.mapToString(point.getAttributes().asMap())
+                                    + System.lineSeparator() + "Expected values: "
+                                    + TestUtils.mapToString(expectedResults.get(point.getValue()).asMap()));
+                });
     }
 
-}
+}
diff --git a/...ics/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/DoubleGaugeTest.java b/...ics/src/main/java/org/eclipse/microprofile/telemetry/metrics/tck/cdi/DoubleGaugeTest.java
@@ -83,7 +83,7 @@ void testDoubleGauge() throws InterruptedException {
                             measurement.record(1, Attributes.empty());
                         }));
 
-        MetricData metric = metricExporter.getMetricData((MetricDataType.DOUBLE_GAUGE));
+        MetricData metric = metricExporter.getMetricData(MetricDataType.DOUBLE_GAUGE).get(0);
         Assert.assertEquals(metric.getName(), gaugeName);
         Assert.assertEquals(metric.getDescription(), gaugeDescription);
         Assert.assertEquals(metric.getUnit(), gaugeUnit);