Skip to content

docs(cdc): document EnvUtils deployment contract #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
seonghobae wants to merge 1 commit into from
Closed

docs(cdc): document EnvUtils deployment contract #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions cdc-service/src/test/java/com/xtrmetl/cdc/util/EnvUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,30 @@

import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

class EnvUtilsTest {

@Test
void publicEnvironmentUtilityHasBeginnerReadableJavadocs() throws IOException {
String source = Files.readString(Path.of(
"src/main/java/com/xtrmetl/cdc/util/EnvUtils.java"
));

assertTrue(source.contains("Environment-variable access helpers for CDC deployment configuration."));
assertTrue(source.contains("Returns the configured environment value, or the supplied default when it is missing or blank."));
assertTrue(source.contains("Returns the required environment value and fails when it is missing or blank."));
}

@Test
void getEnvReturnsDefaultWhenMissingOrBlank() {
Map<String, String> env = new HashMap<>();
Expand Down
Loading