test_suite_splitter 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf8e75ec7693f017eb21ec9ed18216b219800e85498f9e1445041dec1410b3dc
-  data.tar.gz: 14314af600cfa9a1afa087b912306ca11659867fa8f9bc62e4292ac6ac2a85cb
+  metadata.gz: 2bf5b723c5f3b7bc866531725c9d7127fdca1277d5c53079e9bb2751817342fc
+  data.tar.gz: 35b104aca369d17a0b256a732bb7aaa4c73eb60a7dfa3f028eec5c1d497ada40
 SHA512:
-  metadata.gz: 8f543e59a5bdc560c1dfbb9b904dca9be82682b142df14ad9a86b4c594c38169d0d27165e14102f4d36e1ee5e8e4d84aa5e131ac400e9657261742dbe9828167
-  data.tar.gz: 17be6115b41e1440e67b36441cc997eb3bb9468372644a836acbe7174239f8a1de056648ccad42fe992f6a0990e7530b38e7b9c02f58b208a77a0d4256692b01
+  metadata.gz: '08ae2c9be973a1b14b893ecc9517794ecf297d02aac5a8825346511803274edffd6866c01778fa460ca4c6d6d175c8735dbe19190a7b55a6654ccd5c3da3ec89'
+  data.tar.gz: 9138c299cd2fe61f270a57d6982e24a5ef9e2a66b35aa99b041aa3830925b6473efeaf45d7b46d21a3f42a15d3a04b2de819870dcf8ea8abb2606bb3c73ce4e7

data/README.md

@@ -12,11 +12,40 @@ Change your CI configuration file to execute something like this:
 bundle exec rspec `bundle exec test_suite_splitter --groups=6 --group-number=3`
 ```
 
-Or Semaphore that could be done dynamically like this:
+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}`
 ```
 
+Run only a certain type of specs:
+```bash
+bundle exec rspec `bundle exec test_suite_splitter --groups=6 --group-number=3 --only-types=system,model`
+```
+
+Exclude a certain type of specs:
+```bash
+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
+```
+
+`release:path` is available as an alias for the same flow.
+
 ## Contributing to test_suite_splitter
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/Rakefile

@@ -8,6 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require "rake"
+require_relative "lib/test_suite_splitter"
 task default: :test
 
 require "rdoc/task"
@@ -19,3 +20,12 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include("README*")
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
+
+namespace :release do
+  desc "Bump the patch version, commit it, push master, build the gem, and push it"
+  task :patch do
+    TestSuiteSplitter::Release.call(part: :patch)
+  end
+
+  task path: :patch
+end

data/bin/test_suite_splitter

@@ -4,26 +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
-
-rspec_helper = ::TestSuiteSplitter::RspecHelper.new(**args)
-
-print rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }.join(" ")
+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/release.rb

@@ -0,0 +1,69 @@
+module TestSuiteSplitter
+end
+
+class TestSuiteSplitter::Release
+  VERSION_FILE = File.expand_path("../../VERSION", __dir__)
+  GEMSPEC_FILE = "test_suite_splitter.gemspec".freeze
+  MASTER_BRANCH = "master".freeze
+
+  def self.call(part: :patch)
+    new(part: part).call
+  end
+
+  def initialize(part:)
+    @part = part.to_sym
+  end
+
+  def call
+    next_version = bumped_version
+    write_version(next_version)
+    run("git", "commit", "VERSION", GEMSPEC_FILE, "-m", "Release #{next_version}")
+    run("git", "push", "origin", MASTER_BRANCH)
+    run("gem", "build", GEMSPEC_FILE)
+    run("gem", "push", gem_file_name(next_version))
+    next_version
+  end
+
+private
+
+  attr_reader :part
+
+  def bumped_version
+    case part
+    when :patch, :path
+      major, minor, patch = current_version_segments
+      [major, minor, patch + 1].join(".")
+    else
+      raise ArgumentError, "Unsupported release part: #{part}"
+    end
+  end
+
+  def current_version
+    File.read(VERSION_FILE).strip
+  end
+
+  def current_version_segments
+    segments = current_version.split(".").map do |segment|
+      Integer(segment, 10)
+    rescue ArgumentError
+      raise ArgumentError, "Invalid version: #{current_version}"
+    end
+
+    raise ArgumentError, "Invalid version: #{current_version}" unless segments.length == 3
+
+    segments
+  end
+
+  def gem_file_name(version)
+    "test_suite_splitter-#{version}.gem"
+  end
+
+  def run(*command)
+    success = system(*command)
+    raise "Command failed: #{command.join(' ')}" unless success
+  end
+
+  def write_version(version)
+    File.write(VERSION_FILE, "#{version}\n")
+  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?
@@ -143,11 +144,11 @@ private
       require "stringio"
 
       output_capture = StringIO.new
-      RSpec::Core::Runner.run(rspec_options, $stderr, output_capture)
+      exit_code = RSpec::Core::Runner.run(rspec_options, $stderr, output_capture)
 
       result = ::JSON.parse(output_capture.string)
 
-      raise "No examples were found" if result.fetch("examples").empty?
+      raise dry_run_error_message(result: result, exit_code: exit_code) if result.fetch("examples").empty?
 
       result
     end
@@ -161,11 +162,14 @@ private
     @files ||= begin
       result = {}
       dry_result.fetch("examples").each do |example|
-        file_path = example.fetch("file_path")
+        file_path_id = example.fetch("id")
+        file_path = file_path_id.gsub(/\[([\d:]+)\]$/, "") # Same as ID but remove any [1:2:3] at the end
+
         file_path = file_path[2, file_path.length]
-        type = type_from_path(file_path)
+        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)
@@ -184,8 +188,16 @@ 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 == "feature" || type == "system"
+    if type == "system"
+      20
+    elsif type == "feature"
       10
     elsif type == "controllers"
       3
@@ -207,8 +219,21 @@ private
     rspec_options
   end
 
+  def dry_run_error_message(result:, exit_code:)
+    error_summary = []
+    errors_outside_of_examples_count = result.dig("summary", "errors_outside_of_examples_count")
+
+    error_summary << "exit_code=#{exit_code}"
+    error_summary << "errors_outside_of_examples_count=#{errors_outside_of_examples_count}" if errors_outside_of_examples_count.to_i.positive?
+
+    first_message = result.fetch("messages", []).find { |message| message.strip != "" }
+    details = first_message&.strip || "No examples were found"
+
+    "RSpec dry-run failed (#{error_summary.join(', ')})\n\n#{details}"
+  end
+
   def type_from_path(file_path)
-    match = file_path.match(/^spec\/(.+?)\//)
+    match = file_path.match(/^\.\/spec\/(.+?)\//)
     match[1] if match
   end
 end

data/lib/test_suite_splitter.rb

@@ -1,5 +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,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: test_suite_splitter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - kaspernj
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +37,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,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
@@ -93,14 +135,16 @@ 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
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Split your RSpec test suite up into several groups and run them in parallel.
 test_files: []