pact_broker 2.66.0 → 2.67.0

data/spec/fixtures/approvals/modifiable_resources.approved.json

@@ -0,0 +1,74 @@
+{
+  "resource_classes": [
+    {
+      "resource_class_name": "PactBroker::Api::Resources::AllWebhooks"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::ErrorTest"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Integration"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Integrations"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Label"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::LatestVerificationForLatestPact",
+      "resource_class_data": "provider"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::LatestVerificationForPact",
+      "resource_class_data": "provider"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Pact",
+      "resource_class_data": "consumer"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::PactVersions",
+      "resource_class_data": "consumer"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::PactWebhooks"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Pacticipant"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Pacticipants"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::ProviderPactsForVerification"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Tag"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::TaggedPactVersions",
+      "resource_class_data": "consumer"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Verification",
+      "resource_class_data": "provider"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Verifications",
+      "resource_class_data": "provider"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Version"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Webhook"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::WebhookExecution"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Webhooks"
+    }
+  ]
+}

data/spec/lib/pact_broker/api/decorators/relationships_csv_decorator_spec.rb

@@ -2,11 +2,8 @@ require 'spec_helper'
 require 'pact_broker/api/decorators/relationships_csv_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       describe RelationshipsCsvDecorator do
 
         let(:pact) { TestDataBuilder.new.create_pact_with_hierarchy("My Consumer", "1.0", "My Provider").and_return(:pact) }

data/spec/lib/pact_broker/api/decorators/verifiable_pact_decorator_spec.rb

@@ -5,7 +5,7 @@ module PactBroker
     module Decorators
       describe VerifiablePactDecorator do
         before do
-          allow_any_instance_of(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url).and_return('http://pact')
+          allow_any_instance_of(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url_with_metadata).and_return('http://pact')
           allow(PactBroker::Pacts::BuildVerifiablePactNotices).to receive(:call).and_return(notices)
           allow_any_instance_of(PactBroker::Pacts::VerifiablePactMessages).to receive(:pact_version_short_description).and_return('short desc')
         end
@@ -61,7 +61,7 @@ module PactBroker
         end
 
         it "creates the pact version url" do
-          expect(decorator).to receive(:pact_version_url).with(pact, 'http://example.org')
+          expect(decorator).to receive(:pact_version_url_with_metadata).with(pact, nil, 'http://example.org')
           subject
         end
 
@@ -84,6 +84,11 @@ module PactBroker
           it "includes the wip flag" do
             expect(subject['verificationProperties']['wip']).to be true
           end
+
+          it "includes it in the metadata" do
+            expect(decorator).to receive(:pact_version_url_with_metadata).with(pact, { wip: true }, 'http://example.org')
+            subject
+          end
         end
       end
     end

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -111,25 +111,26 @@ module PactBroker
         end
 
         it "builds the webhook metadata" do
-          expect(PactBrokerUrls.decode_webhook_metadata(PactBrokerUrls.build_webhook_metadata(pact))).to eq (expected_metadata)
+          encoded_metadata = PactBrokerUrls.encode_metadata(PactBrokerUrls.build_metadata_for_webhook_triggered_by_pact_publication(pact))
+          expect(PactBrokerUrls.decode_pact_metadata(encoded_metadata)).to eq (expected_metadata)
         end
       end
 
-      describe "decode_webhook_metadata" do
+      describe "decode_pact_metadata" do
         context "when the metadata is nil" do
           it "returns an empty hash" do
-            expect(PactBrokerUrls.decode_webhook_metadata(nil)).to eq({})
+            expect(PactBrokerUrls.decode_pact_metadata(nil)).to eq({})
           end
         end
 
         context "when the metadata is not valid base64" do
           it "returns an empty hash" do
-            expect(PactBrokerUrls.decode_webhook_metadata("foo==,")).to eq({})
+            expect(PactBrokerUrls.decode_pact_metadata("foo==,")).to eq({})
           end
 
           it "logs a warning" do
             expect(logger).to receive(:warn).with("Exception parsing webhook metadata: foo==,", ArgumentError)
-            PactBrokerUrls.decode_webhook_metadata("foo==,")
+            PactBrokerUrls.decode_pact_metadata("foo==,")
           end
         end
       end

data/spec/lib/pact_broker/api/resources/can_i_deploy_spec.rb

