pact_broker 2.18.0 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be2a40680787302de6ff629cc8522bed68b57c86
-  data.tar.gz: e5fe341fb89a53b5a5b93ba801bfaad429fa34d6
+  metadata.gz: 4a315c4d4db3576fad3d6fbb76104b211382b36d
+  data.tar.gz: 88587d68f58299bd29b576172ce920c60bc4a2d7
 SHA512:
-  metadata.gz: 40bbfae215d62a2bbed81cdcae2e76236f1c952d5a7b274cb9811052b1a03e29b81e4feb344be5f7e62827c009d913ed057e6a3b0a8006b3a769774b2062c495
-  data.tar.gz: e7867be0091b5ca6e2748f032c0964f1a2409ecdb1f7d578f8dbdf071f6f35c7d4706f82a8333dc37133566027cb951436c3e18752388cb8d7bb3b40475d761f
+  metadata.gz: d061e082b1b76232f88f8a0d5e6f21bd53a9c1f1dd84ff1694ee5066ab62468c1d36c123bcb19c0f52f9663db318d14ce0c4aef0366e2f6961cef9975b85a7fb
+  data.tar.gz: 5db882315d0172d445f4966dece781605ceb818e7a4527710d0d5ca5721030950148bab308552c688dc51b077022935c8e66d2f0e85f96b32e4df6ed3c0fbb13

data/.github/ISSUE_TEMPLATE.md

@@ -1,3 +1,10 @@
+# Pre issue-raising checklist
+
+I have already (please mark the applicable with an `x`):
+
+* [ ] Upgraded to the latest Pact Broker OR
+* [ ] Checked the CHANGELOG to see if the issue I am about to raise has been fixed
+
 ## Software versions
 
 * **pact-broker gem version:** eg 2.3.1

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="v2.19.0"></a>
+### v2.19.0 (2018-05-03)
+
+
+#### Features
+
+* create endpoint to compare arbitrary pact versions, ignoring interaction/message order	 ([15f0688](/../../commit/15f0688))
+* add endpoint to retrieve a pact version by its pact content sha	 ([a519731](/../../commit/a519731))
+* include pact revision number and verification number in badge svg comment	 ([82b59ef](/../../commit/82b59ef))
+* add pb:version-tag relation to pacticipant resource	 ([0704772](/../../commit/0704772))
+* create endpoints for retrieving all pact versions for a provider, with and without a tag.	 ([d7011b2](/../../commit/d7011b2))
+* update matrix UI to allow _all_ versions with a particular tag to be specified	 ([278b3ea](/../../commit/278b3ea))
+* allow matrix to be queried for _all_ versions with a given tag	 ([cac3023](/../../commit/cac3023))
+
+
+#### Bug Fixes
+
+* correct logic for finding latest verification for revised pacts	 ([8fb28ee](/../../commit/8fb28ee))
+* do not invoke error reporters for validation errors	 ([57eed65](/../../commit/57eed65))
+
+
 <a name="v2.18.0"></a>
 ### v2.18.0 (2018-04-05)
 

data/README.md

