pact_broker 2.12.0 → 2.13.0

data/lib/pact_broker/webhooks/service.rb

@@ -1,17 +1,18 @@
 require 'pact_broker/repositories'
 require 'pact_broker/logging'
-require 'pact_broker/webhooks/job'
 require 'base64'
 require 'securerandom'
+require 'pact_broker/webhooks/job'
 require 'pact_broker/webhooks/triggered_webhook'
 require 'pact_broker/webhooks/status'
+require 'pact_broker/webhooks/webhook_event'
 
 module PactBroker
 
   module Webhooks
     class Service
 
-      PUBLICATION = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_PUBLICATION
+      RESOURCE_CREATION = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_RESOURCE_CREATION
       USER = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_USER
 
       extend Repositories
@@ -83,21 +84,21 @@ module PactBroker
         webhook_repository.find_by_consumer_and_provider consumer, provider
       end
 
-      def self.execute_webhooks pact
-        webhooks = webhook_repository.find_by_consumer_and_provider pact.consumer, pact.provider
+      def self.execute_webhooks pact, event_name
+        webhooks = webhook_repository.find_by_consumer_and_provider_and_event_name pact.consumer, pact.provider, event_name
 
         if webhooks.any?
-          run_later(webhooks, pact)
+          run_later(webhooks, pact, event_name)
         else
           logger.debug "No webhook found for consumer \"#{pact.consumer.name}\" and provider \"#{pact.provider.name}\""
         end
       end
 
-      def self.run_later webhooks, pact
+      def self.run_later webhooks, pact, event_name
         trigger_uuid = next_uuid
         webhooks.each do | webhook |
           begin
-            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, PUBLICATION)
+            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, RESOURCE_CREATION)
             logger.info "Scheduling job for #{webhook.description} with uuid #{webhook.uuid}"
             Job.perform_async triggered_webhook: triggered_webhook
           rescue StandardError => e

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -6,7 +6,7 @@ module PactBroker
   module Webhooks
     class TriggeredWebhook < Sequel::Model(:triggered_webhooks)
 
-      TRIGGER_TYPE_PUBLICATION = 'pact_publication'
+      TRIGGER_TYPE_RESOURCE_CREATION = 'resource_creation'
       TRIGGER_TYPE_USER = 'user'
 
       STATUS_NOT_RUN = 'not_run'.freeze

data/lib/pact_broker/webhooks/webhook.rb

@@ -9,6 +9,8 @@ module PactBroker
       set_primary_key :id
       associate(:many_to_one, :provider, :class => "PactBroker::Domain::Pacticipant", :key => :provider_id, :primary_key => :id)
       associate(:many_to_one, :consumer, :class => "PactBroker::Domain::Pacticipant", :key => :consumer_id, :primary_key => :id)
+
+      one_to_many :events, :class => "PactBroker::Webhooks::WebhookEvent", :reciprocal => :webhook
       one_to_many :headers, :class => "PactBroker::Webhooks::WebhookHeader", :reciprocal => :webhook
 
       dataset_module do
@@ -41,6 +43,7 @@ module PactBroker
           uuid: uuid,
           consumer: consumer,
           provider: provider,
+          events: events,
           request: Domain::WebhookRequest.new(request_attributes),
           created_at: created_at,
           updated_at: updated_at)

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -0,0 +1,24 @@
+require 'sequel'
+require 'pact_broker/repositories/helpers'
+
+module PactBroker
+  module Webhooks
+    class WebhookEvent < Sequel::Model
+
+      CONTRACT_CONTENT_CHANGED = 'contract_content_changed'
+      VERIFICATION_PUBLISHED = 'provider_verification_published'
+      DEFAULT_EVENT_NAME = CONTRACT_CONTENT_CHANGED
+      #CONTRACT_VERIFIABLE_CONTENT_CHANGED = 'contract_verifiable_content_changed'
+      #VERIFICATION_STATUS_CHANGED = 'verification_status_changed'
+
+      EVENT_NAMES = [CONTRACT_CONTENT_CHANGED, VERIFICATION_PUBLISHED]
+
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+      end
+
+    end
+
+    WebhookEvent.plugin :timestamps, update_on_create: true
+  end
+end

data/pact_broker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["bskurrie@dius.com.au", "serge.matheson@rea-group.com", "warner@warnergodfrey.com"]
   gem.description   = %q{A server that stores and returns pact files generated by the pact gem. It enables head/prod cross testing of the consumer and provider projects.}
   gem.summary       = %q{See description}
