GrpcDocStringExtractorTest.java

/*
 * Copyright 2017 LINE Corporation
 *
 * LINE Corporation licenses this file to you 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.linecorp.armeria.server.grpc;

import static org.assertj.core.api.Assertions.assertThat;

import java.util.Map;

import org.junit.Test;

public class GrpcDocStringExtractorTest {

    private static final Map<String, String> DOCSTRINGS = new GrpcDocStringExtractor().getAllDocStrings(
            GrpcDocStringExtractorTest.class.getClassLoader());

    @Test
    public void service() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.TestService",
                " A simple service to test the various types of RPCs and experiment with\n" +
                " performance with various types of payload.\n");
    }

    @Test
    public void method() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.TestService/UnaryCall",
                " One request followed by one response.\n");
    }

    @Test
    public void message() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest",
                " Unary request.\n");
    }

    @Test
    public void field() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest/response_type",
                " Desired payload type in the response from the server.\n" +
                " If response_type is RANDOM, server randomly chooses one from other formats.\n");
    }

    @Test
    public void nestedMessage() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest.NestedRequest",
                " A request nested in another request.\n");
    }

    @Test
    public void nestedMessageField() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest.NestedRequest/nested_payload",
                " The payload for a nested request.\n");
    }

    @Test
    public void enumType() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.CompressionType",
                " Compression algorithms\n");
    }

    @Test
    public void enumValue() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.CompressionType/NONE",
                " No compression\n");
    }

    @Test
    public void nestedEnumType() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest.NestedEnum",
                " An enum nested in a request.\n");
    }

    @Test
    public void nestedEnumValue() {
        assertThat(DOCSTRINGS).containsEntry(
                "armeria.grpc.testing.SimpleRequest.NestedEnum/OK",
                " We're ok.\n");
    }

}