capital.scalable.restdocs.request.PathParametersSnippetTest.java Source code

Introduction

Here is the source code for capital.scalable.restdocs.request.PathParametersSnippetTest.java

Source

/*
 * Copyright 2016 the original author or 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
 *
 *      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 capital.scalable.restdocs.request;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.javadoc.JavadocReader;
import org.junit.Test;
import org.springframework.core.DefaultParameterNameDiscoverer;
import org.springframework.core.MethodParameter;
import org.springframework.restdocs.AbstractSnippetTests;
import org.springframework.restdocs.templates.TemplateFormat;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.method.HandlerMethod;

public class PathParametersSnippetTest extends AbstractSnippetTests {

    public PathParametersSnippetTest(String name, TemplateFormat templateFormat) {
        super(name, templateFormat);
    }

    @Test
    public void simpleRequest() throws Exception {
        HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "addItem", Integer.class, String.class);
        initParameters(handlerMethod);

        JavadocReader javadocReader = mock(JavadocReader.class);
        when(javadocReader.resolveMethodParameterComment(TestResource.class, "addItem", "id"))
                .thenReturn("An integer");
        when(javadocReader.resolveMethodParameterComment(TestResource.class, "addItem", "otherId"))
                .thenReturn("A string");

        ConstraintReader constraintReader = mock(ConstraintReader.class);

        this.snippet.expectPathParameters()
                .withContents(tableWithHeader("Parameter", "Type", "Optional", "Description")
                        .row("id", "Integer", "false", "An integer.").row("subid", "String", "false", "A string."));

        new PathParametersSnippet()
                .document(operationBuilder.attribute(HandlerMethod.class.getName(), handlerMethod)
                        .attribute(JavadocReader.class.getName(), javadocReader)
                        .attribute(ConstraintReader.class.getName(), constraintReader)
                        .request("http://localhost/items/123/subitem/myItem").build());
    }

    @Test
    public void noParameters() throws Exception {
        HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "addItem");

        this.snippet.expectPathParameters().withContents(equalTo("No parameters."));

        new PathParametersSnippet().document(operationBuilder
                .attribute(HandlerMethod.class.getName(), handlerMethod).request("http://localhost/items").build());
    }

    private void initParameters(HandlerMethod handlerMethod) {
        for (MethodParameter parameter : handlerMethod.getMethodParameters()) {
            parameter.initParameterNameDiscovery(new DefaultParameterNameDiscoverer());
        }
    }

    private static class TestResource {

        @RequestMapping(value = "/items/{id}/subitem/{subid}")
        public void addItem(@PathVariable Integer id, @PathVariable("subid") String otherId) {
            // NOOP
        }

        @RequestMapping(value = "/items")
        public void addItem() {
            // NOOP
        }
    }
}