io.micronaut.http.server.tck.tests.HeadersTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-http-server-tck Show documentation
Natively Cloud Native
There is a newer version: 4.7.9
Show newest version
/*
 * 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.server.tck.tests;

import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.Introspected;
import io.micronaut.http.HttpHeaders;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpStatus;
import io.micronaut.http.MediaType;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Header;
import io.micronaut.http.tck.AssertionUtils;
import io.micronaut.http.tck.HttpResponseAssertion;
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.util.List;
import java.util.Optional;

import static io.micronaut.http.tck.TestScenario.asserts;
import static org.junit.jupiter.api.Assertions.*;

@SuppressWarnings({
    "java:S5960", // We're allowed assertions, as these are used in tests only
    "checkstyle:MissingJavadocType",
    "checkstyle:DesignForExtension"
})
public class HeadersTest {
    public static final String SPEC_NAME = "HeadersTest";

    /**
     * Message header field names are case-insensitive.
     *
     * @see HTTP/1.1 Message Headers
     */
    @Test
    void headersAreCaseInsensitiveAsPerMessageHeadersSpecification() throws IOException {
        // standard header name with mixed case
        asserts(SPEC_NAME,
            HttpRequest.GET("/foo/ok").header("aCcEpT", MediaType.APPLICATION_JSON),
            (server, request) -> AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder()
                .status(HttpStatus.OK)
                .body("{\"status\":\"ok\"}")
                .build()));
        // custom header name with mixed case
        asserts(SPEC_NAME,
            HttpRequest.GET("/foo/bar").header("fOO",  "ok"),
            (server, request) -> AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder()
                .status(HttpStatus.OK)
                .body("{\"status\":\"okok\"}")
                .build()));
        // A different use-case with using @Header(name="..")
        asserts(SPEC_NAME,
            HttpRequest.GET("/foo/bar2").header("fOO",  "ok"),
            (server, request) -> AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder()
                .status(HttpStatus.OK)
                .body("{\"status\":\"okok\"}")
                .build()));
    }

    /**
     * Multiple Headers are properly received as list and not as single header.
     */
    @Test
    void multipleHeadersAreReceivedAsList() throws IOException {
        asserts(SPEC_NAME,
            HttpRequest.GET("/foo/receive-multiple-headers")
                    .header(HttpHeaders.ETAG, "A")
                    .header(HttpHeaders.ETAG, "B"),
            (server, request) -> AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder()
                .status(HttpStatus.OK)
                    .assertResponse(response -> {
                        Optional eTagsOptional = response.getBody(String.class);
                        assertTrue(eTagsOptional.isPresent());
                        String json = eTagsOptional.get();
                        assertTrue(
                            json.equals("{\"headers\":[\"A\",\"B\"]}") ||
                                json.equals("{\"headers\":[\"A,B\"]}")
                        );
                    })
                .build()));
    }

    @Controller("/foo")
    @Requires(property = "spec.name", value = SPEC_NAME)
    static class ProduceController {
        @Get(value = "/ok", produces = MediaType.APPLICATION_JSON)
        String getOkAsJson() {
            return "{\"status\":\"ok\"}";
        }

        @Get(value = "/bar", produces = MediaType.APPLICATION_JSON)
        String getFooAsJson(@Header("Foo") String header1, @Header("fOo") String header2) {
            return "{\"status\":\"" + header1 + header2 + "\"}";
        }

        @Get(value = "/bar2", produces = MediaType.APPLICATION_JSON)
        String getFooAsJson2(@Header(name = "Foo") String header1, @Header(name = "fOo") String header2) {
            return "{\"status\":\"" + header1 + header2 + "\"}";
        }

        @Get(value = "/receive-multiple-headers")
        ETags receiveMultipleHeaders(HttpRequest request) {
            return new ETags(request.getHeaders().getAll(HttpHeaders.ETAG));
        }
    }

    @Introspected
    record ETags(List headers) {
    }
}