fix: Fix handling of generated files for Comparable verification

* Added messages to test protobufs that fail in CI
* Adjusted getJavaFile to check existence and provide clearer error messages if a required file is missing
* Moved a few strings to constants in Common.java
* Removed a few unnecessary `toString` calls
* Fixed wildcard static import in Field.java
---
Additional minor adjustments
* Updated the Java language version to 21.
* Updated github CI config to use Java 21
* Moved the folder for the protobuf grammar file (Protobuf3.g4) to correct a package mismatch

Signed-off-by: Joseph Sinclair <[email protected]>

.github/workflows/zxc-compile-pbj-code.yaml

@@ -26,7 +26,7 @@ on:
         description: "Java JDK Version:"
         type: string
         required: false
-        default: "17.0.9"
+        default: "21.0.2"
       gradle-version:
         description: "Gradle Version:"
         type: string

.gitignore

@@ -669,3 +669,9 @@ Temporary Items
 
 ### Generated Protobuf Files
 /tests/src/main/proto/
+
+### IntelliJ workarounds
+.github/.github.iml
+github-setup
+
+

pbj-core/buildSrc/src/main/kotlin/com.hedera.pbj.conventions.gradle.kts

@@ -32,10 +32,10 @@ plugins {
 group = "com.hedera.pbj"
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
     toolchain {
-        languageVersion.set(JavaLanguageVersion.of(17))
+        languageVersion.set(JavaLanguageVersion.of(21))
         vendor.set(JvmVendorSpec.ADOPTIUM)
     }
 

pbj-core/pbj-compiler/src/main/java/com/hedera/pbj/compiler/impl/Common.java

@@ -20,11 +20,6 @@
 public final class Common {
 	/** The indent for fields, default 4 spaces */
 	public static final String FIELD_INDENT = " ".repeat(4);
-
-	public static final int DEFAULT_INDENT = 4;
-	/** Number of bits used to represent the tag type */
-	static final int TAG_TYPE_BITS = 3;
-
 	/** Wire format code for var int */
 	public static final int TYPE_VARINT = 0;
 	/** Wire format code for fixed 64bit number */
@@ -33,8 +28,20 @@ public final class Common {
 	public static final int TYPE_LENGTH_DELIMITED = 2;
 	/** Wire format code for fixed 32bit number */
 	public static final int TYPE_FIXED32 = 5;
+	public static final int DEFAULT_INDENT = 4;
+
+	/** Number of bits used to represent the tag type */
+	static final int TAG_TYPE_BITS = 3;
+
     private static final Pattern COMPARABLE_PATTERN = Pattern.compile("[)] implements Comparable<\\w+> [{]");
+    private static final String FIELD_NOT_IMPLEMENT_COMPARABLE_MESSAGE =
+            "Field %s.%s specified in `pbj.comparable` option must implement `Comparable` interface but it doesn't.";
+    private static final String JAVA_FILE_PATH_FORM = "%1$s%2$c%1$s".formatted("%s", File.separatorChar);
+    private static final String JAVA_FILE_MISSING_MESSAGE =
+            "Unable to read Java file %1$s for class %2$s in package %3$s under source root %4$s.";
+    private static final String ESCAPED_FILE_SEPARATOR = "\\" + File.pathSeparator;
 
+    private Common() {}
 
     /**
 	 * Makes a tag value given a field number and wire type.
@@ -257,7 +264,7 @@ public static String getFieldsHashCode(final List<Field> fields, String generate
                              }
                              """).replace("$fieldName", f.nameCamelFirstLower());
                 } else {
-                    throw new RuntimeException("Unexpected field type for getting HashCode - " + f.type().toString());
+                    throw new RuntimeException("Unexpected field type for getting HashCode - " + f.type());
                 }
             }
 		}
@@ -422,7 +429,7 @@ else if (f.repeated()) {
                             }
                             """).replace("$fieldName", f.nameCamelFirstLower());
                 } else {
-                    throw new IllegalArgumentException("Unexpected field type for getting Equals - " + f.type().toString());
+                    throw new IllegalArgumentException("Unexpected field type for getting Equals - " + f.type());
                 }
             }
 		}
@@ -449,7 +456,6 @@ private static String getPrimitiveWrapperEqualsGeneration(String generatedCodeSo
                 }
                 """).replace("$fieldName", f.nameCamelFirstLower());
 			case "BoolValue" ->
-
 				generatedCodeSoFar += (
                 """
                 if (this.$fieldName == null && thatObj.$fieldName != null) {
@@ -481,7 +487,6 @@ private static String getPrimitiveWrapperEqualsGeneration(String generatedCodeSo
                 """).replace("$fieldName", f.nameCamelFirstLower());
 			default -> throw new UnsupportedOperationException("Unhandled optional message type:" + f.messageType());
 		}
-		;
 		return generatedCodeSoFar;
 	}
 
@@ -593,7 +598,7 @@ public static String getFieldsCompareToStatements(final List<Field> fields, Stri
 					verifyComparable(f, destinationSrcDir);
 					generatedCodeSoFar += generateCompareToForObject(f);
 				} else {
-					throw new IllegalArgumentException("Unexpected field type for getting CompareTo - " + f.type().toString());
+					throw new IllegalArgumentException("Unexpected field type for getting CompareTo - " + f.type());
 				}
 			}
 		}
@@ -626,24 +631,27 @@ private static String generateCompareToForObject(Field f) {
 	private static void verifyComparable(final Field field, File destinationSrcDir) {
 		if (field instanceof final SingleField singleField) {
 			if (singleField.type() != Field.FieldType.MESSAGE) {
-				// everything else except message and bytes is comparable for sure
+				// everything except message and repeated is comparable for sure
 				return;
 			}
 			// let's check if the message implements Comparable
 			final String className = singleField.javaFieldType();
-			final File javaFile = getJavaFile(destinationSrcDir, singleField.messageTypeModelPackage(), className);
-			try (BufferedReader reader = new BufferedReader(new FileReader(javaFile))) {
-				String line;
-				while ((line = reader.readLine()) != null) {
-					if (COMPARABLE_PATTERN.matcher(line).matches()) {
-						return;
-					}
-				}
-				throw new IllegalArgumentException(("Field %s.%s specified in `pbj.comparable` option must implement " +
-						"`Comparable` interface but it doesn't.").formatted(className, field.nameCamelFirstLower()));
-			} catch (IOException e) {
-				throw new RuntimeException(e);
-			}
+            try {
+                final File javaFile =
+                        getJavaFile(destinationSrcDir, singleField.messageTypeModelPackage(), className, true);
+                try (BufferedReader reader = new BufferedReader(new FileReader(javaFile))) {
+                    String line;
+                    while ((line = reader.readLine()) != null) {
+                        if (COMPARABLE_PATTERN.matcher(line).matches()) {
+                            return;
+                        }
+                    }
+                    throw new IllegalArgumentException(
+                            FIELD_NOT_IMPLEMENT_COMPARABLE_MESSAGE.formatted(className, field.nameCamelFirstLower()));
+                }
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
         } if (field instanceof final OneOfField oneOfField) {
 			oneOfField.fields().forEach(v -> verifyComparable(v, destinationSrcDir));
 		} else {
@@ -696,25 +704,51 @@ private static String getPrimitiveWrapperCompareToGeneration(Field f) {
 	 * @return  text without a leading dot
 	 */
 	public static String removingLeadingDot(String text) {
-		if (!text.isEmpty() & text.charAt(0) == '.') {
+		if (!text.isEmpty() && text.charAt(0) == '.') {
 			return text.substring(1);
 		}
 		return text;
 	}
 
-	/**
+    /**
 	 * Get the java file for a src directory, package and classname with optional suffix. All parent directories will
 	 * also be created.
 	 *
-	 * @param srcDir The src dir root of all java src
+	 * @param sourceFolder The source folder root of all generated java sources
 	 * @param javaPackage the java package with '.' deliminators
-	 * @param className the camel case class name
+	 * @param className the proper camel case class name
 	 * @return File object for java file
+     * @throws IOException if the source folder is invalid.
+	 */
+	public static File getJavaFile(final File sourceFolder, final String javaPackage, final String className)
+            throws IOException {
+        return getJavaFile(sourceFolder, javaPackage, className, false);
+    }
+
+    /**
+	 * Get the java file for a src directory, package and classname with optional suffix. All parent directories will
+	 * also be created.
+	 *
+	 * @param sourceFolder The source folder root of all generated java sources
+	 * @param javaPackage the java package with '.' deliminators
+	 * @param className the proper camel case class name
+	 * @param mustExist if true, then the file to return must already exist.
+     * @return File object for java file
+     * @throws IOException if the source folder is invalid,
+     *     or the java file requested does not exist and mustExist is true.
 	 */
-	public static File getJavaFile(File srcDir, String javaPackage, String className) {
-		File packagePath = new File(srcDir.getPath() + File.separatorChar + javaPackage.replaceAll("\\.","\\" + File.separator));
-		//noinspection ResultOfMethodCallIgnored
-		packagePath.mkdirs();
-		return new File(packagePath,className+".java");
+	public static File getJavaFile(final File sourceFolder, final String javaPackage, final String className,
+            final boolean mustExist) throws IOException {
+        final String sourcePath = sourceFolder.getCanonicalPath();
+		final File packagePath =
+                new File(JAVA_FILE_PATH_FORM.formatted(sourcePath, javaPackage.replaceAll("\\.", ESCAPED_FILE_SEPARATOR)));
+        if (!packagePath.exists()) packagePath.mkdirs();
+        final File javaFile = new File(packagePath, className + ".java");
+        if (mustExist && (!javaFile.exists() || !javaFile.canRead())) {
+            final String message =
+                    JAVA_FILE_MISSING_MESSAGE.formatted(javaFile.getCanonicalPath(), className, javaPackage, sourcePath);
+            throw new IOException(message);
+        }
+		return javaFile;
 	}
 }

pbj-core/pbj-compiler/src/main/java/com/hedera/pbj/compiler/impl/Field.java

@@ -1,12 +1,16 @@
 package com.hedera.pbj.compiler.impl;
 
+import static com.hedera.pbj.compiler.impl.Common.TYPE_FIXED32;
+import static com.hedera.pbj.compiler.impl.Common.TYPE_FIXED64;
+import static com.hedera.pbj.compiler.impl.Common.TYPE_LENGTH_DELIMITED;
+import static com.hedera.pbj.compiler.impl.Common.TYPE_VARINT;
+import static com.hedera.pbj.compiler.impl.Common.snakeToCamel;
+
 import com.hedera.pbj.compiler.impl.grammar.Protobuf3Parser;
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 import java.util.Set;
 
-import static com.hedera.pbj.compiler.impl.Common.*;
-
 /**
  * Interface for SingleFields and OneOfFields
  */

pbj-integration-tests/src/main/proto/comparable.proto

@@ -113,5 +113,28 @@ message LimitedComparableTestWithOneOf {
     string oneOfText = 10;
     ComparableSubObj oneOfSubObject = 12;
   }
+}
 
+/**
+ * Help to encounter the error found in issue #180 by providing an enum with a name
+ * that has unusual "almost" camel case. The odd case of "ENum" is deliberate here.
+ */
+enum OddCaseENum {
+  UP = 0;
+  DOWN = 1;
+  CHARM = 2;
+  STRANGE = 3;
+  TOP = 4;
+  BOTTOM = 5;
+}
+
+/**
+ * This exercises the error found in issue #180 by including fields of the
+ * problematic message types.
+ */
+// <<<pbj.comparable = "test_comparable_value, test_enum_value, simple_stringValue" >>>
+message ComparableContainsWrongCase {
+  ComparableWrongCaseID test_comparable_value = 1;
+  OddCaseENum test_enum_value = 2;
+  string simple_stringValue = 3;
 }

pbj-integration-tests/src/main/proto/everything.proto

@@ -183,4 +183,15 @@ message InnerEverything {
     google.protobuf.BytesValue bytesBoxedOneOf = 100025;
     google.protobuf.StringValue stringBoxedOneOf = 100026;
   }
-}
+}
+
+/**
+ * Example of a message which is named <strong>almost</strong> like a Java class, but not quite.
+ * This helps test the error originally found in issue #180.
+ * Placed here to ensure comparable works across imported files.
+ */
+// <<<pbj.comparable = "subMessageCMP, sub_message_two" >>>
+message ComparableWrongCaseID {
+  TimestampTest subMessageCMP = 1;
+  Suit sub_message_two = 2;
+}

pbj-integration-tests/src/main/proto/timestampTest.proto

@@ -5,12 +5,12 @@ package proto;
 /** Test issue 87 */
 /** Test issue 87 */
 
-/*-
- * ‌
+/*
+ *
  * Hedera Network Services Protobuf
- * ​
+ *
  * Copyright (C) 2018 - 2021 Hedera Hashgraph, LLC
- * ​
+ *
  * 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
@@ -22,7 +22,7 @@ package proto;
  * 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.
- * ‍
+ *
  */
 
 option java_package = "com.hedera.pbj.test.proto.java";
@@ -32,7 +32,9 @@ option java_multiple_files = true;
 /**
  * An exact date and time. This is the same data structure as the protobuf Timestamp.proto (see the
  * comments in https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto)
+ * We add comparable here to expand testing of that feature
  */
+// <<<pbj.comparable = "seconds,nanos" >>>
 message TimestampTest {
     /**
      * Number of complete seconds since the start of the epoch
@@ -54,4 +56,3 @@ message TimestampTestSeconds {
      */
     int64 seconds = 1;
 }
-