test_suite_splitter 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2544ca288e5c7cb4c154043483963b1dbc9f7666c058caca6b89da805a8e2a
-  data.tar.gz: 6dc90fe1986b9f55b7aa82dda12c1545e566ed3830725d72bda19fbd863cedbd
+  metadata.gz: 87ca0053702cb8904a2856c58df606e3bd8f12a48cf98e0edc804c7959d9655a
+  data.tar.gz: 9a3b00d07bf4ad69343b1ffc3229914b05b7aa4d138f4446331ad056af23c5f9
 SHA512:
-  metadata.gz: 6ee0867d88f4e7ffcc864ac2fad277071d8cf15e85bea3bdbf107ac8254ac276746d6a6e218ce31667a58779162c51871c61cb55e60319638d25f907130658ab
-  data.tar.gz: c4d31874181ec420bbc0e28e6e2b494bbb540513c91fa0e75112eabed4f6de1d6ae9090815a2aade27ee6eb1ef42d927ffb665052f53c0bb23b0d4f01f14223c
+  metadata.gz: d53b1810eb33ea334e3ce519794112e7c9ec44d9f458e11488058bd5c999a20405d0cba1c55e0d70087ef1f1b871c2632ae6d1c53acf4b8f1435a620fdf23e82
+  data.tar.gz: 722e776eadb0266991e96da7f1a64b40b77ca3bfd5c335fe4cdeea5bd2d338260dba602f0127c252d8048e9ad7c232c62abe06db17b4d0d540bf124fe076d4d8

data/README.md

@@ -12,6 +12,11 @@ Change your CI configuration file to execute something like this:
 bundle exec rspec `bundle exec test_suite_splitter --groups=6 --group-number=3`
 ```
 
+Or let `test_suite_splitter` run RSpec directly:
+```bash
+bundle exec test_suite_splitter_rspec --groups=6 --group-number=3 -- --format documentation
+```
+
 On Semaphore that could be done dynamically like this:
 ```bash
 bundle exec rspec `bundle exec test_suite_splitter --groups=${SEMAPHORE_JOB_COUNT} --group-number=${SEMAPHORE_JOB_INDEX}`
@@ -27,6 +32,13 @@ Exclude a certain type of specs:
 bundle exec rspec `bundle exec test_suite_splitter --groups=6 --group-number=3 --exclude-types=system,feature`
 ```
 
+Exclude file paths by prefix:
+```bash
+bundle exec test_suite_splitter_rspec --groups=6 --group-number=3 --exclude-path-prefixes=spec/system/projects/project_environments_terminal_e2e_spec/ -- --format documentation
+```
+
+When the dry run fails, `test_suite_splitter` writes the failure output to `log/test_suite_splitter.log` by default. Override that path with `--log-file=path/to/file.log`.
+
 Release a new gem version:
 ```bash
 bundle exec rake release:patch

data/bin/test_suite_splitter

@@ -4,31 +4,4 @@
 
 require "#{__dir__}/../lib/test_suite_splitter"
 
-args = {}
-ARGV.each do |arg|
-  match = arg.match(/\A--(.+?)=(.+)\Z/)
-  raise "Couldn't match argument: #{arg}" unless match
-
-  key = match[1]
-  hash_key = key.tr("-", "_").to_sym
-  value = match[2]
-
-  if key == "exclude-types" || key == "only-types" || key == "tags"
-    value = value.split(",")
-  elsif key == "group-number" || key == "groups"
-    value = value.to_i
-  else
-    raise "Unknown argument: #{key}"
-  end
-
-  args[hash_key] = value
-end
-
-begin
-  rspec_helper = ::TestSuiteSplitter::RspecHelper.new(**args)
-
-  print rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }.join(" ")
-rescue StandardError => e
-  puts e.message
-  exit 1
-end
+exit(TestSuiteSplitter::Cli.new(argv: ARGV).execute_splitter_command)

data/bin/test_suite_splitter_rspec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "#{__dir__}/../lib/test_suite_splitter"
+
+exit(TestSuiteSplitter::Cli.new(argv: ARGV).execute_rspec_command)

data/lib/test_suite_splitter/cli.rb

