pact_broker 2.31.0 → 2.32.0

data/lib/pact_broker/webhooks/trigger_service.rb

@@ -9,21 +9,21 @@ module PactBroker
       extend PactBroker::Services
       include PactBroker::Logging
 
-      def trigger_webhooks_for_new_pact pact
-        webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED
+      def trigger_webhooks_for_new_pact(pact, webhook_options)
+        webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED, webhook_options
         if pact_is_new_or_newly_tagged_or_pact_has_changed_since_previous_version?(pact)
-          webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED
+          webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED, webhook_options
         else
           logger.debug "Pact content has not changed since previous version, not triggering webhooks for changed content"
         end
       end
 
-      def trigger_webhooks_for_updated_pact(existing_pact, updated_pact)
-        webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED
+      def trigger_webhooks_for_updated_pact(existing_pact, updated_pact, webhook_options)
+        webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED, webhook_options
         # TODO this should use the sha!
         if existing_pact.pact_version_sha != updated_pact.pact_version_sha
           logger.debug "Existing pact for version #{existing_pact.consumer_version_number} has been updated with new content, triggering webhooks for changed content"
-          webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED
+          webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED, webhook_options
         else
           logger.debug "Pact content has not changed since previous revision, not triggering webhooks for changed content"
         end

data/lib/pact_broker/webhooks/webhook.rb

@@ -15,6 +15,10 @@ module PactBroker
 
       dataset_module do
         include PactBroker::Repositories::Helpers
+
+        def enabled
+          where(enabled: true)
+        end
       end
 
       def before_destroy
@@ -42,10 +46,12 @@ module PactBroker
       def to_domain
         Domain::Webhook.new(
           uuid: uuid,
+          description: description,
           consumer: consumer,
           provider: provider,
           events: events,
           request: Webhooks::WebhookRequestTemplate.new(request_attributes),
+          enabled: enabled,
           created_at: created_at,
           updated_at: updated_at)
       end
@@ -81,17 +87,19 @@ module PactBroker
       def self.properties_hash_from_domain webhook
         is_json_request_body = !(String === webhook.request.body || webhook.request.body.nil?) # Can't rely on people to set content type
         {
+          description: webhook.description,
           method: webhook.request.method,
           url: webhook.request.url,
           username: webhook.request.username,
           password: not_plain_text_password(webhook.request.password),
+          enabled: webhook.enabled.nil? ? true : webhook.enabled,
           body: (is_json_request_body ? webhook.request.body.to_json : webhook.request.body),
           is_json_request_body: is_json_request_body
         }
       end
     end
 
-    Webhook.plugin :timestamps, :update_on_create=>true
+    Webhook.plugin :timestamps, update_on_create: true
 
     class WebhookHeader < Sequel::Model
       associate(:many_to_one, :webhook, :class => "PactBroker::Repositories::Webhook", :key => :webhook_id, :primary_key => :id)

data/lib/pact_broker/webhooks/webhook_request_template.rb

@@ -22,7 +22,7 @@ module PactBroker
         @url = attributes[:url]
         @username = attributes[:username]
         @password = attributes[:password]
-        @headers = attributes[:headers] || {}
+        @headers = Rack::Utils::HeaderHash.new(attributes[:headers] || {})
         @body = attributes[:body]
         @uuid = attributes[:uuid]
       end
@@ -30,23 +30,23 @@ module PactBroker
       def build(context)
         attributes = {
           method: http_method,
-          url: build_url(context[:pact], context[:verification], context[:base_url]),
+          url: build_url(context[:pact], context[:verification], context[:webhook_context]),
           headers: headers,
           username: username,
           password: password,
           uuid: uuid,
-          body: build_body(context[:pact], context[:verification], context[:base_url])
+          body: build_body(context[:pact], context[:verification], context[:webhook_context])
         }
         PactBroker::Domain::WebhookRequest.new(attributes)
       end
 
