test_suite_splitter 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e8eca9c33b9e9db919f0e2a8a7aa816217e054f17785b22411c0196315591e8
-  data.tar.gz: 8618f272307e0b5967c89822f18b3e4f0d6c425cf3011e294b2c4ce634e83ef0
+  metadata.gz: ac2544ca288e5c7cb4c154043483963b1dbc9f7666c058caca6b89da805a8e2a
+  data.tar.gz: 6dc90fe1986b9f55b7aa82dda12c1545e566ed3830725d72bda19fbd863cedbd
 SHA512:
-  metadata.gz: 188817535dd7829b1c2513071165287c76b405100365464744636639af514004f511aa8859da73a302d7b65127784e2a57d14fdc2ece24eeb546e076252b1ee1
-  data.tar.gz: 69f7f346e5dc3c6708b58e36ec55ab1d9990745fa5382479611a136318bd5f08008a478a2e47f7033f9545461b7ed61576d9178998f3d6b4779d5cb0dfaf3c18
+  metadata.gz: 6ee0867d88f4e7ffcc864ac2fad277071d8cf15e85bea3bdbf107ac8254ac276746d6a6e218ce31667a58779162c51871c61cb55e60319638d25f907130658ab
+  data.tar.gz: c4d31874181ec420bbc0e28e6e2b494bbb540513c91fa0e75112eabed4f6de1d6ae9090815a2aade27ee6eb1ef42d927ffb665052f53c0bb23b0d4f01f14223c

data/README.md

@@ -0,0 +1,50 @@
+# test_suite_splitter
+
+Add it to your Gemfile:
+```ruby
+group :test do
+  gem "test_suite_splitter", require: false
+end
+```
+
+Change your CI configuration file to execute something like this:
+```bash
+bundle exec rspec `bundle exec test_suite_splitter --groups=6 --group-number=3`
+```
+
+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`
+```
+
+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.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2021 kaspernj. See LICENSE.txt for
+further details.

data/Rakefile

@@ -8,33 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require "rake"
-require "juwelier"
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "test_suite_splitter"
-  gem.homepage = "http://github.com/kaspernj/test_suite_splitter"
-  gem.license = "MIT"
-  gem.summary = "Split your RSpec test suite up into several groups and run them in parallel."
-  gem.description = "Split your RSpec test suite up into several groups and run them in parallel."
-  gem.email = "k@spernj.org"
-  gem.authors = ["kaspernj"]
-
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-require "rake/testtask"
-Rake::TestTask.new(:test) do |test|
-  test.libs << "lib" << "test"
-  test.pattern = "test/**/test_*.rb"
-  test.verbose = true
-end
-
-desc "Code coverage detail"
-task :simplecov do
-  ENV["COVERAGE"] = "true"
-  Rake::Task["test"].execute
-end
-
+require_relative "lib/test_suite_splitter"
 task default: :test
 
 require "rdoc/task"
@@ -46,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

@@ -6,16 +6,29 @@ require "#{__dir__}/../lib/test_suite_splitter"
 
 args = {}
 ARGV.each do |arg|
-  if (match = arg.match(/\A--(.+?)=(.+)\Z/))
-    args[match[1]] = match[2]
+  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(
-  groups: args.fetch("groups").to_i,
-  group_number: args.fetch("group-number").to_i,
-  only_types: args["only-types"]&.split(","),
-  tags: args["tags"]&.split(",")
-)
+begin
+  rspec_helper = ::TestSuiteSplitter::RspecHelper.new(**args)
 
-print rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }.join(" ")
+  print rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }.join(" ")
+rescue StandardError => e
+  puts e.message
+  exit 1
+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,7 +1,8 @@
 class TestSuiteSplitter::RspecHelper
-  attr_reader :only_types, :tags
+  attr_reader :exclude_types, :only_types, :tags
 
-  def initialize(groups:, group_number:, only_types: nil, tags: nil)
+  def initialize(groups:, group_number:, exclude_types: nil, only_types: nil, tags: nil)
+    @exclude_types = exclude_types
     @groups = groups
     @group_number = group_number
     @example_data_exists = File.exist?("spec/examples.txt")
@@ -142,11 +143,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
@@ -160,9 +161,11 @@ 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_type?(type)
@@ -177,11 +180,16 @@ private
   end
 
   def ignore_type?(type)
-    only_types && !only_types.include?(type) # rubocop:disable: Style/SafeNavigation
+    return true if only_types && !only_types.include?(type)
+    return true if exclude_types&.include?(type)
+
+    false
   end
 
   def points_from_type(type)
-    if type == "feature" || type == "system"
+    if type == "system"
+      20
+    elsif type == "feature"
       10
     elsif type == "controllers"
       3
@@ -203,8 +211,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,6 @@
 module TestSuiteSplitter
   path = "#{__dir__}/test_suite_splitter"
 
+  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.1
+  version: 0.0.3
 platform: ruby
 authors:
 - kaspernj
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 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
@@ -25,7 +38,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  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:
     - - ">="
@@ -101,29 +128,20 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
-- ".document"
-- ".rubocop.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
 - bin/test_suite_splitter
 - lib/test_suite_splitter.rb
+- lib/test_suite_splitter/release.rb
 - lib/test_suite_splitter/rspec_helper.rb
-- peak_flow.yml
-- spec/spec_helper.rb
-- spec/test_suite_splitter/rspec_helper/nemoa_rspec_output.json
-- spec/test_suite_splitter/rspec_helper_spec.rb
-- test_suite_splitter.gemspec
 homepage: http://github.com/kaspernj/test_suite_splitter
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -131,15 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-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: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rubocop.yml

@@ -1,195 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  NewCops: enable
-  TargetRubyVersion: 2.7
-
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-Layout/AccessModifierIndentation:
-  EnforcedStyle: outdent
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-Layout/EmptyLines:
-  Enabled: false
-
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-Layout/LineLength:
-  Max: 160
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/RescueEnsureAlignment:
-  Enabled: false
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/FloatComparison:
-  Enabled: false
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-# Metrics/AbcSize:
-#   Max: 25
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 250
-
-Metrics/AbcSize:
-  Max: 29
-
-Metrics/CyclomaticComplexity:
-  Max: 13
-
-Metrics/MethodLength:
-  Max: 50
-
-Metrics/PerceivedComplexity:
-  Max: 15
-
-RSpec/AnyInstance:
-  Enabled: false
-
-RSpec/ContextWording:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/DescribedClass:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-RSpec/LetSetup:
-  Enabled: false
-
-RSpec/MessageSpies:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Enabled: false
-
-# This can make expectaions look weird: Prefer using be_rvm_in_build_config matcher over rvm_in_build_config?
-RSpec/PredicateMatcher:
-  Enabled: false
-
-RSpec/StubbedMock:
-  Enabled: false
-
-Style/CaseLikeIf:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/ExplicitBlockArgument:
-  Enabled: false
-
-Style/ExponentialNotation:
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# Will report offences for many places that are much more readable without using a guard clause
-Style/GuardClause:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/Lambda:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/MultipleComparison:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: false
-
-Style/NilComparison:
-  Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/SlicingWithRange:
-  Enabled: true
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/TrivialAccessors:
-  ExactNameMatch: true
-  Enabled: true
-
-Style/WordArray:
-  Enabled: false

data/Gemfile

@@ -1,18 +0,0 @@
-source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "bundler"
-  gem "juwelier"
-end
-
-group :development, :test do
-  gem "rspec"
-  gem "rubocop"
-  gem "rubocop-performance"
-  gem "rubocop-rspec"
-end