@@ -0,0 +1,124 @@
+class TestSuiteSplitter::Cli
+  DEFAULT_LOG_FILE_PATH = "log/test_suite_splitter.log".freeze
+
+  attr_reader :argv, :stderr, :stdout
+
+  def initialize(argv:, stderr: $stderr, stdout: $stdout)
+    @argv = argv
+    @stderr = stderr
+    @stdout = stdout
+  end
+
+  def execute_splitter_command
+    print_output(group_file_paths.join(" "))
+    0
+  rescue StandardError => e
+    handle_error(e)
+  end
+
+  def execute_rspec_command
+    files = group_file_paths
+
+    if files.empty?
+      print_output("No files from test_suite_splitter - skipping shard")
+      return 0
+    end
+
+    require "rspec/core"
+
+    RSpec::Core::Runner.run(rspec_arguments + files, stderr, stdout)
+  rescue StandardError => e
+    handle_error(e)
+  end
+
+  def group_file_paths
+    rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }
+  end
+
+private
+
+  def handle_error(error)
+    message = error.message
+
+    write_log(message)
+    print_output("#{message}\n\nLogged to #{log_file_path}")
+
+    1
+  end
+
+  def write_log(message)
+    require "fileutils"
+
+    FileUtils.mkdir_p(File.dirname(log_file_path))
+    File.write(log_file_path, "#{message}\n")
+  end
+
+  def print_output(message)
+    stdout.print(message)
+  end
+
+  def log_file_path
+    @parsed_arguments&.fetch(:log_file) || DEFAULT_LOG_FILE_PATH
+  end
+
+  def rspec_helper
+    @rspec_helper ||= TestSuiteSplitter::RspecHelper.new(**splitter_arguments)
+  end
+
+  def splitter_arguments
+    parsed_arguments.slice(:exclude_path_prefixes, :exclude_types, :group_number, :groups, :only_types, :tags)
+  end
+
+  def rspec_arguments
+    parsed_arguments.fetch(:rspec_arguments)
+  end
+
+  def parsed_arguments
+    @parsed_arguments ||= begin
+      result = {
+        exclude_path_prefixes: nil,
+        exclude_types: nil,
+        log_file: DEFAULT_LOG_FILE_PATH,
+        only_types: nil,
+        rspec_arguments: [],
+        tags: nil
+      }
+      parsing_splitter_arguments = true
+
+      argv.each do |arg|
+        if parsing_splitter_arguments && arg == "--"
+          parsing_splitter_arguments = false
+          next
+        end
+
+        if parsing_splitter_arguments
+          key, value = parse_argument(arg)
+          result[key] = value
+        else
+          result[:rspec_arguments] << arg
+        end
+      end
+
+      result
+    end
+  end
+
+  def parse_argument(argument)
+    match = argument.match(/\A--(.+?)=(.+)\Z/)
+    raise "Couldn't match argument: #{argument}" unless match
+
+    key = match[1]
+    value = match[2]
+
+    case key
+    when "exclude-path-prefixes", "exclude-types", "only-types", "tags"
+      [key.tr("-", "_").to_sym, value.split(",")]
+    when "group-number", "groups"
+      [key.tr("-", "_").to_sym, value.to_i]
+    when "log-file"
+      [:log_file, value]
+    else
+      raise "Unknown argument: #{key}"
+    end
+  end
+end

data/lib/test_suite_splitter/rspec_helper.rb

@@ -1,13 +1,14 @@
 class TestSuiteSplitter::RspecHelper
-  attr_reader :exclude_types, :only_types, :tags
+  attr_reader :exclude_path_prefixes, :exclude_types, :only_types, :tags
 
-  def initialize(groups:, group_number:, exclude_types: nil, only_types: nil, tags: nil)
-    @exclude_types = exclude_types
+  def initialize(groups:, group_number:, **options)
+    @exclude_path_prefixes = options[:exclude_path_prefixes]
+    @exclude_types = options[:exclude_types]
     @groups = groups
     @group_number = group_number
     @example_data_exists = File.exist?("spec/examples.txt")
