Support slf4j2 in OSGi (#6512)

* Make slf4j package imports dynamic, to work with org.slf4j.spi in slf4j 2 bundle.

* Add slf4j 2 OSGi test.

Signed-off-by: Matt Magoffin <[email protected]>

Author: msqr

micrometer-commons/build.gradle

@@ -16,6 +16,7 @@ jar {
         bnd '''\
         Import-Package: \
             org.aspectj.*;resolution:=dynamic,\
+            org.slf4j.*;resolution:=dynamic,\
             javax.annotation.*;resolution:=optional;version="${@}",\
             *
         '''.stripIndent()

micrometer-core/build.gradle

@@ -58,6 +58,7 @@ jar {
             org.HdrHistogram.*;resolution:=dynamic;version="${@}",\
             org.apache.catalina.*;resolution:=dynamic,\
             org.bson.*;resolution:=dynamic;version="${@}",\
+            org.slf4j.*;resolution:=dynamic,\
             rx.*;resolution:=dynamic;version="${@}",\
             javax.persistence.*;resolution:=dynamic;version="${@}",\
             io.netty.*;resolution:=dynamic;version="${@}",\

micrometer-osgi-test-slf4j2/build.gradle

@@ -0,0 +1,70 @@
+import aQute.bnd.gradle.Bundle
+import aQute.bnd.gradle.Resolve
+import aQute.bnd.gradle.TestOSGi
+
+// skip this module when building with jdk >=24
+// waiting for a release with the fix https://github.com/bndtools/bnd/pull/6371
+if (javaLanguageVersion.canCompileOrRun(24)) {
+    project.tasks.configureEach { task -> task.enabled = false }
+}
+
+dependencies {
+    testImplementation libs.assertj
+    testImplementation libs.osgiJunit5
+    testImplementation 'org.slf4j:slf4j-api:2.0.17'
+    testImplementation 'org.slf4j:slf4j-simple:2.0.17'
+
+    testImplementation project(':micrometer-core')
+
+    testImplementation project(':micrometer-registry-jmx')
+    // osgi test fails when the new prometheus client is used
+    //testImplementation project(':micrometer-registry-prometheus')
+    testImplementation project(':micrometer-registry-prometheus-simpleclient')
+
+    testImplementation libs.felixFramework
+
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
+    testRuntimeOnly libs.felixScr
+    testRuntimeOnly 'org.slf4j:slf4j-simple:2.0.17'
+    testRuntimeOnly 'org.apache.aries.spifly:org.apache.aries.spifly.dynamic.bundle:1.3.7'
+}
+
+def testingBundle = tasks.register('testingBundle', Bundle) {
+    archiveClassifier = 'tests'
+    from sourceSets.test.output
+    if (javaLanguageVersion.asInt() < 17) {
+        sourceSet = sourceSets.test
+    }
+    bundle {
+        bnd """\
+            Bundle-SymbolicName: \${task.archiveBaseName}-\${task.archiveClassifier}
+            Test-Cases: \${classes;HIERARCHY_INDIRECTLY_ANNOTATED;org.junit.platform.commons.annotation.Testable;CONCRETE}
+            """.stripIndent()
+    }
+}
+
+def resolveTask = tasks.register("resolve", Resolve) {
+    dependsOn jar, testingBundle
+    project.ext.osgiRunee="JavaSE-${javaLanguageVersion.asInt()}"
+    bundles = files(sourceSets.test.runtimeClasspath, configurations.archives.artifacts.files)
+    bndrun = file("test.bndrun")
+    outputBndrun = layout.buildDirectory.file("resolved-test.bndrun")
+}
+
+
+
+tasks.register("testOSGi", TestOSGi) {
+    group = "verification"
+    description = "Run OSGi tests"
+    bundles = files(sourceSets.test.runtimeClasspath, configurations.archives.artifacts.files)
+    bndrun = resolveTask.flatMap { it.outputBndrun }
+}
+
+tasks.test.configure {
+    actions.clear()
+    dependsOn testOSGi
+}
+
+artifacts {
+    archives testingBundle
+}

micrometer-osgi-test-slf4j2/src/test/java/io/micrometer/osgi/test/OsgiTest.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2023 VMware, Inc.
+ *
+ * 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
+ *
+ * https://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 io.micrometer.osgi.test;
+
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Metrics;
+import io.micrometer.core.instrument.MockClock;
+import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
+import io.micrometer.jmx.JmxConfig;
+import io.micrometer.jmx.JmxMeterRegistry;
+import io.micrometer.prometheus.PrometheusConfig;
+import io.micrometer.prometheus.PrometheusMeterRegistry;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.FrameworkUtil;
+import org.osgi.test.junit5.context.BundleContextExtension;
+import org.osgi.test.junit5.service.ServiceExtension;
+
+import java.time.Duration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith({ ServiceExtension.class, BundleContextExtension.class })
+class OsgiTest {
+
+    private final BundleContext context = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
+
+    private final MockClock clock = new MockClock();
+
+    @Test
+    void testCoreResolves() {
+        Bundle bundle = context.getBundle();
+        assertThat(bundle).isNotNull();
+
+        CompositeMeterRegistry registry = Metrics.globalRegistry;
+        assertThat(registry).isNotNull();
+    }
+
+    @Test
+    void testPrometheusMeterRegistryResolves() {
+        PrometheusMeterRegistry registry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
+        testMetrics(registry);
+        assertThat(registry.scrape()).contains("micrometer_test_counter").contains(" micrometer_test_timer");
+    }
+
+    @Test
+    void testJmxMeterRegistryResolves() {
+        JmxMeterRegistry registry = new JmxMeterRegistry(JmxConfig.DEFAULT, clock);
+        testMetrics(registry);
+    }
+
+    private void testMetrics(MeterRegistry registry) {
+        registry.counter("micrometer.test.counter").increment();
+        registry.timer("micrometer.test.timer").record(Duration.ofMillis(123));
+    }
+
+}

micrometer-osgi-test-slf4j2/test.bndrun

@@ -0,0 +1,20 @@
+-tester: biz.aQute.tester.junit-platform
+-runfw: org.apache.felix.framework;
+-runee: ${project.osgiRunee}
+-runtrace: false
+
+#uncomment to remote debug
+# -runjdb: 5005
+
+-runrequires: \
+    bnd.identity;id='org.apache.aries.spifly.dynamic.bundle',\
+    bnd.identity;id='micrometer-osgi-test-slf4j2-tests',\
+    bnd.identity;id='junit-jupiter-engine',\
+    bnd.identity;id='junit-platform-launcher'
+
+-runstartlevel: \
+    order=sortbynameversion,\
+    begin=-1
+
+-runproperties: \
+    org.osgi.framework.bsnversion=multiple

settings.gradle

@@ -51,4 +51,5 @@ include 'micrometer-java21'
 include 'micrometer-jetty11'
 include 'micrometer-jetty12'
 include 'micrometer-osgi-test'
+include 'micrometer-osgi-test-slf4j2'
 include 'docs'