rspec-sharder 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d09ff7bef003d57985622045c99bb8743834d26f0f2119bc32d9ffdd800822
-  data.tar.gz: 9e5f371699047b82862fe5f76288122c10b80b23117dc0ec2d82e6e1f29f312e
+  metadata.gz: 456e3e2d41127ed5154b26a4dffaa32e6fabf159a9aaea4461630212a8209dee
+  data.tar.gz: 37d68db5f6317a270de6f96129842c5bf4e530cedfab973b03d53c16583a74b9
 SHA512:
-  metadata.gz: be15f6f4f0b66eef6b50af889e48f3fb3f7cadfd1650314538c3088e4828e19f8f6af77092fa359f081cec206f3957389397e1d52b4e30ff81dd20b2ecb854cd
-  data.tar.gz: 4c69946dc056cb146ff452d80b9e31503c12fbaa6cfb14f164268fafd84a7baf13da04b694e77f0b9d9dfea65898f8579f2b7fb81b401bde7ef80b9494f458d8
+  metadata.gz: 5ca04689abae34a1a1820ac1de65fb844377254251ba3e4f6420858873bed207140495846b23ea9a00c3ffa8c796747cca5023f7c463f2c5bb78f3fe760c1879
+  data.tar.gz: 43bbba87bf483eb6237a16c12c115ff1b1ef340b7fb527ec4a6d4e0c2bded1a8d794379e9b9cd6223040e7cb89c7e39d86014733198c0d7117d78233f38382b9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-sharder (0.0.3)
+    rspec-sharder (0.0.4)
       rspec-core
 
 GEM

data/lib/rspec-sharder/command.rb

@@ -1,5 +1,5 @@
 require 'optparse'
-require 'rspec-sharder'
+require 'rspec-sharder/runner'
 
 def fail(message)
   warn message
@@ -83,4 +83,4 @@ fail('fatal: invalid value for --total-shards') unless @total_shards > 0
 fail('fatal: invalid value for --shard') unless @shard > 0
 fail('fatal: --shard may not be greater than --total-shards') unless @shard <= @total_shards
 
-exit RSpec::Sharder.run(total_shards: @total_shards, shard_num: @shard, persist: @persist, rspec_args: ARGV)
+exit RSpec::Sharder::Runner.run(total_shards: @total_shards, shard_num: @shard, persist: @persist, rspec_args: ARGV)

data/lib/rspec-sharder/runner.rb

