percy-client 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc578e0917f5911a1aa66074c6b3df2cfd29f13b
-  data.tar.gz: e8018bcffe5f1023331a360f6e3c1137409e15e9
+  metadata.gz: 5cb1162a266bd022d172fd7f3480434d70a32c64
+  data.tar.gz: fd764e8b3a6a1474ffa6f59e1bb54765c6e20ae6
 SHA512:
-  metadata.gz: f2fd7787234164b43c0ba7b9cc65a5414f374b7515f7ae397cbcb2de889020f1bb55678876433ab166c4be29418b00b4260ed8e55141deff7da6383c2ec820a6
-  data.tar.gz: e6b211360bd8650475918f344f9f810349407e0f1a961d97fdd5f56e9214062de4e95390128d9d60aaf2350a518ad511ee591687a01b4d95d74b35e975ced155
+  metadata.gz: 16d2abf05c798b824d7e3387b1404df556596fa4c52652571075572a69d34e6cd7f9a18f533ffe79c262dbd28068a150593eb41fe761de04b41038f9fa29a61a
+  data.tar.gz: a2d8c8e124c448f6fd99da12d85b1b26e9fba3b295ec20a9022df370dea539d06ea528064ccc949841823971a74c7e7cf476da19d0198990a0cb668f07b78a8a

data/lib/percy/client/builds.rb

@@ -10,8 +10,12 @@ module Percy
         parallel_total_shards = options[:parallel_total_shards] \
           || Percy::Client::Environment.parallel_total_shards
 
