Add and update tests; run tests in CI

plume-lib · Jan 30, 2025 · b8917f0 · b8917f0
1 parent af85032
commit b8917f0
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 4 deletions.
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -27,3 +27,5 @@ jobs:
       run: ./gradlew requireJavadoc
     - name: ./gradlew spotlessCheck
       run: ./gradlew spotlessCheck
+    - name: run-tests.sh
+      run: src/test/run-tests.sh
diff --git a/src/test/expected.txt b/src/test/expected.txt
@@ -1,4 +1,3 @@
-JavaRecords.java:5:5: missing documentation for second
 JavaRecords.java:9:1: missing documentation for MyOtherRecord
 JavaRecords.java:15:1: missing documentation for Undocumented
 NoArgConstructor.java:8:3: missing documentation for HasArgConstructor
@@ -52,3 +51,4 @@ TrivialProperties.java:355:3: missing documentation for get
 TrivialProperties.java:359:3: missing documentation for set
 TrivialProperties.java:363:3: missing documentation for has
 TrivialProperties.java:367:3: missing documentation for is
+package-info.java:2:1: missing documentation for a.b.c
diff --git a/src/test/module-info.java b/src/test/module-info.java
@@ -0,0 +1,2 @@
+/** There is a Javadoc comment here. */
+package a.b.c;
diff --git a/src/test/package-info.java b/src/test/package-info.java
@@ -0,0 +1,2 @@
+// There is no Javadoc comment here.
+package a.b.c;
diff --git a/src/test/README → src/test/run-tests.sh b/src/test/README → src/test/run-tests.sh
@@ -1,7 +1,9 @@
-Tests are not yet automated. :-(
+#!/bin/sh
 
-The diff output should be empty:
+SCRIPTDIR="$(cd "$(dirname "$0")" && pwd -P)"
+
+cd ${SCRIPTDIR}
 
 (cd ../.. && ./gradlew assemble) && sleep .1 && java -cp ../../build/libs/require-javadoc-1.0.9-all.jar org.plumelib.javadoc.RequireJavadoc --relative --dont-require-trivial-properties --dont-require-noarg-constructor > out.txt 
 
-diff expected.txt out.txt
+diff -u expected.txt out.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		/** There is a Javadoc comment here. */
		package a.b.c;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// There is no Javadoc comment here.
		package a.b.c;