Validate spec on generation by default

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java

@@ -72,4 +72,4 @@ public void run() {
             System.exit(1);
         }
     }
-}
+}

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java

@@ -194,6 +194,11 @@ public class Generate implements Runnable {
             description = CodegenConstants.REMOVE_OPERATION_ID_PREFIX_DESC)
     private Boolean removeOperationIdPrefix;
 
+    @Option(name = {"--skip-validate-spec"},
+            title = "skip spec validation",
+            description = "Skips the default behavior of validating an input specification.")
+    private Boolean skipValidateSpec;
+
     @Override
     public void run() {
 
@@ -207,6 +212,10 @@ public void run() {
         }
 
         // now override with any specified parameters
+        if (skipValidateSpec != null) {
+            configurator.setValidateSpec(false);
+        }
+
         if (verbose != null) {
             configurator.setVerbose(verbose);
         }

modules/openapi-generator-gradle-plugin/README.adoc

@@ -59,6 +59,11 @@ The gradle plugin is not currently published to https://plugins.gradle.org/m2/.
 |false
 |The verbosity of generation
 
+|validateSpec
+|Boolean
+|true
+|Whether or not we should validate the input spec before generation. Invalid specs result in an error.
+
 |generatorName
 |String
 |None

modules/openapi-generator-gradle-plugin/samples/local-spec/README.md

@@ -11,6 +11,7 @@ gradle openApiGenerate
 gradle openApiMeta
 gradle openApiValidate
 gradle buildGoSdk
+gradle generateGoWithInvalidSpec
 ```
 
 The samples can be tested against other versions of the plugin using the `openApiGeneratorVersion` property. For example:

modules/openapi-generator-gradle-plugin/samples/local-spec/build.gradle

@@ -54,3 +54,16 @@ task buildGoSdk(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTas
             dateLibrary: "threetenp"
     ]
 }
+
+task generateGoWithInvalidSpec(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask){
+    validateSpec = true
+    generatorName = "go"
+    inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
+    additionalProperties = [
+            packageName: "petstore"
+    ]
+    outputDir = "$buildDir/go".toString()
+    configOptions = [
+            dateLibrary: "threetenp"
+    ]
+}

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt

@@ -80,6 +80,7 @@ class OpenApiGeneratorPlugin : Plugin<Project> {
                     description = "Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents."
 
                     verbose.set(generate.verbose)
+                    validateSpec.set(generate.validateSpec)
                     generatorName.set(generate.generatorName)
                     outputDir.set(generate.outputDir)
                     inputSpec.set(generate.inputSpec)

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt

@@ -32,6 +32,11 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
      */
     val verbose = project.objects.property<Boolean>()
 
+    /**
+     * Whether or not an input specification should be validated upon generation.
+     */
+    val validateSpec = project.objects.property<Boolean>()
+
     /**
      * The name of the generator which will handle codegen. (see "openApiGenerators" task)
      */
@@ -262,6 +267,11 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
     val configOptions = project.objects.property<Map<String, String>>()
 
     init {
+        applyDefaults()
+    }
+
+    @Suppress("MemberVisibilityCanBePrivate")
+    fun applyDefaults(){
         releaseNote.set("Minor update")
         modelNamePrefix.set("")
         modelNameSuffix.set("")
@@ -271,5 +281,6 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
         generateApiDocumentation.set(true)
         withXml.set(false)
         configOptions.set(mapOf())
+        validateSpec.set(true)
     }
 }

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt

@@ -28,7 +28,6 @@ import org.gradle.kotlin.dsl.property
 import org.openapitools.codegen.CodegenConstants
 import org.openapitools.codegen.DefaultGenerator
 import org.openapitools.codegen.config.CodegenConfigurator
-import org.openapitools.codegen.config.CodegenConfiguratorUtils.*
 
 
 /**
@@ -48,6 +47,12 @@ open class GenerateTask : DefaultTask() {
     @get:Internal
     val verbose = project.objects.property<Boolean>()
 
+    /**
+     * Whether or not an input specification should be validated upon generation.
+     */
+    @get:Internal
+    val validateSpec = project.objects.property<Boolean>()
+
     /**
      * The name of the generator which will handle codegen. (see "openApiGenerators" task)
      */
@@ -382,6 +387,10 @@ open class GenerateTask : DefaultTask() {
                 configurator.isVerbose = value
             }
 
+            validateSpec.ifNotEmpty { value ->
+                configurator.isValidateSpec = value
+            }
+
             skipOverwrite.ifNotEmpty { value ->
                 configurator.isSkipOverwrite = value ?: false
             }
@@ -528,8 +537,7 @@ open class GenerateTask : DefaultTask() {
 
                 out.println("Successfully generated code to ${configurator.outputDir}")
             } catch (e: RuntimeException) {
-                logger.error(e.message)
-                throw GradleException("Code generation failed.")
+                throw GradleException("Code generation failed.", e)
             }
         } finally {
             originalEnvironmentVariables.forEach { entry ->

modules/openapi-generator-gradle-plugin/src/test/kotlin/GenerateTaskDslTest.kt

@@ -31,7 +31,7 @@ class GenerateTaskDslTest : TestBase()  {
     fun `openApiGenerate should create an expected file structure from DSL config`() {
         // Arrange
         val projectFiles = mapOf(
-                "spec.yaml" to javaClass.classLoader.getResourceAsStream("specs/petstore-v3.0-invalid.yaml")
+                "spec.yaml" to javaClass.classLoader.getResourceAsStream("specs/petstore-v3.0.yaml")
         )
         withProject(defaultBuildGradle, projectFiles)
 

modules/openapi-generator-maven-plugin/README.md

@@ -38,6 +38,7 @@ mvn clean compile
 ### General Configuration parameters
 
 - `inputSpec` - OpenAPI Spec file path
+- `validateSpec` - Whether or not to validate the input spec prior to generation. Invalid specifications will result in an error.
 - `language` - target generation language (deprecated, replaced by `generatorName` as values here don't represent only 'language' any longer)
 - `generatorName` - target generator name
 - `output` - target output path (default is `${project.build.directory}/generated-sources/swagger`)
@@ -102,4 +103,8 @@ Specifying a custom generator is a bit different. It doesn't support the classpa
 
 ### Sample configuration
 
-- Please see [an example configuration](examples) for using the plugin
+Please see [an example configuration](examples) for using the plugin. To run these examples, explicitly pass the file to maven. Example:
+
+```bash
+mvn -f non-java.xml compile
+```

modules/openapi-generator-maven-plugin/examples/java-client.xml

@@ -12,7 +12,7 @@
             <plugin>
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
-                <version>3.0.1-SNAPSHOT</version>
+                <version>3.1.1-SNAPSHOT</version>
                 <executions>
                     <execution>
                         <goals>

modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml

@@ -0,0 +1,34 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.openapitools</groupId>
+    <artifactId>sample-project</artifactId>
+    <packaging>jar</packaging>
+    <version>1.0-SNAPSHOT</version>
+    <name>sample-project</name>
+    <url>http://maven.apache.org</url>
+    <build>
+        <plugins>
+            <!-- activate the plugin -->
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <version>3.1.1-SNAPSHOT</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                        <configuration>
+                            <validateSpec>false</validateSpec>
+                            <inputSpec>petstore-v3.0-invalid.yaml</inputSpec>
+                            <generatorName>aspnetcore</generatorName>
+                            <configOptions>
+                                <additional-properties>optionalProjectFile=true</additional-properties>
+                            </configOptions>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>

modules/openapi-generator-maven-plugin/examples/non-java.xml

@@ -12,7 +12,7 @@
             <plugin>
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
-                <version>3.0.1-SNAPSHOT</version>
+                <version>3.1.1-SNAPSHOT</version>
                 <executions>
                     <execution>
                         <goals>

modules/openapi-generator-maven-plugin/examples/petstore-v3.0-invalid.yaml

@@ -0,0 +1,103 @@
+openapi: "3.0.0"
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java

@@ -60,6 +60,9 @@ public class CodeGenMojo extends AbstractMojo {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(CodeGenMojo.class);
 
+    @Parameter(name="validateSpec", required = false, defaultValue = "true")
+    private Boolean validateSpec;
+
     @Parameter(name = "verbose", required = false, defaultValue = "false")
     private boolean verbose;
 
@@ -348,6 +351,11 @@ public void execute() throws MojoExecutionException {
 
         configurator.setVerbose(verbose);
 
+        // now override with any specified parameters
+        if (validateSpec != null) {
+            configurator.setValidateSpec(validateSpec);
+        }
+
         if (skipOverwrite != null) {
             configurator.setSkipOverwrite(skipOverwrite);
         }