percy-client 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de692225ce84348e116edaeba0d43941994e2894
-  data.tar.gz: 9461b20e0de36b59b41144c02aeec697e5b16e60
+  metadata.gz: 24df8c4fd00e7b5a84afffb237b642d1720b89fa
+  data.tar.gz: 3c18dc7ef7138240b5f82facfc4ed75c113b5b7a
 SHA512:
-  metadata.gz: 5305b2d6f3ee3b27c3d3efba19cf13cc461efc4ce50bd9c4daa65a1e6442aaf0fdf791cd305bff7baa44cc476b5d133ed52365e58091611170dc43468cb0c85c
-  data.tar.gz: a10670db8b468e4fa19b2873f93ef1b71ed1e8b308f3cbc2aed5828cece095de9a6a273b959e8ad69bfe82cdacf19331b06767c475fff7d2003c5aaad683bc9f
+  metadata.gz: 273baa8a0b0dc73c132a9074d7ae4f3800a170ccc88befc02e3b9dea1f5a0ed6c3780bddc4f6e4cbddeff059dfdd816ece500f6ffcb7a2296add163818d01817
+  data.tar.gz: 808767c19370e264f7128ee2d25be74a36ed1063e55305406acdeaab7908bb8853a0a8eb23650b9d398184049284e7ac2364ef53b771db38e9e0bbc09a750c1e

data/lib/percy/client/builds.rb

@@ -5,6 +5,7 @@ module Percy
         pull_request_number = options[:pull_request_number] ||
           Percy::Client::Environment.pull_request_number
         commit_data = options[:commit_data] || Percy::Client::Environment.commit
+        target_branch = options[:target_branch] || Percy::Client::Environment.target_branch
         resources = options[:resources]
         parallel_nonce = options[:parallel_nonce] || Percy::Client::Environment.parallel_nonce
         parallel_total_shards = options[:parallel_total_shards] \
@@ -23,6 +24,7 @@ module Percy
             'type' => 'builds',
             'attributes' => {
               'branch' => commit_data[:branch],
+              'target-branch' => target_branch,
               'commit-sha' => commit_data[:sha],
               'commit-committed-at' => commit_data[:committed_at],
               'commit-author-name' => commit_data[:author_name],

data/lib/percy/client/environment.rb

@@ -90,6 +90,11 @@ module Percy
         when :jenkins
           ENV['ghprbTargetBranch']
         when :travis
+          # Note: this is very unfortunately necessary because Travis does not expose the head
+          # branch, only the targeted 'master' branch in TRAVIS_BRANCH, with no way to get the
+          # actual head branch of the PR. We create a fake branch name so that Percy does not
+          # mistake this PR as a new master build.
+          # https://github.com/travis-ci/travis-ci/issues/1633#issuecomment-194749671
           if pull_request_number && ENV['TRAVIS_BRANCH'] == 'master'
             "github-pr-#{pull_request_number}"
           else
@@ -113,6 +118,11 @@ module Percy
         result
       end
 
+      # The target branch to compare against (if unset, Percy will pick master).
+      def self.target_branch
+        return ENV['PERCY_TARGET_BRANCH'] if ENV['PERCY_TARGET_BRANCH']
+      end
+
       # @private
       def self._raw_branch_output
         # Discover from local git repo branch name.

data/lib/percy/client/version.rb

@@ -1,5 +1,5 @@
 module Percy
   class Client
-    VERSION = '1.4.2'
+    VERSION = '1.5.0'
   end
 end

data/spec/lib/percy/client/builds_spec.rb

@@ -3,9 +3,30 @@ RSpec.describe Percy::Client::Builds, :vcr do
   let(:sha) { Digest::SHA256.hexdigest(content) }
 
   describe '#create_build' do
-    before(:each) { ENV['PERCY_PULL_REQUEST'] = '123' }
-    after(:each) { ENV['PERCY_PULL_REQUEST'] = nil }
     it 'creates a build' do
+      # Whitebox test to check POST data.
+      expect_any_instance_of(Percy::Client).to \
+        receive(:post)
+        .with(/\/api\/v1\/repos\/fotinakis\/percy-examples\/builds\//, {
+          'data' => {
+            'type' => 'builds',
+            'attributes' => {
+              'branch' => 'master',
+              'target-branch' => nil,
+              'commit-sha' => kind_of(String),
+              'commit-committed-at' => kind_of(String),
+              'commit-author-name' => kind_of(String),
+              'commit-author-email' => kind_of(String),
+              'commit-committer-name' => kind_of(String),
+              'commit-committer-email' => kind_of(String),
+              'commit-message' => kind_of(String),
+              'pull-request-number' => nil,
+              'parallel-nonce' => nil,
+              'parallel-total-shards' => nil,
+            },
+          },
+        }).and_call_original
+
       build = Percy.create_build('fotinakis/percy-examples')
       expect(build).to be
       expect(build['data']).to be
