knapsack_pro 8.3.3 → 8.4.0

data/spec/knapsack_pro/formatters/time_tracker_spec.rb

@@ -0,0 +1,448 @@
+require 'open3'
+require 'tmpdir'
+
+describe 'TimeTracker' do
+  around(:each) do |example|
+    Dir.mktmpdir(nil, 'spec_time_tracker') do |dir|
+      @dir = dir
+      example.run
+    end
+  end
+
+  describe '#queue' do
+    it 'single example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+
+    it 'two files' do
+      spec0 = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 1' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      spec1 = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 2' do
+          it do
+            sleep 0.2
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs([spec0, spec1], 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(2)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+        expect(queue[1]['path']).to eq(spec_paths[1])
+        expect(queue[1]['time_execution']).to be_between(0.20, 0.25)
+      end
+    end
+
+    it 'failing example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 2
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+
+    it 'pending example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          xit do
+            sleep 0.1
+            expect(1).to eq 2
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+
+    it 'multiple top level groups' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 1' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker 2' do
+          it do
+            sleep 0.2
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.30, 0.35)
+      end
+    end
+
+    it 'rspec split by test example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker 1' do
+          it do
+            expect(1).to eq 1
+          end
+
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker 2' do
+          it do
+            sleep 0.2
+            expect(1).to eq 1
+          end
+
+          it do
+            sleep 0.3
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(4)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.00, 0.05).exclusive
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2]" }['time_execution']).to be_between(0.10, 0.15)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[2:1]" }['time_execution']).to be_between(0.20, 0.25)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[2:2]" }['time_execution']).to be_between(0.30, 0.35)
+      end
+    end
+
+    it 'hooks' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          before(:each) do
+            sleep 0.1
+          end
+
+          after(:each) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.60, 0.65)
+      end
+    end
+
+    it 'nested hooks' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to be_between(0.60, 0.65)
+      end
+    end
+
+    it 'hooks with rspec split by test example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          before(:each) do
+            sleep 0.1
+          end
+
+          after(:each) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(2)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.40, 0.45)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2]" }['time_execution']).to be_between(0.40, 0.45)
+      end
+    end
+
+    it 'nested hooks with rspec split by test example' do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+
+          describe do
+            before(:all) do
+              sleep 0.1
+            end
+
+            after(:all) do
+              sleep 0.1
+            end
+
+            it do
+              expect(1).to eq 1
+            end
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__SBTE=1') do |spec_paths, queue|
+        expect(queue.size).to eq(3)
+
+        spec_path = spec_paths[0]
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:1]" }['time_execution']).to be_between(0.20, 0.25)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:2:1]" }['time_execution']).to be_between(0.40, 0.45)
+        expect(queue.find { |time| time['path'] == "#{spec_path}[1:3:1]" }['time_execution']).to be_between(0.40, 0.45)
+      end
+    end
+
+    it 'unknown path' do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:all) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'queue', env: 'TEST__EMPTY_FILE_PATH=1') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+
+    it 'empty group' do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:suite) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+        end
+      SPEC
+
+      run_specs(spec, 'queue') do |spec_paths, queue|
+        expect(queue.size).to eq(1)
+        expect(queue[0]['path']).to eq(spec_paths[0])
+        expect(queue[0]['time_execution']).to eq(0.0)
+      end
+    end
+  end
+
+  describe '#duration' do
+    it do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'duration') do |_, duration|
+        expect(duration).to be_between(0.00, 0.05).exclusive
+      end
+    end
+  end
+
+  describe '#unexecuted_test_files' do
+    it do
+      spec = <<~SPEC
+        RSpec.configure do |config|
+          config.before(:all) do
+            time_tracker = ::RSpec.configuration.formatters.find { |f| f.class.to_s == 'TestableTimeTracker' }
+            time_tracker.scheduled_paths = ['#{@dir}/0_spec.rb', 'foo_spec.rb[1:1]']
+          end
+        end
+
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          xit do
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'unexecuted_test_files') do |spec_paths, unexecuted_test_files|
+        expect(unexecuted_test_files).to eq(["#{@dir}/0_spec.rb", 'foo_spec.rb[1:1]'])
+      end
+    end
+  end
+
+  describe '#batch' do
+    it do
+      spec = <<~SPEC
+        describe 'KnapsackPro::Formatters::TimeTracker' do
+          it do
+            sleep 0.1
+            expect(1).to eq 1
+          end
+        end
+      SPEC
+
+      run_specs(spec, 'batch') do |spec_paths, batch|
+        expect(batch.size).to eq(1)
+        expect(batch[0]['path']).to eq(spec_paths[0])
+        expect(batch[0]['time_execution']).to be_between(0.10, 0.15)
+      end
+    end
+  end
+
+  def run_specs(specs, method, env: '')
+    paths = Array(specs).map.with_index do |spec, i|
+      path = "#{@dir}/#{i}_spec.rb"
+      File.write(path, spec)
+      path
+    end
+
+    out, err, _status = Open3.capture3("#{env} TEST__METHOD=#{method} bundle exec rspec --default-path spec_time_tracker -f TestableTimeTracker spec_time_tracker")
+    puts err if ENV['TEST__DEBUG']
+    result = Marshal.load(out.lines.last)
+
+    yield(paths, result)
+  end
+end

