flatware 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ff7cc506cc64f0d64a8892435f946ec19551461
-  data.tar.gz: e27ffb2ff50e1547a03e2c8f24c8a2c1f6220abe
+SHA256:
+  metadata.gz: 81d5bd7d6b9f6e71cf86030bdb1e10e9f699b8e63053b7795573438df8aa1ba9
+  data.tar.gz: 141903472d1d3d2998f1a19fec837fc79dfca9a966996c91ac5b16986e1c4906
 SHA512:
-  metadata.gz: df21484a242be9f3e979c53bd38830c1e824e045a966d2e66023bd9f56c43ea64ed7a1c6e365206ea4bfb59e2440ce6654520eaf1be55f25f463119e89306b2d
-  data.tar.gz: c6ce36dc2f5472e7abc59eee306cc1afc82dcae1a6c4fba5844a82a1501f3f3d036d1bb8ba2aba99d0faa7d5eb07f2280deb1bd8097f0953a574c874371581ad
+  metadata.gz: 11985434629de54efbb5ad7d1b14ecb27bdd9047a72893a2367d0747e60bc67042e876d3374ab39c85b2c5617312243e92458c62f03ccb372b371e76cacda5ec
+  data.tar.gz: e763a95035658051651a8c44b1a40ea014a9e9f41b8a08faa13c10fd1cfe7985a27771bf9ebc3ba8178b163ddab2847644b5f522a4a889c15baed371897a0c97

data/README.md

