Add tests to run on Hazelcast 3 sample

Author: shakuzen

samples/micrometer-samples-hazelcast/build.gradle

@@ -1,3 +1,7 @@
+plugins {
+    id 'java'
+}
+
 dependencies {
     implementation project(':micrometer-core')
     implementation 'com.hazelcast:hazelcast:4.+'

samples/micrometer-samples-hazelcast/src/main/java/io/micrometer/core/samples/HazelcastCacheSample.java renamed to samples/micrometer-samples-hazelcast/src/main/java/io/micrometer/samples/hazelcast4/HazelcastCacheSample.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.samples;
+package io.micrometer.samples.hazelcast4;
 
 import com.hazelcast.core.Hazelcast;
 import com.hazelcast.map.IMap;

samples/micrometer-samples-hazelcast-3-compatibility/build.gradle renamed to samples/micrometer-samples-hazelcast3/build.gradle

@@ -6,17 +6,14 @@ repositories {
     mavenCentral()
 }
 
-license {
-    ext.year = Calendar.getInstance().get(Calendar.YEAR)
-    skipExistingHeaders = true
-}
-
 dependencies {
     implementation project(':micrometer-core')
     implementation('com.hazelcast:hazelcast') {
         version {
-            strictly '3.12.6'
+            strictly '3.+'
         }
     }
     implementation 'ch.qos.logback:logback-classic'
+
+    testImplementation project(':micrometer-test')
 }

samples/micrometer-samples-hazelcast-3-compatibility/src/main/java/io/micrometer/core/samples/HazelcastCacheSample.java renamed to samples/micrometer-samples-hazelcast3/src/main/java/io/micrometer/samples/hazelcast3/HazelcastCacheSample.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2017 VMware, Inc.
+ * Copyright 2020 VMware, Inc.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.samples;
+package io.micrometer.samples.hazelcast3;
 
 import com.hazelcast.core.Hazelcast;
 import com.hazelcast.core.IMap;

samples/micrometer-samples-hazelcast-3-compatibility/src/main/resources/logback.xml renamed to samples/micrometer-samples-hazelcast3/src/main/resources/logback.xml

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2020 VMware, Inc.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.micrometer.samples.hazelcast3;
+
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.IMap;
+import io.micrometer.core.instrument.binder.cache.CacheMeterBinder;
+import io.micrometer.core.instrument.binder.cache.CacheMeterBinderCompatibilityKit;
+import io.micrometer.core.instrument.binder.cache.HazelcastCacheMetrics;
+import org.junit.jupiter.api.AfterEach;
+
+import static java.util.Collections.emptyList;
+
+class Hazelcast3CacheMetricsCompatibilityTest extends CacheMeterBinderCompatibilityKit {
+    private IMap<String, String> cache = Hazelcast.newHazelcastInstance().getMap("mycache");
+
+    @AfterEach
+    void cleanup() {
+        Hazelcast.shutdownAll();
+    }
+
+    @Override
+    public CacheMeterBinder binder() {
+        return new HazelcastCacheMetrics(cache, emptyList());
+    }
+
+    @Override
+    public void put(String key, String value) {
+        cache.put(key, value);
+    }
+
+    @Override
+    public String get(String key) {
+        return cache.get(key);
+    }
+}

samples/micrometer-samples-hazelcast3/src/test/java/io/micrometer/samples/hazelcast3/Hazelcast3CacheMetricsCompatibilityTest.java

@@ -0,0 +1,119 @@
+/**
+ * Copyright 2020 VMware, Inc.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.micrometer.samples.hazelcast3;
+
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.core.IMap;
+import com.hazelcast.monitor.LocalMapStats;
+import com.hazelcast.monitor.NearCacheStats;
+import io.micrometer.core.instrument.*;
+import io.micrometer.core.instrument.binder.cache.HazelcastCacheMetrics;
+import io.micrometer.core.instrument.search.RequiredSearch;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+import java.util.concurrent.TimeUnit;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Copied from micrometer-core test HazelcastCacheMetricsTest here to ensure cache metrics work with Hazelcast 3.
+ */
+class Hazelcast3CacheMetricsTest {
+
+    HazelcastInstance hazelcastInstance = Hazelcast.newHazelcastInstance();
+    IMap<String, String> cache = hazelcastInstance.getMap("mycache");
+    HazelcastCacheMetrics metrics = new HazelcastCacheMetrics(cache, Tags.empty());
+    LocalMapStats localMapStats = cache.getLocalMapStats();
+    MeterRegistry meterRegistry = new SimpleMeterRegistry();
+
+    @BeforeEach
+    void setup() {
+        metrics.bindTo(meterRegistry);
+        cache.put("hello", "world");
+        cache.get("hello");
+        cache.get("hi");
+        cache.get("hello");
+    }
+
+    @AfterEach
+    void cleanUp() {
+        hazelcastInstance.shutdown();
+    }
+
+    @Test
+    void generalMetrics() {
+        Gauge backupEntries = fetch(meterRegistry, "cache.entries", Tags.of("ownership", "backup")).gauge();
+        assertThat(backupEntries.value()).isEqualTo(localMapStats.getBackupEntryCount());
+
+        Gauge ownedEntries = fetch(meterRegistry, "cache.entries", Tags.of("ownership", "owned")).gauge();
+        assertThat(ownedEntries.value()).isEqualTo(localMapStats.getOwnedEntryCount());
+
+        Gauge backupEntryMemory = fetch(meterRegistry, "cache.entry.memory", Tags.of("ownership", "backup")).gauge();
+        assertThat(backupEntryMemory.value()).isEqualTo(localMapStats.getBackupEntryMemoryCost());
+
+        Gauge ownedEntryMemory = fetch(meterRegistry, "cache.entry.memory", Tags.of("ownership", "owned")).gauge();
+        assertThat(ownedEntryMemory.value()).isEqualTo(localMapStats.getOwnedEntryMemoryCost());
+
+        FunctionCounter partitionGets = fetch(meterRegistry, "cache.partition.gets").functionCounter();
+        assertThat(partitionGets.count()).isEqualTo(localMapStats.getGetOperationCount());
+    }
+
+    @Disabled("TODO figure out how to setup near cache properly")
+    @Test
+    void nearCacheMetrics() {
+        NearCacheStats nearCacheStats = localMapStats.getNearCacheStats();
+        Gauge hitCacheRequests = fetch(meterRegistry, "cache.near.requests", Tags.of("result", "hit")).gauge();
+        assertThat(hitCacheRequests.value()).isEqualTo(nearCacheStats.getHits());
+
+        Gauge missCacheRequests = fetch(meterRegistry, "cache.near.requests", Tags.of("result", "miss")).gauge();
+        assertThat(missCacheRequests.value()).isEqualTo(nearCacheStats.getMisses());
+
+        Gauge nearPersistance = fetch(meterRegistry, "cache.near.persistences").gauge();
+        assertThat(nearPersistance.value()).isEqualTo(nearCacheStats.getPersistenceCount());
+
+        Gauge nearEvictions = fetch(meterRegistry, "cache.near.evictions").gauge();
+        assertThat(nearEvictions.value()).isEqualTo(nearCacheStats.getEvictions());
+    }
+
+    @Test
+    void timingsMetrics() {
+        TimeUnit timeUnit = TimeUnit.MILLISECONDS;
+        FunctionTimer getsLatency = fetch(meterRegistry, "cache.gets.latency").functionTimer();
+        assertThat(getsLatency.count()).isEqualTo(localMapStats.getGetOperationCount());
+        assertThat(getsLatency.totalTime(timeUnit)).isEqualTo(localMapStats.getTotalGetLatency());
+
+        FunctionTimer putsLatency = fetch(meterRegistry, "cache.puts.latency").functionTimer();
+        assertThat(putsLatency.count()).isEqualTo(localMapStats.getPutOperationCount());
+        assertThat(putsLatency.totalTime(timeUnit)).isEqualTo(localMapStats.getTotalPutLatency());
+
+        FunctionTimer removeLatency = fetch(meterRegistry, "cache.removals.latency").functionTimer();
+        assertThat(removeLatency.count()).isEqualTo(localMapStats.getRemoveOperationCount());
+        assertThat(removeLatency.totalTime(timeUnit)).isEqualTo(localMapStats.getTotalRemoveLatency());
+    }
+
+    private RequiredSearch fetch(MeterRegistry meterRegistry, String name) {
+        return fetch(meterRegistry, name, Tags.empty());
+    }
+
+    private RequiredSearch fetch(MeterRegistry meterRegistry, String name, Iterable<Tag> tags) {
+        return meterRegistry.get(name).tags(tags);
+    }
+}

samples/micrometer-samples-hazelcast3/src/test/java/io/micrometer/samples/hazelcast3/Hazelcast3CacheMetricsTest.java

@@ -3,7 +3,7 @@ rootProject.name = 'micrometer'
 include 'micrometer-core'
 include 'micrometer-jersey2'
 
-['core', 'boot2', 'spring-integration', 'hazelcast', 'hazelcast-3-compatibility'].each { sample ->
+['core', 'boot2', 'spring-integration', 'hazelcast', 'hazelcast3'].each { sample ->
     include "micrometer-samples-$sample"
     project(":micrometer-samples-$sample").projectDir = new File(rootProject.projectDir, "samples/micrometer-samples-$sample")
 }