-        if (parallel_nonce && !parallel_total_shards) || (!parallel_nonce && parallel_total_shards)
-          raise ArgumentError.new('If parallel_nonce is given, parallel_total_shards is required.')
+        # Only pass parallelism data if it all exists and there is more than 1 shard.
+        in_parallel_environment = parallel_nonce && \
+          parallel_total_shards && parallel_total_shards > 1
+        if !in_parallel_environment
+          parallel_nonce = nil
+          parallel_total_shards = nil
         end
 
         data = {

data/lib/percy/client/environment.rb

@@ -156,12 +156,24 @@ module Percy
         end
       end
 
+      # A nonce which will be the same for all nodes of a parallel build, used to identify shards
+      # of the same CI build. This is usually just the CI environment build ID.
       def self.parallel_nonce
         return ENV['PERCY_PARALLEL_NONCE'] if ENV['PERCY_PARALLEL_NONCE']
+
+        case current_ci
+        when :circle
+          ENV['CIRCLE_BUILD_NUM']
+        end
       end
 
       def self.parallel_total_shards
         return Integer(ENV['PERCY_PARALLEL_TOTAL']) if ENV['PERCY_PARALLEL_TOTAL']
+
+        case current_ci
+        when :circle
+          Integer(ENV['CIRCLE_NODE_TOTAL']) if !ENV['CIRCLE_NODE_TOTAL'].empty?
+        end
       end
 
       # @private

data/lib/percy/client/version.rb

@@ -1,5 +1,5 @@
 module Percy
   class Client
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end
 end

data/spec/cassettes/Percy_Client_Builds/_create_build/parallel_test_environment/passes_through_parallelism_variables.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/repos/fotinakis/percy-examples/builds/
+    body:
+      encoding: UTF-8
+      string: '{"data":{"type":"builds","attributes":{"commit-sha":"fc4d2c2e6b55d995a005dba2d071e2f2fca5e04b","commit-branch":"master","commit-committed-at":"2015-06-09
+        23:22:31 -0700","commit-author-name":"<COMMIT_AUTHOR_NAME>","commit-author-email":"<COMMIT_AUTHOR_EMAIL>","commit-committer-name":"<COMMIT_AUTHOR_NAME>","commit-committer-email":"<COMMIT_AUTHOR_EMAIL>","commit-message":"Fix
+        test environment issue.","pull-request-number":"123","parallel-nonce":"nonce","parallel-total-shards":2}}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept:
+      - "*/*"
+      Date:
+      - Thu, 11 Jun 2015 00:20:38 GMT
+      Content-Type:
+      - application/vnd.api+json
+      Authorization:
+      - Token token="<FILTERED_PERCY_TOKEN>"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Thu, 11 Jun 2015 00:20:39 GMT
+      Status:
+      - 201 Created
+      Connection:
+      - close
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, PATCH, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - Authorization, Content-Type
+      Cache-Control:
+      - no-cache, no-store, max-age=0, must-revalidate
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Request-Id:
+      - 446304d0-e682-46b1-b0c0-39eefc375c40
+      X-Runtime:
+      - '0.422910'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"31","type":"builds","attributes":{"build-number":31,"state":"pending","is-pull-request":true,"pull-request-number":123,"pull-request-title":null,"approved-at":null,"parallel-nonce":"nonce","parallel-total-shards":2,"created-at":"2015-06-11T00:20:38.926Z","updated-at":"2015-06-11T00:20:38.926Z"},"links":{"self":"/api/v1/builds/31"},"relationships":{"commit":{"links":{"self":"/api/v1/builds/31/relationships/commit","related":"/api/v1/builds/31/commit"},"data":{"type":"commits","id":"2"}},"repo":{"links":{"self":"/api/v1/builds/31/relationships/repo","related":"/api/v1/builds/31/repo"}},"base-build":{"links":{"self":"/api/v1/builds/31/relationships/base-build","related":"/api/v1/builds/31/base-build"},"data":{"type":"builds","id":"29"}},"approved-by":{"links":{"self":"/api/v1/builds/31/relationships/approved-by","related":"/api/v1/builds/31/approved-by"}},"snapshots":{"links":{"self":"/api/v1/builds/31/relationships/snapshots","related":"/api/v1/builds/31/snapshots"}},"comparisons":{"links":{"self":"/api/v1/builds/31/relationships/comparisons","related":"/api/v1/builds/31/comparisons"}},"missing-resources":{"links":{"self":"/api/v1/builds/31/relationships/missing-resources","related":"/api/v1/builds/31/missing-resources"}}},"meta":{"finalize-link":"/api/v1/builds/31/finalize","approve-link":"/api/v1/builds/31/approve"}},"included":[{"id":"2","type":"commits","attributes":{"sha":"fc4d2c2e6b55d995a005dba2d071e2f2fca5e04b","branch":"master","message":"Fix
+        test environment issue.","committed-at":"2015-06-09 23:22:31 -0700","author-name":"<COMMIT_AUTHOR_NAME>","committer-name":"<COMMIT_AUTHOR_NAME>","created-at":"2015-06-11T00:15:24.000Z","updated-at":"2015-06-11T00:15:24.000Z"},"links":{"self":"/api/v1/commits/2"}},{"id":"29","type":"builds","attributes":{"build-number":29,"state":"finished","is-pull-request":false,"pull-request-number":0,"pull-request-title":null,"approved-at":null,"created-at":"2015-06-11T00:20:38.000Z","updated-at":"2015-06-11T00:20:38.000Z"},"links":{"self":"/api/v1/builds/29"},"relationships":{"commit":{"links":{"self":"/api/v1/builds/29/relationships/commit","related":"/api/v1/builds/29/commit"},"data":{"type":"commits","id":"2"}},"repo":{"links":{"self":"/api/v1/builds/29/relationships/repo","related":"/api/v1/builds/29/repo"}},"base-build":{"links":{"self":"/api/v1/builds/29/relationships/base-build","related":"/api/v1/builds/29/base-build"}},"approved-by":{"links":{"self":"/api/v1/builds/29/relationships/approved-by","related":"/api/v1/builds/29/approved-by"}},"snapshots":{"links":{"self":"/api/v1/builds/29/relationships/snapshots","related":"/api/v1/builds/29/snapshots"}},"comparisons":{"links":{"self":"/api/v1/builds/29/relationships/comparisons","related":"/api/v1/builds/29/comparisons"}},"missing-resources":{"links":{"self":"/api/v1/builds/29/relationships/missing-resources","related":"/api/v1/builds/29/missing-resources"}}},"meta":{"finalize-link":"/api/v1/builds/29/finalize","approve-link":"/api/v1/builds/29/approve"}}]}'
+    http_version:
+  recorded_at: Thu, 11 Jun 2015 00:20:39 GMT
+recorded_with: VCR 2.9.3

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

@@ -34,13 +34,14 @@ RSpec.describe Percy::Client::Builds, :vcr do
       expect(build['data']['relationships']['missing-resources']['data'].length).to eq(1)
     end
     context 'parallel test environment' do
-      it 'raises an error if either parallel_nonce or parallel_total_shards is given alone' do
-        expect do
-          Percy.create_build('fotinakis/percy-examples', parallel_nonce: 123)
-        end.to raise_error(ArgumentError)
-        expect do
-          Percy.create_build('fotinakis/percy-examples', parallel_total_shards: 2)
-        end.to raise_error(ArgumentError)
+      it 'passes through parallelism variables' do
+        build = Percy.create_build(
+          'fotinakis/percy-examples',
+          parallel_nonce: 'nonce',
+          parallel_total_shards: 2,
+        )
+        expect(build['data']['attributes']['parallel-nonce']).to eq('nonce')
+        expect(build['data']['attributes']['parallel-total-shards']).to eq(2)
       end
     end
   end

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

@@ -27,6 +27,7 @@ RSpec.describe Percy::Client::Environment do
     ENV['CIRCLE_BRANCH'] = nil
     ENV['CIRCLE_PROJECT_USERNAME'] = nil
     ENV['CIRCLE_PROJECT_REPONAME'] = nil
+    ENV['CIRCLE_BUILD_NUM'] = nil
     ENV['CI_PULL_REQUESTS'] = nil
 
     # Unset Codeship vars.
@@ -236,6 +237,8 @@ RSpec.describe Percy::Client::Environment do
       ENV['CIRCLE_SHA1'] = 'circle-commit-sha'
       ENV['CIRCLE_PROJECT_USERNAME'] = 'circle'
       ENV['CIRCLE_PROJECT_REPONAME'] = 'repo-name'
+      ENV['CIRCLE_BUILD_NUM'] = 'build-number'
+      ENV['CIRCLE_NODE_TOTAL'] = '2'
       ENV['CI_PULL_REQUESTS'] = 'https://github.com/owner/repo-name/pull/123'
     end
 
@@ -265,6 +268,20 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.repo).to eq('circle/repo-name')
       end
     end
+    describe '#parallel_nonce' do
+      it 'reads from the CI environment (the CI build ID)' do
+        expect(Percy::Client::Environment.parallel_nonce).to eq('build-number')
+      end
+    end
+    describe '#parallel_total_shards' do
+      it 'reads from the CI environment (the number of nodes)' do
+        expect(Percy::Client::Environment.parallel_total_shards).to eq(2)
+      end
+      it 'is nil if empty' do
+        ENV['CIRCLE_NODE_TOTAL'] = ''
+        expect(Percy::Client::Environment.parallel_total_shards).to be_nil
+      end
+    end
   end
   context 'in Codeship' do
     before(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -135,6 +135,7 @@ files:
 - percy-client.gemspec
 - spec/cassettes/Percy_Client_Builds/_create_build/accepts_optional_resources.yml
 - spec/cassettes/Percy_Client_Builds/_create_build/creates_a_build.yml
+- spec/cassettes/Percy_Client_Builds/_create_build/parallel_test_environment/passes_through_parallelism_variables.yml
 - spec/cassettes/Percy_Client_Builds/_finalize_build/finalizes_a_build.yml
 - spec/cassettes/Percy_Client_Resources/_upload_resource/returns_true_with_success.yml
 - spec/cassettes/Percy_Client_Snapshots/_create_snapshot/creates_a_snapshot.yml
@@ -176,6 +177,7 @@ summary: Percy::Client
 test_files:
 - spec/cassettes/Percy_Client_Builds/_create_build/accepts_optional_resources.yml
 - spec/cassettes/Percy_Client_Builds/_create_build/creates_a_build.yml
+- spec/cassettes/Percy_Client_Builds/_create_build/parallel_test_environment/passes_through_parallelism_variables.yml
 - spec/cassettes/Percy_Client_Builds/_finalize_build/finalizes_a_build.yml
 - spec/cassettes/Percy_Client_Resources/_upload_resource/returns_true_with_success.yml
 - spec/cassettes/Percy_Client_Snapshots/_create_snapshot/creates_a_snapshot.yml