Examples with IDocumentValidatorExtension io.apicurio.datamodels.core.validation.IDocumentValidatorExtension used on opensource projects

Example 1 with IDocumentValidatorExtension

use of io.apicurio.datamodels.core.validation.IDocumentValidatorExtension in project apicurio-data-models by Apicurio.

the class Library method validateDocument.

/**
 * Called to validate a data model node.  All validation rules will be evaluated and reported.  The list
 * of validation problems found during validation is returned.  In addition, validation problems will be
 * reported on the individual nodes themselves.  Validation problem severity is determined by checking
 * with the included severity registry.  If the severity registry is null, a default registry is used.
 * Custom validators can be passed to provide additional validation rules beyond what this Library offers out of the box.
 *
 * @param node The document to be validated
 * @param severityRegistry Supply a custom severity registry. If nothing is passed, the default severity registry will be used
 * @param extensions Supply an optional list of validation extensions, enabling the use of 3rd-party validators or custom validation rules
 * @return full list of the validation problems found in the document
 */
public static CompletableFuture<List<ValidationProblem>> validateDocument(Node node, IValidationSeverityRegistry severityRegistry, List<IDocumentValidatorExtension> extensions) {
    List<ValidationProblem> totalValidationProblems = Library.validate(node, severityRegistry);
    if (extensions != null && !extensions.isEmpty()) {
        for (IDocumentValidatorExtension extension : extensions) {
            CompletableFuture<List<ValidationProblem>> extensionValidationProblems = extension.validateDocument(node);
            extensionValidationProblems.thenAccept(problems -> problems.forEach(p -> {
                totalValidationProblems.add(p);
                node.ownerDocument().addValidationProblem(p.errorCode, p.nodePath, p.property, p.message, p.severity);
            }));
        }
    }
    return CompletableFuture.completedFuture(totalValidationProblems);
}

Example 2 with IDocumentValidatorExtension

use of io.apicurio.datamodels.core.validation.IDocumentValidatorExtension in project apicurio-data-models by Apicurio.

the class TestValidationExtension method testValidateDocumentWithCustomExtension.

@Test
public void testValidateDocumentWithCustomExtension() {
    String jsonString = "{\r\n" + "    \"openapi\": \"3.0.9\",\r\n" + "    \"info\": {\r\n" + "        \"title\": \"Very Simple API\",\r\n" + "        \"version\": \"1.0.0\"\r\n" + "    }\r\n" + "}";
    Document doc = Library.readDocumentFromJSONString(jsonString);
    List<IDocumentValidatorExtension> extensions = new ArrayList<>();
    extensions.add(new TestValidationExtension());
    CompletableFuture<List<ValidationProblem>> problems = Library.validateDocument(doc, null, extensions);
    problems.whenCompleteAsync((validationProblems, done) -> {
        List<String> expectedErrorCodes = Arrays.asList("R-003", "TEST-001");
        List<String> documentErrorCodes = doc.getValidationProblemCodes();
        Assert.assertEquals(expectedErrorCodes, documentErrorCodes);
        List<String> problemErrorCodes = validationProblems.stream().map(p -> p.errorCode).collect(Collectors.toList());
        Assert.assertEquals(expectedErrorCodes, problemErrorCodes);
    });
}