[GR-19220] Add dirty repo status to RUBY_DESCRIPTION, and add jt build --new-hash (#2684)

PullRequest: truffleruby/3427

Author: eregon

src/processor/java/org/truffleruby/processor/BuildInformationProcessor.java

@@ -20,6 +20,7 @@
 import java.security.CodeSource;
 import java.util.Calendar;
 import java.util.HashSet;
+import java.util.Optional;
 import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -46,8 +47,9 @@ public class BuildInformationProcessor extends TruffleRubyProcessor {
     private String buildName;
     private String shortRevision;
     private String fullRevision;
+    private boolean isDirty;
     private String compileDate;
-    private String copyrightYear;
+    private int copyrightYear;
     private String kernelMajorVersion;
 
     @Override
@@ -56,10 +58,13 @@ public synchronized void init(ProcessingEnvironment env) {
         try {
             trufflerubyHome = findHome();
             buildName = System.getenv("TRUFFLERUBY_BUILD_NAME");
-            fullRevision = runCommand("git rev-parse HEAD");
+            fullRevision = runCommand("git rev-parse HEAD")
+                    .orElseThrow(() -> new Error("git rev-parse command failed"));
             shortRevision = fullRevision.substring(0, 8);
-            compileDate = runCommand("git log -1 --date=short --pretty=format:%cd");
-            copyrightYear = compileDate.split("\\-")[0];
+            isDirty = runCommand("git diff --quiet").isEmpty();
+            compileDate = runCommand("git log -1 --date=short --pretty=format:%cd")
+                    .orElseThrow(() -> new Error("git log command failed"));
+            copyrightYear = Integer.parseInt(compileDate.split("\\-")[0]);
             kernelMajorVersion = findKernelMajorVersion();
         } catch (Throwable e) {
             throw new Error(e);
@@ -98,23 +103,32 @@ private File findHome() throws URISyntaxException {
     }
 
     private String findKernelMajorVersion() throws IOException, InterruptedException {
-        final String kernelVersion = runCommand("uname -r");
+        final String kernelVersion = runCommand("uname -r").orElseThrow(() -> new Error("uname -r command failed"));
         return kernelVersion.split(Pattern.quote("."))[0];
     }
 
-    private String runCommand(String command) throws IOException, InterruptedException {
-        final Process git = new ProcessBuilder(command.split("\\s+")).directory(trufflerubyHome).start();
-        final String firstLine;
+    private Optional<String> runCommand(String command) throws IOException, InterruptedException {
+        final Process process = new ProcessBuilder(command.split("\\s+")).directory(trufflerubyHome).start();
+
+        String firstLine;
         try (BufferedReader reader = new BufferedReader(
-                new InputStreamReader(git.getInputStream(), StandardCharsets.UTF_8))) {
+                new InputStreamReader(process.getInputStream(), StandardCharsets.UTF_8))) {
             firstLine = reader.readLine();
+
+            while (process.isAlive()) {
+                reader.readLine();
+            }
+        }
+
+        if (process.waitFor() != 0) {
+            return Optional.empty();
         }
 
-        final int exitCode = git.waitFor();
-        if (exitCode != 0) {
-            throw new Error("Command " + command + " failed with exit code " + exitCode);
+        if (firstLine == null) {
+            firstLine = "";
         }
-        return firstLine;
+
+        return Optional.of(firstLine);
     }
 
     @Override
@@ -174,7 +188,7 @@ private void processBuildInformation(TypeElement element) throws Exception {
                 if (e instanceof ExecutableElement) {
                     final String name = e.getSimpleName().toString();
 
-                    final String value;
+                    final Object value;
                     switch (name) {
                         case "getBuildName":
                             value = buildName;
@@ -185,6 +199,9 @@ private void processBuildInformation(TypeElement element) throws Exception {
                         case "getFullRevision":
                             value = fullRevision;
                             break;
+                        case "isDirty":
+                            value = isDirty;
+                            break;
                         case "getCopyrightYear":
                             value = copyrightYear;
                             break;
@@ -199,11 +216,13 @@ private void processBuildInformation(TypeElement element) throws Exception {
                     }
 
                     stream.println("    @Override");
-                    stream.println("    public String " + name + "() {");
+                    stream.println("    public " + ((ExecutableElement) e).getReturnType() + " " + name + "() {");
                     if (value == null) {
                         stream.println("        return null;");
-                    } else {
+                    } else if (value instanceof String) {
                         stream.println("        return \"" + value + "\";");
+                    } else {
+                        stream.println("        return " + value + ";");
                     }
                     stream.println("    }");
                     stream.println();

src/shared/java/org/truffleruby/shared/BuildInformation.java

@@ -20,7 +20,9 @@ public interface BuildInformation {
 
     String getFullRevision();
 
-    String getCopyrightYear();
+    boolean isDirty();
+
+    int getCopyrightYear();
 
     String getCompileDate();
 

src/shared/java/org/truffleruby/shared/TruffleRuby.java

@@ -34,10 +34,11 @@ public static String getVersionString(String implementationName) {
         }
 
         return String.format(
-                "%s%s %s, like ruby %s, %s %s [%s-%s]",
+                "%s%s %s%s, like ruby %s, %s %s [%s-%s]",
                 ENGINE_ID,
                 nameExtra,
                 getEngineVersion(),
+                BuildInformationImpl.INSTANCE.isDirty() ? "*" : "",
                 LANGUAGE_VERSION,
                 implementationName,
                 ImageInfo.inImageCode() ? "Native" : "JVM",
@@ -49,14 +50,16 @@ public static String getEngineVersion() {
         // The property cannot be read in a static initializer, it's set later
         final String systemVersion = System.getProperty("org.graalvm.version");
 
+        final String revisionString = BuildInformationImpl.INSTANCE.getShortRevision();
+
         // No version information, or just "dev" - use 0.0-commit
         if (systemVersion == null || systemVersion.equals("dev")) {
-            return "0.0-" + BuildInformationImpl.INSTANCE.getShortRevision();
+            return "0.0-" + revisionString;
         }
 
         // A "-dev" version number - append the commit as well
         if (systemVersion.endsWith("-dev")) {
-            return systemVersion + "-" + BuildInformationImpl.INSTANCE.getShortRevision();
+            return systemVersion + "-" + revisionString;
         }
 
         return systemVersion;

tool/jt.rb

@@ -766,6 +766,7 @@ def help
                                               it is also linked in your ruby manager (if found) under the same name,
                                               by default it is the name of the mx env file,
                                               the named build stays until it is rebuilt or deleted manually
+              --new-hash                      update the git commit hash in RUBY_DESCRIPTION
             mx options:                       options passed directly to mx
               -d                              start the Java debugger and enables assertions when running truffleruby to configure C extensions
             mx build options                  options passed to the 'build' command of mx
@@ -2375,6 +2376,12 @@ def bootstrap_toolchain
       remove_shared_compile_artifacts
     end
 
+    if options.delete('--new-hash')
+      build_information_path = "#{TRUFFLERUBY_DIR}/src/shared/java/org/truffleruby/shared/BuildInformation.java"
+      raise unless File.exist?(build_information_path) # in case the file moves in the future
+      FileUtils.touch(build_information_path)
+    end
+
     env = if (i = options.index('--env') || options.index('-e'))
             options.delete_at i
             options.delete_at i