rspec-sharder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7abffffb75542211fc36495edeca3b96f32f59b6975686568b3532d2df6ff9c6
-  data.tar.gz: 64bccf923c9897fa23205ade6af164ca10eb60dfc3c89b760b9a73be35d382bb
+  metadata.gz: c3d09ff7bef003d57985622045c99bb8743834d26f0f2119bc32d9ffdd800822
+  data.tar.gz: 9e5f371699047b82862fe5f76288122c10b80b23117dc0ec2d82e6e1f29f312e
 SHA512:
-  metadata.gz: 3cbba17bc9116dbe0a8e3f6aef9d7865f57e40c6393d2e3d3243afacfc5dee658d33fe2c729734fb43ad291280a67f124913807f0b5d69eb28f13671d194309f
-  data.tar.gz: 809210eec8b32c39a87c6f64dbe6e9f699c1f1242b8edb1c0a9ea8120c7945801461744ad17065913f981a81bdfe1b5e1a031a2ce68a746871db995504e39ff1
+  metadata.gz: be15f6f4f0b66eef6b50af889e48f3fb3f7cadfd1650314538c3088e4828e19f8f6af77092fa359f081cec206f3957389397e1d52b4e30ff81dd20b2ecb854cd
+  data.tar.gz: 4c69946dc056cb146ff452d80b9e31503c12fbaa6cfb14f164268fafd84a7baf13da04b694e77f0b9d9dfea65898f8579f2b7fb81b401bde7ef80b9494f458d8

data/Gemfile.lock

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

data/README.md

@@ -5,22 +5,35 @@ Groups specs into shards, ensuring that each shard has a similar size, and runs
 the specified shard.
 
 Shard size is determined by summing the saved durations for each spec file in
-the shard. Durations are saved in .spec_durations. If a spec file is not found
-in .spec_durations, the duration is estimated based on the number of examples in
-the spec file.
+the shard. Durations are saved in .rspec-sharder-durations. If a spec file is
+not found in .rspec-sharder-durations, the duration is estimated based on the
+number of examples in the spec file.
 
-.spec_durations is generate/updated after a successful run when --persist is
-specified, but only for the shard which was actually executed. To generate
-durations for all shards simultaneously, run with the default options of 1 total
-shards and --persist:
+.rspec-sharder-durations is generated after each successful run, but only for
+the specs which were run as part of the specified shard. Before first use,
+generate .rspec-sharder-durations for all specs by executing with the default
+option of 1 total shards:
 
-bundle exec rspec-sharder --persist -- [<rspec-args...>]
+  bundle exec rspec-sharder -- [<rspec-args...>]
 
-Usage: bundle exec rspec-sharder [--total-shards <num> [--shard <num>]] [--persist] -- [<rspec-args...>]
+Commit .rspec-sharder-durations file to your version control.
+
+Next, configure 2 or more CI jobs to execute separate shards like:
+
+  bundle exec rspec-sharder --total-shards 4 --shard 1 -- [<rspec-args...>]
+  bundle exec rspec-sharder --total-shards 4 --shard 2 -- [<rspec-args...>]
+  bundle exec rspec-sharder --total-shards 4 --shard 3 -- [<rspec-args...>]
+  bundle exec rspec-sharder --total-shards 4 --shard 4 -- [<rspec-args...>]
+
+Finally, set up some job or process to periodically pull .rspec-sharder-durations
+files from CI, combine them, and commit them to source control. This will ensure
+you pick up updated durations for any new or changed files.
+
+Usage: bundle exec rspec-sharder [--total-shards <num> [--shard <num>]] [--no-persist] -- [<rspec-args...>]
 
 Options:
     -h, --help                       Print this message.
     -t, --total-shards <num>         The total number of shards. Defaults to 1.
     -s, --shard <num>                The shard to run. Defaults to 1.
