pact_broker 2.38.1 → 2.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ac1db03f84cc1808c8478d24d33e24ad0b4cb9a4d8d5de5f4f123e9ab7994f2d
-  data.tar.gz: 5a96dc5e3fa3378a34b648f421091442a3b616fd123de2b42b96dee9389916b0
+SHA1:
+  metadata.gz: 7e280e7c13bd55791cab9e6133c2a63c62e18c89
+  data.tar.gz: 34f9831b62572f892ccd85a4a71f8f05e0660210
 SHA512:
-  metadata.gz: 5c3b636c4768b80bd046abdeec33c75cf53e3c0793590521e6b0cec337e1591ee9f71dd9130de9b9c7a10159a732de7d851864c9898276aa19e357fd3b7f8279
-  data.tar.gz: 7e41605da8904ed4b0a80cca5737f0adc7766c4dd330fe89e012934359772e449b8b26bdc46fd5acb9d76a837460f26048d08863c9654aaf84ed5bf2f913bb4d
+  metadata.gz: 358dff2b700249596936bf1cd380568a01220941a0f63e4d70ed3366f5e69b1a8fa2855976011779439dfd01e43cae4e2c79b370a9f1920bcb98a199da92f132
+  data.tar.gz: f5a45fde10fde4d65afef8cc1ce3202da9dd46163c5f0096f6c421a305dc87a1f0528502bfcc0a15d4771b7a95e0e42864a6de1f218e56a1daadee73e5b69225

data/.github/ISSUE_TEMPLATE.md

@@ -25,8 +25,8 @@ TBC
 
 ## Steps to reproduce
 
-Provide a repository, gist or reproducable code snippet so that we can test the problem.
+Provide a repository, gist or reproducible code snippet so that we can test the problem.
 
