feat(openapi): new module for checking backwards incompatible changes to OpenAPI contracts

src/main/java/tech/jhipster/lite/generator/server/springboot/apidocumentation/openapicontract/application/OpenApiContractApplicationService.java

@@ -17,4 +17,8 @@ public OpenApiContractApplicationService() {
  public JHipsterModule buildModule(JHipsterModuleProperties properties) {
  return factory.buildModule(properties);
  }
+
+ public JHipsterModule buildBackwardsCompatibilityCheckModule(JHipsterModuleProperties properties) {
+ return factory.buildBackwardsCompatibilityCheckModule(properties);
+ }
 }

src/main/java/tech/jhipster/lite/generator/server/springboot/apidocumentation/openapicontract/domain/OpenApiContractModuleFactory.java

@@ -56,4 +56,29 @@ private MavenPlugin openApiPluginManagement(JHipsterModuleProperties properties)
  )
  .build();
  }
+
+ public JHipsterModule buildBackwardsCompatibilityCheckModule(JHipsterModuleProperties properties) {
+ Assert.notNull("properties", properties);
+
+ //@formatter:off
+ return moduleBuilder(properties)
+ .mavenPlugins()
+ .pluginManagement(openApiBackwardsCompatPluginManagement())
+ .plugin(openApiBackwardsCompatPlugin().build())
+ .and()
+ .build();
+ //@formatter:on
+ }
+
+ private MavenPlugin openApiBackwardsCompatPluginManagement() {
+ return openApiBackwardsCompatPlugin()
+ .versionSlug("openapi-backwards-compat-maven-plugin")
+ .configuration("<openApiSourceDir>${project.build.directory}</openApiSourceDir>")
+ .addExecution(pluginExecution().goals("backwards-compatibility-check"))
+ .build();
+ }
+
+ private MavenPluginOptionalBuilder openApiBackwardsCompatPlugin() {
+ return mavenPlugin().groupId("io.kemtoa.openapi").artifactId("openapi-backwards-compat-maven-plugin");
+ }
 }

src/main/java/tech/jhipster/lite/generator/server/springboot/apidocumentation/openapicontract/infrastructure/primary/OpenApiContractModuleConfiguration.java

@@ -21,4 +21,15 @@ JHipsterModuleResource openApiContractModule(OpenApiContractApplicationService o
  .tags("server", "spring", "spring-boot", "documentation", "swagger", "openapi")
  .factory(openApiContract::buildModule);
  }
+
+ @Bean
+ JHipsterModuleResource openApiBackwardsCompatibilityCheckModule(OpenApiContractApplicationService openApiContract) {
+ return JHipsterModuleResource.builder()
+ .slug(OPENAPI_BACKWARDS_COMPATIBILITY_CHECK)
+ .propertiesDefinition(JHipsterModulePropertiesDefinition.EMPTY)
+ .apiDoc("Spring Boot - OpenAPI", "Check backwards incompatible changes to OpenAPI contract during build")
+ .organization(JHipsterModuleOrganization.builder().addDependency(OPENAPI_CONTRACT).build())
+ .tags("server", "spring", "spring-boot", "documentation", "swagger", "openapi")
+ .factory(openApiContract::buildBackwardsCompatibilityCheckModule);
+ }
 }

src/main/java/tech/jhipster/lite/generator/slug/domain/JHLiteModuleSlug.java

