android-16.0.0_r2/s

/*
 * Copyright (c) 2020 Network New Technologies Inc.
 *
 * Licensed 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 com.networknt.schema;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.networknt.schema.SpecVersion.VersionFlag;
import com.networknt.schema.serialization.JsonMapperFactory;
import com.networknt.schema.suite.TestCase;
import com.networknt.schema.suite.TestSource;
import com.networknt.schema.suite.TestSpec;

import org.junit.jupiter.api.AssertionFailureBuilder;
import org.junit.jupiter.api.DynamicNode;
import org.opentest4j.AssertionFailedError;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static com.networknt.schema.SpecVersionDetector.detectVersion;
import static org.junit.jupiter.api.Assumptions.abort;
import static org.junit.jupiter.api.DynamicContainer.dynamicContainer;
import static org.junit.jupiter.api.DynamicTest.dynamicTest;

public abstract class AbstractJsonSchemaTestSuite extends HTTPServiceSupport {


    protected ObjectMapper mapper = JsonMapperFactory.getInstance();

    private static String toForwardSlashPath(Path file) {
        return file.toString().replace('\\', '/');
    }

    private static void executeTest(JsonSchema schema, TestSpec testSpec) {
        Set<ValidationMessage> errors = schema.validate(testSpec.getData(), OutputFormat.DEFAULT, (executionContext, validationContext) -> {
            if (testSpec.getTestCase().getSource().getPath().getParent().toString().endsWith("format")) {
                executionContext.getExecutionConfig().setFormatAssertionsEnabled(true);
            }
        });

        if (testSpec.isValid()) {
            if (!errors.isEmpty()) {
                String msg = new StringBuilder("Expected success")
                        .append("\n  description: ")
                        .append(testSpec.getDescription())
                        .append("\n  schema: ")
                        .append(schema)
                        .append("\n  data: ")
                        .append(testSpec.getData())
                        .toString();

                AssertionFailedError t = AssertionFailureBuilder.assertionFailure()
                        .message(msg)
                        .reason(errors.stream().map(ValidationMessage::getMessage).collect(Collectors.joining("\n    ", "\n  errors:\n    ", "")))
                        .build();
                t.setStackTrace(new StackTraceElement[0]);
                throw t;
            }
        } else {
            if (errors.isEmpty()) {
                String msg = new StringBuilder("Expected failure")
                        .append("\n  description: ")
                        .append(testSpec.getDescription())
                        .append("\n  schema: ")
                        .append(schema)
                        .append("\n  data: ")
                        .append(testSpec.getData())
                        .toString();

                AssertionFailedError t = AssertionFailureBuilder.assertionFailure()
                        .message(msg)
                        .build();
                t.setStackTrace(new StackTraceElement[0]);
                throw t;
            }
        }

        // Expected Validation Messages need not be exactly same as actual errors.
        // This code checks if expected validation message is subset of actual errors
        Set<String> actual = errors.stream().map(ValidationMessage::getMessage).collect(Collectors.toSet());
        Set<String> expected = testSpec.getValidationMessages();
        expected.removeAll(actual);
        if (!expected.isEmpty()) {
            String msg = new StringBuilder("Expected Validation Messages")
                    .append("\n  description: ")
                    .append(testSpec.getDescription())
                    .append("\n  schema: ")
                    .append(schema)
                    .append("\n  data: ")
                    .append(testSpec.getData())
                    .append(actual.stream().collect(Collectors.joining("\n    ", "\n  errors:\n    ", "")))
                    .toString();

            AssertionFailedError t = AssertionFailureBuilder.assertionFailure()
                    .message(msg)
                    .reason(expected.stream().collect(Collectors.joining("\n    ", "\n  expected:\n    ", "")))
                    .build();
            t.setStackTrace(new StackTraceElement[0]);
            throw t;
        }
    }

    private static Iterable<? extends DynamicNode> unsupportedMetaSchema(TestCase testCase) {
        return Collections.singleton(
                dynamicTest("Detected an unsupported schema", () -> {
                    String schema = testCase.getSchema().asText();
                    AssertionFailedError t = AssertionFailureBuilder.assertionFailure()
                            .message("Detected an unsupported schema: " + schema)
                            .reason("Future and custom meta-schemas are not supported")
                            .build();
                    t.setStackTrace(new StackTraceElement[0]);
                    throw t;
                })
        );
    }

    protected Stream<DynamicNode> createTests(VersionFlag defaultVersion, String basePath) {
        return findTestCases(basePath)
                .stream()
                .peek(System.out::println)
                .flatMap(path -> buildContainers(defaultVersion, path));
    }

    protected boolean enabled(@SuppressWarnings("unused") Path path) {
        return true;
    }

    protected Optional<String> reason(@SuppressWarnings("unused") Path path) {
        return Optional.empty();
    }

    private Stream<DynamicNode> buildContainers(VersionFlag defaultVersion, Path path) {
        boolean disabled = !enabled(path);
        String reason = reason(path).orElse("Unknown");
        return TestSource.loadFrom(path, disabled, reason)
                .map(testSource -> buildContainer(defaultVersion, testSource))
                .orElse(Stream.empty());
    }

    private Stream<DynamicNode> buildContainer(VersionFlag defaultVersion, TestSource testSource) {
        return testSource.getTestCases().stream().map(testCase -> buildContainer(defaultVersion, testCase));
    }

    private DynamicNode buildContainer(VersionFlag defaultVersion, TestCase testCase) {
        try {
            JsonSchemaFactory validatorFactory = buildValidatorFactory(defaultVersion, testCase);

            return dynamicContainer(testCase.getDisplayName(), testCase.getTests().stream().map(testSpec -> {
                return buildTest(validatorFactory, testSpec);
            }));
        } catch (JsonSchemaException e) {
            String msg = e.getMessage();
            if (msg.endsWith("' is unrecognizable schema")) {
                return dynamicContainer(testCase.getDisplayName(), unsupportedMetaSchema(testCase));
            }
            throw e;
        }
    }

    private JsonSchemaFactory buildValidatorFactory(VersionFlag defaultVersion, TestCase testCase) {
        if (testCase.isDisabled()) return null;

        VersionFlag specVersion = detectVersion(testCase.getSchema(), testCase.getSpecification(), defaultVersion, false);
        JsonSchemaFactory base = JsonSchemaFactory.getInstance(specVersion);
        return JsonSchemaFactory
                .builder(base)
                .jsonMapper(this.mapper)
                .schemaMappers(schemaMappers -> schemaMappers
                        .mapPrefix("https://", "http://")
                        .mapPrefix("http://json-schema.org", "resource:"))
                .build();
    }

    private DynamicNode buildTest(JsonSchemaFactory validatorFactory, TestSpec testSpec) {
        if (testSpec.isDisabled()) {
            return dynamicTest(testSpec.getDescription(), () -> abortAndReset(testSpec.getReason()));
        }

        // Configure the schemaValidator to set typeLoose's value based on the test file,
        // if test file do not contains typeLoose flag, use default value: false.
        @SuppressWarnings("deprecation") boolean typeLoose = testSpec.isTypeLoose();

        SchemaValidatorsConfig config = new SchemaValidatorsConfig();
        config.setTypeLoose(typeLoose);
        config.setEcma262Validator(TestSpec.RegexKind.JDK != testSpec.getRegex());
        testSpec.getStrictness().forEach(config::setStrict);

        if (testSpec.getConfig() != null) {
            if (testSpec.getConfig().containsKey("isCustomMessageSupported")) {
                config.setCustomMessageSupported((Boolean) testSpec.getConfig().get("isCustomMessageSupported"));
            }
            if (testSpec.getConfig().containsKey("readOnly")) {
                config.setReadOnly((Boolean) testSpec.getConfig().get("readOnly"));
            }
            if (testSpec.getConfig().containsKey("writeOnly")) {
                config.setWriteOnly((Boolean) testSpec.getConfig().get("writeOnly"));
            }
        }

        SchemaLocation testCaseFileUri = SchemaLocation.of("classpath:" + toForwardSlashPath(testSpec.getTestCase().getSpecification()));
        JsonSchema schema = validatorFactory.getSchema(testCaseFileUri, testSpec.getTestCase().getSchema(), config);

        return dynamicTest(testSpec.getDescription(), () -> executeAndReset(schema, testSpec));
    }

    private void abortAndReset(String reason) {
        try {
            abort(reason);
        } finally {
            cleanup();
        }
    }

    private void executeAndReset(JsonSchema schema, TestSpec testSpec) {
        try {
            executeTest(schema, testSpec);
        } finally {
            cleanup();
        }
    }

    private List<Path> findTestCases(String basePath) {
        try (Stream<Path> paths = Files.walk(Paths.get(basePath))) {
            return paths
                    .filter(path -> path.toString().endsWith(".json"))
                    .collect(Collectors.toList());
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

}