@@ -0,0 +1,181 @@
+require 'rspec/core'
+require 'rspec-sharder/sharder'
+
+module RSpec
+  module Sharder
+    module Runner
+      def self.run(total_shards:, shard_num:, persist:, rspec_args:)
+        raise "fatal: invalid total shards: #{total_shards}" unless total_shards.is_a?(Integer) && total_shards > 0
+        raise "fatal: invalid shard number: #{shard_num}" unless shard_num.is_a?(Integer) && shard_num > 0 && shard_num <= total_shards
+
+        begin
+          ::RSpec::Core::ConfigurationOptions.new(rspec_args).configure(::RSpec.configuration)
+
+          return if ::RSpec.world.wants_to_quit
+
+          ::RSpec.configuration.load_spec_files
+        ensure
+          ::RSpec.world.announce_filters
+        end
+
+        return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code) if ::RSpec.world.wants_to_quit
+
+        begin
+          shards = ::RSpec::Sharder.build_shards(total_shards)
+        rescue ::RSpec::Sharder::ShardError => e
+          ::RSpec.configuration.error_stream.puts e.message
+          return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code)
+        end
+
+        print_shards(shards)
+
+        expected_total_duration = shards[shard_num - 1][:duration]
+
+        shard_file_paths = shards[shard_num - 1][:file_paths]
+        example_groups = ::RSpec.world.ordered_example_groups.select do |example_group|
+          shard_file_paths.include?(example_group.metadata[:file_path])
+        end
+        example_count = ::RSpec.world.example_count(example_groups)
+
+        new_durations = { }
+
+        actual_total_duration = 0
+        exit_code = ::RSpec.configuration.reporter.report(example_count) do |reporter|
+          ::RSpec.configuration.with_suite_hooks do
+            if example_count == 0 && ::RSpec.configuration.fail_if_no_examples
+              return ::RSpec.configuration.failure_exit_code
+            end
+
+            group_results = example_groups.map do |example_group|
+              result, duration = run_example_group(example_group, reporter)
+
+              file_path = example_group.metadata[:file_path]
+              actual_total_duration += duration
+              new_durations[file_path] ||= 0
+              new_durations[file_path] += duration
+
+              result
+            end
+
+            success = group_results.all?
+            exit_code = success ? 0 : 1
+            if ::RSpec.world.non_example_failure
+              success = false
+              exit_code = ::RSpec.configuration.failure_exit_code
+            end
+            exit_code
+          end
+        end
+
+        # Write results to .examples file.
+        unless ::RSpec.configuration.dry_run
+          persist_example_statuses(shard_file_paths)
+        end
+
+        if ::RSpec.configuration.dry_run
+          if persist
+            ::RSpec.configuration.output_stream.puts <<~EOF
+              
+              Dry run. Not saving to .rspec-sharder-durations.
+            EOF
+          end
+        else
+          if exit_code == 0
+            # Print recorded durations and summary.
+            ::RSpec.configuration.output_stream.puts 'Durations'
+
+            new_durations.sort_by { |file_path, duration| file_path }.each do |file_path, duration|
+              ::RSpec.configuration.output_stream.puts "#{file_path},#{duration}"
+            end
+
+            ::RSpec.configuration.output_stream.puts <<~EOF
+              
+              Expected total duration: #{pretty_duration(expected_total_duration)}
+              Actual total duration:   #{pretty_duration(actual_total_duration)}
+              Diff:                    #{pretty_duration((actual_total_duration - expected_total_duration).abs)}
+            EOF
+
+            if persist
+              # Write durations to .rspec-sharder-durations.
+              ::RSpec.configuration.output_stream.puts <<~EOF
+
+                Saving to .rspec-sharder-durations.
+              EOF
+
+              persist_durations(new_durations)
+            end
+          elsif persist
+            ::RSpec.configuration.output_stream.puts <<~EOF
+              
+              RSpec failed. Not saving to .rspec-sharder-durations.
+            EOF
+          end
+        end
+
+        exit_code
+      end
+
+      private
+
+      def self.persist_example_statuses(file_paths)
+        return unless (path = ::RSpec.configuration.example_status_persistence_file_path)
+
+        examples = ::RSpec.world.all_examples.select do |example|
+          file_paths.include?(example.metadata[:file_path])
+        end
+        ::RSpec::Core::ExampleStatusPersister.persist(examples, path)
+      rescue SystemCallError => e
+        ::RSpec.configuration.output_stream.puts "warning: failed to write results to #{path}"
+      end
+
+      def self.pretty_duration(duration_millis)
+        duration_seconds = (duration_millis / 1000.0).round
+        minutes = duration_seconds / 60
+        seconds = duration_seconds % 60
+
+        minutes_str = "#{minutes} minute#{minutes == 1 ? '' : 's'}"
+        seconds_str = "#{seconds} second#{seconds == 1 ? '' : 's'}"
+
+        if minutes == 0
+          seconds_str
+        else
+          "#{minutes_str}, #{seconds_str}"
+        end
+      end
+
+      def self.print_shards(shards)
+        shards.each_with_index do |shard, i|
+          ::RSpec.configuration.output_stream.puts(
+            "Shard #{i + 1} (Files: #{shard[:file_paths].size}, Duration: #{pretty_duration(shard[:duration])}):"
+          )
+          shard[:file_paths].each do |file_path|
+            ::RSpec.configuration.output_stream.puts file_path
+          end
+          ::RSpec.configuration.output_stream.puts unless i == shards.size - 1
+        end
+      end
+
+      def self.persist_durations(durations)
+        File.open(".rspec-sharder-durations", "w+") do |file|
+          file.puts <<~EOF
+            # Generated by rspec-sharder on #{Time.now.to_s}. See `bundle exec rspec-sharder -h`.
+            
+          EOF
+          durations.sort_by { |file_path, duration| file_path }.each do |file_path, duration|
+            file.puts "#{file_path},#{duration}"
+          end
+        end
+      end
+
+      def self.current_time_millis
+        (Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1000).to_i
+      end
+
+      def self.run_example_group(example_group, reporter)
+        start_time = current_time_millis
+        result = example_group.run(reporter)
+        [result, (current_time_millis - start_time).to_i]
+      end
+    end
+  end
+end

