ci-helper 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adbebe67fd86fd92ee630a21009a3c42fe6d4be32d9ebb773539cc92964bab77
-  data.tar.gz: ce5e94594b8392d5f0d7b1de9f4fd5c548d5598c0097192a98eb6718f8478493
+  metadata.gz: acb764a2dd918b19d7aa39e23f3f2cf3f38dbcf1e37d67029487b29e3fe609db
+  data.tar.gz: b0a66151d11632ad06a22367110f9520dcc5f4c13ab51dcb95b03309ce1b2bb1
 SHA512:
-  metadata.gz: b98ad7e1d9b1cfa5a740c01ad854c697b65d41e070dbb132b5da44af2a9ada24140edbf80dca852fd9e0e3132a9ec911c8902dcf319d3120a16e2995eda810b1
-  data.tar.gz: 7eb7b22ffacf1b8f0951c8b116edfa67ccd2f55c244626e6d2484332c3dc4de891a7eff91bf0008cf3893be3f9474305076952b1c5ad6c5ce3b70b4b95c0a5fd
+  metadata.gz: cc0f16f1a115ebb6feef700a5f12f9f02c02eb036001e3305770ac58a075240d972d4c58475f5722b00448a5b2756fe5b79887f3c7e75c9a4aba28ff758322f3
+  data.tar.gz: 5dfe278d4742215228137a499f725a83446b54e0bb645c088a99baa8f4d1f509a93aba29d50256b68ab78849a514ddf465fe37a9ce38dd09e92819b1183f524a

data/.rubocop.yml

@@ -3,8 +3,13 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
+  NewCops: enable
   TargetRubyVersion: 3.2
 
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+  EnforcedShorthandSyntax: always
+
 Naming/MethodParameterName:
   AllowedNames: ["x", "y", "z"]
 

data/Gemfile

@@ -7,7 +7,6 @@ gemspec
 gem "benchmark"
 gem "bundler"
 gem "bundler-audit"
-gem "ostruct"
 gem "pry"
 gem "rake"
 gem "rspec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci-helper (0.10.2)
+    ci-helper (0.11.0)
       colorize (~> 1.1)
       dry-inflector (~> 1.0)
       umbrellio-sequel-plugins (~> 0.14)
@@ -48,7 +48,6 @@ GEM
     minitest (6.0.5)
       drb (~> 2.0)
       prism (~> 1.5)
-    ostruct (0.6.3)
     parallel (1.28.0)
     parser (3.3.11.1)
       ast (~> 2.4.1)
@@ -153,7 +152,6 @@ DEPENDENCIES
   bundler
   bundler-audit
   ci-helper!
-  ostruct
   pry
   rake
   rspec

data/README.md

@@ -55,7 +55,7 @@ List of available commands:
 * **RubocopLint** — executes rubocop linter. Does not accept flags.
 * **RunSpecs** — executes `rspec` in project root.
     Accepted flags: `--node-index`, `--node-total`, `--with-database`, `--with-clickhouse`,
-    `--split-resultset`.
+    `--split-resultset`, `--timings-file`, `--timings-out`, `--timings-split-threshold`.
     * `--node-index` — if you run specs in parallel in CI, then you might use this flag.
     * `--node-total` — if you run specs in parallel in CI, then you might use this flag.
     * `--with-database` — if you want to prepare database before executing specs,
@@ -65,6 +65,18 @@ List of available commands:
     * `--split-resultset` — if you run specs in parallel in CI,
         then you might use this flag to `true`. If this flag set to true,
         final `.resultset.json` will be renamed to `resultset.#{node_index}.json`
+    * `--timings-file` — path to a JSON file with previously recorded example timings
+        (`{"./spec/a_spec.rb[1:1]": 0.42, ...}`). When the file is present and non-empty,
+        parallel nodes pack whole spec files by total recorded time (greedy LPT) instead of
+        splitting examples evenly by count; files heavier than the split threshold are packed
+        example by example, and examples missing from the file get the median recorded time.
+        If the file is missing or unreadable, the count-based split is used.
+        `spec/heavy_specs.yml` is ignored in this mode.
+    * `--timings-out` — path to write this run's per-example timings as a flat JSON map
+        (the `--timings-file` format). Merge the files from all nodes to build the timings
+        input for future runs.
+    * `--timings-split-threshold` — total seconds above which a single spec file is split
+        example by example between nodes (default 30).
 * **CheckSpecSuffixes** — checks specs in the spec subdirectories for `_spec` suffix,
     by default ignores directories `support`, `factories` and files with `context` suffix.
     Accepted flags: `--extra-paths`, `--ignored-paths`.

