pact_broker 2.34.0 → 2.35.0

data/lib/pact_broker/webhooks/redact_logs.rb

@@ -1,9 +1,26 @@
+require 'pact_broker/string_refinements'
+
 module PactBroker
   module Webhooks
-    class RedactLogs
-      def self.call logs
-        logs.gsub(/(Authorization: )(.*)/i,'\1[REDACTED]')
-            .gsub(/(Token: )(.*)/i,'\1[REDACTED]')
+    module RedactLogs
+      HEADER_SUBSTITUTIONS = [[/(Authorization: )(.*)/i, '\1[REDACTED]'], [ /(Token: )(.*)/i, '\1[REDACTED]']]
+
+      using PactBroker::StringRefinements
+
+      def redact_logs(logs, values)
+        RedactLogs.call(logs, values)
+      end
+
+      def self.call logs, values
+        substitutions = HEADER_SUBSTITUTIONS + value_substitutions(values)
+
+        substitutions.reduce(logs) do | logs, (find, replace) |
+          logs.gsub(find, replace)
+        end
+      end
+
+      def self.value_substitutions(values)
+        values.select(&:not_blank?).collect{ | value | [value, "********"] }
       end
     end
   end

data/lib/pact_broker/webhooks/render.rb

@@ -3,17 +3,26 @@ require 'pact_broker/webhooks/pact_and_verification_parameters'
 module PactBroker
   module Webhooks
     class Render
-
       TEMPLATE_PARAMETER_REGEXP = /\$\{pactbroker\.[^\}]+\}/
       DEFAULT_ESCAPER = lambda { |it| it }
 
+      def self.includes_parameter?(value)
+        value =~ TEMPLATE_PARAMETER_REGEXP
+      end
+
+      def self.render_with_placeholder(value, placeholder = 'placeholder')
+        value.gsub(TEMPLATE_PARAMETER_REGEXP, placeholder)
+      end
+
       def self.call(template, params, &escaper)
         render_template(escape_params(params, escaper || DEFAULT_ESCAPER), template)
       end
 
+      private
+
       def self.render_template(params, template)
         params.inject(template) do | template, (key, value) |
-          template.gsub(key, value)
+          template.gsub("${#{key}}", value)
         end
       end
 

data/lib/pact_broker/webhooks/repository.rb

@@ -7,11 +7,12 @@ require 'pact_broker/webhooks/webhook_event'
 require 'pact_broker/webhooks/triggered_webhook'
 require 'pact_broker/webhooks/latest_triggered_webhook'
 require 'pact_broker/webhooks/execution'
+require 'pact_broker/logging'
 
 module PactBroker
   module Webhooks
-
     class Repository
+      include PactBroker::Logging
 
       include Repositories
 
@@ -125,10 +126,15 @@ module PactBroker
       end
 
       def create_execution triggered_webhook, webhook_execution_result
-        Execution.create(
-          triggered_webhook: triggered_webhook,
-          success: webhook_execution_result.success?,
-          logs: webhook_execution_result.logs)
+        # TriggeredWebhook may have been deleted since the webhook execution started
+        if TriggeredWebhook.where(id: triggered_webhook.id).any?
+          Execution.create(
+            triggered_webhook: triggered_webhook,
+            success: webhook_execution_result.success?,
+            logs: webhook_execution_result.logs)
+        else
+          logger.info("Could not save webhook execution for triggered webhook with id #{triggered_webhook.id} as it has been delete from the database")
+        end
       end
 
       def delete_triggered_webhooks_by_pacticipant pacticipant

data/lib/pact_broker/webhooks/service.rb

@@ -10,11 +10,15 @@ require 'pact_broker/webhooks/webhook_event'
 require 'pact_broker/verifications/placeholder_verification'
 require 'pact_broker/pacts/placeholder_pact'
 require 'pact_broker/api/decorators/webhook_decorator'
+require 'pact_broker/hash_refinements'
+require 'pact_broker/webhooks/execution_configuration'
+require 'pact_broker/messages'
+require 'pact_broker/webhooks/pact_and_verification_parameters'
 
 module PactBroker