@@ -138,12 +138,15 @@ You can use the [Pact Broker Docker image][docker] or [Terraform on AWS][terrafo
 
 * Are you sure you don't just want to use the [Pact Broker Docker image][docker]? No Docker at your company yet? Ah well, keep reading.
 * Create a PostgreSQL (recommended) or MySQL (not recommended, see following note) database.
- * __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in the future, however MySQL the other [semi supported](https://github.com/pact-foundation/pact_broker/issues/33) database.
+    * __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in the future, however MySQL the other [semi supported](https://github.com/pact-foundation/pact_broker/issues/33) database.
  * Check the [travis.yml][travisyml] file to make sure you're using the version of the database that we're currently running our tests against.
 * If you're using PostgreSQL (did we mention this was _recommended!_) you'll find the database creation script in the [example/config.ru](https://github.com/pact-foundation/pact_broker/blob/master/example/config.ru).
-* Install ruby 2.2.0 or later and bundler >= 1.12.0 (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
+* Install ruby 2.2.0 or later (ruby 2.4 is recommended) and bundler >= 1.12.0 (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
 * Copy the [pact\_broker](https://github.com/DiUS/pact_broker-docker/tree/master/pact_broker) directory from the Pact Broker Docker project. This will have the recommended settings for database connections, logging, basic auth etc. Note that the Docker image uses Phusion Passenger as the web application server in front of the Pact Broker Ruby application, which is the recommended set up.
 * Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem if using Postgres and the "mysql2" gem if using MySQL)
+    * example Sequel configuration for postgres `{adapter: "postgres", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8'}`
+    * example Sequel configuration for mysql `{adapter: "mysql2", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8'}`
+`
 * Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
 * For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application. You'll need to read up on the documentation for these yourself as it is beyond the scope of this documentation. See the [wiki][reverse-proxy-docs] for instructions on using a reverse proxy with SSL.
 * Deploy to your location of choice.

data/example/example_data.sql

@@ -14,4 +14,6 @@ INSERT INTO pact_publications VALUES(1,1,1,1,1,'2014-11-18 06:28:36.340041');
 INSERT INTO pact_publications VALUES(2,2,1,1,3,'2015-01-19 22:15:10.969518');
 INSERT INTO pact_publications VALUES(3,3,1,1,1,'2016-11-08 22:45:37.291839');
 INSERT INTO pact_publications VALUES(4,4,3,1,4,'2017-05-23 06:10:23.252829');
+INSERT INTO materialized_matrix SELECT * FROM matrix;
+INSERT INTO materialized_head_matrix SELECT * FROM head_matrix;
 COMMIT;

data/lib/pact_broker/api.rb

@@ -13,8 +13,11 @@ module PactBroker
 
         # Pacts
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publication"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha], Api::Resources::PactVersion, {resource_name: "pact_publication"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'previous-distinct'], Api::Resources::PreviousDistinctPactVersion, {resource_name: "previous_distinct_pact_version"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'diff', 'previous-distinct'], Api::Resources::PactContentDiff, {resource_name: "previous_distinct_pact_version_diff"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'diff', 'version', :comparison_consumer_version], Api::Resources::PactContentDiff, {resource_name: "pact_version_diff_by_consumer_version"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'diff', 'pact-version', :comparison_pact_version_sha], Api::Resources::PactContentDiff, {resource_name: "pact_version_diff_by_pact_version_sha"}
 
         # Verifications
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results'], Api::Resources::Verifications, {resource_name: "verification_results"}
@@ -29,6 +32,8 @@ module PactBroker
         # Latest pacts
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest'], Api::Resources::LatestPact, {resource_name: "latest_pact_publication"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', :tag], Api::Resources::LatestPact, {resource_name: "latest_tagged_pact_publication"}
+        add ['pacts', 'provider', :provider_name], Api::Resources::ProviderPacts, {resource_name: "provider_pact_publications"}
+        add ['pacts', 'provider', :provider_name, 'tag', :tag], Api::Resources::ProviderPacts, {resource_name: "tagged_provider_pact_publications"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest-untagged'], Api::Resources::LatestPact, {resource_name: "latest_untagged_pact_publication", tag: :untagged}
         add ['pacts', 'provider', :provider_name, 'latest'], Api::Resources::LatestProviderPacts, {resource_name: "latest_provider_pact_publications"}
         add ['pacts', 'provider', :provider_name, 'latest', :tag], Api::Resources::LatestProviderPacts, {resource_name: "latest_tagged_provider_pact_publications"}

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

@@ -25,6 +25,14 @@ module PactBroker
           versions_url(options[:base_url], represented)
         end
 
+        link :'pb:version-tag' do | options |
+          {
+            title: "Get, create or delete a tag for a version of #{represented.name}",
+            href: templated_tag_url_for_pacticipant(represented.name, options[:base_url]),
+            templated: true
+          }
+        end
+
         # TODO deprecate in v3
         # URL isn't implemented
         # link 'latest-version' do | options |

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

@@ -2,19 +2,15 @@ require_relative 'base_decorator'
 require_relative 'pact_version_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
-
       class ProviderPactsDecorator < BaseDecorator
 
         link :self do | context |
           suffix = context[:tag] ? " with tag '#{context[:tag]}'" : ""
           {
             href: context[:resource_url],
-            title: "Latest pact versions for the provider #{context[:provider_name]}#{suffix}"
+            title: context[:title]
           }
         end
 
@@ -25,16 +21,25 @@ module PactBroker
           }
         end
 
-        links :'pacts' do | context |
+        links :'pb:pacts' do | context |
           represented.collect do | pact |
             {
               :href => pact_url(context[:base_url], pact),
               :title => pact.name,
-              :name => pact.consumer.name
+              :name => pact.consumer_name
             }
           end
         end
 
+        links :'pacts' do | context |
+          represented.collect do | pact |
+            {
+              :href => pact_url(context[:base_url], pact),
+              :title => 'DEPRECATED - please use the pb:pacts relation',
+              :name => pact.consumer_name
+            }
+          end
+        end
       end
     end
   end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -128,6 +128,10 @@ module PactBroker
         "#{tags_url(base_url, tag.version)}/#{tag.name}"
       end
 
+      def templated_tag_url_for_pacticipant pacticipant_name, base_url = ""
+        pacticipant_url_from_params({pacticipant_name: pacticipant_name}, base_url) + "/versions/{version}/tags/{tag}"
+      end
+
       def label_url label, base_url
         "#{labels_url(label.pacticipant, base_url)}/#{label.name}"
       end

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

@@ -58,8 +58,10 @@ module PactBroker
 
         def comment
           consumer_version_number = pact ? pact.consumer_version_number : "?"
+          pact_revision = pact ? pact.revision_number : "?"
           provider_version_number = latest_verification ? latest_verification.provider_version_number : "?"
-          "<!-- #{identifier_from_path[:consumer_name]} version #{consumer_version_number} #{identifier_from_path[:provider_name]} version #{provider_version_number} -->\n"
+          verification_number =  latest_verification ? latest_verification.number : "?"
+          "<!-- #{identifier_from_path[:consumer_name]} version #{consumer_version_number} revision #{pact_revision} #{identifier_from_path[:provider_name]} version #{provider_version_number} number #{verification_number} -->\n"
         end
       end
     end

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

@@ -12,7 +12,11 @@ module PactBroker
           logger.error e
           logger.error e.backtrace
           response.body = {:message => e.message, :backtrace => e.backtrace }.to_json
-          report e, request
+          report(e, request) if reportable?(e)
+        end
+
+        def self.reportable? e
+          !e.is_a?(PactBroker::Error)
         end
 
         def self.report e, request

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

@@ -24,11 +24,11 @@ module PactBroker
         end
 
         def to_json
-          raise PactBroker::Error.new("Don't panic. This is a test API error.")
+          raise PactBroker::TestError.new("Don't panic. This is a test API error.")
         end
 
         def from_json
-          raise PactBroker::Error.new("Don't panic. This is a test API error.")
+          raise PactBroker::TestError.new("Don't panic. This is a test API error.")
         end
       end
     end

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

@@ -50,7 +50,19 @@ module PactBroker
               'pb:latest-provider-pacts-with-tag' =>
               {
                 href: base_url + '/pacts/provider/{provider}/latest/{tag}',
-                title: 'Latest pacts by provider with the specified tag',
+                title: 'Latest pacts for provider with the specified tag',
+                templated: true
+              },
+              'pb:provider-pacts-with-tag' =>
+              {
+                href: base_url + '/pacts/provider/{provider}/tag/{tag}',
+                title: 'All pact versions for the provider with the specified consumer version tag',
+                templated: true
+              },
+              'pb:provider-pacts' =>
+              {
+                href: base_url + '/pacts/provider/{provider}',
+                title: 'All pact versions for the specified provider',
                 templated: true
               },
               'pb:latest-version' => {

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

@@ -1,33 +1,21 @@
-require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/resources/provider_pacts'
 require 'pact_broker/configuration'
 require 'pact_broker/api/decorators/provider_pacts_decorator'
 
 module PactBroker
   module Api
     module Resources
-
-      class LatestProviderPacts < BaseResource
-
-        def content_types_provided
-          [["application/hal+json", :to_json]]
-        end
-
-        def allowed_methods
-          ["GET"]
-        end
-
-        def resource_exists?
-          pacticipant_service.find_pacticipant_by_name(provider_name)
-        end
-
-        def to_json
-          PactBroker::Api::Decorators::ProviderPactsDecorator.new(pacts).to_json(user_options: decorator_context(identifier_from_path))
-        end
+      class LatestProviderPacts < ProviderPacts
+        private
 
         def pacts
           pact_service.find_latest_pact_versions_for_provider provider_name, tag: identifier_from_path[:tag]
         end
 
+        def resource_title
+          suffix = identifier_from_path[:tag] ? " with consumer version tag '#{identifier_from_path[:tag]}'" : ""
+          "Latest pact versions for the provider #{identifier_from_path[:provider_name]}#{suffix}"
+        end
       end
     end
   end

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

@@ -20,7 +20,7 @@ module PactBroker
         end
 
         def to_text
-          output = PactBroker::Pacts::Diff.new.process pact_params.merge(base_url: base_url)
+          output = PactBroker::Pacts::Diff.new.process pact_params.merge(base_url: base_url), comparison_pact_params, raw: false
           response.body = output
         end
 
@@ -29,7 +29,19 @@ module PactBroker
         end
 
         def pact_params
-          @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
+          @pact_params ||= PactBroker::Pacts::PactParams.from_path_info identifier_from_path
+        end
+
+        def comparison_pact_params
+          if identifier_from_path[:comparison_consumer_version_number] || identifier_from_path[:comparison_pact_version_sha]
+            comparison_identifier_from_path = identifier_from_path.merge(
+                consumer_version_number: identifier_from_path[:comparison_consumer_version_number],
+                pact_version_sha: identifier_from_path[:comparison_pact_version_sha],
+                base_url: base_url)
+            PactBroker::Pacts::PactParams.from_path_info(comparison_identifier_from_path)
+          else
+            nil
+          end
         end
       end
     end

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

@@ -0,0 +1,13 @@
+require 'pact_broker/api/resources/pact'
+
+module PactBroker
+  module Api
+    module Resources
+      class PactVersion < Pact
+        def allowed_methods
+          ["GET"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/configuration'
+require 'pact_broker/api/decorators/provider_pacts_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+      class ProviderPacts < BaseResource
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET"]
+        end
+
+        def resource_exists?
+          pacticipant_service.find_pacticipant_by_name(provider_name)
+        end
+
+        def to_json
+          PactBroker::Api::Decorators::ProviderPactsDecorator.new(pacts).to_json(to_json_options)
+        end
+
+        private
+
+        def pacts
+          pact_service.find_pact_versions_for_provider provider_name, tag: identifier_from_path[:tag]
+        end
+
+        def to_json_options
+          {
+            user_options: decorator_context(identifier_from_path.merge(title: resource_title))
+          }
+        end
+
+        def resource_title
+          suffix = identifier_from_path[:tag] ? " with consumer version tag '#{identifier_from_path[:tag]}'" : ""
+          "All pact versions for the provider #{identifier_from_path[:provider_name]}#{suffix}"
+        end
+      end
+    end
+  end
+end

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

@@ -35,7 +35,7 @@ module PactBroker
 
         def version
           if path_info[:tag]
-            @version ||= version_service.find_by_pacticpant_name_and_latest_tag(path_info[:pacticipant_name], path_info[:tag])
+            @version ||= version_service.find_by_pacticipant_name_and_latest_tag(path_info[:pacticipant_name], path_info[:tag])
           elsif path_info[:pacticipant_version_number]
             @version ||= version_service.find_by_pacticipant_name_and_number path_info
           else

data/lib/pact_broker/domain/verification.rb

@@ -46,8 +46,7 @@ module PactBroker
 
         def tag tag_name
           filter = name_like(Sequel.qualify(:tags, :name), tag_name)
-          join(:pact_publications, {pact_version_id: :pact_version_id})
-            .join(:tags, {version_id: :consumer_version_id}).where(filter)
+          join(:tags, { version_id: :consumer_version_id }).where(filter)
         end
 
         def untagged

data/lib/pact_broker/error.rb

@@ -1,5 +1,6 @@
 module PactBroker
 
   class Error < StandardError; end
+  class TestError < StandardError; end
 
 end

data/lib/pact_broker/matrix/repository.rb

@@ -78,8 +78,6 @@ module PactBroker
         lines.sort
       end
 
-
-
       def apply_latestby options, selectors, lines
         return lines unless options[:latestby]
         group_by_columns = case options[:latestby]
@@ -134,21 +132,19 @@ module PactBroker
       end
 
       def resolve_selectors(selectors, options)
-        selectors = look_up_versions_for_latest_and_tag(selectors, options)
-
-        if options[:latest]
-          apply_latest_and_tag_to_inferred_selectors(selectors, options)
+        resolved_selectors = look_up_version_numbers(selectors, options)
+        if options[:latest] || options[:tag]
+          apply_latest_and_tag_to_inferred_selectors(resolved_selectors, options)
         else
-          selectors
+          resolved_selectors
         end
       end
 
-      # Find the version number for selectors with the latest (tagged) version specified
-      def look_up_versions_for_latest_and_tag(selectors, options)
+      # Find the version number for selectors with the latest and/or tag specified
+      def look_up_version_numbers(selectors, options)
         selectors.collect do | selector |
-          # resource validation currently stops tag being specified without latest=true
           if selector[:tag] && selector[:latest]
-            version = version_repository.find_by_pacticpant_name_and_latest_tag(selector[:pacticipant_name], selector[:tag])
+            version = version_repository.find_by_pacticipant_name_and_latest_tag(selector[:pacticipant_name], selector[:tag])
             raise Error.new("Could not find version with tag #{selector[:tag].inspect} for #{selector[:pacticipant_name]}") unless version
             # validation in resource should ensure we always have a version
             {
@@ -161,25 +157,38 @@ module PactBroker
               pacticipant_name: selector[:pacticipant_name],
               pacticipant_version_number: version.number
             }
+          elsif selector[:tag]
+            # validation in resource should ensure we always have at least one version
+            versions = version_repository.find_by_pacticipant_name_and_tag(selector[:pacticipant_name], selector[:tag])
+            versions.collect do | version |
+              {
+                pacticipant_name: selector[:pacticipant_name],
+                pacticipant_version_number: version.number
+              }
+            end
           else
             selector.dup
           end
-        end.collect do | selector |
-          if selector[:pacticipant_name]
-            pacticipant = PactBroker::Domain::Pacticipant.find(name: selector[:pacticipant_name])
-            selector[:pacticipant_id] = pacticipant ? pacticipant.id : nil
-          end
+        end.flatten.compact.collect do | selector |
+          add_ids(selector)
+        end
+      end
 
-          if selector[:pacticipant_name] && selector[:pacticipant_version_number]
-            version = version_repository.find_by_pacticipant_name_and_number(selector[:pacticipant_name], selector[:pacticipant_version_number])
-            selector[:pacticipant_version_id] = version ? version.id : nil
-          end
+      def add_ids(selector)
+        if selector[:pacticipant_name]
+          pacticipant = PactBroker::Domain::Pacticipant.find(name: selector[:pacticipant_name])
+          selector[:pacticipant_id] = pacticipant ? pacticipant.id : nil
+        end
 
-          if selector[:pacticipant_version_number].nil?
-            selector[:pacticipant_version_id] = nil
-          end
-          selector
+        if selector[:pacticipant_name] && selector[:pacticipant_version_number]
+          version = version_repository.find_by_pacticipant_name_and_number(selector[:pacticipant_name], selector[:pacticipant_version_number])
+          selector[:pacticipant_version_id] = version ? version.id : nil
         end
+
+        if selector[:pacticipant_version_number].nil?
+          selector[:pacticipant_version_id] = nil
+        end
+        selector
       end
 
       # eg. when checking to see if Foo version 2 can be deployed to prod,
@@ -190,13 +199,15 @@ module PactBroker
         inferred_names = all_pacticipant_names - specified_names
 
         inferred_selectors = inferred_names.collect do | pacticipant_name |
-          {
+          selector = {
             pacticipant_name: pacticipant_name,
-            latest: options[:latest]
-          }.tap { |it| it[:tag] = options[:tag] if options[:tag] }
+          }
+          selector[:tag] = options[:tag] if options[:tag]
+          selector[:latest] = options[:latest] if options[:latest]
+          selector
         end
 
-        selectors + look_up_versions_for_latest_and_tag(inferred_selectors, options)
+        selectors + look_up_version_numbers(inferred_selectors, options)
       end
 
       def all_pacticipant_names_in_specified_matrix(selectors, options)