@@ -0,0 +1,51 @@
+require 'pact_broker/api/resources/can_i_deploy'
+
+module PactBroker
+  module Api
+    module Resources
+      describe CanIDeploy do
+        include_context "stubbed services"
+
+        before do
+          allow(pacticipant_service).to receive(:find_pacticipant_by_name).and_return(pacticipant)
+          allow(matrix_service).to receive(:find).and_return(results)
+          allow_any_instance_of(described_class).to receive(:matrix_service).and_return(matrix_service)
+          allow(PactBroker::Api::Decorators::MatrixDecorator).to receive(:new).and_return(decorator)
+        end
+
+        let(:results) { double('results') }
+        let(:pacticipant) { double('pacticipant') }
+        let(:decorator) { instance_double('PactBroker::Api::Decorators::MatrixDecorator', to_json: 'response_body') }
+        let(:matrix_service) { class_double("PactBroker::Matrix::Service").as_stubbed_const }
+
+        let(:query) do
+          {
+            pacticipant: "Foo",
+            version: "1.2.3",
+            to: "prod"
+          }
+        end
+
+        subject { get("/can-i-deploy", query, { 'HTTP_ACCEPT' => 'application/hal+json'}) }
+
+        context "with the wrong query" do
+          let(:query) { {} }
+
+          it "returns a 400" do
+            expect(subject.status).to eq 400
+            expect(JSON.parse(subject.body)["errors"]["pacticipant"].first).to_not be_empty
+          end
+        end
+
+        context "when the pacticipant does not exist" do
+          let(:pacticipant) { nil }
+
+          it "returns a 400" do
+            expect(subject.status).to eq 400
+            expect(JSON.parse(subject.body)["errors"]["pacticipant"].first).to match /Foo.*found/
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/resources/default_base_resource_approval_spec.rb

@@ -0,0 +1,59 @@
+require 'pact_broker/api/resources'
+
+module PactBroker
+  module Api
+    module Resources
+      RSpec.describe "modifiable resources (ones that require write access)" do
+        let(:pact_broker_resource_classes) do
+          all_resources = ObjectSpace.each_object(::Class)
+            .select { |klass| klass < DefaultBaseResource }
+            .select(&:name)
+            .reject { |klass| klass.name.end_with?("BaseResource") }
+            .sort_by(&:name)
+        end
+
+        it "specifies which pacticipant is the one relevant to the policy" do
+          data = pact_broker_resource_classes.collect do | resource_class |
+            request = double('request', uri: URI("http://example.org")).as_null_object
+            response = double('response')
+            resource = resource_class.new(request, response)
+            modifiable = resource.allowed_methods.any?{ | method | %w{PATCH POST PUT DELETE}.include?(method) }
+            # We only care about getting the right pacticipant for the policy if the
+            # resource itself can be modified.
+            # Read only resources can be read by anybody - no point wasting time getting the right pacticipant
+            if modifiable
+              def resource.consumer
+                'consumer'
+              end
+
+              def resource.provider
+                'provider'
+              end
+
+              def resource.pacticipant
+                'pacticipant'
+              end
+
+              def resource.resource_exists?
+                true
+              end
+
+              resource_class_data = {
+                resource_class_name: resource.class.name,
+              }
+
+              if resource.respond_to?(:policy_pacticipant)
+                resource_class_data[:resource_class_data] = resource.policy_pacticipant
+              end
+                resource_class_data
+            else
+              nil
+            end
+          end.compact
+
+          Approvals.verify({ resource_classes: data }, :name => 'modifiable_resources', format: :json)
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/resources/latest_pact_spec.rb

@@ -55,7 +55,7 @@ module PactBroker::Api
             before do
               allow(PactBroker::Api::Decorators::PactDecorator).to receive(:new).and_return(decorator)
               allow(PactBroker::Pacts::Metadata).to receive(:build_metadata_for_latest_pact).and_return(metadata)
-              allow_any_instance_of(LatestPact).to receive(:encode_webhook_metadata).and_return('encoded metadata')
+              allow_any_instance_of(LatestPact).to receive(:encode_metadata).and_return('encoded metadata')
             end
 
             it "builds the metadata" do
@@ -64,7 +64,7 @@ module PactBroker::Api
             end
 
             it "encodes the metadata" do
-              expect_any_instance_of(LatestPact).to receive(:encode_webhook_metadata).with(metadata)
+              expect_any_instance_of(LatestPact).to receive(:encode_metadata).with(metadata)
               subject
             end
 

data/spec/lib/pact_broker/api/resources/verifications_spec.rb

