Added new api module to support custom rule and ported 3 existing rul…

…es into new design. I
OpenAPITools · Aug 27, 2022 · 712e863 · 712e863
1 parent 13db6fb
commit 712e863
Show file tree

Hide file tree

Showing 42 changed files with 420 additions and 246 deletions.
diff --git a/api/build.gradle b/api/build.gradle
@@ -0,0 +1,59 @@
+plugins {
+    id "com.diffplug.spotless" version "6.9.1"
+}
+
+dependencies {
+    implementation 'org.eclipse.microprofile.openapi:microprofile-openapi-api:3.0'
+    testImplementation 'org.slf4j:slf4j-jdk14:2.0.0'
+    testImplementation 'org.openapitools.empoa:empoa-simple-models-impl:2.0.0'
+    testImplementation 'nl.jqno.equalsverifier:equalsverifier:3.10.1'
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
+    implementation group: 'org.reflections', name: 'reflections', version: '0.10.2'
+}
+
+java {
+    withJavadocJar()
+    withSourcesJar()
+}
+
+spotless {
+    java {
+        removeUnusedImports()
+        trimTrailingWhitespace()
+        palantirJavaFormat()
+    }
+}
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            artifactId = 'openapi-style-validator-api'
+            pom {
+                name = 'OpenAPI Style Validator - api'
+                description = 'module to expose API for writing rules to validate the style and standards of an OpenAPI specification'
+                packaging = 'jar'
+                url = 'https://openapitools.github.io/openapi-style-validator/'
+                inceptionYear = "2019"
+                licenses {
+                    license {
+                        name = 'Apache 2.0 License'
+                        url = 'http://www.apache.org/licenses/LICENSE-2.0'
+                    }
+                }
+                developers {
+                    developer {
+                        id = 'JFCote'
+                        name = 'Jean-Francois Cote'
+                        email = '[email protected]'
+                    }
+                }
+                scm {
+                    connection = 'scm:git:https://github.com/openapitools/openapi-style-validator.git'
+                    developerConnection = 'scm:git:https://github.com/openapitools/openapi-style-validator.git'
+                    url = 'https://github.com/openapitools/openapi-style-validator/'
+                }
+            }
+            from components.java
+        }
+    }
+}
diff --git a/api/src/main/java/org/openapitools/openapistylevalidator/api/Rule.java b/api/src/main/java/org/openapitools/openapistylevalidator/api/Rule.java
@@ -0,0 +1,14 @@
+package org.openapitools.openapistylevalidator.api;
+
+import java.util.Optional;
+import org.eclipse.microprofile.openapi.models.OpenAPI;
+import org.openapitools.openapistylevalidator.error.StyleError;
+
+public interface Rule {
+
+    String ruleName();
+
+    String description();
+
+    Optional<StyleError> execute(OpenAPI api);
+}
diff --git a/...lidator/styleerror/GenericStyleError.java → ...ylevalidator/error/GenericStyleError.java b/...lidator/styleerror/GenericStyleError.java → ...ylevalidator/error/GenericStyleError.java
@@ -1,4 +1,4 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 import java.util.Objects;
 

diff --git a/...tor/styleerror/ModelNamingStyleError.java → ...alidator/error/ModelNamingStyleError.java b/...tor/styleerror/ModelNamingStyleError.java → ...alidator/error/ModelNamingStyleError.java
@@ -1,4 +1,4 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 import java.util.Objects;
 

diff --git a/...validator/styleerror/ModelStyleError.java → ...stylevalidator/error/ModelStyleError.java b/...validator/styleerror/ModelStyleError.java → ...stylevalidator/error/ModelStyleError.java
@@ -1,4 +1,4 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 import java.util.Objects;
 

diff --git a/...styleerror/OperationNamingStyleError.java → ...ator/error/OperationNamingStyleError.java b/...styleerror/OperationNamingStyleError.java → ...ator/error/OperationNamingStyleError.java
@@ -1,4 +1,4 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 import java.util.Objects;
 import org.eclipse.microprofile.openapi.models.PathItem;

diff --git a/...dator/styleerror/OperationStyleError.java → ...evalidator/error/OperationStyleError.java b/...dator/styleerror/OperationStyleError.java → ...evalidator/error/OperationStyleError.java
@@ -1,4 +1,4 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 import java.util.Objects;
 import org.eclipse.microprofile.openapi.models.PathItem;

