rspec-big-split 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d3cf217b11c3eb3f3c55e2a5b72b7189d872f329da515628059f7d1ffa3f7c
-  data.tar.gz: ccb04637123dc99fdd8fa723e17458fc1340fc956206a93b9425beabc48cf31e
+  metadata.gz: 20f5e4c2f972d26054fa30ca2788fcd8047a9b06044d7ce3e6819517a766cca3
+  data.tar.gz: ccba4e1c22c523c049ead08e59d9bc42fd282ed3e975c7d7cea3a21fec0500fa
 SHA512:
-  metadata.gz: aabcdae89d712a55daef97a81933b568edaa71955e7b1cf3e838b8be074fbfb21fea5c3145822ca1bb52ec8691a30a79404aa3361e6410eec5759b6f4510b223
-  data.tar.gz: d00bd6b3b5f8c77fc6e9980ecf67fa05428e76484f3fd01847daf437a5245c8312e83c8f521ce82f25f3df4d29ab6a2c95d637fe77699e74da27574bbf70bee5
+  metadata.gz: d8cf84fa84d023337a0ac541344ea317db3877b57c6fe3947cc13ba90bf4ef09917872137687e8543eb2d84462972414dbd678c59a5a431709aee582bc20dc4e
+  data.tar.gz: 3be4b0b93b25f3a53cb41d06e305292e1855c6420f0e2f9ab62938ddc20d7288a57c4a9974273f8acdc572fb910738d4280574717946068695ac9dda38b6d5a7

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 iPePe.pl Open Source Software
+
+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.md

@@ -6,30 +6,17 @@ TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Execute this command to add gem to your application's Gemfile:
 
 ```ruby
-gem 'rspec-big-split'
+bundle add rspec-big-split
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rspec-big-split
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-big-split.
+1. Add `ci_split_example_groups: true` as metadata to your example groups (only for big files).
+2. Generate tests map with: `bundle exec rspec --dry-run --format Rspec::Big::Split::Formatter --out tmp/rspec_splitter.json`
+3. Define variables like `TEST_NODE_TOTAL=20` and `TEST_NODE_INDEX=0` in your CI/CD configuration.
+   * Make sure that your indexing starts with `1` and ends equal to `TEST_NODE_TOTAL`.
+4. (optional) Printout tests that will be run in current node: `bundle exec rspec-big-split tmp/rspec_splitter.json`
+5. Run tests with `bundle exec rspec $(bundle exec rspec-big-split tmp/rspec_splitter.json)` to run tests on each node.

data/exe/rspec-big-split

@@ -0,0 +1,45 @@
+#!/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+
+total_workers = ENV.fetch("TEST_NODE_TOTAL", "1").to_i
+this_worker_index = ENV.fetch("TEST_NODE_INDEX", "1").to_i
+
+warn "TEST_NODE_TOTAL=#{total_workers}"
+warn "TEST_NODE_INDEX=#{this_worker_index}"
+
+raise "TEST_NODE_INDEX must be between 1 and TEST_NODE_TOTAL" unless (1..total_workers).cover?(this_worker_index)
+
+# Load the examples from the JSON file
+if ARGV[0]
+  path = ARGV[0]
+  all_rspec_examples = JSON.parse(File.read(path))["examples"]
+
+  example_paths = {}
+
+  all_rspec_examples.map do |example|
+    if example["ci_split_example_groups"] || ARGV.include?("--split-by-example")
+      example_paths[example["id"]] ||= []
+      example_paths[example["id"]].push example["id"]
+    else
+      example_paths[example["file_path"]] ||= []
+      example_paths[example["file_path"]].push example["id"]
+    end
+  end
+
+  # Split the examples into groups
+  examples_to_run_for_current_worker = []
+  example_paths.keys.sort.each_with_index do |example, index|
+    next unless ((index % total_workers) - 1) == this_worker_index
+
+    examples_to_run_for_current_worker.concat(
+      example_paths[example]
+    )
+  end
+  warn "Suggesting #{examples_to_run_for_current_worker.size}/#{example_paths.size} examples on worker #{this_worker_index}"
+  $stdout.puts examples_to_run_for_current_worker
+else
+  warn "Usage: rspec-big-split <path to JSON file>"
+  exit 1
+end

data/lib/rspec/big/split/formatter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rspec/core/formatters/json_formatter"
+
+module Rspec
+  module Big
+    module Split
+      class Formatter < ::RSpec::Core::Formatters::JsonFormatter
+        ::RSpec::Core::Formatters.register self
+
+        private
+
+        def format_example(example)
+          {
+            id: example.id,
+            ci_split_example_groups: example.metadata[:ci_split_example_groups],
+            example_group_id: example.example_group.id
+          }.merge(super.slice(:file_path))
+        end
+      end
+    end
+  end
+end

data/lib/rspec/big/split/version.rb

@@ -3,7 +3,7 @@
 module Rspec
   module Big
     module Split
-      VERSION = "0.1.0"
+      VERSION = "0.3.1"
     end
   end
 end

data/lib/rspec/big/split.rb

@@ -1,12 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "split/version"
-
-module Rspec
-  module Big
-    module Split
-      class Error < StandardError; end
-      # Your code goes here...
-    end
-  end
-end
+require_relative "split/formatter"

data/rspec-big-split.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables   = ["rspec-big-split"]
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "rspec-core", "~> 3"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,19 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: rspec-big-split
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Patryk Ptasinski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
-dependencies: []
-description: 
+date: 2024-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description:
 email:
 - patryk@ipepe.pl
-executables: []
+executables:
+- rspec-big-split
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,11 +37,14 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- exe/rspec-big-split
 - lib/rspec/big/split.rb
+- lib/rspec/big/split/formatter.rb
 - lib/rspec/big/split/version.rb
 - publish.sh
 - rspec-big-split.gemspec
@@ -37,7 +55,7 @@ metadata:
   homepage_uri: https://github.com/ipepe-oss/rspec-big-split
   source_code_uri: https://github.com/ipepe-oss/rspec-big-split
   changelog_uri: https://github.com/ipepe-oss/rspec-big-split
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Split one big RSpec test file into many smaller ones for parallel execution
 test_files: []