rspec_chunked 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76485af77917941cf4e9afbc37c5580077bb3943fb1b9bebdaa5c9ae3c83c8f4
+  data.tar.gz: 814d02ffe139f175ae2c2ef8bb2b64d14b8c8407ee37d381fcc00c333b072ee6
+SHA512:
+  metadata.gz: 87c877e3ef437d78d6dda51fa63e1c4168c046731891c587ff50db107778a24535427536d885d9f576aa016f10b8fdb91b42062ab9545df7bcbe9fdc4670562a
+  data.tar.gz: b0e7f004c432ada92eb8ed2997626e62f8c65ec7b3331af1d98a4d879481e460a05387a5cfcb5fcaadb275e9481193def45aa8cc7c36a38357735da05a322d35

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 owen2345
+
+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

@@ -0,0 +1,62 @@
+# RspecChunked
+This gem permits to run rspec tests in parallel by chunking tests into defined groups and balancing by file size.
+If ordering is not enough, permits to balance manually by moving x percentage of tests files from group A into group B.
+
+## Installation
+- Add this line to your application's Gemfile:
+```ruby
+  group :test do
+    gem 'rspec_chunked'
+  end
+```
+
+- And then execute:
+`bundle install`
+
+- Add manual balance
+```ruby
+  # config/initializers/rspec_chunked.rb
+  return unless defined?(RspecChunked::ChunkedTests)
+
+  RspecChunked::ChunkedTests.balance_settings =  { 1 => { to: 2, percentage: 15 }, 4 => { to: 3, percentage: 10 } }
+```
+Balance tests by moving 15% tests files from group 1 into group 2 and moving 10% tests files from group 4 into group 3
+
+## Usage
+` CI_JOBS=3 CI_JOB=1 rake rspec_chunked `
+- `CI_JOBS`: quantity of groups/workers to be split
+- `CI_JOB`: current group/worker to be executed, limit: 1 until CI_JOBS
+
+### Github workflow result
+- Before:    
+  ![Before](/docs/before.png?raw=true)
+
+- Current:    
+  ![Current](/docs/current.png?raw=true)   
+
+- Github workflow sample:
+  ````yaml
+  rspec_tests:
+    name: Rspec tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ci_job: [ 1, 2, 3, 4 ] # enumerize jobs
+    env:
+      CI_JOBS: 4 # define total jobs (must match with matrix above)
+  
+    steps:
+      - uses: actions/checkout@v2
+      - name: Backend tests
+        env:
+          CI_JOB: ${{ matrix.ci_job }}
+        run: docker-compose run test /bin/sh -c "CI_JOBS=$CI_JOBS CI_JOB=$CI_JOB rake rspec_chunked"
+
+  ````  
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/rspec_chunked. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RspecChunked'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rspec_chunked.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rspec_chunked/chunked_tests'
+module RspecChunked
+end

data/lib/rspec_chunked/chunked_tests.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RspecChunked
+  class ChunkedTests
+    class << self
+      attr_accessor :balance_settings
+    end
+    attr_accessor :qty_groups, :job_number, :balance_settings
+
+    def initialize(qty_groups, job_number)
+      @qty_groups = qty_groups
+      @job_number = job_number - 1
+      @balance_settings = self.class.balance_settings || {}
+    end
+
+    def run
+      balanced_tests = balance_tests(group_tests, balance_settings)
+      tests = balanced_tests[job_number]
+      qty = balanced_tests.flatten.count
+      Kernel.puts "**** running #{tests.count}/#{qty} tests (group number: #{job_number + 1})"
+      Kernel.exec "bundle exec rspec #{tests.join(' ')}"
+    end
+
+    private
+
+    def group_tests
+      res = Array.new(qty_groups).map { [] }
+      test_files.each_slice(qty_groups).each do |group|
+        group.each_with_index do |path, index|
+          res[index] << path
+        end
+      end
+      res
+    end
+
+    def test_files
+      Dir['spec/**/*_spec.rb'].sort_by do |path|
+        File.size(File.join(__dir__, '../', path)).to_f
+      end
+    end
+
+    # Balance tests by moving x percentage tests files from group 1 into group 2
+    # Sample balance_tests(data, { 1 => { to: 2, percentage: 15 }, 3 => { to: 0, percentage: 10 } })
+    # @return (Array) same array with balance applied tests
+    def balance_tests(data, balance_data)
+      balance_data.each do |index, info|
+        from = index - 1
+        to = info[:to] - 1
+        move_tests(data, from, to, info[:percentage]) if data[from] && data[to]
+      end
+      data
+    end
+
+    def move_tests(data, from, to, percentage)
+      qty_tests = ((data[from].count * percentage) / 100).round
+      moving_tests = data[from][-qty_tests..-1]
+      data[to] += moving_tests
+      data[from] -= moving_tests
+    end
+  end
+end

data/lib/rspec_chunked/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RspecChunked
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/rspec_chunked/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RspecChunked
+  VERSION = '0.1.0'
+end

data/lib/tasks/rspec_chunked_tasks.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+desc 'Run chunked rspec tests on specific qty, sample: CI_JOBS=3 CI_JOB=1 rake rspec_chunked'
+task :rspec_chunked do
+  qty_jobs = (ENV['CI_JOBS'] || 3).to_i
+  job_number = (ENV['CI_JOB'] || 1).to_i
+
+  service = RspecChunked::ChunkedTests.new(qty_jobs, job_number)
+  service.run
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rspec_chunked
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- owen2345
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+    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: rubocop
+  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'
+description: 'Run chunked rspec tests on specific qty, sample: CI_JOBS=3 CI_JOB=1
+  rake rspec_chunked'
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rspec_chunked.rb
+- lib/rspec_chunked/chunked_tests.rb
+- lib/rspec_chunked/railtie.rb
+- lib/rspec_chunked/version.rb
+- lib/tasks/rspec_chunked_tasks.rake
+homepage: https://github.com/owen2345/rspec_chunked
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: 'Run chunked rspec tests on specific qty, sample: CI_JOBS=3 CI_JOB=1 rake
+  rspec_chunked'
+test_files: []