From a1b6f14d46ecbe1014cd4eea340ba1a99cc7ca58 Mon Sep 17 00:00:00 2001 From: Vasily Pelikh <2010720+vpelikh@users.noreply.github.com> Date: Tue, 25 Aug 2026 22:41:41 +0300 Subject: [PATCH 1/2] Add springdoc-openapi Gradle + Maven generator plugins Generate the OpenAPI JSON/YAML spec from a Spring Boot app without keeping a web server running, supporting WebFlux (reactive) and WebMvc (servlet). - springdoc-openapi-generator-worker: shared thin worker whose entry point GeneratorWorkerMain detects the app's web stack from the fork classpath and dispatches to GeneratorWorkerWebFlux (REACTIVE, no port bound via a no-op ReactiveWebServerFactory) or GeneratorWorkerWebMvc (SERVLET, ephemeral port 0, shut down immediately). Writes the JSON/YAML atomically and fails fast on an unsupported format. - springdoc-openapi-gradle-plugin: standalone Gradle plugin exposing openApiGenerate { mainClass, outputDir, outputFileName, format, timeoutSeconds, systemProperties, skip }. Forks the worker with the Java toolchain's launcher and a configurable fork timeout. - springdoc-openapi-maven-plugin: 'generate' Mojo (springdoc.skip supported) that resolves the worker and transitive deps via Aether and forks it against the project's runtime classpath. - systemProperties escape hatch for infra-dependent apps (e.g. JPA/Hibernate) via a generation-time profile/overrides. - The Gradle fork classpath carries only the worker jar (matching the Maven Mojo) so a WebMvc app's servlet stack detection is never flipped by a webflux-api safety-net; the app's own runtime classpath provides its stack. - Registered worker and plugin in springdoc-openapi-bom; per-module gitignore. --- pom.xml | 2 + springdoc-openapi-bom/pom.xml | 10 + springdoc-openapi-generator-worker/.gitignore | 144 ++++++++++ springdoc-openapi-generator-worker/pom.xml | 53 ++++ .../generator/GeneratorWorkerMain.java | 53 ++++ .../generator/GeneratorWorkerWebFlux.java | 101 +++++++ .../generator/GeneratorWorkerWebMvc.java | 94 +++++++ .../NoOpReactiveWebServerFactory.java | 40 +++ .../org/springdoc/generator/WriteUtils.java | 48 ++++ springdoc-openapi-gradle-plugin/.gitignore | 144 ++++++++++ springdoc-openapi-gradle-plugin/README.md | 155 +++++++++++ springdoc-openapi-gradle-plugin/build.gradle | 66 +++++ .../gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 48462 bytes .../gradle/wrapper/gradle-wrapper.properties | 9 + springdoc-openapi-gradle-plugin/gradlew | 248 ++++++++++++++++++ springdoc-openapi-gradle-plugin/gradlew.bat | 82 ++++++ .../settings.gradle | 1 + .../gradle/OpenApiGenerateExtension.java | 68 +++++ .../gradle/SpringDocOpenApiGradlePlugin.java | 108 ++++++++ .../gradle/tasks/GenerateOpenApiTask.java | 187 +++++++++++++ ...springdoc-openapi-gradle-plugin.properties | 1 + ...gDocOpenApiGradlePluginFunctionalTest.java | 214 +++++++++++++++ .../src/main/java/test/PetController.java | 22 ++ .../src/main/java/test/SampleApp.java | 10 + .../src/main/java/test/PetController.java | 19 ++ .../src/main/java/test/SampleApp.java | 9 + springdoc-openapi-maven-plugin/.gitignore | 144 ++++++++++ springdoc-openapi-maven-plugin/README.md | 119 +++++++++ springdoc-openapi-maven-plugin/pom.xml | 81 ++++++ .../src/it/generate-jpa/pom.xml | 61 +++++ .../it/generate-jpa/src/main/java/it/App.java | 9 + .../it/generate-jpa/src/main/java/it/Pet.java | 31 +++ .../src/main/java/it/PetController.java | 21 ++ .../src/it/generate-jpa/verify.groovy | 21 ++ .../src/it/generate-skip/pom.xml | 46 ++++ .../generate-skip/src/main/java/it/App.java | 9 + .../src/main/java/it/PetController.java | 19 ++ .../src/it/generate-skip/verify.groovy | 16 ++ .../src/it/generate-webflux/pom.xml | 45 ++++ .../src/main/java/it/App.java | 9 + .../src/main/java/it/PetController.java | 19 ++ .../src/it/generate-webflux/verify.groovy | 15 ++ .../src/it/generate-webmvc/pom.xml | 48 ++++ .../generate-webmvc/src/main/java/it/App.java | 9 + .../src/main/java/it/PetController.java | 18 ++ .../src/it/generate-webmvc/verify.groovy | 15 ++ .../src/it/generate-yaml/pom.xml | 46 ++++ .../generate-yaml/src/main/java/it/App.java | 9 + .../src/main/java/it/PetController.java | 19 ++ .../src/it/generate-yaml/verify.groovy | 24 ++ .../springdoc/maven/GenerateOpenApiMojo.java | 236 +++++++++++++++++ 51 files changed, 2977 insertions(+) create mode 100644 springdoc-openapi-generator-worker/.gitignore create mode 100644 springdoc-openapi-generator-worker/pom.xml create mode 100644 springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerMain.java create mode 100644 springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebFlux.java create mode 100644 springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebMvc.java create mode 100644 springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/NoOpReactiveWebServerFactory.java create mode 100644 springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/WriteUtils.java create mode 100644 springdoc-openapi-gradle-plugin/.gitignore create mode 100644 springdoc-openapi-gradle-plugin/README.md create mode 100644 springdoc-openapi-gradle-plugin/build.gradle create mode 100644 springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.jar create mode 100644 springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.properties create mode 100755 springdoc-openapi-gradle-plugin/gradlew create mode 100644 springdoc-openapi-gradle-plugin/gradlew.bat create mode 100644 springdoc-openapi-gradle-plugin/settings.gradle create mode 100644 springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/OpenApiGenerateExtension.java create mode 100644 springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/SpringDocOpenApiGradlePlugin.java create mode 100644 springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/tasks/GenerateOpenApiTask.java create mode 100644 springdoc-openapi-gradle-plugin/src/main/resources/springdoc-openapi-gradle-plugin.properties create mode 100644 springdoc-openapi-gradle-plugin/src/test/java/org/springdoc/gradle/SpringDocOpenApiGradlePluginFunctionalTest.java create mode 100644 springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/PetController.java create mode 100644 springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/SampleApp.java create mode 100644 springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/PetController.java create mode 100644 springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/SampleApp.java create mode 100644 springdoc-openapi-maven-plugin/.gitignore create mode 100644 springdoc-openapi-maven-plugin/README.md create mode 100644 springdoc-openapi-maven-plugin/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-jpa/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/App.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/Pet.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/PetController.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-jpa/verify.groovy create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-skip/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/App.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/PetController.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-skip/verify.groovy create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webflux/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/App.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/PetController.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webflux/verify.groovy create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webmvc/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/App.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/PetController.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-webmvc/verify.groovy create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-yaml/pom.xml create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/App.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/PetController.java create mode 100644 springdoc-openapi-maven-plugin/src/it/generate-yaml/verify.groovy create mode 100644 springdoc-openapi-maven-plugin/src/main/java/org/springdoc/maven/GenerateOpenApiMojo.java diff --git a/pom.xml b/pom.xml index e1e1e50b2..b155e61ae 100644 --- a/pom.xml +++ b/pom.xml @@ -50,6 +50,8 @@ springdoc-openapi-starter-webmvc-mcp springdoc-openapi-starter-webflux-mcp springdoc-openapi-bom + springdoc-openapi-generator-worker + springdoc-openapi-maven-plugin springdoc-openapi-tests diff --git a/springdoc-openapi-bom/pom.xml b/springdoc-openapi-bom/pom.xml index 7ab6f6b8d..d49f9ff75 100644 --- a/springdoc-openapi-bom/pom.xml +++ b/springdoc-openapi-bom/pom.xml @@ -60,6 +60,16 @@ springdoc-openapi-starter-webflux-mcp ${project.version} + + io.github.vpelikh + springdoc-openapi-generator-worker + ${project.version} + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${project.version} + diff --git a/springdoc-openapi-generator-worker/.gitignore b/springdoc-openapi-generator-worker/.gitignore new file mode 100644 index 000000000..ab21548c1 --- /dev/null +++ b/springdoc-openapi-generator-worker/.gitignore @@ -0,0 +1,144 @@ +###################### +# Project Specific +###################### +/target/www/** +/src/test/javascript/coverage/ + +###################### +# Node +###################### +/node/ +node_tmp/ +node_modules/ +npm-debug.log.* +/.awcache/* +/.cache-loader/* + +###################### +# SASS +###################### +.sass-cache/ + +###################### +# Eclipse +###################### +*.pydevproject +.project +.metadata +tmp/ +tmp/**/* +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath +.factorypath +/src/main/resources/rebel.xml + +# External tool builders +.externalToolBuilders/** + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + +###################### +# Intellij +###################### +.idea/ +*.iml +*.iws +*.ipr +*.ids +*.orig +classes/ +out/ + +###################### +# Visual Studio Code +###################### +.vscode/ + +###################### +# Maven +###################### +/log/ +/target/ + +###################### +# Gradle +###################### +.gradle/ +/build/ + +###################### +# Package Files +###################### +*.jar +*.war +*.ear +*.db + +###################### +# Windows +###################### +# Windows image file caches +Thumbs.db + +# Folder config file +Desktop.ini + +###################### +# Mac OSX +###################### +.DS_Store +.svn + +# Thumbnails +._* + +# Files that might appear on external disk +.Spotlight-V100 +.Trashes + +###################### +# Directories +###################### +/bin/ +/deploy/ + +###################### +# Logs +###################### +*.log* + +###################### +# Others +###################### +*.class +*.*~ +*~ +.merge_file* + +###################### +# Gradle Wrapper +###################### +!gradle/wrapper/gradle-wrapper.jar + +###################### +# Maven Wrapper +###################### +!.mvn/wrapper/maven-wrapper.jar + +###################### +# ESLint +###################### +.eslintcache \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/pom.xml b/springdoc-openapi-generator-worker/pom.xml new file mode 100644 index 000000000..cbbaf3fe1 --- /dev/null +++ b/springdoc-openapi-generator-worker/pom.xml @@ -0,0 +1,53 @@ + + 4.0.0 + + io.github.vpelikh + springdoc-openapi + 5.0.6-SNAPSHOT + + springdoc-openapi-generator-worker + ${project.artifactId} + Shared forked-JVM worker that boots a Spring Boot reactive or servlet context, runs springdoc-openapi, and writes the OpenAPI document. Used by the Gradle and Maven generator plugins. + + + + + io.github.vpelikh + springdoc-openapi-starter-webflux-api + ${project.version} + provided + + + io.github.vpelikh + springdoc-openapi-starter-webmvc-api + ${project.version} + provided + + + org.springframework.boot + spring-boot + provided + + + org.springframework.boot + spring-boot-web-server + provided + + + + jakarta.servlet + jakarta.servlet-api + provided + + + + org.springframework + spring-test + + + \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerMain.java b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerMain.java new file mode 100644 index 000000000..058e56a2d --- /dev/null +++ b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerMain.java @@ -0,0 +1,53 @@ +package org.springdoc.generator; + +/** + * Entry point for the generator worker, run in a forked JVM by the Gradle and Maven plugins. + *

+ * It detects the target application's web stack from the fork classpath (the app's own + * dependencies are on it) and delegates to the matching worker: + *

+ * The two worker classes are only loaded when selected. Because the JVM resolves constant-pool + * references lazily, the non-selected worker is never loaded on a fork that lacks that stack, so + * this works on WebFlux-only and WebMvc-only classpaths alike. + *

+ * When both stacks are on the classpath (a mixed application), WebMvc (servlet) wins, matching + * {@code SpringApplication}'s {@code WebApplicationType.deduceFromClasspath}. + *