-      def build_url(pact, verification, broker_base_url)
-        URI(PactBroker::Webhooks::Render.call(url, pact, verification, broker_base_url){ | value | CGI::escape(value) if !value.nil? } ).to_s
+      def build_url(pact, verification, webhook_context)
+        URI(PactBroker::Webhooks::Render.call(url, pact, verification, webhook_context){ | value | CGI::escape(value) if !value.nil? } ).to_s
       end
 
-      def build_body(pact, verification, broker_base_url)
+      def build_body(pact, verification, webhook_context)
         body_string = String === body ? body : body.to_json
-        PactBroker::Webhooks::Render.call(body_string, pact, verification, broker_base_url)
+        PactBroker::Webhooks::Render.call(body_string, pact, verification, webhook_context)
       end
 
       def description
@@ -64,6 +64,10 @@ module PactBroker
         end
       end
 
+      def headers= headers
+        @headers = Rack::Utils::HeaderHash.new(headers)
+      end
+
       private
 
       def to_s

data/lib/rack/pact_broker/database_transaction.rb

@@ -22,14 +22,18 @@ module Rack
       def call env
         set_database_connector
         if use_transaction? env
-          call_with_transaction env
+          call_with_transaction(add_database_connector(env))
         else
-          call_without_transaction env
+          call_without_transaction(add_database_connector(env))
         end
       ensure
         clear_database_connector
       end
 
+      def add_database_connector(env)
+        env.merge("pactbroker.database_connector" => @default_database_connector)
+      end
+
       def use_transaction? env
         TRANS_METHODS.include? env[REQUEST_METHOD]
       end

data/script/publish-new.sh

@@ -1,9 +1,31 @@
 set -e