-  gem.homepage      = "https://github.com/bethesque/pact_broker"
+  gem.homepage      = "https://github.com/pact-foundation/pact_broker"
 
   gem.required_ruby_version = '>= 2.2.0'
 
@@ -38,6 +38,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rack-protection', '~>2.0'
   gem.add_runtime_dependency 'dry-types', '~> 0.10.3' # https://travis-ci.org/pact-foundation/pact_broker/jobs/249448621
   gem.add_runtime_dependency 'table_print', '~> 1.5'
+  gem.add_runtime_dependency 'webrick', '~>1.3.0' # Webrick requires Ruby version >= 2.5.0dev. TODO remove dependency on Pact gem.
 
   gem.add_development_dependency 'bundler-audit', '~>0.4'
   gem.add_development_dependency 'sqlite3', '~>1.3'

data/public/javascripts/matrix.js

@@ -0,0 +1,60 @@
+function handleRadioButtonClicked() {
+  selectApplicableTextBox($(this));
+  clearOtherTextBoxes($(this));
+}
+
+function selectApplicableTextBox(selectedRadioButton) {
+  selectedRadioButton.closest('.input-group').find('input[type="text"]').first().focus();
+}
+
+function handleTextBoxClicked() {
+  selectApplicableRadioButton($(this));
+  clearOtherTextBoxes($(this));
+}
+
+function selectApplicableRadioButton(selectedTextBox) {
+  selectedTextBox.closest('.input-group').find('.version-selectorizor').prop('checked', 'checked');
+}
+
+function clearOtherTextBoxes(clickedElement) {
+  clickedElement.closest('.selector').find('input[type="text"]').each(function(){
+    if(!$.contains(clickedElement.closest('.input-group')[0], $(this)[0])) {
+      $(this).prop('value', '');
+    }
+  });
+}
+
+function onSubmit() {
+  disableFieldsThatShouldNotBeSubmitted();
+  return true;
+}
+
+function disableFieldsThatShouldNotBeSubmitted() {
+  disableInputsForUncheckedRadioButtons();
+  disableRadioButtons();
+}
+
+function disableInputsForUncheckedRadioButtons() {
+  $('.version-selectorizor').each(function(){
+    if($(this).prop('checked') === false) {
+      $(this).closest('.input-group').find('input').prop('disabled', 'disabled');
+    }
+  });
+}
+
+function disableRadioButtons() {
+  $('.version-selectorizor').prop('disabled', 'disabled');
+}
+
+$(document).ready(function(){
+  $('.by-version').click(handleTextBoxClicked);
+  $('.by-latest-tag').click(handleTextBoxClicked);
+  $('.version-selectorizor').click(handleRadioButtonClicked);
+
+  $("#matrix").tablesorter({
+    textExtraction : function(node, table, cellIndex){
+      n = $(node);
+      return n.attr('data-sort-value') || n.text();
+    }
+  });
+});

data/public/stylesheets/matrix.css

@@ -0,0 +1,12 @@
+.input-group {
+  display: inline-block;
+  padding-right: 20px
+}
+
+input[type="radio"] {
+  /*margin-right: 4px;*/
+}
+
+div.top-of-group {
+  margin-top: 10px;
+}

data/script/db-spec.sh

@@ -3,5 +3,6 @@ set -e
 cd db/test/backwards_compatibility
 export BUNDLE_GEMFILE=$PWD/Gemfile
 bundle install
+bundle exec appraisal update
 bundle exec appraisal install
 bundle exec rake

data/script/foo-bar-verification.json

