pact_broker 2.12.0 → 2.13.0

data/db/test/change_migration_strategy/before/Gemfile

@@ -2,5 +2,6 @@ source 'https://rubygems.org'
 
 gem "rake", "~>12.0"
 gem "pact_broker", git: "https://github.com/pact-foundation/pact_broker.git", ref: "11d3464a120ed5f76e23241c79992fa04b702701"
+gem "webrick", "~>1.3.0" # Webrick requires Ruby version >= 2.5.0dev. TODO remove dependency on Pact gem.
 gem "sqlite3", "~>1.3"
 gem "pg"

data/example/README.md

@@ -0,0 +1,65 @@
+# Run Pact Broker example
+
+Clone project
+
+```bash
+git clone https://github.com/pact-foundation/pact_broker
+```
+
+Change directory to `example`
+
+```bash
+cd pact_broker/example
+```
+
+## Run with sqlite database
+
+Install dependencies
+
+```bash
+bundle install
+```
+
+Run Pact Broker
+
+```bash
+bundle exec rackup
+```
+
+## Run with postgres database
+
+Uncomment `gem 'pg'` in the [Gemfile](Gemfile)
+
+Comment out `gem 'sqlite3'` in the [Gemfile](Gemfile)
+
+Comment out the line with `DATABASE_CREDENTIALS = {adapter: "sqlite"...` in the [config.ru](config.ru#L9).
+
+Uncomment the line with `DATABASE_CREDENTIALS = {adapter: "postgres"...`. in the [config.ru](config.ru#L17).
+
+Set up postgres database
+
+```bash
+psql postgres -c "CREATE DATABASE pact_broker;"
+psql postgres -c "CREATE ROLE pact_broker WITH LOGIN PASSWORD 'pact_broker';"
+psql postgres -c "GRANT ALL PRIVILEGES ON DATABASE pact_broker TO pact_broker;"
+```
+
+Install dependencies
+
+```bash
+bundle install
+```
+
+Run Pact Broker
+
+```bash
+bundle exec rackup
+```
+
+If you need an example data run following command
+
+```bash
+psql pact_broker < example_data.sql
+```
+
+Now Pact Broker can be access locally at [http://localhost:9292](http://localhost:9292).

data/example/config.ru

@@ -11,6 +11,7 @@ DATABASE_CREDENTIALS = {adapter: "sqlite", database: "pact_broker_database.sqlit
 # For postgres:
 #
 # $ psql postgres -c "CREATE DATABASE pact_broker;"
+# $ psql postgres -c "CREATE ROLE pact_broker WITH LOGIN PASSWORD 'pact_broker';"
 # $ psql postgres -c "GRANT ALL PRIVILEGES ON DATABASE pact_broker TO pact_broker;"
 #
 # DATABASE_CREDENTIALS = {adapter: "postgres", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8'}

data/example/example_data.sql

@@ -0,0 +1,17 @@
+BEGIN TRANSACTION;
+INSERT INTO pacticipants VALUES(1,'Animal Service',NULL,'2014-11-18 06:28:36.261868','2014-11-18 06:28:36.261868');
+INSERT INTO pacticipants VALUES(2,'Zoo App',NULL,'2014-11-18 06:28:36.290466','2014-11-18 06:28:36.290466');
+INSERT INTO pacticipants VALUES(3,'Bar',NULL,'2017-05-23 06:10:23.235822','2017-05-23 06:10:23.235822');
+INSERT INTO pacticipants VALUES(4,'Foo',NULL,'2017-05-23 06:10:23.239004','2017-05-23 06:10:23.239004');
+INSERT INTO versions VALUES(1,'1.0.0',NULL,2,0,'2014-11-18 06:28:36.295750','2014-11-18 06:28:36.333021');
+INSERT INTO versions VALUES(2,'1.0.1',NULL,2,1,'2015-01-19 22:13:57.743993','2015-01-19 22:13:57.746417');
+INSERT INTO versions VALUES(3,'1.0.2',NULL,2,2,'2016-11-08 22:45:37.244731','2016-11-08 22:45:37.274760');
+INSERT INTO versions VALUES(4,'1.0.0',NULL,4,0,'2017-05-23 06:10:23.243015','2017-05-23 06:10:23.245281');
+INSERT INTO pact_versions VALUES(1,2,1,'15a22e805caa9d0153b815fc6566a0c03d4a82ae',replace('{\n  "provider": {\n    "name": "Animal Service"\n  },\n  "consumer": {\n    "name": "Zoo App"\n  },\n  "interactions": [\n    {\n      "description": "a request for an alligator",\n      "provider_state": "there is an alligator named Mary",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 200,\n        "headers": {\n          "Content-Type": "application/json;charset=utf-8"\n        },\n        "body": {\n          "name": "Mary"\n        }\n      }\n    },\n    {\n      "description": "a request for an alligator",\n      "provider_state": "there is not an alligator named Mary",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 404\n      }\n    },\n    {\n      "description": "a request for an alligator",\n      "provider_state": "an error occurs retrieving an alligator",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 500,\n        "headers": {\n          "Content-Type": "application/json;charset=utf-8"\n        },\n        "body": {\n          "error": "Argh!!!"\n        }\n      }\n    }\n  ],\n  "metadata": {\n    "pactSpecificationVersion": "1.0.0"\n  }\n}','\n',''),'2014-11-18 06:28:36.340041');
+INSERT INTO pact_versions VALUES(3,2,1,'23b64b5c5f5baf0e56dd92c4deddf9eb1e249d11',replace('{\n  "provider": {\n    "name": "Animal Service"\n  },\n  "consumer": {\n    "name": "Zoo App"\n  },\n  "interactions": [\n    {\n      "description": "a request for an alligator",\n      "provider_state": "there is an alligator named Mary",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 200,\n        "headers": {\n          "Content-Type": "application/json;charset=utf-8"\n        },\n        "body": {\n          "name": "Mary"\n        }\n      }\n    },\n    {\n      "description": "a request for an alligator",\n      "provider_state": "there is not an alligator named Mary",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 404\n      }\n    },\n    {\n      "description": "a request for an alligator",\n      "provider_state": "an error occurs retrieving an alligator",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 500,\n        "headers": {\n          "Content-Type": "application/json;charset=utf-8"\n        },\n        "body": {\n          "error": "Argh!!!"\n        }\n      }\n    },\n    {\n      "description": "a request for an alligator''s sister",\n      "provider_state": "there is an alligator named Mary",\n      "request": {\n        "method": "get",\n        "path": "/alligators/Mary/sister",\n        "headers": {\n          "Accept": "application/json"\n        }\n      },\n      "response": {\n        "status": 200,\n        "headers": {\n          "Content-Type": "application/json;charset=utf-8"\n        },\n        "body": {\n          "name": "Sue"\n        }\n      }\n    }\n  ],\n  "metadata": {\n    "pactSpecificationVersion": "1.0.0"\n  }\n}','\n',''),'2015-01-19 22:15:10.964768');
+INSERT INTO pact_versions VALUES(4,4,3,'73cd294d54d900e5ebb313896b1df8d1da8914f9',replace('{\n  "consumer": {\n    "name": "Foo"\n  },\n  "provider": {\n    "name": "Bar"\n  },\n  "interactions": [\n    {\n      "description": "a retrieve thing request",\n      "request": {\n        "method": "get",\n        "path": "/thing"\n      },\n      "response": {\n        "status": 200,\n        "headers": {\n          "Content-Type": "application/json"\n        },\n        "body": [\n          {\n            "status": "4"\n          }\n        ],\n        "matchingRules": {\n          "$.body": {\n            "min": 1\n          },\n          "$.body[*].*": {\n            "match": "type"\n          },\n          "$.body[*].status": {\n            "match": "regex",\n            "regex": "\\d+"\n          }\n        }\n      }\n    }\n  ],\n  "metadata": {\n    "pactSpecification": {\n      "version": "2.0.0"\n    }\n  }\n}','\n',''),'2017-05-23 06:10:23.249813');
+INSERT INTO pact_publications VALUES(1,1,1,1,1,'2014-11-18 06:28:36.340041');
+INSERT INTO pact_publications VALUES(2,2,1,1,3,'2015-01-19 22:15:10.969518');
+INSERT INTO pact_publications VALUES(3,3,1,1,1,'2016-11-08 22:45:37.291839');
+INSERT INTO pact_publications VALUES(4,4,3,1,4,'2017-05-23 06:10:23.252829');
+COMMIT;

data/lib/pact_broker/api.rb

@@ -61,6 +61,7 @@ module PactBroker
 
         # matrix
         add ['matrix', 'provider', :provider_name, 'consumer', :consumer_name], Api::Resources::MatrixForConsumerAndProvider, {resource_name: "matrix_consumer_provider"}
+        add ['matrix', 'provider', :provider_name, 'latest', :provider_tag, 'consumer', :consumer_name, 'latest', :tag, 'badge'], Api::Resources::MatrixBadge, {resource_name: "matrix_tag_badge"}
         add ['matrix'], Api::Resources::Matrix, {resource_name: "matrix"}
 
         add [], Api::Resources::Index, {resource_name: "index"}
@@ -73,5 +74,4 @@ module PactBroker
 
     pact_api.adapter
   end
-
 end

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

@@ -5,7 +5,6 @@ module PactBroker
   module Api
     module Contracts
       class WebhookContract < Reform::Form
-        property :request
 
         validation do
           configure do
@@ -13,6 +12,7 @@ module PactBroker
           end
 
           required(:request).filled
+          optional(:events).maybe(min_size?: 1)
         end
 
         property :request do
@@ -39,6 +39,14 @@ module PactBroker
             required(:url).filled(:valid_url?)
           end
         end
+
+        collection :events do
+          property :name
+
+          validation do
+            required(:name).filled
+          end
+        end
       end
     end
   end

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

@@ -10,6 +10,7 @@ module PactBroker
         property :success
         property :execution_date, as: :verificationDate
         property :build_url, as: :buildUrl
+        property :test_results, as: :testResults
 
         link :self do | options |
           {

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

@@ -2,19 +2,24 @@ require_relative 'base_decorator'
 require 'pact_broker/api/decorators/webhook_request_decorator'
 require 'pact_broker/api/decorators/timestamps'
 require 'pact_broker/domain/webhook_request'
+require 'pact_broker/webhooks/webhook_event'
 require 'pact_broker/api/decorators/basic_pacticipant_decorator'
+require_relative 'pact_pacticipant_decorator'
+require_relative 'pacticipant_decorator'
 
 module PactBroker
   module Api
     module Decorators
       class WebhookDecorator < BaseDecorator
 
-        property :request, :class => PactBroker::Domain::WebhookRequest, :extend => WebhookRequestDecorator
+        class WebhookEventDecorator < BaseDecorator
+          property :name
+        end
 
-        include Timestamps
+        property :request, :class => PactBroker::Domain::WebhookRequest, extend: WebhookRequestDecorator
+        collection :events, :class => PactBroker::Webhooks::WebhookEvent, extend: WebhookEventDecorator
 
-        property :consumer, :extend => PactBroker::Api::Decorators::BasicPacticipantDecorator, :embedded => true, writeable: false
-        property :provider, :extend => PactBroker::Api::Decorators::BasicPacticipantDecorator, :embedded => true, writeable: false
+        include Timestamps
 
         link :self do | options |
           {
@@ -31,9 +36,26 @@ module PactBroker
           }
         end
 
+
+        link :'pb:consumer' do | options |
+          {
+            title: "Consumer",
+            name: represented.consumer.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.consumer)
+          }
+        end
+
+        link :'pb:provider' do | options |
+          {
+            title: "Provider",
+            name: represented.provider.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.provider)
+          }
+        end
+
         link :'pb:pact-webhooks' do | options |
           {
-            title: "All webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
+            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])
           }
         end
@@ -44,6 +66,14 @@ module PactBroker
             href: webhooks_url(options[:base_url])
           }
         end
