knapsack_pro 0.17.0 → 0.18.0

data/lib/knapsack_pro/client/api/v1/queues.rb

@@ -0,0 +1,27 @@
+module KnapsackPro
+  module Client
+    module API
+      module V1
+        class Queues < Base
+          class << self
+            def queue(args)
+              action_class.new(
+                endpoint_path: '/v1/queues/queue',
+                http_method: :post,
+                request_hash: {
+                  :can_initialize_queue => args.fetch(:can_initialize_queue),
+                  :commit_hash => args.fetch(:commit_hash),
+                  :branch => args.fetch(:branch),
+                  :node_total => args.fetch(:node_total),
+                  :node_index => args.fetch(:node_index),
+                  :node_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+                  :test_files => args.fetch(:test_files)
+                }
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/config/ci/base.rb

@@ -8,6 +8,9 @@ module KnapsackPro
         def node_index
         end
 
+        def node_build_id
+        end
+
         def commit_hash
         end
 

data/lib/knapsack_pro/config/ci/buildkite.rb

@@ -10,6 +10,10 @@ module KnapsackPro
           ENV['BUILDKITE_PARALLEL_JOB']
         end
 
+        def node_build_id
+          ENV['BUILDKITE_BUILD_NUMBER']
+        end
+
         def commit_hash
           ENV['BUILDKITE_COMMIT']
         end

data/lib/knapsack_pro/config/ci/circle.rb

@@ -10,6 +10,10 @@ module KnapsackPro
           ENV['CIRCLE_NODE_INDEX']
         end
 
+        def node_build_id
+          ENV['CIRCLE_BUILD_NUM']
+        end
+
         def commit_hash
           ENV['CIRCLE_SHA1']
         end
@@ -26,4 +30,3 @@ module KnapsackPro
     end
   end
 end
-

data/lib/knapsack_pro/config/ci/semaphore.rb

@@ -11,6 +11,10 @@ module KnapsackPro
           index.to_i - 1 if index
         end
 
+        def node_build_id
+          ENV['SEMAPHORE_BUILD_NUMBER']
+        end
+
         def commit_hash
           ENV['REVISION']
         end

data/lib/knapsack_pro/config/ci/snap_ci.rb

@@ -11,6 +11,10 @@ module KnapsackPro
           index.to_i - 1 if index
         end
 
+        def node_build_id
+          ENV['SNAP_PIPELINE_COUNTER']
+        end
+
         def commit_hash
           ENV['SNAP_COMMIT']
         end

data/lib/knapsack_pro/config/ci/travis.rb

@@ -2,6 +2,10 @@ module KnapsackPro
   module Config
     module CI
       class Travis < Base
+        def node_build_id
+          ENV['TRAVIS_BUILD_NUMBER']
+        end
+
         def commit_hash
           ENV['TRAVIS_COMMIT']
         end

data/lib/knapsack_pro/config/env.rb

@@ -14,6 +14,12 @@ module KnapsackPro
             0).to_i
         end
 
+        def ci_node_build_id
+          ENV['KNAPSACK_PRO_CI_NODE_BUILD_ID'] ||
+            ci_env_for(:node_build_id) ||
+            'missing-build-id'
+        end
+
         def commit_hash
           ENV['KNAPSACK_PRO_COMMIT_HASH'] ||
             ci_env_for(:commit_hash)
@@ -45,6 +51,22 @@ module KnapsackPro
           recording_enabled == 'true'
         end
 
+        def queue_recording_enabled
+          ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED']
+        end
+
+        def queue_recording_enabled?
+          queue_recording_enabled == 'true'
+        end
+
+        def queue_id
+          ENV['KNAPSACK_PRO_QUEUE_ID'] || raise('Missing Queue ID')
+        end
+
+        def subset_queue_id
+          ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] || raise('Missing Subset Queue ID')
+        end
+
         def test_files_encrypted
           ENV['KNAPSACK_PRO_TEST_FILES_ENCRYPTED']
         end

data/lib/knapsack_pro/config/env_generator.rb

@@ -0,0 +1,19 @@
+module KnapsackPro
+  module Config
+    class EnvGenerator
+      class << self
+        def set_queue_id
+          if ENV['KNAPSACK_PRO_QUEUE_ID']
+            raise 'Queue ID already generated.'
+          else
+            ENV['KNAPSACK_PRO_QUEUE_ID'] = "#{Time.now.to_i}_#{SecureRandom.uuid}"
+          end
+        end
+
+        def set_subset_queue_id
+          ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = SecureRandom.uuid
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/queue_allocator.rb