data/spec_time_tracker/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'knapsack_pro'
+require_relative '../lib/knapsack_pro/formatters/time_tracker'
+
+class TestableTimeTracker < KnapsackPro::Formatters::TimeTracker
+  ::RSpec::Core::Formatters.register self, :dump_summary
+
+  if ENV['TEST__SBTE']
+    def rspec_split_by_test_example?(_file)
+      true
+    end
+  end
+
+  if ENV['TEST__EMPTY_FILE_PATH']
+    def file_path_for(_example)
+      ''
+    end
+  end
+
+  def dump_summary(_)
+    method = ENV['TEST__METHOD']
+    result = send(method)
+    puts Marshal.dump(result)
+    return if ENV['TEST__DEBUG'].nil?
+
+    warn 'DEBUG'
+    warn result
+    warn 'GUBED'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.3.3
+  version: 8.4.0
 platform: ruby
 authors:
 - ArturT
@@ -215,7 +215,6 @@ files:
 - README.md
 - Rakefile
 - bin/knapsack_pro
-- bin/test
 - knapsack_pro.gemspec
 - lib/knapsack_pro.rb
 - lib/knapsack_pro/adapters/base_adapter.rb
@@ -359,7 +358,7 @@ files:
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb
 - spec/knapsack_pro/formatters/time_tracker_fetcher_spec.rb
-- spec/knapsack_pro/formatters/time_tracker_specs.rb
+- spec/knapsack_pro/formatters/time_tracker_spec.rb
 - spec/knapsack_pro/hooks/queue_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb
@@ -403,6 +402,7 @@ files:
 - spec_fake/models/admin_spec.rb
 - spec_fake/models/user_spec.rb
 - spec_fake/spec_helper.rb
+- spec_time_tracker/spec_helper.rb
 - test_fake/a_test.rb
 - test_fake/b_test.rb
 homepage: https://knapsackpro.com
@@ -481,7 +481,7 @@ test_files:
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb
 - spec/knapsack_pro/formatters/time_tracker_fetcher_spec.rb
-- spec/knapsack_pro/formatters/time_tracker_specs.rb
+- spec/knapsack_pro/formatters/time_tracker_spec.rb
 - spec/knapsack_pro/hooks/queue_spec.rb
 - spec/knapsack_pro/logger_wrapper_spec.rb
 - spec/knapsack_pro/presenter_spec.rb

data/bin/test

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-bundle exec ruby spec/knapsack_pro/formatters/time_tracker_specs.rb
-FORMATTERS_EXIT_CODE=$?
-
-bundle exec rspec spec
-RSPEC_EXIT_CODE=$?
-
-if [ "$FORMATTERS_EXIT_CODE" -ne "0" ]; then
-  exit $FORMATTERS_EXIT_CODE
-fi
-
-if [ "$RSPEC_EXIT_CODE" -ne "0" ]; then
-  exit $RSPEC_EXIT_CODE
-fi