pact_broker 2.22.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 107e0313842be2bc851feb80d62920c27f320509
-  data.tar.gz: d411b036f55dc4d75544d13f607bcdd156485daf
+  metadata.gz: 8781ad53ce4869d80b5c2ad87288cd6d6e1561da
+  data.tar.gz: e83f9bc9fd4b337ac1d28a210402db80af340a5f
 SHA512:
-  metadata.gz: c00e5f4e37da0f499641550cae06a874ae384065ab7afe3e0b44901e5ea87218b69715936d704b4701e3d310d1f66239395319ca111bbdca6ba488c57828e78c
-  data.tar.gz: 2beb39b0a6fabee40acd5d7259437262f120ae8c0bf5273c32e79ad66be3fa32fd13b18629cfd94b9877f470c7a6ff2f62c71a478ac9a1a2fcee1baf1e02c123
+  metadata.gz: 3c424033d9cb8fa602a2344d11eea58722001df6fc6555e10d51a4af28b29e92f660156650da1b7fd511a7496e5e9b9d01afdec1b4d288569cf49a567ef9a818
+  data.tar.gz: f746b17398c51084398b6c4197a4c42b61ea91b7f8b95c210234cb00102fff4f82e9f4ac5e4c26136ee1b375c1147d23909e137ee40e7ec8a21eefbd30432994

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+<a name="v2.23.0"></a>
+### v2.23.0 (2018-06-20)
+
+
+#### Features
+
+* include test webhook request in execution response body	 ([7518098](/../../commit/7518098))
+* use the latest matching pact or verification to test webhook execution, or a placeholder if either is not found	 ([273078b](/../../commit/273078b))
+* add resource to view the triggered webhooks for a verification result	 ([c3e8df0](/../../commit/c3e8df0))
+* add resource to view the triggered webhooks for a pact publication	 ([00f60c1](/../../commit/00f60c1))
+* allow "global" webhooks (matching all consumers and providers) to be triggered by pact or verification publication	 ([19f7060](/../../commit/19f7060))
+* allow webhook with optional consumer and/or provider to be created by posting to /webhooks	 ([b15ba85](/../../commit/b15ba85))
+* add consumer and provider objects to webhook resource	 ([e60460e](/../../commit/e60460e))
+* move $.message to $.error.message in error response body	 ([803c025](/../../commit/803c025))
+* only show backtrace in error response for non production environments	 ([665ac23](/../../commit/665ac23))
+* change version ordering to sort by date by default	 ([6552b46](/../../commit/6552b46))
+* raise explicit error if a matrix query is done for a version with a tag that does not exist	 ([8f64288](/../../commit/8f64288))
+
+* **consumer or provider webhooks**
+  * refactor webhooks resource classes and add consumer and provider webhook links to pact resource	 ([9321c73](/../../commit/9321c73))
+  * change pact webhook status URL	 ([2445b1e](/../../commit/2445b1e))
+  * allow a webhook to be defined for either a consumer OR provider	 ([37a62be](/../../commit/37a62be))
+
+
+#### Bug Fixes
+
+* ensure non utf-8 characters in the webook response do not cause an error in the Pact Broker response body	 ([a5ae5bf](/../../commit/a5ae5bf))
+* update sintra to >= 2.0.2 to fix css vulnerability	 ([3023408](/../../commit/3023408))
+
+
 <a name="v2.22.0"></a>
 ### v2.22.0 (2018-06-11)
 

data/README.md