diff --git a/api/src/main/java/org/openapitools/openapistylevalidator/error/StyleCheckSection.java b/api/src/main/java/org/openapitools/openapistylevalidator/error/StyleCheckSection.java
@@ -0,0 +1,9 @@
+package org.openapitools.openapistylevalidator.error;
+
+public enum StyleCheckSection {
+    APIInfo,
+    Operations,
+    Models,
+    Naming,
+    OpenAPI,
+}
diff --git a/...stylevalidator/styleerror/StyleError.java → ...enapistylevalidator/error/StyleError.java b/...stylevalidator/styleerror/StyleError.java → ...enapistylevalidator/error/StyleError.java
@@ -1,15 +1,7 @@
-package org.openapitools.openapistylevalidator.styleerror;
+package org.openapitools.openapistylevalidator.error;
 
 public class StyleError {
 
-    public enum StyleCheckSection {
-        APIInfo,
-        Operations,
-        Models,
-        Naming,
-        OpenAPI,
-    }
-
     final StyleCheckSection styleCheckSection;
     final String fieldNames;
     final String description;

diff --git a/cli/build.gradle b/cli/build.gradle
@@ -6,6 +6,7 @@ apply plugin: 'application'
 
 dependencies {
     implementation project(':openapi-style-validator-lib')
+    implementation project(':openapi-style-validator-api')
     implementation 'commons-cli:commons-cli:1.5.0'
     implementation 'org.slf4j:slf4j-jdk14:2.0.0'
     implementation 'io.swagger.parser.v3:swagger-parser:2.0.33'

diff --git a/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java b/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java
@@ -10,7 +10,7 @@
 import org.apache.commons.cli.Options;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.openapitools.openapistylevalidator.styleerror.StyleError;
+import org.openapitools.openapistylevalidator.error.StyleError;
 
 class OutputUtils {
     private static final Logger logger = LogManager.getLogger(OutputUtils.class);

diff --git a/cli/src/main/java/org/openapitools/openapistylevalidator/cli/ValidationInitiator.java b/cli/src/main/java/org/openapitools/openapistylevalidator/cli/ValidationInitiator.java
@@ -7,9 +7,10 @@
 import org.apache.commons.cli.CommandLine;
 import org.eclipse.microprofile.openapi.models.OpenAPI;
 import org.openapitools.empoa.swagger.core.internal.SwAdapter;
+import org.openapitools.openapistylevalidator.OpenAPIStyleValidator;
 import org.openapitools.openapistylevalidator.OpenApiSpecStyleValidator;
 import org.openapitools.openapistylevalidator.ValidatorParameters;
-import org.openapitools.openapistylevalidator.styleerror.StyleError;
+import org.openapitools.openapistylevalidator.error.StyleError;
 
 public class ValidationInitiator {
     public List<StyleError> validate(OptionManager optionManager, CommandLine commandLine) {
@@ -31,4 +32,11 @@ private OpenAPI parseToOpenAPIModels(OptionManager optionManager, CommandLine co
         io.swagger.v3.oas.models.OpenAPI swaggerOpenAPI = parserResult.getOpenAPI();
         return SwAdapter.toOpenAPI(swaggerOpenAPI);
     }
+
+    public List<StyleError> validateV2(OptionManager optionManager, CommandLine commandLine) {
+        OpenAPI openAPI = parseToOpenAPIModels(optionManager, commandLine);
+        ValidatorParameters parameters = optionManager.getOptionalValidatorParametersOrDefault(commandLine);
+        OpenAPIStyleValidator openAPIStyleValidator = new OpenAPIStyleValidator(openAPI, parameters);
+        return openAPIStyleValidator.validate();
+    }
 }
diff --git a/cli/src/main/java/rules/CheckTagsAreDefinedRule.java b/cli/src/main/java/rules/CheckTagsAreDefinedRule.java
diff --git a/cli/src/main/java/rules/OperationHasTagRule.java b/cli/src/main/java/rules/OperationHasTagRule.java
diff --git a/cli/src/test/java/org/openapitools/openapistylevalidator/cli/ValidationInitiatorTest.java b/cli/src/test/java/org/openapitools/openapistylevalidator/cli/ValidationInitiatorTest.java
@@ -9,7 +9,7 @@
 import org.apache.commons.cli.ParseException;
 import org.junit.jupiter.api.*;
 import org.mockito.Mockito;
-import org.openapitools.openapistylevalidator.styleerror.StyleError;
+import org.openapitools.openapistylevalidator.error.StyleError;
 import org.opentest4j.MultipleFailuresError;
 
 class ValidationInitiatorTest {

diff --git a/...alidator/cli/CustomRuleValidatorTest.java → ...idator/cli/ValidationInitiatorV2Test.java b/...alidator/cli/CustomRuleValidatorTest.java → ...idator/cli/ValidationInitiatorV2Test.java
@@ -1,5 +1,8 @@
 package org.openapitools.openapistylevalidator.cli;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.List;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
 import org.apache.commons.cli.Options;
@@ -10,18 +13,13 @@
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
-import org.openapitools.openapistylevalidator.styleerror.StyleError;
+import org.openapitools.openapistylevalidator.error.StyleError;
 import org.opentest4j.MultipleFailuresError;
 
-import java.util.List;
-
-import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertThrows;
-
-class CustomRuleValidatorTest {
+class ValidationInitiatorV2Test {
     private static final DefaultParser parser = new DefaultParser();
-    public static final String SRC_TEST_RESOURCES_MISSING_TAG_YAML = "src/test/resources/missing_tags.yaml";
+
+    public static final String SRC_TEST_RESOURCES_PING_YAML = "src/test/resources/ping.yaml";
 
     private final OutputUtils outputUtils = Mockito.mock(OutputUtils.class);
     private OptionManager optionManager;
@@ -45,21 +43,20 @@ class Validate {
         class GivenFileProvidedWithInvalidTagDefinedYaml {
             @BeforeEach
             void init() throws ParseException {
-                commandLine = parser.parse(options, new String[] {"-s", SRC_TEST_RESOURCES_MISSING_TAG_YAML});
+                commandLine = parser.parse(options, new String[] {"-s", SRC_TEST_RESOURCES_PING_YAML});
             }
 
             @Test
             void returnSevenErrors() {
-                List<StyleError> errorList = validationInitiator.validate(optionManager, commandLine);
-
-                sevenErrorsAssertions(errorList);
+                List<StyleError> errorList = validationInitiator.validateV2(optionManager, commandLine);
+                fiveErrorsAssertions(errorList);
             }
         }
     }
 
-    private void sevenErrorsAssertions(List<StyleError> errorList) throws MultipleFailuresError {
+    private void fiveErrorsAssertions(List<StyleError> errorList) throws MultipleFailuresError {
         Assertions.assertAll(
-                () -> assertEquals(7, errorList.size()),
+                () -> assertEquals(3, errorList.size()),
                 () -> assertEquals(
                         "*ERROR* Section: APIInfo: 'license' -> Should be present and not empty",
                         errorList.get(0).toString()),
@@ -68,22 +65,6 @@ private void sevenErrorsAssertions(List<StyleError> errorList) throws MultipleFa
                         errorList.get(1).toString()),
                 () -> assertEquals(
                         "*ERROR* Section: APIInfo: 'contact' -> Should be present and not empty",
-                        errorList.get(2).toString()),
-                () -> assertEquals(
-                        "*ERROR* in Operation POST /ping 'description' -> This field should be present and not empty",
-                        errorList.get(3).toString()),
-                () -> assertEquals(
-                        "*ERROR* in Operation POST /ping 'summary' -> This field should be present and not empty",
-                        errorList.get(4).toString()),
-                () -> assertEquals(
-                        "*ERROR* Section: Operations: 'tags' -> FIX ME is not defined under tag section",
-                        errorList.get(5).toString()),
-
-                () -> assertEquals(
-                        "*ERROR* Section: Operations: 'tags' -> FIX ME is not defined under tag section",
-                        errorList.get(5).toString()),
-                () -> assertEquals(
-                        "*ERROR* Section: OpenAPI: 'tags' -> Should be present and not empty",
-                        errorList.get(6).toString()));
+                        errorList.get(2).toString()));
     }
 }
diff --git a/cli/src/test/resources/missing_tags.yaml b/cli/src/test/resources/missing_tags.yaml
diff --git a/gradle-plugin/build.gradle b/gradle-plugin/build.gradle
@@ -4,6 +4,7 @@ plugins {
 
 dependencies {
     implementation project(':openapi-style-validator-lib')
+    implementation project(':openapi-style-validator-api')
     implementation 'io.swagger.parser.v3:swagger-parser:2.0.33'
     implementation 'org.openapitools.empoa:empoa-swagger-core:2.0.0'
     testImplementation 'junit:junit:4.13.2'

diff --git a/...rc/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java b/...rc/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java
@@ -11,7 +11,7 @@
 import org.openapitools.openapistylevalidator.OpenApiSpecStyleValidator;
 import org.openapitools.openapistylevalidator.ValidatorParameters;
 import org.openapitools.openapistylevalidator.ValidatorParameters.NamingConvention;
-import org.openapitools.openapistylevalidator.styleerror.StyleError;
+import org.openapitools.openapistylevalidator.error.StyleError;
 
 import java.util.List;
 

diff --git a/lib/build.gradle b/lib/build.gradle
@@ -3,6 +3,7 @@ plugins {
 }
 
 dependencies {
+    implementation project(':openapi-style-validator-api')
     implementation 'org.eclipse.microprofile.openapi:microprofile-openapi-api:3.0'
     testImplementation 'org.slf4j:slf4j-jdk14:2.0.0'
     testImplementation 'org.openapitools.empoa:empoa-simple-models-impl:2.0.0'