mirror of
https://github.com/google/nomulus
synced 2026-04-14 13:37:25 +00:00
a02b67caf5
* Migrate the documentation package to Java 11 The old Doclet API is deprected and removed in Java 12. This commit changes the documentation package to use the new recommended API. However it is not a drop-in replacement and there are non-idiomatic usages all over the place. I think it is eaiser to keep the current code logic and kind of shoehorn in the new API than starting afresh as the return on investment of a do-over is not great. Also note that the docs package is disabled as of this commit because we are still using Java 8 to compile which lacks the new API. Once we switch our toolchains to Java 11 (but still compiling Java 8 bytecode) we can re-enable this package. TESTED=ran `./gradlew :docs:test` locally with the documentation package enabled.
55 lines
2.2 KiB
Java
55 lines
2.2 KiB
Java
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
|
//
|
|
// 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 google.registry.documentation;
|
|
|
|
import static com.google.common.truth.Truth.assertWithMessage;
|
|
import static google.registry.util.BuildPathUtils.getProjectRoot;
|
|
import static java.nio.charset.StandardCharsets.UTF_8;
|
|
|
|
import com.google.common.base.Joiner;
|
|
import java.nio.file.Files;
|
|
import java.nio.file.Path;
|
|
import org.junit.jupiter.api.Test;
|
|
|
|
/** Tests to ensure that generated flow documentation matches the expected documentation. */
|
|
class FlowDocumentationTest {
|
|
private static final Path GOLDEN_MARKDOWN_FILEPATH = getProjectRoot().resolve("docs/flows.md");
|
|
|
|
private static final String UPDATE_COMMAND = "./gradlew :docs:flowDocsTool";
|
|
private static final String UPDATE_INSTRUCTIONS =
|
|
Joiner.on('\n')
|
|
.join(
|
|
"",
|
|
"-----------------------------------------------------------------------------------",
|
|
"Your changes affect the flow API documentation output. To update the golden version "
|
|
+ "of the documentation, run:",
|
|
UPDATE_COMMAND,
|
|
"");
|
|
|
|
@Test
|
|
void testGeneratedMatchesGolden() throws Exception {
|
|
// Read the markdown file.
|
|
Path goldenMarkdownPath = GOLDEN_MARKDOWN_FILEPATH;
|
|
|
|
String goldenMarkdown = new String(Files.readAllBytes(goldenMarkdownPath), UTF_8);
|
|
|
|
// Don't use Truth's isEqualTo() because the output is huge and unreadable for large files.
|
|
DocumentationGenerator generator = new DocumentationGenerator();
|
|
if (!generator.generateMarkdown().equals(goldenMarkdown)) {
|
|
assertWithMessage(UPDATE_INSTRUCTIONS).fail();
|
|
}
|
|
}
|
|
}
|