rspec_chunked 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc398c99a740b44f4503b351d0161a93db59a2ee50a87ce992d7863faf00278c
-  data.tar.gz: ac9a9e3cd8bd6dd05d4d20c191e8d59efba116a37be3f0fe8948e4267e11542d
+  metadata.gz: 126bfb5e31cdc7fc519a21d3b040bc6ff34227bbd55059cd3a195f1ef3575ea5
+  data.tar.gz: b5f82ce322ec832bc8acbd7022098a559adc93c4a309829e1f1801b2913180a5
 SHA512:
-  metadata.gz: 533b28d0ddf8b52d6502527889364fa80537fcfb1e0d5aec1406030b408cff5f98cdf3517b8795f410969cef87c1e509137a6f33a28869bbded20341f4a660e8
-  data.tar.gz: 5f40aa1988ce2b4350ffcc7e9e065617df4533bf37ad101ff8efab95944a53a6796d807463459ef2ac132dcf0069eb6f63bb99e3e91bdc906bda4162a3ea3f7d
+  metadata.gz: 264adcb2b6c8e52695240a7797c49a0406e915200eee2aecafef532662cf375249d1b9f1b18aa92b5194e140eef299b0f88b1bbbe49e621882724a68a657b79a
+  data.tar.gz: e652f96bec6139ac8fc03951333da1acdd3eab1f0d8eb4a2d88cc61ac7446adc8277b9f7d31f3c1de440dec8f998fc7d98abdf672e227e0b14eb07504bd4364f

data/README.md

@@ -1,6 +1,5 @@
 # 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.
+This gem permits running rspec tests in parallel by chunking tests into defined groups and balancing by file size. If the default order is not enough, it permits to balance manually by moving x percentage of test files from group A into group B.
 
 ## Installation
 - Add this line to your application's Gemfile:
@@ -13,24 +12,25 @@ If ordering is not enough, permits to balance manually by moving x percentage of
 - And then execute:
 `bundle install`
 
-- Add manual balance
-```ruby
-  # config/rspec_chunked.rb
-  if defined?(RspecChunked::ChunkedTests)
-    data = { 1 => { to: 2, percentage: 15 },
-             4 => { to: 3, percentage: 10 } }
-    RspecChunked::ChunkedTests.balance_settings = data
-  end
-```
-Balance tests by moving 15% tests files from group 1 into group 2 and moving 10% tests files from group 4 into group 3
+- Add manual balance (optional)
+  ```ruby
+    # config/rspec_chunked.rb
+    if defined?(RspecChunked::ChunkedTests)
+      data = { 1 => { to: 2, percentage: 15 },
+               4 => { to: 3, percentage: 10 } }
+      RspecChunked::ChunkedTests.balance_settings = data
+    end
+  ```
+  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
 - Basic initialization
   ` CI_JOBS=1/3 rake rspec_chunked`
 - Custom initialization
-  ` CI_JOBS=1/3 CI_CMD="bundle exec rspec ..." rake rspec_chunked`
+  ` CI_LOGIC=qty_specs CI_JOBS=1/3 CI_CMD="bundle exec rspec ..." rake rspec_chunked`
 - `CI_JOBS`: Current job number / quantity of groups/jobs to be split
 - `CI_CMD`: Custom rspec command
+- `CI_LOGIC`: Kind of logic to be used when ordering tests: `qty_specs` or `file_size` (by default `file_size`)
 
 ### Coverage merge reports (when using [simplecov](https://github.com/simplecov-ruby/simplecov#merging-test-runs-under-different-execution-environments))
 This task will merge all coverage reports
@@ -54,14 +54,12 @@ This task will merge all coverage reports
       matrix:
         ci_job: [ 1, 2, 3, 4 ] # enumerize jobs
     env:
-      CI_JOBS: 4 # define total jobs (must match with matrix above)
+      CI_JOBS: ${{ matrix.ci_job }}/4 # <current_job>/<total_jobs>
   
     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"
+        run: docker-compose run test /bin/sh -c "CI_JOBS=$CI_JOBS rake rspec_chunked"
 
   ````  
 

data/lib/rspec_chunked/chunked_tests.rb

@@ -5,11 +5,13 @@ module RspecChunked
     class << self
       attr_accessor :balance_settings
     end
-    attr_accessor :qty_groups, :job_number, :balance_settings, :cmd
+    attr_accessor :qty_groups, :job_number, :balance_settings, :cmd, :order_logic
 
-    def initialize(qty_groups, job_number, cmd: nil)
+    # @param order_logic (:qty_specs|:file_size*)
+    def initialize(qty_groups, job_number, cmd: nil, order_logic: :file_size)
       @qty_groups = qty_groups
       @job_number = job_number - 1
+      @order_logic = order_logic
       @balance_settings = self.class.balance_settings || {}
       @cmd = cmd || 'bundle exec rspec'
     end
@@ -18,7 +20,7 @@ module RspecChunked
       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.puts "**** running #{tests.count}/#{qty} test files (group number: #{job_number + 1})"
       Kernel.abort('failed running command') unless Kernel.system "#{cmd} #{tests.join(' ')}"
     end
 
@@ -36,10 +38,19 @@ module RspecChunked
 
     def test_files
       Dir['spec/**/*_spec.rb'].sort_by do |path|
-        File.size(File.join('./', path)).to_f
+        if order_logic == :qty_specs
+          count_specs_for(path)
+        else
+          File.size(File.join('./', path)).to_f
+        end
       end
     end
 
+    def count_specs_for(path)
+      body = File.read(File.join('./', path))
+      body.scan(/ it ['|"]/).count
+    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

data/lib/rspec_chunked/version.rb

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

data/lib/tasks/rspec_chunked_tasks.rake

@@ -3,8 +3,10 @@
 desc 'Run chunked rspec tests on specific qty, sample: CI_JOBS=3 CI_JOB=1 rake rspec_chunked'
 task :rspec_chunked do
   job_number, qty_jobs = (ENV['CI_JOBS'] || '1/3').split('/')
+  logic = (ENV['CI_LOGIC'] || :file_size).to_sym
   load_config
-  service = RspecChunked::ChunkedTests.new(qty_jobs.to_i, job_number.to_i, cmd: ENV['CI_CMD'])
+  service = RspecChunked::ChunkedTests.new(qty_jobs.to_i, job_number.to_i,
+                                           cmd: ENV['CI_CMD'], order_logic: logic)
   service.run
   copy_coverage(job_number)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_chunked
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler