pact_broker 2.34.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe2b3ac695d8a843322fa534dfeab9fe17956c99
-  data.tar.gz: 7f0fccfb8bc7b2713feb0effa685e2773ad2a90b
+  metadata.gz: 16a87ec2e8bd7d3047768e040433544194b306fa
+  data.tar.gz: 7dda1535ad3341c18acd174f2459cae29be8e287
 SHA512:
-  metadata.gz: 1c339fb970aa844ebfb4efb48055a7807641076cbcad153f93a7f03df9631a86e6d36a3ad36f804d0e72f63f621805cad0fb872a609ed25399b59107f38ecaa4
-  data.tar.gz: 2b55bccea03acdd7304abf226109abb0a21a86b0aa43f18f4c92743b4b2e6bc5ab24e5f81cc9c10b761b86eba55038a47a94392d194cde790d841dd75df26751
+  metadata.gz: cf0fa7165f17a13b045d068d78cbe0aebe5cf860055d271a00dc369d56eff478c3946c8a22451f323eb762bee75069c6359c208c6178dfd82c0561a5c03444bd
+  data.tar.gz: 27f0ffd8fceaa7f907fe3e256c4e0f63947ffc4343cb01982e4d1eb5fe2d63b4c0097d602653026cc8deec4349b49e6c7bea9776fa45fc7e67bf80388df94f0b

data/.dockerignore

@@ -0,0 +1,2 @@
+**/.git
+tmp

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+open_collective: pact-foundation
+custom: ['https://pactflow.io']

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - 2.4.1
-  - 2.3.4
+  - 2.5
 services:
   - postgresql
   - mysql

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+<a name="v2.35.0"></a>
+### v2.35.0 (2019-08-08)
+
+
+#### Features
+
+* **webhooks**
+  * do not redact a password with a parameter in it	 ([47c602ef](/../../commit/47c602ef))
+  * update parameter text	 ([7fa518cb](/../../commit/7fa518cb))
+  * do not redact header if it contains a parameter	 ([5787e0d1](/../../commit/5787e0d1))
+  * support template parameters in header values, username and password	 ([a800ac2e](/../../commit/a800ac2e))
+  * simplify request logger format	 ([c52ade2f](/../../commit/c52ade2f))
+  * add the logs and success flag to the execution result	 ([96769a88](/../../commit/96769a88))
+  * allow testing of an unsaved webhook	 ([a436e42d](/../../commit/a436e42d))
+  * gracefully handle scenario where triggered webhook has been deleted while webhook was being executed	 ([052055d4](/../../commit/052055d4))
+  * use consumer/provider names in webhook title	 ([2b5d2498](/../../commit/2b5d2498))
+
+* add copy to clipboard for version numbers (#283)	 ([c10a6f28](/../../commit/c10a6f28))
+* update redact logs	 ([51aa13c0](/../../commit/51aa13c0))
+* use hardcoded error message when error class has a nil message	 ([03a3b63c](/../../commit/03a3b63c))
+* ensure clean up script handles pact versions for left over verifications	 ([116f8eaa](/../../commit/116f8eaa))
+* added clean up sql script	 ([388b441e](/../../commit/388b441e))
+* add Vary header to avoid browser returning the wrong cached content type for a resource	 ([6d30baa2](/../../commit/6d30baa2))
+* change logging level from error to info for JSON parsing errors	 ([cc144062](/../../commit/cc144062))
+
+
+#### Bug Fixes
+
+* inefficient SQL loading latest verification for pact version	 ([301d9a58](/../../commit/301d9a58))
+
+* **publish pacts**
+  * handle race condition when creating pact version	 ([de0d3b7f](/../../commit/de0d3b7f))
+
+
 <a name="v2.34.0"></a>
 ### v2.34.0 (2019-06-14)
 

data/DEVELOPER_DOCUMENTATION.md

@@ -8,7 +8,9 @@
     * HTTP Resources - [lib/pact_broker/api/resources](lib/pact_broker/api/resources) These handle the HTTP requests.
     * Decorators - [lib/pact_broker/api/decorators](lib/pact_broker/api/decorators) These render the response bodies.
     * Contracts - [lib/pact_broker/api/contracts](lib/pact_broker/api/contracts) These validate incoming API requests.
-  * Domain - Domain classes were intially created in [lib/pact_broker/domain](lib/pact_broker/domain) but are now put in their own modules. The ones left here just haven't been migrated yet.
+  * Domain - Domain classes were intially created in [lib/pact_broker/domain](lib/pact_broker/domain) but are now put in their own modules. The ones left here just haven't been migrated yet. The module name is the plural of the domain class name. eg `lib/pact_broker/widgets/widget.rb`.
+  * Services and Repositories - in the module with the name of their domain concept. eg `lib/pact_broker/widgets/service.rb` and `lib/pact_broker/widgets/repository.rb`
+  * Standalone "function as class" classes go into the module they relate to. This pattern is used when there is some significant stateless logic that we want to
 * Database migrations - [db/migrations](db/migrations)
 
 * Tests - `spec`
@@ -95,3 +97,24 @@ Domain classes are found in `lib/pact_broker/domain`. Many of these classes are
 
 * The supported database types are Postgres (recommended), MySQL (sigh) and Sqlite (just for testing, not recommended for production). Check the travis.yml file for the supported database versions.
 * Any migration that uses the "order" column has to be defined using the Sequel DSL rather than pure SQL, because the word "order" is a key word, and it has to be escaped correctly and differently on each database (Postgres, MySQL, Sqlite).
+
+## Adding a resource
+
+* In `spec/features` add a new high level spec that executes the endpoint you're going to write. Don't worry if you're not sure exactly what it's going to look like yet - you can come back and change it as you go. Have a look at the other specs in the directory for the type of assertions that should be made. Basic rule of thumb is to check the http status code, and do a light touch of assertions on the body.
+* Create a new directory for the classes that relate to your new resource. eg For a "Foo" resource, create `lib/pact_broker/foos`
+* Create a new migration in `db/migrations` that creates the underlying database table.
+* Create a new database model for the resource that extends from Sequel::Model. eg `lib/pact_broker/foos/foo.rb`
+* Create a decorator in `spec/lib/pact_broker/api/decorators/` that will map to and from the representation that will be used in the HTTP request and response.
+  * Write a spec for the decorator.
+* You may need to create a contract to validate the request. This is kind of broken while I upgrade to the latest dry-validation library. See Beth for more details.
+* Add the HTTP resource in `lib/pact_broker/api/resources/`. It should extend from `BaseResource`.
+  * Write a spec for the resource, stubbing out the behaviour you expect from your service.
+* Add the route to `lib/pact_broker/api.rb`
+* Create a service that has the methods that you need for the resource. eg. `lib/pact_broker/foos/service.rb`
+  * Add the new service to `lib/pact_broker/services.rb`
+  * Write a spec for the service, stubbing out the behaviour you expect from your repository.
+* Create a repository eg. `lib/pact_broker/foos/repository.rb`.
+  * Add the new repository to `lib/pact_broker/repositories.rb`.
+  * Write a spec for the repository.
+* Go back and make the original feature spec pass.
+* Profit.

data/DEVELOPER_SETUP.md

@@ -1,35 +1,55 @@
 # Developer setup
 
+## Preparation
+
+### With virtual battery
+
+* Build an initial local image with Docker
+  ```sh
+  docker build --rm -t pact_broker:dev .
+  ```
+
+* Spin up a container with mounted volume and open an interactive shell session
+  ```sh
+  docker run --rm -v $(PWD):/app -w /app -it pact_broker:dev bash
+  ```
+
+### With native install
+
 * You will need to install Ruby 2.5, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-install].
 * Install bundler (the Ruby gem dependency manager) `gem install bundler`
 * Check out the pact_broker repository and cd into it.
 * Run `bundle install`. If you have not got mysql or postgres installed locally, comment out the `mysql2` and `pg` development dependency lines in `pact_broker.gemspec`, as these are only really required on Travis.
-* Run `bundle exec rake pact_broker:dev:setup`. This will create an example application that you can run locally, that uses the local source code.
-* To run the example:
 
-      cd dev
-      bundle install
-      bundle exec rackup
+## Running a local application
 
+* Run `bundle exec rake pact_broker:dev:setup`. This will create an example application that you can run locally, that uses the local source code.
+* To run the example:
+  ```sh
+  cd dev
+  bundle install
+  bundle exec rackup
+  ```
 * The application will be available on `http://localhost:9292`
 
 ## Running the tests
 
