/
MetricRegistryTest.java
149 lines (125 loc) · 5.36 KB
/
MetricRegistryTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
**********************************************************************
* Copyright (c) 2017, 2022 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.metrics.tck;
import static org.junit.Assert.assertNotNull;
import org.eclipse.microprofile.metrics.Counter;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
import org.eclipse.microprofile.metrics.MetricRegistry;
import org.eclipse.microprofile.metrics.MetricType;
import org.eclipse.microprofile.metrics.Tag;
import org.eclipse.microprofile.metrics.annotation.Metric;
import org.eclipse.microprofile.metrics.annotation.RegistryScope;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.junit.InSequence;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.EmptyAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import jakarta.inject.Inject;
@RunWith(Arquillian.class)
public class MetricRegistryTest {
private static final String CUSTOM_SCOPE = "customScope";
@Inject
@Metric(name = "nameTest", absolute = true)
private Counter nameTest;
@Inject
private MetricRegistry metrics;
@Inject
@RegistryScope(scope = MetricRegistry.BASE_SCOPE)
private MetricRegistry baseMetrics;
@Inject
@RegistryScope(scope = MetricRegistry.VENDOR_SCOPE)
private MetricRegistry vendorMetrics;
@Inject
@RegistryScope(scope = CUSTOM_SCOPE)
private MetricRegistry customScope;
@Deployment
public static WebArchive createDeployment() {
return ShrinkWrap.create(WebArchive.class).addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml");
}
@Test
@InSequence(1)
public void nameTest() {
Assert.assertNotNull(metrics);
Assert.assertNotNull(metrics.getMetadata("nameTest"));
}
@Test
@InSequence(3)
public void removeTest() {
metrics.remove("nameTest");
Assert.assertNull(metrics.getMetadata("nameTest"));
}
@Test
@InSequence(4)
public void useExistingMetaDataTest() {
String displayName = "displayCounterFoo";
String metricName = "counterFoo";
// first to register a "complex" metadata
metrics.counter(Metadata.builder().withName(metricName).withDisplayName(displayName)
.withType(MetricType.COUNTER).build());
Tag purpleTag = new Tag("colour", "purple");
// creates with a simple/template metadata or uses an existing one.
metrics.counter(metricName, purpleTag);
// check both counters have been registered
assertExists(Counter.class, new MetricID(metricName));
assertExists(Counter.class, new MetricID(metricName, purpleTag));
// check that the "original" metadata wasn't replaced by the empty default metadata
Assert.assertEquals(metrics.getMetadata(metricName).getDisplayName(), displayName);
}
@Test
@InSequence(5)
public void testMetricRegistryScope() {
Assert.assertEquals(MetricRegistry.APPLICATION_SCOPE, metrics.getScope());
Assert.assertEquals(MetricRegistry.BASE_SCOPE, baseMetrics.getScope());
Assert.assertEquals(MetricRegistry.VENDOR_SCOPE, vendorMetrics.getScope());
Assert.assertEquals(CUSTOM_SCOPE, customScope.getScope());
}
private void assertExists(Class<? extends org.eclipse.microprofile.metrics.Metric> expected, MetricID metricID) {
assertNotNull("Metric expected to exist but was undefined: " + metricID, metrics.getMetric(metricID, expected));
}
/**
* The implementation has to sanitize Metadata passed to registration methods if the application does not supply the
* metric type explicitly, but the type is implied by the used method.
*/
@Test
@InSequence(6)
public void sanitizeMetadataTest() {
Metadata metadata = Metadata.builder().withName("metric1").build();
metrics.counter(metadata);
Metadata actualMetadata = metrics.getMetadata("metric1");
Assert.assertEquals(MetricType.COUNTER, actualMetadata.getTypeRaw());
}
/**
* if there is a mismatch because the type specified in the `Metadata` is different than the one implied by the
* method name, an exception must be thrown
*/
@Test(expected = Exception.class)
@InSequence(7)
public void conflictingMetadataTest() {
Metadata metadata = Metadata.builder().withName("metric1").withType(MetricType.COUNTER).build();
metrics.timer(metadata);
}
}