-
   module Webhooks
     class Service
+      using PactBroker::HashRefinements
 
       RESOURCE_CREATION = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_RESOURCE_CREATION
       USER = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_USER
@@ -22,6 +26,7 @@ module PactBroker
       extend Repositories
       extend Services
       include Logging
+      extend PactBroker::Messages
 
       def self.next_uuid
         SecureRandom.urlsafe_base64
@@ -67,11 +72,9 @@ module PactBroker
         webhook_repository.find_all
       end
 
-      def self.test_execution webhook, options
-        logging_options = options[:logging_options].merge(
-          failure_log_message: "Webhook execution failed",
-        )
-        merged_options = options.merge(logging_options: logging_options)
+      def self.test_execution webhook, execution_configuration
+        merged_options = execution_configuration.with_failure_log_message("Webhook execution failed").to_hash
+
         verification = nil
         if webhook.trigger_on_provider_verification_published?
           verification = verification_service.search_for_latest(webhook.consumer_name, webhook.provider_name) || PactBroker::Verifications::PlaceholderVerification.new
@@ -81,21 +84,8 @@ module PactBroker
         webhook.execute(pact, verification, merged_options)
       end
 
-      # # TODO delete?
-      # def self.execute_webhook_now webhook, pact, verification = nil
-      #   triggered_webhook = webhook_repository.create_triggered_webhook(next_uuid, webhook, pact, verification, USER)
-      #   logging_options = { failure_log_message: "Webhook execution failed"}
-      #   webhook_execution_result = execute_triggered_webhook_now triggered_webhook, logging_options
-      #   if webhook_execution_result.success?
-      #     webhook_repository.update_triggered_webhook_status triggered_webhook, TriggeredWebhook::STATUS_SUCCESS
-      #   else
-      #     webhook_repository.update_triggered_webhook_status triggered_webhook, TriggeredWebhook::STATUS_FAILURE
-      #   end
-      #   webhook_execution_result
-      # end
-
-      def self.execute_triggered_webhook_now triggered_webhook, webhook_options
-        webhook_execution_result = triggered_webhook.execute webhook_options
+      def self.execute_triggered_webhook_now triggered_webhook, webhook_execution_configuration_hash
+        webhook_execution_result = triggered_webhook.execute webhook_execution_configuration_hash
         webhook_repository.create_execution triggered_webhook, webhook_execution_result
         webhook_execution_result
       end
@@ -132,12 +122,7 @@ module PactBroker
           begin
             triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION)
             logger.info "Scheduling job for webhook with uuid #{webhook.uuid}"
-            job_data = {
-              triggered_webhook: triggered_webhook,
-              webhook_context: options.fetch(:webhook_context),
-              logging_options: options.fetch(:logging_options),
-              database_connector: options.fetch(:database_connector)
-            }
+            job_data = { triggered_webhook: triggered_webhook }.deep_merge(options)
             # Delay slightly to make sure the request transaction has finished before we execute the webhook
             Job.perform_in(5, job_data)
           rescue StandardError => e
@@ -166,6 +151,15 @@ module PactBroker
         webhook_repository.find_triggered_webhooks_for_verification(verification)
       end
 
+      def self.parameters
+        PactAndVerificationParameters::ALL.collect do | parameter |
+          OpenStruct.new(
+            name: parameter,
+            description: message("messages.webhooks.parameters.#{parameter}")
+          )
+        end
+      end
+
       private
 
       # Dirty hack to maintain existing password or Authorization header if it is submitted with value ****

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -44,7 +44,6 @@ module PactBroker
       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)
 
-
       def request_description
         webhook.to_domain.request_description
       end

data/lib/pact_broker/webhooks/webhook_request_logger.rb

@@ -10,9 +10,22 @@ module PactBroker
 
       attr_reader :execution_logger, :options
 