-    -p, --persist                    Save durations to .spec_durations.
+        --no-persist                 Don't save durations to .rspec-sharder-durations.
 ```

data/lib/rspec-sharder/command.rb

@@ -10,7 +10,7 @@ end
 
 @total_shards = 1
 @shard = 1
-@persist = false
+@persist = true
 
 @parser = OptionParser.new do |opts|
   opts.banner = <<~EOF
@@ -18,18 +18,31 @@ end
     the specified shard.
 
     Shard size is determined by summing the saved durations for each spec file in
-    the shard. Durations are saved in .spec_durations. If a spec file is not found
-    in .spec_durations, the duration is estimated based on the number of examples in
-    the spec file.
+    the shard. Durations are saved in .rspec-sharder-durations. If a spec file is
+    not found in .rspec-sharder-durations, the duration is estimated based on the
+    number of examples in the spec file.
 
-    .spec_durations is generate/updated after a successful run when --persist is
-    specified, but only for the shard which was actually executed. To generate
-    durations for all shards simultaneously, run with the default options of 1 total
-    shards and --persist:
+    .rspec-sharder-durations is generated after each successful run, but only for
+    the specs which were run as part of the specified shard. Before first use,
+    generate .rspec-sharder-durations for all specs by executing with the default
+    option of 1 total shards:
 
-    bundle exec rspec-sharder --persist -- [<rspec-args...>]
+      bundle exec rspec-sharder -- [<rspec-args...>]
 
-    Usage: bundle exec rspec-sharder [--total-shards <num> [--shard <num>]] [--persist] -- [<rspec-args...>]
+    Commit .rspec-sharder-durations file to your version control.
+
+    Next, configure 2 or more CI jobs to execute separate shards like:
+
+      bundle exec rspec-sharder --total-shards 4 --shard 1 -- [<rspec-args...>]
+      bundle exec rspec-sharder --total-shards 4 --shard 2 -- [<rspec-args...>]
+      bundle exec rspec-sharder --total-shards 4 --shard 3 -- [<rspec-args...>]
+      bundle exec rspec-sharder --total-shards 4 --shard 4 -- [<rspec-args...>]
+
+    Finally, set up some job or process to periodically pull .rspec-sharder-durations
+    files from CI, combine them, and commit them to source control. This will ensure
+    you pick up updated durations for any new or changed files.
+
+    Usage: bundle exec rspec-sharder [--total-shards <num> [--shard <num>]] [--no-persist] -- [<rspec-args...>]
 
     Options:
   EOF
@@ -55,8 +68,8 @@ end
     end
   end
 
-  opts.on('-p', '--persist', 'Save durations to .spec_durations.') do
-    @persist = true
+  opts.on('--no-persist', "Don't save durations to .rspec-sharder-durations.") do
+    @persist = false
   end
 end
 
@@ -70,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
 
-RSpec::Sharder.run(total_shards: @total_shards, shard_num: @shard, persist: @persist, rspec_args: ARGV)
+exit RSpec::Sharder.run(total_shards: @total_shards, shard_num: @shard, persist: @persist, rspec_args: ARGV)

data/lib/rspec-sharder/version.rb

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

data/lib/rspec-sharder.rb

@@ -27,7 +27,7 @@ module RSpec
         shards = build_shards(total_shards, shard_num, all_durations)
       rescue ShardError => e
         ::RSpec.configuration.error_stream.puts e.message
-        exit ::RSpec.configuration.failure_exit_cod
+        return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code)
       end
 
       print_shards(shards)
@@ -79,7 +79,7 @@ module RSpec
         if persist
           ::RSpec.configuration.output_stream.puts <<~EOF
             
-            Dry run. Not saving to .spec_durations.
+            Dry run. Not saving to .rspec-sharder-durations.
           EOF
         end
       else
@@ -99,27 +99,23 @@ module RSpec
           EOF
 
           if persist
-            # Write all durations with updates to .spec_durations.
+            # Write durations to .rspec-sharder-durations.
             ::RSpec.configuration.output_stream.puts <<~EOF
 
-              Saving to .spec_durations.
+              Saving to .rspec-sharder-durations.
             EOF
 
-            new_durations.each do |file_path, duration|
-              all_durations[file_path] = duration
-            end
-
-            persist_durations(all_durations)
+            persist_durations(new_durations)
           end
         elsif persist
           ::RSpec.configuration.output_stream.puts <<~EOF
             
-            RSpec failed. Not saving to .spec_durations.
+            RSpec failed. Not saving to .rspec-sharder-durations.
           EOF
         end
       end
 
-      exit exit_code
+      exit_code
     end
 
     private
@@ -127,36 +123,45 @@ module RSpec
     def self.load_recorded_durations
       durations = { }
 
-      if File.exist?('.spec_durations')
-        File.readlines('.spec_durations').each_with_index do |line, index|
+      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 .spec_durations at line #{index + 1}")
+              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 .spec_durations at line #{index + 1}")
+              raise ShardError.new("fatal: invalid file path in .rspec-sharder-durations at line #{index + 1}")
             end
 
             unless File.exist?(file_path)
-              raise ShardError.new("fatal: file in .spec_durations not found at line #{index + 1}")
+              missing_files += 1
             end
 
             begin
               duration = Integer(parts[1])
             rescue ArgumentError => e
-              raise ShardError.new("fatal: invalid .spec_durations at line #{index + 1}")
+              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
@@ -165,19 +170,26 @@ module RSpec
     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
-          ::RSpec.configuration.output_stream.puts "warning: recorded duration not found for #{file_path}"
-
+          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.
@@ -222,7 +234,6 @@ module RSpec
     end
 
     def self.print_shards(shards)
-      ::RSpec.configuration.output_stream.puts
       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])}):"
@@ -235,9 +246,9 @@ module RSpec
     end
 
     def self.persist_durations(durations)
-      File.open(".spec_durations", "w+") do |file|
+      File.open(".rspec-sharder-durations", "w+") do |file|
         file.puts <<~EOF
-          # Generated by rspec-sharder on #{Time.now.to_s}.")
+          # 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|

data/scripts/release.sh

@@ -15,6 +15,8 @@ fi
 NEW_VERSION=$1
 CURRENT_VERSION=$(grep VERSION lib/rspec-sharder/version.rb | cut -d'"' -f 2)
 
+bundle exec rspec
+
 echo "Updating from v$CURRENT_VERSION to v$NEW_VERSION. Press enter to continue."
 read
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sharder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-28 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core