@@ -81,6 +81,7 @@ public enum JHLiteModuleSlug implements JHipsterModuleSlugFactory {
  NEO4J("neo4j"),
  NEO4J_MIGRATIONS("neo4j-migrations"),
  OPENAPI_CONTRACT("openapi-contract"),
+ OPENAPI_BACKWARDS_COMPATIBILITY_CHECK("openapi-backwards-compatibility-check"),
  OPTIONAL_TYPESCRIPT("optional-typescript"),
  PAGINATION_DOMAIN("pagination-domain"),
  PLAYWRIGHT_COMPONENT_TESTS("playwright-component-tests"),

src/main/resources/generator/dependencies/pom.xml

@@ -70,6 +70,7 @@
  <failsafe-plugin.version>3.5.0</failsafe-plugin.version>
  <asciidoctor-maven-plugin.version>3.0.0</asciidoctor-maven-plugin.version>
  <openapi-maven-plugin.version>0.0.20</openapi-maven-plugin.version>
+ <openapi-backwards-compat-maven-plugin.version>1.0.1</openapi-backwards-compat-maven-plugin.version>
  </properties>
 
  <dependencyManagement>
@@ -400,6 +401,11 @@
  <artifactId>openapi-maven-plugin</artifactId>
  <version>${openapi-maven-plugin.version}</version>
  </dependency>
+ <dependency>
+ <groupId>io.kemtoa.openapi</groupId>
+ <artifactId>openapi-backwards-compat-maven-plugin</artifactId>
+ <version>${openapi-backwards-compat-maven-plugin.version}</version>
+ </dependency>
  </dependencies>
  </dependencyManagement>
 </project>

src/test/features/server/springboot/openapi-contract.feature

@@ -4,3 +4,8 @@ Feature: OpenAPI contract generation
  When I apply "openapi-contract" module to default project with maven file
  | packageName | tech.jhipster.chips |
  Then I should have "openapi-maven-plugin" in "pom.xml"
+
+ Scenario: Should apply OpenAPI backwards compatibility check module
+ When I apply "openapi-backwards-compatibility-check" module to default project with maven file
+ | packageName | tech.jhipster.chips |
+ Then I should have "openapi-backwards-compat-maven-plugin" in "pom.xml"

src/test/java/tech/jhipster/lite/generator/server/springboot/apidocumentation/openapicontract/domain/OpenApiContractModuleFactoryTest.java

@@ -16,7 +16,7 @@ class OpenApiContractModuleFactoryTest {
  private static final OpenApiContractModuleFactory factory = new OpenApiContractModuleFactory();
 
  @Test
- void shouldBuildModuleOnProjectWithoutDefaultGoal() {
+ void shouldBuildOpenApiContractModule() {
  JHipsterModuleProperties properties = propertiesBuilder(tmpDirForTest()).basePackage("tech.jhipster.jhlitest").build();
 
  JHipsterModule module = factory.buildModule(properties);
@@ -72,4 +72,43 @@ void shouldBuildModuleOnProjectWithoutDefaultGoal() {
  """
  );
  }
+
+ @Test
+ void shouldBuildOpenApiBackwardsCompatibilityCheckModule() {
+ JHipsterModuleProperties properties = propertiesBuilder(tmpDirForTest()).build();
+
+ JHipsterModule module = factory.buildBackwardsCompatibilityCheckModule(properties);
+
+ assertThatModuleWithFiles(module, pomFile())
+ .hasFile("pom.xml")
+ .containing(
+ // language=xml
+ """
+ <plugin>
+ <groupId>io.kemtoa.openapi</groupId>
+ <artifactId>openapi-backwards-compat-maven-plugin</artifactId>
+ </plugin>\
+ """
+ )
+ .containing(
+ // language=xml
+ """
+ <plugin>
+ <groupId>io.kemtoa.openapi</groupId>
+ <artifactId>openapi-backwards-compat-maven-plugin</artifactId>
+ <version>${openapi-backwards-compat-maven-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>backwards-compatibility-check</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <openApiSourceDir>${project.build.directory}</openApiSourceDir>
+ </configuration>
+ </plugin>\
+ """
+ );
+ }
 }

tests-ci/generate.sh

@@ -138,6 +138,7 @@ elif [[ $application == 'fullapp' ]]; then
  "spring-boot-async" \
  "spring-boot-devtools" \
  "openapi-contract" \
+ "openapi-backwards-compatibility-check" \
  "logstash" \
  "jib" \
  "dockerfile-${java_build_tool}" \