+      class Formatter < Logger::Formatter
+        Format = "[%s] %s: %s\n".freeze
+
+        def call(severity, time, progname, msg)
+          Format % [format_datetime(time), severity, msg2str(msg)]
+        end
+
+        def format_datetime(time)
+          time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%SZ".freeze)
+        end
+      end
+
       def initialize(options)
         @log_stream = StringIO.new
         @execution_logger = Logger.new(log_stream)
+        @execution_logger.formatter = Formatter.new
         @options = options
       end
 

data/lib/pact_broker/webhooks/webhook_request_template.rb

@@ -2,6 +2,7 @@ require 'pact_broker/domain/webhook_request_header'
 require 'pact_broker/webhooks/render'
 require 'cgi'
 require 'pact_broker/domain/webhook_request'
+require 'pact_broker/string_refinements'
 
 module PactBroker
   module Webhooks
@@ -9,6 +10,8 @@ module PactBroker
 
       include PactBroker::Logging
       include PactBroker::Messages
+      using PactBroker::StringRefinements
+
       HEADERS_TO_REDACT = [/authorization/i, /token/i]
 
       attr_accessor :method, :url, :headers, :body, :username, :password, :uuid
@@ -27,40 +30,30 @@ module PactBroker
         @uuid = attributes[:uuid]
       end
 
-      def build(context)
-        template_params = PactBroker::Webhooks::PactAndVerificationParameters.new(context[:pact], context[:verification], context[:webhook_context]).to_hash
+      def build(template_params)
         attributes = {
           method: http_method,
           url: build_url(template_params),
-          headers: headers,
-          username: username,
-          password: password,
+          headers: build_headers(template_params),
+          username: build_string(username, template_params),
+          password: build_string(password, template_params),
           uuid: uuid,
           body: build_body(template_params)
         }
         PactBroker::Domain::WebhookRequest.new(attributes)
       end
 
-      def build_url(template_params)
-        URI(PactBroker::Webhooks::Render.call(url, template_params){ | value | CGI::escape(value) if !value.nil? } ).to_s
-      end
-
-      def build_body(template_params)
-        body_string = String === body ? body : body.to_json
-        PactBroker::Webhooks::Render.call(body_string, template_params)
-      end
-
       def description
-        "#{http_method.upcase} #{URI(url.gsub(PactBroker::Webhooks::Render::TEMPLATE_PARAMETER_REGEXP, 'placeholder')).host}"
+        "#{http_method.upcase} #{URI(PactBroker::Webhooks::Render.render_with_placeholder(url)).host}"
       end
 
       def display_password
-        password.nil? ? nil : "**********"
+        password.nil? ? nil : (PactBroker::Webhooks::Render.includes_parameter?(password) ? password : "**********")
       end
 
       def redacted_headers
         headers.each_with_object({}) do | (name, value), new_headers |
-          redact = HEADERS_TO_REDACT.any?{ | pattern | name =~ pattern }
+          redact = HEADERS_TO_REDACT.any?{ | pattern | name =~ pattern }  && !PactBroker::Webhooks::Render.includes_parameter?(value)
           new_headers[name] = redact ? "**********" : value
         end
       end
@@ -69,11 +62,32 @@ module PactBroker
         @headers = Rack::Utils::HeaderHash.new(headers)
       end
 
-      private
 
       def to_s
         "#{method.upcase} #{url}, username=#{username}, password=#{display_password}, headers=#{redacted_headers}, body=#{body}"
       end
+
+      private
+
+      def build_url(template_params)
+        URI(PactBroker::Webhooks::Render.call(url, template_params){ | value | CGI::escape(value) if !value.nil? } ).to_s
+      end
+
+      def build_body(template_params)
+        body_string = String === body ? body : body.to_json
+        build_string(body_string, template_params)
+      end
+
+      def build_headers(template_params)
+        headers.each_with_object(Rack::Utils::HeaderHash.new) do | (key, value), new_headers |
+          new_headers[key] = build_string(value, template_params)
+        end
+      end
+
+      def build_string(string, template_params)
+        return string if string.nil? || string.blank?
+        PactBroker::Webhooks::Render.call(string, template_params)
+      end
     end
   end
 end

