Support info extensions via environment (#423)

* #395 support info-extensions definition in environment * #395 changed extensionfields in ConfigDocket.Info to Map<String,String> * #395 Integration tests for info/contact/license extensions in amqp-examples * #395 reverted rename of asycnapi.json in amqp-examples --------- Co-authored-by: Thomas Vahrst <[email protected]>
springwolf · Oct 27, 2023 · 89c7b00 · 89c7b00
1 parent 6e61df1
commit 89c7b00
Show file tree

Hide file tree

Showing 11 changed files with 428 additions and 14 deletions.
diff --git a/...main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java b/...main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java
@@ -9,6 +9,7 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.StringUtils;
 
+import java.util.Map;
 import java.util.Optional;
 
 @Slf4j
@@ -75,19 +76,29 @@ private AsyncApiDocket parseApplicationConfigProperties() {
         return builder.build();
     }
 
-    private static Info buildInfo(@Nullable SpringwolfConfigProperties.ConfigDocket.Info info) {
-        if (info == null || !StringUtils.hasText(info.getVersion()) || !StringUtils.hasText(info.getTitle())) {
+    private static Info buildInfo(@Nullable SpringwolfConfigProperties.ConfigDocket.Info configDocketInfo) {
+        if (configDocketInfo == null
+                || !StringUtils.hasText(configDocketInfo.getVersion())
+                || !StringUtils.hasText(configDocketInfo.getTitle())) {
             throw new IllegalArgumentException("One or more required fields of the info object (title, version) "
                     + "in application.properties with path prefix " + SpringwolfConfigConstants.SPRINGWOLF_CONFIG_PREFIX
                     + " is not set.");
         }
 
-        return Info.builder()
-                .version(info.getVersion())
-                .title(info.getTitle())
-                .description(info.getDescription())
-                .contact(info.getContact())
-                .license(info.getLicense())
+        Info asyncapiInfo = Info.builder()
+                .version(configDocketInfo.getVersion())
+                .title(configDocketInfo.getTitle())
+                .description(configDocketInfo.getDescription())
+                .contact(configDocketInfo.getContact())
+                .license(configDocketInfo.getLicense())
                 .build();
+
+        // copy extension fields from configDocketInfo to asyncapiInfo.
+        if (configDocketInfo.getExtensionFields() != null) {
+            Map<String, Object> extFieldsMap = Map.copyOf(configDocketInfo.getExtensionFields());
+            asyncapiInfo.setExtensionFields(extFieldsMap);
+        }
+
+        return asyncapiInfo;
     }
 }
diff --git a/.../io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java b/.../io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java
@@ -132,6 +132,12 @@ public static class Info {
             @NestedConfigurationProperty
             @Nullable
             private License license;
+
+            /**
+             * Extension properties for the Info block.
+             */
+            @Nullable
+            private Map<String, String> extensionFields;
         }
     }
 

diff --git a/...thub/stavshamir/springwolf/configuration/DefaultAsyncApiDocketServiceIntegrationTest.java b/...thub/stavshamir/springwolf/configuration/DefaultAsyncApiDocketServiceIntegrationTest.java
@@ -32,6 +32,7 @@ public class DefaultAsyncApiDocketServiceIntegrationTest {
                 "springwolf.enabled=true",
                 "springwolf.docket.info.title=Info title was loaded from spring properties",
                 "springwolf.docket.info.version=1.0.0",
+                "springwolf.docket.info.extension-fields.x-api-name=api-name",
                 "springwolf.docket.base-package=io.github.stavshamir.springwolf.example",
                 "springwolf.docket.servers.test-protocol.protocol=test",
                 "springwolf.docket.servers.test-protocol.url=some-server:1234"
@@ -46,6 +47,7 @@ void testDocketContentShouldBeLoadedFromProperties() {
             AsyncApiDocket docket = asyncApiDocketService.getAsyncApiDocket();
             assertThat(docket).isNotNull();
             assertThat(docket.getInfo().getTitle()).isEqualTo("Info title was loaded from spring properties");
+            assertThat(docket.getInfo().getExtensionFields().get("x-api-name")).isEqualTo("api-name");
         }
     }
 

diff --git a/.../java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketServiceTest.java b/.../java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketServiceTest.java
@@ -9,6 +9,7 @@
 import io.github.stavshamir.springwolf.configuration.properties.SpringwolfConfigProperties.ConfigDocket.Info;
 import org.junit.jupiter.api.Test;
 
+import java.util.Map;
 import java.util.Optional;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -34,6 +35,7 @@ void testServiceShouldMapAllPropertiesToTheDocket() {
         info.setDescription("some-description");
         info.setLicense(new License("license-name", "license-url"));
         info.setContact(new Contact("contact-name", "contact-url", "contact-email"));
+        info.setExtensionFields(Map.of("x-api-name", "api-name"));
         configDocket.setInfo(info);
 
         SpringwolfConfigProperties properties = new SpringwolfConfigProperties();
@@ -52,6 +54,8 @@ void testServiceShouldMapAllPropertiesToTheDocket() {
         assertThat(asyncApiDocket.getInfo().getDescription()).isEqualTo(info.getDescription());
         assertThat(asyncApiDocket.getInfo().getLicense()).isEqualTo(info.getLicense());
         assertThat(asyncApiDocket.getInfo().getContact()).isEqualTo(info.getContact());
+        assertThat(asyncApiDocket.getInfo().getExtensionFields().get("x-api-name"))
+                .isEqualTo("api-name");
     }
 
     @Test

diff --git a/...ava/io/github/stavshamir/springwolf/example/amqp/configuration/AsyncApiConfiguration.java b/...ava/io/github/stavshamir/springwolf/example/amqp/configuration/AsyncApiConfiguration.java
@@ -16,6 +16,8 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
+import java.util.Map;
+
 @Configuration
 public class AsyncApiConfiguration {
 
@@ -50,6 +52,12 @@ public AsyncApiDocket asyncApiDocket() {
                 .license(License.builder().name("Apache License 2.0").build())
                 .build();
 
+        // the builder for asyncapi info, contact and license doesn't support setting/adding extensions, so
+        // we add text extension explicitely
+        info.setExtensionFields(Map.of("x-api-audience", "company-internal"));
+        info.getContact().setExtensionFields(Map.of("x-phone", "+49 123 456789"));
+        info.getLicense().setExtensionFields(Map.of("x-desc", "some description"));
+
         Server amqp = Server.builder()
                 .protocol("amqp")
                 .url(String.format("%s:%s", amqpHost, amqpPort))

diff --git a/springwolf-examples/springwolf-amqp-example/src/main/resources/application.properties b/springwolf-examples/springwolf-amqp-example/src/main/resources/application.properties
@@ -1,6 +1,6 @@
 #########
 # Spring configuration
-spring.application.name=Springwolf example project - Amqp
+spring.application.name=Springwolf example project - AMQP
 
 
 #########
@@ -19,10 +19,13 @@ springwolf.docket.info.title=${spring.application.name}
 springwolf.docket.info.version=1.0.0
 springwolf.docket.info.description=Springwolf example project to demonstrate springwolfs abilities
 springwolf.docket.info.terms-of-service=http://asyncapi.org/terms
+springwolf.docket.info.extension-fields.x-api-audience=company-internal
 springwolf.docket.info.contact.name=springwolf
 springwolf.docket.info.contact.email=[email protected]
 springwolf.docket.info.contact.url=https://github.com/springwolf/springwolf-core
+springwolf.docket.info.contact.extension-fields.x-phone=+49 123 456789
 springwolf.docket.info.license.name=Apache License 2.0
+springwolf.docket.info.license.extension-fields.x-desc=some description
 springwolf.docket.servers.amqp.protocol=amqp
 springwolf.docket.servers.amqp.url=${spring.rabbitmq.host}:${spring.rabbitmq.port}
 

diff --git a/...t/java/io/github/stavshamir/springwolf/example/amqp/ApiWithDocketBeanIntegrationTest.java b/...t/java/io/github/stavshamir/springwolf/example/amqp/ApiWithDocketBeanIntegrationTest.java
@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+package io.github.stavshamir.springwolf.example.amqp;
+
+import org.springframework.test.context.TestPropertySource;
+
+/**
+ * Api integrationtest based on a SpringBoot application that defines a custom Docket bean. This contains Info and
+ * Server Informations as well as some explicit Producer and Consumer definitions.
+ */
+@TestPropertySource(properties = {"customAsyncApiDocketBean=true"})
+public class ApiWithDocketBeanIntegrationTest extends BaseApiIntegrationTest {
+
+    @Override
+    protected String getExpectedApiFileName() {
+        return "/asyncapi.json";
+    }
+}
diff --git a/...ithub/stavshamir/springwolf/example/amqp/ApiWithDocketFromEnvironmentIntegrationTest.java b/...ithub/stavshamir/springwolf/example/amqp/ApiWithDocketFromEnvironmentIntegrationTest.java
@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+package io.github.stavshamir.springwolf.example.amqp;
+
+import org.springframework.test.context.TestPropertySource;
+
+/**
+ * Api integrationtest based on a SpringBoot application that defines all info and server properties via
+ * spring environment (from application.properties).
+ */
+@TestPropertySource(properties = {"customAsyncApiDocketBean=false"})
+public class ApiWithDocketFromEnvironmentIntegrationTest extends BaseApiIntegrationTest {
+
+    @Override
+    protected String getExpectedApiFileName() {
+        return "/asyncapi_withdocketfromenvironment.json";
+    }
+}
diff --git a/...wolf/example/amqp/ApiIntegrationTest.java → .../example/amqp/BaseApiIntegrationTest.java b/...wolf/example/amqp/ApiIntegrationTest.java → .../example/amqp/BaseApiIntegrationTest.java
@@ -14,10 +14,16 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+/**
+ * Api integrationtest base class defining a SpringBootTest and a test method which asserts the resulting asyncapi.
+ * Subclasses can customize this test with @TestPropertySources and custom expectation file names.
+ * @see ApiWithDocketBeanIntegrationTest
+ * @see ApiWithDocketFromEnvironmentIntegrationTest
+ */
 @SpringBootTest(
         classes = {SpringwolfAmqpExampleApplication.class},
         webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
-public class ApiIntegrationTest {
+public abstract class BaseApiIntegrationTest {
 
     @Autowired
     private TestRestTemplate restTemplate;
@@ -31,9 +37,12 @@ void asyncApiResourceArtifactTest() throws JSONException, IOException {
         String actual = restTemplate.getForObject(url, String.class);
         System.out.println("Got: " + actual);
 
-        InputStream s = this.getClass().getResourceAsStream("/asyncapi.json");
+        String expectedApiFileName = getExpectedApiFileName();
+        InputStream s = this.getClass().getResourceAsStream(expectedApiFileName);
         String expected = new String(s.readAllBytes(), StandardCharsets.UTF_8);
 
         assertEquals(expected, actual);
     }
+
+    protected abstract String getExpectedApiFileName();
 }
diff --git a/springwolf-examples/springwolf-amqp-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-amqp-example/src/test/resources/asyncapi.json
@@ -7,11 +7,14 @@
     "contact": {
       "name": "springwolf",
       "url": "https://github.com/springwolf/springwolf-core",
-      "email": "[email protected]"
+      "email": "[email protected]",
+      "x-phone": "+49 123 456789"
     },
     "license": {
-      "name": "Apache License 2.0"
-    }
+      "name": "Apache License 2.0",
+      "x-desc": "some description"
+    },
+    "x-api-audience": "company-internal"
   },
   "defaultContentType": "application/json",
   "servers": {