-To run everything (specs, pact verifications, vulnerability scan...):
-
-`bundle exec rake`
-
-To run a smaller subset of the tests:
-
-`bundle exec rake spec`
-
-To run the "quick tests" (skip the lengthy migration specs)
-
-`bundle exec rake spec:quick`
-
-To run a single spec:
-
-`bundle exec rspec path_to_your_spec.rb`
+* To run everything (specs, pact verifications, vulnerability scan...):
+  ```sh
+  bundle exec rake
+  ```
+* To run a smaller subset of the tests:
+  ```sh
+  bundle exec rake spec
+  ```
+* To run the "quick tests" (skip the lengthy migration specs)
+  ```sh
+  bundle exec rake spec:quick
+  ```
+* To run a single spec:
+  ```sh
+  bundle exec rspec path_to_your_spec.rb
+  ```
 
 [chruby]: https://github.com/postmodern/chruby
 [ruby-install]: https://github.com/postmodern/ruby-install

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.5.3-alpine
+
+RUN apk update \
+    && apk --no-cache add \
+      "build-base>=0.5" \
+      "bash>=4.4" \
+      "ca-certificates>=20190108" \
+      "git>=2.20" \
+      "postgresql-dev>=11.3" \
+      "sqlite-dev>=3.28" \
+      "sqlite>=3.28" \
+      "tzdata>=2019" \
+    && rm -rf /var/cache/apk/*
+
+WORKDIR /app
+
+COPY . ./
+
+RUN gem install bundler -v '~>2.0.0' \
+    && bundle install --jobs 3 --retry 3
+
+CMD []

data/db/migrations/000028_create_all_pact_publications.rb

@@ -33,7 +33,6 @@ Sequel.migration do
         and app.revision_number = lr.latest_revision_number"
         )
 
-
     # updated in 20180519_recreate_views.rb
     # This view tells us the latest consumer version with a pact for a consumer/provider pair
     create_or_replace_view(:latest_pact_consumer_version_orders,

data/db/migrations/20180311_optimise_head_matrix.rb

@@ -46,7 +46,6 @@ Sequel.migration do
           }, { table_alias: :s })
     )
 
-
     create_or_replace_view(:head_matrix, HEAD_MATRIX_V1)
   end
 end

data/lib/pact/doc/doc_file.rb

@@ -25,7 +25,6 @@ module Pact
 
       attr_reader :dir, :consumer_contract, :consumer_contract_renderer, :file_extension
 
-
       def path
         File.join(dir, name)
       end

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

@@ -142,7 +142,7 @@ module PactBroker
               end
 
               def parse_uri(uri_string, placeholder = 'placeholder')
-                URI(uri_string.gsub(PactBroker::Webhooks::Render::TEMPLATE_PARAMETER_REGEXP, placeholder))
+                URI(PactBroker::Webhooks::Render.render_with_placeholder(uri_string, placeholder))
               end
             end
 

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

@@ -11,17 +11,17 @@ module PactBroker
           self[:base_url] = base_url
           @resource_url = resource_url
           self[:resource_url] = resource_url
-          @resource_title = options[:resource_title]
-          self[:resource_title] = resource_title
+          if options[:resource_title]
+            @resource_title = options[:resource_title]
+            self[:resource_title] = resource_title
+          end
           merge!(options)
         end
 
         def to_s
           "DecoratorContext #{super}"
         end
-
       end
-
     end
   end
-end
+end

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

@@ -53,7 +53,6 @@ module PactBroker
           }
         end
 
-
         link :'pb:latest-pact-version' do | options |
           {
             title: "Latest version of this pact",

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

@@ -2,7 +2,6 @@ require 'pact_broker/api/pact_broker_urls'
 require_relative 'embedded_version_decorator'
 require_relative 'base_decorator'
 
-
 module PactBroker
 
   module Api

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

@@ -14,7 +14,6 @@ module PactBroker
 
         include Timestamps
 
-
         link :self do | options |
           {
             title: 'Tag',

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

@@ -48,7 +48,6 @@ module PactBroker
           }
         end
 
-
         link :'pb:consumer' do | options |
           if represented.consumer
             {

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

@@ -35,7 +35,6 @@ module PactBroker
           end
         end
 
-
         class HTTPResponseDecorator < BaseDecorator
           property :status, :getter => lambda { |_| code.to_i }
           property :headers, exec_context: :decorator
@@ -61,17 +60,21 @@ module PactBroker
         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] }
+        property :logs
+        property :success?, as: :success
 
         link :webhook do | options |
-          {
-            href: webhook_url(options.fetch(:webhook).uuid, options.fetch(:base_url))
-          }
+          if options.fetch(:webhook).uuid
+            {
+              href: webhook_url(options.fetch(:webhook).uuid, options.fetch(:base_url))
+            }
+          end
         end
 
         link :'try-again' do | options |
           {
             title: 'Execute the webhook again',
-            href: webhook_execution_url(options.fetch(:webhook), options.fetch(:base_url))
+            href: options.fetch(:resource_url)
           }
         end
 

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

@@ -7,15 +7,12 @@ module PactBroker
 
         property :method
         property :url
-        property :headers, getter: lambda { | _ | headers.empty? ? nil : self.redacted_headers }
+        property :headers, getter: lambda { | _ | self.redacted_headers.empty? ? nil : self.redacted_headers }
         property :body
         property :username
         property :password, getter: lambda { | _ | display_password }
 
 
-        def redacted_headers
-          represented.headers
-        end
       end
     end
   end

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

@@ -6,7 +6,6 @@ module PactBroker
     module Decorators
       class WebhooksDecorator < BaseDecorator
 
-
         link :self do | context |
           {
             title: context[:resource_title],
@@ -24,7 +23,7 @@ module PactBroker
         links :'pb:webhooks' do | context |
           represented.entries.collect do | webhook |
             {
-              title: "Webhook",
+              title: webhook.scope_description,
               name: webhook.display_description,
               href: webhook_url(webhook.uuid, context[:base_url])
             }

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

@@ -23,7 +23,6 @@ module PactBroker
         include PactBroker::Api::Resources::Authentication
         include PactBroker::Logging
 
-
         attr_accessor :user
 
         def initialize

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

@@ -9,20 +9,27 @@ module PactBroker
         include PactBroker::Logging
 
         def self.call e, request, response
-          error_reference = SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
-          logger.error "#{e.message} - error reference #{error_reference}"
-          logger.error e.backtrace
+          error_reference = generate_error_reference
+          if reportable?(e)
+            log_error(e, "Error reference #{error_reference}")
+            report(e, error_reference, request)
+          else
+            logger.info "Error reference #{error_reference} - #{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
+          end
           response.body = response_body_hash(e, error_reference).to_json
-          report(e, error_reference, request) if reportable?(e)
         end
 
-        def self.reportable? e
-          !e.is_a?(PactBroker::Error)
+        def self.generate_error_reference
+          SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
+        end
+
+        def self.reportable?(e)
+          !e.is_a?(PactBroker::Error) && !e.is_a?(JSON::GeneratorError)
         end
 
         def self.display_message(e, error_reference)
           if PactBroker.configuration.show_backtrace_in_error_response?
-            e.message
+            e.message || obfuscated_error_message(error_reference)
           else
            reportable?(e) ? obfuscated_error_message(error_reference) : e.message
           end

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

@@ -5,6 +5,8 @@ require 'pact_broker/api/decorators/pact_decorator'
 require 'pact_broker/json'
 require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/contracts/put_pact_params_contract'
+require 'pact_broker/webhooks/execution_configuration'
+require 'pact_broker/api/resources/webhook_execution_methods'
 
 module Webmachine
   class Request
@@ -15,13 +17,11 @@ module Webmachine
 end
 
 module PactBroker
-
   module Api
     module Resources
-
       class Pact < BaseResource
-
         include PacticipantResourceMethods
+        include WebhookExecutionMethods
 
         def content_types_provided
           [["application/hal+json", :to_json],
@@ -122,12 +122,7 @@ module PactBroker
         def webhook_options
           {
             database_connector: database_connector,
-            logging_options: {
-              show_response: PactBroker.configuration.show_webhook_response?
-            },
-            webhook_context: {
-              base_url: base_url
-            }
+            webhook_execution_configuration: webhook_execution_configuration
           }
         end
       end

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

@@ -76,7 +76,6 @@ module PactBroker
           @next_uuid ||= webhook_service.next_uuid
         end
 
-
       end
     end
   end

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

@@ -3,12 +3,13 @@ require 'pact_broker/configuration'
 require 'pact_broker/domain/verification'
 require 'pact_broker/api/contracts/verification_contract'
 require 'pact_broker/api/decorators/verification_decorator'
+require 'pact_broker/api/resources/webhook_execution_methods'
 
 module PactBroker
   module Api
     module Resources
-
       class Verifications < BaseResource
+        include WebhookExecutionMethods
 
         def content_types_accepted
           [["application/json", :from_json]]
@@ -70,7 +71,6 @@ module PactBroker
           request.post?
         end
 
-
         def metadata
           PactBrokerUrls.parse_webhook_metadata(identifier_from_path[:metadata])
         end
@@ -78,12 +78,8 @@ module PactBroker
         def webhook_options
           {
             database_connector: database_connector,
-            logging_options: {
-              show_response: PactBroker.configuration.show_webhook_response?
-            },
-            webhook_context: metadata.merge(
-              base_url: base_url
-            )
+            webhook_execution_configuration: webhook_execution_configuration
+                                      .with_webhook_context(metadata)
           }
         end
       end

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

@@ -1,13 +1,15 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/services'
 require 'pact_broker/api/decorators/webhook_decorator'
+require 'pact_broker/api/resources/webhook_resource_methods'
 
 module PactBroker
   module Api
     module Resources
-
       class Webhook < BaseResource
 
+        include WebhookResourceMethods
+
         def content_types_accepted
           [["application/json", :from_json]]
         end
@@ -26,7 +28,7 @@ module PactBroker
 
         def malformed_request?
           if request.put?
-            return invalid_json? || validation_errors?(webhook)
+            return invalid_json? || webhook_validation_errors?(new_webhook)
           end
           false
         end
@@ -51,12 +53,6 @@ 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

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

@@ -1,21 +1,34 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/services'
 require 'pact_broker/api/decorators/webhook_execution_result_decorator'
+require 'pact_broker/api/resources/webhook_resource_methods'
 require 'pact_broker/constants'
+require 'pact_broker/webhooks/execution_configuration'
+require 'pact_broker/api/resources/webhook_execution_methods'
 
 module PactBroker
   module Api
     module Resources
       class WebhookExecution < BaseResource
+        include WebhookResourceMethods
+        include WebhookExecutionMethods
+
+        def content_types_accepted
+          [["application/json"]]
+        end
+
+        def content_types_provided
+          [["application/hal+json"]]
+        end
 
         def allowed_methods
           ["POST", "OPTIONS"]
         end
 
         def process_post
-          webhook_execution_result = webhook_service.test_execution(webhook, webhook_options)
+          webhook_execution_result = webhook_service.test_execution(webhook, webhook_execution_configuration)
           response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
-          response.body = post_response_body webhook_execution_result
+          response.body = post_response_body(webhook_execution_result)
           true
         end
 
@@ -23,6 +36,14 @@ module PactBroker
           webhook
         end
 
+        def malformed_request?
+          if uuid
+            false
+          else
+            webhook_validation_errors?(webhook)
+          end
+        end
+
         private
 
         def post_response_body webhook_execution_result
@@ -30,7 +51,13 @@ module PactBroker
         end
 
         def webhook
-          @webhook ||= webhook_service.find_by_uuid uuid
+          @webhook ||= begin
+            if uuid
+              webhook_service.find_by_uuid uuid
+            else
+              build_unsaved_webhook
+            end
+          end
         end
 
         def uuid
@@ -38,22 +65,14 @@ module PactBroker
         end
 
         def user_options
-          {
-            base_url: base_url,
+          decorator_context(
             webhook: webhook,
             show_response: PactBroker.configuration.show_webhook_response?
-          }
-        end
-
-        def webhook_options
-          {
-            logging_options: {
-              show_response: PactBroker.configuration.show_webhook_response?
-            },
-            webhook_context: {
-              base_url: base_url
-            }
-          }
+          )
+        end
+
+        def build_unsaved_webhook
+          Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
         end
       end
     end

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

@@ -0,0 +1,13 @@
+module PactBroker
+  module Api
+    module Resources
+      module WebhookExecutionMethods
+        def webhook_execution_configuration
+          PactBroker::Webhooks::ExecutionConfiguration.new
+            .with_show_response(PactBroker.configuration.show_webhook_response?)
+            .with_webhook_context(base_url: base_url)
+        end
+      end
+    end
+  end
+end