@@ -148,6 +148,7 @@ You can use the [Pact Broker Docker image][docker] or [Terraform on AWS][terrafo
 `
 * Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
 * For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application. You'll need to read up on the documentation for these yourself as it is beyond the scope of this documentation. See the [wiki][reverse-proxy-docs] for instructions on using a reverse proxy with SSL.
+* Ensure the environment variable `RACK_ENV` is set to `production`.
 * Deploy to your location of choice.
 
 ## Upgrading

data/db/migrations/20180611_make_webhook_pacticipant_ids_optional.rb

@@ -0,0 +1,11 @@
+Sequel.migration do
+  up do
+    alter_table(:webhooks) do
+      set_column_allow_null(:consumer_id)
+      set_column_allow_null(:provider_id)
+    end
+  end
+
+  down do
+  end
+end

data/example/config.ru

@@ -4,6 +4,8 @@ require 'sequel'
 # require 'pg' # for postgres
 require 'pact_broker'
 
+ENV['RACK_ENV'] ||= 'production'
+
 # Create a real database, and set the credentials for it here
 # It is highly recommended to set the encoding to utf8
 DATABASE_CREDENTIALS = {adapter: "sqlite", database: "pact_broker_database.sqlite3", :encoding => 'utf8'}

data/lib/pact_broker/api.rb

@@ -22,6 +22,7 @@ module PactBroker
         # Verifications
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results'], Api::Resources::Verifications, {resource_name: "verification_results"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', :verification_number], Api::Resources::Verification, {resource_name: "verification_result"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', :verification_number, 'triggered-webhooks'], Api::Resources::VerificationTriggeredWebhooks, {resource_name: "verification_result_triggered_webhooks"}
         add ['verification-results', 'consumer', :consumer_name, 'version', :consumer_version_number,'latest'], Api::Resources::LatestVerificationsForConsumerVersion, {resource_name: "verification_results_for_consumer_version"}
 
         # Badges
@@ -55,13 +56,18 @@ module PactBroker
         add ['pacticipants', :pacticipant_name, 'labels', :label_name], Api::Resources::Label, {resource_name: "pacticipant_label"}
 
         # Webhooks
-        add ['webhooks', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::PactWebhooks, {resource_name: "pact_webhooks"}
-        add ['webhooks', 'provider', :provider_name, 'consumer', :consumer_name, 'status' ], Api::Resources::PactWebhooksStatus, {resource_name: "pact_webhooks_status"}
+        add ['webhooks', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::Webhooks, {resource_name: "consumer_and_provider_webhooks"}
+        add ['webhooks', 'provider', :provider_name], Api::Resources::Webhooks, {resource_name: "provider_webhooks"}
+        add ['webhooks', 'consumer', :consumer_name], Api::Resources::Webhooks, {resource_name: "consumer_webhooks"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'webhooks'], Api::Resources::PactWebhooks, {resource_name: "pact_webhooks"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'webhooks', 'status'], Api::Resources::PactWebhooksStatus, {resource_name: "pact_webhooks_status"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'triggered-webhooks'], Api::Resources::PactTriggeredWebhooks, {resource_name: "pact_triggered_webhooks"}
 
         add ['webhooks', :uuid ], Api::Resources::Webhook, {resource_name: "webhook"}
         add ['webhooks', :uuid, 'trigger', :trigger_uuid, 'logs' ], Api::Resources::TriggeredWebhookLogs, {resource_name: "triggered_webhook_logs"}
         add ['webhooks', :uuid, 'execute' ], Api::Resources::WebhookExecution, {resource_name: "execute_webhook"}
-        add ['webhooks'], Api::Resources::Webhooks, {resource_name: "webhooks"}
+        add ['webhooks'], Api::Resources::AllWebhooks, {resource_name: "webhooks"}
+
 
         add ['relationships'], Api::Resources::Relationships, {resource_name: "relationships"}
         add ['groups', :pacticipant_name], Api::Resources::Group, {resource_name: "group"}

data/lib/pact_broker/api/contracts/webhook_contract.rb

@@ -2,6 +2,7 @@ require 'reform'
 require 'reform/form'
 require 'pact_broker/webhooks/check_host_whitelist'
 require 'pact_broker/webhooks/render'
+require 'pact_broker/pacticipants/service'
 
 module PactBroker
   module Api
@@ -26,10 +27,45 @@ module PactBroker
             config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
           end
 
+          optional(:consumer)
+          optional(:provider)
           required(:request).filled
           optional(:events).maybe(min_size?: 1)
         end
 
+        property :consumer do
+          property :name
+
+          validation do
+            configure do
+              config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
+
+              def pacticipant_exists?(name)
+                !!PactBroker::Pacticipants::Service.find_pacticipant_by_name(name)
+              end
+            end
+
+            required(:name).filled(:pacticipant_exists?)
+          end
+
+        end
+
+        property :provider do
+          property :name
+
+          validation do
+            configure do
+              config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
+
+              def pacticipant_exists?(name)
+                !!PactBroker::Pacticipants::Service.find_pacticipant_by_name(name)
+              end
+            end
+
+            required(:name).filled(:pacticipant_exists?)
+          end
+        end
+
         property :request do
           property :url
           property :http_method

data/lib/pact_broker/api/decorators/pact_decorator.rb

@@ -102,7 +102,21 @@ module PactBroker
         link :'pb:pact-webhooks' do | options |
           {
             title: "Webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
-            href: webhooks_for_pact_url(represented.consumer, represented.provider, options.fetch(:base_url))
+            href: webhooks_for_consumer_and_provider_url(represented.consumer, represented.provider, options.fetch(:base_url))
+          }
+        end
+
+        link :'pb:consumer-webhooks' do | options |
+          {
+            title: "Webhooks for all pacts with consumer #{represented.consumer.name}",
+            href: consumer_webhooks_url(represented.consumer, options.fetch(:base_url))
+          }
+        end
+
+        link :'pb:consumer-webhooks' do | options |
+          {
+            title: "Webhooks for all pacts with provider #{represented.provider.name}",
+            href: consumer_webhooks_url(represented.provider, options.fetch(:base_url))
           }
         end
 
@@ -127,6 +141,13 @@ module PactBroker
           }
         end
 
+        link :'pb:triggered-webhooks' do | options |
+          {
+            title: "Webhooks triggered by the publication of this pact",
+            href: pact_triggered_webhooks_url(represented, options.fetch(:base_url))
+          }
+        end
+
         curies do | options |
           [{
             name: :pb,

data/lib/pact_broker/api/decorators/pact_webhooks_status_decorator.rb

@@ -1,37 +1,12 @@
 require_relative 'base_decorator'
 require_relative 'timestamps'
 require_relative 'pact_version_decorator'
+require_relative 'triggered_webhook_decorator'
 
 module PactBroker
   module Api
     module Decorators
 
-      class TriggeredWebhookDecorator < BaseDecorator
-        property :request_description, as: :name
-        property :status
-        property :number_of_attempts_made, as: :attemptsMade
-        property :number_of_attempts_remaining, as: :attemptsRemaining
-        property :trigger_type, as: :triggerType
-
-        property :created_at, as: :triggeredAt
-
-        link :logs do | context |
-          {
-            href: triggered_webhook_logs_url(represented, context[:base_url]),
-            title: "Webhook execution logs",
-            name: represented.request_description
-          }
-        end
-
-        link :'pb:webhook' do | context |
-          {
-            href: webhook_url(represented.webhook_uuid, context[:base_url]),
-            title: "Webhook",
-            name: represented.request_description
-          }
-        end
-      end
-
       class PactWebhooksStatusDecorator < BaseDecorator
 
         property :summary, exec_context: :decorator do

data/lib/pact_broker/api/decorators/triggered_webhook_decorator.rb

@@ -0,0 +1,33 @@
+require_relative 'base_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class TriggeredWebhookDecorator < BaseDecorator
+        property :request_description, as: :name
+        property :status
+        property :number_of_attempts_made, as: :attemptsMade
+        property :number_of_attempts_remaining, as: :attemptsRemaining
+        property :trigger_type, as: :triggerType
+
+        property :created_at, as: :triggeredAt
+
+        link :logs do | context |
+          {
+            href: triggered_webhook_logs_url(represented, context[:base_url]),
+            title: "Webhook execution logs",
+            name: represented.request_description
+          }
+        end
+
+        link :'pb:webhook' do | context |
+          {
+            href: webhook_url(represented.webhook_uuid, context[:base_url]),
+            title: "Webhook",
+            name: represented.request_description
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/triggered_webhooks_decorator.rb

@@ -0,0 +1,19 @@
+require 'pact_broker/api/decorators/base_decorator'
+require 'pact_broker/api/decorators/triggered_webhook_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class TriggeredWebhooksDecorator < BaseDecorator
+        collection :entries, as: :triggeredWebhooks, embedded: true, :extend => PactBroker::Api::Decorators::TriggeredWebhookDecorator
+
+        link :self do | options |
+          {
+            title: options.fetch(:resource_title),
+            href: options.fetch(:resource_url)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/verification_decorator.rb

@@ -28,6 +28,12 @@ module PactBroker
           }
         end
 
+        link 'pb:triggered-webhooks' do | options |
+          {
+            title: 'Webhooks triggered by the publication of this verification result',
+            href: verification_triggered_webhooks_url(represented, options.fetch(:base_url))
+          }
+        end
       end
     end
   end

data/lib/pact_broker/api/decorators/webhook_decorator.rb

@@ -1,7 +1,7 @@
 require_relative 'base_decorator'
-require 'pact_broker/api/decorators/webhook_request_decorator'
+require 'pact_broker/api/decorators/webhook_request_template_decorator'
 require 'pact_broker/api/decorators/timestamps'
-require 'pact_broker/domain/webhook_request'
+require 'pact_broker/webhooks/webhook_request_template'
 require 'pact_broker/webhooks/webhook_event'
 require 'pact_broker/api/decorators/basic_pacticipant_decorator'
 require_relative 'pact_pacticipant_decorator'
@@ -16,7 +16,15 @@ module PactBroker
           property :name
         end
 
-        property :request, :class => PactBroker::Domain::WebhookRequest, extend: WebhookRequestDecorator
+        property :consumer, :class => PactBroker::Domain::Pacticipant do
+          property :name
+        end
+
+        property :provider, :class => PactBroker::Domain::Pacticipant do
+          property :name
+        end
+
+        property :request, :class => PactBroker::Webhooks::WebhookRequestTemplate, extend: WebhookRequestTemplateDecorator
         collection :events, :class => PactBroker::Webhooks::WebhookEvent, extend: WebhookEventDecorator
 
         include Timestamps
@@ -31,33 +39,39 @@ module PactBroker
 
         link :'pb:execute' do | options |
           {
-            title: "Test the execution of the webhook by sending a POST request to this URL",
+            title: "Test the execution of the webhook with the latest matching pact or verification by sending a POST request to this URL",
             href: webhook_execution_url(represented, options[:base_url])
           }
         end
 
 
         link :'pb:consumer' do | options |
-          {
-            title: "Consumer",
-            name: represented.consumer.name,
-            href: pacticipant_url(options.fetch(:base_url), represented.consumer)
-          }
+          if represented.consumer
+            {
+              title: "Consumer",
+              name: represented.consumer.name,
+              href: pacticipant_url(options.fetch(:base_url), represented.consumer)
+            }
+          end
         end
 
         link :'pb:provider' do | options |
-          {
-            title: "Provider",
-            name: represented.provider.name,
-            href: pacticipant_url(options.fetch(:base_url), represented.provider)
-          }
+          if represented.provider
+            {
+              title: "Provider",
+              name: represented.provider.name,
+              href: pacticipant_url(options.fetch(:base_url), represented.provider)
+            }
+          end
         end
 
         link :'pb:pact-webhooks' do | options |
-          {
-            title: "All webhooks for consumer #{represented.consumer.name} and provider #{represented.provider.name}",
-            href: webhooks_for_pact_url(represented.consumer, represented.provider, options[:base_url])
-          }
+          if represented.consumer && represented.provider
+            {
+              title: "All webhooks for consumer #{represented.consumer.name} and provider #{represented.provider.name}",
+              href: webhooks_for_consumer_and_provider_url(represented.consumer, represented.provider, options[:base_url])
+            }
+          end
         end
 
         link :'pb:webhooks' do | options |

data/lib/pact_broker/api/decorators/webhook_execution_result_decorator.rb

@@ -11,6 +11,32 @@ module PactBroker
           property :backtrace
         end
 
+        class HTTPRequestDecorator < BaseDecorator
+          property :headers, exec_context: :decorator
+          property :body, exec_context: :decorator
+          property :url, exec_context: :decorator
+
+          def headers
+            headers_hash = represented.to_hash
+            headers_hash.keys.each_with_object({}) do | name, new_headers_hash|
+              new_headers_hash[name] = headers_hash[name].join(", ")
+            end
+          end
+
+          def body
+            begin
+              ::JSON.parse(represented.body)
+            rescue StandardError => e
+              represented.body
+            end
+          end
+
+          def url
+            (represented.uri || represented.path).to_s
+          end
+        end
+
+
         class HTTPResponseDecorator < BaseDecorator
           property :status, :getter => lambda { |_| code.to_i }
           property :headers, exec_context: :decorator
@@ -33,6 +59,7 @@ module PactBroker
         end
 
         property :error, :extend => ErrorDecorator, if: lambda { |context| context[:options][:user_options][:show_response] }
+        property :request, :extend => HTTPRequestDecorator
         property :response, :extend => HTTPResponseDecorator, if: lambda { |context| context[:options][:user_options][:show_response] }
         property :response_hidden_message, as: :message, exec_context: :decorator, if: lambda { |context| !context[:options][:user_options][:show_response] }
 

data/lib/pact_broker/api/decorators/{webhook_request_decorator.rb → webhook_request_template_decorator.rb}

@@ -3,7 +3,7 @@ require_relative 'base_decorator'
 module PactBroker
   module Api
     module Decorators
-      class WebhookRequestDecorator < BaseDecorator
+      class WebhookRequestTemplateDecorator < BaseDecorator
 
         property :method
         property :url

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -120,6 +120,10 @@ module PactBroker
         "#{base_url}/verification-results/consumer/#{url_encode(version.pacticipant.name)}/version/#{version.number}/latest"
       end
 
+      def verification_triggered_webhooks_url verification, base_url = ''
+        "#{verification_url(verification, base_url)}/triggered-webhooks"
+      end
+
       def verification_publication_url pact, base_url
         "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}/verification-results"
       end
@@ -152,14 +156,30 @@ module PactBroker
         "#{base_url}/webhooks/#{webhook.uuid}/execute"
       end
 
-      def webhooks_for_pact_url consumer, provider, base_url = ''
+      def webhooks_for_consumer_and_provider_url consumer, provider, base_url = ''
         "#{base_url}/webhooks/provider/#{url_encode(provider.name)}/consumer/#{url_encode(consumer.name)}"
       end
 
+      def consumer_webhooks_url consumer, base_url = ''
+        "#{base_url}/webhooks/consumer/#{url_encode(consumer.name)}"
+      end
+
+      def provider_webhooks_url provider, base_url = ''
+        "#{base_url}/webhooks/provider/#{url_encode(provider.name)}"
+      end
+
+      def webhooks_for_pact_url consumer, provider, base_url = ''
+        "#{base_url}/pacts/provider/#{url_encode(provider.name)}/consumer/#{url_encode(consumer.name)}/webhooks"
+      end
+
       def webhooks_status_url consumer, provider, base_url = ''
         "#{webhooks_for_pact_url(consumer, provider, base_url)}/status"
       end
 
+      def pact_triggered_webhooks_url pact, base_url = ''
+        "#{pact_url(base_url, pact)}/triggered-webhooks"
+      end
+
       def triggered_webhook_logs_url triggered_webhook, base_url
         "#{base_url}/webhooks/#{triggered_webhook.webhook_uuid}/trigger/#{triggered_webhook.trigger_uuid}/logs"
       end