diff --git a/CHANGELOG.md b/CHANGELOG.md index a2f9bb2..9ba9de3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ ## Release Notes +`1.0.5` + +- Added `GeneratorException` class for generation related errors. +- Upgraded `apiphany` to `1.0.20`. +- Upgraded `swagger-jaxrs2-jakarta` to `2.2.41`. +- Upgraded `maven-plugin-api` to `3.9.11`. + +--- + `1.0.4` - Upgraded `apiphany` to `1.0.18`. diff --git a/README.md b/README.md index 95f9689..19c0e3f 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,19 @@ A Maven plugin for generating OpenAPI documentation offline. ![Build (develop)](https://github.com/raduking/openapi-offline-generator-plugin/actions/workflows/build.yml/badge.svg?branch=develop) ## Features + - Pure offline generation (no network calls, no Spring context loading for Spring applications) - Fast, reproducible, CI friendly - Supports YAML, JSON bundle outputs - Deterministic builds (stable ordering / hashing) ## Prerequisites + - Java 25+ - Maven 3.8+ ## Quick Start + Add the plugin to your project POM: ```xml @@ -32,7 +35,7 @@ Add the plugin to your project POM: com.example openapi-offline-generator-plugin - 1.0.4 + 1.0.5 generate-openapi-offline @@ -59,6 +62,7 @@ mvn clean verify Artifacts will be placed under target/openapi. ## Configuration Options + | Field | Description | Default | |-------|-------------|----------------------------------------------------| | `packagesToScan` | The base package(s) to scan for REST controllers (multiple packages can be comma-separated) | @@ -135,17 +139,20 @@ Attach generated spec: ``` ## Offline Philosophy + - All enrichment (bundling, ordering, validation) happens at build time - Encourages contract-first development - Makes specs diff-friendly for code review ## Roadmap + - Gradle plugin wrapper - Multi-module aggregation - OpenAPI 4.x (when finalized) - Pluggable preprocessors ## Contributing + 1. Fork 2. Create feature branch 3. Add tests (mvn test) @@ -160,18 +167,24 @@ mvn clean install ``` ## Release (Maintainers) + - Update [CHANGELOG](CHANGELOG.md) +- Update [README](README.md) - Set release version - mvn clean deploy -Prelease ## License + [Apache License 2.0](LICENSE) ## Security + Report vulnerabilities via private issue or security email channel. Do not open public issues until disclosure window ends. ## Acknowledgements + Inspired by needs for deterministic, auditable API specification generation in regulated environments. ## Contact + Open an issue for bugs, discussions for ideas. diff --git a/pom.xml b/pom.xml index 85dc02e..02ed0f2 100644 --- a/pom.xml +++ b/pom.xml @@ -17,7 +17,7 @@ io.github.raduking openapi-offline-generator-plugin - 1.0.4 + 1.0.5 maven-plugin ${project.groupId}:${project.artifactId} @@ -51,13 +51,25 @@ ${java.version} UTF-8 - 3.14.1 - 3.15.2 + + 3.9.11 + 3.9.11 + + 2.2.41 + 2.8.13 + 1.0.20 + 0.15.0 3.2.8 0.9.0 + + 3.15.2 + 2.46.1 + 3.42.0 + 4.36 + @@ -70,6 +82,7 @@ + -XX:+EnableDynamicAgentLoading --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/sun.reflect.annotation=ALL-UNNAMED @@ -87,13 +100,13 @@ io.swagger.core.v3 swagger-jaxrs2-jakarta - 2.2.39 + ${swagger.jaxrs2.jakarta.version} org.springdoc springdoc-openapi-starter-webmvc-api - 2.8.13 + ${springdoc.openapi.starter.webmvc.api.version} @@ -117,14 +130,14 @@ org.apache.maven maven-plugin-api - 3.9.6 + ${maven.plugin.api.version} provided org.apache.maven maven-core - 3.9.11 + ${maven.core.version} provided @@ -138,14 +151,14 @@ io.github.raduking apiphany - 1.0.18 + ${apiphany.version} com.github.therapi therapi-runtime-javadoc - 0.15.0 + ${therapi.runtime.javadoc.version} @@ -191,6 +204,11 @@ test + + org.springframework.boot + spring-boot-starter-test + test + @@ -244,7 +262,6 @@ org.apache.maven.plugins maven-compiler-plugin - ${maven.compiler.plugin.version} ${maven.compiler.source} ${maven.compiler.target} @@ -345,19 +362,19 @@ com.diffplug.spotless spotless-maven-plugin - 2.46.1 + ${spotless.maven.plugin.version} org.eclipse.jdt org.eclipse.jdt.core - 3.42.0 + ${org.eclipse.jdt.core.version} ${project.basedir}/formatter/java-formatter.xml - 4.36 + ${eclipse.formatter.version} diff --git a/src/main/java/org/oogp/Errors.java b/src/main/java/org/oogp/Errors.java index 65d2ffc..3c60e29 100644 --- a/src/main/java/org/oogp/Errors.java +++ b/src/main/java/org/oogp/Errors.java @@ -14,7 +14,7 @@ public class Errors { /** * The logger. */ - private static final Logger LOGGER = LoggerFactory.getLogger(Conversions.class); + private static final Logger LOGGER = LoggerFactory.getLogger(Errors.class); /** * Hide constructor. diff --git a/src/main/java/org/oogp/GeneratorException.java b/src/main/java/org/oogp/GeneratorException.java new file mode 100644 index 0000000..ea31908 --- /dev/null +++ b/src/main/java/org/oogp/GeneratorException.java @@ -0,0 +1,34 @@ +package org.oogp; + +/** + * Exception class for generator-related errors. + * + * @author Radu Sebastian LAZIN + */ +public class GeneratorException extends RuntimeException { + + /** + * Serial version UID. + */ + private static final long serialVersionUID = -4336559629781875288L; + + /** + * Constructs a new {@link GeneratorException} with the specified detail message. + * + * @param message the detail message + */ + public GeneratorException(final String message) { + super(message); + } + + /** + * Constructs a new {@link GeneratorException} with the specified detail message and cause. + * + * @param message the detail message + * @param cause the cause of the exception + */ + public GeneratorException(final String message, final Throwable cause) { + super(message, cause); + } + +} diff --git a/src/main/java/org/oogp/OpenApiGenerator.java b/src/main/java/org/oogp/OpenApiGenerator.java index 2c52ebf..be20f58 100644 --- a/src/main/java/org/oogp/OpenApiGenerator.java +++ b/src/main/java/org/oogp/OpenApiGenerator.java @@ -1,14 +1,14 @@ package org.oogp; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; + import org.apiphany.json.JsonBuilder; import org.morphix.reflection.Constructors; import org.oogp.jakarta.OpenApiSpecJakartaGenerator; import org.oogp.spring.OpenApiSpecSpringDocGenerator; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - /** * Main class for OpenAPI generation used in the CLI mode. * @@ -22,18 +22,23 @@ public class OpenApiGenerator { * @param args the command line arguments * @throws Exception in case of errors */ - static void main(final String[] args) throws Exception { + static void main(final String[] args) { if (args.length != 1) { System.err.println("Expected path to properties JSON"); System.exit(2); } + try { + Path propertiesPath = Path.of(args[0]); + String json = Files.readString(propertiesPath); - Path propertiesPath = Path.of(args[0]); - String json = Files.readString(propertiesPath); - GeneratorProperties properties = JsonBuilder.fromJson(json, GeneratorProperties.class); - properties.applyDefaults(null, null); + GeneratorProperties properties = JsonBuilder.fromJson(json, GeneratorProperties.class); + properties.applyDefaults(null, null); - generate(properties); + generate(properties); + } catch (Exception e) { + e.printStackTrace(); + System.exit(3); + } } /** @@ -46,7 +51,7 @@ public static void generate(final GeneratorProperties properties) throws IOExcep switch (ProjectType.fromString(properties.getProjectType())) { case JAKARTA -> OpenApiSpecJakartaGenerator.generate(properties); case SPRING -> OpenApiSpecSpringDocGenerator.generate(properties); - default -> throw new RuntimeException("Unknown project type: " + properties.getProjectType()); + default -> throw new GeneratorException("Unknown project type: " + properties.getProjectType()); } } diff --git a/src/main/java/org/oogp/OpenApiMojo.java b/src/main/java/org/oogp/OpenApiMojo.java index f27362c..1edc659 100644 --- a/src/main/java/org/oogp/OpenApiMojo.java +++ b/src/main/java/org/oogp/OpenApiMojo.java @@ -3,6 +3,7 @@ import java.io.File; import java.io.IOException; import java.io.InputStream; +import java.net.URISyntaxException; import java.net.URL; import java.net.URLClassLoader; import java.nio.file.Files; @@ -86,7 +87,7 @@ public void execute() throws MojoExecutionException { throw new MojoExecutionException("Failed to apply default properties", e); } - if (fork) { + if (Boolean.TRUE.equals(fork)) { runForked(); } else { run(); @@ -121,16 +122,7 @@ private void runForked() throws MojoExecutionException { String json = JsonBuilder.toJson(properties); Files.writeString(tempPropertiesFile, json); - List cp = new ArrayList<>(); - cp.add(project.getBuild().getOutputDirectory()); - cp.addAll(project.getRuntimeClasspathElements()); - File pluginJar = new File(getClass().getProtectionDomain().getCodeSource().getLocation().toURI()); - cp.add(pluginJar.getAbsolutePath()); - for (Artifact a : pluginArtifacts) { - cp.add(a.getFile().getAbsolutePath()); - } - String classpath = String.join(File.pathSeparator, cp); - + String classpath = getClassPath(); List cmd = getCmd(classpath, tempPropertiesFile); getLog().info("Forking JVM to generate OpenAPI spec..."); @@ -147,6 +139,9 @@ private void runForked() throws MojoExecutionException { if (exitCode != 0) { throw new MojoExecutionException("Forked OpenAPI generation process exited with code " + exitCode); } + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new MojoExecutionException("Forked OpenAPI generation process was interrupted", e); } catch (Exception e) { throw new MojoExecutionException("Failed to fork OpenAPI generation process", e); } finally { @@ -160,6 +155,25 @@ private void runForked() throws MojoExecutionException { } } + /** + * Builds the classpath for the forked JVM process. + * + * @return the classpath + * @throws DependencyResolutionRequiredException when project resolution fails + * @throws URISyntaxException when URI syntax is invalid + */ + private String getClassPath() throws DependencyResolutionRequiredException, URISyntaxException { + List cp = new ArrayList<>(); + cp.add(project.getBuild().getOutputDirectory()); + cp.addAll(project.getRuntimeClasspathElements()); + File pluginJar = new File(getClass().getProtectionDomain().getCodeSource().getLocation().toURI()); + cp.add(pluginJar.getAbsolutePath()); + for (Artifact a : pluginArtifacts) { + cp.add(a.getFile().getAbsolutePath()); + } + return String.join(File.pathSeparator, cp); + } + /** * Builds the command to run the forked JVM process. * diff --git a/src/main/java/org/oogp/spring/CustomApplicationContext.java b/src/main/java/org/oogp/spring/CustomApplicationContext.java index 0bb3189..ded7b60 100644 --- a/src/main/java/org/oogp/spring/CustomApplicationContext.java +++ b/src/main/java/org/oogp/spring/CustomApplicationContext.java @@ -311,7 +311,7 @@ public boolean isTypeMatch(final String name, final Class typeToMatch) throws @Override @Nullable - public Class getType(final String name) throws NoSuchBeanDefinitionException { + public Class getType(final String name) throws NoSuchBeanDefinitionException { // NOSONAR comes from the interface BeanMetadata beanMetadata = nameMap.get(name); if (null == beanMetadata) { throw new NoSuchBeanDefinitionException("No bean available for name: " + name); @@ -321,7 +321,7 @@ public Class getType(final String name) throws NoSuchBeanDefinitionException @Override @Nullable - public Class getType(final String name, final boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException { + public Class getType(final String name, final boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException { // NOSONAR interface return Errors.unsupportedOperation(); } diff --git a/src/test/java/org/oogp/OpenApiSpecSpringDocGeneratorTest.java b/src/test/java/org/oogp/OpenApiSpecSpringDocGeneratorTest.java index 9281bd9..063af23 100644 --- a/src/test/java/org/oogp/OpenApiSpecSpringDocGeneratorTest.java +++ b/src/test/java/org/oogp/OpenApiSpecSpringDocGeneratorTest.java @@ -9,7 +9,10 @@ import java.nio.file.Paths; import java.util.Map; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.junit.jupiter.MockitoExtension; import org.oogp.spring.OpenApiSpecSpringDocGenerator; /** @@ -24,16 +27,33 @@ * * @author raduking */ +@ExtendWith(MockitoExtension.class) class OpenApiSpecSpringDocGeneratorTest { + private static final String MY_SERVICE_PATH = "/src/test/resources/myservice/"; + private static final String ISOLATED_PATH = "/src/test/resources/isolated/"; + + private static final String ACTUAL_PATH = "actual/"; + private static final String EXPECTED_PATH = "expected/"; + private static final String OUTPUT_FILE_NAME_WITH_GENERATE = "open-api-with-generate.yaml"; private static final String OUTPUT_FILE_NAME_WITH_MAIN = "open-api-with-main.yaml"; + private static final String OUTPUT_FILE_NAME_FOR_OBJECT = "object.yaml"; + private static final String OUTPUT_FILE_NAME_FOR_OFFSET_DATE_TIME = "offsetdatetime.yaml"; + + private String currentDirectory; + + @BeforeEach + void setup() { + currentDirectory = getCurrentDirectory(); + System.setProperty("project.build.outputDirectory", currentDirectory + "/target/test-classes"); + } - private static GeneratorProperties getGeneratorProperties(final String fileName) { + private static GeneratorProperties getGeneratorProperties(final String outputFileName, final String packagesToScan) { GeneratorProperties generatorProperties = new GeneratorProperties(); - generatorProperties.setPackagesToScan("org.oogp.controller"); - generatorProperties.setOutputFile(fileName); + generatorProperties.setPackagesToScan(packagesToScan); + generatorProperties.setOutputFile(outputFileName); generatorProperties.setSchemaForObjectClass("object"); GeneratorProperties.OAuth2 oAuth2 = new GeneratorProperties.OAuth2(); oAuth2.setEnabled(true); @@ -43,16 +63,19 @@ private static GeneratorProperties getGeneratorProperties(final String fileName) return generatorProperties; } + private static String getCurrentDirectory() { + return Paths.get("").toAbsolutePath().toString(); + } + @Test void shouldBuildOpenApiFileWithGenerate() throws IOException { - String currentDirectory = Paths.get("").toAbsolutePath().toString(); - System.setProperty("project.build.outputDirectory", currentDirectory + "/target/test-classes"); - String fileName = currentDirectory + "/src/test/resources/" + OUTPUT_FILE_NAME_WITH_GENERATE; Path path = Paths.get(fileName); Files.deleteIfExists(path); - GeneratorProperties generatorProperties = getGeneratorProperties(fileName); + String packagesToScan = "org.oogp.myservice.controller"; + GeneratorProperties generatorProperties = getGeneratorProperties(fileName, packagesToScan); + OpenApiSpecSpringDocGenerator.generate(generatorProperties); boolean exists = Files.exists(path); @@ -61,22 +84,36 @@ void shouldBuildOpenApiFileWithGenerate() throws IOException { } @Test - void shouldBuildExpectedOpenApiFile() throws IOException { - String currentDirectory = Paths.get("").toAbsolutePath().toString(); + void shouldBuildOpenApiFileWithMain() throws IOException { System.setProperty("project.build.outputDirectory", currentDirectory + "/target/test-classes"); - String fileName = currentDirectory + "/src/test/resources/actual/" + OUTPUT_FILE_NAME_WITH_GENERATE; + String fileName = currentDirectory + "/src/test/resources/" + OUTPUT_FILE_NAME_WITH_MAIN; + Path path = Paths.get(fileName); + Files.deleteIfExists(path); + + OpenApiSpecSpringDocGenerator.main(new String[] { "org.oogp.myservice.controller", fileName }); + + boolean exists = Files.exists(path); + + assertThat(exists, equalTo(true)); + } + + @Test + void shouldBuildExpectedOpenApiFile() throws IOException { + String fileName = currentDirectory + MY_SERVICE_PATH + ACTUAL_PATH + OUTPUT_FILE_NAME_WITH_GENERATE; Path path = Paths.get(fileName); Files.deleteIfExists(path); - GeneratorProperties generatorProperties = getGeneratorProperties(fileName); + String packagesToScan = "org.oogp.myservice.controller"; + GeneratorProperties generatorProperties = getGeneratorProperties(fileName, packagesToScan); + OpenApiSpecSpringDocGenerator.generate(generatorProperties); boolean exists = Files.exists(path); assertThat(exists, equalTo(true)); - String expectedFileName = currentDirectory + "/src/test/resources/expected/" + OUTPUT_FILE_NAME_WITH_GENERATE; + String expectedFileName = currentDirectory + MY_SERVICE_PATH + EXPECTED_PATH + OUTPUT_FILE_NAME_WITH_GENERATE; String expectedContent = Files.readString(Paths.get(expectedFileName)); String actualContent = Files.readString(path); @@ -84,32 +121,36 @@ void shouldBuildExpectedOpenApiFile() throws IOException { } @Test - void shouldBuildOpenApiFileWithMain() throws IOException { - String currentDirectory = Paths.get("").toAbsolutePath().toString(); - System.setProperty("project.build.outputDirectory", currentDirectory + "/target/test-classes"); - - String fileName = currentDirectory + "/src/test/resources/" + OUTPUT_FILE_NAME_WITH_MAIN; + void shouldBuildOpenApiFileForObjectType() throws IOException { + String fileName = currentDirectory + ISOLATED_PATH + ACTUAL_PATH + OUTPUT_FILE_NAME_FOR_OBJECT; Path path = Paths.get(fileName); Files.deleteIfExists(path); - OpenApiSpecSpringDocGenerator.main(new String[] { "org.oogp.controller", fileName }); + GeneratorProperties generatorProperties = new GeneratorProperties(); + generatorProperties.setPackagesToScan("org.oogp.isolated.object.controller"); + generatorProperties.setOutputFile(fileName); + generatorProperties.setSchemaForObjectClass("object"); + OpenApiSpecSpringDocGenerator.generate(generatorProperties); boolean exists = Files.exists(path); assertThat(exists, equalTo(true)); + + String expectedFileName = currentDirectory + ISOLATED_PATH + EXPECTED_PATH + OUTPUT_FILE_NAME_FOR_OBJECT; + String expectedContent = Files.readString(Paths.get(expectedFileName)); + String actualContent = Files.readString(path); + + assertThat(actualContent, equalTo(expectedContent)); } @Test - void shouldBuildOpenApiFileForObjectType() throws IOException { - String currentDirectory = Paths.get("").toAbsolutePath().toString(); - System.setProperty("project.build.outputDirectory", currentDirectory + "/target/test-classes"); - - String fileName = currentDirectory + "/src/test/resources/isolated/" + OUTPUT_FILE_NAME_FOR_OBJECT; + void shouldBuildOpenApiFileForObjectTypeAndOffsetDateTime() throws IOException { + String fileName = currentDirectory + ISOLATED_PATH + ACTUAL_PATH + OUTPUT_FILE_NAME_FOR_OFFSET_DATE_TIME; Path path = Paths.get(fileName); Files.deleteIfExists(path); GeneratorProperties generatorProperties = new GeneratorProperties(); - generatorProperties.setPackagesToScan("org.oogp.object.controller"); + generatorProperties.setPackagesToScan("org.oogp.isolated.offsetdatetime.controller"); generatorProperties.setOutputFile(fileName); generatorProperties.setSchemaForObjectClass("object"); OpenApiSpecSpringDocGenerator.generate(generatorProperties); @@ -118,11 +159,10 @@ void shouldBuildOpenApiFileForObjectType() throws IOException { assertThat(exists, equalTo(true)); - String expectedFileName = currentDirectory + "/src/test/resources/expected/isolated/" + OUTPUT_FILE_NAME_FOR_OBJECT; + String expectedFileName = currentDirectory + ISOLATED_PATH + EXPECTED_PATH + OUTPUT_FILE_NAME_FOR_OFFSET_DATE_TIME; String expectedContent = Files.readString(Paths.get(expectedFileName)); String actualContent = Files.readString(path); assertThat(actualContent, equalTo(expectedContent)); } - } diff --git a/src/test/java/org/oogp/object/api/ObjectApi.java b/src/test/java/org/oogp/isolated/object/api/ObjectApi.java similarity index 96% rename from src/test/java/org/oogp/object/api/ObjectApi.java rename to src/test/java/org/oogp/isolated/object/api/ObjectApi.java index 6a97819..06a8607 100644 --- a/src/test/java/org/oogp/object/api/ObjectApi.java +++ b/src/test/java/org/oogp/isolated/object/api/ObjectApi.java @@ -1,4 +1,4 @@ -package org.oogp.object.api; +package org.oogp.isolated.object.api; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.Content; diff --git a/src/test/java/org/oogp/object/controller/ObjectController.java b/src/test/java/org/oogp/isolated/object/controller/ObjectController.java similarity index 82% rename from src/test/java/org/oogp/object/controller/ObjectController.java rename to src/test/java/org/oogp/isolated/object/controller/ObjectController.java index 209fe64..be6faed 100644 --- a/src/test/java/org/oogp/object/controller/ObjectController.java +++ b/src/test/java/org/oogp/isolated/object/controller/ObjectController.java @@ -1,6 +1,6 @@ -package org.oogp.object.controller; +package org.oogp.isolated.object.controller; -import org.oogp.object.api.ObjectApi; +import org.oogp.isolated.object.api.ObjectApi; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.RestController; diff --git a/src/test/java/org/oogp/isolated/offsetdatetime/OffsetDateTimeApplication.java b/src/test/java/org/oogp/isolated/offsetdatetime/OffsetDateTimeApplication.java new file mode 100644 index 0000000..fb5de50 --- /dev/null +++ b/src/test/java/org/oogp/isolated/offsetdatetime/OffsetDateTimeApplication.java @@ -0,0 +1,12 @@ +package org.oogp.isolated.offsetdatetime; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class OffsetDateTimeApplication { + + public static void main(final String[] args) { + SpringApplication.run(OffsetDateTimeApplication.class, args); + } +} diff --git a/src/test/java/org/oogp/isolated/offsetdatetime/api/OffsetDateTimeApi.java b/src/test/java/org/oogp/isolated/offsetdatetime/api/OffsetDateTimeApi.java new file mode 100644 index 0000000..8243f3e --- /dev/null +++ b/src/test/java/org/oogp/isolated/offsetdatetime/api/OffsetDateTimeApi.java @@ -0,0 +1,92 @@ +package org.oogp.isolated.offsetdatetime.api; + +import java.time.OffsetDateTime; + +import jakarta.validation.constraints.Pattern; + +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; + +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.tags.Tag; + +@Tag(name = "ISO-8601", description = "the data") +@RequestMapping("/api/test/offsetdatetime/") +public interface OffsetDateTimeApi { + + /** + * Flexible pattern to match ISO 8601. + *

