pact_broker 2.4.2 → 2.5.0

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -14,13 +14,14 @@ module PactBroker
 
         include PactBroker::Logging
 
-        def self.call pact
-          new(pact).call
+        def self.call pact, options = {}
+          new(pact, options).call
         end
 
-        def initialize pact
+        def initialize pact, options = {}
           @json_content = pact.json_content
           @pact = pact
+          @options = options
         end
 
         def call
@@ -40,12 +41,17 @@ module PactBroker
           <link rel='stylesheet' type='text/css' href='/stylesheets/pact.css'>
           <link rel='stylesheet' type='text/css' href='/stylesheets/github-json.css'>
           <script src='/javascripts/highlight.pack.js'></script>
+          <script src='/javascripts/jquery-2.1.1.min.js'></script>
+          <script src='/js/bootstrap.min.js'></script>
+          <script src='/javascripts/pact.js'></script>
           <script>hljs.initHighlightingOnLoad();</script>"
         end
 
         def pact_metadata
           "<div class='pact-metadata'>
             <ul>
+              #{badge_list_item}
+              #{badge_markdown_item}
               <li>
                 <span class='name'>#{@pact.consumer.name} version:</span>
                 <span class='value'>#{@pact.consumer_version_number}#{tags}</span>
@@ -64,6 +70,36 @@ module PactBroker
           </div>"
         end
 
+        def badge_list_item
+            "<li class='badge'>
+              <img src='#{badge_url}'/>
+            </li>
+            "
+        end
+
+        def badge_markdown_item
+          "<li class='badge-markdown' style='display:none'>
+              <textarea rows='3' cols='100'>#{badge_markdown}</textarea>
+          </li>"
+        end
+
+        def badge_markdown
+          warning = if badges_protected?
+            "If the broker is protected by authentication, set `enable_public_badge_access` to true in the configuration to enable badges to be embedded in a markdown file.\n"
+          else
+            ""
+          end
+          "#{warning}[![#{@pact.consumer.name}/#{@pact.provider.name} Pact Status](#{badge_url})](#{badge_target_url})"
+        end
+
+        def badges_protected?
+          !PactBroker.configuration.enable_public_badge_access
+        end
+
+        def base_url
+          @options[:base_url] || ''
+        end
+
         def title
           "Pact between #{@pact.consumer.name} and #{@pact.provider.name}"
         end
@@ -80,6 +116,14 @@ module PactBroker
           PactBroker::Api::PactBrokerUrls.pact_url '', @pact
         end
 
+        def badge_target_url
+          base_url
+        end
+
+        def badge_url
+          @options[:badge_url]
+        end
+
         def tags
           if @pact.consumer_version_tag_names.any?
             " (#{@pact.consumer_version_tag_names.join(", ")})"

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

@@ -17,11 +17,11 @@ module PactBroker
         end
 
         def resource_exists?
-          PactBroker.configuration.enable_badge_resources
+          true
         end
 
         def is_authorized?(authorization_header)
-          true
+          super || PactBroker.configuration.enable_public_badge_access
         end
 
         def forbidden?
@@ -31,7 +31,7 @@ module PactBroker
         private
 
         def to_svg
-          badges_service.pact_verification_badge pact, label, initials, verification_status
+          badge_service.pact_verification_badge pact, label, initials, verification_status
         end
 
         def pact

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

@@ -75,7 +75,7 @@ module PactBroker
         end
 
         def resource_url
-          request.uri.to_s
+          request.uri.to_s.gsub(/\?.*/, '')
         end
 
         def decorator_context options = {}

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

@@ -27,7 +27,11 @@ module PactBroker
         end
 
         def to_html
-          PactBroker.configuration.html_pact_renderer.call(pact)
+          PactBroker.configuration.html_pact_renderer.call(
+            pact, {
+              base_url: base_url,
+              badge_url: "#{resource_url}/badge.svg"
+          })
         end
 
         def pact

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

@@ -79,7 +79,11 @@ module PactBroker
         end
 
         def to_html
-          PactBroker.configuration.html_pact_renderer.call(pact)
+          PactBroker.configuration.html_pact_renderer.call(
+            pact, {
+              base_url: base_url,
+              badge_url: badge_url_for_latest_pact(pact, base_url)
+          })
         end
 
         def delete_resource

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

