Merge pull request #2 from kirpi4ik/v1.2

V1.2

.gitignore

@@ -7,4 +7,5 @@ build/
 ### IntelliJ IDEA ###
 .DS_Store
 .idea
-
+### VSC
+bin

README.md

@@ -2,9 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-[![Version](https://badge.fury.io/gh/kirpi4ik%2Fgraphql-java-linter.svg)](https://badge.fury.io/gh/kirpi4ik%2Fgraphql-java-linter)
-[![GitHub Release](https://img.shields.io/github/v/release/kirpi4ik/graphql-java-linter?include_prereleases)]()  
-[![Maven Central](https://img.shields.io/maven-central/v/org.myhab.tools/graphql-java-linter)]()  
+[![Build project](https://github.com/kirpi4ik/graphql-java-linter/actions/workflows/gradle.yml/badge.svg)](https://github.com/kirpi4ik/graphql-java-linter/actions/workflows/gradle.yml) 
+[![GitHub Release](https://img.shields.io/github/v/release/kirpi4ik/graphql-java-linter?include_prereleases)](https://github.com/kirpi4ik/graphql-java-linter/releases) 
+[![Maven Central](https://img.shields.io/maven-central/v/org.myhab.tools/graphql-java-linter)](https://search.maven.org/artifact/org.myhab.tools/graphql-java-linter)  
 [![Nexus snapshot](https://img.shields.io/nexus/s/org.myhab.tools/graphql-java-linter?server=https%3A%2F%2Fs01.oss.sonatype.org%2F)](https://s01.oss.sonatype.org/content/repositories/snapshots/org/myhab/tools/graphql-java-linter/)
 
 ### Usage
@@ -44,9 +44,9 @@ rules:
 ### Command line
 
 #### Run from command line:
-
+Download from [packages](https://github.com/kirpi4ik/graphql-java-linter/packages/1728805) the latest version.
 ```bash
-java -jar graphql-java-linter-1.1-cli.jar linter.yaml
+java -jar graphql-java-linter-1.2-cli.jar linter.yaml
 ```
 
 ### In CI/CD flow via unit tests
@@ -57,7 +57,7 @@ java -jar graphql-java-linter-1.1-cli.jar linter.yaml
 
 ```groovy
 dependencies {
-    test 'org.myhab.tools:graphql-java-linter:1.1'
+    test 'org.myhab.tools:graphql-java-linter:1.2'
 }
 ```
 
@@ -68,7 +68,7 @@ dependencies {
 <dependency>
     <groupId>org.myhab.tools</groupId>
     <artifactId>graphql-java-linter</artifactId>
-    <version>1.1</version>
+    <version>1.2</version>
     <scope>test</scope>
 </dependency>
 ```
@@ -110,6 +110,11 @@ rule(["FIELD"]) {
     }
 }
 ```
+File name will be used as the rule name. 
+Most important object/methods used during validation and available also in DSL are :
+ - `parent` - Parent element [[GraphQLNamedSchemaElement](https://github.com/graphql-java/graphql-java/blob/master/src/main/java/graphql/schema/GraphQLNamedSchemaElement.java)], in case of type - it will be null 
+ - `node` - Current element [[GraphQLNamedSchemaElement](https://github.com/graphql-java/graphql-java/blob/master/src/main/java/graphql/schema/GraphQLNamedSchemaElement.java)]
+ - `fail(parent, node, message)` - Record the failure into execution context(validation queue will be not interrupted).
 
 In configuration file you will have to specify folder location which contains the dsl rules
 

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'org.myhab.tools'
-version '1.1'
+version '1.2'
 
 task cliJar(type: Jar) {
     manifest {
@@ -52,9 +52,6 @@ publishing {
             version = project.version
 
             from project.components.java
-            artifact cliJar {
-                classifier "cli"
-            }
 
             pom {
                 name = project.name
@@ -109,7 +106,6 @@ publishing {
 signing {
     useGpgCmd()
     sign publishing.publications.mavenJava
-    sign publishing.publications.gpr
 }
 test {
     useJUnitPlatform()

src/main/groovy/graphql/linter/BasicResultHandler.groovy

@@ -2,30 +2,31 @@ package graphql.linter
 
 import graphql.linter.exception.RuleValidationError
 
-class BasicResultHandler implements ResultHandler{
-    def handle(executionEnvironment, context){
+class BasicResultHandler implements ResultHandler {
+    def handle(executionEnvironment, context) {
         boolean hasErrors = context.errors.any { error -> error.value.any { it.level == FailLevel.ERROR } }
         if (hasErrors) {
             def failedRules = context.errors.findAll { error -> error.value.any { it.level == FailLevel.ERROR } }
             throw new RuleValidationError(failedRules)
         }
         boolean hasWarnings = context.errors.any { error -> error.value.any { it.level == FailLevel.WARN } }
+        int rowLength = 160
         if (hasWarnings) {
-            printf("#######################################################################################################################%n")
-            printf("###################################################    FAILURES   #####################################################%n")
-            printf("#######################################################################################################################%n")
+            printf "${'#' * rowLength}%n"
+            printf "${'#' * (rowLength / 2 - 5)} FAILURES ${'#' * (rowLength / 2 - 5)}%n"
+            printf "${'#' * rowLength}%n"
             def failedRules = context.errors.findAll { error -> error.value.any { it.level == FailLevel.WARN } }
             failedRules.each { ruleName, ruleWarn ->
-                printf("#---------------------------------------------------------------------------------------------------------------------#%n")
-                printf "# [ %-30s ] [ %-3d failures][%-6d runs] [%-4.3f sec/rule]                                    #%n", ruleName, ruleWarn.size(), context.execution[ruleName]['count'], context.execution[ruleName]['time']
-                ruleWarn.each { error -> printf("#            +  %-100s  #%n", error.message)
+                printf "#${'=' * (rowLength-2)}#%n"
+                printf "# * %-35s  [ %-3d failures][%-6d runs] [%-3.3f sec/rule]${' ' * (rowLength - 87)}#%n", ruleName, ruleWarn.size(), context.execution[ruleName]['count'], context.execution[ruleName]['time']
+                ruleWarn.each { error -> printf("#            +  %-${rowLength - 19}s  #%n", error.message)
                 }
-                def failWhenExceed = executionEnvironment.config['rules'][ruleName as String]?['failWhenExceed']
+                def failWhenExceed = executionEnvironment.config['rules'][ruleName as String] ?['failWhenExceed']
                 if (executionEnvironment.config['failWhenExceedWarningMax'] && (failWhenExceed && ruleWarn.size() > failWhenExceed)) {
                     throw new RuleValidationError("[${ruleName}] Exceeded number of failures. ${ruleWarn.size()} > ${failWhenExceed} ")
                 }
             }
-            printf("#######################################################################################################################%n")
+            printf "${'#' * rowLength}%n"
         }
     }
 }

src/main/groovy/graphql/linter/registry/RulesRegistry.groovy

@@ -3,6 +3,8 @@ package graphql.linter.registry
 import graphql.linter.LinterConfiguration
 import graphql.linter.rules.LintRule
 
+import static java.util.stream.Collectors.toList
+
 class RulesRegistry implements Registry {
     private Set<LintRule> fieldRules = new HashSet<>()
     private Set<LintRule> typeRules = new HashSet<>()
@@ -11,8 +13,16 @@ class RulesRegistry implements Registry {
         def registryDynamic = new RulesRegistryDynamic(config)
         fieldRules.addAll registryDynamic.fieldRuleSet
         typeRules.addAll registryDynamic.typeRuleSet
+        //Allow only one rule with the same name,
+        //If there is already defined a DSL rule with same name, static rule will be ignored(overwritten)
         def registryStatic = new RulesRegistryStatic()
+        if (registryStatic.fieldRuleSet.stream().anyMatch(fieldRules::contains)) {
+            println("WARNING: Duplicated field rules found: ${registryStatic.fieldRuleSet.stream().filter(fieldRules::contains).map(rule -> rule.name()).collect(toList())}")
+        }
         fieldRules.addAll registryStatic.fieldRuleSet
+        if (registryStatic.typeRuleSet.stream().anyMatch(typeRules::contains)) {
+            println("WARNING: Duplicated type rules found: ${registryStatic.typeRuleSet.stream().filter(typeRules::contains).map(rule -> rule.name()).collect(toList())}")
+        }
         typeRules.addAll registryStatic.typeRuleSet
     }
 

src/main/groovy/graphql/linter/registry/RulesRegistryStatic.groovy

@@ -14,6 +14,7 @@ class RulesRegistryStatic implements Registry {
         register(ArgumentsHasDescriptions.class)
         register(DeprecationHasReason.class)
         register(EnumValueAllCaps.class)
+        register(TypeNameFirstCaps.class)
     }
 
     def register(Class<?> rule) {

src/main/groovy/graphql/linter/rules/LintRule.groovy

@@ -37,4 +37,14 @@ abstract class LintRule {
                 executionEnvironment.config.rules[name()] ?['level'] as FailLevel ?: executionEnvironment.config.level,
                 " ${message}")
     }
+
+    @Override
+    boolean equals(Object obj) {
+        return obj instanceof LintRule && obj.name() == this.name()
+    }
+
+    @Override
+    int hashCode() {
+        return name().hashCode()
+    }
 }

src/main/groovy/graphql/linter/rules/TypeNameFirstCaps.groovy

@@ -0,0 +1,14 @@
+package graphql.linter.rules
+
+import graphql.linter.registry.types.TypeRule
+import graphql.schema.GraphQLNamedSchemaElement
+
+@TypeRule
+class TypeNameFirstCaps extends LintRule {
+    @Override
+    def validate(GraphQLNamedSchemaElement parent, GraphQLNamedSchemaElement node) {
+        if (!(node.name ==~ /^[A-Z].+/)) {
+            fail(parent, node, "Type `${node.name}` has invalid name, it should start with caps ")
+        }
+    }
+}

src/test/resources/rules/test_field_rule.groovy

@@ -1,5 +1,5 @@
 rule(["FIELD", "TYPE"]) {
     if (node.name ==~ /^[a-z].*/) {
-        fail(parent, node, "The fieldname `${parent.name}.${node.name}` starts with uppercase.")
+        fail(parent, node, "The fieldname `${parent?.name}.${node.name}` starts with uppercase.")
     }
 }

src/test/resources/schema/file2.graphqls

@@ -1,3 +1,14 @@
 extend type Query {
     Camel:String
+    field(arg:invalidInputName):String
+}
+
+input invalidInputName {
+    id:String
+}
+type invalidTypeName{
+    id:String
+}
+enum invalidEnumName{
+    EN
 }