test_suite_splitter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e8eca9c33b9e9db919f0e2a8a7aa816217e054f17785b22411c0196315591e8
+  data.tar.gz: 8618f272307e0b5967c89822f18b3e4f0d6c425cf3011e294b2c4ce634e83ef0
+SHA512:
+  metadata.gz: 188817535dd7829b1c2513071165287c76b405100365464744636639af514004f511aa8859da73a302d7b65127784e2a57d14fdc2ece24eeb546e076252b1ee1
+  data.tar.gz: 69f7f346e5dc3c6708b58e36ec55ab1d9990745fa5382479611a136318bd5f08008a478a2e47f7033f9545461b7ed61576d9178998f3d6b4779d5cb0dfaf3c18

data/.document

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

data/.rubocop.yml

@@ -0,0 +1,195 @@
+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

@@ -0,0 +1,18 @@
+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

data/Gemfile.lock

@@ -0,0 +1,126 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    git (1.9.1)
+      rchardet (~> 1.8)
+    github_api (0.19.0)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (>= 0.8, < 2)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashie (3.6.0)
+    highline (2.0.3)
+    juwelier (2.4.9)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (2.3.0)
+    kamelcase (0.0.2)
+      semver2 (~> 3)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    psych (4.0.2)
+    public_suffix (4.0.6)
+    racc (1.6.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rchardet (1.8.0)
+    rdoc (6.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    semver2 (3.4.2)
+    thread_safe (0.3.6)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  juwelier
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.28

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 kaspernj
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= test_suite_splitter
+
+Description goes here.
+
+== 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

@@ -0,0 +1,48 @@
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  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
+
+task default: :test
+
+require "rdoc/task"
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "test_suite_splitter #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/test_suite_splitter

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+# This task detects and prints out the RSpec files for the current build group
+
+require "#{__dir__}/../lib/test_suite_splitter"
+
+args = {}
+ARGV.each do |arg|
+  if (match = arg.match(/\A--(.+?)=(.+)\Z/))
+    args[match[1]] = match[2]
+  end
+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(",")
+)
+
+print rspec_helper.group_files.map { |group_file| group_file.fetch(:path) }.join(" ")

data/lib/test_suite_splitter/rspec_helper.rb

@@ -0,0 +1,210 @@
+class TestSuiteSplitter::RspecHelper
+  attr_reader :only_types, :tags
+
+  def initialize(groups:, group_number:, only_types: nil, tags: nil)
+    @groups = groups
+    @group_number = group_number
+    @example_data_exists = File.exist?("spec/examples.txt")
+    @only_types = only_types
+    @tags = tags
+  end
+
+  def example_data_exists?
+    @example_data_exists
+  end
+
+  def example_data
+    @example_data ||= begin
+      raw_data = File.read("spec/examples.txt")
+
+      result = []
+      raw_data.scan(/^\.\/(.+)\[(.+?)\]\s+\|\s+(.+?)\s+\|\s+((.+?) seconds|)\s+\|$/) do |match|
+        file_path = match[0]
+        spec_result = match[1]
+        seconds = match[4]&.to_f
+
+        spec_data = {
+          file_path: file_path,
+          spec_result: spec_result,
+          seconds: seconds
+        }
+
+        result << spec_data
+      end
+
+      result
+    end
+  end
+
+  def example_files
+    @example_files ||= begin
+      files = {}
+      example_data.each do |spec_data|
+        file_path = spec_data.fetch(:file_path)
+        seconds = spec_data.fetch(:seconds)
+
+        files[file_path] ||= {examples: 0, seconds: 0.0}
+        files[file_path][:examples] += 1
+        files[file_path][:seconds] += seconds if seconds
+      end
+
+      files
+    end
+  end
+
+  def example_file(path)
+    example_files[path]
+  end
+
+  def group_files
+    return @group_files if @group_files
+
+    sorted_files.each do |file|
+      file_path = file.fetch(:path)
+      file_data = example_file(file_path) if example_data_exists?
+
+      if file_data
+        examples = file_data.fetch(:examples)
+        seconds = file_data.fetch(:seconds)
+      else
+        examples = file.fetch(:examples)
+      end
+
+      group = group_with_least
+      group[:examples] += examples
+      group[:files] << file
+      group[:seconds] += seconds if seconds
+    end
+
+    @group_files = group_orders[@group_number - 1].fetch(:files)
+  end
+
+  def group_orders
+    @group_orders ||= begin
+      group_orders = []
+      @groups.times do
+        group_orders << {
+          examples: 0,
+          files: [],
+          seconds: 0.0
+        }
+      end
+      group_orders
+    end
+  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
+  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
+  def sorted_files
+    files.values.sort do |file1, file2|
+      file1_path = file1.fetch(:path)
+      file2_path = file2.fetch(:path)
+
+      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
+
+      if value1 == value2
+        value2 = file1_path
+        value1 = file2_path
+      end
+
+      value2 <=> value1
+    end
+  end
+
+private
+
+  def dry_result
+    @dry_result ||= begin
+      require "json"
+      require "rspec/core"
+      require "stringio"
+
+      output_capture = StringIO.new
+      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?
+
+      result
+    end
+  end
+
+  def dry_file(path)
+    files.fetch(path)
+  end
+
+  def files
+    @files ||= begin
+      result = {}
+      dry_result.fetch("examples").each do |example|
+        file_path = example.fetch("file_path")
+        file_path = file_path[2, file_path.length]
+        type = type_from_path(file_path)
+        points = points_from_type(type)
+
+        next if ignore_type?(type)
+
+        result[file_path] = {examples: 0, path: file_path, points: 0, type: type} unless result.key?(file_path)
+        result[file_path][:examples] += 1
+        result[file_path][:points] += points
+      end
+
+      result
+    end
+  end
+
+  def ignore_type?(type)
+    only_types && !only_types.include?(type) # rubocop:disable: Style/SafeNavigation
+  end
+
+  def points_from_type(type)
+    if type == "feature" || type == "system"
+      10
+    elsif type == "controllers"
+      3
+    else
+      1
+    end
+  end
+
+  def rspec_options
+    rspec_options = ["--dry-run", "--format", "json"]
+
+    tags&.each do |tag|
+      rspec_options += ["--tag", tag]
+    end
+
+    # Add the folder with all the specs, which is required when running programmatically
+    rspec_options << "spec"
+
+    rspec_options
+  end
+
+  def type_from_path(file_path)
+    match = file_path.match(/^spec\/(.+?)\//)
+    match[1] if match
+  end
+end

data/lib/test_suite_splitter.rb

@@ -0,0 +1,5 @@
+module TestSuiteSplitter
+  path = "#{__dir__}/test_suite_splitter"
+
+  autoload :RspecHelper, "#{path}/rspec_helper"
+end

data/peak_flow.yml

@@ -0,0 +1,4 @@
+rvm: true
+script:
+  - bundle exec rspec
+  - bundle exec rubocop