data/lib/rack/pact_broker/add_vary_header.rb

@@ -0,0 +1,39 @@
+=begin
+
+  This header should fix the situation where using the back button shows the json/csv instead of the html.
+
+  > Unlike intermediary caches (such as CDNs), browsers typically do not implement the capability to
+  store multiple variations per URL. The rationale for this is that the things we typically use Vary
+  for (mainly Accept-Encoding and Accept-Language) do not change frequently within the context of a
+  single user. Accept-Encoding might (but probably doesn’t) change upon a browser upgrade, and
+  Accept-Language would most likely only change if you edit your operating system’s language locale
+  settings. It also happens to be a lot easier to implement Vary in this way, although some specification
+  authors believe this was a mistake.
+
+  > It’s no great loss most of the time for a browser to store only one variation, but it is important
+  that we don’t accidentally use a variation that isn’t valid anymore if the “varied on” data does
+  happen to change.
+
+  > The compromise is to treat Vary as a validator, not a key. Browsers compute cache keys in the normal
+  way (essentially, using the URL), and then if they score a hit, they check that the request satisfies any
+  ry rules that are baked into the cached response. If it doesn’t, then the browser treats the request as a
+  iss on the cache, and it moves on to the next layer of cache or out to the network. When a fresh response
+  is received, it will then overwrite the cached version, even though it’s technically a different variation.
+
+  https://www.smashingmagazine.com/2017/11/understanding-vary-header/
+=end
+
+module Rack
+  module PactBroker
+    class AddVaryHeader
+      def initialize app
+        @app = app
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+        [status, { "Vary" => "Accept" }.merge(headers || {}), body]
+      end
+    end
+  end
+end

data/lib/rack/pact_broker/convert_file_extension_to_accept_header.rb

@@ -3,6 +3,8 @@ module Rack
     # If the HTML and the CSV group resources are both requested by the browser,
     # Chrome gets confused by the content types, and when you click back, it tries to load the CSV
     # instead of the HTML page. So we have to give the CSV resource a different URL (.csv)
+    # Update: this should be fixed by lib/rack/pact_broker/add_vary_header.rb, but may as well
+    # leave it now!
 
     class ConvertFileExtensionToAcceptHeader
 

data/lib/webmachine/rack_adapter_monkey_patch.rb

@@ -14,7 +14,6 @@ module Webmachine
   end
 end
 
-
 unless Webmachine::Adapters::Rack.private_instance_methods.include?(:build_webmachine_request)
   raise "Webmachine::Adapters::Rack no longer has the private instance method #build_webmachine_request - rack env monkey patch won't work"
 end

data/public/javascripts/clipboard.js

@@ -0,0 +1,73 @@
+/**
+ * Include code to enable copy-to-clipboard functionality
+ * and currently used on index and matrix tables
+ * @example in Haml
+ *     %div.clippable
+ *       = Text to be copied
+ *       %button.clippy.hidden{ title: "Copy to clipboard" }
+ *         %span.glyphicon.glyphicon-copy
+ */
+
+/**
+ * Bootstrap copy-to-clipboard functionality
+ * @param {string} selector CSS selector of elements that require
+ *     copy-to-clipboard functionality
+ */
+function initializeClipper(selector) {
+  const elements = $(selector);
+
+  elements.hover(function() {
+    $(this).children(".clippy").toggleClass("hidden");
+  });
+
+  elements
+    .children(".clippy")
+    .click(function() {
+      const clippyButton = $(this);
+      const text = $.trim(clippyButton.closest(selector).text());
+
+      copyToClipboard(text);
+      flashClipped(clippyButton);
+    });
+}
+
+/**
+ * Copy text to clipboard using execCommand
+ * @see https://gist.github.com/Chalarangelo/4ff1e8c0ec03d9294628efbae49216db#file-copytoclipboard-js
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/execCommand
+ * @param {string} text text to be copied to clipboard
+ */
+function copyToClipboard(text) {
+  const el = document.createElement('textarea');
+  el.value = text;
+  el.setAttribute('readonly', '');
+  el.style.position = 'absolute';
+  el.style.left = '-9999px';
+  document.body.appendChild(el);
+
+  const selected =
+        document.getSelection().rangeCount > 0
+        ? document.getSelection().getRangeAt(0)
+        : false;
+  el.select();
+  document.execCommand('copy');
+  document.body.removeChild(el);
+  if (selected) {
+    document.getSelection().removeAllRanges();
+    document.getSelection().addRange(selected);
+  }
+}
+
+/**
+ * Flash a success tick to indicate successful copy-to-clipboard action
+ * @param {jQuery Element} clipButton button to copy to clipboard
+ */
+function flashClipped(clippyButton) {
+  const icon = clippyButton.children("span");
+  icon.attr("class", "glyphicon glyphicon-ok success");
+
+  setTimeout(
+    function() { icon.attr("class", "glyphicon glyphicon-copy"); },
+    2000
+  );
+}