@@ -73,6 +73,17 @@ To run your entire suite with the default rspec options add the `flatware-rspec`
 $ flatware rspec
 ```
 
+The rspec runner can balance worker loads, making your suite even faster.
+
+It forms balaced groups of spec files according to their last run times, if you've set `example_status_persistence_file_path` [in your RSpec config](https://relishapp.com/rspec/rspec-core/v/3-8/docs/command-line/only-failures).
+
+For this to work the configuration option must be loaded before any specs are run. The `.rspec` file is one way to achive this:
+
+    --require spec_helper
+
+But beware, if you're using ActiveRecord in your suite you'll need to avoid doing things that cause it to establish a database connection in `spec_helper.rb`. If ActiveRecord connects before flatware forks off workers, each will die messily. All of this will just work if you're following [the recomended pattern of splitting your helpers into `spec_helper` and `rails_helper`](https://github.com/rspec/rspec-rails/blob/v3.8.2/lib/generators/rspec/install/templates/spec/rails_helper.rb).
+
+
 ### Options
 
 If you'd like to limit the number of forked workers, you can pass the 'w' flag:

data/lib/flatware/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core'
 require 'rspec/expectations'
 require 'flatware/rspec/cli'
@@ -6,23 +8,21 @@ module Flatware
   module RSpec
     require 'flatware/rspec/formatters/console'
     require 'flatware/rspec/formatter'
+    require 'flatware/rspec/job_builder'
 
     def self.extract_jobs_from_args(args, workers:)
+      JobBuilder.new(args, workers: workers).jobs
+   end
 
-      options = ::RSpec::Core::ConfigurationOptions.new(args)
-      configuration = ::RSpec::Core::Configuration.new
-      def configuration.command() 'rspec' end
-      options.configure(configuration)
-      configuration.files_to_run.uniq.map do |file|
-        Job.new(file, args)
-      end
-    end
-
-    def self.run(job, options={})
+    def self.run(job, _options = {})
       runner = ::RSpec::Core::Runner
       def runner.trap_interrupt() end
 
-      runner.run(%w[--format Flatware::RSpec::Formatter] + Array(job), $stderr, $stdout)
+      args = %w[
+        --format Flatware::RSpec::Formatter
+      ] + Array(job)
+
+      runner.run(args, $stderr, $stdout)
     end
   end
 end

data/lib/flatware/rspec/checkpoint.rb

@@ -14,7 +14,7 @@ module Flatware
       end
 
       def failures?
-        summary.failure_count > 0
+        summary.failure_count > 0 || summary.errors_outside_of_examples_count > 0
       end
 
       def failure_notifications

data/lib/flatware/rspec/job_builder.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Flatware
+  module RSpec
+    # groups spec files into one job per worker.
+    # reads from persisted example statuses, if available,
+    # and attempts to ballence the jobs accordingly.
+    class JobBuilder
+      extend Forwardable
+      attr_reader :args, :workers, :configuration
+      def_delegators(
+        :configuration,
+        :files_to_run,
+        :example_status_persistence_file_path
+      )
+
+      def initialize(args, workers:)
+        @args = args
+        @workers = workers
+
+        @configuration = ::RSpec.configuration
+        configuration.define_singleton_method(:command) { 'rspec' }
+
+        ::RSpec::Core::ConfigurationOptions.new(args).configure(@configuration)
+      end
+
+      def jobs
+        bucket_count = [files_to_run.size, workers].min
+
+        seconds_per_file = load_persisted_example_statuses
+                           .select(&passing)
+                           .map(&parse_example)
+                           .reduce({}, &sum_by_example_file)
+
+        timed_files, untimed_files = files_to_run
+                                     .map(&method(:normalize_path))
+                                     .reduce(
+                                       [[], []]
+                                     ) do |(timed, untimed), file|
+          if (time = seconds_per_file[file])
+            [timed.append([file, time]), untimed]
+          else
+            [timed, untimed.append(file)]
+          end
+        end
+
+        balance_by(bucket_count, timed_files, &:last)
+          .map { |bucket| bucket.map(&:first) }
+          .zip(
+            round_robin(bucket_count, untimed_files)
+          ).map(&:flatten)
+          .map do |files|
+          Job.new(files, args)
+        end
+      end
+
+      private
+
+      def normalize_path(path)
+        ::RSpec::Core::Metadata.relative_path(File.expand_path(path))
+      end
+
+      def load_persisted_example_statuses
+        ::RSpec::Core::ExampleStatusPersister.load_from(
+          example_status_persistence_file_path || ''
+        )
+      end
+
+      def sum_by_example_file
+        lambda do |times, file_name:, seconds:|
+          times.merge(file_name => seconds) { |_, old = 0, new| old + new }
+        end
+      end
+
+      def passing
+        ->(status:, **) { status =~ /pass/i }
+      end
+
+      def parse_example
+        lambda do |example_id:, run_time:, **|
+          seconds = run_time.match(/\d+(\.\d+)?/).to_s.to_f
+          file_name = ::RSpec::Core::Example.parse_id(example_id).first
+          { seconds: seconds, file_name: file_name }
+        end
+      end
+
+      def round_robin(count, items)
+        Array.new(count) { [] }.tap do |groups|
+          items.each_with_index do |entry, i|
+            groups[i % count] << entry
+          end
+        end
+      end
+
+      def balance_by(count, items, &block)
+        # find the group with the smallest sum and add it there
+        Array.new(count) { [] }.tap do |groups|
+          items
+            .sort_by(&block)
+            .reverse
+            .each do |entry|
+            groups.min_by do |group|
+              group.map(&block).reduce(:+) || 0
+            end.push(entry)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flatware/sink.rb

@@ -98,7 +98,7 @@ module Flatware
         jobs.group_by.with_index do |_,i|
           i % worker_count
         end.values.map do |jobs|
-          Job.new(jobs.map(&:id), jobs.first.args)
+          Job.new(jobs.map(&:id).flatten, jobs.first.args)
         end
       end
     end

data/lib/flatware/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Flatware
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flatware
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Dunn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
@@ -103,6 +103,7 @@ files:
 - lib/flatware/rspec/examples_notification.rb
 - lib/flatware/rspec/formatter.rb
 - lib/flatware/rspec/formatters/console.rb
+- lib/flatware/rspec/job_builder.rb
 - lib/flatware/rspec/summary.rb
 - lib/flatware/serialized_exception.rb
 - lib/flatware/sink.rb
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A distributed cucumber and rspec runner