+
 BODY=$(ruby -e "require 'json'; j = JSON.parse(File.read('script/foo-bar.json')); j['interactions'][0]['providerState'] = 'it is ' + Time.now.to_s; puts j.to_json")
 latest_url=$(curl http://localhost:9292/pacts/provider/Bar/consumer/Foo/latest | jq -r ._links.self.href)
 next_version=$(echo ${latest_url} | ruby -e "version = ARGF.read[/\d+\.\d+\.\d+/]; require 'semver'; puts SemVer.parse(version).tap{ | v| v.minor = v.minor + 1}.format('%M.%m.%p')")
+
+curl -v -XPUT \
+  -H "Content-Length: 0" \
+  -H "Content-Type: application/json" \
+  http://localhost:9292/pacticipants/Foo/versions/${next_version}/tags/dev
+
 echo ${BODY} > tmp.json
 curl -v -XPUT \-H "Content-Type: application/json" -d@tmp.json \
   http://localhost:9292/pacts/provider/Bar/consumer/Foo/version/${next_version}
+
+
+sleep 3
+
+
+curl -v -XPUT \
+  -H "Content-Length: 0" \
+  -H "Content-Type: application/json" \
+  http://localhost:9292/pacticipants/Foo/versions/${next_version}/tags/prod
+
+next_next_version=$(echo ${next_version} | ruby -e "version = ARGF.read[/\d+\.\d+\.\d+/]; require 'semver'; puts SemVer.parse(version).tap{ | v| v.minor = v.minor + 1}.format('%M.%m.%p')")
+
+curl -v -XPUT \-H "Content-Type: application/json" -d@tmp.json \
+  http://localhost:9292/pacts/provider/Bar/consumer/Foo/version/${next_next_version}
+
 rm tmp.json
-echo ""
+echo ""

data/script/publish.sh

@@ -1,19 +1,28 @@
 #!/bin/sh
 function finish {
-  rm -rf tmp/pact.json
+  rm -rf $tmpfile
 }
 trap finish EXIT
 
 set -x
 
+consumer_version="1.0.$(ruby -e "puts (rand * 10).to_i")"
 consumer=${1:-Foo}
 provider=${2:-Bar}
 escaped_consumer=$(echo $consumer | ruby -e "require 'uri'; puts URI.encode(ARGF.read.strip)")
 escaped_provider=$(echo $provider | ruby -e "require 'uri'; puts URI.encode(ARGF.read.strip)")
 echo $consumer $provider
+
+curl -v -XPUT \
+  -H "Content-Length: 0" \
+  -H "Content-Type: application/json" \
+  http://localhost:9292/pacticipants/${escaped_consumer}/versions/${consumer_version}/tags/dev
+
+
 body=$(cat script/foo-bar.json | sed "s/Foo/${consumer}/" | sed "s/Bar/${provider}/")
-echo $body > tmp/pact.json
+tmpfile=$(mktemp)
+echo $body > $tmpfile
 curl -v -XPUT \-H "Content-Type: application/json" \
--d@tmp/pact.json \
-http://127.0.0.1:9292/pacts/provider/${escaped_provider}/consumer/${escaped_consumer}/version/1.0.0
+-d@$tmpfile \
+http://127.0.0.1:9292/pacts/provider/${escaped_provider}/consumer/${escaped_consumer}/version/${consumer_version}
 echo ""

data/script/seed.rb

@@ -14,7 +14,7 @@ DATABASE_CREDENTIALS = {logger: Logger.new($stdout), adapter: "sqlite", database
 connection = Sequel.connect(DATABASE_CREDENTIALS)
 connection.timezone = :utc
 # Uncomment these lines to open a pry session for inspecting the database
-# require 'table_print'
+
 # require 'pry'; pry(binding);
 # exit
 
@@ -44,54 +44,55 @@ webhook_body = {
 }
 
 TestDataBuilder.new
-  .create_global_webhook(method: 'GET', url: "http://example.org?consumer=${pactbroker.consumerName}&provider=${pactbroker.providerName}")
-  .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
-  .create_consumer("Bethtest")
-  .create_verification_webhook(method: 'GET', url: "http://localhost:9292", body: webhook_body, username: "foo", password: "bar", headers: {"Accept" => "application/json"})
-  .create_consumer("Foo")
-  .create_label("microservice")
-  .create_provider("Bar")
-  .create_label("microservice")
-  .create_verification_webhook(method: 'GET', url: "http://example.org")
-  .create_consumer_webhook(method: 'GET', url: 'https://www.google.com.au', event_names: ['provider_verification_published'])
-  .create_provider_webhook(method: 'GET', url: 'https://theage.com.au')
-  .create_webhook(method: 'GET', url: 'https://self-signed.badssl.com')
-  .create_consumer_version("1.2.100")
-  .create_pact
-  .create_verification(provider_version: "1.4.234", success: true, execution_date: DateTime.now - 15)
-  .revise_pact
-  .create_consumer_version("1.2.101")
-  .create_consumer_version_tag('prod')
-  .create_pact
-  .create_verification(provider_version: "9.9.10", success: false, execution_date: DateTime.now - 15)
-  .create_consumer_version("1.2.102")
-  .create_pact(created_at: (Date.today - 7).to_datetime)
-  .create_verification(provider_version: "9.9.9", success: true, execution_date: DateTime.now - 14)
-  .create_provider("Animals")
-  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
-  .create_pact(created_at: (Time.now - 140).to_datetime)
-  .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
-  .create_provider("Wiffles")
-  .create_pact
-  .create_verification(provider_version: "3.6.100", success: false, execution_date: Date.today - 7)
-  .create_provider("Hello World App")
-  .create_consumer_version("1.2.107")
-  .create_pact(created_at: (Date.today - 1).to_datetime)
-  .create_consumer("The Android App")
-  .create_provider("The back end")
-  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
-  .create_consumer_version("1.2.106")
-  .create_consumer_version_tag("production")
-  .create_consumer_version_tag("feat-x")
-  .create_pact
-  .create_consumer("Some other app")
-  .create_provider("A service")
-  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
-  .create_triggered_webhook(status: 'success')
-  .create_webhook_execution
-  .create_webhook(method: 'POST', url: 'http://foo:9393/')
-  .create_triggered_webhook(status: 'failure')
-  .create_webhook_execution
-  .create_consumer_version("1.2.106")
-  .create_pact(created_at: (Date.today - 26).to_datetime)
-  .create_verification(provider_version: "4.8.152", execution_date: DateTime.now)
+  .create_global_webhook(method: 'POST', url: "http://localhost:9292/pact-changed-webhook", body: webhook_body.to_json)
+  .create_global_verification_webhook(method: 'POST', url: "http://localhost:9292/verification-published-webhook", body: webhook_body.to_json)
+  # .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
+  # .create_consumer("Bethtest")
+  # .create_verification_webhook(method: 'GET', url: "http://localhost:9292", body: webhook_body, username: "foo", password: "bar", headers: {"Accept" => "application/json"})
+  # .create_consumer("Foo")
+  # .create_label("microservice")
+  # .create_provider("Bar")
+  # .create_label("microservice")
+  # .create_verification_webhook(method: 'GET', url: "http://example.org")
+  # .create_consumer_webhook(method: 'GET', url: 'https://www.google.com.au', event_names: ['provider_verification_published'])
+  # .create_provider_webhook(method: 'GET', url: 'https://theage.com.au')
+  # .create_webhook(method: 'GET', url: 'https://self-signed.badssl.com')
+  # .create_consumer_version("1.2.100")
+  # .create_pact
+  # .create_verification(provider_version: "1.4.234", success: true, execution_date: DateTime.now - 15)
+  # .revise_pact
+  # .create_consumer_version("1.2.101")
+  # .create_consumer_version_tag('prod')
+  # .create_pact
+  # .create_verification(provider_version: "9.9.10", success: false, execution_date: DateTime.now - 15)
+  # .create_consumer_version("1.2.102")
+  # .create_pact(created_at: (Date.today - 7).to_datetime)
+  # .create_verification(provider_version: "9.9.9", success: true, execution_date: DateTime.now - 14)
+  # .create_provider("Animals")
+  # .create_webhook(method: 'GET', url: 'http://localhost:9393/')
+  # .create_pact(created_at: (Time.now - 140).to_datetime)
+  # .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
+  # .create_provider("Wiffles")
+  # .create_pact
+  # .create_verification(provider_version: "3.6.100", success: false, execution_date: Date.today - 7)
+  # .create_provider("Hello World App")
+  # .create_consumer_version("1.2.107")
+  # .create_pact(created_at: (Date.today - 1).to_datetime)
+  # .create_consumer("The Android App")
+  # .create_provider("The back end")
+  # .create_webhook(method: 'GET', url: 'http://localhost:9393/')
+  # .create_consumer_version("1.2.106")
+  # .create_consumer_version_tag("production")
+  # .create_consumer_version_tag("feat-x")
+  # .create_pact
+  # .create_consumer("Some other app")
+  # .create_provider("A service")
+  # .create_webhook(method: 'GET', url: 'http://localhost:9393/')
+  # .create_triggered_webhook(status: 'success')
+  # .create_webhook_execution
+  # .create_webhook(method: 'POST', url: 'http://foo:9393/')
+  # .create_triggered_webhook(status: 'failure')
+  # .create_webhook_execution
+  # .create_consumer_version("1.2.106")
+  # .create_pact(created_at: (Date.today - 26).to_datetime)
+  # .create_verification(provider_version: "4.8.152", execution_date: DateTime.now)

data/spec/features/create_webhook_spec.rb

@@ -11,6 +11,8 @@ describe "Creating a webhook" do
   let(:webhook_json) { webhook_hash.to_json }
   let(:webhook_hash) do
     {
+      description: "trigger build",
+      enabled: false,
       events: [{
         name: 'something_happened'
       }],

data/spec/features/execute_webhook_spec.rb

@@ -19,9 +19,10 @@ describe "Execute a webhook" do
 
   context "when the execution is successful" do
     let!(:request) do
-      stub_request(:post, /http/).with(body: 'http://broker/pacts/provider/Bar/consumer/Foo/version/1').to_return(:status => 200, body: response_body)
+      stub_request(:post, /http/).with(body: expected_webhook_url).to_return(:status => 200, body: response_body)
     end
 
+    let(:expected_webhook_url) { %r{http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/.*/metadata/Y29uc3VtZXJfdmVyc2lvbl9udW1iZXI9MQ==} }
     let(:response_body) { "webhook-response-body" }
 
     it "performs the HTTP request" do
@@ -81,8 +82,8 @@ describe "Execute a webhook" do
 
     subject { post path; last_response }
 
-    it "returns a 500 response" do
-      expect(subject.status).to be 500
+    it "returns a 200 response" do
+      expect(subject.status).to be 200
     end
 
     it "does not save a TriggeredWebhook" do

data/spec/features/get_integrations_spec.rb

@@ -0,0 +1,17 @@
+describe "Get integrations dot file" do
+  before do
+    TestDataBuilder.new
+      .create_pact_with_hierarchy("Foo", "1", "Bar")
+  end
+
+  let(:path) { "/integrations" }
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+
+  subject { get path, nil, {'HTTP_ACCEPT' => 'application/hal+json' }  }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns a json body with embedded integrations" do
+    expect(JSON.parse(subject.body)["_embedded"]["integrations"]).to be_a(Array)
+  end
+end

data/spec/features/get_pacts_to_verify_spec.rb

@@ -12,7 +12,9 @@ describe "fetching pacts to verify", pending: 'not yet implemented' do
     # eg. if content has been verified on git branch (broker tag) feat-2,
     # it's still pending on master, and shouldn't fail the build
     {
-      provider_version_tags: [{ name: "feat-2" }],
+      protocol: "http1", # other option is "message"
+      include_other_pending: true, # whether or not to include pending pacts not already specified by the consumer_version_tags('head' pacts that have not yet been successfully verified)
+      provider_version_tags: [{ name: "feat-2" }], # the provider tags that will be applied to this app version when the results are published
       consumer_version_tags: [
         { name: "feat-1", fallback: "master" }, # allow a fallback to be provided for the "branch mirroring" workflow
         { name: "test", required: true }, # default to optional or required??? Ron?
@@ -30,8 +32,10 @@ describe "fetching pacts to verify", pending: 'not yet implemented' do
   end
 
   it "returns a list of links to the pacts" do
-    expect(response_body_hash[:_links][:'pb:pacts']).to be_instance_of(Array)
+    expect(response_body_hash[:_embedded][:'pacts']).to be_instance_of(Array)
   end
 
-  it "indicates whether a pact is pending or not"
+  it "indicates whether a pact is pending or not" do
+    expect(response_body_hash[:_embedded][:'pacts'].first[:pending]).to be true
+  end
 end

data/spec/features/publish_verification_spec.rb

@@ -7,8 +7,15 @@ describe "Recording a pact verification" do
   let(:verification_content) { load_fixture('verification.json') }
   let(:parsed_response_body) { JSON.parse(subject.body) }
   let(:pact) { td.pact }
+  let(:rack_env) do
+    {
+      'CONTENT_TYPE' => 'application/json',
+      'HTTP_ACCEPT' => 'application/hal+json',
+      'pactbroker.database_connector' => lambda { |&block| block.call }
+    }
+  end
 
-  subject { post path, verification_content, {'CONTENT_TYPE' => 'application/json', 'HTTP_ACCEPT' => 'application/hal+json' }; last_response  }
+  subject { post path, verification_content, rack_env; last_response  }
 
   before do
     td.create_provider("Provider")

data/spec/features/update_webhook_spec.rb

@@ -0,0 +1,47 @@
+require 'support/test_data_builder'
+
+describe "Updating a webhook" do
+  let(:webhook) do
+    TestDataBuilder.new
+      .create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+      .create_global_webhook
+      .and_return(:webhook)
+  end
+
+  let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:webhook_json) { webhook_hash.to_json }
+  let(:webhook_hash) do
+    {
+      description: "trigger build",
+      consumer: {
+        name: "Some Consumer"
+      },
+      enabled: false,
+      events: [{
+        name: 'contract_published'
+      }],
+      request: {
+        method: 'POST',
+        url: 'https://example.org',
+        headers: {
+          :"Content-Type" => "application/json"
+        },
+        body: {
+          a: 'body'
+        }
+      }
+    }
+  end
+
+  subject { put(path, webhook_json, headers) }
+
+  let(:path) { "/webhooks/#{webhook.uuid}" }
+
+  context "with valid attributes" do
+    it "returns the newly created webhook" do
+      subject
+      expect(response_body).to include description: "trigger build"
+    end
+  end
+end