@@ -0,0 +1,61 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/pact_webhooks_status_decorator'
+
+module PactBroker
+
+  module Api
+    module Resources
+
+      class PactWebhooksStatus < BaseResource
+
+        def allowed_methods
+          ["GET"]
+        end
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def resource_exists?
+          consumer && provider
+        end
+
+        def to_json
+          decorator_for(latest_triggered_webhooks).to_json(user_options: decorator_context(identifier_from_path))
+        end
+
+        private
+
+        def latest_triggered_webhooks
+          @latest_triggered_webhooks ||= webhook_service.find_latest_triggered_webhooks(consumer, provider)
+        end
+
+        def pact
+          @pact ||= pact_service.find_latest_pact(pact_params)
+        end
+
+        def webhooks
+          webhook_service.find_by_consumer_and_provider consumer, provider
+        end
+
+        def consumer
+          @consumer ||= find_pacticipant(identifier_from_path[:consumer_name], "consumer")
+        end
+
+        def provider
+          @provider ||= find_pacticipant(identifier_from_path[:provider_name], "provider")
+        end
+
+        def find_pacticipant name, role
+          pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
+            set_json_error_message("No #{role} with name '#{name}' found") if pacticipant.nil?
+          end
+        end
+
+        def decorator_for latest_triggered_webhooks
+          PactBroker::Api::Decorators::PactWebhooksStatusDecorator.new(latest_triggered_webhooks)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/webhooks/triggered_webhook'
+
+module PactBroker
+  module Api
+    module Resources
+
+      class TriggeredWebhookLogs < BaseResource
+
+        def content_types_provided
+          [["text/plain", :to_text]]
+        end
+
+        def allowed_methods
+          ["GET"]
+        end
+
+        def resource_exists?
+          triggered_webhook
+        end
+
+        def to_text
+          # Too simple to bother putting into a service
+          triggered_webhook.webhook_executions.collect(&:logs).join("\n")
+        end
+
+        def triggered_webhook
+          @triggered_webhook ||= begin
+            criteria = {webhook_uuid: identifier_from_path[:uuid], trigger_uuid: identifier_from_path[:trigger_uuid]}
+            PactBroker::Webhooks::TriggeredWebhook.where(criteria).single_record
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,18 +7,38 @@ module PactBroker
 
       class Webhook < BaseResource
 
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
 
         def allowed_methods
-          ["GET", "DELETE"]
+          ["GET", "PUT", "DELETE"]
         end
 
         def resource_exists?
           webhook
         end
 
+        def malformed_request?
+          if request.put?
+            return invalid_json? || validation_errors?(webhook)
+          end
+          false
+        end
+
+        def from_json
+          if webhook
+            @webhook = webhook_service.update_by_uuid uuid, new_webhook
+            response.body = to_json
+          else
+            404
+          end
+        end
+
         def to_json
           Decorators::WebhookDecorator.new(webhook).to_json(user_options: { base_url: base_url })
         end
@@ -30,16 +50,24 @@ module PactBroker
 
         private
 
+        def validation_errors? webhook
+          errors = webhook_service.errors(new_webhook)
+          set_json_validation_error_messages(errors.messages) if !errors.empty?
+          !errors.empty?
+        end
+
         def webhook
           @webhook ||= webhook_service.find_by_uuid uuid
         end
 
+        def new_webhook
+          @new_webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
+        end
+
         def uuid
           identifier_from_path[:uuid]
         end
-
       end
     end
-
   end
 end

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

@@ -1,6 +1,7 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/services'
 require 'pact_broker/api/decorators/webhook_execution_result_decorator'
+require 'pact_broker/constants'
 
 module PactBroker
   module Api
@@ -13,10 +14,15 @@ module PactBroker
         end
 
         def process_post
-          webhook_execution_result = webhook_service.execute_webhook_now webhook
+          webhook_execution_result = webhook_service.execute_webhook_now webhook, pact
           response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
           response.body = post_response_body webhook_execution_result
-          webhook_execution_result.success? ? true : 500
+          if webhook_execution_result.success?
+            true
+          else
+            response.headers[PactBroker::DO_NOT_ROLLBACK] = 'true'
+            500
+          end
         end
 
         def resource_exists?
@@ -33,6 +39,10 @@ module PactBroker
           @webhook ||= webhook_service.find_by_uuid uuid
         end
 
+        def pact
+          @pact ||= pact_service.find_latest_pact consumer_name: webhook.consumer_name, provider_name: webhook.provider_name
+        end
+
         def uuid
           identifier_from_path[:uuid]
         end

data/lib/pact_broker/api.rb

@@ -49,7 +49,10 @@ module PactBroker
 
         # 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', :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"}
 

data/lib/pact_broker/app.rb

@@ -23,7 +23,7 @@ module PactBroker
       @configuration = PactBroker.configuration
       yield configuration
       post_configure
-      migrate_database
+      prepare_database
       prepare_app
     end
 
@@ -45,15 +45,18 @@ module PactBroker
       PactBroker.logger = configuration.logger
       SuckerPunch.logger = configuration.logger
       configure_database_connection
+      configure_sucker_punch
     end
 
-    def migrate_database
+    def prepare_database
       if configuration.auto_migrate_db
         logger.info "Migrating database"
         PactBroker::DB.run_migrations configuration.database_connection
       else
         logger.info "Skipping database migrations"
       end
