Add @SdkImport annotation to simplify importing an SDK client (#1165)

Adds a new `@SdkImport` annotation that lets the user easily import an SDK client built with SDK v3 but not compiled with Micronaut.

Author: graemerocher

buildSrc/src/main/groovy/io.micronaut.build.internal.ocisdk-metadata-module.gradle

@@ -21,6 +21,7 @@ sourceSets {
     }
 }
 
+
 if (!project.name.contains("circuitbreaker")) {
     var generateClientFactories = tasks.register("generateClientFactories", GenerateClientFactories) {
         sources = sourceSets.main.java
@@ -39,6 +40,16 @@ if (!project.name.contains("circuitbreaker")) {
         generatedCompileOnly(mn.reactor)
         generatedCompileOnly(mnReactor.micronaut.reactor)
     }
+
+    tasks.named("compileGeneratedJava") {
+        options.fork = true
+        options.forkOptions.jvmArgs.add("-Doci.sdk.visitor.enabled")
+    }
+
+    tasks.named("compileJava") {
+        options.fork = true
+        options.forkOptions.jvmArgs.add("-Doci.sdk.visitor.enabled")
+    }
 }
 
 def metadataJar = tasks.register("metadataJar", Jar) {
@@ -95,6 +106,11 @@ tasks.named("compileTestJava") {
     enabled = false
 }
 
+tasks.named("compileJava") {
+    options.fork = true
+    options.forkOptions.jvmArgs.add("-Doci.sdk.visitor.enabled")
+}
+
 tasks.configureEach {
     if (name.startsWith("spotless")) {
         // The license and checkstyle rules differ from ours

gradle/libs.versions.toml

@@ -27,6 +27,7 @@ micronaut-reactor = "3.8.0"
 micronaut-rxjava2 = "2.8.0"
 micronaut-serde = "2.15.1"
 micronaut-servlet = "5.4.0"
+micronaut-sourcegen = "1.8.2"
 micronaut-sql = "6.2.1"
 micronaut-test = "4.8.1"
 micronaut-logging = "1.7.0"
@@ -54,6 +55,7 @@ micronaut-rxjava2 = { module = "io.micronaut.rxjava2:micronaut-rxjava2-bom", ver
 micronaut-serde = { module = "io.micronaut.serde:micronaut-serde-bom", version.ref = "micronaut-serde" }
 micronaut-servlet = { module = "io.micronaut.servlet:micronaut-servlet-bom", version.ref = "micronaut-servlet" }
 micronaut-sql = { module = "io.micronaut.sql:micronaut-sql-bom", version.ref = "micronaut-sql" }
+micronaut-sourcegen = { module = "io.micronaut.sourcegen:micronaut-sourcegen-bom", version.ref = "micronaut-sourcegen" }
 micronaut-docs = { module = "io.micronaut.docs:micronaut-docs-asciidoc-config-props", version.ref = "micronaut-docs" }
 micronaut-validation = { module = "io.micronaut.validation:micronaut-validation-bom", version.ref = "micronaut-validation" }
 micronaut-discovery-client = { module = "io.micronaut.discovery:micronaut-discovery-client-bom", version.ref = "micronaut-discovery-client" }
@@ -78,6 +80,7 @@ oci-common = { module = 'com.oracle.oci.sdk:oci-java-sdk-common', version.ref =
 oci-common-httpclient = { module = 'com.oracle.oci.sdk:oci-java-sdk-common-httpclient', version.ref = "oci" }
 oci-common-httpclient-jersey3 = { module = 'com.oracle.oci.sdk:oci-java-sdk-common-httpclient-jersey3', version.ref = "oci" }
 oci-objectstorage = { module = 'com.oracle.oci.sdk:oci-java-sdk-objectstorage', version.ref = "oci" }
+oci-disasterrecovery = { module = 'com.oracle.oci.sdk:oci-java-sdk-disasterrecovery', version.ref = "oci" }
 oci-encryption = { module = 'com.oracle.oci.sdk:oci-java-sdk-encryption', version.ref = "oci" }
 oci-oke-workload-identity = { module = 'com.oracle.oci.sdk:oci-java-sdk-addons-oke-workload-identity', version.ref = "oci" }
 oci-graalvm = { module = 'com.oracle.oci.sdk:oci-java-sdk-addons-graalvm', version.ref = "oci" }

oraclecloud-common/src/main/java/io/micronaut/oraclecloud/core/sdk/SdkImport.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2017-2025 original authors
+ *
+ * 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.micronaut.oraclecloud.core.sdk;
+
+/**
+ * Annotation used to import an SDK if it is generated with OCI SDK v3, but without Micronaut compatibility.
+ */
+public @interface SdkImport {
+    /**
+     * The type of the client. This should reference a type that extends from either
+     * {@link com.oracle.bmc.http.internal.BaseAsyncClient} or {@link com.oracle.bmc.http.internal.BaseSyncClient}.
+     *
+     * @return The type of a client to import.
+     */
+    Class<?> value();
+}

oraclecloud-httpclient-netty/build.gradle

@@ -25,6 +25,7 @@ dependencies {
 
     testAnnotationProcessor mn.micronaut.inject.java
     testAnnotationProcessor projects.micronautOraclecloudSerdeProcessor
+    testAnnotationProcessor(mnSourcegen.micronaut.sourcegen.generator.java)
     testCompileOnly mn.micronaut.jackson.databind
     testRuntimeOnly mn.micronaut.runtime
 
@@ -35,7 +36,9 @@ dependencies {
     testImplementation mn.micronaut.context
     testImplementation projects.micronautOraclecloudCommon
     testImplementation projects.testSuiteHttpClient
-
+    testImplementation(libs.oci.disasterrecovery) {
+        exclude(group: "com.oracle.oci.sdk", module: "oci-java-sdk-common")
+    }
     [projects.micronautOraclecloudBmcMonitoring,
      projects.micronautOraclecloudBmcIdentity,
      projects.micronautOraclecloudBmcObjectstorage,

oraclecloud-httpclient-netty/src/test/java/io/micronaut/oraclecloud/httpclient/netty/SdkImportTest.java

@@ -0,0 +1,72 @@
+package io.micronaut.oraclecloud.httpclient.netty;
+
+import com.oracle.bmc.Region;
+import com.oracle.bmc.auth.RegionProvider;
+import com.oracle.bmc.disasterrecovery.DisasterRecoveryClient;
+import com.oracle.bmc.disasterrecovery.model.CreateDrPlanDetails;
+import com.oracle.bmc.disasterrecovery.model.DrPlan;
+import com.oracle.bmc.disasterrecovery.model.DrPlanType;
+import com.oracle.bmc.disasterrecovery.requests.CreateDrPlanRequest;
+import com.oracle.bmc.disasterrecovery.responses.CreateDrPlanResponse;
+import io.micronaut.context.annotation.Property;
+import io.micronaut.context.event.BeanCreatedEventListener;
+import io.micronaut.http.HttpResponse;
+import io.micronaut.http.annotation.Body;
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Post;
+import io.micronaut.oraclecloud.core.sdk.SdkImport;
+import io.micronaut.runtime.server.EmbeddedServer;
+import io.micronaut.test.annotation.MockBean;
+import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+@SdkImport(DisasterRecoveryClient.class)
+@MicronautTest
+@Property(name = "oci.config.path", value = "") // Disable reading config file
+public class SdkImportTest {
+
+    @Inject
+    DisasterRecoveryClient disasterRecoveryClient;
+
+    @Test
+    void testImport() {
+        Assertions.assertNotNull(disasterRecoveryClient);
+        CreateDrPlanResponse drPlan = disasterRecoveryClient.createDrPlan(
+            CreateDrPlanRequest.builder()
+                .body$(CreateDrPlanDetails.builder()
+                    .type(DrPlanType.Failover)
+                    .drProtectionGroupId("mygroup")
+                    .sourcePlanId("myplan")
+                    .build())
+                .build()
+        );
+        DrPlan dp = drPlan.getDrPlan();
+        Assertions.assertNotNull(dp);
+        Assertions.assertEquals(DrPlanType.Failover, drPlan.getDrPlan().getType());
+    }
+
+    @MockBean(RegionProvider.class)
+    RegionProvider mockRegionProvider() {
+        return () -> Region.AF_JOHANNESBURG_1;
+    }
+
+    @MockBean
+    BeanCreatedEventListener<DisasterRecoveryClient.Builder> setEndpoint(EmbeddedServer embeddedServer) {
+        return event -> event.getBean().endpoint("http://localhost:" + embeddedServer.getPort());
+    }
+
+    @MockBean
+    @Controller
+    static class TestController {
+        @Post("/20220125/drPlans")
+        HttpResponse<DrPlan> createDrPlan(@Body CreateDrPlanDetails createDrPlanRequest) {
+            return HttpResponse.created(DrPlan.builder()
+                    .sourcePlanId(createDrPlanRequest.getSourcePlanId())
+                    .drProtectionGroupId(createDrPlanRequest.getDrProtectionGroupId())
+                    .type(createDrPlanRequest.getType())
+                .build());
+        }
+    }
+}

oraclecloud-serde-processor/build.gradle

@@ -1,15 +1,23 @@
 plugins {
     id 'io.micronaut.build.internal.common'
-    id 'io.micronaut.build.internal.oraclecloud-base'
+    id 'io.micronaut.build.internal.oraclecloud-module'
 }
 
 dependencies {
     // Transitive dependencies
     implementation mn.micronaut.inject
     implementation mn.micronaut.inject.java
+    implementation mnSourcegen.micronaut.sourcegen.annotations
+    implementation mnSourcegen.micronaut.sourcegen.generator
     implementation mnSerde.micronaut.serde.processor
     implementation mnSerde.micronaut.serde.api
 
+    testImplementation(libs.oci.objectstorage)
     testImplementation mn.micronaut.inject.java.test
-    testImplementation libs.oci.common
+    testImplementation(mnSourcegen.micronaut.sourcegen.generator.java)
+    testImplementation(projects.micronautOraclecloudCommon)
+}
+
+micronautBuild {
+    binaryCompatibility.enabled = false
 }