mesa_test 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80dc6d76445d3a3b8e24e4de42bc561471583897452faa29cdf9f6d767c99a1c
-  data.tar.gz: 353ee970f820241963bde503b86a3a5444ae6a793060433938ba122fbcc8d2e2
+  metadata.gz: 539c96d3328d28340abaac30b503be321ee9a79742a0efa3fce3e03889c7762c
+  data.tar.gz: 885b08d2985ecf74db5d5c492d5a47022e75b58986fb5bb1037b9e6d1126e9a3
 SHA512:
-  metadata.gz: 3eacb6b20929997ac9bfea5e555edb219927de877dae78fdd062c28c216ebc894e356e72f336b533a7c4b302cb958116318a784d9a500f7afc35be77ef3cea89
-  data.tar.gz: d7734eede0dde268ec1a97a24bf0ef90a83efea839bf88c615364f4b5034c18d834b1a0273df2899da483d17e1440af568e8b75564dab7d31092af3313262954
+  metadata.gz: 8a6f3271653eb9b93dfa096ae1dfcd226726db72fce4fe5ebfac4acfd860a7a4b5293fedad15cdb85dc8399e7c781477b0290828f123fe42e86d02cbe4f89c0d
+  data.tar.gz: c0796ba4b2b7c0e63f95b7b0e8d8def92da1c9aad7a800da896b6c077d56a317e68c3d5ce73ca0fbbfb28e35f9d81c0013bc0ab85b4fc1b878a62240b0dac240

data/bin/mesa_test

@@ -21,7 +21,7 @@ class MesaTest < Thor
   DEVELOPMENT_URI = 'http://localhost:3000'.freeze
   STAGING_URI = 'https://beta-testhub.herokuapp.com'.freeze
 
-  # Exit status when MesaTestHub has nothing for this computer to do, so a
+  # Exit status when MESATestHub has nothing for this computer to do, so a
   # script can stop instead of re-testing whatever is already in the work
   # directory:  mesa_test install best || exit
   NOTHING_TO_DO_EXIT = 3
@@ -32,7 +32,7 @@ class MesaTest < Thor
 
   # --claim / --no-claim, shared by every command that starts work.
   def self.claim_option
-    option :claim, desc: 'Tell MesaTestHub this computer is working on the ' \
+    option :claim, desc: 'Tell MESATestHub this computer is working on the ' \
                          'commit (and its tests) so it shows as pending, not ' \
                          'untested. Use --no-claim if something else already ' \
                          'claimed it.',
@@ -90,7 +90,7 @@ class MesaTest < Thor
 
     #{MesaTestCase.modules.map { |mod| '    ' + mod.to_s }.join(', ')}
 
-    Each test is claimed on MesaTestHub as it starts, so it shows as pending,
+    Each test is claimed on MESATestHub as it starts, so it shows as pending,
     and its result is submitted as soon as it finishes. This needs an API key
     (see `mesa_test help setup`). --no-submit runs tests locally only:
     nothing is claimed or sent, and no key is needed.
@@ -109,7 +109,7 @@ class MesaTest < Thor
                  type: :boolean, default: true, aliases: '-f'
   option 'force-logs', desc: 'Submit logs for test case(s), even if they pass',
                        type: :boolean, default: false
-  option :submit, desc: 'Submit results (if any) to MesaTestHub.',
+  option :submit, desc: 'Submit results (if any) to MESATestHub.',
                   type: :boolean, default: true
   option :module, desc: 'Which module to test and/or submit, if applicable.',
                   type: :string, default: 'all', aliases: '-m'
@@ -145,16 +145,10 @@ class MesaTest < Thor
                     flags: claim_flags(modes), mesa: m)
           end
 
-          # run test
+          say_step(shell, "Testing #{t.mod}/#{t.test_name}")
           started = Time.now
           t.do_one
-
-          # bail out if not submitting
-          return unless options[:submit]
-
-          # submit results
-          shell.say 'Submitting results to ' + s.base_uri + '... ', :blue
-          submit_result(s, m, t, started)
+          finish_test(s, m, t, started, submit: options[:submit])
         else
           # Each test is claimed as it starts and submitted as it finishes.
           # (`install` reports the build.)
@@ -163,7 +157,6 @@ class MesaTest < Thor
         end
       end
     end
-    shell.say "Done.\n", :green
   end
 
   desc 'submit [TEST CASE]', 'submit a test case or commit'
@@ -175,7 +168,7 @@ class MesaTest < Thor
     that test's result. Without it, the build status plus every test with
     results from this build (or with --empty, just the build status), in one
     request. Results left over from an earlier build are skipped, and
-    MesaTestHub ignores results it already has, so submitting again is safe.
+    MESATestHub ignores results it already has, so submitting again is safe.
     Needs an API key (see `mesa_test help setup`). Modules are
     searched/concatenated in this order:
 
@@ -216,10 +209,7 @@ class MesaTest < Thor
                                        mod: options[:module].downcase.to_sym)
         raise Thor::Error, "#{t.mod}/#{t.test_name} has no results to submit." unless t.ran?
 
-        # submit results
-        shell.say 'Submitting results to ' + s.base_uri + '... ', :blue
         s.submit_instance(m, t, force_logs: options['force-logs'])
-        shell.say "Done.\n", :green
       else
         # The build status plus (unless --empty) every test with results from
         # this build, in one request. MESATestHub stores it as a build row
@@ -228,9 +218,8 @@ class MesaTest < Thor
         begin
           m.check_installation
         rescue MesaDirError
