Handle non-json files when validating a directory (#13)

README.md

@@ -4,7 +4,7 @@
 
 Provides json validation as a part of your gradle build pipeline.
 
-This plugin implements a custom task type, [ValidateJsonTask](https://github.com/alenkacz/gradle-json-validator/blob/master/src/main/groovy/cz/alenkacz/gradle/jsonvalidator/ValidateJsonTask.groovy). This task expects two properties - *targetJsonFile* and *jsonSchemaFile* (instead of *targetJsonFile* you can use *targetJsonDirectory* and then all files in that directory will be validated). If you need to validate more jsons as a part of one build, you will have to create as many custom tasks as the number of json schema files (see *validateCustomJson* in the example below).
+This plugin implements a custom task type, [ValidateJsonTask](https://github.com/alenkacz/gradle-json-validator/blob/master/src/main/groovy/cz/alenkacz/gradle/jsonvalidator/ValidateJsonTask.groovy). This task expects two properties - *targetJsonFile* and *jsonSchemaFile* (instead of *targetJsonFile* you can use *targetJsonDirectory* and then all files in that directory will be validated). If that directory contains both json and non-json files, the task will fail for non-json files. If you want to validate only files with .json extension use the `onlyWithJsonExtension` property. If you need to validate more jsons as a part of one build, you will have to create as many custom tasks as the number of json schema files (see *validateCustomJson* in the example below).
 
 Usage
 ====================
@@ -26,6 +26,7 @@ Usage
       targetJsonFile = file("target.json") // only one of targetJsonFile or targetJsonDirectory can be specified 
       targetJsonDirectory = file("directoryWithJsons") // only one of targetJsonFile or targetJsonDirectory can be specified
       jsonSchema = file("schema.json")
+      onlyWithJsonExtension = true // default is false, this makes sense only when using targetJsonDirectory, it ignores all files apart from those who do not have .json file extension
     }
 
 JSON schema syntax check

src/main/groovy/cz/alenkacz/gradle/jsonvalidator/ValidateJsonTask.groovy

@@ -9,6 +9,7 @@ import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.InputFile
+import org.json.JSONException
 import org.json.JSONObject
 import org.json.JSONTokener
 
@@ -23,10 +24,18 @@ class ValidateJsonTask extends DefaultTask {
     @InputDirectory
     @Optional
     File targetJsonDirectory
+    @Optional
+    Boolean onlyWithJsonExtension
 
     @TaskAction
     def validateJson() {
         // check files exist
+        if (onlyWithJsonExtension != null && targetJsonDirectory == null) {
+            throw new IllegalArgumentException("Cannot use onlyWithJsonExtension property without using targetJsonDirectory.")
+        }
+        if (onlyWithJsonExtension == null) {
+            onlyWithJsonExtension = false
+        }
         new FileInputStream(jsonSchema).withStream {
             JSONObject rawSchema = new JSONObject(new JSONTokener(it))
             Schema schema = SchemaLoader.load(rawSchema)
@@ -44,6 +53,11 @@ class ValidateJsonTask extends DefaultTask {
                     schema.validate(new JSONObject(new FileInputStream(it).getText()))
                 } catch (ValidationException e) {
                     violations << new ValidationError(jsonFilePath: it.absolutePath, violations: getViolations(e))
+                } catch (JSONException e) {
+                    if (!onlyWithJsonExtension || hasJsonExtension(it)) {
+                        // invalid json file is considered a violation only when onlyWithJsonExtension is not used or if the file does not have json extension
+                        violations << new ValidationError(jsonFilePath: it.absolutePath, violations: ["File is not valid json: ${e.message}"])
+                    }
                 }
             }
             if (!violations.empty) {
@@ -52,6 +66,10 @@ class ValidateJsonTask extends DefaultTask {
         }
     }
 
+    def hasJsonExtension(File file) {
+        file.name.contains(".") && file.name.take(file.name.lastIndexOf('.')) == "json"
+    }
+
     List<String> getViolations(ValidationException e) {
         if (e.causingExceptions.empty) {
             [e.message]

src/test/groovy/cz/alenkacz/gradle/jsonvalidator/ValidateJsonTaskTest.groovy

@@ -78,6 +78,45 @@ class ValidateJsonTaskTest extends Specification  {
         actual.task(":validateCustomJson").outcome == TaskOutcome.FAILED
     }
 
+    def "fail on non-json file"() {
+        given:
+        final FileTreeBuilder treeBuilder = new FileTreeBuilder(targetProjectDir.newFolder("non-json-folder"))
+        treeBuilder.file("test.json", getInvalidJson())
+        treeBuilder.file("nonjson.txt", "randomtext")
+        gradleBuildFile.text = getFolderGradleFile("non-json-folder")
+        jsonSchemaFile << getJsonSchema()
+
+        when:
+        def actual = GradleRunner.create()
+                .withProjectDir(targetProjectDir.root)
+                .withArguments(':validateCustomJson', '--stacktrace')
+                .buildAndFail()
+
+        then:
+        actual.output.contains("File is not valid json")
+        actual.output.contains("nonjson.txt")
+        actual.task(":validateCustomJson").outcome == TaskOutcome.FAILED
+    }
+
+    def "not fail on non-json file when using onlyWithJsonExtension"() {
+        given:
+        final FileTreeBuilder treeBuilder = new FileTreeBuilder(targetProjectDir.newFolder("non-json-folder"))
+        treeBuilder.file("test.json", getCorrectJson())
+        treeBuilder.file("nonjson.txt", "randomtext")
+        gradleBuildFile.text = getFolderGradleFile("non-json-folder", true)
+        jsonSchemaFile << getJsonSchema()
+
+        when:
+        def actual = GradleRunner.create()
+                .withProjectDir(targetProjectDir.root)
+                .withArguments(':validateCustomJson', '--stacktrace')
+                .build()
+
+        then:
+        print(actual.output)
+        actual.task(":validateCustomJson").outcome == TaskOutcome.SUCCESS
+    }
+
     def getCorrectJson() {
         '''
             {
@@ -139,7 +178,7 @@ class ValidateJsonTaskTest extends Specification  {
         """
     }
 
-    def getFolderGradleFile() {
+    def getFolderGradleFile(folderName = "json", onlyWithJsonExtension = false) {
         """
             buildscript {
                 dependencies {
@@ -151,8 +190,9 @@ class ValidateJsonTaskTest extends Specification  {
             import cz.alenkacz.gradle.jsonvalidator.ValidateJsonTask
 
             task validateCustomJson(type: ValidateJsonTask) {
-                targetJsonDirectory = file("json")
+                targetJsonDirectory = file("$folderName")
                 jsonSchema = project.file("schema.json")
+                onlyWithJsonExtension = ${onlyWithJsonExtension ? "true" : "false"}
             }
         """
     }