+      require 'pact_broker/webhooks/service'
+      PactBroker::Webhooks::Service.fail_retrying_triggered_webhooks
     end
 
     def configure_database_connection
@@ -119,6 +122,12 @@ module PactBroker
       builder
     end
 
+    def configure_sucker_punch
+      SuckerPunch.exception_handler = -> (ex, klass, args) do
+        PactBroker.log_error(ex, "Unhandled Suckerpunch error for #{klass}.perform(#{args.inspect})")
+      end
+    end
+
     def running_app
       @running_app ||= begin
         apps = @cascade_apps
@@ -128,6 +137,5 @@ module PactBroker
         @app_builder
       end
     end
-
   end
 end

data/lib/pact_broker/badges/service.rb

@@ -12,6 +12,7 @@ module PactBroker
       include PactBroker::Logging
 
       SPACE_DASH_UNDERSCORE = /[\s_\-]/
+      CACHE = {}
 
       def pact_verification_badge pact, label, initials, verification_status
         return static_svg(pact, verification_status) unless pact
@@ -23,6 +24,10 @@ module PactBroker
         dynamic_svg(title, status, color) || static_svg(pact, verification_status)
       end
 
+      def clear_cache
+        CACHE.clear
+      end
+
       private
 
       def badge_title pact, label, initials
@@ -79,7 +84,7 @@ module PactBroker
           response = do_request(uri)
           response.code == '200' ? response.body : nil
         rescue StandardError => e
-          log_error e, "Error retrieving badge from #{uri}"
+          logger.error "Error retrieving badge from #{uri} due to #{e.class} - #{e.message}"
           nil
         end
       end
@@ -95,11 +100,27 @@ module PactBroker
       end
 
       def do_request(uri)
-        request = Net::HTTP::Get.new(uri)
-        Net::HTTP.start(uri.hostname, uri.port,
-          use_ssl: uri.scheme == 'https', read_timeout: 1000) do |http|
-          http.request request
+        with_cache uri do
+          request = Net::HTTP::Get.new(uri)
+          Net::HTTP.start(uri.hostname, uri.port,
+              use_ssl: uri.scheme == 'https',
+              read_timeout: 3,
+              open_timeout: 1,
+              ssl_timeout: 1,
+              continue_timeout: 1) do |http|
+            http.request request
+          end
+        end
+      end
+
+      def with_cache uri
+        if !(response = CACHE[uri])
+          response = yield
+          if response.code == '200'
+            CACHE[uri] = response
+          end
         end
+        response
       end
 
       def static_svg pact, verification_status

data/lib/pact_broker/configuration.rb

@@ -11,13 +11,14 @@ module PactBroker
 
   class Configuration
 
-    SAVABLE_SETTING_NAMES = [:order_versions_by_date, :use_case_sensitive_resource_names, :enable_badge_resources, :shields_io_base_url]
+    SAVABLE_SETTING_NAMES = [:order_versions_by_date, :use_case_sensitive_resource_names, :enable_public_badge_access, :shields_io_base_url]
 
     attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :semver_formats
-    attr_accessor :enable_badge_resources, :shields_io_base_url
+    attr_accessor :enable_public_badge_access, :shields_io_base_url
+    attr_accessor :webhook_retry_schedule
     attr_writer :logger
 
     def initialize
@@ -39,7 +40,7 @@ module PactBroker
       config.use_hal_browser = true
       config.validate_database_connection_config = true
       config.enable_diagnostic_endpoints = true
-      config.enable_badge_resources = false # For security
+      config.enable_public_badge_access = false # For security
       config.shields_io_base_url = "https://img.shields.io".freeze
       config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
@@ -48,13 +49,14 @@ module PactBroker
       # consistently extract an orderable object from the consumer application version number.
       config.order_versions_by_date = false
       config.semver_formats = ["%M.%m.%p%s%d","%M.%m", "%M"]
+      config.webhook_retry_schedule = [10, 60, 120, 300, 600, 1200] #10 sec, 1 min, 2 min, 5 min, 10 min, 20 min => 38 minutes
       config
     end
 
     def self.default_html_pact_render