-    @only_types = only_types
-    @tags = tags
+    @only_types = options[:only_types]
+    @tags = options[:tags]
   end
 
   def example_data_exists?
@@ -75,6 +76,7 @@ class TestSuiteSplitter::RspecHelper
       group[:examples] += examples
       group[:files] << file
       group[:seconds] += seconds if seconds
+      group[:weight] += file_weight(file, file_data)
     end
 
     @group_files = group_orders[@group_number - 1].fetch(:files)
@@ -87,7 +89,8 @@ class TestSuiteSplitter::RspecHelper
         group_orders << {
           examples: 0,
           files: [],
-          seconds: 0.0
+          seconds: 0.0,
+          weight: 0.0
         }
       end
       group_orders
@@ -95,13 +98,7 @@ class TestSuiteSplitter::RspecHelper
   end
 
   def group_with_least
-    group_orders.min do |group1, group2|
-      if example_data_exists? && group1.fetch(:seconds) != 0.0 && group2.fetch(:seconds) != 0.0
-        group1.fetch(:seconds) <=> group2.fetch(:seconds)
-      else
-        group1.fetch(:examples) <=> group2.fetch(:examples)
-      end
-    end
+    group_orders.min_by { |group| group.fetch(:weight) }
   end
 
   # Sort them so that they are sorted by file path in three groups so each group have an equal amount of controller specs, features specs and so on
@@ -113,17 +110,8 @@ class TestSuiteSplitter::RspecHelper
       file1_data = example_file(file1_path) if example_data_exists?
       file2_data = example_file(file2_path) if example_data_exists?
 
-      if file1_data && file2_data && file1_data.fetch(:seconds) != 0.0 && file2_data.fetch(:seconds) != 0.0
-        value1 = file1_data[:seconds]
-      else
-        value1 = file1.fetch(:points)
-      end
-
-      if file2_data && file1_data && file2_data.fetch(:seconds) != 0.0 && file2_data.fetch(:seconds) != 0.0
-        value2 = file2_data[:seconds]
-      else
-        value2 = file2.fetch(:points)
-      end
+      value1 = file_weight(file1, file1_data)
+      value2 = file_weight(file2, file2_data)
 
       if value1 == value2
         value2 = file1_path
@@ -136,6 +124,13 @@ class TestSuiteSplitter::RspecHelper
 
 private
 
+  def file_weight(file, file_data)
+    seconds = file_data&.fetch(:seconds)
+    return seconds if seconds&.positive?
+
+    file.fetch(:points)
+  end
+
   def dry_result
     @dry_result ||= begin
       require "json"
@@ -168,6 +163,7 @@ private
         type = type_from_path(file_path_id)
         points = points_from_type(type)
 
+        next if ignore_path?(file_path)
         next if ignore_type?(type)
 
         result[file_path] = {examples: 0, path: file_path, points: 0, type: type} unless result.key?(file_path)
@@ -186,6 +182,12 @@ private
     false
   end
 
+  def ignore_path?(file_path)
+    exclude_path_prefixes&.any? do |exclude_path_prefix|
+      file_path.start_with?(exclude_path_prefix)
+    end
+  end
+
   def points_from_type(type)
     if type == "system"
       20

data/lib/test_suite_splitter.rb

@@ -1,6 +1,7 @@
 module TestSuiteSplitter
   path = "#{__dir__}/test_suite_splitter"
 
+  autoload :Cli, "#{path}/cli"
   autoload :Release, "#{path}/release"
   autoload :RspecHelper, "#{path}/rspec_helper"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_suite_splitter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - kaspernj
@@ -125,6 +125,7 @@ description: Split your RSpec test suite up into several groups and run them in
 email: k@spernj.org
 executables:
 - test_suite_splitter
+- test_suite_splitter_rspec
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -134,7 +135,9 @@ files:
 - README.md
 - Rakefile
 - bin/test_suite_splitter
+- bin/test_suite_splitter_rspec
 - lib/test_suite_splitter.rb
+- lib/test_suite_splitter/cli.rb
 - lib/test_suite_splitter/release.rb
 - lib/test_suite_splitter/rspec_helper.rb
 homepage: http://github.com/kaspernj/test_suite_splitter