fun_ci 2.1.1-aarch64-linux → 2.3.0-aarch64-linux

data/lib/fun_ci/setup/lfs_hook.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "hook_script"
+
+module FunCi
+  module Setup
+    # git-lfs's own post-commit and pre-push hooks, as `git lfs install`
+    # writes them, and the hook fun-ci writes in their place, which runs
+    # fun-ci's, then git-lfs's. A push reads its ref list from git once, so
+    # the pre-push hook keeps it in a file and gives it to both.
+    module LfsHook
+      GUARD = %r{\Acommand -v git-lfs >/dev/null 2>&1 \|\| \{.*; exit 2; \}\z}
+      MISSING = %(command -v git-lfs >/dev/null 2>&1 || { echo "This repository is configured for Git LFS ) +
+                %(but 'git-lfs' was not found on your path." >&2; exit 2; })
+
+      RUN = {
+        "post-commit" => "if #{HookScript::INSTALLED}; then fun_ci; else #{HookScript::NOT_INSTALLED}; fi\n",
+        "pre-push" => %(if #{HookScript::INSTALLED}; then fun_ci < "$refs" || exit 1; ) +
+                      "else #{HookScript::NOT_INSTALLED}; fi\n"
+      }.freeze
+
+      KEEP_REFS = { "post-commit" => "", "pre-push" => <<~SH }.freeze
+        refs=$(mktemp) || exit 1
+        trap 'rm -f "$refs"' EXIT
+        cat > "$refs"
+      SH
+
+      FUN_CI = { "post-commit" => HookScript::POST_COMMIT, "pre-push" => "#{HookScript::PRE_PUSH_WAITS}return $status\n" }
+               .freeze
+      LFS_INPUT = { "post-commit" => "", "pre-push" => %( < "$refs") }.freeze
+
+      # Whether `script` is the hook `git lfs install` writes for `hook_type`
+      # and nothing more.
+      def self.stock?(script, hook_type)
+        lines = script.lines(chomp: true).reject { |line| line.strip.empty? }
+        lines.size == 3 && lines.first == "#!/bin/sh" && GUARD.match?(lines[1]) && lines.last == call(hook_type)
+      end
+
+      def self.runs_lfs?(script, hook_type) = script.include?(call(hook_type))
+
+      def self.script(hook_type)
+        "#!/bin/sh\n#{HookScript::MARKER}\n# fun-ci's #{hook_type} hook, then git-lfs's, which it replaced.\n" \
+          "#{KEEP_REFS.fetch(hook_type)}fun_ci() {\n#{FUN_CI.fetch(hook_type)}}\n" \
+          "#{RUN.fetch(hook_type)}#{MISSING}\n#{call(hook_type)}#{LFS_INPUT.fetch(hook_type)}\n"
+      end
+
+      def self.call(hook_type) = %(git lfs #{hook_type} "$@")
+    end
+  end
+end

data/lib/fun_ci/setup/project_config.rb

@@ -4,6 +4,7 @@ require "shellwords"
 require_relative "settings"
 require_relative "../evidence/settings"
 require_relative "../evidence/start"
+require_relative "../jobs/folders"
 
 module FunCi
   module Setup
@@ -19,12 +20,17 @@ module FunCi
         Dir.exist?(@fun_ci_dir)
       end
 
+      # What stops a pipeline: no .fun-ci/, or a stage script it can't run.
       def validate
         return ["No .fun-ci/ folder found in #{@project_root}"] unless folder_exists?
 
-        REQUIRED_SCRIPTS.flat_map { |script| script_errors(script) } + settings.errors
+        REQUIRED_SCRIPTS.flat_map { |script| script_errors(script) }
       end
 
+      # Mistakes in .fun-ci/config, which never stop a pipeline: the setting
+      # takes its default instead.
+      def settings_errors = settings.errors
+
       # Mistakes in the `evidence` key, which `fun-ci check` reports but which
       # never stop a pipeline: the entry with the mistake is left out instead.
       def evidence_errors = Evidence::Settings.load(File.join(@fun_ci_dir, "config")).errors(root: @project_root)
@@ -37,9 +43,15 @@ module FunCi
       # may hold, such as JSON logs.
       def any_project_presets = preset_candidates.reject(&:because).map { |found| found.preset.name }
 
+      # The daily and weekly jobs that can run, and why any other can't
+      # (design.md, Daily and weekly jobs); neither stops a pipeline.
+      def jobs = Jobs::Folders.new(@project_root).jobs
+      def job_errors = Jobs::Folders.new(@project_root).errors
+
       def worktree_slots = settings.worktree_slots
       def trunk = settings.trunk
       def trunk_fetch = settings.trunk_fetch
+      def job_spacing = settings.job_spacing
 
       def script_path(stage)
         File.join(@fun_ci_dir, "#{stage}.sh")

data/lib/fun_ci/setup/settings.rb

@@ -6,7 +6,8 @@ module FunCi
   module Setup
     # .fun-ci/config: settings for this machine's runs, as YAML. Each one left
     # out takes its default; one that is wrong is reported and the default used,
-    # as are all of them when the file isn't YAML.
+    # as are all of them when the file can't be read as YAML. Anchors and
+    # aliases are YAML, so they are read.
     class Settings
       DEFAULTS = { "worktree_slots" => 2 }.freeze
       FETCH_EVERY = 300
@@ -20,7 +21,7 @@ module FunCi
         @text = text
       end
 
-      def worktree_slots = errors.empty? ? values.fetch("worktree_slots") : DEFAULTS.fetch("worktree_slots")
+      def worktree_slots = slots || DEFAULTS.fetch("worktree_slots")
 
       # The trunk's name, or nil when none is given or it is no name. A mistake
       # in the trunk settings never stops a pipeline, so none is among `errors`.
@@ -37,22 +38,51 @@ module FunCi
         seconds(given) || FETCH_EVERY
       end
 
-      def errors
-        return [".fun-ci/config must be a mapping such as `worktree_slots: 2`"] unless raw.is_a?(Hash)
+      # Seconds between the starts of the jobs a commit starts, 0 for all at
+      # once (Jobs::Schedule); nil when none is given, or none it can read,
+      # and the jobs share the day evenly (Jobs::DueJobs).
+      def job_spacing = seconds(setting("job_spacing"))
 
-        slots = values["worktree_slots"]
-        return [] if slots.is_a?(Integer) && slots.positive?
-
-        [".fun-ci/config: worktree_slots must be a whole number above 0, not #{slots.inspect}"]
+      def errors
+        setting_errors
       rescue Psych::SyntaxError => e
         [".fun-ci/config is not YAML: #{e.problem} (line #{e.line})"]
+      rescue Psych::DisallowedClass => e
+        [".fun-ci/config can't be read: #{e.message} (quote a value such as a date to read it as text)"]
+      rescue Psych::Exception => e
+        [".fun-ci/config can't be read: #{e.message}"]
       end
 
       private
 
+      def setting_errors
+        return [".fun-ci/config must be a mapping such as `worktree_slots: 2`"] unless raw.is_a?(Hash)
+
+        [slots_error, spacing_error].compact
+      end
+
+      # The slots the file asks for, when that is a whole number above 0.
+      def slots
+        given = setting("worktree_slots")
+        given if given.is_a?(Integer) && given.positive?
+      end
+
+      def slots_error
+        given = setting("worktree_slots")
+        ".fun-ci/config: worktree_slots must be a whole number above 0, not #{given.inspect}" unless given.nil? || slots
+      end
+
+      # Unlike the trunk's, since taking turns is the jobs' whole point (AT-13.28).
+      def spacing_error
+        given = setting("job_spacing")
+        return nil if given.nil? || seconds(given)
+
+        ".fun-ci/config: job_spacing must be seconds, or a number with s, m or h, not #{given.inspect}"
+      end
+
       def setting(key)
         raw.is_a?(Hash) ? raw[key] : nil
-      rescue Psych::SyntaxError
+      rescue Psych::Exception
         nil
       end
 
@@ -61,8 +91,7 @@ module FunCi
         match && (match[1].to_i * UNITS.fetch(match[2]))
       end
 
-      def raw = (@text && YAML.safe_load(@text)) || {}
-      def values = DEFAULTS.merge(raw)
+      def raw = (@text && YAML.safe_load(@text, aliases: true)) || {}
     end
   end
 end

data/lib/fun_ci/setup/setup_checker.rb

@@ -2,13 +2,22 @@
 
 require_relative "project_config"
 require_relative "legacy_hooks"
+require_relative "installed_hooks"
 require_relative "trunk_report"
 
 module FunCi
   module Setup
     class SetupChecker
-      def self.run(project_root:, stdout: $stdout)
-        new(config: ProjectConfig.new(project_root), hooks: LegacyHooks.new(project_root), stdout: stdout,
+      # The hooks it warns of: fun-ci 1.x's, and any in `hooks_dir` that
+      # doesn't run fun-ci.
+      Hooks = Data.define(:sources) do
+        def warnings = sources.flat_map(&:warnings)
+      end
+
+      # hooks_dir: where git runs the project's hooks from; nil outside a git repository.
+      def self.run(project_root:, stdout: $stdout, hooks_dir: nil)
+        hooks = Hooks.new([LegacyHooks.new(project_root), InstalledHooks.new(hooks_dir)])
+        new(config: ProjectConfig.new(project_root), hooks: hooks, stdout: stdout,
             trunk: TrunkReport.new(project_root)).run
       end
 
@@ -22,20 +31,28 @@ module FunCi
 
       # Warnings are printed but don't fail the check.
       def run
-        errors = @config.validate + @config.evidence_errors
+        errors = problems
         @stdout.puts(errors.empty? ? "All OK. The project is configured." : errors)
         @stdout.puts(@trunk.lines)
         list_presets
+        list_jobs
         @hooks.warnings.each { |warning| @stdout.puts "Warning: #{warning}" }
         errors.empty? ? 0 : 1
       end
 
       private
 
+      def problems = @config.validate + @config.settings_errors + @config.evidence_errors + @config.job_errors
+
       def list_presets
         lists = { "this project" => @config.presets, "any project's output" => @config.any_project_presets }
         lists.each { |what, names| @stdout.puts "Evidence presets for #{what}: #{names.join(", ")}" if names.any? }
       end
+
+      def list_jobs
+        jobs = @config.jobs
+        @stdout.puts "Jobs: #{jobs.map { |job| "#{job.name} (#{job.cadence})" }.join(", ")}" if jobs.any?
+      end
     end
   end
 end

data/lib/fun_ci/trunk/shown.rb

@@ -8,8 +8,9 @@ module FunCi
     # rather than stored, how many seconds ago its trunk tip was seen (nil
     # when it had none), the project's last fetch (a LastFetch, nil if none), and
     # the SHA the trunk has moved to since, if it has.
-    # A run whose check hasn't been recorded is checking until its fetch and
-    # merge are past their time, and then unknown.
+    # A run whose check hasn't been recorded is checking while its foreground
+    # stages run and until its fetch and merge are past their time, and then
+    # unknown.
     Shown = Data.define(:state, :check, :age, :fetch, :moved_to)
 
     class Shown
@@ -21,8 +22,10 @@ module FunCi
             fetch: fetch, moved_to: moved_to)
       end
 
-      def self.unchecked(started:, now:)
-        if now - started <= FETCH_DEADLINE + CHECK_BUDGET
+      # stages_running: whether the run's foreground stages, which the check
+      # is recorded after, are still going.
+      def self.unchecked(started:, now:, stages_running: false)
+        if stages_running || now - started <= FETCH_DEADLINE + CHECK_BUDGET
           return new(state: "checking", check: nil, age: nil, fetch: nil, moved_to: nil)
         end
 

data/lib/fun_ci/version.rb

@@ -2,5 +2,5 @@
 
 # Loaded on its own by the gemspec, so it must not require anything.
 module FunCi
-  VERSION = "2.1.1"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fun_ci
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.0
 platform: aarch64-linux
 authors:
 - Erik Thyge Madsen
@@ -63,15 +63,25 @@ files:
 - exe/fun-ci
 - lib/fun_ci.rb
 - lib/fun_ci/agent/age.rb
+- lib/fun_ci/agent/cancel_command.rb
 - lib/fun_ci/agent/command_support.rb
 - lib/fun_ci/agent/commands.rb
 - lib/fun_ci/agent/context.rb
 - lib/fun_ci/agent/digest.rb
+- lib/fun_ci/agent/due_in.rb
 - lib/fun_ci/agent/events.rb
 - lib/fun_ci/agent/events_command.rb
 - lib/fun_ci/agent/evidence_text.rb
 - lib/fun_ci/agent/exit_code.rb
 - lib/fun_ci/agent/git.rb
+- lib/fun_ci/agent/job_events.rb
+- lib/fun_ci/agent/job_json.rb
+- lib/fun_ci/agent/job_report.rb
+- lib/fun_ci/agent/job_why.rb
+- lib/fun_ci/agent/job_why_json.rb
+- lib/fun_ci/agent/job_why_text.rb
+- lib/fun_ci/agent/jobs_command.rb
+- lib/fun_ci/agent/jobs_text.rb
 - lib/fun_ci/agent/live_pipeline.rb
 - lib/fun_ci/agent/next_step.rb
 - lib/fun_ci/agent/options.rb
@@ -83,7 +93,9 @@ files:
 - lib/fun_ci/agent/runs_command.rb
 - lib/fun_ci/agent/runs_text.rb
 - lib/fun_ci/agent/snapshots.rb
+- lib/fun_ci/agent/span.rb
 - lib/fun_ci/agent/stage_summary.rb
+- lib/fun_ci/agent/starts_in.rb
 - lib/fun_ci/agent/status_command.rb
 - lib/fun_ci/agent/status_json.rb
 - lib/fun_ci/agent/status_text.rb
@@ -110,10 +122,14 @@ files:
 - lib/fun_ci/console/console_loop.rb
 - lib/fun_ci/console/console_session.rb
 - lib/fun_ci/console/console_state.rb
+- lib/fun_ci/console/job_message.rb
+- lib/fun_ci/console/job_order.rb
+- lib/fun_ci/console/job_rows.rb
 - lib/fun_ci/console/key_handler.rb
 - lib/fun_ci/console/launcher.rb
 - lib/fun_ci/console/milestone_events.rb
 - lib/fun_ci/console/milestones.rb
+- lib/fun_ci/console/paging.rb
 - lib/fun_ci/console/renderer_lookup.rb
 - lib/fun_ci/console/renderer_process.rb
 - lib/fun_ci/console/row_order.rb
@@ -205,8 +221,23 @@ files:
 - lib/fun_ci/evidence/stamp.rb
 - lib/fun_ci/evidence/start.rb
 - lib/fun_ci/evidence/worktree.rb
+- lib/fun_ci/jobs/due.rb
+- lib/fun_ci/jobs/due_jobs.rb
+- lib/fun_ci/jobs/folders.rb
+- lib/fun_ci/jobs/job.rb
+- lib/fun_ci/jobs/job_fork.rb
+- lib/fun_ci/jobs/job_run.rb
+- lib/fun_ci/jobs/locks.rb
+- lib/fun_ci/jobs/schedule.rb
+- lib/fun_ci/jobs/site.rb
+- lib/fun_ci/jobs/standings.rb
+- lib/fun_ci/jobs/state.rb
+- lib/fun_ci/jobs/wall_clock_wait.rb
+- lib/fun_ci/persistence/active_jobs.rb
 - lib/fun_ci/persistence/active_runs.rb
 - lib/fun_ci/persistence/database.rb
+- lib/fun_ci/persistence/job_recorder.rb
+- lib/fun_ci/persistence/job_runs.rb
 - lib/fun_ci/persistence/null_recorder.rb
 - lib/fun_ci/persistence/output_tail.rb
 - lib/fun_ci/persistence/pipeline_recorder.rb
@@ -222,6 +253,7 @@ files:
 - lib/fun_ci/persistence/trunk_recording.rb
 - lib/fun_ci/persistence/write_trouble.rb
 - lib/fun_ci/pipeline/background_fork.rb
+- lib/fun_ci/pipeline/budgets.rb
 - lib/fun_ci/pipeline/command_executor.rb
 - lib/fun_ci/pipeline/gate.rb
 - lib/fun_ci/pipeline/git_environment.rb
@@ -229,6 +261,7 @@ files:
 - lib/fun_ci/pipeline/in_place.rb
 - lib/fun_ci/pipeline/output_window.rb
 - lib/fun_ci/pipeline/pipeline_forker.rb
+- lib/fun_ci/pipeline/priorities.rb
 - lib/fun_ci/pipeline/process_runner.rb
 - lib/fun_ci/pipeline/progress_reporter.rb
 - lib/fun_ci/pipeline/run_canceller.rb
@@ -256,8 +289,10 @@ files:
 - lib/fun_ci/setup/gradle_linter_detector.rb
 - lib/fun_ci/setup/hook_script.rb
 - lib/fun_ci/setup/hook_writer.rb
+- lib/fun_ci/setup/installed_hooks.rb
 - lib/fun_ci/setup/installer.rb
 - lib/fun_ci/setup/legacy_hooks.rb
+- lib/fun_ci/setup/lfs_hook.rb
 - lib/fun_ci/setup/lint_detection.rb
 - lib/fun_ci/setup/maven_linter_detector.rb
 - lib/fun_ci/setup/project_config.rb