Seed-Based Regression Testing Implementation in Java (#303)

* Implement seed storing for Java schema tests . Remember seeds of failing test cases and rerun

* Implement seed storing for Java schema tests . Remember seeds of failing test cases and rerun

* Resolving CoPilot comments

* Update stefc/generator/testdata/seeds/java/README.md

Co-authored-by: Copilot <[email protected]>

* Regenerated the files after reverting the changes with protoc version v5.29.5

* Regenerated the files after reverting the changes with protoc version v5.29.5

* Regenerated the files after reverting the changes with protoc version v5.29.5

---------

Co-authored-by: Abhishek Chatterjee <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

stefc/generator/testdata/seeds/java/README.md

@@ -0,0 +1,15 @@
+This directory stores **random seeds that previously caused failures in Java-generated schema tests** (e.g. `*WriterTest`).
+
+## Why this exists
+
+- When a randomized Java writer/reader test fails, it prints the seed and **appends it** to the appropriate `*_seeds.txt` file in this directory.
+- On subsequent test runs, the seeds in these files are **replayed first** to ensure the bug does not regress.
+
+## File naming convention
+Each file is named:
+`<javaPackage>_<RootStruct>_seeds.txt`
+Example:
+`com.example.gentest.json_like_Record_seeds.txt`
+
+## Important
+- Only add seeds that were found by **Java** failures. Go/other-language seeds are not portable because RNGs differ.

stefc/generator/testdata/seeds/java/com.example.gentest.json_like_Record_seeds.txt

@@ -0,0 +1 @@
+680413050164375

stefc/generator/testdata/seeds/java/com.example.gentest.optional_reset_fail_Struct1_seeds.txt

@@ -0,0 +1,2 @@
+1765233907441407000
+1765234703981295000

stefc/templates/java/writerTest.java.tmpl

@@ -11,6 +11,10 @@ import static org.junit.jupiter.api.Assertions.*;
 
 import java.io.ByteArrayInputStream;
 import java.io.EOFException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -35,8 +39,9 @@ class {{.StructName}}WriterTest {
         return records;
     }
 
-    @Test
-    void test{{.StructName}}WriteRead() throws Exception {
+    boolean test{{.StructName}}WriteReadSeed(long seed) {
+        boolean retVal = true;
+
         List<WriterOptions.Builder> opts = Arrays.asList(
             WriterOptions.builder(),
             WriterOptions.builder().compression(Compression.Zstd),
@@ -61,12 +66,9 @@ class {{.StructName}}WriterTest {
             WriterOptions.builder().frameRestartFlags(FrameFlags.RestartCodecs).maxUncompressedFrameByteSize(500)
         );
 
-        // Choose a seed (non-pseudo) randomly. We will print the seed
-        // on failure for easy reproduction.
-        long seed1 = System.nanoTime();
-        Random random = new Random(seed1);
+        Random random = new Random(seed);
 
-        for (int optIdx=0; optIdx < opts.size(); optIdx++) {
+        for (int optIdx = 0; optIdx < opts.size(); optIdx++) {
             WriterOptions.Builder opt = opts.get(optIdx);
             try {
                 MemChunkWriter buf = new MemChunkWriter();
@@ -85,12 +87,44 @@ class {{.StructName}}WriterTest {
                 {{.StructName}}Reader reader = new {{.StructName}}Reader(new ByteArrayInputStream(buf.getBytes()));
                 for (int i = 0; i < records.size(); i++) {
                     assertEquals(ReadResult.Success, reader.read(ReadOptions.none));
-                    assertTrue(reader.record.equals(records.get(i)), "record " + i + " seed " + seed1 + " optIdx " + optIdx);
+                    assertTrue(reader.record.equals(records.get(i)), "record " + i + " seed " + seed + " optIdx " + optIdx);
                 }
                 assertThrows(EOFException.class, () -> reader.read(ReadOptions.none));
             } catch (Exception e) {
-                fail("seed " + seed1 + " optIdx " + optIdx + ": " + e.getMessage());
+                System.out.printf("Test failed with seed %d optIdx %d: %s%n", seed, optIdx, e.getMessage());
+                e.printStackTrace();
+                retVal = false;
+            }
+        }
+
+        return retVal;
+    }
+
+    @Test
+    void test{{.StructName}}WriteRead() throws Exception {
+        // Seed files are stored in-repo so previously-failing seeds can be replayed to prevent regressions.
+        Path seedFilePath = Paths.get("../stefc/generator/testdata/seeds/java/{{ .PackageName }}_{{.StructName}}_seeds.txt");
+
+        if (Files.exists(seedFilePath)) {
+            for (String line : Files.readAllLines(seedFilePath)) {
+                String s = line.trim();
+                if (s.isEmpty()) continue;
+                long seed = Long.parseLong(s);
+                System.out.printf("Testing with seed from file: %d%n", seed);
+                boolean passed = test{{.StructName}}WriteReadSeed(seed);
+                if (!passed) {
+                    fail("Previously-failing seed " + seed + " still fails");
+                }
             }
         }
+
+        long seed = System.nanoTime();
+        boolean succeeded = test{{.StructName}}WriteReadSeed(seed);
+        if (!succeeded) {
+            System.out.printf("Test failed with seed %d, adding to seed file%n", seed);
+            Files.createDirectories(seedFilePath.getParent());
+            Files.writeString(seedFilePath, seed + "\n", StandardOpenOption.CREATE, StandardOpenOption.APPEND);
+            fail("Test failed with seed " + seed);
+        }
     }
-}
+}