@@ -0,0 +1,57 @@
+{
+  "success": true,
+  "providerApplicationVersion": "1.0.0",
+  "testResults": {
+    "examples": [
+      {
+        "description": "has status code 200",
+        "file_path": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb",
+        "full_description": "Verifying a pact between me and they Greeting with GET / returns a response which has status code 200",
+        "id": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb[1:1:1:1:1]",
+        "line_number": 122,
+        "pending_message": null,
+        "run_time": 0.111762,
+        "status": "passed"
+      },
+      {
+        "description": "has a matching body",
+        "file_path": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb",
+        "full_description": "Verifying a pact between me and they Greeting with GET / returns a response which has a matching body",
+        "id": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb[1:1:1:1:3]",
+        "line_number": 139,
+        "pending_message": null,
+        "run_time": 0.000235,
+        "status": "passed"
+      },
+      {
+        "description": "has status code 200",
+        "file_path": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb",
+        "full_description": "Verifying a pact between me and they Given There is a greeting Provider state success with GET /somestate returns a response which has status code 200",
+        "id": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb[1:2:1:1:1:1]",
+        "line_number": 122,
+        "pending_message": null,
+        "run_time": 0.006892,
+        "status": "passed"
+      },
+      {
+        "description": "has a matching body",
+        "file_path": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb",
+        "full_description": "Verifying a pact between me and they Given There is a greeting Provider state success with GET /somestate returns a response which has a matching body",
+        "id": "/redacted/.gem/ruby/2.4.1/gems/pact-1.17.0/lib/pact/provider/rspec.rb[1:2:1:1:1:3]",
+        "line_number": 139,
+        "pending_message": null,
+        "run_time": 0.000176,
+        "status": "passed"
+      }
+    ],
+    "summary": {
+      "duration": 0.123096,
+      "errors_outside_of_examples_count": 0,
+      "example_count": 4,
+      "failure_count": 0,
+      "pending_count": 0
+    },
+    "summary_line": "4 examples, 0 failures",
+    "version": "3.7.0"
+  }
+}

data/script/insert-self-signed-certificate-from-url.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'uri'
+require 'securerandom'
+require 'logger'
+require 'sequel'
+
+uri_string = ARGV[0]
+database = ARGV[1]
+raise "Usage: #{__FILE__} URI SQLITE_DATABASE_PATH" unless uri_string && database
+
+DATABASE_CREDENTIALS = {logger: Logger.new($stdout), adapter: "sqlite", database: database, :encoding => 'utf8'}
+
+uri = URI(uri_string)
+connection = Sequel.connect(DATABASE_CREDENTIALS)
+
+certificate_command = "openssl s_client -showcerts -servername #{uri.host} -connect #{uri.host}:#{uri.port} </dev/null 2>/dev/null | openssl x509 -outform PEM"
+certificate_content = `#{certificate_command}`
+
+puts "Downloaded certificate from #{uri.host}: #{certificate_content}"
+
+certificate_hash = {
+  uuid: SecureRandom.urlsafe_base64,
+  description: "Self signed certificate for #{uri.host}",
+  content: certificate_content,
+  created_at: DateTime.now,
+  updated_at: DateTime.now
+}
+
+connection[:certificates].insert(certificate_hash)
+
+puts "Done"

data/script/publish-verification.sh

@@ -0,0 +1,5 @@
+BASE_URL="http://localhost:9292"
+
+response_body=$(curl ${BASE_URL}/pacts/provider/Bar/consumer/Foo/latest)
+verification_url=$(echo "${response_body}" | ruby -e "require 'json'; puts JSON.parse(ARGF.read)['_links']['pb:publish-verification-results']['href']")
+curl -XPOST -H 'Content-Type: application/json' -d@script/foo-bar-verification.json ${verification_url}

data/script/seed-matrix.rb

@@ -4,6 +4,7 @@ raise "Please supply database path" unless ARGV[0]
 
 $LOAD_PATH.unshift './lib'
 $LOAD_PATH.unshift './spec'
+$LOAD_PATH.unshift './tasks'
 ENV['RACK_ENV'] = 'development'
 require 'sequel'
 require 'logger'
@@ -15,11 +16,9 @@ PactBroker::DB.connection = connection
 require 'pact_broker'
 require 'support/test_data_builder'
 
-
-tables_to_clean = [:labels, :webhook_executions, :triggered_webhooks, :verifications, :pact_publications, :pact_versions, :pacts, :pact_version_contents, :tags, :versions, :webhook_headers, :webhooks, :pacticipants]
-
-tables_to_clean.each do | table_name |
-  connection[table_name].delete if connection.table_exists?(table_name)
+require 'database/table_dependency_calculator'
+PactBroker::Database::TableDependencyCalculator.call(connection).each do | table_name |
+  connection[table_name].delete
 end
 
 =begin
@@ -41,6 +40,7 @@ A -> B ->  C
 
 TestDataBuilder.new
   .create_pact_with_hierarchy("A", "1", "B")
+  .create_consumer_version_tag("master")
   .create_verification(provider_version: '1', success: false)
   .create_verification(provider_version: '1', number: 2, success: true)
   .create_verification(provider_version: '2', number: 3)
@@ -48,6 +48,7 @@ TestDataBuilder.new
   .create_provider_version("5")
   .use_consumer("B")
   .use_consumer_version("1")