-      lambda { |pact|
+      lambda { |pact, options|
         require 'pact_broker/api/renderers/html_pact_renderer'
-        PactBroker::Api::Renderers::HtmlPactRenderer.call pact
+        PactBroker::Api::Renderers::HtmlPactRenderer.call pact, options
       }
     end
 
@@ -106,6 +108,11 @@ module PactBroker
       end
     end
 
+    def enable_badge_resources= enable_badge_resources
+      puts "Pact Broker configuration property `enable_badge_resources` is deprecated. Please use `enable_public_badge_access`"
+      self.enable_public_badge_access = enable_badge_resources
+    end
+
     def save_to_database
       # Can't require a Sequel::Model class before the connection has been set
       require 'pact_broker/config/save'

data/lib/pact_broker/constants.rb

@@ -1,5 +1,5 @@
 module PactBroker
 
   CONSUMER_VERSION_HEADER = 'X-Pact-Consumer-Version'.freeze
-
+  DO_NOT_ROLLBACK = 'X-Pact-Broker-Do-Not-Rollback'.freeze
 end

data/lib/pact_broker/diagnostic/resources/heartbeat.rb

@@ -14,7 +14,7 @@ module PactBroker
         end
 
         def to_json
-          {
+          @@json ||= {
             "ok" => true,
             "_links" => {
               "self" => {
@@ -23,7 +23,6 @@ module PactBroker
             }
           }.to_json
         end
-
       end
     end
   end

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

@@ -47,4 +47,4 @@ Send a DELETE request to the webhook URL.
 
 ### Updating
 
-Currently not implemented. You will need to delete and re-create the webhook.
+Send a PUT request to the webhook URL with all fields required for the new webhook.

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

@@ -12,4 +12,4 @@ Send a DELETE request to the webhook URL.
 
 ### Updating
 
-Currently not implemented. You will need to delete and re-create the webhook.
+Send a PUT request to the webhook URL with all fields required for the new webhook.

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

@@ -47,4 +47,4 @@ Send a DELETE request to the webhook URL.
 
 ### Updating
 
-Currently not implemented. You will need to delete and re-create the webhook.
+Send a PUT request to the webhook URL with all fields required for the new webhook.

data/lib/pact_broker/domain/relationship.rb

@@ -1,22 +1,23 @@
 require 'pact_broker/verifications/verification_status'
+require 'pact_broker/webhooks/status'
 
 module PactBroker
   module Domain
-
     class Relationship
 
       attr_reader :consumer, :provider, :latest_pact, :latest_verification, :webhooks
 
-      def initialize consumer, provider, latest_pact = nil, latest_verification = nil, webhooks = []
+      def initialize consumer, provider, latest_pact = nil, latest_verification = nil, webhooks = [], triggered_webhooks = []
         @consumer = consumer
         @provider = provider
         @latest_pact = latest_pact
         @latest_verification = latest_verification
         @webhooks = webhooks
+        @triggered_webhooks = triggered_webhooks
       end
 
-      def self.create consumer, provider, latest_pact, latest_verification, webhooks = []
-        new consumer, provider, latest_pact, latest_verification, webhooks
+      def self.create consumer, provider, latest_pact, latest_verification, webhooks = [], triggered_webhooks = []
+        new consumer, provider, latest_pact, latest_verification, webhooks, triggered_webhooks
       end
 
       def eq? other
@@ -45,6 +46,14 @@ module PactBroker
         @webhooks.any?
       end
 
+      def webhook_status
+        @webhook_status ||= PactBroker::Webhooks::Status.new(@latest_pact, @webhooks, @triggered_webhooks).to_sym
+      end
+
+      def last_webhook_execution_date
+        @last_webhook_execution_date ||= @triggered_webhooks.any? ? @triggered_webhooks.sort{|a, b| a.created_at <=> b.created_at }.last.created_at : nil
+      end
+
       def verification_status
         @verification_status ||= PactBroker::Verifications::Status.new(@latest_pact, @latest_verification).to_sym
       end

data/lib/pact_broker/domain/verification.rb

@@ -52,10 +52,6 @@ module PactBroker
             .left_outer_join(:tags, {version_id: :consumer_version_id})
             .where(Sequel.qualify(:tags, :name) => nil)
         end
-
-        def latest
-          reverse_order(:consumer_version_order, :number).limit(1)
-        end
       end
 
       def pact_version_sha

data/lib/pact_broker/domain/webhook.rb

@@ -4,9 +4,7 @@ require 'pact_broker/logging'
 require 'pact_broker/api/contracts/webhook_contract'
 
 module PactBroker
-
   module Domain
-
     class Webhook
 
       include Messages
@@ -33,9 +31,9 @@ module PactBroker
         request && request.description
       end
 
-      def execute
+      def execute options
         logger.info "Executing #{self}"
-        request.execute
+        request.execute options
       end
 
       def to_s
@@ -50,7 +48,5 @@ module PactBroker
         provider && provider.name
       end
     end
-
   end
-
 end

data/lib/pact_broker/domain/webhook_execution_result.rb

@@ -11,7 +11,7 @@ module PactBroker
       end
 
       def success?
-        !@response.nil? && @response.code.to_i < 400
+        !@response.nil? && @response.code.to_i < 300
       end
 
       def response
@@ -25,7 +25,6 @@ module PactBroker
       def logs
         @logs
       end
-
     end
   end
 end