@@ -33,6 +54,48 @@ RSpec.describe Percy::Client::Builds, :vcr do
       expect(build['data']['relationships']['missing-resources']['data']).to be
       expect(build['data']['relationships']['missing-resources']['data'].length).to eq(1)
     end
+    context 'with env vars configured' do
+      before(:each) do
+        ENV['PERCY_BRANCH'] = 'foo-branch'
+        ENV['PERCY_TARGET_BRANCH'] = 'bar-branch'
+        ENV['PERCY_PULL_REQUEST'] = '123'
+        ENV['PERCY_PARALLEL_NONCE'] = 'nonce'
+        ENV['PERCY_PARALLEL_TOTAL'] = '4'
+      end
+      after(:each) do
+        ENV['PERCY_BRANCH'] = nil
+        ENV['PERCY_TARGET_BRANCH'] = nil
+        ENV['PERCY_PULL_REQUEST'] = nil
+        ENV['PERCY_PARALLEL_NONCE'] = nil
+        ENV['PERCY_PARALLEL_TOTAL'] = nil
+      end
+      it 'passes through some attributes from environment' do
+        # Whitebox test to check POST data.
+        expect_any_instance_of(Percy::Client).to \
+          receive(:post)
+          .with(/\/api\/v1\/repos\/fotinakis\/percy-examples\/builds\//, {
+            'data' => {
+              'type' => 'builds',
+              'attributes' => {
+                'branch' => 'foo-branch',
+                'target-branch' => 'bar-branch',
+                'commit-sha' => kind_of(String),
+                'commit-committed-at' => kind_of(String),
+                'commit-author-name' => kind_of(String),
+                'commit-author-email' => kind_of(String),
+                'commit-committer-name' => kind_of(String),
+                'commit-committer-email' => kind_of(String),
+                'commit-message' => kind_of(String),
+                'pull-request-number' => '123',
+                'parallel-nonce' => 'nonce',
+                'parallel-total-shards' => 4,
+              },
+            },
+          })
+
+        Percy.create_build('fotinakis/percy-examples')
+      end
+    end
     context 'parallel test environment' do
       it 'passes through parallelism variables' do
         build = Percy.create_build(

data/spec/lib/percy/client/environment_spec.rb

@@ -3,6 +3,7 @@ RSpec.describe Percy::Client::Environment do
     # Unset Percy vars.
     ENV['PERCY_COMMIT'] = nil
     ENV['PERCY_BRANCH'] = nil
+    ENV['PERCY_TARGET_BRANCH'] = nil
     ENV['PERCY_PULL_REQUEST'] = nil
     ENV['PERCY_REPO_SLUG'] = nil
     ENV['PERCY_PARALLEL_NONCE'] = nil
@@ -97,6 +98,15 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('test-branch')
       end
     end
+    describe '#target_branch' do
+      it 'returns nil if unset' do
+        expect(Percy::Client::Environment.target_branch).to be_nil
+      end
+      it 'can be set with PERCY_TARGET_BRANCH' do
+        ENV['PERCY_TARGET_BRANCH'] = 'test-target-branch'
+        expect(Percy::Client::Environment.target_branch).to eq('test-target-branch')
+      end
+    end
     describe '#_commit_sha' do
       it 'returns nil if no environment info can be found' do
         expect(Percy::Client::Environment._commit_sha).to be_nil
@@ -231,10 +241,7 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('travis-branch')
       end
       it 'renames the Percy branch if this is a PR with an unknown head branch' do
-        # Note: this is very unfortunately necessary because Travis does not expose the head branch,
-        # only the targeted branch in TRAVIS_BRANCH and no way to get the actual head PR branch.
-        # We create a fake branch name so that Percy does not mistake this PR as a new master build.
-        # https://github.com/travis-ci/travis-ci/issues/1633#issuecomment-194749671
+        # Special Travis-only behavior, see note in branch method.
         ENV['TRAVIS_BRANCH'] = 'master'
         expect(Percy::Client::Environment.branch).to eq('github-pr-256')
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-client
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Percy::Client