+  .create_consumer_version_tag("master")
   .create_provider("C")
   .create_pact
   .create_verification(provider_version: '1', success: false)

data/script/seed.rb

@@ -4,6 +4,7 @@ raise "Please supply database path" unless ARGV[0]
 
 $LOAD_PATH.unshift './lib'
 $LOAD_PATH.unshift './spec'
+$LOAD_PATH.unshift './tasks'
 ENV['RACK_ENV'] = 'development'
 require 'sequel'
 require 'logger'
@@ -15,15 +16,16 @@ PactBroker::DB.connection = connection
 require 'pact_broker'
 require 'support/test_data_builder'
 
+# Uncomment these lines to open a pry session for inspecting the database
+# require 'table_print'
+# require 'pry'; pry(binding);
+# exit
 
-tables_to_clean = [:labels, :webhook_executions, :triggered_webhooks, :verifications, :pact_publications, :pact_versions, :pacts, :pact_version_contents, :tags, :versions, :webhook_headers, :webhooks, :pacticipants]
-
-tables_to_clean.each do | table_name |
-  connection[table_name].delete if connection.table_exists?(table_name)
+require 'database/table_dependency_calculator'
+PactBroker::Database::TableDependencyCalculator.call(connection).each do | table_name |
+  connection[table_name].delete
 end
 
-
-
 class TestDataBuilder
   def method_missing *args
       self
@@ -48,59 +50,65 @@ end
 #   .create_pact
 
 
+  # .create_webhook(method: 'GET', url: 'https://localhost:9393?url=${pactbroker.pactUrl}', body: '${pactbroker.pactUrl}')
+TestDataBuilder.new
+  .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
+  .create_consumer("Foo")
+  .create_label("microservice")
+  .create_provider("Bar")
+  .create_label("microservice")
+  .create_webhook(method: 'GET', url: 'https://self-signed.badssl.com')
+  .create_consumer_version("1.2.100")
+  .publish_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')
+  .publish_pact
+  .create_verification(provider_version: "9.9.10", success: false, execution_date: DateTime.now - 15)
+  .create_consumer_version("1.2.102")
+  .publish_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/')
+  .publish_pact(created_at: (Time.now - 140).to_datetime)
+  .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
+  .create_provider("Wiffles")
+  .publish_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")
+  .publish_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")
+  .publish_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")
+  .publish_pact(created_at: (Date.today - 26).to_datetime)
+  .create_verification(provider_version: "4.8.152", execution_date: DateTime.now)
+
 # TestDataBuilder.new
-#   .create_consumer("Foo")
-#   .create_label("microservice")
-#   .create_provider("Bar")
-#   .create_label("microservice")
-#   .create_webhook(method: 'GET', url: 'http://localhost:9393?url=${pactbroker.pactUrl}', body: '${pactbroker.pactUrl}')
-#   .create_consumer_version("1.2.100")
-#   .publish_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')
-#   .publish_pact
-#   .create_verification(provider_version: "9.9.10", success: false, execution_date: DateTime.now - 15)
-#   .create_consumer_version("1.2.102")
-#   .publish_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/')
-#   .publish_pact(created_at: (Time.now - 140).to_datetime)
-#   .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
-#   .create_provider("Wiffles")
-#   .publish_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")
-#   .publish_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")
-#   .publish_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")
-#   .publish_pact(created_at: (Date.today - 26).to_datetime)
-#   .create_verification(provider_version: "4.8.152", execution_date: DateTime.now)
+#   .create_pact_with_hierarchy("A", "1", "B")
+#   .create_consumer_version_tag("master")
+#   .create_consumer_version_tag("prod")
+#   .create_verification(provider_version: "1")
+#   .create_consumer_version("2")
+#   .create_consumer_version_tag("master")
+#   .create_pact
+#   .create_verification(provider_version: "2")
 
-TestDataBuilder.new
-  .create_pact_with_hierarchy("A", "1", "B")
-  .create_consumer_version_tag("master")
-  .create_consumer_version_tag("prod")
-  .create_verification(provider_version: "1")
-  .create_consumer_version("2")
-  .create_consumer_version_tag("master")
-  .create_pact
-  .create_verification(provider_version: "2")
+# TestDataBuilder.new
+#   .create_pact_with_hierarchy("Foo", "1", "Bar")
+#   .create_webhook(method: 'GET', url: 'http://localhost:9393', events: [{ name: 'provider_verification_published' }, {name: ''}])