-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Migrate Swagger to SpringDoc Depends on openrewrite/rewrite-openapi#2 * Make tests run * Change moved dependencies, not a blind remove
- Loading branch information
Showing
3 changed files
with
204 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| # | ||
| # Copyright 2024 the original author or authors. | ||
| # <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. | ||
| # | ||
|
|
||
| type: specs.openrewrite.org/v1beta/recipe | ||
| name: org.openrewrite.java.springdoc.SwaggerToSpringDoc | ||
| displayName: Migrate from Swagger to SpringDoc and OpenAPI | ||
| description: Migrate from Swagger to SpringDoc and OpenAPI. | ||
| tags: | ||
| - swagger | ||
| - springdoc | ||
| - openapi | ||
| recipeList: | ||
| - org.openrewrite.openapi.swagger.SwaggerToOpenAPI | ||
| - org.openrewrite.java.springdoc.UpgradeSpringDoc_2 | ||
| - org.openrewrite.java.spring.DeleteSpringProperty: | ||
| propertyKey: swagger.title | ||
| - org.openrewrite.java.spring.DeleteSpringProperty: | ||
| propertyKey: swagger.description | ||
| - org.openrewrite.java.spring.DeleteSpringProperty: | ||
| propertyKey: swagger.contact | ||
| - org.openrewrite.maven.RemoveDependency: | ||
| groupId: io.swagger.core.v3 | ||
| artifactId: swagger-annotations | ||
|
|
||
| --- | ||
| type: specs.openrewrite.org/v1beta/recipe | ||
| name: org.openrewrite.java.springdoc.UpgradeSpringDoc_2 | ||
| displayName: Upgrade SpringDoc | ||
| description: Upgrade to SpringDoc v2. | ||
| tags: | ||
| - springdoc | ||
| recipeList: | ||
| # https://springdoc.org/#migrating-from-springdoc-v1 | ||
| - org.openrewrite.java.dependencies.UpgradeDependencyVersion: | ||
| groupId: org.springdoc | ||
| artifactId: "*" | ||
| newVersion: 2.3.x | ||
| # "classes/annotations changes" | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.core.SpringDocUtils | ||
| newFullyQualifiedTypeName: org.springdoc.core.utils.SpringDocUtils | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.api.annotations.ParameterObject | ||
| newFullyQualifiedTypeName: org.springdoc.core.annotations.ParameterObject | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.core.GroupedOpenApi | ||
| newFullyQualifiedTypeName: org.springdoc.core.models.GroupedOpenApi | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomiser | ||
| newFullyQualifiedTypeName: org.springdoc.core.customizers.OpenApiCustomizer | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.core.Constants | ||
| newFullyQualifiedTypeName: org.springdoc.core.utils.Constants | ||
| - org.openrewrite.java.ChangeType: | ||
| oldFullyQualifiedTypeName: org.springdoc.core.SwaggerUiConfigParameters | ||
| newFullyQualifiedTypeName: org.springdoc.core.properties.SwaggerUiConfigParameters | ||
| # "The following table describes the main modules changes" | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-common | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-data-rest | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-groovy | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-hateoas | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-javadoc | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-kotlin | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-security | ||
| newArtifactId: springdoc-openapi-starter-common | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-webmvc-core | ||
| newArtifactId: springdoc-openapi-starter-webmvc-api | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-webflux-core | ||
| newArtifactId: springdoc-openapi-starter-webflux-api | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-ui | ||
| newArtifactId: springdoc-openapi-starter-webmvc-ui | ||
| - org.openrewrite.java.dependencies.ChangeDependency: | ||
| oldGroupId: org.springdoc | ||
| oldArtifactId: springdoc-openapi-webflux-ui | ||
| newArtifactId: springdoc-openapi-starter-webflux-ui |
80 changes: 80 additions & 0 deletions
80
src/test/java/org/openrewrite/java/springdoc/SwaggerToSpringDocTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * Copyright 2024 the original author or authors. | ||
| * <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 org.openrewrite.java.springdoc; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.openrewrite.DocumentExample; | ||
| import org.openrewrite.test.RecipeSpec; | ||
| import org.openrewrite.test.RewriteTest; | ||
|
|
||
| import java.util.regex.Pattern; | ||
|
|
||
| import static org.openrewrite.maven.Assertions.pomXml; | ||
|
|
||
| class SwaggerToSpringDocTest implements RewriteTest { | ||
| @Override | ||
| public void defaults(RecipeSpec spec) { | ||
| spec.recipeFromResources("org.openrewrite.java.springdoc.SwaggerToSpringDoc"); | ||
| } | ||
|
|
||
| @Test | ||
| @DocumentExample | ||
| void upgradeMaven() { | ||
| rewriteRun( | ||
| // language=xml | ||
| pomXml( | ||
| """ | ||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>example</artifactId> | ||
| <version>1.0-SNAPSHOT</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.springdoc</groupId> | ||
| <artifactId>springdoc-openapi</artifactId> | ||
| <version>1.5.13</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
| """, | ||
| after -> after.after(actual -> { | ||
| String version = Pattern.compile("<version>(2\\.3\\..*)</version>") | ||
| .matcher(actual) | ||
| .results() | ||
| .map(m -> m.group(1)) | ||
| .findFirst() | ||
| .orElseThrow(); | ||
| return """ | ||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>org.example</groupId> | ||
| <artifactId>example</artifactId> | ||
| <version>1.0-SNAPSHOT</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.springdoc</groupId> | ||
| <artifactId>springdoc-openapi</artifactId> | ||
| <version>%s</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> | ||
| """.formatted(version); | ||
| }) | ||
| ) | ||
| ); | ||
| } | ||
| } |