[GR-25597] Forbid desynchronized repositories unless a flag / environment variable is supplied.

PullRequest: truffleruby/1930

Author: eregon

doc/contributor/workflow.md

@@ -91,17 +91,22 @@ TruffleRuby needs the `truffle` and `sulong` suites from the `graal` repository.
 When running `jt build`, you might see an early warning:
 ```
 $ jt build
-$ mx --env jvm scheckimports --ignore-uncommitted --warn-only
-WARNING: imported version of sulong in truffleruby (89aaf87268) does not match parent (aa6d8e07a6)
-You might want to run "mx sforceimports" to use the imported version or update the import with "mx scheckimports"
+...
+NOTE: Set env variable JT_IMPORTS_DONT_ASK to always answer 'no' to this prompt.
+
+WARNING: imported version of sulong in truffleruby (ae65c10142907329e03ad8e3fa17b88aca42058d) does not match parent (1bf42ddef0e4961cbb92ebc31019747fd1c15f1a)
+Do you want to checkout the supported version of graal as specified in truffleruby's suite.py? (runs `mx sforceimports`) [y/n]
+...
 ```
 
 This warning is important.
-If you did not create new commits  in `graal`, you will typically need to run `jt mx sforceimports`
-so that a known compatible commit of `graal` is used (that commit is recorded in `mx.truffleruby/suite.py`).
 