data/public/javascripts/matrix.js

@@ -1,4 +1,3 @@
-
 function setTextboxVisibility(selectBox, cssSelector, visibility) {
   var textbox = selectBox.closest('.selector').find(cssSelector);
   textbox.toggle(visibility);
@@ -65,7 +64,6 @@ $(document).ready(function(){
     }
   });
 
-
   $('[data-toggle="tooltip"]').each(function(index, el){
     $(el).tooltip({container: $(el)});
   });

data/public/stylesheets/index.css

@@ -56,6 +56,25 @@ body { padding-top: 10px; }
   word-wrap: break-word;
 }
 
+.clippable {
+  display: flex;
+  justify-content: flex-start;
+}
+
+.clippy {
+  padding: 0 4px;
+  border: none;
+  background: none;
+}
+
+.clippy:hover {
+  color: #2a6496;
+}
+
+.success {
+  color: #5cb85c
+}
+
 span.pact {
   display: inline-block;
 }

data/script/prod/clean-up.sql

@@ -0,0 +1,11 @@
+-- Deletes all verifications and pact publications that are older than 60 days,
+-- and cleans up orphan pacticipant versions and their tags.
+-- Also removes webhook execution history.
+
+DELETE FROM webhook_executions;
+DELETE FROM triggered_webhooks;
+DELETE FROM verifications WHERE created_at < now() - '60 days'::interval;
+DELETE FROM pact_publications WHERE created_at < now() - '60 days'::interval;
+DELETE FROM pact_versions WHERE id NOT IN (SELECT pact_version_id FROM pact_publications UNION SELECT pact_version_id FROM verifications);
+DELETE FROM tags WHERE version_id NOT IN (SELECT consumer_version_id FROM pact_publications UNION SELECT provider_version_id FROM verifications);
+DELETE FROM versions WHERE id NOT IN (SELECT consumer_version_id FROM pact_publications UNION SELECT provider_version_id FROM verifications);

data/script/query.rb

@@ -17,5 +17,4 @@ puts time.real
 
 __END__
 
-
 select * from matrix

data/script/seed-matrix.rb

@@ -88,4 +88,3 @@ TestDataBuilder.new
   # .create_pact
   # .create_verification(provider_version: '57fa24e44efc4d8aa42bb855a8217f145b5b1b5b', success: true)
 
-

data/script/seed.rb

@@ -23,7 +23,6 @@ PactBroker::DB.connection = connection
 require 'pact_broker'
 require 'support/test_data_builder'
 
-
 require 'database/table_dependency_calculator'
 PactBroker::Database::TableDependencyCalculator.call(connection).each do | table_name |
   connection[table_name].delete

data/spec/features/delete_version_spec.rb

@@ -16,7 +16,6 @@ describe "Delete version" do
       .create_consumer_version("1.2.4")
   end
 
-
   it "returns a 200 HAL JSON response" do
     expect(subject.status).to eq 204
   end

data/spec/features/execute_unsaved_webhook_spec.rb

