DongHyeonkaandClaude Opus 5
b2963105a8
The keycloak project ended with four open questions that design could not
settle. A two-VM lab was built to answer them by measurement, and this is
that material: 26 experiments, 125 raw command outputs, 22 browser captures.
Follows the import procedure in README.md.
source/ the originating repository verbatim — 78 documents, 28 SVGs,
8 manifests, plus .source-revision recording the commit
final/ the SSOT
document.md 729 lines written from the 29 experiment documents, not
concatenated: what was predicted, what was measured, and
where the measurement itself was wrong
evidence/raw 125 outputs, flattened to <experiment>__<file> because
the originals collided (01-baseline.txt appeared three
times) and the audit only globs the top level
evidence/meta one per raw file; command and exitCode are null and the
README says why rather than inventing them
evidence/browser 22 captures
assets/ three diagrams through techviz
.techviz/ their VizSpecs
A separate project rather than an addition to keycloak: the B-layer answers
that project's four questions, but the A, C and D layers are about cluster
failure, SSO and operations, and one document.md should hold one subject.
The four question records there can point here through 관계.
Recorded rather than papered over: only three of the 28 diagrams were
remade. The repository forbids hand-drawn SVG and forbids titles inside the
canvas; all 28 originals carry both, so converting them is redrawing, not
reformatting. They stay in source/ and the gap is written into the document.
verify-pipeline.py passes. audit-records.py reports no issues.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
64 lines
2.8 KiB
Plaintext
64 lines
2.8 KiB
Plaintext
# evidence 261 — messaging-documentation-contract-test-coverage
|
|
# revision: a24ece9cf797f7ea647e33bf846b115208ed1ba5
|
|
# cwd: /shared/codebase/clean-architecture-backend-template/src/messaging
|
|
# command: grep -n "void " messaging-testkit/src/test/java/dev/caskeleton/messaging/testkit/MessagingDocumentationContractTest.java; echo; echo ---class javadoc---; sed -n "1,25p" messaging-testkit/src/test/java/dev/caskeleton/messaging/testkit/MessagingDocumentationContractTest.java; echo; echo ---the two weakest assertions---; sed -n "113,133p" messaging-testkit/src/test/java/dev/caskeleton/messaging/testkit/MessagingDocumentationContractTest.java
|
|
# ---- raw output ----
|
|
43: void everyDocumentTheSupportMatrixPromisesExists() {
|
|
61: void theSupportMatrixNamesExactlyTheAdaptersTheCodeCallsStable() {
|
|
70: void theSupportMatrixDoesNotCallAnExperimentalAdapterStable() {
|
|
83: void theDocumentedKafkaVersionsMatchWhatTheCodeCertifies() {
|
|
92: void theUnsupportedListStillNamesTheTwoConstantsThatDoNotExist() {
|
|
102: void noEnumConstantTheDocsDenyActuallyExists() {
|
|
115: void theExperimentalPolicyStatesThatExperimentalIsOffByDefault() {
|
|
120: void everyDocumentHasContent() {
|
|
|
|
---class javadoc---
|
|
package dev.caskeleton.messaging.testkit;
|
|
|
|
import static org.assertj.core.api.Assertions.assertThat;
|
|
|
|
import java.io.IOException;
|
|
import java.nio.file.Files;
|
|
import java.nio.file.Path;
|
|
import java.util.List;
|
|
import org.junit.jupiter.api.Test;
|
|
|
|
/**
|
|
* Checks that the shipped documentation still describes the code.
|
|
*
|
|
* <p>Docs rot silently. A support matrix claiming an adapter is Stable outlives the day someone
|
|
* demoted it, and nothing fails — the tests still pass, the build is green, and the only signal is
|
|
* an operator making a decision on a page that stopped being true months ago.
|
|
*
|
|
* <p>The assertions are deliberately narrow: they check the claims a reader would act on, not
|
|
* prose. Asserting on wording would make every edit a test failure and the check would be deleted.
|
|
*/
|
|
class MessagingDocumentationContractTest {
|
|
|
|
private static Path docsRoot() {
|
|
Path candidate = Path.of("").toAbsolutePath();
|
|
while (candidate != null && !Files.isDirectory(candidate.resolve("docs/messaging"))) {
|
|
|
|
---the two weakest assertions---
|
|
|
|
@Test
|
|
void theExperimentalPolicyStatesThatExperimentalIsOffByDefault() {
|
|
assertThat(read("experimental-policy.md")).contains("false");
|
|
}
|
|
|
|
@Test
|
|
void everyDocumentHasContent() {
|
|
assertThat(
|
|
List.of(
|
|
"support-matrix.md",
|
|
"delivery-guarantees.md",
|
|
"retry-dlq-redrive.md",
|
|
"outbox-inbox.md",
|
|
"security.md",
|
|
"operations.md",
|
|
"configuration-reference.md",
|
|
"experimental-policy.md",
|
|
"migration-guide.md"))
|
|
.allSatisfy(name -> assertThat(read(name).length()).isGreaterThan(500));
|
|
}
|