@@ -24,7 +24,7 @@ module PactBroker
           before do
             allow(PactBroker::Verifications::Service).to receive(:create).and_return(verification)
             allow(PactBroker::Verifications::Service).to receive(:errors).and_return(double(:errors, messages: ['errors'], empty?: errors_empty))
-            allow(PactBrokerUrls).to receive(:decode_webhook_metadata).and_return(parsed_metadata)
+            allow(PactBrokerUrls).to receive(:decode_pact_metadata).and_return(parsed_metadata)
             allow_any_instance_of(Verifications).to receive(:webhook_execution_configuration).and_return(webhook_execution_configuration)
             allow(webhook_execution_configuration).to receive(:with_webhook_context).and_return(webhook_execution_configuration)
           end
@@ -65,7 +65,7 @@ module PactBroker
             end
 
             it "parses the webhook metadata" do
-              expect(PactBrokerUrls).to receive(:decode_webhook_metadata).with("abcd")
+              expect(PactBrokerUrls).to receive(:decode_pact_metadata).with("abcd")
               subject
             end
 
@@ -85,7 +85,7 @@ module PactBroker
             it "stores the verification in the database" do
               expect(PactBroker::Verifications::Service).to receive(:create).with(
                 next_verification_number,
-                hash_including('some' => 'params'),
+                hash_including('some' => 'params', 'wip' => false),
                 pact,
                 {
                   webhook_execution_configuration: webhook_execution_configuration,
@@ -104,6 +104,20 @@ module PactBroker
             it "returns the serialised verification in the response body" do
               expect(subject.body).to eq serialised_verification
             end
+
+            context "when the verification is for a wip pact" do
+              let(:parsed_metadata) { { wip: 'true' } }
+
+              it "merges that into the verification params" do
+                expect(PactBroker::Verifications::Service).to receive(:create).with(
+                  anything,
+                  hash_including('wip' => true),
+                  anything,
+                  anything
+                )
+                subject
+              end
+            end
           end
 
           context "when invalid parameters are used" do

data/spec/lib/pact_broker/pacts/latest_tagged_pact_publications_spec.rb

@@ -87,7 +87,7 @@ module PactBroker
             .create_consumer_version_tag("dev")
         end
 
-        let(:selector) { PactBroker::Matrix::UnresolvedSelector.new(tag: true, latest: true, max_age: 3) }
+        let(:selector) { PactBroker::Matrix::UnresolvedSelector.new(tag: true, latest: true, max_age: 5) }
 
         it "returns matching rows" do
           expect(subject.count).to eq 1

data/spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb

@@ -3,8 +3,6 @@ require 'pact_broker/pacts/repository'
 module PactBroker
   module Pacts
     describe Repository do
-      let(:td) { TestDataBuilder.new }
-
       describe "find_wip_pact_versions_for_provider" do
         let(:provider_tags) { %w[dev] }
         let(:options) { { include_wip_pacts_since: include_wip_pacts_since } }
@@ -73,6 +71,28 @@ module PactBroker
           end
         end
 
+        context "when the latest pact for a tag has been successfully verified by the given provider tag but it was a WIP verification" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333")
+              .create_provider_version_tag("dev")
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .comment("above not included because it's not the latest dev")
+              .create_consumer_version("2")
+              .create_consumer_version_tag("feat-1")
+              .create_pact
+              .create_verification(wip: true, success: true, provider_version: "3", tag_names: %w[dev])
+          end
+
+          let(:provider_tags) { %w[dev] }
+
+          it "it is included" do
+            expect(subject[0].consumer_name).to eq "foo"
+            expect(subject[0].consumer_version_number).to eq "2"
+          end
+        end
+
         context "when the latest pact for a tag has been successfully verified by one of the given provider tags, but not the other" do
           before do
             td.create_provider("bar")
@@ -145,6 +165,8 @@ module PactBroker
           end
         end
 
+
+
         context "when the latest pact for a tag has not been verified" do
           before do
             td.create_provider("bar")

data/spec/lib/pact_broker/verifications/service_spec.rb

@@ -23,7 +23,7 @@ module PactBroker
 
         let(:options) { { webhook_execution_configuration: webhook_execution_configuration } }
         let(:webhook_execution_configuration) { instance_double(PactBroker::Webhooks::ExecutionConfiguration) }
-        let(:params) { {'success' => true, 'providerApplicationVersion' => '4.5.6'} }
+        let(:params) { { 'success' => true, 'providerApplicationVersion' => '4.5.6', 'wip' => true, 'testResults' => { 'some' => 'results' }} }
         let(:pact) do
           td.create_pact_with_hierarchy
             .create_provider_version('4.5.6')
@@ -33,14 +33,16 @@ module PactBroker
         let(:create_verification) { subject.create 3, params, pact, options }
 
         it "logs the creation" do
-          expect(logger).to receive(:info).with(/.*verification.*3.*success/)
+          expect(logger).to receive(:info).with(/.*verification.*3/, payload: {"providerApplicationVersion"=>"4.5.6", "success"=>true, "wip"=>true})
           create_verification
         end
 
         it "sets the verification attributes" do
           verification = create_verification
+          expect(verification.wip).to be true
           expect(verification.success).to be true
           expect(verification.number).to eq 3
+          expect(verification.test_results).to eq 'some' => 'results'
         end
 
         it "sets the pact content for the verification" do

data/spec/lib/pact_broker/webhooks/render_spec.rb

@@ -10,7 +10,7 @@ module PactBroker
     describe Render do
       describe "#call" do
         before do
-          allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url_with_metadata).and_return("http://foo")
+          allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url_with_webhook_metadata).and_return("http://foo")
           allow(PactBroker::Api::PactBrokerUrls).to receive(:verification_url) do | verification, base_url |
             expect(verification).to_not be nil
             "http://verification"

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ require 'rspec/pact/matchers'
 require 'sucker_punch/testing/inline'
 require 'webmock/rspec'
 require 'pact_broker/policies'
