-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into compat_rest_api
- Loading branch information
Showing
416 changed files
with
8,792 additions
and
5,206 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
buildSrc/src/main/java/org/elasticsearch/gradle/precommit/ValidateJsonAgainstSchemaTask.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.gradle.precommit; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.networknt.schema.JsonSchema; | ||
| import com.networknt.schema.JsonSchemaException; | ||
| import com.networknt.schema.JsonSchemaFactory; | ||
| import com.networknt.schema.SchemaValidatorsConfig; | ||
| import com.networknt.schema.SpecVersion; | ||
| import com.networknt.schema.ValidationMessage; | ||
| import org.gradle.api.DefaultTask; | ||
| import org.gradle.api.UncheckedIOException; | ||
| import org.gradle.api.file.FileCollection; | ||
| import org.gradle.api.tasks.Input; | ||
| import org.gradle.api.tasks.InputFile; | ||
| import org.gradle.api.tasks.InputFiles; | ||
| import org.gradle.api.tasks.Optional; | ||
| import org.gradle.api.tasks.OutputFile; | ||
| import org.gradle.api.tasks.TaskAction; | ||
| import org.gradle.work.ChangeType; | ||
| import org.gradle.work.Incremental; | ||
| import org.gradle.work.InputChanges; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.PrintWriter; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.StandardOpenOption; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.HashSet; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.LinkedHashSet; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.stream.StreamSupport; | ||
|
|
||
| /** | ||
| * Incremental task to validate a set of JSON files against against a schema. | ||
| */ | ||
| public class ValidateJsonAgainstSchemaTask extends DefaultTask { | ||
|
|
||
| private final ObjectMapper mapper = new ObjectMapper(); | ||
| private Set<String> ignore = new HashSet<>(); | ||
| private File jsonSchema; | ||
| private FileCollection inputFiles; | ||
|
|
||
| @Incremental | ||
| @InputFiles | ||
| public FileCollection getInputFiles() { | ||
| return inputFiles; | ||
| } | ||
|
|
||
| public void setInputFiles(FileCollection inputFiles) { | ||
| this.inputFiles = inputFiles; | ||
| } | ||
|
|
||
| @InputFile | ||
| public File getJsonSchema() { | ||
| return jsonSchema; | ||
| } | ||
|
|
||
| public void setJsonSchema(File jsonSchema) { | ||
| this.jsonSchema = jsonSchema; | ||
| } | ||
|
|
||
| @Input | ||
| @Optional | ||
| public Set<String> getIgnore() { | ||
| return ignore; | ||
| } | ||
|
|
||
| public void ignore(String... ignore) { | ||
| this.ignore.addAll(Arrays.asList(ignore)); | ||
| } | ||
|
|
||
| @OutputFile | ||
| public File getReport() { | ||
| return new File(getProject().getBuildDir(), "reports/validateJson.txt"); | ||
| } | ||
|
|
||
| @TaskAction | ||
| public void validate(InputChanges inputChanges) throws IOException { | ||
| File jsonSchemaOnDisk = getJsonSchema(); | ||
| getLogger().debug("JSON schema : [{}]", jsonSchemaOnDisk.getAbsolutePath()); | ||
| SchemaValidatorsConfig config = new SchemaValidatorsConfig(); | ||
| JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7); | ||
| JsonSchema jsonSchema = factory.getSchema(mapper.readTree(jsonSchemaOnDisk), config); | ||
| Map<File, Set<String>> errors = new LinkedHashMap<>(); | ||
| // incrementally evaluate input files | ||
| StreamSupport.stream(inputChanges.getFileChanges(getInputFiles()).spliterator(), false) | ||
| .filter(f -> f.getChangeType() != ChangeType.REMOVED) | ||
| .forEach(fileChange -> { | ||
| File file = fileChange.getFile(); | ||
| if (ignore.contains(file.getName())) { | ||
| getLogger().debug("Ignoring file [{}] due to configuration", file.getName()); | ||
| } else if (file.isDirectory() == false) { | ||
| // validate all files and hold on to errors for a complete report if there are failures | ||
| getLogger().debug("Validating JSON [{}]", file.getName()); | ||
| try { | ||
| Set<ValidationMessage> validationMessages = jsonSchema.validate(mapper.readTree(file)); | ||
| maybeLogAndCollectError(validationMessages, errors, file); | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| } | ||
| }); | ||
| if (errors.isEmpty()) { | ||
| Files.writeString(getReport().toPath(), "Success! No validation errors found.", StandardOpenOption.CREATE); | ||
| } else { | ||
| try (PrintWriter printWriter = new PrintWriter(getReport())) { | ||
| printWriter.printf("Schema: %s%n", jsonSchemaOnDisk); | ||
| printWriter.println("----------Validation Errors-----------"); | ||
| errors.values().stream().flatMap(Collection::stream).forEach(printWriter::println); | ||
| } | ||
| StringBuilder sb = new StringBuilder(); | ||
| sb.append("Error validating JSON. See the report at: "); | ||
| sb.append(getReport().toURI().toASCIIString()); | ||
| sb.append(System.lineSeparator()); | ||
| sb.append( | ||
| String.format("JSON validation failed: %d files contained %d violations", errors.keySet().size(), errors.values().size()) | ||
| ); | ||
| throw new JsonSchemaException(sb.toString()); | ||
| } | ||
| } | ||
|
|
||
| private void maybeLogAndCollectError(Set<ValidationMessage> messages, Map<File, Set<String>> errors, File file) { | ||
| for (ValidationMessage message : messages) { | ||
| getLogger().error("[validate JSON][ERROR][{}][{}]", file.getName(), message.toString()); | ||
| errors.computeIfAbsent(file, k -> new LinkedHashSet<>()) | ||
| .add(String.format("%s: %s", file.getAbsolutePath(), message.toString())); | ||
| } | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
buildSrc/src/main/java/org/elasticsearch/gradle/precommit/ValidateRestSpecPlugin.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.gradle.precommit; | ||
|
|
||
| import org.elasticsearch.gradle.util.Util; | ||
| import org.gradle.api.Plugin; | ||
| import org.gradle.api.Project; | ||
| import org.gradle.api.provider.Provider; | ||
|
|
||
| import java.io.File; | ||
|
|
||
| public class ValidateRestSpecPlugin implements Plugin<Project> { | ||
| private static final String DOUBLE_STAR = "**"; // checkstyle thinks these are javadocs :( | ||
|
|
||
| @Override | ||
| public void apply(Project project) { | ||
| Provider<ValidateJsonAgainstSchemaTask> validateRestSpecTask = project.getTasks() | ||
| .register("validateRestSpec", ValidateJsonAgainstSchemaTask.class, task -> { | ||
| task.setInputFiles(Util.getJavaTestAndMainSourceResources(project, filter -> { | ||
| filter.include(DOUBLE_STAR + "/rest-api-spec/api/" + DOUBLE_STAR + "/*.json"); | ||
| filter.exclude(DOUBLE_STAR + "/_common.json"); | ||
| })); | ||
| task.setJsonSchema(new File(project.getRootDir(), "rest-api-spec/src/main/resources/schema.json")); | ||
| }); | ||
| project.getTasks().named("precommit").configure(t -> t.dependsOn(validateRestSpecTask)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
...rc/src/main/resources/META-INF/gradle-plugins/elasticsearch.validate-rest-spec.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| implementation-class=org.elasticsearch.gradle.precommit.ValidateRestSpecPlugin |
Oops, something went wrong.