+ * Examples of valid formats: + *

    + *
  • 2023-08-15T14:30:00+02:00
  • + *
  • 2023-08-15T14:30+02:00
  • + *
  • 2023-08-15T14:30:45-02:00
  • + *
  • 2023-08-15T14:30Z
  • + *
+ */ + String ISO_8601_DATE_TIME_PATTERN = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?([+-]\\d{2}:\\d{2}|Z)$"; + + @Operation( + operationId = "getObjectWithOffsetDateTime", + tags = { "ISO-8601" }, + parameters = { + @Parameter( + name = "dateTime", + description = "Input date time", + schema = @Schema( + implementation = OffsetDateTime.class, + pattern = ISO_8601_DATE_TIME_PATTERN, + example = "2019-12-19T23:59:00+01:00")) + }, + responses = { + @ApiResponse( + responseCode = "200", + content = { + @Content(mediaType = "application/json", schema = @Schema(implementation = Object.class)) + }) + }) + @GetMapping( + value = "with-offsetdatetime", + produces = { MediaType.APPLICATION_JSON_VALUE }) + default ResponseEntity getObjectWithOffsetDateTime(@SuppressWarnings("unused") final OffsetDateTime dateTime) { + return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); + } + + @Operation( + operationId = "getObjectWithStringTime", + tags = { "ISO-8601" }, + parameters = { + @Parameter( + name = "dateTime", + description = "Input date time", + schema = @Schema( + implementation = String.class, + pattern = ISO_8601_DATE_TIME_PATTERN, + example = "2019-12-19T23:59:00+01:00")) + }, + responses = { + @ApiResponse( + responseCode = "200", + content = { + @Content(mediaType = "application/json", schema = @Schema(implementation = Object.class)) + }) + }) + @GetMapping( + value = "with-stringtime", + produces = { MediaType.APPLICATION_JSON_VALUE }) + default ResponseEntity getObjectWithStringTime( + @SuppressWarnings("unused") @Validated @Pattern( + regexp = ISO_8601_DATE_TIME_PATTERN, + message = "Invalid date-time format. Expected: ISO 8601") final String dateTime) { + return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); + } +} diff --git a/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeController.java b/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeController.java new file mode 100644 index 0000000..b60f3ea --- /dev/null +++ b/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeController.java @@ -0,0 +1,61 @@ +package org.oogp.isolated.offsetdatetime.controller; + +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; + +import org.oogp.isolated.offsetdatetime.api.OffsetDateTimeApi; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.RestController; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; + +@RestController +public class OffsetDateTimeController implements OffsetDateTimeApi { + + private static final Logger LOGGER = LoggerFactory.getLogger(OffsetDateTimeController.class); + + private ObjectMapper objectMapper = new ObjectMapper(); + + @Override + public ResponseEntity getObjectWithOffsetDateTime(final OffsetDateTime dateTime) { + LOGGER.info("Received OffsetDateTime: {}", dateTime); + + ObjectNode response = createResponseNode(dateTime); + + return ResponseEntity.ok(response); + } + + @Override + public ResponseEntity getObjectWithStringTime(final String dateTime) { + LOGGER.info("Received dateTime string: {}", dateTime); + OffsetDateTime parsedDateTime = OffsetDateTime.parse(dateTime, DateTimeFormatter.ISO_OFFSET_DATE_TIME); + + ObjectNode response = createResponseNode(parsedDateTime); + + return ResponseEntity.ok(response); + } + + /** + * Returns a JSON object node with the details of the OffsetDateTime for testing purposes. + * + * @param dateTime the OffsetDateTime to extract details from + * @return an ObjectNode containing the dateTime details + */ + private ObjectNode createResponseNode(final OffsetDateTime dateTime) { + // IMPORTANT: Format the OffsetDateTime back to ISO 8601 string for consistent output not dependent on toString() + String formattedDateTime = dateTime.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME); + ObjectNode response = objectMapper.createObjectNode(); + response.put("dateTime", formattedDateTime); + response.put("year", dateTime.getYear()); + response.put("month", dateTime.getMonthValue()); + response.put("day", dateTime.getDayOfMonth()); + response.put("hour", dateTime.getHour()); + response.put("minute", dateTime.getMinute()); + response.put("second", dateTime.getSecond()); + response.put("offset", dateTime.getOffset().toString()); + return response; + } +} diff --git a/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeControllerTest.java b/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeControllerTest.java new file mode 100644 index 0000000..fa37daf --- /dev/null +++ b/src/test/java/org/oogp/isolated/offsetdatetime/controller/OffsetDateTimeControllerTest.java @@ -0,0 +1,118 @@ +package org.oogp.isolated.offsetdatetime.controller; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.util.stream.Stream; + +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.test.web.servlet.MockMvc; + +@WebMvcTest(OffsetDateTimeController.class) +class OffsetDateTimeControllerTest { + + @Autowired + private MockMvc mockMvc; + + /** + * Provides a stream of valid ISO 8601 offset date-time strings for parameterized tests. + * + * @return a stream of valid offset date-time strings + */ + private static Stream provideValidOffsetDateTimes() { + return Stream.of( + Arguments.of("2019-12-19T23:59:00+01:00", 2019, 12, 19, 23, 59, 0, "+01:00"), + Arguments.of("2019-12-19T23:59+01:00", 2019, 12, 19, 23, 59, 0, "+01:00"), + Arguments.of("2021-06-15T12:30:45-05:00", 2021, 6, 15, 12, 30, 45, "-05:00"), + Arguments.of("2020-01-01T00:00:00Z", 2020, 1, 1, 0, 0, 0, "Z")); + } + + /** + * Provides a stream of invalid ISO 8601 offset date-time strings for parameterized tests. + * + * @return a stream of invalid offset date-time strings + */ + private static Stream provideInvalidOffsetDateTimes() { + return Stream.of( + Arguments.of("2019-12-19T23:59:00+0100"), + Arguments.of("2019-12-19T23:59+0100"), + Arguments.of("2019-12-19 23:59:00")); + } + + @ParameterizedTest + @MethodSource("provideValidOffsetDateTimes") + void shouldReturnOkOnValidOffsetDateTimeWhenCallingWithOffsetDateTime( + final String validDateTime, + final int year, + final int month, + final int day, + final int hour, + final int minute, + final int second, + final String offset) throws Exception { + OffsetDateTime parsedDateTime = OffsetDateTime.parse(validDateTime, DateTimeFormatter.ISO_OFFSET_DATE_TIME); + String formattedDateTime = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(parsedDateTime); + + mockMvc.perform(get("/api/test/offsetdatetime/with-offsetdatetime") + .param("dateTime", validDateTime)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.dateTime").value(formattedDateTime)) + .andExpect(jsonPath("$.year").value(year)) + .andExpect(jsonPath("$.month").value(month)) + .andExpect(jsonPath("$.day").value(day)) + .andExpect(jsonPath("$.hour").value(hour)) + .andExpect(jsonPath("$.minute").value(minute)) + .andExpect(jsonPath("$.second").value(second)) + .andExpect(jsonPath("$.offset").value(offset)); + } + + @ParameterizedTest + @MethodSource("provideInvalidOffsetDateTimes") + void shouldReturnBadRequestOnInvalidOffsetDateTimeWhenCallingWithOffsetDateTime(final String invalidDateTime) throws Exception { + mockMvc.perform(get("/api/test/offsetdatetime/with-offsetdatetime") + .param("dateTime", invalidDateTime)) + .andExpect(status().isBadRequest()); + } + + @ParameterizedTest + @MethodSource("provideValidOffsetDateTimes") + void shouldReturnOkOnValidOffsetDateTimeWhenCallingWithStringTime( + final String validDateTime, + final int year, + final int month, + final int day, + final int hour, + final int minute, + final int second, + final String offset) throws Exception { + OffsetDateTime parsedDateTime = OffsetDateTime.parse(validDateTime, DateTimeFormatter.ISO_OFFSET_DATE_TIME); + String formattedDateTime = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(parsedDateTime); + + mockMvc.perform(get("/api/test/offsetdatetime/with-stringtime") + .param("dateTime", validDateTime)) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.dateTime").value(formattedDateTime)) + .andExpect(jsonPath("$.year").value(year)) + .andExpect(jsonPath("$.month").value(month)) + .andExpect(jsonPath("$.day").value(day)) + .andExpect(jsonPath("$.hour").value(hour)) + .andExpect(jsonPath("$.minute").value(minute)) + .andExpect(jsonPath("$.second").value(second)) + .andExpect(jsonPath("$.offset").value(offset)); + } + + @ParameterizedTest + @MethodSource("provideInvalidOffsetDateTimes") + void shouldReturnBadRequestOnInvalidOffsetDateTimeWhenCallingWithStringTime(final String invalidDateTime) throws Exception { + mockMvc.perform(get("/api/test/offsetdatetime/with-stringtime") + .param("dateTime", invalidDateTime)) + .andExpect(status().isBadRequest()); + } +} diff --git a/src/test/java/org/oogp/api/DataApi.java b/src/test/java/org/oogp/myservice/api/DataApi.java similarity index 98% rename from src/test/java/org/oogp/api/DataApi.java rename to src/test/java/org/oogp/myservice/api/DataApi.java index 4a0e621..a39ec30 100644 --- a/src/test/java/org/oogp/api/DataApi.java +++ b/src/test/java/org/oogp/myservice/api/DataApi.java @@ -1,4 +1,4 @@ -package org.oogp.api; +package org.oogp.myservice.api; import java.util.List; diff --git a/src/test/java/org/oogp/controller/DataController.java b/src/test/java/org/oogp/myservice/controller/DataController.java similarity index 88% rename from src/test/java/org/oogp/controller/DataController.java rename to src/test/java/org/oogp/myservice/controller/DataController.java index a374d4d..3ffadb5 100644 --- a/src/test/java/org/oogp/controller/DataController.java +++ b/src/test/java/org/oogp/myservice/controller/DataController.java @@ -1,8 +1,8 @@ -package org.oogp.controller; +package org.oogp.myservice.controller; import java.util.List; -import org.oogp.api.DataApi; +import org.oogp.myservice.api.DataApi; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; diff --git a/src/test/java/org/oogp/controller/InfoController.java b/src/test/java/org/oogp/myservice/controller/InfoController.java similarity index 94% rename from src/test/java/org/oogp/controller/InfoController.java rename to src/test/java/org/oogp/myservice/controller/InfoController.java index 740a45e..1476608 100644 --- a/src/test/java/org/oogp/controller/InfoController.java +++ b/src/test/java/org/oogp/myservice/controller/InfoController.java @@ -1,8 +1,8 @@ -package org.oogp.controller; +package org.oogp.myservice.controller; import java.util.List; -import org.oogp.model.UserCacheInfo; +import org.oogp.myservice.model.UserCacheInfo; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; diff --git a/src/test/java/org/oogp/model/UserCacheInfo.java b/src/test/java/org/oogp/myservice/model/UserCacheInfo.java similarity index 96% rename from src/test/java/org/oogp/model/UserCacheInfo.java rename to src/test/java/org/oogp/myservice/model/UserCacheInfo.java index c901e69..2aca9a2 100644 --- a/src/test/java/org/oogp/model/UserCacheInfo.java +++ b/src/test/java/org/oogp/myservice/model/UserCacheInfo.java @@ -1,4 +1,4 @@ -package org.oogp.model; +package org.oogp.myservice.model; import java.util.ArrayList; import java.util.List; diff --git a/src/test/resources/expected/isolated/object.yaml b/src/test/resources/isolated/actual/object.yaml similarity index 100% rename from src/test/resources/expected/isolated/object.yaml rename to src/test/resources/isolated/actual/object.yaml diff --git a/src/test/resources/isolated/actual/offsetdatetime.yaml b/src/test/resources/isolated/actual/offsetdatetime.yaml new file mode 100644 index 0000000..dc2e7b7 --- /dev/null +++ b/src/test/resources/isolated/actual/offsetdatetime.yaml @@ -0,0 +1,53 @@ +openapi: 3.1.0 +info: + title: OpenAPI definition + version: v0 +servers: [] +tags: +- name: ISO-8601 + description: the data +paths: + /api/test/offsetdatetime/with-stringtime: + get: + tags: + - ISO-8601 + operationId: getObjectWithStringTime + parameters: + - name: dateTime + in: query + description: Input date time + required: true + schema: + type: string + example: 2019-12-19T23:59:00+01:00 + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?([+-]\\d{2}:\\d{2}|Z)$" + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + /api/test/offsetdatetime/with-offsetdatetime: + get: + tags: + - ISO-8601 + operationId: getObjectWithOffsetDateTime + parameters: + - name: dateTime + in: query + description: Input date time + required: true + schema: + type: string + format: date-time + example: 2019-12-19T23:59:00+01:00 + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?([+-]\\d{2}:\\d{2}|Z)$" + responses: + "200": + description: OK + content: + application/json: + schema: + type: object +components: {} diff --git a/src/test/resources/isolated/object.yaml b/src/test/resources/isolated/expected/object.yaml similarity index 100% rename from src/test/resources/isolated/object.yaml rename to src/test/resources/isolated/expected/object.yaml diff --git a/src/test/resources/isolated/expected/offsetdatetime.yaml b/src/test/resources/isolated/expected/offsetdatetime.yaml new file mode 100644 index 0000000..dc2e7b7 --- /dev/null +++ b/src/test/resources/isolated/expected/offsetdatetime.yaml @@ -0,0 +1,53 @@ +openapi: 3.1.0 +info: + title: OpenAPI definition + version: v0 +servers: [] +tags: +- name: ISO-8601 + description: the data +paths: + /api/test/offsetdatetime/with-stringtime: + get: + tags: + - ISO-8601 + operationId: getObjectWithStringTime + parameters: + - name: dateTime + in: query + description: Input date time + required: true + schema: + type: string + example: 2019-12-19T23:59:00+01:00 + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?([+-]\\d{2}:\\d{2}|Z)$" + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + /api/test/offsetdatetime/with-offsetdatetime: + get: + tags: + - ISO-8601 + operationId: getObjectWithOffsetDateTime + parameters: + - name: dateTime + in: query + description: Input date time + required: true + schema: + type: string + format: date-time + example: 2019-12-19T23:59:00+01:00 + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?([+-]\\d{2}:\\d{2}|Z)$" + responses: + "200": + description: OK + content: + application/json: + schema: + type: object +components: {} diff --git a/src/test/resources/actual/open-api-with-generate.yaml b/src/test/resources/myservice/actual/open-api-with-generate.yaml similarity index 100% rename from src/test/resources/actual/open-api-with-generate.yaml rename to src/test/resources/myservice/actual/open-api-with-generate.yaml diff --git a/src/test/resources/expected/open-api-with-generate.yaml b/src/test/resources/myservice/expected/open-api-with-generate.yaml similarity index 100% rename from src/test/resources/expected/open-api-with-generate.yaml rename to src/test/resources/myservice/expected/open-api-with-generate.yaml