@@ -0,0 +1,56 @@
+require 'support/test_data_builder'
+require 'webmock/rspec'
+require 'rack/pact_broker/database_transaction'
+
+describe "Execute a webhook" do
+
+  let(:td) { TestDataBuilder.new }
+
+  before do
+    td.create_pact_with_hierarchy("Foo", "1", "Bar")
+    allow(PactBroker.configuration).to receive(:webhook_scheme_whitelist).and_return(%w[http])
+  end
+
+  let(:params) do
+    {
+      request: {
+        method: 'POST',
+        url: 'http://example.org',
+        headers: {'Content-Type' => 'application/json'},
+        body: '${pactbroker.pactUrl}'
+      }
+    }
+  end
+  let(:rack_headers) { { "CONTENT_TYPE" => "application/json", "HTTP_ACCEPT" => "application/hal+json" } }
+
+  let(:path) { "/webhooks/execute" }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { post(path, params.to_json, rack_headers) }
+
+  context "when the execution is successful" do
+    let!(:request) do
+      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.*} }
+    let(:response_body) { "webhook-response-body" }
+
+    it "performs the HTTP request" do
+      subject
+      expect(request).to have_been_made
+    end
+
+    it "returns a 200 response" do
+      expect(subject.status).to be 200
+    end
+  end
+
+  context "when there is a validation error" do
+    let(:params) { {} }
+
+    it "returns a 400" do
+      expect(subject.status).to be 400
+    end
+  end
+end

data/spec/features/execute_webhook_spec.rb

@@ -3,19 +3,16 @@ require 'webmock/rspec'
 require 'rack/pact_broker/database_transaction'
 
 describe "Execute a webhook" do
-
-  let(:td) { TestDataBuilder.new }
-
   before do
-    Thread.current[:pact_broker_thread_data] = OpenStruct.new(base_url: 'http://broker')
     td.create_pact_with_hierarchy("Foo", "1", "Bar")
       .create_webhook(method: 'POST', body: '${pactbroker.pactUrl}')
   end
 
+  let(:td) { TestDataBuilder.new }
   let(:path) { "/webhooks/#{td.webhook.uuid}/execute" }
   let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
 
-  subject { post path; last_response }
+  subject { post(path) }
 
   context "when the execution is successful" do
     let!(:request) do

data/spec/features/get_version_spec.rb

@@ -18,7 +18,6 @@ describe "Get version" do
         .create_consumer_version("1.2.4")
     end
 
-
     it "returns a 200 HAL JSON response" do
       expect(subject).to be_a_hal_json_success_response
     end

data/spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb

@@ -83,7 +83,6 @@ module PactBroker
             end
           end
 
-
           context "with a consumer name in the pact that does not match the consumer name in the path" do
             let(:attributes) do
               valid_attributes.merge(consumer_name: "another consumer")

data/spec/lib/pact_broker/api/contracts/verification_contract_spec.rb

@@ -12,7 +12,6 @@ module PactBroker
         let(:valid_params) { {success: success, providerApplicationVersion: provider_version, buildUrl: build_url} }
         let(:params) { valid_params }
 
-
         let(:success) { true }
         let(:provider_version) { "4.5.6" }
         let(:build_url) { 'http://foo' }

data/spec/lib/pact_broker/api/decorators/relationships_csv_decorator_spec.rb

@@ -12,10 +12,8 @@ module PactBroker
         let(:pact) { TestDataBuilder.new.create_pact_with_hierarchy("My Consumer", "1.0", "My Provider").and_return(:pact) }
         let(:pacts) { [pact]}
 
-
         subject { RelationshipsCsvDecorator.new(pacts) }
 
-
         describe "#to_csv" do
 
           let(:line_1) { '1,My Consumer,1,3158419,0,1,2,0,0,0,0,0,0,0,0'}

data/spec/lib/pact_broker/api/decorators/verification_decorator_spec.rb

@@ -33,7 +33,6 @@ module PactBroker
 
         let(:options) { { user_options: { base_url: 'http://example.org' } } }
 
-
         let(:json) { VerificationDecorator.new(verification).to_json(options) }
 
         subject { JSON.parse json, symbolize_names: true }