-This is not done automatically, because sometimes you might want to have changes in `graal`,
-and because developers of the Truffle or Sulong team typically want to use a different commit of `graal` to test their changes.
+- If you did not create new commits in `graal`, this means the graal import was bumped in `suite.py` and you need
+  to answer `y` to this prompt, which will be equivalent to running `jt mx sforceimports` before proceeding.
+- If you did create new `graal` commits, you should answer `n` or set `JT_IMPORTS_DONT_ASK` (to any value) to
+  automatically do so.
+- If you want to set the `suite.py` import to that checked out in `graal` (unlikely), you should run 
+  jt mx scheckimports` beforehand.
 
 ### Building C Extensions more quickly
 

tool/jt.rb

@@ -101,6 +101,9 @@
 # Forward signals to sub-processes, so they get notified when sending a signal to jt
 [:SIGINT, :SIGTERM].each do |signal|
   trap(signal) do
+    # Enables command line signals (e.g. Ctrl+C) when waiting for input if there are no subprocesses.
+    raise Interrupt if SUBPROCESSES.empty?
+
     SUBPROCESSES.each do |pid|
       Utilities.send_signal(signal, pid)
     end
@@ -577,14 +580,38 @@ def args_split(args)
     return [args, []] unless delimiter_index
     [args[0...delimiter_index], args[(delimiter_index + 1)..-1]]
   end
+
+  def with_color(color_code, &block)
+    print color_code if STDOUT.tty?
+    begin
+      result = yield block
+    ensure
+      print TERM_COLOR_DEFAULT if STDOUT.tty?
+    end
+    result
+  end
+
+  def boxed(&block)
+    puts ''
+    puts '============================================================'
+    puts ''
+    result = yield block
+    puts ''
+    puts '============================================================'
+    puts ''
+    result
+  end
+
+  # https://misc.flogisoft.com/bash/tip_colors_and_formatting
+  TERM_COLOR_RED = "\e[31m"
+  TERM_COLOR_DEFAULT = "\e[39m"
 end
 
 module Commands
   include Utilities
 
   def help
-    # <<~ cannot be used since idea thinks TR is 2.1 and displays it as error
-    puts <<-TXT.gsub(/^ {6}/, '')
+    puts <<~TXT
       Usage: jt [options] COMMAND [command-options]
           Where options are:
           --build                   Runs `jt build` before the command
@@ -609,7 +636,7 @@ def help
                                               GraalVM with JVM and Truffleruby only available in mxbuild/truffleruby-jvm,
                                               the Ruby is symlinked into rbenv or chruby if available
             options:
-              --sforceimports                 run sforceimports before building (default: false)
+              --sforceimports                 run `mx sforceimports` before building (default: false)
               --env|-e                        mx env file used to build the GraalVM, default is "jvm"
               --name|-n NAME                  specify the name of the build "mxbuild/truffleruby-NAME",
                                               it is also linked in your ruby manager (if found) under the same name,
@@ -1196,18 +1223,18 @@ def retag(*args)
           expected_file = "#{dir}/expected.txt"
           expected = File.read(expected_file)
           unless actual == expected
-            abort <<-EOS
-C extension #{dir} didn't work as expected
+            abort <<~EOS
+              C extension #{dir} didn't work as expected
 
-Actual:
-#{actual}
+              Actual:
+              #{actual}
 
-Expected:
-#{expected}
+              Expected:
+              #{expected}
 
-Diff:
-#{diff(expected_file, output_file)}
-EOS
+              Diff:
+              #{diff(expected_file, output_file)}
+            EOS
           end
         ensure
           File.delete output_file if File.exist? output_file
@@ -1978,6 +2005,41 @@ def bootstrap_toolchain
     destination
   end
 
+  private def sforceimports? (mx_base_args)
+    scheckimports_output = mx(*mx_base_args, 'scheckimports', '--ignore-uncommitted', '--warn-only', capture: :both)
+
+    unless scheckimports_output.empty?
+      # Don't ask to update, just warn.
+      if ENV['JT_IMPORTS_DONT_ASK'] || !STDIN.tty?
+        with_color(TERM_COLOR_RED) do
+          boxed do
+            puts scheckimports_output
+            puts <<~MESSAGE
+              You might want to:
+              * use the version of graal in suite.py, then use "jt build --sforceimports", useful when building TruffleRuby and not changing graal at the same time (most common)
+              * update the graal version in suite.py, then use "mx scheckimports", useful when explicitly updating the default graal version of TruffleRuby (rare)
+              * test TruffleRuby with a different graal version with your own changes in graal, then you can ignore this warning
+            MESSAGE
+          end
+        end
+        false
+      else
+        # Ask to update imports.
+        with_color(TERM_COLOR_RED) do
+          puts "\nNOTE: Set env variable JT_IMPORTS_DONT_ASK to always answer 'no' to this prompt.\n\n"
+          puts scheckimports_output
+          input = ''
+          until %w(y n).include? input
+            print 'Do you want to checkout the supported version of graal as specified in truffleruby\'s suite.py? (runs `mx sforceimports`) [y/n] '
+            input = STDIN.gets.chomp
+          end
+          puts ''
+          input == 'y'
+        end
+      end
+    end
+  end
+
   private def build_graalvm(*options)
     raise 'use --env jvm-ce instead' if options.delete('--graal')
     raise 'use --env native instead' if options.delete('--native')
@@ -2003,19 +2065,17 @@ def bootstrap_toolchain
                  end
 
     name = "truffleruby-#{@ruby_name}"
+    mx_base_args = ['-p', TRUFFLERUBY_DIR, '--env', env]
 
+    # Must clone enterprise before running `mx scheckimports` in `sforceimports?`
     cloned = env.include?('ee') && clone_enterprise
+    checkout_enterprise_revision(env) if cloned
 
-    if options.delete('--sforceimports')
+    if options.delete('--sforceimports') || sforceimports?(mx_base_args)
       mx('-p', TRUFFLERUBY_DIR, 'sforceimports')
-      checkout_enterprise_revision(env) if env.include?('ee')
-    else
-      checkout_enterprise_revision(env) if cloned
+      checkout_enterprise_revision(env) if env.include?('ee') && !cloned
     end
 
-    mx_base_args = ['-p', TRUFFLERUBY_DIR, '--env', env]
-    mx(*mx_base_args, 'scheckimports', '--ignore-uncommitted', '--warn-only')
-
     mx_options, mx_build_options = args_split(options)
     mx_args = mx_base_args + mx_options