+
+        def from_json represented
+          super.tap do | webhook |
+            if webhook.events == nil
+              webhook.events = [PactBroker::Webhooks::WebhookEvent.new(name: PactBroker::Webhooks::WebhookEvent::DEFAULT_EVENT_NAME)]
+            end
+          end
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/matrix_badge.rb

@@ -0,0 +1,21 @@
+require 'pact_broker/api/resources/badge'
+
+module PactBroker
+  module Api
+    module Resources
+      class MatrixBadge < Badge
+
+        private
+
+        def latest_verification
+          @latest_verification ||= begin
+            matrix_row = matrix_service.find_for_consumer_and_provider_with_tags(identifier_from_path)
+            if matrix_row && matrix_row[:verification_id]
+              verification_service.find_by_id(matrix_row[:verification_id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/certificates/certificate.rb

@@ -0,0 +1,8 @@
+module PactBroker
+  module Certificates
+    class Certificate < Sequel::Model
+    end
+
+    Certificate.plugin :timestamps, update_on_create: true
+  end
+end

data/lib/pact_broker/certificates/service.rb

@@ -0,0 +1,41 @@
+require 'pact_broker/certificates/certificate'
+require 'pact_broker/logging'
+require 'openssl'
+
+module PactBroker
+  module Certificates
+    module Service
+
+      extend self
+      extend PactBroker::Logging
+
+      def cert_store
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.set_default_paths
+        find_all_certificates.each do | certificate |
+          begin
+            logger.debug("Loading certificate #{certificate.subject} in to cert store")
+            cert_store.add_cert(certificate)
+          rescue StandardError => e
+            log_error e, "Error adding certificate object #{certificate.to_s} to store"
+          end
+        end
+        cert_store
+      end
+
+      def find_all_certificates
+        Certificate.collect do | certificate |
+          cert_arr = certificate.content.split(/(-----END [^\-]+-----)/).each_slice(2).map(&:join)
+          cert_arr.collect do |c|
+            begin
+              OpenSSL::X509::Certificate.new(c)
+            rescue StandardError => e
+              log_error e, "Error creating certificate object from certificate #{certificate.uuid} '#{certificate.description}'"
+              nil
+            end
+          end
+        end.flatten.compact
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/controllers/app.rb

@@ -11,16 +11,26 @@ module PactBroker
         set :root, File.join(File.dirname(__FILE__), '..')
         set :show_exceptions, true
 
+        MAPPINGS = {
+          'webhooks-create' => 'webhooks',
+          'webhooks-webhooks' => 'webhooks',
+          'pact-webhooks' => 'webhooks',
+        }.freeze
+
         helpers do
+          def view_name_for rel_name
+            MAPPINGS[rel_name] || rel_name
+          end
+
           def resource_exists? rel_name
-            File.exist? File.join(self.class.root, 'views', "#{rel_name}.markdown")
+            File.exist? File.join(self.class.root, 'views', "#{view_name_for(rel_name)}.markdown")
           end
         end
 
         get ":rel_name" do
           rel_name = params[:rel_name]
           if resource_exists? rel_name
-            markdown rel_name.to_sym, {:layout_engine => :haml, layout: :'layouts/main'}, {}
+            markdown view_name_for(rel_name).to_sym, {:layout_engine => :haml, layout: :'layouts/main'}, {}
           else
             response.status = 404
           end

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -1,6 +1,8 @@
 # Webhooks
 
-Allowed methods: GET, POST, DELETE
+Allowed methods (collection resource): `GET`, `POST`
+
+Allowed methods (individual resource): `GET`, `PUT`, `DELETE`
 
 ### Creating
 
@@ -9,9 +11,12 @@ Allowed methods: GET, POST, DELETE
 2. Click the "NON-GET" button for the "pact-webhooks" relation.
 3. Paste in the webhook JSON (example shown below) in the body section and click "Make Request".
 
-An example webhook to trigger a Bamboo job.
+An example webhook to trigger a Bamboo job when a contract has changed.
 
     {
+      "events": [{
+        "name": "contract_content_changed"
+      }],
       "request": {
         "method": "POST",
         "url": "http://master.ci.my.domain:8085/rest/api/latest/queue/SOME-PROJECT?os_authType=basic",
@@ -26,6 +31,9 @@ An example webhook to trigger a Bamboo job.
 A request body can be specified as well.
 
     {
+      "events": [{
+        "name": "contract_content_changed"
+      }],
       "request": {
         "method": "POST",
         "url": "http://example.org/something",
@@ -37,6 +45,33 @@ A request body can be specified as well.
 
 **BEWARE** The password can be reverse engineered from the database, so make a separate account for the Pact Broker to use, don't use your personal account!
 
+#### Event types
+
+`contract_content_changed:` triggered when the content of the contract has changed since the previous publication. Uses plain string equality, so changes to the ordering of hash keys, or whitespace changes will trigger this webhook.
+
+`provider_verification_published:` triggered whenever a provider publishes a verification.
+
+### Dynamic variable substitution
+
+The following variables may be used in the request parameters or body, and will be replaced with their appropriate values at runtime.
+
+`${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
+
+Example usage:
+
+    {
+      "events": [{
+        "name": "contract_content_changed"
+      }],
+      "request": {
+        "method": "POST",
+        "url": "http://example.org/something",
+        "body": {
+          "thisPactWasPublished" : "${pactbroker.pactUrl}"
+        }
+      }
+    }
+
 ### Testing
 
 To test a webhook, navigate to the webhook in the HAL browser, then make a POST request to the "execute" relation. The response or error will be shown in the window.

data/lib/pact_broker/domain/verification.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/db'
 require 'pact_broker/repositories/helpers'
+require 'json'
 
 module PactBroker
 
@@ -9,6 +10,7 @@ module PactBroker
       set_primary_key :id
       associate(:many_to_one, :pact_version, class: "PactBroker::Pacts::PactVersion", key: :pact_version_id, primary_key: :id)
       associate(:many_to_one, :provider_version, class: "PactBroker::Domain::Version", key: :provider_version_id, primary_key: :id)
+      plugin :serialization, :json, :test_results
 
       def before_create
         super

data/lib/pact_broker/domain/webhook.rb

@@ -10,7 +10,7 @@ module PactBroker
       include Messages
       include Logging
 
-      attr_accessor :uuid, :consumer, :provider, :request, :created_at, :updated_at
+      attr_accessor :uuid, :consumer, :provider, :request, :created_at, :updated_at, :events
       attr_reader :attributes
 
       def initialize attributes = {}
@@ -19,6 +19,7 @@ module PactBroker
         @request = attributes[:request]
         @consumer = attributes[:consumer]
         @provider = attributes[:provider]
+        @events = attributes[:events]
         @created_at = attributes[:created_at]
         @updated_at = attributes[:updated_at]
       end

data/lib/pact_broker/domain/webhook_request.rb

@@ -5,6 +5,7 @@ require 'pact_broker/messages'
 require 'net/http'
 require 'pact_broker/webhooks/redact_logs'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/services'
 
 module PactBroker
 
@@ -23,6 +24,7 @@ module PactBroker
 
       include PactBroker::Logging
       include PactBroker::Messages
+      include PactBroker::Services
 
       attr_accessor :method, :url, :headers, :body, :username, :password, :uuid
 
@@ -102,8 +104,13 @@ module PactBroker
 
       def do_request uri, req
         logger.info "Making webhook #{uuid} request #{to_s}"
-        Net::HTTP.start(uri.hostname, uri.port,
-          :use_ssl => uri.scheme == 'https') do |http|
+        options = {}
+        if uri.scheme == 'https'
+          options[:use_ssl] = true
+          options[:verify_mode] = OpenSSL::SSL::VERIFY_PEER
+          options[:cert_store] = cert_store
+        end
+        Net::HTTP.start(uri.hostname, uri.port, options) do |http|
           http.request req
         end
       end
@@ -120,8 +127,15 @@ module PactBroker
       end
 
       def log_completion_message options, execution_logger, success
-        execution_logger.info(options[:success_log_message]) if options[:success_log_message] && success
-        execution_logger.info(options[:failure_log_message]) if options[:failure_log_message] && !success
+        if options[:success_log_message] && success
+          execution_logger.info(options[:success_log_message])
+          logger.info(options[:success_log_message])
+        end
+
+        if options[:failure_log_message] && !success
+          execution_logger.info(options[:failure_log_message])
+          logger.info(options[:failure_log_message])
+        end
       end
 
       def to_s
@@ -153,6 +167,10 @@ module PactBroker
         escaped_pact_url = CGI::escape(pact_url)
         url.gsub('${pactbroker.pactUrl}', escaped_pact_url)
       end
+
+      def cert_store
+        certificate_service.cert_store
+      end
     end
   end
 end