io.micronaut.http.tck.TestScenario Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-http-tck Show documentation
Core components supporting the Micronaut Framework
There is a newer version: 4.7.10
/*
 * Copyright 2017-2023 original authors
 *
 * 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
 *
 * https://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 io.micronaut.http.tck;

import io.micronaut.core.annotation.Experimental;
import io.micronaut.http.HttpRequest;

import java.io.IOException;
import java.util.Map;
import java.util.Objects;
import java.util.function.BiConsumer;

/**
 * Defines a HTTP Server Test Scenario.
 * @author Sergio del Amo
 * @since 3.8.0
 */
@Experimental
public final class TestScenario {

    private final String specName;
    private final Map configuration;

    private final RequestSupplier request;
    private final BiConsumer> assertion;

    private TestScenario(String specName,
                         Map configuration,
                         RequestSupplier request,
                         BiConsumer> assertion) {
        this.specName = specName;
        this.configuration = configuration;
        this.request = request;
        this.assertion = assertion;
    }

    /**
     *
     * @param specName Value for {@literal spec.name} property. Used to avoid bean pollution.
     * @param configuration Test Scenario configuration
     * @param request HTTP Request to be sent in the test scenario
     * @param assertion Assertion for a request and server.
     * @throws IOException Exception thrown while getting the server under test.
     */
    public static void asserts(String specName,
                               Map configuration,
                               HttpRequest request,
                               BiConsumer> assertion) throws IOException {
        TestScenario.builder()
            .specName(specName)
            .configuration(configuration)
            .request(request)
            .assertion(assertion)
            .run();
    }

    /**
     *
     * @param specName Value for {@literal spec.name} property. Used to avoid bean pollution.
     * @param configuration Test Scenario configuration
     * @param request HTTP Request to be sent in the test scenario
     * @param assertion Assertion for a request and server.
     * @throws IOException Exception thrown while getting the server under test.
     */
    public static void asserts(String specName,
                               Map configuration,
                               RequestSupplier request,
                               BiConsumer> assertion) throws IOException {
        TestScenario.builder()
            .specName(specName)
            .configuration(configuration)
            .request(request)
            .assertion(assertion)
            .run();
    }

    /**
     *
     * @param specName Value for {@literal spec.name} property. Used to avoid bean pollution.
     * @param request HTTP Request to be sent in the test scenario
     * @param assertion Assertion for a request and server.
     * @throws IOException Exception thrown while getting the server under test.
     */
    public static void asserts(String specName,
                               HttpRequest request,
                               BiConsumer> assertion) throws IOException {
        TestScenario.builder()
            .specName(specName)
            .request(request)
            .assertion(assertion)
            .run();
    }

    /**
     *
     * @return A Test Scenario builder.
     */
    public static TestScenario.Builder builder() {
        return new Builder();
    }

    private void run() throws IOException {
        try (ServerUnderTest server = ServerUnderTestProviderUtils.getServerUnderTestProvider().getServer(specName, configuration)) {
            if (assertion != null) {
                assertion.accept(server, request.apply(server));
            }
        }
    }

    /**
     * Test Scenario Builder.
     */
    public static class Builder {

        private Map configuration;

        private String specName;

        private BiConsumer> assertion;

        private RequestSupplier request;

        /**
         *
         * @param specName Value for {@literal spec.name} property. Used to avoid bean pollution.
         * @return Test Scenario builder
         */
        public Builder specName(String specName) {
            this.specName = specName;
            return this;
        }

        /**
         *
         * @param request HTTP Request to be sent in the test scenario
         * @return The Test Scenario Builder
         */
        public Builder request(HttpRequest request) {
            this.request = server -> request;
            return this;
        }

        /**
         *
         * @param request HTTP Request supplier that given a server, provides the request to be sent in the test scenario
         * @return The Test Scenario Builder
         */
        public Builder request(RequestSupplier request) {
            this.request = request;
            return this;
        }

        /**
         *
         * @param configuration Test Scenario configuration
         * @return Test scenario builder
         */
        public Builder configuration(Map configuration) {
            this.configuration =  configuration;
            return this;
        }

        /**
         *
         * @param assertion Assertion for a request and server.
         * @return The Test Scenario Builder
         */
        public Builder assertion(BiConsumer> assertion) {
            this.assertion =  assertion;
            return this;
        }

        /**
         *
         * @return Builds a Test scenario
         */
        private TestScenario build() {
            return new TestScenario(specName, configuration,
                Objects.requireNonNull(request),
                Objects.requireNonNull(assertion));
        }

        /**
         * Runs the Test Scneario.
         * @throws IOException Exception thrown while getting the server under test.
         */
        public void run() throws IOException {
            build().run();
        }
    }
}