@@ -0,0 +1,52 @@
+module KnapsackPro
+  class QueueAllocator
+    def initialize(args)
+      @test_files = args.fetch(:test_files)
+      @ci_node_total = args.fetch(:ci_node_total)
+      @ci_node_index = args.fetch(:ci_node_index)
+      @ci_node_build_id = args.fetch(:ci_node_build_id)
+      @repository_adapter = args.fetch(:repository_adapter)
+    end
+
+    def test_file_paths(can_initialize_queue)
+      action = build_action(can_initialize_queue)
+      connection = KnapsackPro::Client::Connection.new(action)
+      response = connection.call
+      if connection.success?
+        raise ArgumentError.new(response) if connection.errors?
+        prepare_test_files(response)
+      else
+        raise ArgumentError.new("Couldn't connect with Knapsack Pro API. Response: #{response}")
+      end
+    end
+
+    private
+
+    attr_reader :test_files,
+      :ci_node_total,
+      :ci_node_index,
+      :ci_node_build_id,
+      :repository_adapter
+
+    def encrypted_test_files
+      KnapsackPro::Crypto::Encryptor.call(test_files)
+    end
+
+    def build_action(can_initialize_queue)
+      KnapsackPro::Client::API::V1::Queues.queue(
+        can_initialize_queue: can_initialize_queue,
+        commit_hash: repository_adapter.commit_hash,
+        branch: repository_adapter.branch,
+        node_total: ci_node_total,
+        node_index: ci_node_index,
+        node_build_id: ci_node_build_id,
+        test_files: encrypted_test_files,
+      )
+    end
+
+    def prepare_test_files(response)
+      decrypted_test_files = KnapsackPro::Crypto::Decryptor.call(test_files, response['test_files'])
+      KnapsackPro::TestFilePresenter.paths(decrypted_test_files)
+    end
+  end
+end

data/lib/knapsack_pro/queue_allocator_builder.rb

@@ -0,0 +1,13 @@
+module KnapsackPro
+  class QueueAllocatorBuilder < BaseAllocatorBuilder
+    def allocator
+      KnapsackPro::QueueAllocator.new(
+        test_files: test_files,
+        ci_node_total: env.ci_node_total,
+        ci_node_index: env.ci_node_index,
+        ci_node_build_id: env.ci_node_build_id,
+        repository_adapter: repository_adapter,
+      )
+    end
+  end
+end

data/lib/knapsack_pro/report.rb

@@ -2,7 +2,35 @@ module KnapsackPro
   class Report
     def self.save
       test_files = KnapsackPro.tracker.to_a
+      create_build_subset(test_files)
+    end
+
+    def self.save_subset_queue_to_file
+      test_files = KnapsackPro.tracker.to_a
+      subset_queue_id = KnapsackPro::Config::Env.subset_queue_id
+
+      FileUtils.mkdir_p(queue_path)
+
+      subset_queue_file_name = "#{subset_queue_id}.json"
+      report_path = File.join(queue_path, subset_queue_file_name)
+      report_json = JSON.pretty_generate(test_files)
+
+      File.open(report_path, 'w+') do |f|
+        f.write(report_json)
+      end
+    end
 
+    def self.save_node_queue_to_api
+      test_files = []
+      Dir.glob("#{queue_path}/*.json").each do |file|
+        report = JSON.parse(File.read(file))
+        test_files += report
+      end
+
+      create_build_subset(test_files)
+    end
+
+    def self.create_build_subset(test_files)
       if test_files.empty?
         KnapsackPro.logger.info("Didn't save time execution report on API server because there are no test files matching criteria on this node. Probably reason might be very narrowed tests list - you run only tests with specified tag and there are fewer test files with the tag than node total number.")
         return
@@ -25,5 +53,12 @@ module KnapsackPro
         KnapsackPro.logger.info('Saved time execution report on API server.')
       end
     end
+
+    private
+
+    def self.queue_path
+      queue_id = KnapsackPro::Config::Env.queue_id
+      "tmp/knapsack_pro/queue/#{queue_id}"
+    end
   end
 end

data/lib/knapsack_pro/runners/queue/base_runner.rb