-## Relevent log files
+## Relevant log files
 
 Please ensure you set logging to `DEBUG` and attach any relevant log files here (or link from a gist).

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+<a name="v2.39.0"></a>
+### v2.39.0 (2019-10-21)
+
+
+#### Features
+
+* **matrix**
+  * optimise query for can-i-deploy, again	 ([78b8a5d5](/../../commit/78b8a5d5))
+  * handle overwritten revisions in database rather than code	 ([1459b46a](/../../commit/1459b46a))
+
+* **clean**
+  * allow date to be specified for data to clean and return counts of deleted and kept rows	 ([29dcbacd](/../../commit/29dcbacd))
+
+* update db clean to remove webhooks triggered by verifications	 ([f38eeaea](/../../commit/f38eeaea))
+* add revisions per consumer version and verifications per pact version to metrics	 ([f764fbca](/../../commit/f764fbca))
+* show more helpful error message when someone tries to get /all verifications for a pact	 ([bea59518](/../../commit/bea59518))
+* add missing HAL docs for various relations and correct test that should have identified their absence	 ([a057427c](/../../commit/a057427c))
+* add can-i-deploy endpoint to expose a simplified interface to the /matrix resource that accepts the same parameters as the can-i-deploy CLI.	 ([02443f39](/../../commit/02443f39))
+* add 'pacts for verification' endpoint (#308)	 ([31fb8aa7](/../../commit/31fb8aa7))
+
+* **metrics**
+  * add revision count	 ([4369f227](/../../commit/4369f227))
+  * add matrix and head matrix row counts	 ([5fb705ec](/../../commit/5fb705ec))
+
+* **dashboard api**
+  * eager load the pact_version	 ([b6b5c900](/../../commit/b6b5c900))
+
+* **integrations**
+  * sort by integration with most recent activity first	 ([35bdbb92](/../../commit/35bdbb92))
+  * add verification status to integrations endpoint	 ([437ba769](/../../commit/437ba769))
+
+
+#### Bug Fixes
+
+* typos on ISSUE_TEMPLATE (#311)	 ([a10b4792](/../../commit/a10b4792))
+* add endpoints to get latest verification for latest pact	 ([73413727](/../../commit/73413727))
+* support application/vnd.pactbrokerextended.v1+json for latest pact resource	 ([476ff595](/../../commit/476ff595))
+
+* **matrix**
+  * undefined method	 ([b365c64b](/../../commit/b365c64b))
+
+* **dashboard api**
+  * remove expensive queries for unused data	 ([07206559](/../../commit/07206559))
+
+
 <a name="v2.38.1"></a>
 ### v2.38.1 (2019-09-23)
 

data/DEVELOPER_DOCUMENTATION.md

@@ -31,6 +31,15 @@
 
 Domain classes are found in `lib/pact_broker/domain`. Many of these classes are Sequel models, as the difference between the Sequel model and the functionality required for the domain logic is similar enough to share the class. Some classes separate the domain and database logic, as the concerns are too different. Where there is a separate database model, this will be kept in a module with the pluralized name of the model eg. `PactBroker::Webhooks`. Unfortunately, this sometimes makes it difficult to tell in the calling code whether you have a domain or a database model. I haven't worked out a clean way to handle this yet.
 
+### Domain terminology
+
+* `pacticipant` - an application that participates in a pact. A very bad pun which I deeply regret.
+* `pact` - this term is confusing and overloaded. It generally means a `pact publication` in the code.
+* `pact publication` - the resource that gets created when a PUT request is sent to the Pact Broker to /pacts/provider/PROVIDER/consumer/CONSUMER/version/VERSION.
+* `pact version` - the JSON contents of the pact publication. One pact version may belong to many pact publications. That is, if a pact publication with exactly the same contents is published twice, then a new
+pact publication resource will be created, but it will reuse the existing pact version.
+* `pseudo branch` - A time ordered list of pacts that are related to a particular tag. The most recent pact for each pseudo branch is a "head" pact.
+
 ### Tables
 * `pact_versions` - the JSON content of each UNIQUE pact document is stored in this table. The same content is likely to be published over and over again by the CI builds, so deduplicating the content saves us a lot of disk space. Once created, a row is never modified. Uniqueness is just done on string equality - no special pact logic. This means that pacts with randomly generated values or orders (most of pact-jvm pacts!) will get a new version record every time they publish.
 

data/Dockerfile

@@ -1,5 +1,6 @@
 FROM ruby:2.5.3-alpine
 
+ENV INSTALL_MYSQL=true
 RUN apk update \
     && apk --no-cache add \
       "build-base>=0.5" \
@@ -10,6 +11,7 @@ RUN apk update \
       "sqlite-dev>=3.28" \
       "sqlite>=3.28" \
       "tzdata>=2019" \
+      "mariadb-dev>=10.3" \
     && rm -rf /var/cache/apk/*
 
 WORKDIR /app

data/Gemfile

@@ -5,5 +5,5 @@ gemspec
 gem 'simplecov', :require => false, :group => :test
 
 if ENV['INSTALL_MYSQL'] == "true"
-  gem 'mysql2', '~>0.3.15'
+  gem 'mysql2', '~>0.5'
 end

data/README.md

@@ -8,7 +8,13 @@
 
 The Pact Broker is an application for sharing for consumer driven contracts and verification results. It is optimised for use with "pacts" (contracts created by the [Pact][pact-docs] framework), but can be used for any type of contract that can be serialized to JSON.
 
-**Why do I need one?**
+<br/>
+<a href="https:/pactflow.io/?utm_source=github&utm_campaign=pact_broker_intro"><img src="docs/images/Pactflow logo - black small.png"></a>
+<br/>
+
+You can try out a Pact Broker for free at <a href="https:/pactflow.io/?utm_source=github&utm_campaign=pact_broker_intro"/>pactflow.io</a>. Built by a group of core Pact maintainers, Pactflow is a fork of the OSS Pact Broker with extra goodies like an improved UI, field level verification results and federated login.
+
+**Why do I need a Pact Broker?**
 
 Contract testing is an alternative approach to traditional integration testing that gives you tests that are quicker to execute, and that are more maintainable at scale. One down side of the approach is that the important information that would be available all in one place at the end of an integration test suite execution (that is, the version numbers of all the applications that were tested together, and whether the tests passed or failed) is now spread out across many different builds. The Pact Broker is a tool that brings all this information back together again, and allows you to deploy with safety.
 
@@ -38,6 +44,7 @@ Features:
 * [Docker Pact Broker][docker]
 * A [CLI][cli] for encorporating the Pact workflow into your continuous integration process.
 
+
 ### How would I use the Pact Broker?
 
 #### Step 1. Consumer CI build
@@ -128,7 +135,7 @@ Use the HAL browser to view documentation as you browse.
 
 #### Hosted
 
-In a hurry? Hate having to run your own infrastructure? Check out the [Hosted Pact Broker][hosted] - it's fast, it's secure and it's free!
+In a hurry? Hate having to run your own infrastructure? Check out [pactflow.io][pactflow] - it's fast, it's secure and it's free to trial!
 
 #### Container solutions
 
@@ -161,7 +168,7 @@ Please read the [UPGRADING.md](UPGRADING.md) documentation before upgrading your
 [different-teams]: https://github.com/pact-foundation/pact-ruby/wiki/Using-pact-where-the-consumer-team-is-different-from-the-provider-team
 [docker]: https://hub.docker.com/r/dius/pact-broker
 [terraform]: https://github.com/nadnerb/terraform-pact-broker
-[hosted]: https://pact.dius.com.au/?utm_source=github&utm_campaign=GITHUB_BROKER&utm_medium=github
+[pactflow]: https:/pactflow.io/?utm_source=github&utm_campaign=pact_broker_usage
 [wiki]: https://github.com/pact-foundation/pact_broker/wiki
 [reverse-proxy-docs]: https://github.com/pact-foundation/pact_broker/wiki/Configuration#running-the-broker-behind-a-reverse-proxy
 [stackoverflow]: http://stackoverflow.com/questions/tagged/pact-broker

data/config/database.yml

@@ -16,11 +16,15 @@ test:
     database: postgres
     username: postgres
     password: postgres
-    host: "localhost"
+    host: localhost
     port: "5433"
   mysql:
     <<: *default
     adapter: mysql2
+  docker_mysql:
+    <<: *default
+    adapter: mysql2
+    host: "192.168.0.9"
 
 development:
   default:
@@ -34,11 +38,15 @@ development:
     database: postgres
     username: postgres
     password: postgres
-    host: "localhost"
+    host: localhost
     port: "5432"
   mysql:
     <<: *default
     adapter: mysql2
+  docker_mysql:
+    <<: *default
+    adapter: mysql2
+    host: localhost
 
 production:
   default:

data/lib/pact_broker/api.rb

@@ -30,6 +30,8 @@ module PactBroker
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', 'latest'], Api::Resources::LatestVerificationForPact, {resource_name: "latest_verification_results_for_pact_version"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', :verification_number], Api::Resources::Verification, {resource_name: "verification_result"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', :verification_number, 'triggered-webhooks'], Api::Resources::VerificationTriggeredWebhooks, {resource_name: "verification_result_triggered_webhooks"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', 'verification-results','latest'], Api::Resources::LatestVerificationForLatestPact, {resource_name: "latest_verification_results_for_latest_pact_publication"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', :tag, 'verification-results','latest'], Api::Resources::LatestVerificationForLatestPact, {resource_name: "latest_verification_results_for_latest_tagged_pact_publication"}
         add ['verification-results', 'consumer', :consumer_name, 'version', :consumer_version_number,'latest'], Api::Resources::LatestVerificationsForConsumerVersion, {resource_name: "verification_results_for_consumer_version"}
 
         # Badges
@@ -47,8 +49,8 @@ module PactBroker
         add ['pacts', 'provider', :provider_name, 'latest', :tag], Api::Resources::LatestProviderPacts, {resource_name: "latest_tagged_provider_pact_publications"}
         add ['pacts', 'latest'], Api::Resources::LatestPacts, {resource_name: "latest_pacts"}
 
-        # Pending pacts
-        add ['pacts', 'provider', :provider_name, 'pending'], Api::Resources::PendingProviderPacts, {resource_name: "pending_provider_pact_publications"}
+        # Pacts for verification
+        add ['pacts', 'provider', :provider_name, 'for-verification'], Api::Resources::ProviderPactsForVerification, {resource_name: "pacts_for_verification"}
 
         # Deprecated pact
         add ['pact', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publications", deprecated: "true"} # Deprecate, singular /pact
@@ -86,6 +88,7 @@ module PactBroker
         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 ['can-i-deploy'], Api::Resources::CanIDeploy, {resource_name: "can-i-deploy"}
 
         add ['dashboard'], Api::Resources::Dashboard, {resource_name: "dashboard"}
         add ['dashboard', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::Dashboard, {resource_name: "integration_dashboard"}

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

@@ -0,0 +1,41 @@
+require 'dry-validation'
+
+module PactBroker
+  module Api
+    module Contracts
+      class VerifiablePactsQuerySchema
+        SCHEMA = Dry::Validation.Schema do
+          optional(:provider_version_tags).maybe(:array?)
+          # optional(:exclude_other_pending).filled(included_in?: ["true", "false"])
+          optional(:consumer_version_selectors).each do
+            schema do
+              required(:tag).filled(:str?)
+              optional(:latest).filled(included_in?: ["true", "false"])
+            end
+          end
+        end
+
+        def self.call(params)
+          select_first_message(flatten_index_messages(SCHEMA.call(params).messages(full: true)))
+        end
+
+        def self.select_first_message(messages)
+          messages.each_with_object({}) do | (key, value), new_messages |
+            new_messages[key] = [value.first]
+          end
+        end
+
+        def self.flatten_index_messages(messages)
+          if messages[:consumer_version_selectors]
+            new_messages = messages[:consumer_version_selectors].collect do | index, value |
+              value.values.flatten.collect { | text | "#{text} at index #{index}"}
+            end.flatten
+            messages.merge(consumer_version_selectors: new_messages)
+          else
+            messages
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,7 +45,7 @@ module PactBroker
             pactTags: pact_tags(index_item, base_url),
             latestVerificationResult: verification_hash(index_item, base_url),
             latestVerificationResultTags: verification_tags(index_item, base_url),
-            verificationStatus: index_item.verification_status.to_s,
+            verificationStatus: index_item.pseudo_branch_verification_status.to_s,
             webhookStatus: index_item.webhook_status.to_s,
             latestWebhookExecution: latest_webhook_execution(index_item, base_url),
             _links: links(index_item, base_url)

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

@@ -41,7 +41,7 @@ module PactBroker
             index_item.provider_name,
             index_item.provider_version_number,
             index_item.latest_verification_latest_tags.collect(&:name).sort.join(", "),
-            index_item.verification_status.to_s
+            index_item.pseudo_branch_verification_status.to_s
           )
         end
       end

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

@@ -15,6 +15,8 @@ module PactBroker
           property :name
         end
 
+        property :verificationStatus, getter: ->(represented:, **) { represented.verification_status_for_latest_pact.to_s }
+
         link "pb:dashboard" do | options |
           {
             title: "BETA: Pacts to show on the dashboard",

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

@@ -1,11 +1,45 @@
 require_relative 'base_decorator'
 require 'pact_broker/api/pact_broker_urls'
+require 'delegate'
+require 'pact_broker/pacts/verifiable_pact_messages'
 
 module PactBroker
   module Api
     module Decorators
       class VerifiablePactDecorator < BaseDecorator
 
+        # Allows a "flat" VerifiablePact to look like it has
+        # a nested verification_properties object for Reform
+        class Reshaper < SimpleDelegator
+          def verification_properties
+            __getobj__()
+          end
+        end
+
+        def initialize(verifiable_pact)
+          super(Reshaper.new(verifiable_pact))
+        end
+
+        property :verification_properties, as: :verificationProperties do
+          property :pending
+          property :pending_reason, as: :pendingReason, exec_context: :decorator
+          property :inclusion_reason, as: :inclusionReason, exec_context: :decorator
+
+          def inclusion_reason
+            PactBroker::Pacts::VerifiablePactMessages.new(represented).inclusion_reason
+          end
+
+          def pending_reason
+            PactBroker::Pacts::VerifiablePactMessages.new(represented).pending_reason
+          end
+        end
+
+        link :self do | context |
+          {
+            href: pact_version_url(represented, context[:base_url]),
+            name: represented.name
+          }
+        end
       end
     end
   end

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

@@ -0,0 +1,27 @@
+require_relative 'base_decorator'
+require_relative 'verifiable_pact_decorator'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class VerifiablePactsQueryDecorator < BaseDecorator
+        collection :provider_version_tags
+
+        collection :consumer_version_selectors, class: OpenStruct do
+          property :tag
+          property :latest, setter: ->(fragment:, represented:, **) { represented.latest = (fragment == 'true') }
+        end
+
+
+        def from_hash(*args)
+          # Should remember how to do this via Representable...
+          result = super
+          result.consumer_version_selectors = [] if result.consumer_version_selectors.nil?
+          result.provider_version_tags = [] if result.provider_version_tags.nil?
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/verifications/verification_status'
+require 'pact_broker/verifications/pseudo_branch_status'
 require 'pact_broker/configuration'
 
 module PactBroker
@@ -32,7 +32,7 @@ module PactBroker
 
         def to_svg
           response.headers['Cache-Control'] = 'no-cache'
-          comment + badge_service.pact_verification_badge(pact, label, initials, verification_status)
+          comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status)
         end
 
         def pact
@@ -44,8 +44,8 @@ module PactBroker
           @verification ||= verification_service.find_latest_verification_for(pact.consumer, pact.provider, identifier_from_path[:tag])
         end
 
-        def verification_status
-          @verification_status ||= PactBroker::Verifications::Status.new(pact, latest_verification).to_sym
+        def pseudo_branch_verification_status
+          @pseudo_branch_verification_status ||= PactBroker::Verifications::PseudoBranchStatus.new(pact, latest_verification).to_sym
         end
 
         def label

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

@@ -0,0 +1,41 @@
+require 'pact_broker/api/resources/matrix'
+require 'pact_broker/matrix/can_i_deploy_query_schema'
+require 'pact_broker/matrix/parse_can_i_deploy_query'
+
+module PactBroker
+  module Api
+    module Resources
+      class CanIDeploy < Matrix
+        def initialize
+          @query_params = JSON.parse(Rack::Utils.parse_nested_query(request.uri.query).to_json, symbolize_names: true)
+          @selectors, @options = PactBroker::Matrix::ParseCanIDeployQuery.call(query_params)
+        end
+
+        def malformed_request?
+          if (errors = query_schema.call(query_params)).any?
+            set_json_validation_error_messages(errors)
+            true
+          else
+            false
+          end
+        end
+
+        private
+
+        attr_reader :query_params
+
+        def query_schema
+          PactBroker::Api::Contracts::CanIDeployQuerySchema
+        end
+
+        def selectors
+          @selectors
+        end
+
+        def options
+          @options
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module PactBroker
         private
 
         def index_items
-          index_service.find_index_items(identifier_from_path.merge(tags: true, dashboard: true))
+          index_service.find_index_items_for_api(identifier_from_path)
         end
       end
     end