flink-docs/src/test/java/org/apache/flink/docs/configuration/ConfigOptionsDocGeneratorTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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 org.apache.flink.docs.configuration;

import org.apache.flink.annotation.docs.ConfigGroup;
import org.apache.flink.annotation.docs.ConfigGroups;
import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ConfigOptions;

import org.junit.Test;

import java.util.HashMap;
import java.util.List;

import static org.junit.Assert.assertEquals;

/**
 * Tests for the {@link ConfigOptionsDocGenerator}.
 */
public class ConfigOptionsDocGeneratorTest {

	static class TestConfigGroup {
		public static ConfigOption<Integer> firstOption = ConfigOptions
			.key("first.option.a")
			.defaultValue(2)
			.withDescription("This is example description for the first option.");

		public static ConfigOption<String> secondOption = ConfigOptions
			.key("second.option.a")
			.noDefaultValue()
			.withDescription("This is long example description for the second option.");
	}

	@Test
	public void testCreatingDescription() {
		final String expectedTable =
			"<table class=\"table table-bordered\">\n" +
			"    <thead>\n" +
			"        <tr>\n" +
			"            <th class=\"text-left\" style=\"width: 20%\">Key</th>\n" +
			"            <th class=\"text-left\" style=\"width: 15%\">Default</th>\n" +
			"            <th class=\"text-left\" style=\"width: 65%\">Description</th>\n" +
			"        </tr>\n" +
			"    </thead>\n" +
			"    <tbody>\n" +
			"        <tr>\n" +
			"            <td><h5>first.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">2</td>\n" +
			"            <td>This is example description for the first option.</td>\n" +
			"        </tr>\n" +
			"        <tr>\n" +
			"            <td><h5>second.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">(none)</td>\n" +
			"            <td>This is long example description for the second option.</td>\n" +
			"        </tr>\n" +
			"    </tbody>\n" +
			"</table>\n";
		final String htmlTable = ConfigOptionsDocGenerator.generateTablesForClass(TestConfigGroup.class).get(0).f1;

		assertEquals(expectedTable, htmlTable);
	}

	@ConfigGroups(groups = {
		@ConfigGroup(name = "firstGroup", keyPrefix = "first"),
		@ConfigGroup(name = "secondGroup", keyPrefix = "second")})
	static class TestConfigMultipleSubGroup {
		public static ConfigOption<Integer> firstOption = ConfigOptions
			.key("first.option.a")
			.defaultValue(2)
			.withDescription("This is example description for the first option.");

		public static ConfigOption<String> secondOption = ConfigOptions
			.key("second.option.a")
			.noDefaultValue()
			.withDescription("This is long example description for the second option.");

		public static ConfigOption<Integer> thirdOption = ConfigOptions
			.key("third.option.a")
			.defaultValue(2)
			.withDescription("This is example description for the third option.");

		public static ConfigOption<String> fourthOption = ConfigOptions
			.key("fourth.option.a")
			.noDefaultValue()
			.withDescription("This is long example description for the fourth option.");
	}