data/lib/rspec-sharder/sharder.rb

@@ -0,0 +1,96 @@
+require 'rspec/core'
+
+module RSpec
+  module Sharder
+    class ShardError < StandardError; end
+
+    def self.load_recorded_durations
+      durations = { }
+
+      missing_files = 0
+
+      if File.exist?('.rspec-sharder-durations')
+        File.readlines('.rspec-sharder-durations').each_with_index do |line, index|
+          line = line.strip
+
+          if !line.start_with?('#') && !line.empty?
+            parts = line.split(',')
+
+            unless parts.length == 2
+              raise ShardError.new("fatal: invalid .rspec-sharder-durations at line #{index + 1}")
+            end
+
+            file_path = parts[0].strip
+
+            if file_path.empty?
+              raise ShardError.new("fatal: invalid file path in .rspec-sharder-durations at line #{index + 1}")
+            end
+
+            unless File.exist?(file_path)
+              missing_files += 1
+            end
+
+            begin
+              duration = Integer(parts[1])
+            rescue ArgumentError => e
+              raise ShardError.new("fatal: invalid .rspec-sharder-durations at line #{index + 1}")
+            end
+
+            durations[file_path] = duration
+          end
+        end.compact
+
+        if missing_files > 0
+          ::RSpec.configuration.output_stream.puts <<~EOF
+            warning: #{missing_files} file(s) in .rspec-sharder-durations do not exist, consider regenerating
+
+          EOF
+        end
+      end
+
+      durations
+    end
+
+    def self.build_shards(total_shards)
+      durations = load_recorded_durations
+
+      files = { }
+
+      missing_files = 0
+      ::RSpec.world.ordered_example_groups.each do |example_group|
+        file_path = example_group.metadata[:file_path]
+        files[file_path] ||= 0
+        if durations[file_path]
+          files[file_path] = durations[file_path]
+        else
+          missing_files += 1
+          # Assume 1000 milliseconds per example.
+          files[file_path] += ::RSpec.world.example_count([example_group]) * 1000
+        end
+      end
+
+      if missing_files > 0
+        ::RSpec.configuration.output_stream.puts <<~EOF
+          warning: #{missing_files} file(s) in not found in .rspec-sharder-durations, consider regenerating
+
+        EOF
+      end
+
+      shards = (1..total_shards).map { { duration: 0, file_paths: [] } }
+
+      # First sort by duration to ensure large files are distributed evenly.
+      # Next, sort by path to ensure shards are generated deterministically.
+      # Note that files is a map, sorting it turns it into an array of arrays.
+      files = files.sort_by { |file_path, duration| [duration, file_path] }.reverse
+      files.each do |file_path, duration|
+        shards.sort_by! { |shard| shard[:duration] }
+        shards[0][:file_paths] << file_path
+        shards[0][:duration] += duration
+      end
+
+      shards.each { |shard| shard[:file_paths].sort! }
+
+      shards
+    end
+  end
+end

data/lib/rspec-sharder/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Sharder
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sharder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -38,8 +38,9 @@ files:
 - LICENSE
 - README.md
 - bin/rspec-sharder
-- lib/rspec-sharder.rb
 - lib/rspec-sharder/command.rb
+- lib/rspec-sharder/runner.rb
+- lib/rspec-sharder/sharder.rb
 - lib/rspec-sharder/version.rb
 - rspec-sharder.gemspec
 - scripts/release.sh

data/lib/rspec-sharder.rb