data/lib/ci_helper/commands/check_spec_suffixes.rb

@@ -4,7 +4,7 @@ module CIHelper
   module Commands
     class CheckSpecSuffixes < BaseCommand
       def call
-        paths = target_paths.reject { |path| path.end_with?("_spec.rb") }
+        paths = target_paths.grep_v(/_spec\.rb\z/)
         fail!("Detected specs without _spec suffix: #{paths.join(" ")}") if paths.any?
         0
       end
@@ -16,16 +16,13 @@ module CIHelper
       end
 
       def spec_paths
-        base_paths.select do |path|
-          next if path.start_with?("spec/support")
-          next if path.start_with?("spec/factories")
-          next if path.end_with?("context.rb")
-          true
-        end
+        base_paths
+          .grep_v(%r{\A(?:spec/support|spec/factories)})
+          .grep_v(/context\.rb\z/)
       end
 
       def base_paths
-        Dir["spec/*/**/*.rb"]
+        path.glob("spec/*/**/*.rb").map { |file| file.relative_path_from(path).to_s }
       end
 
       def extra_paths

data/lib/ci_helper/commands/run_specs.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "fileutils"
 require "json"
 require "tmpdir"
 
 module CIHelper
   module Commands
     class RunSpecs < BaseCommand
+      DEFAULT_SPLIT_THRESHOLD = 30.0
+      TIMINGS_RECORDER_PATH = File.expand_path("../tools/spec_timings_recorder.rb", __dir__)
+
       def call
         return if all_spec_files.empty?
 
@@ -15,7 +19,7 @@ module CIHelper
         specs_to_run = job_count == 1 ? job_files : job_examples
         return 0 if specs_to_run.empty?
 
-        execute("bundle exec rspec #{Shellwords.join(specs_to_run)}")
+        run_rspec!(specs_to_run)
         return 0 unless split_resultset?
 
         execute("mv coverage/.resultset.json coverage/resultset.#{job_index}.json")
@@ -33,19 +37,93 @@ module CIHelper
 
       def job_files
         heavy_files, std_files = all_spec_files.partition { |f| heavy?(relative(f)) }
-        sorted_std = std_files.map { |f| [f.size, relative(f)] }.sort.map(&:last)
+        sorted_std = std_files.sort_by { |f| [f.size, relative(f)] }.map { |f| relative(f) }
         distribute(sorted_std + heavy_files)
       end
 
       def job_examples
+        timings.empty? ? counted_job_examples : timed_job_examples
+      end
+
+      def counted_job_examples
         heavy, std = example_ids.partition do |id|
           heavy?(id.split("[", 2).first.delete_prefix("./"))
         end
         distribute(std.sort + heavy.sort)
       end
 
-      def example_ids
+      # Greedy LPT packing: files are weighted by the sum of their examples'
+      # timings (unknown examples get the median), files heavier than the split
+      # threshold are packed example by example. Deterministic on identical
+      # input, so every parallel node computes the same partition.
+      def timed_job_examples
+        loads = Array.new(job_count, 0.0)
+        own_items = []
+
+        weighted_items.sort_by { |item, weight| [-weight, item] }.each do |item, weight|
+          node = loads.each_with_index.min_by { |load, index| [load, index] }.last
+          loads[node] += weight
+          own_items << item if node == job_index - 1
+        end
+
+        own_items.sort
+      end
+
+      def weighted_items
+        example_ids.group_by { |id| id.split("[", 2).first }.flat_map do |file, ids|
+          weights = ids.map { |id| [id, timings.fetch(id, default_example_weight)] }
+          total = weights.sum(&:last)
+          total > split_threshold ? weights : [[file, total]]
+        end
+      end
+
+      def timings
+        @timings ||=
+          begin
+            parsed = options[:timings_file] ? JSON.parse(File.read(options[:timings_file])) : {}
+            parsed.is_a?(Hash) ? parsed.select { |_id, time| time.is_a?(Numeric) } : {}
+          rescue SystemCallError, JSON::ParserError
+            {}
+          end
+      end
+
+      def default_example_weight
+        @default_example_weight ||= timings.values.sort[timings.size / 2]
+      end
+
+      def split_threshold
+        @split_threshold ||= Float(options[:timings_split_threshold] || DEFAULT_SPLIT_THRESHOLD)
+      end
+
+      def timings_out
+        options[:timings_out]
+      end
+
+      # Runs rspec, additionally recording per-example timings when --timings-out is set.
+      # The recorder is wired in through --require rather than --format: --format would replace
+      # the formatters the suite configures via .rspec, and even an added formatter would occupy
+      # the formatter list and suppress rspec's default progress output. It runs from an
+      # after(:suite) hook instead, so it writes even when examples fail and touches no formatter.
+      def run_rspec!(specs_to_run)
+        return execute("bundle exec rspec #{Shellwords.join(specs_to_run)}") unless timings_out
+
+        FileUtils.mkdir_p(File.dirname(timings_out))
         Dir.mktmpdir do |dir|
