knapsack_pro 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4167b51e7f0af27a7d1482efb7a6c019f9aa99dd849f9488e47c4a33b5bd943
-  data.tar.gz: fff1d5e557813cd2829298c422d4ffae857e047d27aa001cf746a516270d9259
+  metadata.gz: e72536de9d4d9ec4a02e935742375b9d8023522f9c21ac8340a991bfdc7982cb
+  data.tar.gz: b7694088ff854a5579ec160fbb08c3219986a95512c2feea15ac6a359dc7aff5
 SHA512:
-  metadata.gz: fd9b442c01b5b58b295e6fc36d3879ddbf97b8770d4f96243f594f225ef3f73e23e75555cfba7adb6439dd5afa39a38ea756e5758628eed54c9305a12bd8b716
-  data.tar.gz: 7401c76f35ce8485a7dc8dc5742514803c8a045d7f431899b32aaa4795433b723b68e554386b7670abb367b1f9dfde2be9e4bc8b661ead354dbab366b56c1705
+  metadata.gz: 408aaada7954066b2a3266897aa9b145ce53f2f7409f99f4c8915e122c5deef0818bc14503da59cab1f20c1376a4b205466089c14eaa8c9cd1943699298f8d86
+  data.tar.gz: 85eef879c155557825347ede8671f1b65d9832a8e8b379e94efaf61573cbd676082d43d6219099a35cad008266ef8e16cd719553397c5b71f775ad0ab76f7e79

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 2.7.0
+
+* Add support for env var `KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE` to allow accepting file containing test files to run
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/129
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.6.0...v2.7.0
+
 ### 2.6.0
 
 * Improve logger to show failed requests URL and when retry will happen

data/README.md

@@ -3082,7 +3082,9 @@ The test file pattern and exclude pattern support any glob pattern handled by [`
 
 #### How to run a specific list of test files or only some tests from test file?
 
-:information_source: If you don't want to use the pattern [`KNAPSACK_PRO_TEST_FILE_PATTERN`](#how-can-i-run-tests-from-multiple-directories) to define a list of tests to run then read below.
+:information_source: If you don't want to use the pattern [`KNAPSACK_PRO_TEST_FILE_PATTERN`](#how-can-i-run-tests-from-multiple-directories) to define a list of tests to run then read below two options.
+
+**Option 1:**  
 
 If you want to run a specific list of test files that are explicitly defined by you or auto-generated by some kind of script you created then please use:
 
@@ -3090,7 +3092,24 @@ If you want to run a specific list of test files that are explicitly defined by
 
 Note `KNAPSACK_PRO_TEST_FILE_LIST` must be a list of test files comma separated. You can provide line number for tests inside of spec file in case of RSpec (this way you can run only one test or a group of tests from RSpec spec file). You can provide the same file a few times with different test line number.
 
-Note when you set `KNAPSACK_PRO_TEST_FILE_LIST` then below environment variables are ignored:
+**Option 2:** 
+
+Similarly, you can also provide a source file containing the test files that you would like to run. For example:
+`KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE=spec/fixtures/test_file_list_source_file.txt`  
+And the content of the source file can be any of the format below:
+
+```
+./spec/test1_spec.rb
+spec/test2_spec.rb[1]
+./spec/test3_spec.rb[1:2:3:4]
+./spec/test4_spec.rb:4
+./spec/test4_spec.rb:5
+```
+
+> Note that each of the line must be ending with `\n` the new line.
+
+Note when you set `KNAPSACK_PRO_TEST_FILE_LIST` or `KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE` then below environment variables are ignored:
+
 * `KNAPSACK_PRO_TEST_FILE_PATTERN`
 * `KNAPSACK_PRO_TEST_FILE_EXCLUDE_PATTERN`
 

data/lib/knapsack_pro/config/env.rb

@@ -74,6 +74,10 @@ module KnapsackPro
           ENV['KNAPSACK_PRO_TEST_FILE_LIST']
         end
 
+        def test_file_list_source_file
+          ENV['KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE']
+        end
+
         def test_dir
           ENV['KNAPSACK_PRO_TEST_DIR']
         end

data/lib/knapsack_pro/test_file_finder.rb

@@ -63,6 +63,10 @@ module KnapsackPro
         return KnapsackPro::Config::Env.test_file_list.split(',').map(&:strip)
       end
 
+      if test_file_list_enabled && KnapsackPro::Config::Env.test_file_list_source_file
+        return File.read(KnapsackPro::Config::Env.test_file_list_source_file).split(/\n/)
+      end
+
       test_file_paths = Dir.glob(test_file_pattern).uniq
 
       excluded_test_file_paths =

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.6.0'
+  VERSION = '2.7.0'
 end

data/spec/fixtures/test_file_list_source_file.txt

@@ -0,0 +1,6 @@
+./spec/test1_spec.rb
+spec/test2_spec.rb[1]
+./spec/test3_spec.rb[1:2:3:4]
+./spec/test4_spec.rb:4
+./spec/test4_spec.rb:5
+

data/spec/knapsack_pro/config/env_spec.rb

@@ -238,6 +238,20 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.test_file_list_source_file' do
+    subject { described_class.test_file_list_source_file }
+
+    context 'when ENV exists' do
+      let(:test_file_list_source_file) { 'spec/fixtures/test_file_list_source_file.txt' }
+      before { stub_const("ENV", { 'KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE' => test_file_list_source_file }) }
+      it { should eq test_file_list_source_file }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
   describe '.test_dir' do
     subject { described_class.test_dir }
 

data/spec/knapsack_pro/test_file_finder_spec.rb

@@ -154,5 +154,23 @@ describe KnapsackPro::TestFileFinder do
         end
       end
     end
+
+    context 'when KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE is defined' do
+      let(:test_file_list_source_file) { 'spec/fixtures/test_file_list_source_file.txt' }
+
+      before do
+        stub_const("ENV", { 'KNAPSACK_PRO_TEST_FILE_LIST_SOURCE_FILE' => test_file_list_source_file })
+      end
+
+      it do
+        expect(subject).to eq([
+          { 'path' => 'spec/test1_spec.rb' },
+          { 'path' => 'spec/test2_spec.rb[1]' },
+          { 'path' => 'spec/test3_spec.rb[1:2:3:4]' },
+          { 'path' => 'spec/test4_spec.rb:4' },
+          { 'path' => 'spec/test4_spec.rb:5' },
+        ])
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -308,6 +308,7 @@ files:
 - lib/tasks/salt.rake
 - lib/tasks/spinach.rake
 - lib/tasks/test_unit.rake
+- spec/fixtures/test_file_list_source_file.txt
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/invalid_test_suite_token.yml
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/success.yml
 - spec/fixtures/vcr_cassettes/api/v1/build_subsets/create/invalid_test_suite_token.yml
@@ -428,6 +429,7 @@ specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
   job finish work at a similar time.
 test_files:
+- spec/fixtures/test_file_list_source_file.txt
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/invalid_test_suite_token.yml
 - spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/success.yml
 - spec/fixtures/vcr_cassettes/api/v1/build_subsets/create/invalid_test_suite_token.yml