knapsack_pro 9.0.0 → 9.1.0

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -1,427 +0,0 @@
-require_relative '../../../lib/knapsack_pro/formatters/time_tracker'
-
-describe KnapsackPro::Adapters::RSpecAdapter do
-  it 'backwards compatibility with knapsack gem old rspec adapter name' do
-    expect(KnapsackPro::Adapters::RspecAdapter.new).to be_kind_of(described_class)
-  end
-
-  it do
-    expect(described_class::TEST_DIR_PATTERN).to eq 'spec/**{,/*/**}/*_spec.rb'
-  end
-
-  context do
-    before { expect(::RSpec).to receive(:configure).at_least(:once) }
-    it_behaves_like 'adapter'
-  end
-
-  describe '.split_by_test_cases_enabled?' do
-    subject { described_class.split_by_test_cases_enabled? }
-
-    before do
-      expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(rspec_split_by_test_examples_enabled)
-    end
-
-    context 'when the RSpec split by test examples is enabled' do
-      let(:rspec_split_by_test_examples_enabled) { true }
-
-      it { expect(subject).to be true }
-
-      context 'when the RSpec version is < 3.3.0' do
-        before do
-          stub_const('RSpec::Core::Version::STRING', '3.2.0')
-        end
-
-        it do
-          expect { subject }.to raise_error RuntimeError, 'RSpec >= 3.3.0 is required to split test files by test examples. Learn more: https://knapsackpro.com/perma/ruby/split-by-test-examples'
-        end
-      end
-    end
-
-    context 'when the RSpec split by test examples is disabled' do
-      let(:rspec_split_by_test_examples_enabled) { false }
-
-      it { expect(subject).to be false }
-    end
-  end
-
-  describe '.test_file_cases_for' do
-    let(:slow_test_files) do
-      [
-        '1_spec.rb',
-        '2_spec.rb',
-        '3_spec.rb',
-        '4_spec.rb',
-        '5_spec.rb',
-      ]
-    end
-
-    subject { described_class.test_file_cases_for(slow_test_files) }
-
-    before do
-      logger = instance_double(Logger)
-      expect(KnapsackPro).to receive(:logger).and_return(logger)
-      expect(logger).to receive(:info).with("Generating RSpec test examples JSON report for slow test files to prepare it to be split by test examples (by individual test cases). Thanks to that, a single slow test file can be split across parallel CI nodes. Analyzing 5 slow test files.")
-
-      cmd = 'RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector'
-      expect(Kernel).to receive(:system).with(cmd).and_return(cmd_result)
-    end
-
-    context 'when the rake task to detect RSpec test examples succeeded' do
-      let(:cmd_result) { true }
-
-      it 'returns test example paths for slow test files' do
-        rspec_test_example_detector = instance_double(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector)
-        expect(KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector).to receive(:new).and_return(rspec_test_example_detector)
-
-        test_file_example_paths = double
-        expect(rspec_test_example_detector).to receive(:test_file_example_paths).and_return(test_file_example_paths)
-
-        expect(subject).to eq test_file_example_paths
-      end
-    end
-
-    context 'when the rake task to detect RSpec test examples failed' do
-      let(:cmd_result) { false }
-
-      it do
-        expect { subject }.to raise_error(RuntimeError, 'Could not generate JSON report for RSpec. Rake task failed when running RACK_ENV=test RAILS_ENV=test bundle exec rake knapsack_pro:rspec_test_example_detector')
-      end
-    end
-  end
-
-  describe '.has_format_option?' do
-    subject { described_class.has_format_option?(cli_args) }
-
-    context 'when format option is provided as -f' do
-      let(:cli_args) { ['-f', 'documentation'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when format option is provided as --format' do
-      let(:cli_args) { ['--format', 'documentation'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when format option is provided without delimiter' do
-      let(:cli_args) { ['-fd'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when format option is not provided' do
-      let(:cli_args) { ['--fake', 'value'] }
-
-      it { expect(subject).to be false }
-    end
-  end
-
-  describe '.has_require_rails_helper_option?' do
-    subject { described_class.has_require_rails_helper_option?(cli_args) }
-
-    context 'when require option is provided as -r' do
-      let(:cli_args) { ['-r', 'rails_helper'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when require option is provided as --require' do
-      let(:cli_args) { ['--require', 'rails_helper'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when require option is provided without delimiter' do
-      let(:cli_args) { ['-rrails_helper'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when require option is not provided' do
-      let(:cli_args) { ['--fake', 'value'] }
-
-      it { expect(subject).to be false }
-    end
-  end
-
-  describe '.id_path?' do
-    subject { described_class.id_path?(path) }
-
-    context 'when the path is an RSpec path with id' do
-      let(:path) { 'spec/features/a_spec.rb[1:1:7:1]' }
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the path is an RSpec path with multiple ids' do
-      let(:path) { 'spec/features/a_spec.rb[1:1:7:1, 1:2]' }
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the path is an RSpec path with no id' do
-      let(:path) { 'spec/features/a_spec.rb' }
-
-      it { is_expected.to be false }
-    end
-
-    context 'when the path is a Turnip path with id' do
-      let(:path) { 'spec/acceptance/a.feature[1:1:7:1]' }
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the path is a Turnip path with multiple ids' do
-      let(:path) { 'spec/acceptance/a.feature[1:1:7:1,1:2]' }
-
-      it { is_expected.to be true }
-    end
-
-    context 'when the path is a Turnip path with no id' do
-      let(:path) { 'spec/acceptance/a.feature' }
-
-      it { is_expected.to be false }
-    end
-  end
-
-  describe '.rails_helper_exists?' do
-    subject { described_class.rails_helper_exists?(test_dir) }
-
-    let(:test_dir) { 'spec_fake' }
-
-    context 'when rails_helper exists' do
-      before do
-        File.open("#{test_dir}/rails_helper.rb", 'w')
-      end
-
-      after do
-        FileUtils.rm("#{test_dir}/rails_helper.rb")
-      end
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when rails_helper does not exist' do
-      before do
-        FileUtils.rm_f("#{test_dir}/rails_helper.rb")
-      end
-
-      it { expect(subject).to be false }
-    end
-  end
-
-  describe '.order_option' do
-    subject { described_class.order_option(cli_args) }
-
-    context "when order is 'defined'" do
-      let(:cli_args) { ['--order', 'defined'] }
-
-      it { expect(subject).to eq 'defined' }
-    end
-
-    context "when order is 'recently-modified'" do
-      let(:cli_args) { ['--order', 'recently-modified'] }
-
-      it { expect(subject).to eq 'recently-modified' }
-    end
-
-    context "when order is 'rand'" do
-      let(:cli_args) { ['--order', 'rand'] }
-
-      it { expect(subject).to eq 'rand' }
-
-      context 'with the seed' do
-        let(:cli_args) { ['--order', 'rand:123456'] }
-
-        it { expect(subject).to eq 'rand:123456' }
-      end
-    end
-
-    context "when order is 'random'" do
-      let(:cli_args) { ['--order', 'random'] }
-
-      it { expect(subject).to eq 'random' }
-
-      context 'with the seed' do
-        let(:cli_args) { ['--order', 'random:123456'] }
-
-        it { expect(subject).to eq 'random:123456' }
-      end
-    end
-
-    context 'when some custom order is specified' do
-      let(:cli_args) { ['--order', 'some-custom-order'] }
-
-      it { expect(subject).to eq 'some-custom-order' }
-    end
-
-    context "when the seed is given with the --seed command" do
-      let(:cli_args) { ['--seed', '123456'] }
-
-      it { expect(subject).to eq 'rand:123456' }
-    end
-  end
-
-  describe '.remove_formatters' do
-    subject { described_class.remove_formatters(cli_args) }
-
-    context "when CLI args include formatters" do
-      let(:cli_args) { ['-t', 'awesome_tag', '-f', 'documentation', '-o', '/tmp/documentation.txt', '--tag', 'mytag', '--format', 'json', '--out', '/tmp/file.json', '--no-color'] }
-
-      it 'removes formatters and the related output file options' do
-        expect(subject).to eq ['-t', 'awesome_tag', '--tag', 'mytag', '--no-color']
-      end
-    end
-  end
-
-  describe '.file_path_for' do
-    let(:current_example) { ::RSpec.describe.example }
-
-    subject { described_class.file_path_for(current_example) }
-
-    context "when id ends in _spec.rb" do
-      it "returns the first part of the id" do
-        allow(current_example).to receive(:id).and_return("./foo_spec.rb[1:1]")
-
-        expect(subject).to eq('./foo_spec.rb')
-      end
-    end
-
-    context "when id does not end in _spec.rb" do
-      it "returns the file_path" do
-        allow(current_example).to receive(:id).and_return("./foo.rb")
-        allow(current_example).to receive(:metadata).and_return(file_path: "./foo_spec.rb")
-
-        expect(subject).to eq('./foo_spec.rb')
-      end
-    end
-
-    context "when id and file_path do not end in _spec.rb" do
-      it "returns the example_group's file_path" do
-        allow(current_example).to receive(:id).and_return("./foo.rb")
-        allow(current_example).to receive(:metadata).and_return(
-          file_path: "./foo.rb", example_group: { file_path: "./foo_spec.rb" }
-        )
-
-        expect(subject).to eq('./foo_spec.rb')
-      end
-    end
-
-    context "when id, file_path, and example_group's file_path do not end in _spec.rb" do
-      it "returns the top_level_group's file_path" do
-        allow(current_example).to receive(:id).and_return("./foo.rb")
-        allow(current_example).to receive(:metadata).and_return(
-          file_path: "./foo.rb",
-          example_group: {
-            file_path: "./foo.rb",
-            parent_example_group: {
-              file_path: "./foo_spec.rb",
-            }
-          }
-        )
-
-        expect(subject).to eq('./foo_spec.rb')
-      end
-    end
-
-    context "when id, file_path, example_group's, and top_level_group's file_path do not end in _spec.rb" do
-      it "returns empty string" do
-        allow(current_example).to receive(:id).and_return("./foo.rb")
-        allow(current_example).to receive(:metadata).and_return(
-          file_path: "./foo.rb",
-          example_group: {
-            file_path: "./foo.rb",
-            parent_example_group: {
-              file_path: "./foo.rb",
-            }
-          }
-        )
-
-        expect(subject).to eq('')
-      end
-    end
-
-    context "when id does not end in .feature (nor _spec.rb)" do
-      it "returns the file_path" do
-        allow(current_example).to receive(:id).and_return("./foo.rb")
-        allow(current_example).to receive(:metadata).and_return(file_path: "./foo.feature")
-
-        expect(subject).to eq("./foo.feature")
-      end
-    end
-  end
-
-  describe 'private .scheduled_paths' do
-    subject { described_class.send(:scheduled_paths) }
-
-    context 'when the RSpec configuration has files or directories to run' do
-      it 'returns list of test files passed to RSpec (if this fails then the internal RSpec API changed and we must start supporting a new RSpec version as well)' do
-        expect(subject).not_to be_empty
-      end
-    end
-
-    context "when the RSpec configuration has no files or directories to run (when the internal RSpec API changed and we don't support the new RSpec version yet)" do
-      before do
-        expect(described_class).to receive(:rspec_configuration).and_return(double(:object_with_no_instance_variables))
-      end
-
-      it 'fallbacks to an empty array to not blow up Knapsack Pro' do
-        expect(subject).to eq([])
-      end
-    end
-  end
-
-  describe 'bind methods' do
-    let(:config) { double }
-
-    describe '#bind_time_tracker' do
-      let(:current_example) { double(metadata: {}) }
-
-      context "when the example's metadata has :focus tag AND RSpec inclusion rule includes :focus" do
-        let(:current_example) { double(metadata: { focus: true }) }
-        let(:test_path) { 'spec/a_spec.rb' }
-
-        it do
-          expect(config).to receive(:around).with(:each).and_yield(current_example)
-          expect(::RSpec).to receive(:configure).and_yield(config)
-
-          expect(described_class).to receive(:file_path_for).with(current_example).and_return(test_path)
-
-          expect(described_class).to receive_message_chain(:rspec_configuration, :filter, :rules, :[]).with(:focus).and_return(true)
-
-          expect {
-            subject.bind_time_tracker
-          }.to raise_error /Knapsack Pro found an example tagged with focus in spec\/a_spec\.rb/i
-        end
-      end
-
-      context 'with no focus' do
-        it 'records time for current test path' do
-          expect(config).to receive(:around).with(:each).and_yield(current_example)
-          expect(config).to receive(:append_after).with(:suite)
-          expect(::RSpec).to receive(:configure).at_least(1).and_yield(config)
-
-          expect(current_example).to receive(:run)
-
-          subject.bind_time_tracker
-        end
-      end
-    end
-
-    describe '#bind_save_report' do
-      it do
-        expect(config).to receive(:after).with(:suite).and_yield
-        expect(::RSpec).to receive(:configure).and_yield(config)
-
-        time_tracker = instance_double(KnapsackPro::Formatters::TimeTracker)
-        times = [{ path: "foo_spec.rb", time_execution: 1.0 }]
-        expect(time_tracker).to receive(:batch).and_return(times)
-        expect(KnapsackPro::Formatters::TimeTrackerFetcher).to receive(:call).and_return(time_tracker)
-        expect(KnapsackPro::Report).to receive(:save).with(times)
-
-        subject.bind_save_report
-      end
-    end
-  end
-end

data/spec/knapsack_pro/adapters/spinach_adapter_spec.rb

@@ -1,61 +0,0 @@
-describe KnapsackPro::Adapters::SpinachAdapter do
-  it do
-    expect(described_class::TEST_DIR_PATTERN).to eq 'features/**{,/*/**}/*.feature'
-  end
-
-  context do
-    it_behaves_like 'adapter'
-  end
-
-  describe '.test_path' do
-    let(:scenario_data) do
-      double(feature: double(filename: 'a.feature'))
-    end
-
-    subject { described_class.test_path(scenario_data) }
-
-    it { should eql 'a.feature' }
-  end
-
-  describe 'bind methods' do
-    describe '#bind_time_tracker' do
-      let(:block) { double }
-      let(:tracker) { instance_double(KnapsackPro::Tracker) }
-      let(:logger) { instance_double(Logger) }
-      let(:global_time) { 'Global time: 01m 05s' }
-      let(:test_path) { 'features/a.feature' }
-      let(:scenario_data) do
-        double(feature: double(filename: test_path))
-      end
-
-      it do
-        expect(Spinach.hooks).to receive(:before_scenario).and_yield(scenario_data, nil)
-
-        allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-        expect(described_class).to receive(:test_path).with(scenario_data).and_return(test_path)
-        expect(tracker).to receive(:current_test_path=).with(test_path)
-        expect(tracker).to receive(:start_timer)
-
-        expect(Spinach.hooks).to receive(:after_scenario).and_yield
-        expect(tracker).to receive(:stop_timer)
-
-        expect(Spinach.hooks).to receive(:after_run).and_yield
-        expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
-        expect(KnapsackPro).to receive(:logger).and_return(logger)
-        expect(logger).to receive(:debug).with(global_time)
-
-        subject.bind_time_tracker
-      end
-    end
-
-    describe '#bind_save_report' do
-      it do
-        expect(Spinach.hooks).to receive(:after_run).and_yield
-
-        expect(KnapsackPro::Report).to receive(:save)
-
-        subject.bind_save_report
-      end
-    end
-  end
-end

data/spec/knapsack_pro/adapters/test_unit_adapter_spec.rb

@@ -1,86 +0,0 @@
-# fake class to make tests pass and to avoid require 'test/unit/testcase' to not break RSpec
-# https://www.rubydoc.info/gems/test-unit/3.4.1/Test/Unit/TestSuite
-module Test
-  module Unit
-    class TestSuite
-    end
-  end
-end
-
-describe KnapsackPro::Adapters::TestUnitAdapter do
-  it do
-    expect(described_class::TEST_DIR_PATTERN).to eq 'test/**{,/*/**}/*_test.rb'
-  end
-
-  describe '.test_path' do
-    subject { described_class.test_path(obj) }
-
-    before do
-      parent_of_test_dir = File.expand_path('../../../', File.dirname(__FILE__))
-      described_class.class_variable_set(:@@parent_of_test_dir, parent_of_test_dir)
-    end
-
-    context 'when regular test' do
-      class FakeTestUnitTest
-        def method_name
-          "test_something"
-        end
-
-        def test_something
-        end
-      end
-
-      class FakeTestUnitTestSuite
-        def tests
-          [FakeTestUnitTest.new]
-        end
-      end
-
-      let(:obj) { FakeTestUnitTestSuite.new }
-
-      it { should eq './spec/knapsack_pro/adapters/test_unit_adapter_spec.rb' }
-    end
-  end
-
-  describe 'bind methods' do
-    describe '#bind_time_tracker' do
-      let(:logger) { instance_double(Logger) }
-      let(:global_time) { 'Global time: 01m 05s' }
-
-      it do
-        expect(Test::Unit::TestSuite).to receive(:send).with(:prepend, KnapsackPro::Adapters::TestUnitAdapter::BindTimeTrackerTestUnitPlugin)
-
-        expect(subject).to receive(:add_post_run_callback).and_yield
-
-        expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
-        expect(KnapsackPro).to receive(:logger).and_return(logger)
-        expect(logger).to receive(:debug).with(global_time)
-
-        subject.bind_time_tracker
-      end
-    end
-
-    describe '#bind_save_report' do
-      it do
-        expect(subject).to receive(:add_post_run_callback).and_yield
-
-        expect(KnapsackPro::Report).to receive(:save)
-
-        subject.bind_save_report
-      end
-    end
-  end
-
-  describe '#set_test_helper_path' do
-    let(:adapter) { described_class.new }
-    let(:test_helper_path) { '/code/project/test/test_helper.rb' }
-
-    subject { adapter.set_test_helper_path(test_helper_path) }
-
-    after do
-      expect(described_class.class_variable_get(:@@parent_of_test_dir)).to eq '/code/project'
-    end
-
-    it { should eql '/code/project' }
-  end
-end

data/spec/knapsack_pro/base_allocator_builder_spec.rb

@@ -1,102 +0,0 @@
-describe KnapsackPro::BaseAllocatorBuilder do
-  let(:adapter_class) { KnapsackPro::Adapters::BaseAdapter }
-  let(:allocator_builder) { described_class.new(adapter_class) }
-
-  describe 'initialize method' do
-    context 'when unknown adapter (base adapter)' do
-      let(:adapter_class) { KnapsackPro::Adapters::BaseAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to be_nil
-      end
-    end
-
-    context 'when RSpec adapter' do
-      let(:adapter_class) { KnapsackPro::Adapters::RSpecAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to eq 'rspec'
-      end
-    end
-
-    context 'when Cucumber adapter' do
-      let(:adapter_class) { KnapsackPro::Adapters::CucumberAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to eq 'cucumber'
-      end
-    end
-
-    context 'when Minitest adapter' do
-      let(:adapter_class) { KnapsackPro::Adapters::MinitestAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to eq 'minitest'
-      end
-    end
-
-    context 'when Spinach adapter' do
-      let(:adapter_class) { KnapsackPro::Adapters::SpinachAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to eq 'spinach'
-      end
-    end
-
-    context 'when Test::Unit adapter' do
-      let(:adapter_class) { KnapsackPro::Adapters::TestUnitAdapter }
-
-      it do
-        allocator_builder
-        expect(ENV['KNAPSACK_PRO_TEST_RUNNER']).to eq 'test-unit'
-      end
-    end
-  end
-
-  describe '#allocator' do
-    subject { allocator_builder.allocator }
-
-    it do
-      expect { subject }.to raise_error(NotImplementedError)
-    end
-  end
-
-  describe '#test_dir' do
-    subject { allocator_builder.test_dir }
-
-    before do
-      expect(KnapsackPro::Config::Env).to receive(:test_dir).and_return(test_dir)
-    end
-
-    context 'when test_dir is defined in ENV' do
-      let(:test_dir) { double }
-
-      it { should eq test_dir }
-    end
-
-    context 'when test_dir is not defined in ENV' do
-      let(:test_dir) { nil }
-
-      before do
-        expect(KnapsackPro::TestFilePattern).to receive(:call).with(adapter_class).and_return(test_file_pattern)
-      end
-
-      context 'when single pattern' do
-        let(:test_file_pattern) { 'spec/**{,/*/**}/*_spec.rb' }
-
-        it { should eq 'spec' }
-      end
-
-      context 'when multiple patterns' do
-        let(:test_file_pattern) { '{spec/controllers/**/*.rb,spec/decorators/**/*.rb}' }
-
-        it { should eq 'spec' }
-      end
-    end
-  end
-end