+ * Arguments: {@code [outputFileName] [format]} + */ +public final class GeneratorWorkerMain { + + private GeneratorWorkerMain() { + } + + public static void main(String[] args) throws Exception { + if (args.length < 2) { + throw new IllegalArgumentException( + "Usage: GeneratorWorkerMain [outputFileName] [format]"); + } + // Spring Boot prefers servlet when both stacks are present, so check WebMvc first. + if (isOnClasspath("org.springframework.web.servlet.DispatcherServlet")) { + GeneratorWorkerWebMvc.main(args); + } + else if (isOnClasspath("org.springframework.web.reactive.DispatcherHandler")) { + GeneratorWorkerWebFlux.main(args); + } + else { + throw new IllegalStateException( + "Could not detect a WebMvc or WebFlux stack on the application classpath."); + } + } + + private static boolean isOnClasspath(String className) { + try { + Class.forName(className, false, GeneratorWorkerMain.class.getClassLoader()); + return true; + } + catch (ClassNotFoundException e) { + return false; + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebFlux.java b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebFlux.java new file mode 100644 index 000000000..976fc874c --- /dev/null +++ b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebFlux.java @@ -0,0 +1,101 @@ +package org.springdoc.generator; + +import org.springdoc.webflux.api.OpenApiWebfluxResource; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.web.server.reactive.ReactiveWebServerFactory; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.server.reactive.ServerHttpRequest; +import org.springframework.mock.http.server.reactive.MockServerHttpRequest; + +import java.nio.file.Path; +import java.util.Locale; +import java.util.Map; + +/** + * Workers that boot a WebFlux (reactive) Spring Boot application, let springdoc-openapi + * build the OpenAPI document, write it to disk, and shut the context down. Runs in a forked JVM. + *

+ * A no-op {@link ReactiveWebServerFactory} is registered so springdoc's + * {@code @ConditionalOnWebApplication} activates without ever binding a port. + */ +public class GeneratorWorkerWebFlux { + + @Configuration + static class NoServerConfiguration { + + @Bean + @ConditionalOnMissingBean(ReactiveWebServerFactory.class) + ReactiveWebServerFactory reactiveWebServerFactory() { + return new NoOpReactiveWebServerFactory(); + } + } + + public static void main(String[] args) throws Exception { + if (args.length < 2) { + throw new IllegalArgumentException( + "Usage: GeneratorWorkerWebFlux [outputFileName] [format]"); + } + String mainClass = args[0]; + String outputDir = args[1]; + String outputFileName = args.length > 2 ? args[2] : "openapi"; + String format = args.length > 3 ? args[3] : "json"; + validateFormat(format); + new GeneratorWorkerWebFlux().generate(mainClass, outputDir, outputFileName, format); + } + + public void generate(String mainClass, String outputDir, String outputFileName, String format) throws Exception { + SpringApplication app = new SpringApplication(Class.forName(mainClass)); + app.setWebApplicationType(WebApplicationType.REACTIVE); + app.addPrimarySources(java.util.List.of(NoServerConfiguration.class)); + app.setDefaultProperties(Map.of("spring.main.banner-mode", "off")); + + ConfigurableApplicationContext context = null; + try { + context = app.run(); + OpenApiWebfluxResource resource = context.getBean(OpenApiWebfluxResource.class); + ServerHttpRequest request = MockServerHttpRequest.get("http://localhost/v3/api-docs").build(); + String lower = format.toLowerCase(Locale.ROOT); + byte[] bytes; + if (isYaml(lower)) { + bytes = resource.openapiYaml(request, "/v3/api-docs", Locale.ENGLISH).block(); + } + else { + bytes = resource.openapiJson(request, "/v3/api-docs", Locale.ENGLISH).block(); + } + if (bytes == null || bytes.length == 0) { + throw new IllegalStateException("OpenAPI generation returned no content"); + } + String ext = isYaml(lower) ? "yaml" : "json"; + Path out = Path.of(outputDir).resolve(outputFileName + "." + ext); + WriteUtils.writeAtomic(out, bytes); + System.out.println("Generated OpenAPI spec at " + out.toAbsolutePath()); + } + finally { + if (context != null) { + context.close(); + } + } + } + + private static boolean isYaml(String lower) { + return "yaml".equals(lower) || "yml".equals(lower); + } + + /** + * Validates a user-supplied {@code format} argument. Only {@code json}, {@code yaml}, + * {@code yml} are supported; anything else is rejected rather than silently falling back + * to JSON output (which would produce a document in a format the user did not ask for). + */ + private static void validateFormat(String format) { + String lower = format.toLowerCase(Locale.ROOT); + boolean valid = "json".equals(lower) || "yaml".equals(lower) || "yml".equals(lower); + if (!valid) { + throw new IllegalArgumentException( + "Unsupported format '" + format + "'. Supported formats: json, yaml, yml."); + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebMvc.java b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebMvc.java new file mode 100644 index 000000000..2a9a444ec --- /dev/null +++ b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/GeneratorWorkerWebMvc.java @@ -0,0 +1,94 @@ +package org.springdoc.generator; + +import org.springdoc.webmvc.api.OpenApiWebMvcResource; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.WebApplicationType; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.mock.web.MockHttpServletRequest; + +import java.nio.file.Path; +import java.util.Locale; +import java.util.Map; + +/** + * Worker that boots a WebMvc (servlet) Spring Boot application, lets springdoc-openapi + * build the OpenAPI document, write it to disk, and shut the context down. Runs in a forked JVM. + *

+ * Unlike WebFlux, the servlet model requires a real servlet container (the DispatcherServlet must + * be able to register in it). To honor "generate without starting the serial server" as closely as + * the servlet model allows, the embedded container is bound to an ephemeral port (0) and the + * context is shut down immediately after generation, so no port is exposed and nothing stays + * listening. + */ +public class GeneratorWorkerWebMvc { + + public static void main(String[] args) throws Exception { + if (args.length < 2) { + throw new IllegalArgumentException( + "Usage: GeneratorWorkerWebMvc [outputFileName] [format]"); + } + String mainClass = args[0]; + String outputDir = args[1]; + String outputFileName = args.length > 2 ? args[2] : "openapi"; + String format = args.length > 3 ? args[3] : "json"; + validateFormat(format); + new GeneratorWorkerWebMvc().generate(mainClass, outputDir, outputFileName, format); + } + + public void generate(String mainClass, String outputDir, String outputFileName, String format) throws Exception { + SpringApplication app = new SpringApplication(Class.forName(mainClass)); + app.setWebApplicationType(WebApplicationType.SERVLET); + // Bind an ephemeral port; the context stops immediately after generation. + app.setDefaultProperties(Map.of( + "server.port", "0", + "spring.main.banner-mode", "off")); + + ConfigurableApplicationContext context = null; + try { + context = app.run(); + OpenApiWebMvcResource resource = context.getBean(OpenApiWebMvcResource.class); + MockHttpServletRequest request = new MockHttpServletRequest("GET", "/v3/api-docs"); + request.setScheme("http"); + request.setServerName("localhost"); + request.setServerPort(80); + String lower = format.toLowerCase(Locale.ROOT); + byte[] bytes; + if (isYaml(lower)) { + bytes = resource.openapiYaml(request, "/v3/api-docs", Locale.ENGLISH); + } + else { + bytes = resource.openapiJson(request, "/v3/api-docs", Locale.ENGLISH); + } + if (bytes == null || bytes.length == 0) { + throw new IllegalStateException("OpenAPI generation returned no content"); + } + String ext = isYaml(lower) ? "yaml" : "json"; + Path out = Path.of(outputDir).resolve(outputFileName + "." + ext); + WriteUtils.writeAtomic(out, bytes); + System.out.println("Generated OpenAPI spec at " + out.toAbsolutePath()); + } + finally { + if (context != null) { + context.close(); + } + } + } + + private static boolean isYaml(String lower) { + return "yaml".equals(lower) || "yml".equals(lower); + } + + /** + * Validates a user-supplied {@code format} argument. Only {@code json}, {@code yaml}, + * {@code yml} are supported; anything else is rejected rather than silently falling back + * to JSON output (which would produce a document in a format the user did not ask for). + */ + private static void validateFormat(String format) { + String lower = format.toLowerCase(Locale.ROOT); + boolean valid = "json".equals(lower) || "yaml".equals(lower) || "yml".equals(lower); + if (!valid) { + throw new IllegalArgumentException( + "Unsupported format '" + format + "'. Supported formats: json, yaml, yml."); + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/NoOpReactiveWebServerFactory.java b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/NoOpReactiveWebServerFactory.java new file mode 100644 index 000000000..08bb8ea24 --- /dev/null +++ b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/NoOpReactiveWebServerFactory.java @@ -0,0 +1,40 @@ +package org.springdoc.generator; + +import org.springframework.boot.web.server.WebServer; +import org.springframework.boot.web.server.WebServerException; +import org.springframework.boot.web.server.reactive.ReactiveWebServerFactory; +import org.springframework.http.server.reactive.HttpHandler; + +/** + * A {@link ReactiveWebServerFactory} that produces a no-op {@link WebServer}. Registering this + * satisfies Spring Boot's reactive web auto-configuration (so {@code @ConditionalOnWebApplication} + * still activates springdoc) while never binding any port: {@code WebServer.start()} is a no-op. + */ +final class NoOpReactiveWebServerFactory implements ReactiveWebServerFactory { + + @Override + public WebServer getWebServer(HttpHandler httpHandler) { + return new NoOpWebServer(); + } + + /** + * A {@link WebServer} whose lifecycle methods do nothing, so no server ever binds a port. + */ + private static final class NoOpWebServer implements WebServer { + + @Override + public void start() throws WebServerException { + // intentionally do not bind any port + } + + @Override + public void stop() throws WebServerException { + // nothing to stop + } + + @Override + public int getPort() { + return 0; + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/WriteUtils.java b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/WriteUtils.java new file mode 100644 index 000000000..bb5b91a13 --- /dev/null +++ b/springdoc-openapi-generator-worker/src/main/java/org/springdoc/generator/WriteUtils.java @@ -0,0 +1,48 @@ +package org.springdoc.generator; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; + +/** + * File-writing helpers for the generator workers. + */ +final class WriteUtils { + + private WriteUtils() { + } + + /** + * Writes {@code bytes} to {@code target} atomically where the underlying filesystem supports + * it. The bytes are first written to a temporary sibling file, then moved over the target. + * This guarantees the final output path only ever contains a complete document: if the fork is + * killed mid-write (e.g. the plugin's fork timeout) or the write fails, no partial or corrupt + * file is left at {@code target}. + * + * @throws IOException if the write or the move fails + */ + static void writeAtomic(Path target, byte[] bytes) throws IOException { + Path dir = target.getParent(); + if (dir == null) { + dir = Path.of("."); + } + Files.createDirectories(dir); + Path tmp = Files.createTempFile(dir, target.getFileName().toString(), ".tmp"); + try { + Files.write(tmp, bytes); + try { + // Atomic within the same directory when the (default) filesystem supports it. + Files.move(tmp, target, StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE); + } + catch (java.nio.file.AtomicMoveNotSupportedException e) { + // Fall back to a best-effort atomic (same-dir) move for non-atomic filesystems. + Files.move(tmp, target, StandardCopyOption.REPLACE_EXISTING); + } + } + finally { + // If anything failed before the move, leave no temp debris behind. + Files.deleteIfExists(tmp); + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/.gitignore b/springdoc-openapi-gradle-plugin/.gitignore new file mode 100644 index 000000000..ab21548c1 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/.gitignore @@ -0,0 +1,144 @@ +###################### +# Project Specific +###################### +/target/www/** +/src/test/javascript/coverage/ + +###################### +# Node +###################### +/node/ +node_tmp/ +node_modules/ +npm-debug.log.* +/.awcache/* +/.cache-loader/* + +###################### +# SASS +###################### +.sass-cache/ + +###################### +# Eclipse +###################### +*.pydevproject +.project +.metadata +tmp/ +tmp/**/* +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath +.factorypath +/src/main/resources/rebel.xml + +# External tool builders +.externalToolBuilders/** + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + +###################### +# Intellij +###################### +.idea/ +*.iml +*.iws +*.ipr +*.ids +*.orig +classes/ +out/ + +###################### +# Visual Studio Code +###################### +.vscode/ + +###################### +# Maven +###################### +/log/ +/target/ + +###################### +# Gradle +###################### +.gradle/ +/build/ + +###################### +# Package Files +###################### +*.jar +*.war +*.ear +*.db + +###################### +# Windows +###################### +# Windows image file caches +Thumbs.db + +# Folder config file +Desktop.ini + +###################### +# Mac OSX +###################### +.DS_Store +.svn + +# Thumbnails +._* + +# Files that might appear on external disk +.Spotlight-V100 +.Trashes + +###################### +# Directories +###################### +/bin/ +/deploy/ + +###################### +# Logs +###################### +*.log* + +###################### +# Others +###################### +*.class +*.*~ +*~ +.merge_file* + +###################### +# Gradle Wrapper +###################### +!gradle/wrapper/gradle-wrapper.jar + +###################### +# Maven Wrapper +###################### +!.mvn/wrapper/maven-wrapper.jar + +###################### +# ESLint +###################### +.eslintcache \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/README.md b/springdoc-openapi-gradle-plugin/README.md new file mode 100644 index 000000000..243c497c1 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/README.md @@ -0,0 +1,155 @@ +# springdoc-openapi-gradle-plugin + +A Gradle plugin that generates the [OpenAPI](https://swagger.io/specification/) specification +for a Spring Boot application without leaving a web server running. It forks a dedicated JVM and +supports both stacks with no per-stack config; the worker detects the target app's stack from its +classpath and dispatches to the matching generator. + +## Important: WebFlux vs WebMvc + +> **WebFlux (reactive) — genuinely serverless.** A no-op `ReactiveWebServerFactory` keeps springdoc +> active and **no port is ever bound**. This fully honors the "generate without starting the app" +> goal. +> +> **WebMvc (servlet) — starts a real, ephemeral server.** The servlet model requires an actual +> container (the `DispatcherServlet` must register in a `ServletContext`), so generation boots the +> embedded server on an **ephemeral port (0)** and shuts the context down immediately after writing +> the spec. No fixed/exposed port is used and nothing stays listening, but a real container does +> briefly start. This is a servlet-model constraint, not a plugin choice. + +## Status + +Feature/experimental. Open for review on branch `feature/openapi-gradle-plugin`. + +## Project layout + +``` +springdoc-openapi-gradle-plugin/ (this Gradle build, the plugin) + src/main/java/org/springdoc/gradle/ plugin, extension, task + src/test/... Gradle TestKit functional test + sample app +``` + +The actual JVM worker (`springdoc-openapi-generator-worker`, which boots the app and writes the +spec) lives in a sibling Maven module shared with the Maven plugin, so both build systems use a +single implementation rather than duplicating it. + +## Usage + +Apply the plugin to the Gradle project containing your Spring Boot application and set the main +class: + +```groovy +plugins { + id 'java' + id 'io.github.vpelikh.springdoc-openapi-gradle-plugin' version '5.0.6-SNAPSHOT' +} + +repositories { + mavenLocal() + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-webflux:4.1.1' + implementation 'io.github.vpelikh:springdoc-openapi-starter-webflux-api:5.0.6-SNAPSHOT' +} + +openApiGenerate { + mainClass = 'com.example.YourApplication' +} +``` + +Then: + +``` +./gradlew generateOpenApi +``` + +The spec is written to `build/docs/openapi.json` by default. + +## Extension options (`openApiGenerate { ... }`) + +| Property | Type | Default | Description | +|----------------|----------|------------------|-----------------------------------------------| +| `mainClass` | `String` | *required* | `@SpringBootApplication` class to boot | +| `outputDir` | `File` | `build/docs` | Directory for the generated document | +| `outputFileName`| `String` | `openapi` | Base file name (`.json` / `.yaml` appended) | +| `format` | `String` | `json` | `json` or `yaml` | +| `timeoutSeconds`| `int` | `120` | Worker time bound; aborts the fork on timeout | +| `skip` | `boolean`| `false` | Skip `generateOpenApi` entirely | +| `systemProperties`| `Map` | `{}` | Extra `-D` props for the worker JVM | + +## How it works + +The plugin: + +1. Resolves the application's `runtimeClasspath` plus a small `springdocGenerator` configuration + carrying only the fork's worker JAR and its transitive runtime deps. The relevant springdoc + stack API (`webflux-api` or `webmvc-api`) comes from the application's own dependencies, so the + fork classpath matches the Maven Mojo's and never forces a stack onto the process. +2. Forks a JVM (`java -cp org.springdoc.gradle.GeneratorWorkerMain ...`). +3. Inside that JVM the worker boots the application with `WebApplicationType.REACTIVE` and + registers a **no-op `ReactiveWebServerFactory`** (a `WebServer` whose `start()` does nothing), + so the reactive web context exists for springdoc but **no port is ever bound**. +4. It invokes springdoc's existing `OpenApiWebfluxResource` (with a mock request) to produce the + JSON/YAML document, writes it to the configured output, and closes the context. +5. The plugin task is `@Cacheable`, so unchanged inputs are up-to-date. + +## Building & testing + +From this directory: + +``` +./gradlew test # TestKit functional test +``` + +The functional test boots the bundled sample reactive app and asserts the generated document +contains the `/pets` paths. + +## Notes / limitations + +- Uses the fork's modules (`io.github.vpelikh:springdoc-openapi-starter-webflux-api` / + `springdoc-openapi-starter-webmvc-api`) at `5.0.6-SNAPSHOT`; install them and the shared + `springdoc-openapi-generator-worker` into `~/.m2` (via the root Maven build) first. +- Supports both WebFlux (reactive, fully serverless) and WebMvc (servlet, ephemeral auto-stopped + embedded server). The stack is detected automatically from the app's classpath. +- **WebFlux "no port bound" caveat:** the no-op `ReactiveWebServerFactory` is registered with + `@ConditionalOnMissingBean`. If the application itself defines a `ReactiveWebServerFactory` bean, + that one wins and a real server can bind a port at generation time. This is rare (configuring the + server via a `WebServerFactoryCustomizer` does not define a factory bean and is unaffected). To + guarantee no port is bound, avoid defining such a bean or use `@OpenAPIDefinition(...)` to control + the generated spec instead. +- The shared worker declares `spring-test` as a runtime dependency solely to build mock + `ServerHttpRequest` / `HttpServletRequest`; it is pulled onto the fork classpath but never + bundled into the worker jar. +- The `generateOpenApi` task is `@Cacheable`; its `javaExecutable` input is absolute (toolchain + path), so remote build-cache hits are machine-specific. +- The fork-invocation logic (build `java -cp`, stream output, time out) is intentionally kept small + and duplicated in the Gradle task and Maven Mojo rather than extracted into a shared helper, to + avoid coupling the plugins to the worker jar's compile classpath. The shared worker still owns + the actual generation. +- The offline spec's `servers` entry defaults to `http://localhost` (WebMvc) / a mock URL + (WebFlux). Set `@OpenAPIDefinition(servers = @Server(...))` or a global `OpenApiCustomizer` to + override it for your deployment. + +### Generating apps that need infrastructure + +The worker boots the application's real context, so beans that need external resources (a +database, JMS broker, external service) must be satisfiable at generation time. For example, a +JPA/Hibernate app with no reachable database will fail to refresh. + +Use `systemProperties` to point generation at a test profile/overrides, exactly like a test: + +```groovy +openApiGenerate { + mainClass = 'com.example.App' + systemProperties = [ + 'spring.profiles.active': 'generation', + 'spring.autoconfigure.exclude': + 'org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration' + ] +} +``` + +Spring Boot still reads `@Entity`/JPA annotations off the classpath, so the OpenAPI spec is +correct while no real database connection is needed. \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/build.gradle b/springdoc-openapi-gradle-plugin/build.gradle new file mode 100644 index 000000000..2de8547e0 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/build.gradle @@ -0,0 +1,66 @@ +// * * * * * * * * * * * * +// Plugins +// * * * * * * * * * * * * +plugins { + id 'java-gradle-plugin' + id 'maven-publish' +} + +// * * * * * * * * * * * * +// Project configuration +// * * * * * * * * * * * * + +group = 'io.github.vpelikh' +version = '5.0.6-SNAPSHOT' + +repositories { + mavenLocal() + mavenCentral() + maven { + url = 'https://central.sonatype.com/repository/maven-snapshots/' + } +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +compileJava { + options.release = 17 +} + +dependencies { + implementation gradleApi() + + testImplementation gradleTestKit() + testImplementation 'org.junit.jupiter:junit-jupiter:5.11.4' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.11.4' +} + +// Filter plugin version into the properties file at build time (like swagger plugin). +processResources { + inputs.property 'pluginVersion', project.version + filteringCharset = 'UTF-8' + filesMatching('springdoc-openapi-gradle-plugin.properties') { + expand(pluginVersion: project.version) + } +} + +// * * * * * * * * * * * * +// Plugin publishing +// * * * * * * * * * * * * + +gradlePlugin { + plugins { + springdoc { + id = 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + implementationClass = 'org.springdoc.gradle.SpringDocOpenApiGradlePlugin' + } + } +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.jar b/springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..b1b8ef56b44f16b14dc800fa8103a6d89abb526f GIT binary patch literal 48462 zcma&NV{|3jwk;gnwr$(CRk3Z`Sy9Ed?Nn^ruGlsztklcC=e7I2x9>aqJFB(1eyu-q z%|3b`eLzVT6buar3JMAc2#EOW{C^)LAZQ?YaW!FjX$1*JIcZUG1yyl%HEd!6f#E+}*Jo*NafvM<-FbE0;-_L#rp}qdn%JEoAVNlEB#J^Oq`mU_#*ev4HLmc> zjXz_hFft^><#omb;Zer-%wm4hxo!wjuX3hBldg(^-RiOleKin`>KHfL3P*{k?(rji(#j2Cc0K509#>qu=-T&B!-5EBi(+ zIuTD-qfcAYgS@`Fb2^-p)4#o6A3z0&fp?~cV=CRsAeCmO4ZQ5kKgC%0el=Q&Rhd#k zaGmAbUW8uKC}-C0s~2);d{;mpsNBx9rn__66W{AhaSvJEK+c0b6ARO+l(CI7E|S5x zhaYP--@F<|99X&)9`q^2(^-Zu^Tzfm)v|gkTJHQ!G*zIg5hzoygeXZoYUEJ;iFkE# zq^r$*c|>Hmn3GapzcDYnjgSFiO^NFyTR5AH#mh%zRToMpEi(r)1$5)h455DuV}0al z!*psWuL@Ke-2gvftfMEGf9YEi^<{B@qru zINgo+YsE&LN?)1qItJoNhISp-fZ86`XR#*6xcvM~_7=JHUX;K9*=Gu5X~ zix|O2d=&C#u_w{=B$eCpJ4L*6i7={j+{Og~`Emz@&98}6s<-p^)`0fXE4cJBP{>)Ltb>JwcqI>yz z0-r-SEhC@p)XOoh|1|XgjFaREHfsu4dAGVz*k#m+V<4 zHqvlud6=;#QWHUoTR_a8Y8+heN?M%n1@0YLiaN@GuOPNd26tik7eKulTx?mM-R!1H znB6+H{^krFXg_b{y=QeCT~qR3T4}l+b!Oz9;~|3*6F<3?#|DYYW&1RtFE)ILZ!`85 zVmvrZkLTzf31unH7Cc5E0iFShqlBE9hgEnRJH1juII*vyp&xd!g`q}X_6WT6E$hhQ`Vdp9k^<)VS?lj!cTh z7FQcQAVA@jL^cXod8cnhKG2TS9+;QU6Kq>}UOY3&TL9gXbl{Fv8@WsF=z7>X0To@$ zY@Oi1uc|MdJ$>Kn{@!g_e`-I&Tpwfg9cr>(iakDX1qciCG_1y!Di#4_)lE!bWJbrp z5aUonb6m-?tiQyR_`P#~SOu+tb_ev6JO>EbEhHK@KbeT0_FDo>dl9bMg)>xmCNB*g zG5NC8ABavuTEZVGW6jP*nAqRt3W?7Iigc-EE~zpNJXRAE z>`~RO9$892j&I1kV;9U)xT8^}IeV`n{}QDtj2o-RBt`DGZUOO;O*lFCb_vpyGh*;95PfeGu!dyrmZ9VJ3Z*upg z6R-3Lr%_55$Hw1^{+KWx0#z`T7O6sXo1h;m?B_ur`X2bFz-SzDrL zpk^@B<+I6imc@7vip za%1jMB7q@1j# zz{u?YojZMW{5j$@h=v4iu2mTu7IzI|)Sxn!74=*J>1a&?Xjt z2%JhSi#4huEcD9qdR9Lj4vwmfnL{%+vQ{f-KgYeqin(OPd8+(g*Uq#TLxQjD4 zLCL%ul(V&PAPlAx8D`@K8Rc`{GPecQ<)d=KWel0ejFeeXGQ6o7601B!!I@RY&eDriADD6wP6DcFKDLZ|lO#YwnrNCZ)zRJpdxX_nPZa4j#$j6v!h|6p!dH}MY6#B`@%6=) z-HigguDACKBULnon^FKzazF|Y1{t(U5rUGnEU|}djVsWT-F>@@mNx?_$kF51QF4C5 zStKR$^3(fw85(4HGs9{mUTtn1)3PwxTN?6}j;32&vJ^BiPHfndLkdU5sOemXKGyCZ z@<7j(k>DNeo~QXyJkFWk!7(y1SB%nA3{v~P2c8ooKa4auM!el!Q_=;lJ$c5ADqE+^ zX8*|A99v;jWPrm(8=h;2ZAj|(vVbx~wQ{N%v;eYLD_BB2LAEWCs@xauyBDl(_HIBvA(XJ7B1E;O zJYCJ8xFJh7f5sr;Y#Wp_`$4Z_H4e9bGiBp?Qu&2!@%Bl2dT5evfFO*^hLDiBu2%Jl z*WAlL5PaQ7skJa(qVysky}DQquZ8U?2@UyJ8zB#=U_E>MgE%XA$CtfL31m$rATJvC zs@!crc0=128PM=Zp zW_5Czv9))n_8Ru?{pxM2F8^r%*O41}RnONbSj*piG%`nyF>6ky=|;B&k8iot(J=kyoU3p<_zaAX(1ijzf*uXA zZ_5jeC{Lks+&QeFIlmzZi3+fsF4fNW^~kvC4Q*T-vrNP!x9xnen12lZQM=1_MdW76LKX(GuW`%T~dM^YX6+ras|Xy4Qhfcq=D+z-P-ea z`T;^gj3+grr3^hwqcNTJErl$z+k>{bYFm6QV%7Opth?9+>|Dn)O@`7F@=j-XSqGPW zjUAu%b3Er@;j1%RZxVDhI3sakg-gvTLOSV7;FV6ED=(5;UG??=WADZw^=$4AyFh#}VMe3afM^pF zFa}-nM8X=K?Jy02*o02@6k{ z%O!hBhjXlXKdhy3A{xGB<##e|j3^dFv~~%v2_H{t(mN7NVeS~51?D&Ozbxa`qwZ_4 z;C#Q#fL1sua%ggucgIEHZtcY=Ag&GgE|h7Q{77D!WUq`;SSGEE0pU;aoj<7-JCAvf zduN=(tx3Mb+EUXKoax|v;8b@#HJ&Q|!g4ryrl|R>WlAv?IH`bk)I24;eE4NIq@SLK31LD4+w~#3iN{=<`<1R!t^$@K5>U6%W=%8_ANuR5 zs(IDuI18ftirTDARnGmF%;iz+4{MlMihJw_l!0Y)NttXC_t+s)V<EY>=Xin*nGX79k6vQ?beRk zy_J>@YSC_gMIG$yjO-y&o>S6xtfT27aSs>e|`x(f2R1bM}*518~%x>1Yct=18b&Z>GiS*>VB$+i2876zL)1cT zN33g=g|>xWE2)dds5m2+8Vy)m-u@NHOlGYxxjam21r1;xWtT0TgqKZrl}*LSkqFt4 zNTI1=3o%C*!-i;iWnlca$stRdwITA1?#fD~5OIqIQAM18BwO_u>hqL&OAANiF|8rG z_IZ9mp?FA-{Gq9+Ky<#NgL1gWJixfO0ziP$4T4G>vsvqC-NQh+A64F4! z-(t<=AbPSG%`mTl6BJtH~3RmvPhQlE-EUkEoBIP(_WMN zK~Fe!siee{M*ns1hkp5(2}vX#%u+T!Abh=<_gEx_QW?h4V@B>uOCEetEe01tl)^`V z(=cOLmuOB;8&&m%_6pcyrt83UXkJ`f9I&0KxY09}RTTs!l^_7~8$tPA%Hm#&$k0;# zF;O0zCGo0IN)X~SyKDoY1DW{Ulce|V9w=ld;U`z$t$>8U!Gu8V?_LAJAudt3eI#*! z2i9~F=kP5m>!bmb%1e~b1!1gz01Py(Yw5gOsFN#o1a&d|=PpgN(#UVreY9^99I0iG zaYE@>(C^V7pnoB~#w$2C1_TIb1N5Je&iao?S2A*TF>@vpHg`31{uk<9{zf_}s&z%dL-Fo)C$yl$%pAdqU!HJgp zh_{m1imk{&{ScyeuziqZHu5cto0{S}^BlXu% z0~;>_yHGd#?Kt8ErxK)z6ojj5SacQobw)-8`c!$HOI*V6eyqou{1Upm%_p!BY^t(D zDtn(oQ!jff`ddGSD;P8Hes!v)OKW-*>mS&#i0ow87;h>(=Cu0>b4)|=EegbN5=Xkh z9Ge13=3z#sk+fT<)PuUUf_%Nx@l!P?t*mni^94p^Ax6b2SVL5U>9dHH!H4DL4}@?@ z?Gpq$C**OmWliYA{5s<|EZ@QI2{-K#brFxfA~AIqq&-WSALHWQ8}%mvaNFasrtnE{ zg=sB4-RF!?)nf{>Wo~kNFgYefoFHBcSr*;iF9B!R=5Np|jv>Uf+mcarG-XGy*kP{z zISVyoPcl_9cOg-@613Qx16OGF#sH&2NTHDa_}vyidmxS~pMfY#AeQvu?AXpWNzi7A z*6&7a7!C9HRU+N{>WYTh0GXoBnXw{lQby^XShgDOw@e8TP}9Y*oFV4MVF#@Ds2A+A zXBEt3a@-IIl)TOcXx;0P;|ihR%Tq@DXeG5p-O{!T7Sg$s1 z8OA4iOx-!>6eK^x{jU-0SvByimK|nZik5zKIvvWVGE)4=x^&5Nx%Qgje!k3VoizaB zip#?$u(R8u{wUFC>tVR8oA%7fs?xEu(gYn>y6BB%vwPR9&RoZE%%RK! zl#Qnkl^+Y*Y4L{Xk(YX&aGj|zSpqO_;C3CTepA!L#4EXO|(eA`Fi+2EQ3!C zo^SpVP?{chQ3uaxu7y>w213e22cdA#l-M2kStPE%sq6vE4M*?3At!S7tIp(tQg(Ml zECjeJw8)*#LYYk_+Txv3rxsH9jJZBRrHp29yJ(^;_PEdn%#U1q`r89}38;XeF{ee& zsZEsUbJ{LtwOjU{vjL(Wvs2!Bx;#^Mzld&TjS@oo3kk=0P36MC-Ie6eHNN&{8b^s z0@jcbdejrrj!>r#Wu=3H1dgjeOI}NkhmE}K+UK&M>%7b!n&{0Zixk%^)6#@=V~IZN zxG>9kl&STQth}qScidfg58d2dF|v_U<@+V^eE@$4x;7oS3)MvWusA?9+%rN>aY#eA_6 zic@S(@e9$9tQM-&-7>X8~#n{5G}nuOu=dSyN+b~jA;_SExZ1H9Q1A}}Rz;XtXUIOP0~ zZzS|~T+%de-nGI$s?wxaJoe+99vmo%xm8o8SNEsAqAE)4LNvHc-1AX24C4k4u3vZmov^_VcxgGxapV(8)_K(^8= z2d{xCrmk(x&514Ly?e{Mf6}h3=oeP7+ZE{%B^c-kK8g0W{tYw3q%zty_Rd@1nbnyHMwabNp-sSyzpV4v>QsnKcQjF67%g~n&3t^1MesVxCzfJ5b=SOI#YfPP^^JGQw=9L1RCMFbrU{8O0LWOUdBK#j&{`tzXX zpe2_{+-8$a+o#%8MUlL4$yK`*--z&3{@Y?jP!m{g5nM+Ht=bD3o}Ok~sBQ_!^!->! z?NDVtyLXzmGYCEmjSCDK*q?Aq1;8fz9l9|z@~l{)R6GfKELc^(nV+TjjI^n0M+S0i z@YOu*Tk>|M6a0_n$(E;#^1Zgif<-CpYiMvyT+Y*9Z?&~IKSwsLa5Q#p_?FqK3lKIw zlp6Hk%lio6)yq>m-`QT2Nj-q!aX7~Hlm^Xh6FNbw z$#ri(Kk*GUHXORu@`aYQU@ zB~S-oIO^~abRPocemkm!W73dbb!j^_xgo_@#W#6p12>w^{){VfeX?U71Xyn9&E zHa1#*!4c;?r}jv7dMN`g#&R_S215)dccDOJr=uz%LIz@zia+LIFjRakROr?P zQ|Xw0Pa8o7&W=fw17`+SqepsQ-Os5v3ncD5|N?N(AHH&`>hLY+CLOluJ z_ErpaT49zK(UcdNmQ%iA-`jS`A_1c|$W86{d_T_T2V-HH3xUqpX0QJSH%i>1i>#vK z&y{;5)^pMB=u;&_DEWakQU>j&+opIrBf~2GUh{`kG{|Z&2Z}5dwG}>Y{W_uQHaR$_ zYH%}$c`CGC-FGCetRdQ@RZ2-%ucC_|R?mHzYEnqC%u9zRBH8wx7po`=EVPMpq+hL2 zTdjVhQn$)++17^cn;<3=bxJy0Z$U;i3AqJMPJO&SuieU&0eVX?eLEEI7Av@#PV_ZQ zsa>I>B5HE996O$z6HyJfhEt^aC><@AnzeN`xs@lv>^pPFtcodrcGyqPSB?#C`Piu0 zh5=hAW|OtT9hs*G?7}@*mG_f7ae@-Nz4{qvne66kco^uD$(JbCo2ttqUm-SMy@kx% z!eDt?5>w5)M!E#C!b#Iu9GqyhUs|QoYWHtR{4espRS-LUt=viY2iygF=-j3kcU#uF z{ka2=zsOuLR}s;&PbbrB`zty&NfZpV*Y;~i*W$EH0JOGS&FMS%VK@)f*%OOrcU3P9 zq4zjhMpx}oc`PWtP!o5Bdlp=(A***TZwVwuZbuB1Pibv5uiHvW{PsE-k5IfCgUz~l z0nMeZU0R>(ajoQ0G%Il)z0BgRR*bsdz5NcqJ<)niF6|PUO0i}<4)q>6wx4K(5>Y_I z4$WMkbCOQFs(krBnl zx85i0*7%Zm(&nKNP?AQ}d~6@?D9dO%@}ouN2paSR;zyUqJuw)1SRy=g%o;g(BD|Bh ztnKV(4fcBgDJ~M@%}n-6ow3xOhnC>C^d?PbS(9=TnO)k5p+W;pu2F4eiG7ts zJVL4M(NiZPQDy*9`H>-P0GWY#=UTnh8feiNF}hCs`8^ZDKy;XIL^9K4Ps&y^#DQSE z-?J z@YOQ9NQi>ZP>^ix5K`R07kWj?`R(B?E*OyR1$Vd;8p%2Y2zEYt4CJM~gVX%MO(E1B zzXhsHn~R1ifq9~dtzuH!*3&W;r`D(Sjrc)m#EI%`Car;CMWcU0c+0r?O!)HpjEvyP zb^;pO-Bn6e-+>dS^o{q&8yEH9v}vuXX`W;NPRlwJdX|59`z?~z{pFE!^u{3k{KkJ55^ zD;F0ldy9W*`d5YP|0(E6|K%}9|D^SIq>wO)4^cJ+yCa&xl*3}hpvcQ1eP_k;@>tz= zOZnw)#fxHc81jPcTM#)jgy|0?n0(jd3IPu-lJ&Tm`#F1)o$GTwYp@dlqy-qiHFCHS zKgikMUx|%x=_%B)>n_y^+HvD2=nP`}-G_0A7)I$yc4`tXS-On8qOkNp>Q^$|Ew%Jm zYx34*(*Z3SF}xw$CA?nG9O3ZH7l)@Dp4EyH>8eXDb}AFz)k*T53iA~gRu&e15u@|% z9Rw?69nQOeJhv^^unjd-VGFwbDzf9K{i(U{xxHyM@-aI+0qP{TU0G~w+Fs>taL#Ik z4+92(Z7n%+okd478;__0GkE`&(C`k8h@?UNnM=F%A~2|TKo)q9F<5`s)KwxJRw~k; z4giS~|8AIVG;rde6I^W6m9fliR^7YT*>&x7wv^?xu(5p45n{|2F>x%?9Jq+~Tqo9# zChbeGm@9!(s;uIKae_4h@`~yIj`Tqct+-M>d>~2PCiQ?UmFUioyy&~h_DTBQ--W|q zqA^UaJMTz4tEggQ*_cQ_LA7j7bLyz8#cpGggy;YBVk!%oSdufoh5-FYAQ)v=d$Bi`G$^~ zm!O;En#M9uCykPzLZ5SHa%?hDHP5P;T4HN0L6J*r9DAvC1WWPOrd{*obfr3yJ?Kl3 z^_6dnXRoi4<$Tr!=4mhHg6ig~BatHR zv%ZMJr-`8w_JyFEzUSQdp0HT>|9QQG?IXj$7Rbx4E)%HauDyY!tedHP ztIbq;D)ckd-eirAHOG7icBH23*ApHA@nG*Jdh}~G?L5C^Xw^+nLWG+>hRi&(fnpY5 z?^hj4si6I{m1u^%i_yk$tco}28X8|}g5*tAEZYF37$f(+xT%XvO^`i^Ig}%cydrwF zlpL!xdO->&@q|8MiJrAxt;z2CP*a+EvV`_2& z<1=p{zjhmmYVkpx#RV=#zuy&7^2Trn=H$nT{OBVF*0z|QH!NxBF%gbqT!BEx zKB!SsSUwSo1Zr?kMM%N)@hG=&m`vRQ6QK6=oIvnUI+|C)dGKM@jNwqG2Xi8;YCUHYRh? zbl@DN-za)+0F9kw>Yv=ioL)01uFp7@AVEB0AH-nmB%j$RC_totFy4BKd;OPCMUMBb zu3oUUK`|{AvkM+@KPZD4Tn$(VlQi&aWV*Uf@DO|FQjLOoVw&C@z~Um*h%Ka-C=n4H z@(Lf&MDJXNS{3Hs@J)11(zo9tGp>wS^b9{Q1WN=Ktn>ZieRZS?k`gb7P4n?cl^7^* zG5-oARAG#i<*z`J0ski%;QCLD-T$AbOHq<{KxIb4=QJRn@MGj=ns0WhZX+uX z=oTjz`o-VviMt1mB0W1vA*7oq1ENz{<*-EU)U;r*ODfV!G-?hdnzhM@rRZ=|qaFTN zX*t~$gc-)M7GS{#34R-n`B)eAPfebN46~61R?j^(Pg3TXR1PyQrO7Mf@xf<3VL0`4 zh(i?-SktJu8Oj?KIy4p@%5ZH;P&p5LB8 z^}7P)9h}vUP+1Hd3nNzNcbR`%1>dSZbWhiXe-CcB+s9e)_w<{bypZ(@cQT`P@ch=d zSOPhExgI31MVFPsClEXe>$~qYQ+d}7(!BE*9y%AjQ47BMDt=#>`1ie)|ES{pFFdHa zI)CK`f3x>)DtZnm!f5=e@g;3iK^jf!RU6hpjYu^V#q0uWLuJ-6={Ua3gDi9#*P7;- z`rm*5)n{2QE{UZ01PVy@_9(amogzzOwYcVgp2>LsJ(}hKbX_!ayZ7=U{!p{BHussVj(W z2z3$zu7h$KK<%}P0YBJ+)0unV*xD&6GusXqs=M=Cl&fP@Ttzfq?>H9TW#qDId+C7? zhD;;HOxDJR4dc_xI7-b6N6nZ@bUWueDk<_9Rju2I*o(i)M0&~%C^ zc)a<25M<^NrsjAccydV2HJu_-1W>b;xrB~Mi@c7FrW-94$-GnKXvF7( zA68!d!gkIo8(URS{(u{zRtrF}B$9@*)KH9POqOW-B$za4Sg-A&PM*on$>$o#L7pH~ z&YW8oJX3T!!@2r4Rr6ac0ZDbtB1b5yc$5}7oZSDvGF0FWTpZ#r7@GfM^MmC-p{9Qj z_JmmlTxO(^(NHqBc$ECU$jQp^;)%xnyr$qvNTd`R@j$8JppDCGQAHQ7?fja9McCUZ^;``VW$1+G#=<;K{_OfH- z_$fp~S3K`;jPNNZnkB@=DFQy3{6+Bq9nOf3~dr4q8zD_t{P4-^%<4kj!U z0aj`=#@G*w?!4fpM? z8Pwb15(Ka*TtDN-2aWK>*hh{R_C}*e*vSTkHdM(ETM!JrJ=1h?(_WL}2p#QXjrKZ_ z0k_yu^;~)#*r>sQP7d_4VBRvWJCzw#TxA{*hktwQI3ST{8{>3$KHJIgMGK6I!d}Q zinmfq&RLRxX8P)_@@vVr0gPu7*)uU<%xS{|Eg;*w1}2=C&?7B zSX?OLt-gZO+<4@tLeF+K0~*|xwMD__KxWgGfsUpj)KyeCM3J-f*uxe|xk;Dlqq%1< zL(PaY@U(>Z#k!C!B45JlmE^~wHSH;r1c^kWTG9_VT~1LN6$a6Yg@kNF?&b0hs+5Dw=0j zR(wcEYmdfgojx+Hzu89*C}4$I7^?^vYKhF(`>=MC)VeeFR}}?j#XeLnp8OhW9%9ND zt6utD8DHnQj5@YJv+$USdN{8apQir2)Z{8_s!BABmG2O#pz5lSh|gf#CI8X4I|U4g zhQwk=VEV+j+-KNxuIk96Bi%^(Sf9}A7o$zHJ5mV~)qP))QQY&^>9}z9z9)PWpw>8T z7#NWNEtnUoUl{DP5(lmy<3;tpLJ3hG|;CGB`3**uH0tf9>;7w;Aq9SRVg1FDpI5y~rY#B|eCNpAXD z9692@_%$t2^nu&4lU~(~_iVf|Cs|mXs-xKlY$-~FZB$!oDK#)JgHZCG)ySDURM=@(i zCpd{Er89|l&)(&5>L6LuWY3yC6)`jPz(Po8pY=AYIBnx3y2Qx6*sT42mpR$zwx!!< zHHCc~tbF^-bje?bo#~Q59Dmw_-VcliCn^FfI*EV)U1NkNA`6Cm=^%j`%M?1Zxa=1U zn#DPNc32&XHHfUfmPx*J+3_GA&g-_pd#wO=Q^5bdhzmm)>s@yO0q|>ROV(hkhJWf@ zqWjI#+9Wx%C+!kp&kxX|XPS5m9CBC&3r>}SwdFd#YF_W78A*CN6mFC)qzOjM);Z&v z#MjdXXMw63v*tbvY+$tDmuHNFunOlRM#qe|eV&|$98!xy{n)-=N?lrkr0_}U^sz|x zs0y);(2Dooa;(9zHzRi=I{GSVcv!6jl%ck@)>JODfR? z%aI)0HvbhzY9K7eYsntq#JvWzj$WCuoyGoPY7;LSPfZlFiWU)X?(-p}s4FXQcpIp00;%Jv;k0t@2vBu4i;rh-?{z}cHTLL9Rz zT8r(1Ws*H~EyH+adP$cGv|7HkeS9p6eOEI*`idH3twkEJ*72|ey4JgISglGV0Vo@qe#)f-=|g%l$S&Onwl@mmdn|sjXXYaQ4MlfzjiK1* zY&hWQyc9?G2}2s1fYnQ}LXpq{!&Kr97d?=a?_xXAU0SXrZE?T+=9os2*v9%Csph*M zW{}m4+PIRmHEI;<=c5$PMrfg#MTs);4Tb_0**o}*cimSWRcxo(;G&&NV+-?W7v*%4ACG#t5J zQP=$g-(mN*;B6s)d9JNkF0#Zz_WA>J;{=2a!IJsiqCV!YLjJ(wUJ`3b$>qcZ!HjDT z2xm;fMSbtJ|3o~tc!jJ+U8a)vX@NcxU8y#u!Puq%R~{sps0msRFO2!GM4}786S7* zxgNmf{q@|Sdnf6_he>gEGX7Hn)uih5nL&&t4`O{?V;;bdl1U~9RAnjNmt~1UPC3mh zrR8ZtHzz1(yOYSK$OjKf;InJ+7mH$WfqI^OG3dhA+S!YmIgRv>2H78?<6A=~%E{ug^P+^b*+f=j32&Nv&Ypq?DcH&Busg^AUDE|p; z8(tQxZs1+0gUX<5~Ah zT0cGckI5%nM~d`uaMJ$o%2bt^##I0UdaQ2>-bpsP4P1Vk8r7EOSr+a!D*Z4shiKFL z35Lvs^i;#;G{%ksUUo8(Nj2DY?u5->J8kqS_#{B`HqS(UkzR|K5&6XI_#FH4?$ znMXeTb$nmr1`|{n*#5H1T%vtU4-H)vrtAchme!ZG#@c+Hrf4uxx$;VU(Dr~N-ich4 zMKpdwot^bPY#kBILFgi?i3W_kV%vn2J+%R5x}TL8I?B~o#VXlmr?i=y`yJi-><;X* zPCDrsU51x;mkr+t18lPs=6)r^gEh2$saaA!qv_< zKQP13J}ptHaUjT_(*x+P}wfV-}57aU3rp#3AB&~e3%y}0ju#22u5@mUIT!GA{* zd%-e2DTmr#$(P6^$&N0oCgR)F9IPR~!Q!x6YI*7dx6LR6n8tj(#1~!0rofeMtT#g* zW%-p@V09>&o>iz0j66K^soJWg(o9#T(8Xx-P3?;J|t~nIDSGPq(?-B zOoNnc5HZhsW(m6!J+yj~kjmjV6GKvhO>%^v5`O2I@4B$Z!~DgelYWdC4P>YfmI$TR zq`atDEhIt5ua)PS;Yz1`FX@3Na6j^uBx_rNKTmgboWGwE6O5;iQiN6Q8>ZX%ApVJS zTEf6oj=@?7klS(JaijG|(gO@dTgxB3#H)4&?+@VWkTc)dl;qK|uv;WRI*cG2`6PiF z4+svy+Bfn&Fs57Jz6i!C(w$w@VWPAbRGak~oN>3vUg|Mmk0NpfURt0*DSJ_e*Gi8I zqshW4F}L&aS8x~4*#{4vOc`gKW99cx*L^69fgPj#?++q9LidItd}<@&#E{ZGz7g|c zFX$uKJ;Qv^NpN*e&EL;l@1br8j8oxO3e`g<911L_jr~Xb0)t$x$A~dFay9(}gt4&L zyb=1<`|)_7(!^xJ14xLBGKXO3`R^_;F01 zG70TiF<5(=pRsJYj!^XjLl_vFJOQPhN#Pkr#G0-m#xG>q)GAHjE4WFhe7Zi83;gte zdDv6+)qrgh3F0}$gPmtb9-Ff1m|xDD$6jX)Dcd5Ms-(@nKM_3)2+hfh6@Cs@-=%Z_ zIinf|ck6rN{EOadGmJ-rzvxZnAL)(mf108HL2v&m)%=a*?3CnX2ZfOQY?ha_11m@UzRqlkhrVbQ@0M(tSSTerx}IH@Dn2={w$iGqU#`v}PuV7I&A9JYNP%sqMn z1bTq*Ok{V>SlVH8H*4X-lO?VzaDQzAaLvc1tTL+To)YOuj^V8mQ?)K-FT(s_!ds-O zeb$rKRR-~g^+_aiGtH6kbJ)!K^ie;ipJ8e;>iy2}73i(1RY-~!(tk2zPj;pwB4k1a zVa~7lF^EE`UH=#eb**88zBH%!WkO0S?_Zu0KpRtXN+XMsAwfT56IZI}&cs+R5N~p3 zlQH7o$(zsQQBPIRmD)i>TfdcgCSKbVVD;VCmO3l1VNbV&rWc9o>Pk>ex!)Nap%NtP z&kKIFMm@k9-HeXj2$((SmG+a-dXvl7q(7n=8)cELHf!@Le+X)=++(}pKC*dcns?>G zVa*fV{2FDIJNaK_jq)WE9MvxiTm6sI%YUn|S=oP0Z`vE#GMZa`4V5byxmv0@8@Zb~ zyBOJuTAG>Im^uIL@!ZrWJy6xL{%n;pEwY87Y^xYSfmmgRcgcEDfz4TJ#{;n|g>8(> zv$(RLnp4oD1Mj>H@ar|0RCy}E{GwvuKOf1FS}O&z-Q)MmCVEK{p~b2xFj@lTn}#s4xg7h+r;n$TZDlT2AXAv z7R^$J?R|*xL^>7HI}e>7{HszA#Y_e8=~8*3zy_J$ejuhByeI0I!w-&%MW7Q-FGMKU z8qPm&IdU3w#^#`d%Vcn&q^w;EEr|w2F@ax^`R;a@p>l`U-T%~f&^`#zG}qdSV)A<0 z^*U=#=#o&gd{o+*s#j$xf+2y^t1Wj9_h}(DNi^aK#jI}z)v1rk-H)gocbgc`wB*?$ zfg~22r!^VEN+n>U8|3{Ebe#!9k|dF8lV*9c&9H~&g|$Ymc-2O^j9w$Q^I)ldd}5zv zQkBFDS2TxDn`p}-{-`br?tUCgyfr0Wbf3QeATbp=9sN|e90U^eVOu0~VT$1A5))@C zPcwzUn7bP^Gd~hLA@8EwiklMmlc^(;uPE%tLecC-iZ$_~jNJnZYn1A%r}=VE(-LG; znh6Q+b;zKz_N7)0SH7t~u#)e>Pr194w7xp;V&CpmJw5j6zBO%yB zjVf*iveYaWlrE~+p8YYym=-QmTd_F!`)ATishn6(oD}hTE2AqnVPF_os`ca^ET@@Z zoo~4YJASOBn<;8#(#3G>n1E)&@JA^3LV7mK^kaJ$((~ASWup3G(%#8O%xFX8XSiN~ zUF0&gDyT`FzIjtA`<-+9RXEKbwu%RtcrG!#-aoN0aj)i z(G|=#b_!z{o1}cIyw#n=j~Ac|NnR@<-CW$c%JFBFTi5JW0BX#4k2o2w{L0EglSN7E zFUcmFVF&U6NBA7!t`Lut>faDk>pW>Lz9BSzsqWvnI<+L#wg=zw+aeL6=70S773#Rq zG@fVM9=1ZibB`>L>hKz>rHG}`pX;dZD>I!_x~u>jsx3;0d$`Q%t7d<8^lkl8w0WZ3 z(HGiok6h^#G2EzIH}G*;!U8FW>@|C+wE+z{@e{wwWEkzUEiT0aDJo2JwZR{zcX$Bz ze2pzE&vKCc6@vE*GIv1LZ=qSg~HR)Jf|ljt#^m2hZF4z|32*7{hd|u`C7{C zjG>}`{SC3Dnc~5%D4yBa!V@}xSBtQ$ZWY^qs3)9jTuIXYMgPF5E0*&A0B(=JEntcVgC%ZO4UKHyuzuSblKNHWJ}OzVpeS z?8|{P8FtkJ=~%YMf1h*@o-YsZkLVQU!43cY~nWEmBt#&Ar%7WClZK8 zSe-!M)B8((tj^wSIm3?e5oe&mQs6BAE#Y7K*^boU^Z#aITL%-H zul5Gx*FKM}n~RnE*Ko3}nXrk8nTw0Ok-d?{|KMda<$n9cFHzkfb4wa&Dp0x>XjayP zg-KZ^Ayey*gb`NecHls@$a-2|Z!Xe^@P`uYYo`Q*jKzDQGPFf^GDQ5rd(-X3n)&f|bD>?`-DktKL<0hWK!cPS>L^@|VH6## zG*0#NtGfzpZpt+e{yL@K$|Lg*JfO%I+hp&kR;NxOJ+y2H49xZA7=^RKObPZi6 zL&R70!l_{PTFcxI#h+WsO^Y<`hE*z1vg9n7nG-6n0xBU8F8yDd}=?${Kl$qim3(S98@^W*vvSs{l zU}!oUIXap-i#nT`er(?avm4Q4-snuM&-cwu#-M{K8n;l1gP$ z3sw?`ls1z%eb%&mNBvLuEci8}-Q`|kUw6;F0-pHb?+A)+BLSn7_@my}6u%J=Ub~(* zU1n~wcfO|73IBZF;|Bhy$0FeO^>lmmZz?ZuZC8$p6<>B{Lsp-*mS05IVU00ergKWv z(LIsLS=?(>QLLQQ?bdTpyO?iiEL`;>(XJw^lA*7FCd|$g@c3VRy#tUf-Lfs*_HNs@ zZQC|>+qT`k+qP}nwz1o`ZNC1_y*J{2=fCentcZ%LwW?M`<;L&dcdwa@4GT@LCkltq=Xfy+OasOLT!lXrqy` zEW9YuDcfQtJ$oJ|Ln|b|q*_a|YPgCbBBfQ|5;-1(P3R`sK~3T`TtVV6yrtDbioJKI zPDV1BAaj#O~V^ll>$# zNC?nv_r5RiH^A2t<)qzcvns9Qd$_UU$`jN;KUSNqMCQiCFCi3A$*D#(v=FXCqz$SB zyC8vjHyJhMy$5kCi}FBy0NdSCJa6{q(|*9I^zwX1NHX*dHOIDB8bsI3_{(*-kkQV@ng|lWd*nWx!(xQ1stGMcRDjH=YUQvY2^uCZuO%-0Jw5az*F1nW_|h zR~z5DT4j&Z7527|#z9b}pmRW}p^|OrU(TWox^&Kn>YUn%%JlZJ^16vzy|O|GnZsf3 zSXEMjOhuYZlh*ikE0&zHt5va@6&GI{1&D+NPop@Tss&f!V4;}nqX@iOvdonoDa}J_ zE-u%qrrUpYVYSGU5NeXJr?#B#3dkObD8uk*U|u*zS;T2YgAk;_kdF0s4A6A*YGO4)#dKwYLQi+*i=C3N85d93 zAe#Lng7EX?@}-FPvIdp0y!`J@^1tg|IHwZ=C-i6LW7u!d>#==7<(?=6?caFCo;)AM zwwV6XHIU7}%D3 z75#&7SiVq=f6k4N*gy{?o~K9`+fsId8Co*62ksPHLm=SB>G)@44I(Fbs1stfE==|e z5WM)k7Hs~OwT#*$%<~0|BEb_6HV0F0=kYy;P zdAZbN(@{*9FL}4bSi-&#J^2;N`G{J?KFD@i^8BEXQq3$Q#~shvw_cx5r%ZlgHz2&Y z*cU<9UD1(G6qg=Yx{LRix``xh^Yi7@j|r7hm00t{(0ei78ZQbt`JV={$XlXvX91YH zxbI<;-YQG@9xrY>Ar~yWklR>hQ-X6TUxD-S!;~b9lu;Tu@f59S=euifnkTO2C*G;S z@TJZ5{$VG<^ThBbq_74=9q9r7DxC6VBngr@olJ}~W87-NEagn(;M*)7Oj2!(TG+}U zsLu!TV4B7DH{}gtanAHawLkpH5_$jk$0~;0`rM1Hjkl;4D-KsjXTl<*z|E`_8Nlb6 zroi&vNu(socja8wZ}9J>;D}esqgs4BR?_u7ZyELz2k%GQjtG%Vx+yeS&QI*AK1Q~e z;1-8)WjT?WqB>et(n%42u5UPI+!F^B7Hx#oW{i;??}{9#vpvk}lwvHPB$=-+pnIAL zGBd3sTO%TRGFw?`Nh>DzU#VeO7C?`w!-QT4ZgBE!WsS1clJ&i=m$ zHn^;?BNx^_wESMCsSKfxi542WFvUJUh%GpT-JP-b+D|wh`H$h4?*AT6uKyK)=>%&^oOXr5Al10+ld z9x<66pEk?hlV|$s!otJ~_Kz3DcB~XFzWq<@HMwvNFc2}VQuS$6g{U$+nN4G0`E zua0)-H1D8k;mm6E{(!pNomCz*qxv$pI3NvG>(+Q4AcJvK#K8 zb9SOKS@GC!pN|JW#<}*37GFj>D1wi~_)k#-N5izNy0%(q7hMm?oL_Ju8jMFGA9bKb zv$!gbC9lC0>Unx?+*3GF(6ZZH<(4j|5-Om02Y2z2IG_&xn+2Z`6;N1An(~^lQwwUQ zOiKj)?fuj7EGlb8nv@wDs4us&o=Bt%l*TAhB{h=R+Pddpm83-ms{V0T&ofYt=D7dS=Kr=V{~wzR|1=j_+3Fh+3mcp0J6k#Z&$+yVt*OJ$s$BYK zRx!5u|IH#%N;9@dV#r@$o(;Dy3GBon{2-)SK+R!>`0yL(nq~lFeelQy_)_BZt2i}m z8rSXb0|MpaMQpG<_IaUCD@=+=`KtLmC}H1)-vV;8Y!fw&`K2B6oou$QOj%XL`Ye$dX*5~GV? zjoCc8{4m*B_lFn=K@#mp@(*Vga>;sjA3Ds|(a_aGGbuFi)9-z>)&hY^h=PM>jvvAt z$Q7Zfbr%lPeu2OFHW3uNyavs`ezAXnB`OuCGx+U1e%!gwF?S3T3XLaG+BzOfiLB-f zLsTI!R2nT{#3)Z+EHpqiKXE$CK-~2S!*Tvgi)l{*o7SZiuHQf&N=jK$gt6|+nF)`Gm z!Txq?dNfctW^}=z-436nDud8w974=Iuf~cqED93ykXqf1w8FZK9fiO>iyHhGH6`Xa zy99CYP)x3@)FSqPdVt-Br1$H%x6;EwpuBzZ?#_D^RUI0KPMzf^_Q2rPhK)0jFB8Xm zlV*;2seylEHqM|s4!E5>k-zx$17R0R2*LcwM(ea^%K>Rf92id$mc6SChy+Lhh?+zh zvO6({dx7GOFjsuW1#TIks9C3Y1NS^K;IL#Bmt5WRAnNcc>QhlO{Vj2vmon)s*asQd z33&IEDekAAXHibwHHW4Kjin6FB;UgbL))#+*%fRgjq!Uy)J$xt^A4P* z=wpGU$DPMXW)DL%DW!nu39E+G5tKB@YM$r#?rOf~PwEaIWOZ?-rZteokPGZsqWYS4;B z|0LjjIbp)2Q9#;HApIi0rAAv&MKYgXU3KhsoOYe|YT)zr{({<}EXL67@nFgE$g8n) zlwsHK7H3m?1l)9j7MVEeKIFU&$Urel=||l_I+%2%vpEWGJ4%Ae=4~9emV-GN((dey zu%{X&7)-JZ@$2L0Yqtni7;-H%fWs%8= z=kT2S6oOA<-_q!hTShh=6tYB`my{cf^+Lx>yzS~3hAy^=8Fn4^M9*a;F$7-pPb`5WTTi>BH<(hQt<2d>L}bEO@qeR~R5CV6M#}U~hOs$t?sI z7o&N-naKA!$TJ z>&^XTo(>zGjv|b*XTI$ut5?7&&KtRH*Xif1`>gBEp7*Joo(B{{&6%EYr?;2euFLC6 zyxINGDCvA&Z9Ke6+p?I9Q!BMcUI`b0h}(?yqWH@VsM zQOR!?^5j*fLK3_B=$34i3+r{u7IgD)M~W2q7y3L-307k;BupXtBuqlRxD3=-rhwa9 z?bS^@iS*Hnd^;p2cOp}nC~VDSN?;3$3z!yI^$)`1W?UAhtCjjqn>M&ph0;8EaiL{z zu|C4KQm1Ko&6~iXk*x&^ph_a+*qDsevtmcT;T0k>1Tvc@2_|YU#phijBjGm~(FAS> zlUlF>J!lV+cX^mbgNt|q+%c)}o#I2L8tL)BII4PpHABevx1oqq4Fk=enLf)lPJppehzt;iO9UQ2qK{ycJZ}25$Em8#QCj@IGeY)Ih;t1C_j5#Indn9> z?q%Mr*&t<`FGYDnXUw!Q9F(&(vc=j2NyA|}`{O%(aBk4&ic|F*CyG^zcJTh7Jbkku znj-MdZ0aPz3?=kXncCW=-<;dP;J9T1y-C;{aJj^)J(P2N6H-0wO?ZvS=U!GHKVCK< z=aWv?u%5>H&8MwXa49`eLmGW<%;nt}*#2=)K*`axE(dLvH|fGa6F34#8tRY?cr_y0 ze3Ys0rp;JgADiP65s|!r+v;Bhhv}`Vm{n>M24Hc%zOJ&UhG2A;(vSJbsM4>fU{u2_ z-6VIhEcV`qxROML_k8tmxBr)-{ z0Nki4Ka!>@`U^UZ)eJ*+dVEKh%hU52puWKbEG44AD>zWsBPQobQCa)OTlz41wS`U5 zA(_e!#MIkQ_D?<^L@2G~TpSiQGc{2i*D?M}9=ed6<%52)rPN_&_Zz}kJyQ*xrss+n z+*}R)Uzw_8MN}8>Nin$jkrHrz;R3n*HT*JD&M9fIRS?wRHq#A#i(f4q5+z;_5Ij)k z55fi>(u^$A=GCiS!o_k6hWVWf;@9>(C^LB-^lw%JYn+7v`}UC04jw=#dbI?>PxGb< z^hYM;a|^$Xv8HwRyEFBlC0EGDeVFD zsI=F15ChE=aHP6tL~Ao9#WHh`H@ZcicgWiJi5Wg12JkaFg6%fLuw^#2^+FGSBYJC) zcLQaBfXhJJeIf<*h>U>kVP9*cRCfKc<$@qO~wd*)<>-)SK6P zJ@I^4#us1Hf$yt#&=?VaIkhDY^^W;!&OFd#L5S3wEK(42b#OVRSI3Yn=DLC>djb3m zOx*FMX7ymI4;B56>=L7Cv?Opmx_j#kUAIX{b-S2c8Z$v=gOMvo?-ij^Qg7+-IsiMdRFM)v7G{O9O zb{zD!lmDA*H)}70ZFQ4xTkLM$F*jknM@CK!9fA;1rEyA1T;kT|rRhl7MQ@3Z8K3<$ zthbXo^c6w1sy3usEhrD|+wtJ{DqW>!SzzMAYG&n5P_48!FI7^!mt^UsJ=Ii%VFz|f zC`{_0n8zVxPB%8P&U9wpG3=awF3lq(pY)ZY+X0iPX>u?nXvOVKqHlZ!kPr!p?==9sB_~DS`Wz) z-C{l?ZU7>v`xhem*b=STWhZXwe7a@WUN>CeYu(sj2^yMe+X__p(O0XKfx z%AXEQxVFsfTzy)ozm#eCQhr*;4iF$jVCn@40VgXeH%1E z29UQ3y$aVZ3TOp-E~*g`Gz^slv`Lf|RO$MFBa@P)tKRuI=cc?XxIqzmXgmw~OWv_3 z79M~sk*g{jtNxD4ShkFGO@d3`N{)-(L`+B$P3o{T)|L%BE`c71nj=koezdtBY4~a%t^5r3-m!3Kj%V`9dB?v%w?BxOI$&~!jUNWa z@o8Q~I6n%f3*aDLLYK<|4FU2X@*``7jnlDRq5+VebLwb4vJVL_1XDYFTUc;$dW3relP0}p?81NZ&{!uRJU{&9)O%uEL4Mkts~ z&T=;)Kjl_c^Tc3YX*8y9Lb`*cpyU^wFHkn{Z--k1SA~|n0bO2_YwyEVv91paW(>>D z5A?fn$`0!!94mEWTUFmE5+yocu&wZDj;aE3+jOFJ95*T%`pKWaqKNiaixt!T^#`@p zHlA$6Fj^5&7!Hb19 zHyE9zQWe<12XmH)8IDIOtwPeM zHRd&LKn-qMRQRtyy5LYzR9#*8JDBD2K-E^^INa=#S{XA+rW5XKtg>7Nn^Of&Vhir! z+P>KycTUF|e~Hw_vAX%ap<+u9o9)jcAVaw~|4zkmS zZa8>nl~i|D8zjQ^%<{;ZR6cbVD>%?nlBzUD&(9h}VOpBkVW!AuVW!MGuz;OfTWE_| z{yi!0mE#74$DH%4$iv357s-5PS(g3aXJUS?=I-+Jz4Y{Czu2{VMepL1!wV0l8b0k) zSH~&|HJ~YYm{WKY&gKO*WNzB=l|JE3C?T`VIh$Fi$wHFx68QWYRy%ziF%z4Zc<{>B zjkGSyv*i{+F*O@tKQ!EDM%7xw!z{Yx)~Woo$kr{Z7+t7ve;X$MoE{R-LVe22TZY;% zOIFYRqSw}4;Mcno^z?O*G8Q`&wbgNV%>E*DX{fnqK*lP#K0dvcU3endLW%GugLOH< z>Y{oG#ECe$UPvO#$t@?@GA5JFE*6oY@?+$jRxnx(BiZ8q{AuRkwymR+;{*D6-bh*) z-5@PC8lo`?K**Ec9*n$U>OJRjK0H$J@vnMoQZa4ti zMegzJ2oft=1Y+aEG$4JE9{t_I{tH*SwKVixk$IyL|hvQq*qu&_4C6X zp>36)v+qAXl|OfXL8koN-RrhNjjA36)N;pjmTkOO>jg}c>35j<2gH)fb7QYv#8VV2-AXJ1-O{Vpi$uIz3lMp3dl`?Wwpp>|6_$}|ROmbQ- z+O3VID2pdMNR%dc(_#%+-P-%bNIb5Irk&d>rOY(_mq8%P;dkWuH0mR4vhl=r?rV5g z%=n2Yz2%@f5#I6!(KxF>D%1-3IyJU|VW-!(l$}cWBQtobb>#9D+>HlD>@kp+qgiCj zU_Y+2nP+9m^gw~vIRygs?R~aXBZ*Vk8cFZj_&b8(pTaY{Y}cTT z*fRuKeL3=89rk16#2TNQ%KL}Ryx)%5M0MHy=A(uL9M*f_;^wBL-FO~J+@|(7I)GQF zGxu8y$fzRDE)xoI0MCR3S^FKd3Mzir$&35HZu)9V$~5*Kk^r{%vt!7ISD#%fswRS1 z7x8ugQ&u(usOPXbN5Z5URhEFc|NLc;g}f4JzVjlUxu&$T#yH-Omy4s=$~b=B<)v}= z;R7RHY}oe#TExRVjM2_)jF*Q3%G{)3ZZqgSTa^}wnjk_InITrx)tW> zN_A5pLZ9CogVv`5^1_9Jm_n4I&Od-1kC6YSPp-Oxyt0!D zIplg&zC_?4NKvoQui_?BUY3EYOP5n0W0#hYf21a%4Fg1xeEs;w-CE2d_X6pd9A`2e zuiIRY)}Lqe0J(eXdpq{`UG}5w@h=I2qwDlnybY&n3-F)3(mWK*z~Y1=sqQ352UCF4 zQlI=T^y5Lp>gG~>1T94`()}Z4=w<|*zIWTL=+#(!PT$k6nPOoI-RVk#s?iWB=$tTc z;v`#9_oLoCy7W1j8Mn^hfr?}kDKcERb3jxH4>hafqve(?N%m6{o48;*Aj`VQb5)Ul zHK-31_Fm*+OH8EXSzh8{$7fljqN=ahTv<75(Rp-SR$Zz#EMGFOcXfT5%J^HHx8x@r zP2)nIWHes~>%OVy%4>O3(0{X?N*ukyQv5>kKb>M|32-D&p%1(V8j7s?3w|Lp63nOV z937ts^a~AioVI92W$?353}~XMK~{A}5JkKH5b=n9Ciq@IDBAB;Z!IUAV+ciiDvH*j zMD^3Dk+a${QM5$azio{#f^OHOx>LnJ+5kbRm4^N`5ii4(4>XD|b?3s1jrWv1Z}MFy zT9v+!?Ds9SiLUpcRnr?JG+C=^SKkC=BwXt~F8Tyir)=)czcAl$Z)2R5pR!H;e=OVl z8*}D=$~ONscK(|=^G~^sSitaqkw<2U?vov$hY7)fa=I8~62|7IuK10w(qZq9BnSjK zt$S9yI^QU{77(-&cteiu27n8-8*tNC&-dMPS#upD2hi$Q=J$O0#Os?xwTN{WtSzZC zp0+5nsTrDO-C3RykP7Y)6z8U{uiQ@973Pg|STBrbPO4R4VU>jA3ZJD%OK)mD`u%Bq zjUA|-$B9L(11X}nY*naJ%@8ESe`WsFWU8vR= z2;2}9@)$?_zbc_riw26%Kg!e8Kd<=z-OEDxpIr0*^LqcyFQ+uzy_6rD_)MF*+Au)L zK+sV!gc8RX!}1A93BeHY86igj>{s@tCS@2Inb@Wg|3Ir$G(TxPHZ`*>y-_zsskEEv zlcqu`YL%;Yn6XuOyEIg6vQ;HLymz>grb&Gw(*q#A5?6USh=@|D2=%(`I*cmsk7f^9^}}P? z?OW5EW$5ivagZURMyiQ!)dSTd0?Cq6Pu{r&OKRfiuu+&nj(M|bhppFk4ze_}sSz1;);PvKNiaE=q^G|5w^Vy2SN zBs0Xts91C^d0dq<=JmXesd8D;1K5UvF9?WTYl6d%lJqXxN`Pj}5LxPgSRE$%)Se9Nn;^;MLmXCiH$)23AiNRlj3 zB5S`@U11=y{xj(rqgS3zSUD^dhUILAwb|IZt>UN#gv=Rm63ig{MK*6HQPQQC{?1ODO*flB7}Q(AO3hFI}(g&O+0tS_v* zssss=fjAF6c7M%h{bJFcbm>-<=R>Xa4X{qGb3|a97zk+R8pO+p(k2^QM<;%(sz0y~ zRB?%#!Lct8vXEtAzqvF2#xo$NsieLB9TCSs^E_?X{@2BD7<@uv#vvJzQhJD^v3!dT zl|$vIA|g+p5nMz|Au5{UAyp|$2kfI)S~hhN0%yOnr(#(o-&bKg$Y+VeF{*sx3Du~N znZWwrE{QHx{GA?2J*uLTQ+AKA)Nbt+N2AXvftlF`pev3SOJ$4`MSDf=HiGkA5i0UO zd~$T7PLbVXMt2^U57wmD5}@X1U>&QO#B&jZ0J18_+exP+Z@5Me9xd0Jbq&L^e7(>X zNNZ(5fx4(0i?cEE=!j+2!b@EfJXIo&j};GwfS*019h#N=Yt|*|0J4`!D5 zN_q7;3^d-)FNmK&7&H^rwGK+yh}q{Hpt?|PFC?Fm#mlG5xknmlrQ>IgB05c3KF~=a zh6K*nAvP~CiOXlXY$wlxYQ8_)WN;>NeiQS5Mb-&Nuox?GER-8$-`li(QhmzUy}Keq zW@+_RPM`C|bx|r{2{VLpv4kQKehI>QOprT%3zknCxVb_F`5u!3W#trOn>06Z6D*XH z=M)M2!jWK4RGLfuttE%E2P@F6hVZljI&jmjn43^ zPJ~{D)br75_H1XB8(ej-Emk3-$#Qk8x9>hEB<9vjxJQ=EG&)&*v=3TD&pvVnxeR-) z?Lb+YlOky39f%jYERz8;%h7@zQH?O%8>!r^nUZ(>IPqq+lbCHA8Ax24#IZ@dwzGe_ zNr{+ocSoD-L2*Xdg%@t^OiJbgq#@1W&4(>T_SLJKpM5HrJSQaRRfbG&uyI9+T~>My zyWR{C12~~%bhg$$vJk%xRx<*^v~v)B^3%hV33i~-tUvA5Sfb|5i=rmc9n>)2!GqKa z^P&<_F>DtK$|77CJ5xuKX-Q%!OtxP3n%EsDQrn82M%6F*?l55XtzSVcMPQG0ZuQjl zmq*Ic&aackwk$S6PqbQ!TT;VJDSX~x&h0RoXfrD8&a{@qUZfVn6$ilU9V(GVzCpk^ zP$Zf;Ui%dnVGK2;ueF6kZ zFhW{mY7j^Tftei%owFtP`AO&4M?tOT( z;Htw$hS6rDA9#f<0l{2DA~U)NOfScqg!^m^q#5Caibizsnh)JfGIIAiSiC=S%J|_X-AWeS|ich7A5v3!>zaS0qG@+}6 zF+61ADkXR}zFbZ1mX?PdOp=@C9DI^|;2Tz^0qedK3>_4z?WYMY85qL(rt=Zq14q`G zmX)L~hGa0K_F1zeK5O`YjYkt&x-#C=rX%}-v%xC}Z95zssU#Mk{YR8Je z@U4Wha=tl!xo6aPg=VsfWT-Uw*s!bATd!Jrcam6JES#?b>09?3j3HtW9zjdZo{@vm z;Qsw!K~TU*LK!uvRJbS;OkNH2Wt%Y^x3I4&v!zodO!!r6#`%hm7yl~tBXG|sE%(t= zztYj^vC$ivB^+7S$l7s@do8-L_omu&g;hi4Q7^#p%DB);DAqKLC_yf{M--fbVCW4Q zpLSAJpyR=Jw|FpZ7!OY9&`o&H;FE5C-006%H7z?V^+c?EUl19l4m+%pxM%W-d$e~- zt(|&Ex@CFK^ihfbnmM|@OUuO+x=YOaa6Up`MZSv=z+ zj&v;Xfs>|(JoZyyf*n#2H&qEvkEBqz1th01TIY?cy1siJEZd%upf04|88q_e^UcqIJI$qO^tX{0Q=;ytn*d0;d>W zpbMg2hvsXQ_P18QOkwPq?4dM+V|(uRBPZ<<$bpw08v0vS$9$VUpbm=Fv(IMqMe~ij zM>0rOq>iZMoC}d%y?jB;97(AMLyv&6Zzi(5LIvB?<#Ywf0)mZ_~Rdangdl z&@8jcCHuwoEo63_;{rqY2HFx=n@YZylX9a} zl&P9Yv{)Lgc|b3Q1o2l|SANshLidoYfmF5?I`bsF`E$9kGP};}K?$qva#L^~CH` z!TFGfb4WF(Bq_ENC#V_OREgx>tR!Qa(Jg2?b%7g;M5AE-&>&(JHfZkcmN2s4eJeN!nCrcl9Way`gTk=o|nGo|BD1pGHLvB0ih$H-WM^@K##RBrgEQ`4$CSNzg z8QjInTy|bpvXE2PqeM9*$mGvZ!Ps7Fn?$@*V_0OIlsGq$7xq#m0A&oC)8WX5OB{I{& z&m4D92ULj=J&5P>4A>lRn(KPS@|aiq-&TfHnOC`uYpkgbZ!za!sgrKX&HmC&DR$Qw znLUwmqe#(ab!;OBsne)NG--Cm>qV#<+25uf(vCyt?AGIMoJse#4t}n3bFn42(girok)X zsLlF0m3f3uPV@^VjN3J zs7vW$dREOUH=t;vnxK-_6qp*ejG&zM*m*>v9wu&xniWe@+eJ-67VZtoVET-b0X5{6 zr(c*Y=7z@KB`=B#zMR8)M_(&sn@t?LtNkyD`lrk0nJapT+`Ued`PVEyOY{v7f2Alh zxP{mY>C3kmqt~@Sx9=weAH3PUD&9e;-4Z?DM%u2JrA~7?nOo3Fg!@?ilHRb~Q9Vh0 zS~k)vttP$Xy9A>{?$-j{oKIM^!~^qOk9nFfO9U;uX<{Z}MGPU&T0}pPw4d7EHF*^c z(1Qo888T#p5hW(|Q-(yg#r6vVzhg0gpd>56bb9oH0wu}%3M)p2fxFLEy>QG4R_-h8 zU+Al?!eBv?3%sHzLA?4>j0E@%7$S|RYf_S$ylY+ z4n%*ot_mG#p83HvVERPUjJRH!Ay-9T%yQe2biJr+b%|?XeE(`??bZyWEqp{h5`F<$ z|26&q>X&o$0crC>TI-zNN~}*w7-kFnefLs z2fQs{{%-wM-9ryBgJ*Iuv&{5yuKy+Eoc^si>??Jju|gyAn_Uf`ajXB1%g`EBtwiQ1 zx^awk%lc*V?-yf2mx&<2oHk?3d{TaxpMu&Sc>d+t2h>+*DNg;iw%P+Pbq56MHt1{8 zuC!j;1YlpBL2hXi-rks7|L=db0Mz7?nWiEF08stMZRP$Sn6!kAqm#as74d%`|J5u1 zZ`hY{-1iNNl z1=2bj@r1^~3~TeQTAAId%fY2ha|!FRU6VMpiAkkk@VViqVwhBxz8SBI0v70InyyD6 z3Bn|Jj3nVomoatTh{xa7jx;yvi_UnW_#l*M<|9E)rOc4j#iVycL>cKHTtp3#k-nKL z+7?|mS#aSINetxl?nE8)%Zyk>!C1k`<{`huyPwZD2`YbK4!99|Okznl56^r1}88nU&cpyn*~f zRP2FGaX0@#FpvKuii!WfqnQ6~#DBA2l_uoxjK6W&?wmdns)%IKg2?m;9KE4d3H+J4 z{P-@21_oU4WQ76zv4`7rf2c8VBqkLlTWX8sn;VP7*r9$|Zvr<123Vyh&st-dNnOt) zxtL4AjW-w3bde9fPrdt&)f0toUJ2&UdD?Duy5Ap7dEF=0V82i93p+Kxkri{*^!QAa z`)V#?MO?Egc}EaN?0rV`N9>*U}noU~6E-WouZiR;Mgh z;i}OVBurvrDpRj7!i%ICbMj)VT&(w5JB7dEWs8$MSfbZaa1D^jw$rlh41JSI!*+g5 zc`HjldKt~dEdKiq-t`OW#SHiFi#h4kU3|pR`S;CF5SvpIp|Cl8#>|qEO zL6o_yj`uN0$wSqXQfj)_qWIKrnS3$j-u8y`GrF8k5xy*m3E_xC>4xG+3@28lsi2dl zG->G?bNPxG)$u+RlKOK*4722EnDvKFTfCP}MVn#i1AP7T_HVVXeMTs4JO zpT_!OPG@)cEQ+es9a7Q~8ZJxuwg`RN6PqI_ZGrR{=g#vc28nWQy+I8dcb5dFR^-u; z&&P%sTVJJ;F`R;9s*$hDbF31St>mkHWdp=P*}5fF!x?lQhPw$TMi}e=#xDm^PWJok zBklIX+F!cN8)z!@No~Er@9ywmEwj?-&7I}xh?Aw0SPtK(3EQ+5LHqwwu+}k1p;#vH zrvh`dw3QgL-4@kIQ!Av--?{@#~s8|+dQ;(;Mo#ndpY6spn{3TJBv8{Ee0%vgX2)N zCCV1=Y(p9TH+hpYR^mG9QF6nF>tHb9wDPpXRlL7F+QvVV*IK(W=+D|wiR-*I;elS7 zY`O=x^{a5b-2CDtug6c%+y!Jb>;Y$1|5k+KbP-$ndnLz+PK~0IJ6_kenCmP!NG!nT z0oX@l4sD#DBU$@kjnc{sh4baeOf!mqY{x0?+@X-P%tFTkGt+fK8Xnl}SW!g#bX7&^ z+2;eo?q}&im*rirs}E*eubvzp8ZZ##(eDL0O^$sfaX!0;rmj^d#vG<0v5$vbadqkM z;c@S>jXq)Rz%lvuo_XtEk0U!0-X%0LG%_Oo&y;sC!y!Vzbv!1e%gjo7+E(!P5CXQg zglw~&%zv|GAITU4^EUXYL*ba5L|+fG{n2f#<$P`;XXQzw!rFG>1xIQtjYXPCx$0Tg z_y1H9*k8*NMu;cG(T9I5k|_z+!6-KvLctWLG?awCF`Wto6>5{_B*kX_J!#TlRfW|Q zTxT2;H#0}=YR;55U1N;$dTp5H%;k}GCmbbyfA00QK5!SnK;wWT_=y7G3YX(F_2ej zekKG-;-FFYlnsInfBS-ue-l(=JyzlnCV;dv+bFa!pd>$1xZyr37BgGGzr|0+^O~0j z15^}t&e-E6dU|#)QNVmuka5beLq1^$=n5hx6Mg@fLV!rjf(f07zjUyE!{MRr^$O81 z9c&-SdtEZ{pn(T}h6ZnUS7wPMBn?d!5HMe!BHRBbb05=@24O?2h_`+1 zSkky=Y6p<;hK&MFs_UV3Pi4-ZFlQ5qOdAaJ4>=1O04Q<~*!bCF?FPS~o{er4?b z@BAktYAQF=_~SF#TF%vAsN~HdgBetV+7Sn}tl<@KS7SOg0f&fC(;da%oL1YWSL+*m zGM#5P_te#*^#`lcd2E#Bzrd<*Ozyihcs6GM{UIN@;iOnS-MRs~qr?3IfIIow<-ibm z1axfeXk3WdOtrvL9~RrkL@RPE27Wm{vO5xg=Y{Si6xRMyB}nHWVL(7VUs(tiyCf+=eFX z^v*e{k1Tj6MkZdZ0LiaYY^zFpCUo+Dxx=bBlNeU*IS#VeeOAzI)Vt^$zh$j^EZMHM z**h+Kz~xZ6N@mz-#ETTbxO`K|Nr-N;@=2jQ#7ZgkFx(W;GWygjB|Jx@jU+qS`t!IrL_@Mh#X_TZx%@ z^4p_*L+-*ol_Bw(5gpCY^}j0qLkVl4eKqJivQEuSwK~_wQU=a?(Pr}B&EB% zySux)K|s1&x?55}O1is2>5>k~O$h(?yyyFj*W>Z~9|mI&_Fz2Mnsd!nbFSyU4NmP* zk_r34gxePNOJ$h6cykvyCw$qW0>}3|r&9U*AFcQWu@^Z90;YM#zVCO^+rx zNH@pXoqevqr|SqP@$wvXr8J@&d_JP>=uXmMSW8G@sN0shx}NXhJ^U;k3^P3*Y9*{X zT_){Q>`WUL%w79gi?=u4Dq=QB^rnC>Qexc!1mCKET58qi_4>ylhJterN@VVP&{9R} zf`VGjgzL=<92XlYXsi4V{!C1%tpasaKFas6LJV)K-=vfm;P_v(pq!FX4Y?&YsVKhO zR%%faHzRDbQ!M3E;64T2WnRzcuczPxKYjJ4E?oK+r6|}!&xa}zY4)CB2A?|sZ9Z0a z|7}5bo3I!eu5axh5J}j*49lzaa_Zc8rw3g>pdb(cSDK@($H8DyJ~4-_*`cwZ$s? ze5h6-?o%Yb`5-tXa|0?FF6Y2tk6?PhbB~VSfa6cTW01)6;9^4dE+jka44m<(+qOx| zS7+%A4{cV1vYAlL_6DE@7TAVxXLfPEJy)0APHnPc=nL6sYxCkc(#=FY#J=VU)@bgA z0_~_L;7&Dz1PtGWxfn&<4}Ma94p>_udw=f*7k4kv58VQ0lC!J^kehlmGtWV4Mi6UiYHz1L*lE`k@;g5_yK$-= zZtu<-NFGqxlm4JpB#T7g%Ex-iNmQO!&y7g$cHfwbO|=&7md}4l4Mn9|n24rEQ^>Ux zYO+gTedMAD(2~_1Q6k*FOpy38A*yn7gLcbXj?+s+U;2tl$BG4xn$@hHmfNzSfuA*V zDR8OI{FbT?yi6r34Q}@hSTAGKo2ggB19-#DmV2x|Zadz2|rHCQV8f=qYq3S-XQKr)V!L{fbjC(JB{i1oZ ziF#JsGKmxT>@0|5a3}*}b2#dWUIr!i`8n>4;r7E*)&qvB!SvEbZkC%_T$i>HF_iTK znSw(apn9nYdcK)KaXd!E__$?es}T}>(H*ztldjGo3~FxJOQHIwDEbA;V7L2u0y+iR zI z`Ta|+1SVzj1fro-ACvhOxw!`lkeVnt+5zUv+2Q>l6W3DEHS!?GkLeUc=jF=*DYi;4 zgAmXvqwtL98S&@oBP*(OL2;6Q!{jJ!x!SIzc(UKP=n25KVnzea3MJKb=3u8Cm>iLlc zo>?@$-95+WQf~)EAZt_5R=Kx&-+eesXf5(h%iWVsgV-k<5sR4Bt?SzA!_Si!Vs17{ z{6tvfF)5Sptk|88Zta~Yi^wNgFB3D>72<4rA$j}O^elvaJgTjo4ShF~YmiNpHeGbr zyKXGp)-!&Ibd!z^zbI+4QbF?)fGbwcwDyLFza9Z}=ghoEC1>_-5DRf*_-4`0`D_3% z-j$9^NUELnMfu|?&hgFGHu3n@;Oi!chfyGFC1tj zysM2L<;pVB&eZILeivP-DG6^E!_0P@Pv$*0)yMcNP8S ztipdgy#t~iDVyOeruzZb?;xzt0NZ53utk9^3ZvN}(iFQco`XI5+!2~Bt*g7s$UI9V zqTk}E=N|5KTZK~u!6+3ngR++0rc2UcL~b2^1ySOpH^5EkBa;19dk^IoLT_D(^eYV? zh)u!~KjQmm97L8GO!T6q$6zM-+4)P@I(QCal||#8B$YWzh+EnD6~{;lGD;KM(2Z~x zbfm^>#(c>3<`9QS(Mb$0_NoT37Om8`p*ft5u4+)-eY&scXqIdG8ph(=r%k3w~PVLOXd zvY%SJgzTUS)}20bSmIE#Ku2ArE#^+hFkz~5s)Jq}y~;DcyBxahE*PlD`+}A(u^rn<&8zczVDn%^A5dk-Vy_mr0qL*uM z+kH(G>dhnCDc>o`r?(AIs+^*rfe)ECTkV3CYD3Q#19fXQhe<>BD4P`WFJ{4fglrGp zMC#o(hLNzR_6BG%EOWFS0kBYlhLR^aX`ly0}L;y&ATq9Kgir+g(JSTR7eC^Kd70rtk@Qwh@u3M8?jc zvgkQ+ER2q@6iY?Es?2yUOPXy52HHmmw09OlCy8i1JSX$cFQ?Kz?WxLaD*;xXXdOZ= zBkjariS2=U=4{ztOD4WdLby%7@-N=%81G7r_onmAC}*~wh&dH`ElcXAaT1YCg!*3c zydPyIQxoLY1}B)t!AYV-sVm|=v@yqXQI~?W4Le?d1`+uZEGOQ|ee*VGf zrT|&74wW?}lFB{`V02N9RseY6=RHwR+vczuOFPU6KW$IutXl`cwNkIGa12qG zrJ%bP3TNk7J?}yS3x6XEWxoN1EKl;n-Jr)OR82@8A-lLcqJ0m!DhivFnJu)P!CIZozRj3Dupfu>UuxP6njtRWN0x(t)#GPjJ(W*QX;@KZebajIc;dm zCW~hL0jRsrD=aVq-P|3Oy{?-lW2lzd!ihrjVFr)oLbOS5oQOiE*S-!;?Lbx&bB@wB zIBCNkoH#5Y8I#5PlHx>EpLUEIfBnTV;pU3R%nfkZ z!YFhE-!>M@7lKEDX})s?nHWmd;*DDNM6GEm7PaY{ePtQ7vU*E6^Yo7t_xmKXg?pIw zLetbL($kGYR?TwDFJ{6?y@??DP->A;k*WI-u5h`r_Fj=a1?c8CaYv_fx+w3Y&sz)# z5l!Eerg8T>?FtY$ym)%@xf}a@V)bx@rCghzp-=;#(K|s@NOO*IZA)NzB23n8Oyp`N z6Y_)!pjq5GpOl;|9mspLVAjuk4Swf>dB>Z+oWGfksTiJHt6LL8{)`TN&}5mlo&S@f zn?k$j;4E88b8ms}U06xznINvR%znonws$*X0nXu~KR;D&0=; zq1MxLBj~1VFmZ3_rpJ&0B|edG0LL4z$TA%JtOE-~IHfCXompV+wy z8-&6rt-RaR;6BG2HZ5IoYkQ!W1K80!*5H1C5|T&@US7!VmLWU9nG%2IR0sf%g(q;p zir%R2#OCiM-FRbfu?u|_l)-Q7I{}F_K#B)nXF9wXSLm-9xO`&}clEL58GaMK6`1Uo zQKob~3zs=o{h-kD;27bhfCkdw{8=X?mD$rB(iIfJLV2z}Inma$btemM>{3VY_dH`c zRmH*W_;0{4Bi*0y!=kq3gCg}!KzsqQv(?<&2%Y|52_E_JZZE7axCF6;pWKz-h9;(1 zFEg|lBDp{TkLtU9pc8X{8!)$h;lT}wYiX`cFvH{sCC$IJ1nrkGsX1R-c54t zLc9jBHVaK(PZqQAK)*w|rQxaCi@4yDsR;BKp_0+QMY4^V@oQdty=y?g5jigp7$EqZ zjDUR~x@7qfAlguTFi<0JZx{E(?05$3ZrE!(`+7JwC(6-O)0zPfL-;9#k~GMZLtGy?nM#)>2+T`kNj ze-Cd%!Vd{3rx0cOIo+1L-plN7F!@)*0?vWum?{xsvwILKF<=UycOWzqNrt^1DAHo{ z&>l4+Ab^}}aY{#leq4;cq6#<-V$Ho7UKVZ81@Wh+CFOY)SxBEZUOMd5^n&4mJBI5y zhiL&%RP$EK=dU%dsx>v_%dKWSAnH{~OU>To6_twC8@+RTFwOV zjN#5sZh{G`WWFrn$+vV8xa_EdxGegTh$iG5fdf8|IkR2eF_u{^F!2%tv7EYty{ytY zfTzxF4)ngPoP_WTG|Fer08u&Q$%>o}_7yWw_VUke{^I-nDIPLL`#{~ep5)0hW*8ez z$=vvIc7ys0bTt^Z4cC$pSAr8jP+)*}S0n5;J4~41b{%cIM*fv_$1_a{7~CzEGF*%a zmo!~DyV(mH=a!>N6aTXY|l>8fd_G+w#(nF|q5jcLBA z13?#dl>PPCA}RNzqD6oVO(@OKym{I-Pa5JmLRwqW$FBiUBnL+P2)@~J(ec|s_sm!R2@$OKicGYN*2GqU(J&T z{Lqn)*=vxuAX1Gv0Dk!C`pCTtlDrGq_gKcHI?^jian>rS^UL?G0{-ilaNK#DTyw56 z{Mo5FbQ?Hew~5Kllovle5o!-n7?EA%~9 z%jQnBip8H@%a9KGo;gZW59-6s%P>_Y62@fk&z9tt_3vec<8wZNl}y-DPVJOG|Iin_ z626Fx(_8z21@R?Y6h3=m$wyZ(m0~u^gGm$C_>_E9bIWd}w}}Fi6`vO0&SEgSdVWB! z70oGSTwI5)%Dq)n3w0Upp_=|g;_;3OZw=}>WJUsdX*M=A4EsAwYD>0ZPrKc^Y`%(P zR4QJgyJNu4aNup&3279U6_ zdbsfLmw#jb+-(ai0SJf=$M4ESh--^XS307Zgwt`pJ8{}aNm%u@LRcdGx zw~H)F7#NIpX{7#kW5V(1H5 zz5AdL#5;!Xs~elu2h{fX{pR6_V=3+&^ruJ{iTx$`s^O_)RYD@?{ol+}(o43PDCFcy z>6@z&ig(9lnQ&Je#^YG*qG0nV5izc-nDi1Oya!vptC5L&xq!LbWas62!Jk9@Hgg$u zcf|NzytpAfC_?Eo)ZG&ywyD+)KyrtAk@F|5=o#Mda4t2W8yW1la)U@5zE9jn2t8L( zX81%5B2%>F4iIQQ*!=|^;t?PSN?@8gFwrSJ@S3$#y8xt&xUbuD-u=7}9#eLWR72-qTT@xu+BTcA6}iClYMq3D|3PS&w~_olnHK zbbUG}X3XIIUV2VpcbYSqR^lWK`E;G4pb|N_JYdhO-P9g;3Pq zx#XGZHE!5Xc?m~}&3$AbIXJZLI=xQV><&VT5CXbQ&*Kz10ue(bo$2A61QOcN*>`p;EOKRNXLPtn*{8w3F-Cleb(>;Dq;Q;C(4 zd?J7xq=(1C&}V+H(IjuWE!QWIPhSF^7YZk!fUfOIo+QzqwU^5k7P>3Y8U%-;?GA!O zHYcntF5ohIP^By2K2uO|W-gA~czK@O*61M(U{K*rXX`j+=FR!L5*bC z8%ZNoC}V;XL!Kpb>sP)JkSj_sf;rwMx2$<+g%bK77T7~8tSw-VD@GV=JA)2g5Hs@& zN(X^2sMAj;J;5fpbBvQ$s%Wr@mKo`t|+60qbQv%_fRc(1N8*2fDS zc~Y)?i3pyo`Y`?2GK=TmHMB1Sk?@)-KhzR}Oj=qWo(Ut-uUx}_lC%xNatZzBfmEBJ zSB2ILfPtS-VxP5RivoeD?|F1}MKFC}S2DXwe+>&i*)@^(pNc<0Ylm@t;ENoizkQkG z#jnpbKyf#qNVcsT*VPwT{GWW9AfDFmg(z^eN2;&JR3~wRYIg?8~`b z6w+Q}ETeZ#j>1Z?z5425VK$AnXI=J;)o?YW1AC@*n=7rc0xy8rmLo~Jcb!bgn3ceG zv1@S2g~rpP*}ia;hD~CRV%Kn2XA_Ux$o_4-22CZ*sM5r!eGy6Peeyw==5WHgAUBr! zfvRYibkq^Pj~pB0`BIi)Xx#xu3H)+%OM`sS+HY@3+2tFUh{#~*CgyA#2A6>lqfn z6S5O{6{Wk3D3`MS+HG^VfwulGBaN;h`#huNIg<4%zjQE;0edb^GBt_26eM9Eg~2<= z%x&8wNd;sz2J(b`T`Vn+b%GZu!pg_&@u44I_b|jc_M^Ast*GX% z~cER`C{E`DzN*%y4r>@ti4A$Le2~6EEK|BE&%nFopIQQ zN!-D9pX<=ija}?3M}Wur)SnR4!Q^=N{TZI>K-5OX+PuZ@ecEdP)O|3 z;Z49IgbEtgSJg(*(Aa^$Aoi=5ZV6^_E4HzP)mn?bbRzqSk-Q@}P! zU^@l7uS{R0FQ1#*uh%#!jP+VDBI7|deK+xz-o;cMwsFQa_N6oU`m|HL^uTLD=QXI? zqFiDND9*>fT!W9Zuh{5;R})jH-(6Au;dQ~kD`bIM)20??E{+DjC_(m7K9a=~L+3%m zmtNX7LSUw(wb78YdD4gQYKDwb0w6BK=Xyc%RRPAvWSvJs>w0h2R385!%w)PxhWr&M01bMie zx>a1ez2u_4;Q$qR#^a%(z`bD;W}PcbW;gZp$;XJ(jj16;20aY3xp5(V_)^EWM`}Gr zK#ADYB0DVWY&9JP_oH)FDL~K(Y0HNT%jo5+7MAC6`q*B*BqP)IfOA zSs1}p4ht#5?g87B?XYTl`HxLvWh($kg4e|Fz2Zvohr;hXR?n)(=s&V%ugp%$J_YTVFooJk<#&j9b704}aM+b!QM* zY2B{6NUDF@2GpzM?B-{6Ghg#rk|qw*Qr=FO%CA^HN`cxwni?*?^I8;o%^2I|#b!@H z!~kFZVrVLm*xR}zG$0!nJB)j{!+gufR3EieNl0$mvb9e%%PXc-huMH^XTw*p?1 zYyBDhW(uaF%N2hMyCTWakzvUi@hY_+R8p{u`b*vcrP^U z_*g|+yWK|d2olI`sQ^ThBwo*25*7;P@yH3tB(f9HU$-isz0RnuWHIEzUyNIb?n@Re zv$Du(b|ul3b3Fq0U>?6%DxBrqHZ@M!(Q9Sr<$XXSD&RZR=lmi8#WaVOpR03FJ!gJX7}xq)vi!L65L~h`COI7w7PQN!xMG^TmKZsOTAK%u z#7EYSymBa>Y&`4@Ffm&lxog|JGhG>BPx$u;Ig zhanra)@5TBV{@8(le)od=MZScTHK2=8cikHIuNW>^0PQLiQ-@U95r?P0sc?spnX8XB-Fwp8ZN9nk*gQNY==j2)0kCP> zDS3wH9LV%ani_3bU2|xy#zAU$rwL<`uAe~6y>{(&G8kQVUiZh>m`rur~bZ0XVL~QQ(q<_ClM)5o8+`+95hA?X0lOj&2f6?i%}xEm~y3R zZA1w3h^*;MJ*GFdRrP9o(a}EeSy$0MRB1H>ND#EI?o(ILX|D1yXsML7Jz;PiQelZ+ zp!i9t0BZQ}Y0c!zH|4A21GdDR7i)Cpg{XY}^=@lm1vWb9>y^p4F^Fj{5|XH~U(`1y zf0U&kUb4c0uQ(#`!MNRwE;%*DP}`saRhM}Q@8)WSInEKkDq_N)ih@A^4cDIuzpTR1 zg1^TRqQx;vVRq~}7XnA(a3&`_p-X}Rp+M!R82&a9yRuU2)qbcH!*(OuBG-ZxL$7^3 zk&b$I^~5I@OdQRRR`nvwa|Z8Ax*#R#RSH|9#$u7?>1oDhG*RHFDlwSr4bi&61QLwz zDLzl|vh{cbR+{+2Riced&uLkYy9`dK_ScE8u`N&ueqg2cUruA%=)P)#35CF58vwV> zIFPBlmMmvWShXzwjAC;X9Q9dnE`&F@@U8Utn=nx1ySEfLX(0((;LiiMhO*{o z332vyIVs;A+_1A?y(oW|?Fl2oUa(^_iON_+oYqiYgd}-iq2eyFl8e*2C7b|Q$7#)w zm1s2=sH^Fdv2u>d+BWU{?4KqFr-5CP>KbEH1xpYDVVij6M-c8AG=ym^@?d!I(P`9u z(W@77VDq{wy0<#R`)C@Tr;x*YPD61$^u=U&KnFrtLk+}c7XYQ}!}&%5t49-o8#I6j z8$BWc@|_PmISg)MZFq}`=(Tu&Y0*gn=!zUT%R6}HnzGC1I3zr#o#GHqMQG@>OzQj7okNAF z(psjhjkl6sE-6TI^GhnVg0K&Qnd~;28l$D{!$=pSZL9m)_hz5f__8{k;McQxsl7yL zoV4+ZL@DetHhsB+u&|Sr*#=j%+t!eitu!F$RMK>tLL_&GeKR_!oe^eQ=FnS3U9fs4 zI?FrCXlH>RT``+eW}G!(+Yec7JR&Y?WJi( zmoa%r*|6?kWI2MyMWFR&UR94W?=gsTJxJ}_*g_YkdUWL!owBrj-lX=Hx;)8+BIbFr zftcCqOWQ7{96mH7cGBrD==xgg7+$j^gyKT_a)O9QZ?{T>TX!jrkd>J#Cm|;2;tO2| z=43{SY5NJhTQKQ*&oeNy$u#WO!de&b$r+usOzH|f+vA&o_9PCcYXVad((7s>b=O!Z zxvTY)LL%1i&SDV@+C7(o`!I)3_ln}{m?q?=Y~@fKh>zj!lY5>N_O3$Ml2U5KPx+(7 zN0LYrf4JaN?NRvbXSVht{+PCc8`(XyfG??_f2D8e;jKH>`WI|T!;WbjqP9zrm*ZR7KW`bM%aMZ4>;lijsSslVlc+pT}&WfxFuQSMv0}uM1%mqJA$7GWa z6pIIode$f6LrBHlm1tMmunGE`=P4W`HIGYvT#t8kYINF0AA{{c=jGrCMA7YO`<&7m znPRW=3T+R(iyAEZD5LAgt+0a^)JQ95Y} zArV<65fxQBr;(Bl?f2HlYs0 ziGdJ%;O|#epl^W;RG_kRG@~>7OHhi=$l8MLJ1b@ZM>7{2pdviba?Qm47dPlXx4gn5 zAS((u#k2^#&-gl#^es}6f5-WyC+g41pS(8g(F7)M06uYiwe0*BfoQ)={+9!*<1+zM zpe4zFKtG#={Y zWh|VWfPQ@cp#n$BpCHi$Fq3A1NJ*f0`j5@bc=iX#zgcbujwXNJ%$8|Sv|Ql8_W^R* zf9Tq6-~sy2ga7Yw^MCDC&}KYbVj#*CIDmc}rk9j|j8g*IG1;2^%l?~tkPAUa! zoPSK-#rj{#|LUpVSk(V~Fn@15{M8crTjX;6d-DGbxPRIH@BK7?9A#=eKOijruWrUa zH|Ben#;-;|-(p?xH>CfwTj$T*@7>LQyk=br|G@pFquD<@LjKJ8-uCLNSK7B=k^Fbg zA3CS~4E^4B>8qpGw|FJ}1N48^U;fBn>u1XM)-XTrI(OM$QvTNt=KtpC^fUK+i;S=aQLge^)V~~G-zzMBoxuDS=O(|*`v;1gKX3c@GJ`*k za60qfF#ev4`Df+EpE=)Gb$=Bt{1(v`f5!Qj&icO6_{Yu)@%|;?4@$*8G>EADkeqE{m7WL`BO#91q`=2-V`_;N1uP(+}zs&l(<<*~)e?RN~b;0jj z5a;|l`5!F*{S5hjw(!SY+EDOI$ls&#chmVlGroU@`a19UEsRQj$M}a?NO>s;-~$;5 R2np~f1o-$>Q}y+){|A@R9n$~+ literal 0 HcmV?d00001 diff --git a/springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.properties b/springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..ad7845be3 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/springdoc-openapi-gradle-plugin/gradlew b/springdoc-openapi-gradle-plugin/gradlew new file mode 100755 index 000000000..b9bb139f7 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the 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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/springdoc-openapi-gradle-plugin/gradlew.bat b/springdoc-openapi-gradle-plugin/gradlew.bat new file mode 100644 index 000000000..24c62d56f --- /dev/null +++ b/springdoc-openapi-gradle-plugin/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/springdoc-openapi-gradle-plugin/settings.gradle b/springdoc-openapi-gradle-plugin/settings.gradle new file mode 100644 index 000000000..5008d0dee --- /dev/null +++ b/springdoc-openapi-gradle-plugin/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springdoc-openapi-gradle-plugin' \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/OpenApiGenerateExtension.java b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/OpenApiGenerateExtension.java new file mode 100644 index 000000000..6d6f73296 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/OpenApiGenerateExtension.java @@ -0,0 +1,68 @@ +package org.springdoc.gradle; + +import org.gradle.api.file.DirectoryProperty; +import org.gradle.api.model.ObjectFactory; +import org.gradle.api.provider.MapProperty; +import org.gradle.api.provider.Property; + +import javax.inject.Inject; + +/** + * Extension for the {@code openApiGenerate { ... }} DSL block. + */ +public abstract class OpenApiGenerateExtension { + + private final Property outputFileName; + private final DirectoryProperty outputDir; + private final Property format; + private final Property mainClass; + private final Property timeoutSeconds; + private final Property skip; + private final MapProperty systemProperties; + + @Inject + public OpenApiGenerateExtension(ObjectFactory objects) { + this.outputFileName = objects.property(String.class).convention("openapi"); + this.outputDir = objects.directoryProperty(); + this.format = objects.property(String.class).convention("json"); + this.mainClass = objects.property(String.class); + this.timeoutSeconds = objects.property(Integer.class).convention(120); + this.skip = objects.property(Boolean.class).convention(false); + this.systemProperties = objects.mapProperty(String.class, String.class); + } + + public Property getOutputFileName() { + return outputFileName; + } + + public DirectoryProperty getOutputDir() { + return outputDir; + } + + public Property getFormat() { + return format; + } + + public Property getMainClass() { + return mainClass; + } + + public Property getTimeoutSeconds() { + return timeoutSeconds; + } + + /** + * Whether generation should be skipped entirely. Defaults to {@code false}. + */ + public Property getSkip() { + return skip; + } + + /** + * Additional system properties ({@code -D}) passed to the forked worker JVM, e.g. + * {@code spring.profiles.active=generation} or {@code spring.autoconfigure.exclude=...}. + */ + public MapProperty getSystemProperties() { + return systemProperties; + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/SpringDocOpenApiGradlePlugin.java b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/SpringDocOpenApiGradlePlugin.java new file mode 100644 index 000000000..25a357214 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/SpringDocOpenApiGradlePlugin.java @@ -0,0 +1,108 @@ +package org.springdoc.gradle; + +import org.gradle.api.Plugin; +import org.gradle.api.Project; +import org.gradle.api.artifacts.Configuration; +import org.gradle.api.tasks.SourceSet; +import org.gradle.api.tasks.SourceSetContainer; +import org.gradle.api.tasks.TaskProvider; +import org.gradle.jvm.toolchain.JavaToolchainService; +import org.gradle.jvm.toolchain.JavaLauncher; +import org.springdoc.gradle.tasks.GenerateOpenApiTask; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Properties; + +/** + * Gradle plugin that generates the OpenAPI specification for a Spring Boot application + * without ever starting a web server. It forks a dedicated JVM that boots the application's + * reactive web context (with a no-op web server factory), lets springdoc-openapi build the + * spec, then writes it to disk and shuts the context down. + */ +public class SpringDocOpenApiGradlePlugin implements Plugin { + + private static final String PLUGIN_PROPERTIES = "/springdoc-openapi-gradle-plugin.properties"; + private static final String PLUGIN_VERSION = loadPluginVersion(); + + @Override + public void apply(Project project) { + // Configuration carrying the thin worker jar (and its transitive runtime deps). + Configuration generatorConfig = project.getConfigurations().create("springdocGenerator") + .setVisible(false) + .setTransitive(true); + // Deliberately does NOT add a springdoc stack API as a safety net: forcing the + // webflux-api jar onto the fork classpath of a WebMvc app would flip springdoc's + // stack detection (servlet-first) and silently generate a reactive spec for a + // servlet app. The target app's own runtimeClasspath already provides the stack API + // it needs. This keeps the fork classpath identical in shape to the Maven Mojo's. + generatorConfig.defaultDependencies(dependencies -> dependencies.addAll(java.util.List.of( + project.getDependencies().create( + "io.github.vpelikh:springdoc-openapi-generator-worker:" + PLUGIN_VERSION) + ))); + + OpenApiGenerateExtension extension = project.getExtensions() + .create("openApiGenerate", OpenApiGenerateExtension.class, project.getObjects()); + extension.getOutputDir().convention(project.getLayout().getBuildDirectory().dir("docs")); + + SourceSet mainSourceSet = project.getExtensions() + .getByType(SourceSetContainer.class) + .getByName("main"); + + TaskProvider task = project.getTasks().register("generateOpenApi", GenerateOpenApiTask.class, t -> { + t.setGroup("documentation"); + t.setDescription("Generates the OpenAPI specification from the Spring Boot application."); + t.dependsOn(mainSourceSet.getClassesTaskName()); + t.getClasspath().from(mainSourceSet.getOutput(), mainSourceSet.getRuntimeClasspath()); + t.getGeneratorClasspath().from(generatorConfig); + t.getOutputDir().convention(extension.getOutputDir()); + t.getMainClass().convention(extension.getMainClass()); + t.getOutputFileName().convention(extension.getOutputFileName()); + t.getFormat().convention(extension.getFormat()); + t.getTimeoutSeconds().convention(extension.getTimeoutSeconds()); + t.getSystemProperties().set(extension.getSystemProperties()); + var javaExe = resolveJavaLauncherExecutable(project); + if (javaExe != null) { + t.getJavaExecutable().convention(javaExe); + } + // Allow skipping via the extension (`openApiGenerate.skip = true`). + t.onlyIf(spec -> !extension.getSkip().getOrElse(false)); + }); + } + + /** + * Resolves the {@code java} executable from the project's Java toolchain (the same JDK used + * to compile the application), so the forked worker runs on the configured toolchain rather + * than the Gradle daemon's JVM. Falls back to the daemon JVM if there is no toolchain. + */ + private static org.gradle.api.provider.Provider resolveJavaLauncherExecutable(Project project) { + JavaToolchainService toolchainService = project.getExtensions().findByType(JavaToolchainService.class); + org.gradle.api.plugins.JavaPluginExtension javaExtension = + project.getExtensions().findByType(org.gradle.api.plugins.JavaPluginExtension.class); + if (toolchainService == null || javaExtension == null || javaExtension.getToolchain() == null) { + return null; + } + org.gradle.api.provider.Provider launcher = + toolchainService.launcherFor(javaExtension.getToolchain()); + return launcher.map(JavaLauncher::getExecutablePath); + } + + private static String loadPluginVersion() { + Properties properties = new Properties(); + try (InputStream stream = SpringDocOpenApiGradlePlugin.class.getResourceAsStream(PLUGIN_PROPERTIES)) { + if (stream == null) { + throw new IllegalStateException("Missing " + PLUGIN_PROPERTIES); + } + properties.load(stream); + } + catch (IOException e) { + throw new IllegalStateException("Unable to load " + PLUGIN_PROPERTIES, e); + } + String pluginVersion = properties.getProperty("plugin.version"); + if (pluginVersion == null || pluginVersion.trim().isEmpty() + || (pluginVersion.startsWith("${") && pluginVersion.endsWith("}"))) { + throw new IllegalStateException("Unresolved plugin.version in " + PLUGIN_PROPERTIES + ": " + pluginVersion); + } + return pluginVersion; + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/tasks/GenerateOpenApiTask.java b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/tasks/GenerateOpenApiTask.java new file mode 100644 index 000000000..634ac94f1 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/main/java/org/springdoc/gradle/tasks/GenerateOpenApiTask.java @@ -0,0 +1,187 @@ +package org.springdoc.gradle.tasks; + +import org.gradle.api.DefaultTask; +import org.gradle.api.GradleException; +import org.gradle.api.file.ConfigurableFileCollection; +import org.gradle.api.file.DirectoryProperty; +import org.gradle.api.file.RegularFileProperty; +import org.gradle.api.provider.MapProperty; +import org.gradle.api.provider.Property; +import org.gradle.api.tasks.CacheableTask; +import org.gradle.api.tasks.Classpath; +import org.gradle.api.tasks.Input; +import org.gradle.api.tasks.InputFile; +import org.gradle.api.tasks.Optional; +import org.gradle.api.tasks.OutputDirectory; +import org.gradle.api.tasks.PathSensitive; +import org.gradle.api.tasks.PathSensitivity; +import org.gradle.api.tasks.TaskAction; + +import javax.inject.Inject; +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * Generates the OpenAPI specification by forking a dedicated JVM that boots the target Spring + * Boot application (WebFlux or WebMvc) against the application's own classpath, writes the spec + * to disk, and shuts the context down. Forking avoids contaminating the Gradle daemon or mixing + * classloaders. + */ +@CacheableTask +public abstract class GenerateOpenApiTask extends DefaultTask { + + private final ConfigurableFileCollection classpath = getProject().getObjects().fileCollection(); + private final ConfigurableFileCollection generatorClasspath = getProject().getObjects().fileCollection(); + private final DirectoryProperty outputDir = getProject().getObjects().directoryProperty(); + private final Property outputFileName = getProject().getObjects().property(String.class).convention("openapi"); + private final Property format = getProject().getObjects().property(String.class).convention("json"); + private final Property mainClass = getProject().getObjects().property(String.class); + private final RegularFileProperty javaExecutable = getProject().getObjects().fileProperty(); + private final Property timeoutSeconds = getProject().getObjects().property(Integer.class).convention(120); + private final MapProperty systemProperties = getProject().getObjects().mapProperty(String.class, String.class); + + @Inject + public GenerateOpenApiTask() { + } + + @Classpath + public ConfigurableFileCollection getClasspath() { + return classpath; + } + + @Classpath + public ConfigurableFileCollection getGeneratorClasspath() { + return generatorClasspath; + } + + @OutputDirectory + public DirectoryProperty getOutputDir() { + return outputDir; + } + + @Input + @Optional + public Property getOutputFileName() { + return outputFileName; + } + + @Input + @Optional + public Property getFormat() { + return format; + } + + @Input + @Optional + public Property getMainClass() { + return mainClass; + } + + /** + * The {@code java} executable to use for the forked worker. When the project applies the + * {@code java} plugin, this is wired to the compilation toolchain's launcher rather than the + * Gradle daemon JVM, keeping the worker on the same JDK as the application. + */ + @InputFile + @Optional + @PathSensitive(PathSensitivity.ABSOLUTE) + public RegularFileProperty getJavaExecutable() { + return javaExecutable; + } + + /** + * Upper bound (seconds) for the forked worker. Defaults to 120. + */ + @Input + @Optional + public Property getTimeoutSeconds() { + return timeoutSeconds; + } + + @Input + @Optional + public MapProperty getSystemProperties() { + return systemProperties; + } + + @TaskAction + public void generate() { + String main = mainClass.getOrNull(); + if (main == null || main.isBlank()) { + throw new GradleException("openApiGenerate.mainClass must be set to the application's @SpringBootApplication class"); + } + + File appOutput = outputDir.getAsFile().get(); + if (!appOutput.exists() && !appOutput.mkdirs()) { + throw new GradleException("Could not create output dir " + appOutput); + } + + String cpString = Stream.concat(classpath.getFiles().stream(), generatorClasspath.getFiles().stream()) + .distinct() + .map(File::getAbsolutePath) + .collect(Collectors.joining(File.pathSeparator)); + + String javaBin; + org.gradle.api.file.RegularFile javaExeRef = javaExecutable.getOrNull(); + File javaExe = javaExeRef != null ? javaExeRef.getAsFile() : null; + if (javaExe != null && javaExe.isFile()) { + javaBin = javaExe.getAbsolutePath(); + } + else { + javaBin = System.getProperty("java.home") + File.separator + "bin" + File.separator + "java"; + } + List command = new ArrayList<>(); + command.add(javaBin); + // Pass through user-supplied system properties (e.g. spring.profiles.active, + // spring.autoconfigure.exclude) so infra-dependent apps can be generated against + // a generation-time profile/overrides. + systemProperties.getOrElse(java.util.Collections.emptyMap()) + .forEach((k, v) -> command.add("-D" + k + "=" + v)); + command.add("-cp"); + command.add(cpString); + command.add("org.springdoc.generator.GeneratorWorkerMain"); + command.add(main); + command.add(appOutput.getAbsolutePath()); + command.add(outputFileName.getOrElse("openapi")); + command.add(format.getOrElse("json")); + + getLogger().lifecycle("Launching generator worker JVM (" + javaBin + ") for main class " + mainClass); + Process process = null; + try { + ProcessBuilder pb = new ProcessBuilder(command); + pb.redirectErrorStream(true); + process = pb.start(); + try (var reader = new java.io.BufferedReader(new java.io.InputStreamReader(process.getInputStream()))) { + String line; + while ((line = reader.readLine()) != null) { + getLogger().lifecycle(line); + } + } + int timeout = timeoutSeconds.getOrElse(120); + boolean finished = process.waitFor(timeout, TimeUnit.SECONDS); + if (!finished) { + process.destroyForcibly(); + throw new GradleException("Generator worker did not finish within " + timeout + "s and was terminated"); + } + int exit = process.exitValue(); + if (exit != 0) { + throw new GradleException("Generator worker exited with code " + exit); + } + } + catch (IOException e) { + throw new GradleException("Failed to launch generator worker: " + e.getMessage(), e); + } + catch (InterruptedException e) { + Thread.currentThread().interrupt(); + if (process != null) { + process.destroyForcibly(); + } + throw new GradleException("Generator worker interrupted", e); + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/main/resources/springdoc-openapi-gradle-plugin.properties b/springdoc-openapi-gradle-plugin/src/main/resources/springdoc-openapi-gradle-plugin.properties new file mode 100644 index 000000000..401723b86 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/main/resources/springdoc-openapi-gradle-plugin.properties @@ -0,0 +1 @@ +plugin.version=${pluginVersion} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/test/java/org/springdoc/gradle/SpringDocOpenApiGradlePluginFunctionalTest.java b/springdoc-openapi-gradle-plugin/src/test/java/org/springdoc/gradle/SpringDocOpenApiGradlePluginFunctionalTest.java new file mode 100644 index 000000000..d6e63eb09 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/test/java/org/springdoc/gradle/SpringDocOpenApiGradlePluginFunctionalTest.java @@ -0,0 +1,214 @@ +package org.springdoc.gradle; + +import org.gradle.testkit.runner.BuildResult; +import org.gradle.testkit.runner.GradleRunner; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +import static org.gradle.testkit.runner.TaskOutcome.SKIPPED; +import static org.gradle.testkit.runner.TaskOutcome.SUCCESS; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class SpringDocOpenApiGradlePluginFunctionalTest { + + @TempDir + Path testProjectDir; + + private Path sampleApp; + + @BeforeEach + void setUp() throws IOException { + sampleApp = Paths.get("src/test/resources/sample-app-webflux"); + } + + @Test + void generatesOpenApiSpecFromReactiveApp() throws IOException { + // Copy sample app into the temp project + copyRecursively(sampleApp, testProjectDir); + + // Add settings + build for the sample app, using the plugin under test + Files.writeString(testProjectDir.resolve("settings.gradle"), "rootProject.name = 'sample-app-webflux'\n"); + Files.writeString(testProjectDir.resolve("build.gradle"), """ + plugins { + id 'java' + id 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + } + + repositories { + mavenLocal() + mavenCentral() + } + + dependencies { + implementation 'org.springframework.boot:spring-boot-starter-webflux:4.1.1' + implementation 'io.github.vpelikh:springdoc-openapi-starter-webflux-api:5.0.6-SNAPSHOT' + } + + openApiGenerate { + mainClass = 'test.SampleApp' + } + """); + + BuildResult result = GradleRunner.create() + .withProjectDir(testProjectDir.toFile()) + .withArguments("generateOpenApi", "--stacktrace") + .withPluginClasspath() + .build(); + + assertTrue(result.task(":generateOpenApi").getOutcome() == SUCCESS); + Path spec = testProjectDir.resolve("build/docs/openapi.json"); + assertTrue(Files.exists(spec), "Expected generated spec at " + spec + " but it does not exist"); + String content = Files.readString(spec); + assertTrue(content.contains("/pets"), "expected /pets path in spec but was: " + content.substring(0, Math.min(200, content.length()))); + assertTrue(content.contains("openapi") || content.contains("swagger"), "expected OpenAPI doc root"); + } + + @Test + void generatesOpenApiSpecFromServletApp() throws IOException { + copyRecursively(Paths.get("src/test/resources/sample-app-webmvc"), testProjectDir); + + Files.writeString(testProjectDir.resolve("settings.gradle"), "rootProject.name = 'sample-app-webmvc'\n"); + Files.writeString(testProjectDir.resolve("build.gradle"), """ + plugins { + id 'java' + id 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + } + + repositories { + mavenLocal() + mavenCentral() + } + + dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web:4.1.1' + implementation 'io.github.vpelikh:springdoc-openapi-starter-webmvc-api:5.0.6-SNAPSHOT' + } + + openApiGenerate { + mainClass = 'test.SampleApp' + systemProperties = [ + 'spring.main.banner-mode': 'off' + ] + } + """); + + BuildResult result = GradleRunner.create() + .withProjectDir(testProjectDir.toFile()) + .withArguments("generateOpenApi", "--stacktrace") + .withPluginClasspath() + .build(); + + assertTrue(result.task(":generateOpenApi").getOutcome() == SUCCESS); + Path spec = testProjectDir.resolve("build/docs/openapi.json"); + assertTrue(Files.exists(spec), "Expected generated webmvc spec at " + spec + " but it does not exist"); + String content = Files.readString(spec); + assertTrue(content.contains("/pets"), "expected /pets path in webmvc spec but was: " + content.substring(0, Math.min(200, content.length()))); + } + + @Test + void skipFlagProducesNoSpec() throws IOException { + copyRecursively(sampleApp, testProjectDir); + + Files.writeString(testProjectDir.resolve("settings.gradle"), "rootProject.name = 'sample-app-skip'\n"); + Files.writeString(testProjectDir.resolve("build.gradle"), """ + plugins { + id 'java' + id 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + } + + repositories { + mavenLocal() + mavenCentral() + } + + dependencies { + implementation 'org.springframework.boot:spring-boot-starter-webflux:4.1.1' + implementation 'io.github.vpelikh:springdoc-openapi-starter-webflux-api:5.0.6-SNAPSHOT' + } + + openApiGenerate { + mainClass = 'test.SampleApp' + skip = true + } + """); + + BuildResult result = GradleRunner.create() + .withProjectDir(testProjectDir.toFile()) + .withArguments("generateOpenApi", "--stacktrace") + .withPluginClasspath() + .build(); + + // The task is skipped, not exercised, and the build still succeeds. + assertTrue(result.task(":generateOpenApi").getOutcome() == SKIPPED, + "expected generateOpenApi to be SKIPPED when skip=true"); + Path spec = testProjectDir.resolve("build/docs/openapi.json"); + assertTrue(!Files.exists(spec), "Expected no spec at " + spec + " when skip=true"); + } + + @Test + void generatesOpenApiYamlFormat() throws IOException { + copyRecursively(sampleApp, testProjectDir); + + Files.writeString(testProjectDir.resolve("settings.gradle"), "rootProject.name = 'sample-app-yaml'\n"); + Files.writeString(testProjectDir.resolve("build.gradle"), """ + plugins { + id 'java' + id 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + } + + repositories { + mavenLocal() + mavenCentral() + } + + dependencies { + implementation 'org.springframework.boot:spring-boot-starter-webflux:4.1.1' + implementation 'io.github.vpelikh:springdoc-openapi-starter-webflux-api:5.0.6-SNAPSHOT' + } + + openApiGenerate { + mainClass = 'test.SampleApp' + format = 'yaml' + } + """); + + BuildResult result = GradleRunner.create() + .withProjectDir(testProjectDir.toFile()) + .withArguments("generateOpenApi", "--stacktrace") + .withPluginClasspath() + .build(); + + assertTrue(result.task(":generateOpenApi").getOutcome() == SUCCESS); + Path spec = testProjectDir.resolve("build/docs/openapi.yaml"); + assertTrue(Files.exists(spec), "Expected generated yaml spec at " + spec + " but it does not exist"); + String content = Files.readString(spec); + assertTrue(content.contains("openapi:"), "expected YAML root marker in spec but was: " + content.substring(0, Math.min(200, content.length()))); + assertTrue(content.contains("/pets"), "expected /pets path in yaml spec but was: " + content.substring(0, Math.min(200, content.length()))); + // A JSON file would start with '[' or '{'; a YAML spec must not. + String trimmed = content.trim(); + assertTrue(!trimmed.startsWith("{") && !trimmed.startsWith("["), + "expected YAML output but got JSON: " + content); + } + + private void copyRecursively(Path source, Path target) throws IOException { + try (var stream = Files.walk(source)) { + for (Path src : (Iterable) stream::iterator) { + Path dest = target.resolve(source.relativize(src).toString()); + if (Files.isDirectory(src)) { + Files.createDirectories(dest); + } + else { + Files.createDirectories(dest.getParent()); + Files.copy(src, dest, java.nio.file.StandardCopyOption.REPLACE_EXISTING); + } + } + } + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/PetController.java b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/PetController.java new file mode 100644 index 000000000..d612afce2 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/PetController.java @@ -0,0 +1,22 @@ +package test; + +import io.swagger.v3.oas.annotations.Operation; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Mono; + +@RestController +public class PetController { + + @Operation(summary = "Get a pet by id") + @GetMapping("/pets/{id}") + public Mono getPet(@PathVariable String id) { + return Mono.just("pet-" + id); + } + + @GetMapping("/pets") + public Mono listPets() { + return Mono.just("[]"); + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/SampleApp.java b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/SampleApp.java new file mode 100644 index 000000000..9e71918ed --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webflux/src/main/java/test/SampleApp.java @@ -0,0 +1,10 @@ +package test; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SampleApp { + public static void main(String[] args) { + // entry point used by the generator worker + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/PetController.java b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/PetController.java new file mode 100644 index 000000000..d83d9dd6a --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/PetController.java @@ -0,0 +1,19 @@ +package test; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public String getPet(@PathVariable String id) { + return "pet-" + id; + } + + @GetMapping("/pets") + public String listPets() { + return "[]"; + } +} \ No newline at end of file diff --git a/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/SampleApp.java b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/SampleApp.java new file mode 100644 index 000000000..11cb40274 --- /dev/null +++ b/springdoc-openapi-gradle-plugin/src/test/resources/sample-app-webmvc/src/main/java/test/SampleApp.java @@ -0,0 +1,9 @@ +package test; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SampleApp { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/.gitignore b/springdoc-openapi-maven-plugin/.gitignore new file mode 100644 index 000000000..ab21548c1 --- /dev/null +++ b/springdoc-openapi-maven-plugin/.gitignore @@ -0,0 +1,144 @@ +###################### +# Project Specific +###################### +/target/www/** +/src/test/javascript/coverage/ + +###################### +# Node +###################### +/node/ +node_tmp/ +node_modules/ +npm-debug.log.* +/.awcache/* +/.cache-loader/* + +###################### +# SASS +###################### +.sass-cache/ + +###################### +# Eclipse +###################### +*.pydevproject +.project +.metadata +tmp/ +tmp/**/* +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath +.factorypath +/src/main/resources/rebel.xml + +# External tool builders +.externalToolBuilders/** + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + +###################### +# Intellij +###################### +.idea/ +*.iml +*.iws +*.ipr +*.ids +*.orig +classes/ +out/ + +###################### +# Visual Studio Code +###################### +.vscode/ + +###################### +# Maven +###################### +/log/ +/target/ + +###################### +# Gradle +###################### +.gradle/ +/build/ + +###################### +# Package Files +###################### +*.jar +*.war +*.ear +*.db + +###################### +# Windows +###################### +# Windows image file caches +Thumbs.db + +# Folder config file +Desktop.ini + +###################### +# Mac OSX +###################### +.DS_Store +.svn + +# Thumbnails +._* + +# Files that might appear on external disk +.Spotlight-V100 +.Trashes + +###################### +# Directories +###################### +/bin/ +/deploy/ + +###################### +# Logs +###################### +*.log* + +###################### +# Others +###################### +*.class +*.*~ +*~ +.merge_file* + +###################### +# Gradle Wrapper +###################### +!gradle/wrapper/gradle-wrapper.jar + +###################### +# Maven Wrapper +###################### +!.mvn/wrapper/maven-wrapper.jar + +###################### +# ESLint +###################### +.eslintcache \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/README.md b/springdoc-openapi-maven-plugin/README.md new file mode 100644 index 000000000..97eacc3cc --- /dev/null +++ b/springdoc-openapi-maven-plugin/README.md @@ -0,0 +1,119 @@ +# springdoc-openapi-maven-plugin + +A Maven plugin that generates the [OpenAPI](https://swagger.io/specification/) specification +for a Spring Boot application without leaving a web server running. It forks a dedicated JVM and +supports both stacks with no per-stack config; the worker detects the target app's stack from its +classpath and dispatches to the matching generator. + +## Important: WebFlux vs WebMvc + +> **WebFlux (reactive) — genuinely serverless.** A no-op `ReactiveWebServerFactory` keeps springdoc +> active and **no port is ever bound**. This fully honors the "generate without starting the app" +> goal. +> +> **WebMvc (servlet) — starts a real, ephemeral server.** The servlet model requires an actual +> container (the `DispatcherServlet` must register in a `ServletContext`), so generation boots the +> embedded server on an **ephemeral port (0)** and shuts the context down immediately after writing +> the spec. No fixed/exposed port is used and nothing stays listening, but a real container does +> briefly start. This is a servlet-model constraint, not a plugin choice. + +Reuses the shared worker module (`springdoc-openapi-generator-worker`) that the Gradle plugin +also uses, so the two build systems share one implementation. + +## Usage + +Bind the goal to the `package` (default) phase or invoke it directly: + +```xml + + io.github.vpelikh + springdoc-openapi-maven-plugin + 5.0.6-SNAPSHOT + + com.example.YourApplication + + + + + generate + + + + +``` + +Then: + +``` +mvn package # or mvn springdoc:generate +``` + +The spec is written to `${project.build.directory}/docs/openapi.json` by default. + +## Goal: `generate` + +| Parameter | Property | Default | Description | +|------------------|----------------------|---------------------------|------------------------------------------| +| `mainClass` | `springdoc.mainClass` | *required* | Application's `@SpringBootApplication` base class | +| `outputDir` | `springdoc.outputDir` | `${project.build.directory}/docs` | Directory for the generated document | +| `outputFileName` | `springdoc.outputFileName` | `openapi` | Base file name (extension appended) | +| `format` | `springdoc.format` | `json` | `json` or `yaml` | +| `timeout` | `springdoc.timeout` | `120` | Worker time bound in seconds; aborts on timeout | +| `skip` | `springdoc.skip` | `false` | Skip generation entirely (`mvn package -Dspringdoc.skip=true`) | +| `systemProperties`| `` | `{}` | Extra `-D` props for the worker JVM | + +## How it works + +1. The Mojo collects the project's runtime classpath (plus compiled output and the shared + `springdoc-openapi-generator-worker` jar, resolved at the plugin's own version). +2. It forks a JVM running `org.springdoc.generator.GeneratorWorkerMain`. +3. The worker detects the app's stack from its classpath and dispatches to the matching + generator: + - WebFlux: a no-op `ReactiveWebServerFactory` keeps springdoc active with **no port bound**. + - WebMvc: the embedded server starts on an **ephemeral port** and is shut down immediately. +4. It invokes springdoc's matching `OpenApi*Resource` with a mock request, writes the JSON/YAML + document, and shuts the context down. + +### Generating apps that need infrastructure + +The worker boots the application's real context, so beans needing external resources (a database, +JMS broker, external service) must be satisfiable at generation time. Use `systemProperties` to +point generation at a test profile/overrides, e.g. for a JPA/Hibernate app: + +```xml + + com.example.App + + generation + + org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration + + + +``` + +The `-D` properties reach the forked worker (verified: `spring.profiles.active` activates in the +worker JVM), so Spring reads annotations off the classpath without needing a real connection. + +## Notes / limitations + +- **WebFlux "no port bound" caveat:** the no-op `ReactiveWebServerFactory` is registered with + `@ConditionalOnMissingBean`. If the application itself defines a `ReactiveWebServerFactory` bean, + that one wins and a real server can bind a port at generation time. This is rare (configuring the + server via a `WebServerFactoryCustomizer` does not define a factory bean and is unaffected). To + guarantee no port is bound, avoid defining such a bean. +- The fork-invocation logic (build `java -cp`, stream output, time out) is intentionally kept small + and duplicated in the Gradle task and Maven Mojo rather than extracted into a shared helper, to + avoid coupling the plugins to the worker jar's compile classpath. The shared worker still owns + the actual generation. +- The offline spec's `servers` entry defaults to `http://localhost` (WebMvc) / a mock URL + (WebFlux). Set `@OpenAPIDefinition(servers = @Server(...))` or a global `OpenApiCustomizer` to + override it for your deployment. + +## Building the plugin + +From the repo root (with the fork modules already installed): + +``` +mvn -pl springdoc-openapi-generator-worker,springdoc-openapi-maven-plugin -am install -DskipTests +``` \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/pom.xml b/springdoc-openapi-maven-plugin/pom.xml new file mode 100644 index 000000000..d52e13d0f --- /dev/null +++ b/springdoc-openapi-maven-plugin/pom.xml @@ -0,0 +1,81 @@ + + 4.0.0 + + io.github.vpelikh + springdoc-openapi + 5.0.6-SNAPSHOT + + springdoc-openapi-maven-plugin + maven-plugin + ${project.artifactId} + A Maven plugin to generate the OpenAPI specification from a Spring Boot application without leaving a web server running. + + + + + org.apache.maven + maven-plugin-api + 3.9.6 + provided + + + org.apache.maven.plugin-tools + maven-plugin-annotations + 3.13.1 + provided + + + org.apache.maven + maven-core + 3.9.6 + provided + + + + + + + org.apache.maven.plugins + maven-plugin-plugin + 3.13.1 + + springdoc + + + + default-descriptor + + descriptor + + + + + + + org.apache.maven.plugins + maven-invoker-plugin + 3.10.1 + + ${project.build.directory}/it + ${settings.localRepository} + verify + true + + ${project.version} + + + + + integration-test + + install + integration-test + verify + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-jpa/pom.xml b/springdoc-openapi-maven-plugin/src/it/generate-jpa/pom.xml new file mode 100644 index 000000000..eedc7f019 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-jpa/pom.xml @@ -0,0 +1,61 @@ + + 4.0.0 + test + springdoc-generate-jpa-it + 1.0.0 + jar + + + 17 + UTF-8 + + + + + org.springframework.boot + spring-boot-starter-web + 4.1.1 + + + org.springframework.boot + spring-boot-starter-data-jpa + 4.1.1 + + + com.h2database + h2 + 2.3.232 + runtime + + + io.github.vpelikh + springdoc-openapi-starter-webmvc-api + ${springdoc.version} + + + + + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${springdoc.version} + + it.App + + jdbc:h2:mem:gen;DB_CLOSE_DELAY=-1 + org.h2.Driver + create-drop + + + + + + generate + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/App.java b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/App.java new file mode 100644 index 000000000..438310580 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/App.java @@ -0,0 +1,9 @@ +package it; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class App { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/Pet.java b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/Pet.java new file mode 100644 index 000000000..39554309e --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/Pet.java @@ -0,0 +1,31 @@ +package it; + +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; + +@Entity +public class Pet { + + @Id + @GeneratedValue + private Long id; + + private String name; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/PetController.java b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/PetController.java new file mode 100644 index 000000000..2572b84a8 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-jpa/src/main/java/it/PetController.java @@ -0,0 +1,21 @@ +package it; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public Pet getPet(Long id) { + Pet pet = new Pet(); + pet.setId(id); + pet.setName("pet-" + id); + return pet; + } + + @GetMapping("/pets") + public String listPets() { + return "[]"; + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-jpa/verify.groovy b/springdoc-openapi-maven-plugin/src/it/generate-jpa/verify.groovy new file mode 100644 index 000000000..de6d5a5d2 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-jpa/verify.groovy @@ -0,0 +1,21 @@ +// +// Post-build hook for the maven-invoker-plugin 'generate-jpa' IT. +// Verifies the plugin generated a spec for an app whose context needs a real DataSource +// (spring-boot-starter-data-jpa + Hibernate), using the spring.datasource.* overrides passed +// through systemProperties. It also checks the JPA @Entity was reflected as a schema. +// +def spec = new File(basedir, 'target/docs/openapi.json') +if (!spec.isFile()) { + throw new FileNotFoundException('Expected generated OpenAPI at ' + spec) +} + +def content = spec.text +if (!content.contains('/pets') || !content.contains('/pets/{id}')) { + throw new IllegalStateException('Generated OpenAPI is missing the /pets paths: ' + content) +} +// The Pet entity should be reflected as a schema (proves JPA annotations were read). +if (!content.contains('"Pet"')) { + throw new IllegalStateException('Generated OpenAPI is missing the JPA Pet schema: ' + content) +} + +println 'Verified JPA (Hibernate + DataSource override) OpenAPI spec: ' + spec \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-skip/pom.xml b/springdoc-openapi-maven-plugin/src/it/generate-skip/pom.xml new file mode 100644 index 000000000..27c833262 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-skip/pom.xml @@ -0,0 +1,46 @@ + + 4.0.0 + test + springdoc-generate-skip-it + 1.0.0 + jar + + + 17 + UTF-8 + + + + + org.springframework.boot + spring-boot-starter-webflux + 4.1.1 + + + io.github.vpelikh + springdoc-openapi-starter-webflux-api + ${springdoc.version} + + + + + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${springdoc.version} + + it.App + true + + + + + generate + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/App.java b/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/App.java new file mode 100644 index 000000000..438310580 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/App.java @@ -0,0 +1,9 @@ +package it; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class App { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/PetController.java b/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/PetController.java new file mode 100644 index 000000000..c889f3795 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-skip/src/main/java/it/PetController.java @@ -0,0 +1,19 @@ +package it; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Mono; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public Mono getPet(String id) { + return Mono.just("pet-" + id); + } + + @GetMapping("/pets") + public Mono listPets() { + return Mono.just("[]"); + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-skip/verify.groovy b/springdoc-openapi-maven-plugin/src/it/generate-skip/verify.groovy new file mode 100644 index 000000000..3e81632b0 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-skip/verify.groovy @@ -0,0 +1,16 @@ +// +// Post-build hook for the maven-invoker-plugin 'generate-skip' IT. +// Verifies that setting true skips generation entirely: no spec document +// is produced and the build (which still runs the bound goal on the package phase) +// succeeds rather than requiring mainClass/context boot. +// +def docsDir = new File(basedir, 'target/docs') +if (docsDir.exists()) { + def leftovers = docsDir.listFiles() + if (leftovers != null && leftovers.length > 0) { + throw new IllegalStateException('Expected no generated documents when skip=true but found: ' + + leftovers*.name.join(', ')) + } +} + +println 'Verified: skip=true produced no OpenAPI document' \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webflux/pom.xml b/springdoc-openapi-maven-plugin/src/it/generate-webflux/pom.xml new file mode 100644 index 000000000..c19fcbab4 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webflux/pom.xml @@ -0,0 +1,45 @@ + + 4.0.0 + test + springdoc-generate-webflux-it + 1.0.0 + jar + + + 17 + UTF-8 + + + + + org.springframework.boot + spring-boot-starter-webflux + 4.1.1 + + + io.github.vpelikh + springdoc-openapi-starter-webflux-api + ${springdoc.version} + + + + + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${springdoc.version} + + it.App + + + + + generate + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/App.java b/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/App.java new file mode 100644 index 000000000..438310580 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/App.java @@ -0,0 +1,9 @@ +package it; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class App { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/PetController.java b/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/PetController.java new file mode 100644 index 000000000..c889f3795 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webflux/src/main/java/it/PetController.java @@ -0,0 +1,19 @@ +package it; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Mono; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public Mono getPet(String id) { + return Mono.just("pet-" + id); + } + + @GetMapping("/pets") + public Mono listPets() { + return Mono.just("[]"); + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webflux/verify.groovy b/springdoc-openapi-maven-plugin/src/it/generate-webflux/verify.groovy new file mode 100644 index 000000000..7d9cce16c --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webflux/verify.groovy @@ -0,0 +1,15 @@ +// +// Post-build hook for the maven-invoker-plugin 'generate-webflux' IT. +// Verifies that the plugin produced target/docs/openapi.json with the expected paths. +// +def spec = new File(basedir, 'target/docs/openapi.json') +if (!spec.isFile()) { + throw new FileNotFoundException('Expected generated OpenAPI at ' + spec) +} + +def content = spec.text +if (!content.contains('/pets') || !content.contains('/pets/{id}')) { + throw new IllegalStateException('Generated OpenAPI is missing the /pets paths: ' + content) +} + +println 'Verified OpenAPI spec: ' + spec \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webmvc/pom.xml b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/pom.xml new file mode 100644 index 000000000..ded8e343d --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/pom.xml @@ -0,0 +1,48 @@ + + 4.0.0 + test + springdoc-generate-webmvc-it + 1.0.0 + jar + + + 17 + UTF-8 + + + + + org.springframework.boot + spring-boot-starter-web + 4.1.1 + + + io.github.vpelikh + springdoc-openapi-starter-webmvc-api + ${springdoc.version} + + + + + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${springdoc.version} + + it.App + + generation + + + + + + generate + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/App.java b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/App.java new file mode 100644 index 000000000..438310580 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/App.java @@ -0,0 +1,9 @@ +package it; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class App { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/PetController.java b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/PetController.java new file mode 100644 index 000000000..509838c25 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/src/main/java/it/PetController.java @@ -0,0 +1,18 @@ +package it; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public String getPet(String id) { + return "pet-" + id; + } + + @GetMapping("/pets") + public String listPets() { + return "[]"; + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-webmvc/verify.groovy b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/verify.groovy new file mode 100644 index 000000000..b84b59bb0 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-webmvc/verify.groovy @@ -0,0 +1,15 @@ +// +// Post-build hook for the maven-invoker-plugin 'generate-webmvc' IT. +// Verifies that the plugin produced target/docs/openapi.json with the expected paths. +// +def spec = new File(basedir, 'target/docs/openapi.json') +if (!spec.isFile()) { + throw new FileNotFoundException('Expected generated OpenAPI at ' + spec) +} + +def content = spec.text +if (!content.contains('/pets') || !content.contains('/pets/{id}')) { + throw new IllegalStateException('Generated OpenAPI is missing the /pets paths: ' + content) +} + +println 'Verified WebMvc OpenAPI spec: ' + spec \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-yaml/pom.xml b/springdoc-openapi-maven-plugin/src/it/generate-yaml/pom.xml new file mode 100644 index 000000000..f22feca58 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-yaml/pom.xml @@ -0,0 +1,46 @@ + + 4.0.0 + test + springdoc-generate-yaml-it + 1.0.0 + jar + + + 17 + UTF-8 + + + + + org.springframework.boot + spring-boot-starter-webflux + 4.1.1 + + + io.github.vpelikh + springdoc-openapi-starter-webflux-api + ${springdoc.version} + + + + + + + io.github.vpelikh + springdoc-openapi-maven-plugin + ${springdoc.version} + + it.App + yaml + + + + + generate + + + + + + + \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/App.java b/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/App.java new file mode 100644 index 000000000..438310580 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/App.java @@ -0,0 +1,9 @@ +package it; + +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class App { + public static void main(String[] args) { + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/PetController.java b/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/PetController.java new file mode 100644 index 000000000..c889f3795 --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-yaml/src/main/java/it/PetController.java @@ -0,0 +1,19 @@ +package it; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Mono; + +@RestController +public class PetController { + + @GetMapping("/pets/{id}") + public Mono getPet(String id) { + return Mono.just("pet-" + id); + } + + @GetMapping("/pets") + public Mono listPets() { + return Mono.just("[]"); + } +} \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/it/generate-yaml/verify.groovy b/springdoc-openapi-maven-plugin/src/it/generate-yaml/verify.groovy new file mode 100644 index 000000000..a30c0534f --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/it/generate-yaml/verify.groovy @@ -0,0 +1,24 @@ +// +// Post-build hook for the maven-invoker-plugin 'generate-yaml' IT. +// Verifies that yaml produces target/docs/openapi.yaml (not .json) +// containing the expected paths and a YAML-ish body. +// +def spec = new File(basedir, 'target/docs/openapi.yaml') +if (!spec.isFile()) { + throw new FileNotFoundException('Expected generated OpenAPI YAML at ' + spec) +} + +def content = spec.text +if (!content.contains('openapi:')) { + throw new IllegalStateException('Generated file does not look like OpenAPI YAML: ' + content) +} +if (!content.contains('/pets') || !content.contains('/pets/{id}')) { + throw new IllegalStateException('Generated OpenAPI YAML is missing the /pets paths: ' + content) +} + +// A JSON file would start with '{' or '['; a YAML spec should not. +if (content.trim().startsWith('{') || content.contains('"openapi"')) { + throw new IllegalStateException('Expected YAML output but found JSON instead: ' + content) +} + +println 'Verified OpenAPI YAML spec: ' + spec \ No newline at end of file diff --git a/springdoc-openapi-maven-plugin/src/main/java/org/springdoc/maven/GenerateOpenApiMojo.java b/springdoc-openapi-maven-plugin/src/main/java/org/springdoc/maven/GenerateOpenApiMojo.java new file mode 100644 index 000000000..ef512567c --- /dev/null +++ b/springdoc-openapi-maven-plugin/src/main/java/org/springdoc/maven/GenerateOpenApiMojo.java @@ -0,0 +1,236 @@ +package org.springdoc.maven; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.InputStreamReader; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.apache.maven.artifact.DependencyResolutionRequiredException; +import org.apache.maven.execution.MavenSession; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugins.annotations.Component; +import org.apache.maven.plugins.annotations.LifecyclePhase; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.plugins.annotations.ResolutionScope; +import org.apache.maven.project.MavenProject; +import org.eclipse.aether.RepositorySystem; +import org.eclipse.aether.artifact.DefaultArtifact; +import org.eclipse.aether.collection.CollectRequest; +import org.eclipse.aether.graph.Dependency; +import org.eclipse.aether.repository.RemoteRepository; +import org.eclipse.aether.resolution.ArtifactResult; +import org.eclipse.aether.resolution.DependencyRequest; +import org.eclipse.aether.resolution.DependencyResolutionException; +import org.eclipse.aether.resolution.DependencyResult; + +/** + * Maven goal that generates the OpenAPI specification for a Spring Boot application without + * leaving a web server running. It forks a dedicated JVM (using the project's runtime + * classpath) that boots the application's reactive web context on an ephemeral port, lets + * springdoc-openapi build the document, writes it to disk, and shuts the context down. + */ +@Mojo(name = "generate", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.RUNTIME) +public class GenerateOpenApiMojo extends AbstractMojo { + + /** + * The Maven project. + */ + @Parameter(defaultValue = "${project}", readonly = true, required = true) + private MavenProject project; + + /** + * The Maven session. + */ + @Parameter(defaultValue = "${session}", readonly = true, required = true) + private MavenSession session; + + /** + * Aether repository system for resolving the worker artifact. + */ + @Component + private RepositorySystem repositorySystem; + + /** + * Fully-qualified name of the application's {@code @SpringBootApplication} class. + */ + @Parameter(property = "springdoc.mainClass", required = true) + private String mainClass; + + /** + * Directory for the generated document. Defaults to {@code ${project.build.directory}/docs}. + */ + @Parameter(defaultValue = "${project.build.directory}/docs", property = "springdoc.outputDir") + private File outputDir; + + /** + * Base file name of the generated document (without extension). + */ + @Parameter(defaultValue = "openapi", property = "springdoc.outputFileName") + private String outputFileName; + + /** + * Output format: {@code json} or {@code yaml}. + */ + @Parameter(defaultValue = "json", property = "springdoc.format") + private String format; + + /** + * The plugin's own version, used to resolve the matching generator-worker artifact. + */ + @Parameter(defaultValue = "${plugin.version}", readonly = true, required = true) + private String pluginVersion; + + /** + * Upper bound (seconds) for the forked worker. Defaults to 120. + */ + @Parameter(defaultValue = "120", property = "springdoc.timeout") + private int timeout; + + /** + * Skip generation entirely. Useful to disable the bound goal without removing the plugin, + * e.g. {@code mvn package -Dspringdoc.skip=true}. + */ + @Parameter(defaultValue = "false", property = "springdoc.skip") + private boolean skip; + + /** + * Additional system properties ({@code -D}) passed to the forked worker JVM, e.g. + * {@code spring.profiles.active=generation} or {@code spring.autoconfigure.exclude=...}. + */ + @Parameter + private Map systemProperties; + + @Override + public void execute() throws MojoExecutionException { + if (skip) { + getLog().info("Springdoc: generation skipped (springdoc.skip=true)"); + return; + } + if (mainClass == null || mainClass.isBlank()) { + throw new MojoExecutionException("springdoc.mainClass must be set to the application's @SpringBootApplication class"); + } + if (!outputDir.exists() && !outputDir.mkdirs()) { + throw new MojoExecutionException("Could not create output dir " + outputDir); + } + + List classpath = new ArrayList<>(); + try { + classpath.add(project.getBuild().getOutputDirectory()); + classpath.addAll(project.getRuntimeClasspathElements()); + } + catch (DependencyResolutionRequiredException e) { + throw new MojoExecutionException("Could not resolve runtime classpath", e); + } + + // The fork uses the thin shared generator-worker jar (boots the app, exposes + // GeneratorWorkerMain) plus its transitive runtime dependencies (spring-test for the + // mock request). Resolved at the plugin's own version. + List workerJars = resolveWorkerClasspath(); + classpath.addAll(workerJars); + + // keep order & dedupe + Set dedup = new LinkedHashSet<>(classpath); + String cp = String.join(File.pathSeparator, dedup); + + String javaBin = System.getProperty("java.home") + File.separator + "bin" + File.separator + "java"; + List command = new ArrayList<>(); + command.add(javaBin); + // Pass through user-supplied system properties (e.g. spring.profiles.active, + // spring.autoconfigure.exclude) so infra-dependent apps can be generated against + // a generation-time profile/overrides. + if (systemProperties != null) { + systemProperties.forEach((k, v) -> command.add("-D" + k + "=" + v)); + } + command.add("-cp"); + command.add(cp); + command.add("org.springdoc.generator.GeneratorWorkerMain"); + command.add(mainClass); + command.add(outputDir.getAbsolutePath()); + command.add(outputFileName); + command.add(format); + + getLog().info("Springdoc: generating OpenAPI spec for main class " + mainClass); + ProcessBuilder pb = new ProcessBuilder(command); + pb.redirectErrorStream(true); + Process process = null; + try { + process = pb.start(); + try (BufferedReader reader = new BufferedReader( + new InputStreamReader(process.getInputStream(), StandardCharsets.UTF_8))) { + String line; + while ((line = reader.readLine()) != null) { + getLog().info(line); + } + } + boolean finished = process.waitFor(timeout, java.util.concurrent.TimeUnit.SECONDS); + if (!finished) { + process.destroyForcibly(); + throw new MojoExecutionException("Springdoc generator worker did not finish within " + + timeout + "s and was terminated"); + } + int exit = process.exitValue(); + if (exit != 0) { + throw new MojoExecutionException("Springdoc generator worker exited with code " + exit); + } + } + catch (IOException e) { + if (process != null) { + process.destroyForcibly(); + } + throw new MojoExecutionException("Failed to launch springdoc generator worker", e); + } + catch (InterruptedException e) { + Thread.currentThread().interrupt(); + if (process != null) { + process.destroyForcibly(); + } + throw new MojoExecutionException("Springdoc generator worker interrupted", e); + } + } + + /** + * Resolves the {@code springdoc-openapi-generator-worker} artifact and its transitive runtime + * dependencies from the build session's repositories (or the reactor). Fails the build if it + * cannot be resolved, since generation is impossible without it. + * + * @return absolute paths to the worker jar and its runtime dependencies + * @throws MojoExecutionException if resolution fails + */ + private List resolveWorkerClasspath() throws MojoExecutionException { + try { + Dependency root = new Dependency( + new DefaultArtifact("io.github.vpelikh", + "springdoc-openapi-generator-worker", "jar", pluginVersion), + "runtime"); + java.util.List repos = + session.getCurrentProject().getRemoteProjectRepositories(); + CollectRequest collect = new CollectRequest(root, repos); + DependencyRequest request = new DependencyRequest(collect, null); + DependencyResult result = repositorySystem.resolveDependencies(session.getRepositorySession(), request); + List paths = new ArrayList<>(); + for (ArtifactResult artifact : result.getArtifactResults()) { + paths.add(artifact.getArtifact().getFile().getAbsolutePath()); + } + if (paths.isEmpty()) { + throw new MojoExecutionException("Could not resolve springdoc generator worker at " + + pluginVersion); + } + return paths; + } + catch (DependencyResolutionException e) { + throw new MojoExecutionException( + "Could not resolve springdoc-openapi-generator-worker:" + pluginVersion + + ". Ensure the artifact is installed (e.g. via the springdoc Maven build) " + + "or available in the configured repositories.", + e); + } + } +} \ No newline at end of file From 9398a405463c8ec94c60cd02472575661fd71873 Mon Sep 17 00:00:00 2001 From: Vasily Pelikh <2010720+vpelikh@users.noreply.github.com> Date: Wed, 26 Aug 2026 15:22:34 +0300 Subject: [PATCH 2/2] Add Gradle plugin CI, tests, and publishing --- .../actions/build-and-test-plugins/action.yml | 21 +++++++++++++++ .github/actions/maven-install/action.yml | 12 +++++++++ .github/workflows/build.yml | 11 +++++--- .github/workflows/codeql-analysis.yml | 4 ++- .github/workflows/release.yml | 25 +++++++++++++++--- CI/bump-snapshot.sh | 3 +++ CI/prepare-release-commit.sh | 3 +++ springdoc-openapi-gradle-plugin/build.gradle | 26 +++++++++++++++++-- .../gradle.properties | 1 + 9 files changed, 96 insertions(+), 10 deletions(-) create mode 100644 .github/actions/build-and-test-plugins/action.yml create mode 100644 .github/actions/maven-install/action.yml create mode 100644 springdoc-openapi-gradle-plugin/gradle.properties diff --git a/.github/actions/build-and-test-plugins/action.yml b/.github/actions/build-and-test-plugins/action.yml new file mode 100644 index 000000000..7f75da6a7 --- /dev/null +++ b/.github/actions/build-and-test-plugins/action.yml @@ -0,0 +1,21 @@ +name: 'Build and test plugins' +description: > + Builds and installs the Maven reactor, builds the Gradle plugin, and runs the + Maven plugin's integration tests. Shared by the Build and Release workflows so + the application build+test sequence is defined in one place. +runs: + using: "composite" + steps: + - name: Maven install (parallel, skip invoker ITs) + uses: ./.github/actions/maven-install + + - name: Build Gradle plugin + shell: bash + run: | + cd ./springdoc-openapi-gradle-plugin + ./gradlew build --info --build-cache --parallel + + - name: Maven plugin integration tests + shell: bash + run: | + ./mvnw --no-transfer-progress -B -pl springdoc-openapi-maven-plugin verify \ No newline at end of file diff --git a/.github/actions/maven-install/action.yml b/.github/actions/maven-install/action.yml new file mode 100644 index 000000000..bf793ae1d --- /dev/null +++ b/.github/actions/maven-install/action.yml @@ -0,0 +1,12 @@ +name: 'Maven install (parallel, skip invoker ITs)' +description: > + Builds and installs the whole Maven reactor to the local repo, skipping the + maven-plugin's invoker-plugin integration tests. Those run serially afterwards + via build-and-test-plugins. +runs: + using: "composite" + steps: + - name: Maven install + shell: bash + run: | + ./mvnw --no-transfer-progress -B -T 1C -Dinvoker.skip=true install --file pom.xml \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2701b3e06..3c230626b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,8 +34,13 @@ jobs: server-username: MAVEN_USERNAME server-password: MAVEN_PASSWORD - - name: Build with Maven - run: ./mvnw --no-transfer-progress -B -T 1C install --file pom.xml + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v6 + with: + cache-read-only: ${{ github.event_name == 'pull_request' }} + + - name: Build and test plugins + uses: ./.github/actions/build-and-test-plugins - name: Deploy SNAPSHOT to Maven Central if: github.event_name == 'push' && matrix.java == 17 @@ -43,7 +48,7 @@ jobs: MY_POM_VERSION=$(./mvnw -q -DforceStdout help:evaluate -Dexpression=project.version --non-recursive) echo "POM VERSION: $MY_POM_VERSION" if [[ $MY_POM_VERSION =~ ^.*SNAPSHOT$ ]]; then - ./mvnw --no-transfer-progress -B -T 1C -DskipTests deploy -e + ./mvnw --no-transfer-progress -B -T 1C -Dinvoker.skip=true -DskipTests deploy -e else echo "Not a SNAPSHOT version, skipping deployment." fi diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index d355aec5f..f0c3c7107 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -38,7 +38,9 @@ jobs: languages: java - name: Build with Maven - run: ./mvnw --no-transfer-progress -B -T 1C install --file pom.xml + # CodeQL only needs the source built for analysis; the maven-plugin's invoker + # ITs already run in the main Build workflow (see maven-install action). + uses: ./.github/actions/maven-install - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v4 \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 383380994..e6c3959f8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -33,6 +33,14 @@ jobs: server-password: MAVEN_PASSWORD gpg-private-key: ${{ secrets.OSSRH_GPG_PRIVATE_KEY }} + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v6 + env: + GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }} + GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }} + with: + cache-read-only: false + - name: Compute release version id: version run: . ./CI/compute-release-version.sh ${{ github.event.inputs.release_type }} @@ -42,12 +50,19 @@ jobs: - name: Prepare release commit (detached) run: . ./CI/prepare-release-commit.sh - - name: Build and test - run: ./mvnw --no-transfer-progress -B -T 1C install --file pom.xml + - name: Build and test plugins + uses: ./.github/actions/build-and-test-plugins - name: Deploy to Maven Central if: success() - run: ./mvnw --no-transfer-progress -B -T 1C -Prelease deploy + run: ./mvnw --no-transfer-progress -B -T 1C -Dinvoker.skip=true -Prelease deploy + + - name: Publish Gradle plugin + if: success() + run: | + cd ./springdoc-openapi-gradle-plugin + ./gradlew publishPlugins -Pgradle.publish.key="${GRADLE_PUBLISH_KEY}" -Pgradle.publish.secret="${GRADLE_PUBLISH_SECRET}" --info --build-cache --parallel + cd ../.. - name: Tag and push release tag if: success() @@ -111,4 +126,6 @@ jobs: MAVEN_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GPG_PRIVATE_KEY: ${{ secrets.OSSRH_GPG_PRIVATE_KEY }} - GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_PRIVATE_PASSPHRASE }} \ No newline at end of file + GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_PRIVATE_PASSPHRASE }} + GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }} + GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }} \ No newline at end of file diff --git a/CI/bump-snapshot.sh b/CI/bump-snapshot.sh index 53581d0be..cf752b7bc 100644 --- a/CI/bump-snapshot.sh +++ b/CI/bump-snapshot.sh @@ -28,6 +28,9 @@ echo "Bumping version to $NEXT_SNAPSHOT" # Update all POMs in one go ./mvnw versions:set -DnewVersion="${NEXT_SNAPSHOT}" -DgenerateBackupPoms=false +# Update gradle.properties +sed -i "s/version=.*/version=${NEXT_SNAPSHOT}/" springdoc-openapi-gradle-plugin/gradle.properties + # Commit and push git config user.email "action@github.com" git config user.name "GitHub Action" diff --git a/CI/prepare-release-commit.sh b/CI/prepare-release-commit.sh index 2a4e27c10..beeb91f3a 100644 --- a/CI/prepare-release-commit.sh +++ b/CI/prepare-release-commit.sh @@ -10,6 +10,9 @@ git config user.name "GitHub Action" # Update all Maven POMs in one go ./mvnw versions:set -DnewVersion="${RELEASE_VERSION}" -DgenerateBackupPoms=false +# Update gradle.properties +sed -i "s/version=.*/version=${RELEASE_VERSION}/" springdoc-openapi-gradle-plugin/gradle.properties + # Stage all changes and commit (detached) git add -A git commit -m "Release version ${RELEASE_VERSION}" diff --git a/springdoc-openapi-gradle-plugin/build.gradle b/springdoc-openapi-gradle-plugin/build.gradle index 2de8547e0..c21fc0c75 100644 --- a/springdoc-openapi-gradle-plugin/build.gradle +++ b/springdoc-openapi-gradle-plugin/build.gradle @@ -3,6 +3,9 @@ // * * * * * * * * * * * * plugins { id 'java-gradle-plugin' + // Publishing publicly to plugins.gradle.org + id 'com.gradle.plugin-publish' version '2.1.1' + // Publishing to maven id 'maven-publish' } @@ -11,7 +14,11 @@ plugins { // * * * * * * * * * * * * group = 'io.github.vpelikh' -version = '5.0.6-SNAPSHOT' + +project.description = 'Gradle plugin that generates the OpenAPI specification for a Spring Boot app' +project.ext.pluginId = 'io.github.vpelikh.springdoc-openapi-gradle-plugin' +project.ext.scm = 'https://github.com/vpelikh/springdoc-openapi.git' +project.ext.url = 'https://github.com/vpelikh/springdoc-openapi/tree/main/springdoc-openapi-gradle-plugin' repositories { mavenLocal() @@ -52,11 +59,26 @@ processResources { // Plugin publishing // * * * * * * * * * * * * +// Configuration for: com.gradle.plugin-publish gradlePlugin { + website = project.ext.url + vcsUrl = project.ext.scm + plugins { springdoc { - id = 'io.github.vpelikh.springdoc-openapi-gradle-plugin' + id = project.ext.pluginId + displayName = 'Springdoc OpenAPI Gradle Plugin' + description = project.description implementationClass = 'org.springdoc.gradle.SpringDocOpenApiGradlePlugin' + tags = ['springdoc', 'openapi', 'spring-boot', 'spring', 'api'] + } + } +} + +publishing { + repositories { + maven { + url = mavenLocal().url } } } diff --git a/springdoc-openapi-gradle-plugin/gradle.properties b/springdoc-openapi-gradle-plugin/gradle.properties new file mode 100644 index 000000000..d375d330f --- /dev/null +++ b/springdoc-openapi-gradle-plugin/gradle.properties @@ -0,0 +1 @@ +version=5.0.6-SNAPSHOT \ No newline at end of file