+require 'approvals/rspec'
 
 Dir.glob("./spec/support/**/*.rb") { |file| require file  }
 
@@ -19,6 +20,10 @@ WebMock.disable_net_connect!(allow_localhost: true)
 
 I18n.config.enforce_available_locales = false
 
+Approvals.configure do |c|
+  c.approvals_path = 'spec/fixtures/approvals/'
+end
+
 RSpec.configure do | config |
   config.before :each do
     PactBroker.reset_configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.66.0
+  version: 2.67.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -520,6 +520,7 @@ files:
 - db/migrations/20200319_add_created_at_to_latest_verifications.rb
 - db/migrations/20200922_add_event_to_triggered_webhook.rb
 - db/migrations/20200930_update_latest_triggered_webhooks.rb
+- db/migrations/20201006_add_wip_to_verification.rb
 - db/migrations/migration_helper.rb
 - db/test/backwards_compatibility/.rspec
 - db/test/backwards_compatibility/Appraisals
@@ -1106,6 +1107,7 @@ files:
 - spec/fixtures/a_consumer-a_provider-conflict.json
 - spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
+- spec/fixtures/approvals/modifiable_resources.approved.json
 - spec/fixtures/certificate-invalid.pem
 - spec/fixtures/certificate.pem
 - spec/fixtures/certificates/cacert.pem
@@ -1178,7 +1180,9 @@ files:
 - spec/lib/pact_broker/api/resources/badge_spec.rb
 - spec/lib/pact_broker/api/resources/can_i_deploy_badge_spec.rb
 - spec/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_spec.rb
+- spec/lib/pact_broker/api/resources/can_i_deploy_spec.rb
 - spec/lib/pact_broker/api/resources/dashboard_spec.rb
+- spec/lib/pact_broker/api/resources/default_base_resource_approval_spec.rb
 - spec/lib/pact_broker/api/resources/default_base_resource_spec.rb
 - spec/lib/pact_broker/api/resources/error_handler_spec.rb
 - spec/lib/pact_broker/api/resources/group_spec.rb
@@ -1497,6 +1501,7 @@ test_files:
 - spec/fixtures/a_consumer-a_provider-conflict.json
 - spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
+- spec/fixtures/approvals/modifiable_resources.approved.json
 - spec/fixtures/certificate-invalid.pem
 - spec/fixtures/certificate.pem
 - spec/fixtures/certificates/cacert.pem
@@ -1569,7 +1574,9 @@ test_files:
 - spec/lib/pact_broker/api/resources/badge_spec.rb
 - spec/lib/pact_broker/api/resources/can_i_deploy_badge_spec.rb
 - spec/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_spec.rb
+- spec/lib/pact_broker/api/resources/can_i_deploy_spec.rb
 - spec/lib/pact_broker/api/resources/dashboard_spec.rb
+- spec/lib/pact_broker/api/resources/default_base_resource_approval_spec.rb
 - spec/lib/pact_broker/api/resources/default_base_resource_spec.rb
 - spec/lib/pact_broker/api/resources/error_handler_spec.rb
 - spec/lib/pact_broker/api/resources/group_spec.rb