+          setup = File.join(dir, "ci_helper_timings_setup.rb")
+          File.write(setup, timings_recorder_setup)
+          execute("bundle exec rspec #{Shellwords.join(["--require", setup, *specs_to_run])}")
+        end
+      end
+
+      def timings_recorder_setup
+        <<~RUBY
+          require #{TIMINGS_RECORDER_PATH.inspect}
+          CIHelper::Tools::SpecTimingsRecorder.install(#{timings_out.inspect})
+        RUBY
+      end
+
+      def example_ids
+        @example_ids ||= Dir.mktmpdir do |dir|
           output_file = File.join(dir, "rspec_examples.json")
           begin
             execute(
@@ -60,9 +138,10 @@ module CIHelper
       end
 
       def distribute(items)
-        items.reverse.select.with_index do |_item, index|
-          (index % job_count) == (job_index - 1)
-        end
+        reversed = items.reverse
+        selected_indices =
+          (job_index.pred..).step(job_count).take_while { |index| index < reversed.length }
+        selected_indices.map { |index| reversed[index] }
       end
 
       def heavy?(relative_path)

data/lib/ci_helper/commands.rb

@@ -65,7 +65,7 @@ module CIHelper
       end
 
       def fail!(message, output: nil)
-        raise Error.new(message, output: output)
+        raise Error.new(message, output:)
       end
 
       def boolean_option?(key)

data/lib/ci_helper/tools/spec_timings_recorder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "json"
+
+module CIHelper
+  module Tools
+    # Records each example's run time to a flat JSON map ({ "./spec/a_spec.rb[1:1]" => 0.42 }),
+    # the format RunSpecs consumes via --timings-file. RunSpecs wires it in through rspec's
+    # --require. It collects timings from an after(:suite) hook, so it writes even when examples
+    # fail; and, unlike a formatter, it never joins the formatter list, so rspec still installs
+    # the suite's own formatters — including its default progress formatter when none is set.
+    module SpecTimingsRecorder
+      def self.install(path)
+        RSpec.configure do |config|
+          config.after(:suite) { File.write(path, JSON.dump(SpecTimingsRecorder.collect)) }
+        end
+      end
+
+      # A node runs only the example ids it was given, but rspec loads the whole file, so
+      # all_examples also holds examples filtered out on this node; those never ran and have a
+      # nil run_time. Skip them, otherwise they land as 0.0 and can overwrite real timings on merge.
+      def self.collect
+        RSpec.world.all_examples.each_with_object({}) do |example, timings|
+          run_time = example.execution_result.run_time
+          timings[example.id] = run_time.to_f if run_time
+        end
+      end
+    end
+  end
+end

data/lib/ci_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CIHelper
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 end

data/lib/tasks/sequel_management.rake

@@ -103,7 +103,7 @@ class SequelManagement
       if error.message.include?("does not exist in the filesystem")
         logger.info error.message
       else
-        raise error
+        raise
       end
     end
   end
@@ -115,7 +115,7 @@ class SequelManagement
       if error.message.include?("does not exist in the filesystem")
         logger.info error.message
       else
-        raise error
+        raise
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci-helper
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - JustAnotherDude
@@ -89,6 +89,7 @@ files:
 - lib/ci_helper/railtie.rb
 - lib/ci_helper/tools/colorize.rb
 - lib/ci_helper/tools/inflector.rb
+- lib/ci_helper/tools/spec_timings_recorder.rb
 - lib/ci_helper/version.rb
 - lib/tasks/sequel_management.rake
 homepage: https://github.com/umbrellio/ci_helper