@@ -1,270 +0,0 @@
-require 'rspec/core'
-
-module RSpec
-  module Sharder
-
-    class ShardError < StandardError; end
-
-    def self.run(total_shards:, shard_num:, persist:, rspec_args:)
-      raise "fatal: invalid total shards: #{total_shards}" unless total_shards.is_a?(Integer) && total_shards > 0
-      raise "fatal: invalid shard number: #{shard_num}" unless shard_num.is_a?(Integer) && shard_num > 0 && shard_num <= total_shards
-
-      begin
-        ::RSpec::Core::ConfigurationOptions.new(rspec_args).configure(::RSpec.configuration)
-
-        return if ::RSpec.world.wants_to_quit
-
-        ::RSpec.configuration.load_spec_files
-      ensure
-        ::RSpec.world.announce_filters
-      end
-
-      return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code) if ::RSpec.world.wants_to_quit
-
-      all_durations = load_recorded_durations
-
-      begin
-        shards = build_shards(total_shards, shard_num, all_durations)
-      rescue ShardError => e
-        ::RSpec.configuration.error_stream.puts e.message
-        return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code)
-      end
-
-      print_shards(shards)
-
-      expected_total_duration = shards[shard_num - 1][:duration]
-
-      shard_file_paths = shards[shard_num - 1][:file_paths]
-      example_groups = ::RSpec.world.ordered_example_groups.select do |example_group|
-        shard_file_paths.include?(example_group.metadata[:file_path])
-      end
-      example_count = ::RSpec.world.example_count(example_groups)
-
-      new_durations = { }
-
-      actual_total_duration = 0
-      exit_code = ::RSpec.configuration.reporter.report(example_count) do |reporter|
-        ::RSpec.configuration.with_suite_hooks do
-          if example_count == 0 && ::RSpec.configuration.fail_if_no_examples
-            return ::RSpec.configuration.failure_exit_code
-          end
-
-          group_results = example_groups.map do |example_group|
-            result, duration = run_example_group(example_group, reporter)
-
-            file_path = example_group.metadata[:file_path]
-            actual_total_duration += duration
-            new_durations[file_path] ||= 0
-            new_durations[file_path] += duration
-
-            result
-          end
-
-          success = group_results.all?
-          exit_code = success ? 0 : 1
-          if ::RSpec.world.non_example_failure
-            success = false
-            exit_code = ::RSpec.configuration.failure_exit_code
-          end
-          exit_code
-        end
-      end
-
-      # Write results to .examples file.
-      unless ::RSpec.configuration.dry_run
-        persist_example_statuses(shard_file_paths)
-      end
-
-      if ::RSpec.configuration.dry_run
-        if persist
-          ::RSpec.configuration.output_stream.puts <<~EOF
-            
-            Dry run. Not saving to .rspec-sharder-durations.
-          EOF
-        end
-      else
-        if exit_code == 0
-          # Print recorded durations and summary.
-          ::RSpec.configuration.output_stream.puts 'Durations'
-
-          new_durations.sort_by { |file_path, duration| file_path }.each do |file_path, duration|
-            ::RSpec.configuration.output_stream.puts "#{file_path},#{duration}"
-          end
-
-          ::RSpec.configuration.output_stream.puts <<~EOF
-            
-            Expected total duration: #{pretty_duration(expected_total_duration)}
-            Actual total duration:   #{pretty_duration(actual_total_duration)}
-            Diff:                    #{pretty_duration((actual_total_duration - expected_total_duration).abs)}
-          EOF
-
-          if persist
-            # Write durations to .rspec-sharder-durations.
-            ::RSpec.configuration.output_stream.puts <<~EOF
-
-              Saving to .rspec-sharder-durations.
-            EOF
-
-            persist_durations(new_durations)
-          end
-        elsif persist
-          ::RSpec.configuration.output_stream.puts <<~EOF
-            
-            RSpec failed. Not saving to .rspec-sharder-durations.
-          EOF
-        end
-      end
-
-      exit_code
-    end
-
-    private
-
-    def self.load_recorded_durations
-      durations = { }
-
-      missing_files = 0
-
-      if File.exist?('.rspec-sharder-durations')
-        File.readlines('.rspec-sharder-durations').each_with_index do |line, index|
-          line = line.strip
-
-          if !line.start_with?('#') && !line.empty?
-            parts = line.split(',')
-
-            unless parts.length == 2
-              raise ShardError.new("fatal: invalid .rspec-sharder-durations at line #{index + 1}")
-            end
-
-            file_path = parts[0].strip
-
-            if file_path.empty?
-              raise ShardError.new("fatal: invalid file path in .rspec-sharder-durations at line #{index + 1}")
-            end
-
-            unless File.exist?(file_path)
-              missing_files += 1
-            end
-
-            begin
-              duration = Integer(parts[1])
-            rescue ArgumentError => e
-              raise ShardError.new("fatal: invalid .rspec-sharder-durations at line #{index + 1}")
-            end
-
-            durations[file_path] = duration
-          end
-        end.compact
-
-        if missing_files > 0
-          ::RSpec.configuration.output_stream.puts <<~EOF
-            warning: #{missing_files} file(s) in .rspec-sharder-durations do not exist, consider regenerating
-
-          EOF
-        end
-      end
-
-      durations
-    end
-
-    def self.build_shards(total_shards, shard_num, durations)
-      files = { }
-
-      missing_files = 0
-      ::RSpec.world.ordered_example_groups.each do |example_group|
-        file_path = example_group.metadata[:file_path]
-        files[file_path] ||= 0
-        if durations[file_path]
-          files[file_path] = durations[file_path]
-        else
-          missing_files += 1
-          # Assume 1000 milliseconds per example.
-          files[file_path] += ::RSpec.world.example_count([example_group]) * 1000
-        end
-      end
-
-      if missing_files > 0
-        ::RSpec.configuration.output_stream.puts <<~EOF
-          warning: #{missing_files} file(s) in not found in .rspec-sharder-durations, consider regenerating
-
-        EOF
-      end
-
-      shards = (1..total_shards).map { { duration: 0, file_paths: [] } }
-
-      # First sort by duration to ensure large files are distributed evenly.
-      # Next, sort by path to ensure shards are generated deterministically.
-      # Note that files is a map, sorting it turns it into an array of arrays.
-      files = files.sort_by { |file_path, duration| [duration, file_path] }.reverse
-      files.each do |file_path, duration|
-        shards.sort_by! { |shard| shard[:duration] }
-        shards[0][:file_paths] << file_path
-        shards[0][:duration] += duration
-      end
-
-      shards.each { |shard| shard[:file_paths].sort! }
-
-      shards
-    end
-
-    def self.persist_example_statuses(file_paths)
-      return unless (path = ::RSpec.configuration.example_status_persistence_file_path)
-
-      examples = ::RSpec.world.all_examples.select do |example|
-        file_paths.include?(example.metadata[:file_path])
-      end
-      ::RSpec::Core::ExampleStatusPersister.persist(examples, path)
-    rescue SystemCallError => e
-      ::RSpec.configuration.output_stream.puts "warning: failed to write results to #{path}"
-    end
-
-    def self.pretty_duration(duration_millis)
-      duration_seconds = (duration_millis / 1000.0).round
-      minutes = duration_seconds / 60
-      seconds = duration_seconds % 60
-
-      minutes_str = "#{minutes} minute#{minutes == 1 ? '' : 's'}"
-      seconds_str = "#{seconds} second#{seconds == 1 ? '' : 's'}"
-
-      if minutes == 0
-        seconds_str
-      else
-        "#{minutes_str}, #{seconds_str}"
-      end
-    end
-
-    def self.print_shards(shards)
-      shards.each_with_index do |shard, i|
-        ::RSpec.configuration.output_stream.puts(
-          "Shard #{i + 1} (Files: #{shard[:file_paths].size}, Duration: #{pretty_duration(shard[:duration])}):"
-        )
-        shard[:file_paths].each do |file_path|
-          ::RSpec.configuration.output_stream.puts file_path
-        end
-        ::RSpec.configuration.output_stream.puts unless i == shards.size - 1
-      end
-    end
-
-    def self.persist_durations(durations)
-      File.open(".rspec-sharder-durations", "w+") do |file|
-        file.puts <<~EOF
-          # Generated by rspec-sharder on #{Time.now.to_s}. See `bundle exec rspec-sharder -h`.
-          
-        EOF
-        durations.sort_by { |file_path, duration| file_path }.each do |file_path, duration|
-          file.puts "#{file_path},#{duration}"
-        end
-      end
-    end
-
-    def self.current_time_millis
-      (Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1000).to_i
-    end
-
-    def self.run_example_group(example_group, reporter)
-      start_time = current_time_millis
-      result = example_group.run(reporter)
-      [result, (current_time_millis - start_time).to_i]
-    end
-  end
-end