@@ -0,0 +1,34 @@
+module KnapsackPro
+  module Runners
+    module Queue
+      class BaseRunner
+        def self.run(args)
+          raise NotImplementedError
+        end
+
+        def self.run_tests(runner, can_initialize_queue, args, exitstatus)
+          raise NotImplementedError
+        end
+
+        def initialize(adapter_class)
+          @allocator_builder = KnapsackPro::QueueAllocatorBuilder.new(adapter_class)
+          @allocator = allocator_builder.allocator
+        end
+
+        def test_file_paths(args)
+          can_initialize_queue = args.fetch(:can_initialize_queue)
+          allocator.test_file_paths(can_initialize_queue)
+        end
+
+        def test_dir
+          allocator_builder.test_dir
+        end
+
+        private
+
+        attr_reader :allocator_builder,
+          :allocator
+      end
+    end
+  end
+end

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -0,0 +1,42 @@
+module KnapsackPro
+  module Runners
+    module Queue
+      class RSpecRunner < BaseRunner
+        def self.run(args)
+          require 'rspec/core'
+
+          ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_rspec
+          ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
+          ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
+
+          runner = new(KnapsackPro::Adapters::RSpecAdapter)
+
+          cli_args = (args || '').split
+          run_tests(runner, true, cli_args, 0)
+        end
+
+        def self.run_tests(runner, can_initialize_queue, args, exitstatus)
+          test_file_paths = runner.test_file_paths(can_initialize_queue: can_initialize_queue)
+
+          if test_file_paths.empty?
+            KnapsackPro::Report.save_node_queue_to_api
+            exit(exitstatus)
+          else
+            subset_queue_id = KnapsackPro::Config::EnvGenerator.set_subset_queue_id
+            ENV['KNAPSACK_PRO_SUBSET_QUEUE_ID'] = subset_queue_id
+
+            cli_args = args + [
+              '--default-path', runner.test_dir,
+            ] + test_file_paths
+            options = RSpec::Core::ConfigurationOptions.new(cli_args)
+            exit_code = RSpec::Core::Runner.new(options).run($stderr, $stdout)
+            exitstatus = exit_code if exit_code != 0
+            RSpec.world.example_groups.clear
+
+            run_tests(runner, false, args, exitstatus)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knapsack_pro/task_loader.rb

@@ -5,7 +5,7 @@ module KnapsackPro
     include ::Rake::DSL
 
     def load_tasks
-      Dir.glob("#{KnapsackPro.root}/lib/tasks/*.rake").each { |r| import r }
+      Dir.glob("#{KnapsackPro.root}/lib/tasks/**/*.rake").each { |r| import r }
     end
   end
 end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.17.0'
+  VERSION = '0.18.0'
 end

data/lib/tasks/queue/rspec.rake

@@ -0,0 +1,9 @@
+require 'knapsack_pro'
+
+namespace :knapsack_pro do
+  namespace :queue do
+    task :rspec, [:rspec_args] do |_, args|
+      KnapsackPro::Runners::Queue::RSpecRunner.run(args[:rspec_args])
+    end
+  end
+end

data/lib/tasks/salt.rake

@@ -1,5 +1,3 @@
-require 'securerandom'
-
 namespace :knapsack_pro do
   task :salt, [:size] do |_, args|
     default_size = 32

data/spec/knapsack_pro/adapters/base_adapter_spec.rb

@@ -17,31 +17,54 @@ describe KnapsackPro::Adapters::BaseAdapter do
   end
 
   describe '#bind' do
+    let(:recording_enabled?) { false }
+    let(:queue_recording_enabled?) { false }
+
     before do
       expect(KnapsackPro::Config::Env).to receive(:recording_enabled?).and_return(recording_enabled?)
+      expect(KnapsackPro::Config::Env).to receive(:queue_recording_enabled?).and_return(queue_recording_enabled?)
     end
 
+    after { subject.bind }
+
     context 'when recording enabled' do
       let(:recording_enabled?) { true }
 
+      before do
+        allow(subject).to receive(:bind_time_tracker)
+        allow(subject).to receive(:bind_save_report)
+      end
+
       it do
         logger = instance_double(Logger)
         expect(KnapsackPro).to receive(:logger).and_return(logger)
         expect(logger).to receive(:info).with('Test suite time execution recording enabled.')
-        expect(subject).to receive(:bind_time_tracker)
-        expect(subject).to receive(:bind_save_report)
-        subject.bind
       end
+      it { expect(subject).to receive(:bind_time_tracker) }
+      it { expect(subject).to receive(:bind_save_report) }
     end
 
-    context 'when recording not enabled' do
-      let(:recording_enabled?) { false }
+    context 'when queue recording enabled' do
+      let(:queue_recording_enabled?) { true }
+
+      before do
+        allow(subject).to receive(:bind_time_tracker)
+        allow(subject).to receive(:bind_save_queue_report)
+      end
 
       it do
-        expect(subject).not_to receive(:bind_time_tracker)
-        expect(subject).not_to receive(:bind_save_report)
-        subject.bind
+        logger = instance_double(Logger)
+        expect(KnapsackPro).to receive(:logger).and_return(logger)
+        expect(logger).to receive(:info).with('Test suite time execution queue recording enabled.')
       end
+      it { expect(subject).to receive(:bind_time_tracker) }
+      it { expect(subject).to receive(:bind_save_queue_report) }
+    end
+
+    context 'when recording disabled' do
+      it { expect(subject).not_to receive(:bind_time_tracker) }
+      it { expect(subject).not_to receive(:bind_save_report) }
+      it { expect(subject).not_to receive(:bind_save_queue_report) }
     end
   end
 
@@ -60,4 +83,12 @@ describe KnapsackPro::Adapters::BaseAdapter do
       }.to raise_error(NotImplementedError)
     end
   end
+
+  describe '#bind_save_queue_report' do
+    it do
+      expect {
+        subject.bind_save_queue_report
+      }.to raise_error(NotImplementedError)
+    end
+  end
 end