	@Test
	public void testCreatingMultipleGroups() {
		final List<Tuple2<ConfigGroup, String>> tables = ConfigOptionsDocGenerator.generateTablesForClass(
			TestConfigMultipleSubGroup.class);

		assertEquals(tables.size(), 3);
		final HashMap<String, String> tablesConverted = new HashMap<>();
		for (Tuple2<ConfigGroup, String> table : tables) {
			tablesConverted.put(table.f0 != null ? table.f0.name() : "default", table.f1);
		}

		assertEquals(
			"<table class=\"table table-bordered\">\n" +
			"    <thead>\n" +
			"        <tr>\n" +
			"            <th class=\"text-left\" style=\"width: 20%\">Key</th>\n" +
			"            <th class=\"text-left\" style=\"width: 15%\">Default</th>\n" +
			"            <th class=\"text-left\" style=\"width: 65%\">Description</th>\n" +
			"        </tr>\n" +
			"    </thead>\n" +
			"    <tbody>\n" +
			"        <tr>\n" +
			"            <td><h5>first.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">2</td>\n" +
			"            <td>This is example description for the first option.</td>\n" +
			"        </tr>\n" +
			"    </tbody>\n" +
			"</table>\n", tablesConverted.get("firstGroup"));
		assertEquals(
			"<table class=\"table table-bordered\">\n" +
			"    <thead>\n" +
			"        <tr>\n" +
			"            <th class=\"text-left\" style=\"width: 20%\">Key</th>\n" +
			"            <th class=\"text-left\" style=\"width: 15%\">Default</th>\n" +
			"            <th class=\"text-left\" style=\"width: 65%\">Description</th>\n" +
			"        </tr>\n" +
			"    </thead>\n" +
			"    <tbody>\n" +
			"        <tr>\n" +
			"            <td><h5>second.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">(none)</td>\n" +
			"            <td>This is long example description for the second option.</td>\n" +
			"        </tr>\n" +
			"    </tbody>\n" +
			"</table>\n", tablesConverted.get("secondGroup"));
		assertEquals(
			"<table class=\"table table-bordered\">\n" +
			"    <thead>\n" +
			"        <tr>\n" +
			"            <th class=\"text-left\" style=\"width: 20%\">Key</th>\n" +
			"            <th class=\"text-left\" style=\"width: 15%\">Default</th>\n" +
			"            <th class=\"text-left\" style=\"width: 65%\">Description</th>\n" +
			"        </tr>\n" +
			"    </thead>\n" +
			"    <tbody>\n" +
			"        <tr>\n" +
			"            <td><h5>fourth.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">(none)</td>\n" +
			"            <td>This is long example description for the fourth option.</td>\n" +
			"        </tr>\n" +
			"        <tr>\n" +
			"            <td><h5>third.option.a</h5></td>\n" +
			"            <td style=\"word-wrap: break-word;\">2</td>\n" +
			"            <td>This is example description for the third option.</td>\n" +
			"        </tr>\n" +
			"    </tbody>\n" +
			"</table>\n", tablesConverted.get("default"));
	}

	static class TestConfigGroupWithOverriddenDefault {
		@Documentation.OverrideDefault("default_1")
		public static ConfigOption<Integer> firstOption = ConfigOptions
			.key("first.option.a")
			.defaultValue(2)
			.withDescription("This is example description for the first option.");

		@Documentation.OverrideDefault("default_2")
		public static ConfigOption<String> secondOption = ConfigOptions
			.key("second.option.a")
			.noDefaultValue()
			.withDescription("This is long example description for the second option.");
	}

	@Test
	public void testOverrideDefault() {
		final String expectedTable =
			"<table class=\"table table-bordered\">\n" +
				"    <thead>\n" +
				"        <tr>\n" +
				"            <th class=\"text-left\" style=\"width: 20%\">Key</th>\n" +
				"            <th class=\"text-left\" style=\"width: 15%\">Default</th>\n" +
				"            <th class=\"text-left\" style=\"width: 65%\">Description</th>\n" +
				"        </tr>\n" +
				"    </thead>\n" +
				"    <tbody>\n" +
				"        <tr>\n" +
				"            <td><h5>first.option.a</h5></td>\n" +
				"            <td style=\"word-wrap: break-word;\">default_1</td>\n" +
				"            <td>This is example description for the first option.</td>\n" +
				"        </tr>\n" +
				"        <tr>\n" +
				"            <td><h5>second.option.a</h5></td>\n" +
				"            <td style=\"word-wrap: break-word;\">default_2</td>\n" +
				"            <td>This is long example description for the second option.</td>\n" +
				"        </tr>\n" +
				"    </tbody>\n" +
				"</table>\n";
		final String htmlTable = ConfigOptionsDocGenerator.generateTablesForClass(TestConfigGroupWithOverriddenDefault.class).get(0).f1;

		assertEquals(expectedTable, htmlTable);
	}

}