-          shell.say %q{This MESA installation doesn't seem to be compiled } \
-            'properly. Attempting to submit a compilation failure to '\
-            'MESATestHub.', :red
+          shell.say "This build didn't finish compiling, so only the failed build " \
+                    'will be reported.', :yellow
           empty = true
         end
         s.submit_commit(m, empty: empty, force_logs: options['force-logs'])
@@ -243,7 +232,7 @@ class MesaTest < Thor
   Checks out SHA (default: main) into your work directory (mesa_work in
   ~/.mesa_test/config.yml, or --mesadir), using git worktrees off the mirror
   so MESA's history isn't downloaded again. Doesn't build, doesn't contact
-  MesaTestHub, and doesn't touch your own MESA_DIR or environment.
+  MESATestHub, and doesn't touch your own MESA_DIR or environment.
   LONGDESC
 
   option :mesadir, desc: 'Location of mesa dir, if not relying on config data',
@@ -269,7 +258,7 @@ class MesaTest < Thor
   already there and ignores SHA.
 
   The build is claimed and its result (pass or fail, with the build log)
-  reported to MesaTestHub, which needs an API key (see `mesa_test help
+  reported to MESATestHub, which needs an API key (see `mesa_test help
   setup`). A failed build exits with status 1. --no-submit just builds, for
   local work: nothing is claimed or sent, and no key is needed.
 
@@ -277,7 +266,7 @@ class MesaTest < Thor
   the build and recorded in $MESA_DIR/testhub.yml, so later `mesa_test test`
   runs on this build (e.g. cluster array jobs) apply them automatically.
 
-  If SHA is `best`, MesaTestHub picks the commit this computer should build
+  If SHA is `best`, MESATestHub picks the commit this computer should build
   next, and the run modes come from its request instead: the mode flags then
   say what this computer is *willing* to do (overriding `capabilities` in the
   config file). If nothing needs building, mesa_test exits with status
@@ -293,7 +282,7 @@ class MesaTest < Thor
   option :mesadir, desc: 'Location of mesa dir, if not relying on config data',
                    type: :string
   option :submit, desc: 'Report the build (claim it first, then submit its ' \
-                        'status) to MesaTestHub. --no-submit just builds, ' \
+                        'status) to MESATestHub. --no-submit just builds, ' \
                         'e.g. for local testing.',
                   type: :boolean, default: true
   claim_option
@@ -367,7 +356,7 @@ class MesaTest < Thor
   Run modes (--skip-optional, --fpe, --converge) apply to the build and
   every test; unset ones are left to your shell's environment.
 
-  If SHA is `best`, MesaTestHub picks the commit (one this computer hasn't
+  If SHA is `best`, MESATestHub picks the commit (one this computer hasn't
   tested yet) and the run modes (FPE checks, plus full inlists or a
   convergence run if the commit asks for one); everything else is the
   ordinary run above. The mode flags then say what this computer is
@@ -385,7 +374,7 @@ class MesaTest < Thor
   option :force, desc: 'Use ~/.mesa_test/config.yml as it is. --no-force ' \
                        'shows it and asks you to confirm (or fix) it first.',
                  type: :boolean, default: true, aliases: '-f'
-  option :submit, desc: 'Submit results (if any) to MesaTestHub.',
+  option :submit, desc: 'Submit results (if any) to MESATestHub.',
                   type: :boolean, default: true
   option :module, desc: 'Which module to test and/or submit, if applicable.',
                   type: :string, default: 'all', aliases: '-m'
@@ -456,9 +445,9 @@ class MesaTest < Thor
     end
   end
 
-  desc 'request_work', 'ask MesaTestHub what this computer should do next'
+  desc 'request_work', 'ask MESATestHub what this computer should do next'
   long_desc <<-LONGDESC
-  Asks MesaTestHub which commit this computer should build next (or, with
+  Asks MESATestHub which commit this computer should build next (or, with
   --scope=test --sha=SHA, which test to run next on a commit it built) and
   prints the recommendation as JSON on STDOUT, including the run modes to
   use and the reasons it was picked. The mode flags say what this computer
@@ -488,13 +477,13 @@ class MesaTest < Thor
     which is where the other commands look).
 
     mesa_test authenticates with a per-computer API key. To get one, log in
-    to MesaTestHub, open My Computers, open this computer's page (adding the
+    to MESATestHub, open My Computers, open this computer's page (adding the
     computer first if needed; one used only for `search` and `count` is
     fine), and click "Generate key". The key starts with mth_. Paste it when
     the wizard asks, or export MESATESTHUB_API_KEY, which overrides the
     config file (e.g. to keep the key off disk on a cluster).
 
-    The wizard checks the key with MesaTestHub, which also supplies this
+    The wizard checks the key with MESATestHub, which also supplies this
     computer's name. Then it asks which optional test modes the computer is
     willing to run when a commit asks for them (full_inlists, fpe, converge),
     the logs token, and where the MESA mirror and work directory live.
@@ -506,7 +495,7 @@ class MesaTest < Thor
 
   desc 'search "QUERY"', 'retrieve JSON test instances matching QUERY'
   long_desc <<-LONGDESC
-  Sends a GET request to the MesaTestHub search API. QUERY should be
+  Sends a GET request to the MESATestHub search API. QUERY should be
   quoted. Authenticates with your API key; a key for any of your computers
   works, since search is read-only.
 
@@ -542,7 +531,7 @@ class MesaTest < Thor
 
   private
 
-  # `install_and_test best`: MesaTestHub picks the commit, then each test.
+  # `install_and_test best`: MESATestHub picks the commit, then each test.
   def install_and_test_best
     unless options[:submit]
       raise Thor::Error, '`install_and_test best` submits as it goes; ' \
@@ -572,7 +561,7 @@ class MesaTest < Thor
 
     # Report the build on its own; this also fulfills the build claim.
     build_submitted = submit_build(s, m)
-    # MesaTestHub chose the commit and its modes; from here it's an ordinary
+    # MESATestHub chose the commit and its modes; from here it's an ordinary
     # whole-suite run, as `install_and_test SHA` does it: MESA's order,
     # --jobs at a time, each test claimed as it starts and submitted as it
     # finishes.
@@ -626,9 +615,8 @@ class MesaTest < Thor
                 "(#{jobs} in all).", :yellow
     else
       idle = budget - each * jobs
-      note = idle.positive? ? "; #{idle} left idle" : ''
-      shell.say "Up to #{jobs} tests at a time, #{each} thread#{'s' unless each == 1} each " \
-                "(#{source} ÷ #{jobs}#{note}). Use --test-threads to set it yourself.", :blue
+      @thread_note = "#{source} split #{jobs} ways#{"; #{idle} left idle" if idle.positive?}; " \
+                     '--test-threads sets it directly'
     end
     each
   end
@@ -647,11 +635,9 @@ class MesaTest < Thor
   # run's result. Its claim is left to lapse, which tells the hub the work
   # was abandoned. Returns whether a result went through.
   def submit_result(s, m, t, started)
-    unless t.ran_since?(started)
-      shell.say "#{t.mod}/#{t.test_name} wrote no results; nothing submitted.", :red
-      return false
-    end
-    s.submit_instance(m, t, force_logs: options['force-logs'])
+    return false unless t.ran_since?(started)
+
+    s.submit_instance(m, t, force_logs: options['force-logs'], quiet: true)
   end
 
   # Check numeric options before anything is checked out or built, so a
@@ -699,7 +685,13 @@ class MesaTest < Thor
     tests = tests_for(m, mod)
     sha = m.sha
     claiming = submit && options[:claim]
-    shell.say "Running #{tests.size} tests, #{jobs} at a time.", :blue if jobs > 1
+    if jobs > 1
+      threads = test_thread_env['OMP_NUM_THREADS'] || ENV['OMP_NUM_THREADS']
+      say_step(shell, "Testing #{tests.size} tests, #{jobs} at a time" \
+                      "#{", #{threads} thread#{'s' unless threads == '1'} each" if threads}")
+      shell.say "(#{@thread_note})" if @thread_note
+      shell.say "Each test's output goes to each_test_run.log in its directory."
+    end
     lock = Mutex.new
     done = 0
     all_submitted = true
@@ -710,15 +702,17 @@ class MesaTest < Thor
         end
       end
       started = Time.now
-      jobs > 1 ? t.run_isolated : t.do_one
+      if jobs > 1
+        t.run_isolated
+      else
+        say_step(shell, "[#{lock.synchronize { done } + 1}/#{tests.size}] Testing #{t.mod}/#{t.test_name}")
+        t.do_one
+      end
       lock.synchronize do
         done += 1
-        report_test(t, started, "[#{done}/#{tests.size}]")
-        if submit
-          # (not `&&=` on the call: that would skip every later submission)
-          submitted = submit_result(s, m, t, started)
-          all_submitted &&= submitted
-        end
+        # (not `&&=` on the call: that would skip every later submission)
+        submitted = finish_test(s, m, t, started, submit: submit, prefix: "[#{done}/#{tests.size}] ")
+        all_submitted &&= submitted
       end
     end
     if jobs > 1
@@ -729,34 +723,58 @@ class MesaTest < Thor
     all_submitted
   end
 
-  # One progress line for a finished test, from its testhub.yml.
-  def report_test(t, started, prefix)
-    outcome = begin
-      t.ran? ? (t.passed? ? 'pass' : 'FAIL') : 'no result'
+  # Submit a finished test (with +submit+) and print its one progress line:
+  #   [12/107] star/1M_pre_ms_to_wd passed in 41.2 min, submitted
+  # Only the outcome is colored. Returns whether the result went in (true
+  # when not submitting).
+  def finish_test(s, m, t, started, submit:, prefix: '')
+    elapsed = format_duration(Time.now - started)
+    unless t.ran_since?(started)
+      line = "#{prefix}#{t.mod}/#{t.test_name} #{shell.set_color('wrote no results', :red)} " \
+             "after #{elapsed}"
+      shell.say(submit ? "#{line}; nothing submitted" : line)
+      return !submit
+    end
+
+    passed = begin
+      t.passed?
     rescue StandardError
-      'no result'
+      false
+    end
+    outcome = passed ? shell.set_color('passed', :green) : shell.set_color('FAILED', :red)
+    submitted = submit ? submit_result(s, m, t, started) : true
+    suffix = if !submit then ''
+             elsif submitted then ', submitted'
+             else ", #{shell.set_color('not submitted', :red)}"
+             end
+    shell.say "#{prefix}#{t.mod}/#{t.test_name} #{outcome} in #{elapsed}#{suffix}"
+    submitted
+  end
+
+  def format_duration(seconds)
+    if seconds < 90 then format('%d s', seconds.round)
+    elsif seconds < 2 * 3600 then format('%.1f min', seconds / 60.0)
+    else format('%.1f h', seconds / 3600.0)
     end
-    shell.say format('%s %s/%s: %s (%.1f min)', prefix, t.mod, t.test_name, outcome,
-                     (Time.now - started) / 60.0), outcome == 'pass' ? :green : :red
   end
 
 
   # clean + install +m+ with +modes+ in the environment, then record the
   # modes in $MESA_DIR/testhub.yml for later `test`/`submit` runs.
   def build_with_modes(m, modes, raise_on_failure: false)
+    say_step(shell, "Building MESA #{short_sha(m.sha)}" \
+                    "#{" (#{describe_modes(modes)})" unless modes.empty?}")
     with_env(run_mode_env(modes).merge(build_thread_env)) do
       m.clean
       m.install
     end
   rescue MesaDirError
-    shell.say "\nFailed in compiling MESA.", :red
+    shell.say "MESA #{short_sha(m.sha)} failed to build; see #{File.join(m.mesa_dir, 'build.log')}.", :red
     raise if raise_on_failure
   else
+    # Recorded so later `mesa_test test` runs on this build use the same modes.
     m.record_run_modes(modes)
-    shell.say "\nSuccessfully compiled MESA commit #{m.sha}.", :green
-    unless modes.empty?
-      shell.say "Recorded run modes for this build: #{describe_modes(modes)}.", :blue
-    end
+    shell.say "Built MESA #{short_sha(m.sha)}.", :green
   end
 
   # Run modes given explicitly on the command line (unset flags omitted).
@@ -806,8 +824,8 @@ class MesaTest < Thor
     shell_factor = ENV['MESA_TEST_SUITE_RESOLUTION_FACTOR']
     if recorded[:resolution_factor] && !explicit.key?(:resolution_factor) && shell_factor &&
        shell_factor.to_f != recorded[:resolution_factor].to_f
-      warn "This build was set up for resolution factor #{recorded[:resolution_factor]}; " \
-           "using it instead of your MESA_TEST_SUITE_RESOLUTION_FACTOR=#{shell_factor}."
+      warn_yellow "This build was set up for resolution factor #{recorded[:resolution_factor]}; " \
+                  "using it instead of your MESA_TEST_SUITE_RESOLUTION_FACTOR=#{shell_factor}."
     end
     recorded.merge(explicit)
   end
@@ -831,7 +849,7 @@ class MesaTest < Thor
     end.join(', ')
   end
 
-  # Optional modes this computer is willing to run for MesaTestHub: the
+  # Optional modes this computer is willing to run for MESATestHub: the
   # config file's `capabilities`, overridden by any mode flag given.
   def capabilities_for(s)
     caps = s.capabilities.dup
@@ -853,11 +871,12 @@ class MesaTest < Thor
   def dispatch_or_exit(s, scope:, sha: nil, capabilities: capabilities_for(s))
     rec = s.dispatch(scope: scope, sha: sha, capabilities: capabilities)
     if rec.nil?
-      $stderr.puts 'MesaTestHub has nothing more for this computer to ' \
+      $stderr.puts 'MESATestHub has nothing for this computer to ' \
                    "#{scope == 'build' ? 'build' : 'test on this commit'} right now."
     elsif scope == 'build'
-      $stderr.puts "MesaTestHub suggests #{rec['short_sha']} on #{rec['branch']}: " \
-                   "#{Array(rec['reasons']).join('; ')}"
+      # (the hub's first reason is usually "on <branch>", already said)
+      reasons = Array(rec['reasons']) - ["on #{rec['branch']}"]
+      $stderr.puts "MESATestHub picked #{rec['short_sha']} on #{rec['branch']}: #{reasons.join('; ')}"
     end
     rec
   rescue TestHubError => e
@@ -914,7 +933,7 @@ class MesaTest < Thor
     end
   end
 
-  # hub: true for commands that talk to MesaTestHub, which all need an API
+  # hub: true for commands that talk to MESATestHub, which all need an API
   # key; checked first, before any checkout or build.
   def create_submitter(force: true, hub: false)
     s = case MODE

data/lib/mesa_test.rb

@@ -16,6 +16,26 @@ InvalidDataType = Class.new(StandardError)
 GitHubError = Class.new(StandardError)
 TestHubError = Class.new(StandardError)
 
+# Output conventions (CLAUDE.md, "Output"): a bold step heading after one
+# blank line for each phase; green when MESA work succeeded (a build, a
+# passing test, a standalone submission), red when something failed, yellow
+# for a warning (the run continues, but you may want to act), blue only for
+# setup-wizard questions; everything else plain. No color for plumbing.
+def say_step(shell, text)
+  shell.say ''
+  shell.say text, :bold
+end
+
+def short_sha(sha)
+  sha.to_s[0, 7]
+end
+
+# A warning on STDERR (so `request_work`'s JSON stays clean), yellow on a
+# terminal.
+def warn_yellow(text)
+  $stderr.puts($stderr.tty? ? "\e[33m#{text}\e[0m" : text)
+end
+
 GITHUB_HTTPS = 'https://github.com/MESAHub/mesa.git'.freeze
 GITHUB_SSH = 'git@github.com:MESAHub/mesa.git'.freeze
 
@@ -36,9 +56,9 @@ class MesaTestSubmitter
   def setup
     update do |s|
       shell.say <<~INTRO
-        This wizard sets up this computer's profile for MESATestHub. Current
-        values are shown in parentheses; press enter to keep them. You can
-        confirm everything at the end.
+        This wizard sets up this computer's profile for MESATestHub. Each
+        question shows the current value; press enter to keep it. You can
+        review everything at the end.
 
         #{API_KEY_HELP}
         (MESATESTHUB_API_KEY, if set, overrides the key saved here.) The key
@@ -52,37 +72,33 @@ class MesaTestSubmitter
       # Optional run modes this computer can serve when MESATestHub asks for
       # them (see `mesa_test request_work` and `install_and_test best`)
       current = s.capabilities.select { |_, on| on }.keys.join(', ')
-      response = shell.ask 'Which optional test modes can this computer ' \
-        'run when a commit asks for them? Any of: full_inlists, fpe, ' \
-        "converge, separated by commas, or 'none'. " \
-        "(#{current.empty? ? 'none' : current}):", :blue
-      s.capabilities = parse_capabilities(response) unless response.strip.empty?
+      response = question('Which optional test modes can this computer run when a ' \
+                          'commit asks for them? Any of: full_inlists, fpe, converge, ' \
+                          "separated by commas, or 'none'.", current.empty? ? 'none' : current)
+      s.capabilities = parse_capabilities(response) unless response.empty?
 
       # Get API key for submitting failure logs
-      response = shell.ask 'What is your token for uploading failure logs to ' \
-        "the logs server? (if you don't have one, ask a MESA testing " \
-        'maintainer or a representative from Flatiron for a key) ' \
-        "(#{s.logs_token}):", :blue
+      response = question('What is your token for uploading failure logs to the logs ' \
+                          "server? (If you don't have one, ask a MESA testing maintainer " \
+                          'or a representative from Flatiron for a key.)', s.logs_token)
       s.logs_token = response unless response.empty?
 
       # Determine if we'll use ssh or https to access github
-      response = shell.ask 'When accessing GitHub, which protocol do you '\
-        'want to use?', :blue, limited_to: %w[ssh https],
-        default: s.github_protocol.to_s
+      shell.say ''
+      shell.say 'When accessing GitHub, which protocol do you want to use?', :blue
+      response = shell.ask '>', limited_to: %w[ssh https], default: s.github_protocol.to_s
       s.github_protocol = response.strip.downcase.to_sym
 
       # Get location of source MESA repo (the mirror)
-      response = shell.ask "Where is/should your mirrored MESA repository " \
-      "located? This is where a mirror will be stored from which test " \
-      "repos will be generated. You won't touch this in regular operation. " \
-      "(#{s.mesa_mirror}):", :blue
+      response = question('Where is/should your mirrored MESA repository be? This is ' \
+                          'where a mirror will be stored from which test repos will be ' \
+                          "generated. You won't touch this in regular operation.", s.mesa_mirror)
       s.mesa_mirror = response unless response.empty?
 
       # Get location of source MESA work (where testing happens)
-      response = shell.ask "Where is/should your working directory for "\
-      "testing be located? This is where testing actually occurs, but all "\
-      "files it uses are cached in the mirror repo to save time later. " \
-      "(#{s.mesa_work}):", :blue
+      response = question('Where is/should your working directory for testing be? This ' \
+                          'is where testing actually occurs, but all files it uses are ' \
+                          'cached in the mirror repo to save time later.', s.mesa_work)
       s.mesa_work = response unless response.empty?
     end
 
@@ -90,11 +106,23 @@ class MesaTestSubmitter
     if confirm_computer_data
       save_computer_data
     else
-      shell.say "Restarting wizard.\n"
+      shell.say 'Starting over.'
       setup
     end
   end
 
+  # Ask one wizard question; returns the stripped answer, '' to keep
+  # +current+. The question goes out through `say`, which the terminal
+  # wraps normally; the prompt that Readline draws stays a short, plain
+  # "> ". Readline counts color codes as visible characters, so a long or
+  # colored prompt garbles at the terminal's edge (the start of the line
+  # repeats before it wraps).
+  def question(text, current = nil)
+    shell.say ''
+    shell.say(current.to_s.empty? ? text : "#{text} (current: #{current})", :blue)
+    shell.ask('>').to_s.strip
+  end
+
   # Ask for the API key until MESATestHub accepts one, and take the computer
   # name from it, since a key belongs to exactly one computer. If the hub
   # can't be reached, keep the key and ask for the name instead.
@@ -104,9 +132,9 @@ class MesaTestSubmitter
         shell.say "Using the API key in MESATESTHUB_API_KEY (#{s.masked_api_key}). " \
                   'Unset it to enter one here.', :yellow
       else
-        response = shell.ask 'What is the MESATestHub API key for this ' \
-          "computer? (#{s.masked_api_key || 'none'}):", :blue
-        s.api_key = response.strip unless response.strip.empty?
+        response = question('What is the MESATestHub API key for this computer?',
+                            s.masked_api_key || 'none')
+        s.api_key = response unless response.empty?
         next shell.say('An API key is required.', :red) unless s.api_key
       end
 
@@ -117,8 +145,7 @@ class MesaTestSubmitter
         return
       elsif check['reachable'] == false
         shell.say 'Saving the key unverified.', :yellow
-        response = shell.ask 'What is the name of this computer on ' \
-          "MESATestHub? (#{s.computer_name}):", :blue
+        response = question('What is the name of this computer on MESATestHub?', s.computer_name)
         s.computer_name = response unless response.empty?
         return
       end
@@ -235,21 +262,20 @@ class MesaTestSubmitter
   end
 
   def confirm_computer_data
-    puts "This computer's mesa_test settings:"
-    puts '-------------------------------------------------------'
-    puts "Computer Name           #{computer_name}"
-    puts "API key                 #{masked_api_key || 'none'}"
-    puts "Optional test modes     #{capabilities.select { |_, on| on }.keys.join(', ').then { |c| c.empty? ? 'none' : c }}"
-    puts "logs API token          #{logs_token}"
-    puts "GitHub Protocol         #{github_protocol}"
-    puts "MESA Mirror Location    #{mesa_mirror}"
-    puts "MESA Work Location      #{mesa_work}"
-    puts "OS (detected each run)  #{platform_version}"
-    # puts "Config location         #{config_file}"
-    puts '-------------------------------------------------------'
-    puts ''
-    response = shell.ask 'Is this correct? (y/Y = Yes, anything else = No):'
-    response.strip.casecmp('y').zero?
+    modes = capabilities.select { |_, on| on }.keys.join(', ')
+    say_step(shell, "This computer's settings")
+    [['Computer', computer_name],
+     ['API key', masked_api_key || 'none'],
+     ['Optional test modes', modes.empty? ? 'none' : modes],
+     ['Logs token', logs_token.to_s.empty? ? 'none' : logs_token],
+     ['GitHub protocol', github_protocol],
+     ['MESA mirror', mesa_mirror],
+     ['Work directory', mesa_work],
+     ['OS (detected)', platform_version]].each do |label, value|
+      shell.say format('  %-20s %s', label, value)
+    end
+    shell.say ''
+    shell.ask('Save these settings? [y/N]').to_s.strip.casecmp('y').zero?
   end
 
   def save_computer_data
@@ -397,8 +423,8 @@ class MesaTestSubmitter
                 'build (left over from an earlier one).', :yellow
     end
     unless unread.empty?
-      shell.say 'The following test cases could NOT be read for submission:', :red
-      unread.each { |test_case| shell.say "- #{test_case.test_name}", :red }
+      shell.say "Couldn't read the results of #{unread.map(&:test_name).join(', ')}; " \
+                'not submitting them.', :red
     end
     tests
   end
@@ -525,39 +551,39 @@ class MesaTestSubmitter
       # network failure; testhub_request already explained why
       false
     elsif !response.is_a? Net::HTTPCreated
-      shell.say "\nFailed to submit some or all test case instances and/or "\
-                "commit data (server responded #{response.code} "\
-                "#{response.message}).", :red
+      shell.say "MESATestHub refused the results for #{short_sha(mesa.sha)} " \
+                "(HTTP #{response.code}: #{error_message(response)}).", :red
       false
     else
-      shell.say "\nSuccessfully submitted commit #{mesa.sha}.", :green
-      # commit submitted to testhub, now submit build log if compilation failed
-      # and exit
+      if !mesa.installed?
+        shell.say "Reported the failed build of #{short_sha(mesa.sha)} to MESATestHub."
+      elsif empty || tests.empty?
+        shell.say "Reported the build of #{short_sha(mesa.sha)} to MESATestHub."
+      else
+        shell.say "Submitted the build and #{tests.size} test result#{'s' unless tests.size == 1} " \
+                  "for #{short_sha(mesa.sha)}.", :green
+      end
+      # Upload the build log if compilation failed. A logs-server problem is
+      # only a warning: the results are already in.
       unless mesa.installed?
-        return submit_build_log(mesa)
+        submit_build_log(mesa)
+        return true
       end
 
-      # compilation succeded, so submit any logs for failing tests
-      res = true
       # logs for the failing tests just submitted (or all, with force_logs)
       tests.each do |test_case|
-        if !test_case.passed? || force_logs
-          # (not `res &&= submit_test_log(...)`: after one failed upload that
-          # would skip every remaining test's logs)
-          sent = submit_test_log(test_case, skip_passing: !force_logs)
-          res &&= sent
-        end
+        submit_test_log(test_case, skip_passing: !force_logs) if !test_case.passed? || force_logs
       end
-
-      # a true return value means that any and all log submission were
-      # successful
-      res
+      true
     end
   end
 
   # submit results for a single test case instance. Does *not* report overall
-  # compilation status to testhub. Use an empty commit submission for that
-  def submit_instance(mesa, test_case, force_logs: false)
+  # compilation status to testhub. Use an empty commit submission for that.
+  # +quiet+ leaves the success line to the caller (a test run's progress
+  # line says "submitted"). Returns whether the result went in; a log
+  # upload problem is only a warning.
+  def submit_instance(mesa, test_case, force_logs: false, quiet: false)
     unless mesa.install_attempted?
       raise MesaDirError, 'No testhub.yml file found in installation; '\
                           'must attempt to install before subitting.'
@@ -587,17 +613,13 @@ class MesaTestSubmitter
       # network failure; testhub_request already explained why
       return false
     elsif !response.is_a? Net::HTTPCreated
-      shell.say "\nFailed to submit #{test_case.test_name} for commit "\
-                "#{mesa.sha} (server responded #{response.code} "\
-                "#{response.message}).", :red
+      shell.say "MESATestHub refused #{test_case.mod}/#{test_case.test_name} " \
+                "(HTTP #{response.code}: #{error_message(response)}).", :red
       return false
     else
-      shell.say "\nSuccessfully submitted instance of #{test_case.test_name} "\
-                "for commit #{mesa.sha}.", :green
+      shell.say "Submitted #{test_case.mod}/#{test_case.test_name}.", :green unless quiet
       # submit logs if test failed
-      if !test_case.passed? || force_logs
-        return submit_test_log(test_case, skip_passing: !force_logs)
-      end
+      submit_test_log(test_case, skip_passing: !force_logs) if !test_case.passed? || force_logs
       true
     end
   end
@@ -613,8 +635,7 @@ class MesaTestSubmitter
     https.read_timeout = 60
     https.request(request)
   rescue StandardError => e
-    shell.say "\nCould not reach the test hub at #{https.address} "\
-              "(#{e.class}: #{e.message}).", :red
+    shell.say "Could not reach MESATestHub at #{https.address} (#{e.class}: #{e.message}).", :red
     nil
   end
 
@@ -641,9 +662,8 @@ class MesaTestSubmitter
     begin
       https.request(req)
     rescue StandardError => e
-      shell.say "\nCould not reach the LOGS server at #{uri.host} "\
-                "(#{e.class}: #{e.message}). Skipping log upload; this does "\
-                'not affect test results already sent to the test hub.', :yellow
+      shell.say "Could not reach the logs server at #{uri.host} (#{e.class}: #{e.message}); " \
+                'skipping the log upload. The results themselves are in.', :yellow
       nil
     end
   end
@@ -653,12 +673,7 @@ class MesaTestSubmitter
     # intercept and don't send if mesa was properly installed
     return true if mesa.installed?
 
-    # don't even try unless we have a logs token set
-    unless logs_token
-      shell.say 'Cannot submit to logs server; need to set mesa_logs_token '\
-                'in the mesa_test config file.'
-      return false
-    end
+    return false unless logs_token?
 
     # do submission
     res = submit_logs(build_log_params(mesa))
@@ -668,13 +683,10 @@ class MesaTestSubmitter
       # network failure; submit_logs already explained why. Don't fail the run.
       false
     elsif !res.is_a? Net::HTTPOK
-      shell.say "\nFailed to submit build.log to the LOGS server for commit "\
-                "#{mesa.sha} (server responded #{res.code} #{res.message}).",
-                :red
+      shell.say "The logs server refused the build log (HTTP #{res.code} #{res.message}).", :yellow
       false
     else
-      shell.say "\nSuccessfully submitted build.log to the LOGS server for "\
-                "#{mesa.sha}.", :green
+      shell.say 'Uploaded the build log to the logs server.'
       true
     end
   end
@@ -687,13 +699,8 @@ class MesaTestSubmitter
       return true
     end
 
-    # don't even try unless we have a logs token set
-    unless logs_token
-      shell.say 'Cannot submit to logs server; need to set mesa_logs_token '\
-                'in the mesa_test config file..'
-      return false
-    end
-  
+    return false unless logs_token?
+
     # do submission
     res = submit_logs(test_log_params(test_case))
 
@@ -702,18 +709,27 @@ class MesaTestSubmitter
       # network failure; submit_logs already explained why. Don't fail the run.
       false
     elsif !res.is_a? Net::HTTPOK
-      shell.say "Failed to submit logs for test case #{test_case.test_name} "\
-                "in commit #{test_case.mesa.sha} (server responded "\
-                "#{res.code} #{res.message}).", :red
+      shell.say "The logs server refused the logs for #{test_case.test_name} " \
+                "(HTTP #{res.code} #{res.message}).", :yellow
       false
     else
-      shell.say "Successfully submitted logs for test case "\
-                "#{test_case.test_name} in commit #{test_case.mesa.sha}.",
-                :green
+      shell.say "Uploaded the logs for #{test_case.test_name} to the logs server."
       true
     end
   end
 
+  # Whether failure logs can be uploaded; says why not once per run.
+  def logs_token?
+    return true if logs_token && !logs_token.to_s.empty?
+
+    unless @warned_no_logs_token
+      shell.say 'No logs token is set, so failure logs are not being uploaded ' \
+                '(add one with `mesa_test setup`).', :yellow
+      @warned_no_logs_token = true
+    end
+    false
+  end
+
   # GET a search query from the testhub. The query rides in the URL's
   # query_text parameter; the API key in the Authorization header.
   # Returns the raw Net::HTTP response.
@@ -876,35 +892,29 @@ class Mesa
   end
 
   def checkout(new_sha: 'HEAD')
+    # A branch name is worth showing; a SHA is shown with its subject below.
+    say_step(shell, new_sha =~ /\A\h{40}\z/ ? 'Checking out MESA' : "Checking out #{new_sha}")
     # before anything confirm that git-lfs has been installed
-    shell.say "\nEnsuring that git-lfs is installed... ", :blue
     command = 'git lfs help >> /dev/null 2>&1'
-    if bash_execute(command)
-      shell.say "yes", :green
-    else
-      shell.say "no", :red
-      raise(GitHubError, "The command #{command} returned with an error "\
-                         'status, indicating that git-lfs is not installed. '\
-                         'Make sure it is installed and try again.')
+    unless bash_execute(command)
+      raise(GitHubError, 'git-lfs is not installed (`git lfs help` failed); ' \
+                         'MESA needs it. Install it and try again.')
     end
 
     # set up mirror if it doesn't exist
     unless dir_or_symlink_exists?(mirror_dir)
-      shell.say "\nCreating initial mirror at #{mirror_dir}. "\
-                'This might take awhile...', :blue
+      shell.say "Creating a mirror of MESA in #{mirror_dir} (first time only; " \
+                'this can take a while).'
       FileUtils.mkdir_p mirror_dir
       case github_protocol
       when :ssh
         command = "git clone --mirror #{GITHUB_SSH} #{mirror_dir}"
-        shell.say command
         # fail loudly if this doesn't work
         unless bash_execute(command)
           # nuke the mirror directory since it is probably bogus (make this
           # code fire off the next time checkout is done)
-          shell.say "Failed. Removing the [potentially corrupted] mirror.", :red
-          command = "rm -rf #{mirror_dir}"
-          shell.say command
-          bash_execute(command)
+          shell.say 'Cloning failed; removing the partial mirror.', :red
+          bash_execute("rm -rf #{mirror_dir}")
 
           raise(GitHubError, 'Error while executing the following command:'\
                              "#{command}. Perhaps you haven't set up "\
@@ -912,15 +922,12 @@ class Mesa
         end
       when :https
         command = "git clone --mirror #{GITHUB_HTTPS} #{mirror_dir}"
-        shell.say command
         # fail loudly if this doesn't work
         unless bash_execute(command)
           # nuke the mirror directory since it is probably bogus (make this
           # code fire off the next time checkout is done)
-          shell.say "Failed. Removing the [potentially corrupted] mirror.", :red
-          command = "rm -rf #{mirror_dir}"
-          shell.say command
-          bash_execute(command)
+          shell.say 'Cloning failed; removing the partial mirror.', :red
+          bash_execute("rm -rf #{mirror_dir}")
 
           raise(GitHubError, 'Error while executing the following command: '\
                              "#{command}. Perhaps you need to configure "\
@@ -938,20 +945,19 @@ class Mesa
     update_mirror
 
     # create "work" directory with proper commit
-    shell.say "\nSetting up worktree repo...", :blue
     FileUtils.mkdir_p mesa_dir
-    command = "git -C #{mirror_dir} worktree add #{mesa_dir} #{new_sha}"
-    shell.say command
-    return if bash_execute(command)
+    command = "git -C #{mirror_dir} worktree add --quiet #{mesa_dir} #{new_sha}"
+    if bash_execute(command)
+      shell.say "#{bashticks("git -C #{mesa_dir} log -1 --format='%h %s'")} (in #{mesa_dir})"
+      return
+    end
 
     raise(GitHubError, 'Failed while executing the following command: '\
                        "\"#{command}\".")
   end
 
   def update_mirror
-    shell.say "\nFetching MESA history...", :blue
-    command = "git -C #{mirror_dir} fetch origin --prune"
-    shell.say command
+    command = "git -C #{mirror_dir} fetch origin --prune --quiet"
     # fail loudly
     return if bash_execute(command)
 
@@ -961,15 +967,11 @@ class Mesa
 
   def remove
     return unless File.exist? mesa_dir
-    shell.say "\nRemoving work directory from worktree (clearing old data)...",
-              :blue
     command = "git -C #{mirror_dir} worktree remove --force #{mesa_dir}"
-    shell.say command
     return if bash_execute(command)
 
-    shell.say "Failed. Simply trying to remove the directory.", :red
+    # Not a worktree of this mirror (or git refused): just delete it.
     command = "rm -rf #{mesa_dir}"
-    shell.say command
     # fail loudly (the "true" tells bash_execute to raise an exception if
     # the command fails)
     bash_execute(command, true)
@@ -987,8 +989,6 @@ class Mesa
     with_mesa_dir do
       visit_and_check mesa_dir, MesaDirError, 'E\countered a problem in ' \
                                 "running `clean` in #{mesa_dir}." do
-        shell.say('MESA_DIR = ' + ENV['MESA_DIR'])
-        shell.say './clean'
         bash_execute('./clean')
       end
     end
@@ -999,8 +999,6 @@ class Mesa
     with_mesa_dir do
       visit_and_check mesa_dir, MesaDirError, 'Encountered a problem in ' \
                                 "running `install` in #{mesa_dir}." do
-        shell.say('MESA_DIR = ' + ENV['MESA_DIR'])
-        shell.say './install'
         bash_execute('./install')
       end
     end
@@ -1114,7 +1112,7 @@ class Mesa
       @names_to_numbers[mod] = {}
       @test_case_names[mod] = []
       @test_cases[mod] = {}
-      visit_dir(test_suite_dir(mod: mod), quiet: true) do
+      visit_dir(test_suite_dir(mod: mod)) do
         bashticks('./list_tests').split("\n").each do |line|
           num, tc_name = line.strip.split
           @names_to_numbers[mod][tc_name.strip] = num.to_i
@@ -1127,7 +1125,7 @@ class Mesa
               mesa: self
             )
           rescue TestCaseDirError
-            shell.say "No such test case #{tc_name.strip}. Skipping loading it.", :red
+            shell.say "do1_test_source lists #{tc_name.strip}, but it has no directory; skipping it.", :yellow
           end
         end
       end
@@ -1196,15 +1194,13 @@ class Mesa
     # change MESA_DIR, holding on to old value
     orig_mesa_dir = ENV['MESA_DIR']
     ENV['MESA_DIR'] = mesa_dir
-    shell.say "Temporarily changed MESA_DIR to #{ENV['MESA_DIR']}.", :blue
-  
+
     # do the stuff
     begin
       yield
     # make sure we undo MESA_DIR change
     ensure
       ENV['MESA_DIR'] = orig_mesa_dir
-      shell.say "Changed MESA_DIR back to #{ENV['MESA_DIR']}.", :blue
     end
   end
 
@@ -1380,7 +1376,6 @@ class MesaTestCase
   # just punt to +each_test_run+ in the test_suite directory. It's your problem
   # now, sucker!
   def do_one
-    shell.say("Testing #{test_name}", :yellow)
     visit_dir(test_suite_dir) do
       bash_execute("./each_test_run #{position}")
     end
@@ -1478,12 +1473,8 @@ end
 # exception if the block failed (returned false or nil)
 def visit_and_check(new_dir, exception, message)
   cwd = Dir.getwd
-  shell.say "Leaving  #{cwd}", :blue
-  shell.say "\nEntering #{new_dir}.", :blue
   Dir.chdir(new_dir)
   success = yield if block_given?
-  shell.say "Leaving  #{new_dir}", :blue
-  shell.say "\nEntering #{cwd}.", :blue
   Dir.chdir(cwd)
   return if success
   raise exception, message
@@ -1491,19 +1482,15 @@ end
 
 # cd into a new directory, execute a block, then cd back into original
 # directory
-def visit_dir(new_dir, quiet: false)
+def visit_dir(new_dir)
   cwd = Dir.getwd
-  shell.say "Leaving  #{cwd}\n", :blue unless quiet
-  shell.say "\nEntering #{new_dir}.", :blue unless quiet
   Dir.chdir(new_dir)
   yield if block_given?
-  shell.say "Leaving  #{new_dir}\n", :blue unless quiet
-  shell.say "\nRe-entering #{cwd}.", :blue unless quiet
   Dir.chdir(cwd)
 end
 
 # the next function probalby doesn't belong here, but keep it anyway, please
-# create seed data for test cases for MesaTestHub of a given mesa version
+# create seed data for test cases for MESATestHub of a given mesa version
 def generate_seeds_rb(mesa_dir, outfile)
   m = Mesa.new(mesa_dir: mesa_dir)
   m.load_test_source_data
@@ -1602,8 +1589,8 @@ def dispatch_run_modes(rec, preferred: nil, preferred_source: nil)
     if requested
       factor = requested.to_s
       if preferred && preferred.to_f != requested.to_f
-        warn "MESATestHub asked for resolution factor #{factor} ([ci converge #{factor}]); " \
-             "using it instead of your #{preferred_source}=#{preferred}."
+        warn_yellow "MESATestHub asked for resolution factor #{factor} ([ci converge #{factor}]); " \
+                    "using it instead of your #{preferred_source}=#{preferred}."
       end
       modes[:resolution_factor] = factor
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mesa_test
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - William Wolf
@@ -78,9 +78,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.17
 signing_key: