knapsack_pro 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 897d3324c8c5701fb4508d0382716c3bbbe6ed0c
-  data.tar.gz: 6ebf2904dde98152e80e12dfd855e5080f41233a
+  metadata.gz: f61f4cbac8cf4737c994517d3d2b720b43e31dc0
+  data.tar.gz: 8e78bb42b3cf42aae6ff29cbaac9bbadc059c005
 SHA512:
-  metadata.gz: 9c23494c6858da7833fea766e2f3de502967150219657b3b35cb1fc6b4eb0481bbc6062a76c0a0944092d2b70585443cc3d99954d3a11eed676cba12d01c743d
-  data.tar.gz: f89bf84f3194baacf28b3396ed701d20a2b83d22ece58d2debd8cae591d599ec85605f39b5d9884d9c79e321de04b7d789751924f9a6db20ccbd75374e012730
+  metadata.gz: b03f01778fa3c20735b54c71631b0beeb74658fdef67ab8247aa325aef55de0268ef6ede238a6d75733f3f4ccd74df734769b974c2dca2616a412830f015165e
+  data.tar.gz: 30fcb16188e7e2c72fcfeaa1038775fa9f54f5ffb84ba8ababed6883637ce9b8e4e04f4f2c91f7015e94629437fd4b167f075f3fd026edb834b1f019a7e6664b

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.32.0
+
+* Add encryption for branch names
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/30
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.31.0...v0.32.0
+
 ### 0.31.0
 
 * Add supported for log levels `fatal` and `error` by `KNAPSACK_PRO_LOG_LEVEL` environment variable.

data/README.md

@@ -88,6 +88,8 @@ The knapsack_pro has also [queue mode](#queue-mode) to get most optimal test sui
   - [Test file names encryption](#test-file-names-encryption)
     - [How to enable test file names encryption?](#how-to-enable-test-file-names-encryption)
     - [How to debug test file names?](#how-to-debug-test-file-names)
+    - [How to enable branch names encryption?](#how-to-enable-branch-names-encryption)
+    - [How to debug branch names?](#how-to-debug-branch-names)
   - [Supported CI providers](#supported-ci-providers)
     - [Info for CircleCI users](#info-for-circleci-users)
     - [Info for Travis users](#info-for-travis-users)
@@ -513,7 +515,7 @@ This is optional way of using knapsack_pro when you don't want to add it to `Gem
 ### Test file names encryption
 
 knapsack_pro gem collects information about you test file names and time execution. Those data are stored on KnapsackPro.com server.
-If your test file names are sensitive data then you can encrypt the names before sending them to KnapsackPro.com API.
+If your test file names or branch names are sensitive data then you can encrypt the names before sending them to KnapsackPro.com API.
 
 By default, encryption is disabled because knapsack_pro can use your test files names to prepare better test suite split when the time execution data are not yet collected on KnapsackPro.com server.
 When you will enable test file names encryption then your first test suite split may be less optimal than it could be.
@@ -523,23 +525,45 @@ Each test file name is generated with `Digest::SHA2.hexdigest` method and 64 cha
 Before you enable test file encryption please ensure you are using fresh API key. You should not use the same API key for encrypted and non encrypted test suite.
 You can generate API key for your test suite in [your dashboard](https://knapsackpro.com).
 
-#### How to enable test file names encryption?
-
-First you need to add environment variable `KNAPSACK_PRO_TEST_FILES_ENCRYPTED=true` to your CI server.
-
-Next step is to generate salt which will be used to encrypt test file names.
+Next step is to generate salt which will be used to encrypt test files or branch names.
 
     $ bundle exec rake knapsack_pro:salt
 
 Add to your CI server generated environment variable `KNAPSACK_PRO_SALT`.
 
+#### How to enable test file names encryption?
+
+You need to add environment variable `KNAPSACK_PRO_TEST_FILES_ENCRYPTED=true` to your CI server.
+
 #### How to debug test file names?
 
-If you need to check what is the encryption hash for particular test file your can check that with the rake task:
+If you need to check what is the encryption hash for particular test file you can check that with the rake task:
 
     $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_test_file_names[rspec]
 
-You can pass the name of test runner like rspec, minitest, cucumber, spinach as argument to rake task.
+You can pass the name of test runner like `rspec`, `minitest`, `cucumber`, `spinach` as argument to rake task.
+
+#### How to enable branch names encryption?
+
+You need to add environment variable `KNAPSACK_PRO_BRANCH_ENCRYPTED=true` to your CI server.
+
+Note: there are a few branch names that won't be encrypted because we use them as fallback branches on Knapsack Pro API side to determine time execution for test files during split for newly created branches.
+
+* develop
+* development
+* dev
+* master
+* staging
+
+#### How to debug branch names?
+
+If you need to check what is the encryption hash for particular branch then use the rake task:
+
+    # show all local branches and respective hashes
+    $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_branch_names
+
+    # show hash for branch provided as argument to rake task
+    $ KNAPSACK_PRO_SALT=xxx bundle exec rake knapsack_pro:encrypted_branch_names[not-encrypted-branch-name]
 
 ### Supported CI providers
 

data/lib/knapsack_pro.rb

@@ -55,6 +55,7 @@ require_relative 'knapsack_pro/runners/spinach_runner'
 require_relative 'knapsack_pro/runners/queue/base_runner'
 require_relative 'knapsack_pro/runners/queue/rspec_runner'
 require_relative 'knapsack_pro/crypto/encryptor'
+require_relative 'knapsack_pro/crypto/branch_encryptor'
 require_relative 'knapsack_pro/crypto/decryptor'
 require_relative 'knapsack_pro/crypto/digestor'
 

data/lib/knapsack_pro/allocator.rb

@@ -29,10 +29,14 @@ module KnapsackPro
       KnapsackPro::Crypto::Encryptor.call(test_files)
     end
 
+    def encrypted_branch
+      KnapsackPro::Crypto::BranchEncryptor.call(repository_adapter.branch)
+    end
+
     def build_action
       KnapsackPro::Client::API::V1::BuildDistributions.subset(
         commit_hash: repository_adapter.commit_hash,
-        branch: repository_adapter.branch,
+        branch: encrypted_branch,
         node_total: ci_node_total,
         node_index: ci_node_index,
         test_files: encrypted_test_files,

data/lib/knapsack_pro/config/env.rb

@@ -75,6 +75,14 @@ module KnapsackPro
           test_files_encrypted == 'true'
         end
 
+        def branch_encrypted
+          ENV['KNAPSACK_PRO_BRANCH_ENCRYPTED']
+        end
+
+        def branch_encrypted?
+          branch_encrypted == 'true'
+        end
+
         def salt
           required_env('KNAPSACK_PRO_SALT')
         end

data/lib/knapsack_pro/crypto/branch_encryptor.rb

@@ -0,0 +1,31 @@
+module KnapsackPro
+  module Crypto
+    class BranchEncryptor
+      NON_ENCRYPTABLE_BRANCHES = %w(develop development dev master staging)
+
+      def self.call(branch)
+        if KnapsackPro::Config::Env.branch_encrypted?
+          new(branch).call
+        else
+          branch
+        end
+      end
+
+      def initialize(branch)
+        @branch = branch
+      end
+
+      def call
+        if NON_ENCRYPTABLE_BRANCHES.include?(branch)
+          branch
+        else
+          Digestor.salt_hexdigest(branch)[0..6]
+        end
+      end
+
+      private
+
+      attr_reader :branch
+    end
+  end
+end

data/lib/knapsack_pro/crypto/decryptor.rb

@@ -1,7 +1,6 @@
 module KnapsackPro
   module Crypto
     class Decryptor
-      class MissingEncryptedTestFileError < StandardError; end
       class TooManyEncryptedTestFilesError < StandardError; end
 
       def self.call(test_files, encrypted_test_files)

data/lib/knapsack_pro/crypto/digestor.rb

@@ -1,9 +1,9 @@
 module KnapsackPro
   module Crypto
     class Digestor
-      def self.salt_hexdigest(path)
+      def self.salt_hexdigest(str_to_encrypt)
         salt = KnapsackPro::Config::Env.salt
-        str = salt + path
+        str = salt + str_to_encrypt
         Digest::SHA2.hexdigest(str)
       end
     end

data/lib/knapsack_pro/queue_allocator.rb

@@ -32,11 +32,15 @@ module KnapsackPro
       KnapsackPro::Crypto::Encryptor.call(test_files)
     end
 
+    def encrypted_branch
+      KnapsackPro::Crypto::BranchEncryptor.call(repository_adapter.branch)
+    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,
+        branch: encrypted_branch,
         node_total: ci_node_total,
         node_index: ci_node_index,
         node_build_id: ci_node_build_id,

data/lib/knapsack_pro/report.rb

@@ -45,9 +45,10 @@ module KnapsackPro
       repository_adapter = KnapsackPro::RepositoryAdapterInitiator.call
       test_files = KnapsackPro::Utils.unsymbolize(test_files)
       encrypted_test_files = KnapsackPro::Crypto::Encryptor.call(test_files)
+      encrypted_branch = KnapsackPro::Crypto::BranchEncryptor.call(repository_adapter.branch)
       action = KnapsackPro::Client::API::V1::BuildSubsets.create(
         commit_hash: repository_adapter.commit_hash,
-        branch: repository_adapter.branch,
+        branch: encrypted_branch,
         node_total: KnapsackPro::Config::Env.ci_node_total,
         node_index: KnapsackPro::Config::Env.ci_node_index,
         test_files: encrypted_test_files,

data/lib/knapsack_pro/repository_adapters/base_adapter.rb

@@ -8,6 +8,10 @@ module KnapsackPro
       def branch
         raise NotImplementedError
       end
+
+      def branches
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/knapsack_pro/repository_adapters/git_adapter.rb

@@ -9,6 +9,11 @@ module KnapsackPro
         `git -C "#{working_dir}" rev-parse --abbrev-ref HEAD`.strip
       end
 
+      def branches
+        str_branches = `git rev-parse --abbrev-ref --branches`
+        str_branches.split("\n")
+      end
+
       private
 
       def working_dir

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.31.0'
+  VERSION = '0.32.0'
 end

data/lib/tasks/encrypted_branch_names.rake

@@ -0,0 +1,22 @@
+require 'knapsack_pro'
+
+namespace :knapsack_pro do
+  task :encrypted_branch_names, [:branch] do |_, args|
+    branch = args[:branch]
+
+    branches =
+      if branch
+        [branch]
+      else
+        KnapsackPro::RepositoryAdapters::GitAdapter.new.branches
+      end
+
+    branches.each do |branch_name|
+      encrypted_branch = KnapsackPro::Crypto::BranchEncryptor.new(branch_name).call
+
+      puts "branch: #{branch_name}"
+      puts "encrypted branch: #{encrypted_branch}"
+      puts
+    end
+  end
+end

data/spec/knapsack_pro/allocator_spec.rb

@@ -22,10 +22,13 @@ describe KnapsackPro::Allocator do
       encrypted_test_files = double
       expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(test_files).and_return(encrypted_test_files)
 
+      encrypted_branch = double
+      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
+
       action = double
       expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
         commit_hash: repository_adapter.commit_hash,
-        branch: repository_adapter.branch,
+        branch: encrypted_branch,
         node_total: ci_node_total,
         node_index: ci_node_index,
         test_files: encrypted_test_files,

data/spec/knapsack_pro/config/env_spec.rb

@@ -302,6 +302,40 @@ describe KnapsackPro::Config::Env do
     end
   end
 
+  describe '.branch_encrypted' do
+    subject { described_class.branch_encrypted }
+
+    context 'when ENV exists' do
+      let(:branch_encrypted) { 'true' }
+      before { stub_const("ENV", { 'KNAPSACK_PRO_BRANCH_ENCRYPTED' => branch_encrypted }) }
+      it { should eq branch_encrypted }
+    end
+
+    context "when ENV doesn't exist" do
+      it { should be_nil }
+    end
+  end
+
+  describe '.branch_encrypted?' do
+    subject { described_class.branch_encrypted? }
+
+    before do
+      expect(described_class).to receive(:branch_encrypted).and_return(branch_encrypted)
+    end
+
+    context 'when enabled' do
+      let(:branch_encrypted) { 'true' }
+
+      it { should be true }
+    end
+
+    context 'when disabled' do
+      let(:branch_encrypted) { nil }
+
+      it { should be false }
+    end
+  end
+
   describe '.salt' do
     subject { described_class.salt }
 

data/spec/knapsack_pro/crypto/branch_encryptor_spec.rb

@@ -0,0 +1,53 @@
+describe KnapsackPro::Crypto::BranchEncryptor do
+  let(:branch) { 'feature-branch' }
+  let(:encryptor) { described_class.new(branch) }
+
+  describe '.call' do
+    subject { described_class.call(branch) }
+
+    before do
+      expect(KnapsackPro::Config::Env).to receive(:branch_encrypted?).and_return(branch_encrypted?)
+    end
+
+    context 'when branch encrypted flag enabled' do
+      let(:branch_encrypted?) { true }
+      let(:encryptor) { instance_double(described_class) }
+
+      it do
+        expect(described_class).to receive(:new).with(branch).and_return(encryptor)
+        result = double
+        expect(encryptor).to receive(:call).and_return(result)
+
+        expect(subject).to eq result
+      end
+    end
+
+    context 'when test files encrypted flag disabled' do
+      let(:branch_encrypted?) { false }
+
+      it { should eq branch }
+    end
+  end
+
+  describe '#call' do
+    subject { encryptor.call }
+
+    context 'when encryptable branch name' do
+      let(:branch) { 'feature-branch' }
+
+      before do
+        expect(KnapsackPro::Config::Env).to receive(:salt).at_least(1).and_return('123')
+      end
+
+      it { should eq '49e5bb1' }
+    end
+
+    described_class::NON_ENCRYPTABLE_BRANCHES.each do |branch_name|
+      context "when non encryptable branch name: #{branch_name}" do
+        let(:branch) { branch_name }
+
+        it { should eq branch_name }
+      end
+    end
+  end
+end

data/spec/knapsack_pro/crypto/digestor_spec.rb

@@ -1,8 +1,8 @@
 describe KnapsackPro::Crypto::Digestor do
   describe '.salt_hexdigest' do
-    let(:path) { 'a_spec.rb' }
+    let(:str_to_encrypt) { 'a_spec.rb' }
 
-    subject { described_class.salt_hexdigest(path) }
+    subject { described_class.salt_hexdigest(str_to_encrypt) }
 
     before do
       expect(KnapsackPro::Config::Env).to receive(:salt).at_least(1).and_return('123')

data/spec/knapsack_pro/queue_allocator_spec.rb

@@ -25,11 +25,14 @@ describe KnapsackPro::QueueAllocator do
       encrypted_test_files = double
       expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(test_files).and_return(encrypted_test_files)
 
+      encrypted_branch = double
+      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
+
       action = double
       expect(KnapsackPro::Client::API::V1::Queues).to receive(:queue).with(
         can_initialize_queue: can_initialize_queue,
         commit_hash: repository_adapter.commit_hash,
-        branch: repository_adapter.branch,
+        branch: encrypted_branch,
         node_total: ci_node_total,
         node_index: ci_node_index,
         node_build_id: ci_node_build_id,

data/spec/knapsack_pro/report_spec.rb

@@ -89,6 +89,9 @@ describe KnapsackPro::Report do
       encrypted_test_files = double
       expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(unsymbolize_test_files).and_return(encrypted_test_files)
 
+      encrypted_branch = double
+      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
+
       node_total = double
       node_index = double
       expect(KnapsackPro::Config::Env).to receive(:ci_node_total).and_return(node_total)
@@ -97,7 +100,7 @@ describe KnapsackPro::Report do
       action = double
       expect(KnapsackPro::Client::API::V1::BuildSubsets).to receive(:create).with({
         commit_hash: commit_hash,
-        branch: branch,
+        branch: encrypted_branch,
         node_total: node_total,
         node_index: node_index,
         test_files: encrypted_test_files,

data/spec/knapsack_pro/repository_adapters/git_adapter_spec.rb

@@ -24,4 +24,11 @@ describe KnapsackPro::RepositoryAdapters::GitAdapter do
     it { should_not be_nil }
     it { should eq circle_branch } if ENV['CIRCLE_BRANCH']
   end
+
+  describe '#branches' do
+    subject { described_class.new.branches }
+
+    it { expect(subject.include?('master')).to be true }
+    it { expect(subject.include?(circle_branch)).to be true } if ENV['CIRCLE_BRANCH']
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2017-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -240,6 +240,7 @@ files:
 - lib/knapsack_pro/config/ci/travis.rb
 - lib/knapsack_pro/config/env.rb
 - lib/knapsack_pro/config/env_generator.rb
+- lib/knapsack_pro/crypto/branch_encryptor.rb
 - lib/knapsack_pro/crypto/decryptor.rb
 - lib/knapsack_pro/crypto/digestor.rb
 - lib/knapsack_pro/crypto/encryptor.rb
@@ -269,6 +270,7 @@ files:
 - lib/knapsack_pro/utils.rb
 - lib/knapsack_pro/version.rb
 - lib/tasks/cucumber.rake
+- lib/tasks/encrypted_branch_names.rake
 - lib/tasks/encrypted_test_file_names.rake
 - lib/tasks/install.rake
 - lib/tasks/minitest.rake
@@ -304,6 +306,7 @@ files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb
@@ -397,6 +400,7 @@ test_files:
 - spec/knapsack_pro/config/ci/travis_spec.rb
 - spec/knapsack_pro/config/env_generator_spec.rb
 - spec/knapsack_pro/config/env_spec.rb
+- spec/knapsack_pro/crypto/branch_encryptor_spec.rb
 - spec/knapsack_pro/crypto/decryptor_spec.rb
 - spec/knapsack_pro/crypto/digestor_spec.rb
 - spec/knapsack_pro/crypto/encryptor_spec.rb