pact_broker 2.47.1 → 2.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e05cc047cbfe572f654468283eabb11b7adc91da8b802b6955ddb10b3114a3ec
-  data.tar.gz: 2a70640b544c8ac35f82bfc1612c9285506691ebe4e71c7e8629f3bd64ca3882
+  metadata.gz: bdda99358c4d4d8ca43f6e53e0e314fd24f475f1ff85fd0511743d8982224bca
+  data.tar.gz: 4f61ab3a051164ac3db85d7eef44fa088053873b2381f4c4104f4822c47bd651
 SHA512:
-  metadata.gz: ad822d40451b9821921ea72fd8363625197524c1aed51ecefcfeb7d69b0d3b5382a9b45147fa2bf11baef50e77fc798e4eb55b58d4cbb9490d583a7d85399e4f
-  data.tar.gz: 946de38bcbf4e0d96fa54cbd8466bdbb49cc44a74a4e89d11b4ed8b1c4db2778594450b6599e11adfbcdbd6dd5b84893c19389a5b92f163dfefa6d716f949313
+  metadata.gz: e3d9f86596a6d4aa776c13f28e84af1976485dc9eff3bef98accf6e372d379cb591270354a252c88a6b2c08ac928391e2ddcf8ee19d3db6f9832a667b4a81184
+  data.tar.gz: d4b2273ab789165a3f0ca7ce8f5fdb2220814d222ea172fa02fe77d19ce6e9e251277a6c621483a41b6b9911ab207b6d59861a39d2168ecdf5b0db64d1477d9f

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="v2.48.0"></a>
+### v2.48.0 (2020-02-07)
+
+
+#### Features
+
+* **pacts for verification**
+  * include a short description of the pact's selectors in the response	 ([41c6d91f](/../../commit/41c6d91f))
+  * update inclusion reason to support fallback tag explanation	 ([43081170](/../../commit/43081170))
+  * allow a fallback tag to be specified	 ([113180c1](/../../commit/113180c1))
+  * update the inclusion notice text to handle 'all pacts for tag'	 ([59ec8c8a](/../../commit/59ec8c8a))
+
+* support DELETE for verification results	 ([70392e53](/../../commit/70392e53))
+
+
+#### Bug Fixes
+
+* a url typo (#328)	 ([482264fa](/../../commit/482264fa))
+* correct URL of tag relation in pacticipant version resource	 ([ec24e999](/../../commit/ec24e999))
+
+
 <a name="v2.47.1"></a>
 ### v2.47.1 (2020-02-01)
 

data/Dockerfile

@@ -12,7 +12,6 @@ RUN apk update \
       "sqlite>=3.28" \
       "tzdata>=2019" \
       "mariadb-dev>=10.3" \
-      "git" \
     && rm -rf /var/cache/apk/*
 
 WORKDIR /app

data/README.md

@@ -12,7 +12,7 @@ The Pact Broker is an application for sharing for consumer driven contracts and
 <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.
+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?**
 

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

@@ -17,8 +17,19 @@ module PactBroker
           optional(:providerVersionTags).maybe(:array?)
           optional(:consumerVersionSelectors).each do
             schema do
+              # configure do
+              #   def self.messages
+              #     super.merge(en: { errors: { fallbackTagMustBeForLatest: 'can only be set if latest=true' }})
+              #   end
+              # end
+
               required(:tag).filled(:str?)
               optional(:latest).filled(included_in?: [true, false])
+              optional(:fallbackTag).filled(:str?)
+
+              # rule(fallbackTagMustBeForLatest: [:fallbackTag, :latest]) do | fallback_tag, latest |
+              #   fallback_tag.filled?.then(latest.eql?(true))
+              # end
             end
           end
           optional(:includePendingStatus).filled(included_in?: [true, false])

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

@@ -18,6 +18,7 @@ module PactBroker
             schema do
               required(:tag).filled(:str?)
               optional(:latest).filled(included_in?: ["true", "false"])
+              optional(:fallback_tag).filled(:str?)
             end
           end
           optional(:include_pending_status).filled(included_in?: ["true", "false"])

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

@@ -1,26 +1,15 @@
 require_relative 'base_decorator'
 require 'pact_broker/api/pact_broker_urls'
-require 'delegate'
-require 'pact_broker/pacts/verifiable_pact_messages'
+require 'pact_broker/pacts/build_verifiable_pact_notices'
 
 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 :shortDescription, getter: -> (context) { PactBroker::Pacts::VerifiablePactMessages.new(context[:represented], nil).pact_version_short_description }
 
-        property :verification_properties, as: :verificationProperties do
+        nested :verificationProperties do
           include PactBroker::Api::PactBrokerUrls
 
           property :pending,
@@ -31,32 +20,8 @@ module PactBroker
           property :noteToDevelopers, getter: -> (_) { "Please print out the text from the 'notices' rather than using the inclusionReason and the pendingReason fields. These will be removed when this API moves out of beta."}
 
           def notices(user_options)
-            # TODO move this out of the decorator
             pact_url = pact_version_url(represented, user_options[:base_url])
-            messages = PactBroker::Pacts::VerifiablePactMessages.new(represented, pact_url)
-
-            the_notices = [{
-              when: 'before_verification',
-              text: messages.inclusion_reason
-            }]
-
-            if user_options[:include_pending_status]
-              append_notice(the_notices, 'before_verification', messages.pending_reason)
-              append_notice(the_notices, 'after_verification:success_true_published_false', messages.verification_success_true_published_false)
-              append_notice(the_notices, 'after_verification:success_false_published_false', messages.verification_success_false_published_false)
-              append_notice(the_notices, 'after_verification:success_true_published_true', messages.verification_success_true_published_true)
-              append_notice(the_notices, 'after_verification:success_false_published_true', messages.verification_success_false_published_true)
-            end
-            the_notices
-          end
-
-          def append_notice the_notices, the_when, text
-            if text
-              the_notices << {
-                when: the_when,
-                text: text
-              }
-            end
+            PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, include_pending_status: user_options[:include_pending_status])
           end
         end
 

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

@@ -2,6 +2,8 @@ require_relative 'base_decorator'
 require_relative 'verifiable_pact_decorator'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/hash_refinements'
+require 'pact_broker/pacts/selector'
+require 'pact_broker/pacts/selectors'
 
 module PactBroker
   module Api
@@ -11,12 +13,13 @@ module PactBroker
 
         collection :provider_version_tags, default: []
 
-        collection :consumer_version_selectors, default: [], class: OpenStruct do
+        collection :consumer_version_selectors, default: PactBroker::Pacts::Selectors.new, class: PactBroker::Pacts::Selector do
           property :tag
           property :latest,
             setter: ->(fragment:, represented:, **) {
               represented.latest = (fragment == 'true' || fragment == true)
             }
+          property :fallback_tag
         end
 
         property :include_pending_status, default: false,
@@ -31,7 +34,11 @@ module PactBroker
 
         def from_hash(hash)
           # This handles both the snakecase keys from the GET query and the camelcase JSON POST body
-          super(hash&.snakecase_keys)
+          result = super(hash&.snakecase_keys)
+          if result.consumer_version_selectors && !result.consumer_version_selectors.is_a?(PactBroker::Pacts::Selectors)
+            result.consumer_version_selectors = PactBroker::Pacts::Selectors.new(result.consumer_version_selectors)
+          end
+          result
         end
       end
     end

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

@@ -28,7 +28,7 @@ module PactBroker
 
         link :'pb:tag' do | options |
           {
-            href: pacticipant_url(options.fetch(:base_url), represented.pacticipant) + '/tags/{tag}',
+            href: version_url(options.fetch(:base_url), represented) + '/tags/{tag}',
             title: "Get, create or delete a tag for this pacticipant version",
             templated: true
           }

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

@@ -20,7 +20,7 @@ module PactBroker
         # Remember to update latest_verification_id_for_pact_version_and_provider_version
         # if/when DELETE is implemented
         def allowed_methods
-          ["GET", "OPTIONS"]
+          ["GET", "OPTIONS", "DELETE"]
         end
 
         def resource_exists?
@@ -40,6 +40,11 @@ module PactBroker
           extended_decorator_for(verification).to_json(user_options: { base_url: base_url })
         end
 
+        def delete_resource
+          verification_service.delete(verification)
+          true
+        end
+
         private
 
         def verification

data/lib/pact_broker/pacts/build_verifiable_pact_notices.rb

@@ -0,0 +1,35 @@
+require 'pact_broker/pacts/verifiable_pact_messages'
+
+module PactBroker
+  module Pacts
+    class BuildVerifiablePactNotices
+
+      def self.call(verifiable_pact, pact_url, options)
+        messages = VerifiablePactMessages.new(verifiable_pact, pact_url)
+
+        notices = [{
+          when: 'before_verification',
+          text: messages.inclusion_reason
+        }]
+
+        if options[:include_pending_status]
+          append_notice(notices, 'before_verification', messages.pending_reason)
+          append_notice(notices, 'after_verification:success_true_published_false', messages.verification_success_true_published_false)
+          append_notice(notices, 'after_verification:success_false_published_false', messages.verification_success_false_published_false)
+          append_notice(notices, 'after_verification:success_true_published_true', messages.verification_success_true_published_true)
+          append_notice(notices, 'after_verification:success_false_published_true', messages.verification_success_false_published_true)
+        end
+        notices
+      end
+
+      def self.append_notice notices, the_when, text
+        if text
+          notices << {
+            when: the_when,
+            text: text
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/repository.rb

@@ -16,6 +16,7 @@ require 'pact_broker/pacts/verifiable_pact'
 require 'pact_broker/repositories/helpers'
 require 'pact_broker/pacts/selected_pact'
 require 'pact_broker/pacts/selector'
+require 'pact_broker/pacts/selectors'
 
 module PactBroker
   module Pacts
@@ -150,7 +151,7 @@ module PactBroker
           .collect do | pact_publications |
             selector_tag_names = pact_publications.collect{ | p| p.values.fetch(:consumer_version_tag_name) }
             latest_pact_publication = pact_publications.sort_by{ |p| p.values.fetch(:consumer_version_order) }.last
-            selectors = selector_tag_names.collect{ | tag_name | Selector.one_of_tag(tag_name) }
+            selectors = Selectors.create_for_all_of_each_tag(selector_tag_names)
             SelectedPact.new(latest_pact_publication.to_domain, selectors)
           end
       end
@@ -206,7 +207,8 @@ module PactBroker
           pre_existing_pending_tags = pending_tag_names & pre_existing_tag_names
 
           if pre_existing_pending_tags.any?
-            VerifiablePact.new(pact.to_domain, true, pre_existing_pending_tags, [], pact.head_tag_names, nil, true)
+            selectors = Selectors.create_for_latest_of_each_tag(pact.head_tag_names)
+            VerifiablePact.new(pact.to_domain, selectors, true, pre_existing_pending_tags, [], true)
           end
         end.compact
       end
@@ -349,16 +351,36 @@ module PactBroker
         selected_pacts = find_pacts_for_which_the_latest_version_is_required(provider_name, consumer_version_selectors) +
         find_pacts_for_which_the_latest_version_for_the_tag_is_required(provider_name, consumer_version_selectors) +
         find_pacts_for_which_all_versions_for_the_tag_are_required(provider_name, consumer_version_selectors)
+
+        selected_pacts = selected_pacts + find_pacts_for_fallback_tags(selected_pacts, provider_name, consumer_version_selectors)
+
         selected_pacts
           .group_by(&:pact_version_sha)
           .values
           .collect do | selected_pacts_for_pact_version_id |
             SelectedPact.merge(selected_pacts_for_pact_version_id)
           end
+
       end
 
       private
 
+      def find_pacts_for_fallback_tags(selected_pacts, provider_name, consumer_version_selectors)
+        # TODO at the moment, the validation doesn't stop fallback being used with 'all' selectors
+        selectors_with_fallback_tags = consumer_version_selectors.select(&:fallback_tag?)
+        selectors_missing_a_pact = selectors_with_fallback_tags.reject do | selector |
+          selected_pacts.any? do | selected_pact |
+            selected_pact.latest_for_tag?(selector.tag)
+          end
+        end
+
+        if selectors_missing_a_pact.any?
+          find_pacts_for_which_the_latest_version_for_the_fallback_tag_is_required(provider_name, selectors_missing_a_pact)
+        else
+          []
+        end
+      end
+
       def find_pacts_for_which_the_latest_version_is_required(provider_name, consumer_version_selectors)
         if consumer_version_selectors.empty?
           LatestPactPublications
@@ -366,7 +388,7 @@ module PactBroker
             .order_ignore_case(:consumer_name)
             .collect do | latest_pact_publication |
               pact_publication = PactPublication.find(id: latest_pact_publication.id)
-              SelectedPact.new(pact_publication.to_domain, [Selector.overall_latest])
+              SelectedPact.new(pact_publication.to_domain, Selectors.create_for_overall_latest)
             end
         else
           []
@@ -375,38 +397,70 @@ module PactBroker
 
       def find_pacts_for_which_the_latest_version_for_the_tag_is_required(provider_name, consumer_version_selectors)
         # The tags for which only the latest version is specified
-        latest_tags = consumer_version_selectors.select(&:latest).collect(&:tag).compact.uniq
+        tag_names = consumer_version_selectors.tag_names_of_selectors_for_latest_pacts
 
         # TODO make this an efficient query!
         # These are not yet de-duped. Should make the behaviour consistent between this and find_pacts_for_which_all_versions_for_the_tag_are_required ?
-        if latest_tags.any?
+        if tag_names.any?
           LatestTaggedPactPublications
             .provider(provider_name)
-            .order_ignore_case(:consumer_name)
-            .where(tag_name: latest_tags)
+            .where(tag_name: tag_names)
             .all
             .group_by(&:pact_version_id)
             .values
             .collect do | pact_publications |
-              selector_tag_names = pact_publications.collect(&:tag_name)
-              last_pact_publication = pact_publications.sort_by(&:consumer_version_order).last
-              pact_publication = PactPublication.find(id: last_pact_publication.id)
-              SelectedPact.new(
-                pact_publication.to_domain,
-                selector_tag_names.collect{ | tag_name| Selector.latest_for_tag(tag_name) }
-              )
+              create_selected_pact(pact_publications)
             end
         else
           []
         end
       end
 
+      def create_selected_pact(pact_publications)
+        selector_tag_names = pact_publications.collect(&:tag_name)
+        selectors = Selectors.create_for_latest_of_each_tag(selector_tag_names)
+        last_pact_publication = pact_publications.sort_by(&:consumer_version_order).last
+        pact_publication = PactPublication.find(id: last_pact_publication.id)
+        SelectedPact.new(
+          pact_publication.to_domain,
+          selectors
+        )
+      end
+
+      def create_fallback_selected_pact(pact_publications, consumer_version_selectors)
+        selector_tag_names = pact_publications.collect(&:tag_name)
+        selectors = Selectors.create_for_latest_fallback_of_each_tag(selector_tag_names)
+        last_pact_publication = pact_publications.sort_by(&:consumer_version_order).last
+        pact_publication = PactPublication.find(id: last_pact_publication.id)
+        SelectedPact.new(
+          pact_publication.to_domain,
+          selectors
+        )
+      end
+
+      def find_pacts_for_which_the_latest_version_for_the_fallback_tag_is_required(provider_name, selectors)
+        selectors.collect do | selector |
+          LatestTaggedPactPublications
+            .provider(provider_name)
+            .where(tag_name: selector.fallback_tag)
+            .all
+            .collect do | latest_tagged_pact_publication |
+              pact_publication = PactPublication.find(id: latest_tagged_pact_publication.id)
+              SelectedPact.new(
+                pact_publication.to_domain,
+                Selectors.new(selector)
+              )
+            end
+        end.flatten
+      end
+
+
       def find_pacts_for_which_all_versions_for_the_tag_are_required(provider_name, consumer_version_selectors)
         # The tags for which all versions are specified
-        all_tags = consumer_version_selectors.reject(&:latest).collect(&:tag)
+        tag_names = consumer_version_selectors.tag_names_of_selectors_for_all_pacts
 
-        if all_tags.any?
-          find_all_pact_versions_for_provider_with_consumer_version_tags(provider_name, all_tags)
+        if tag_names.any?
+          find_all_pact_versions_for_provider_with_consumer_version_tags(provider_name, tag_names)
         else
           []
         end

data/lib/pact_broker/pacts/selected_pact.rb

@@ -11,31 +11,22 @@ module PactBroker
         @selectors = selectors
       end
 
-      # might actually be, but this code doesn't know it.
-      def overall_latest?
-        selectors.any?(&:overall_latest?)
-      end
-
-      def latest_for_tag?
-        selectors.any?(&:latest_for_tag?)
-      end
-
       def self.merge(selected_pacts)
         latest_selected_pact = selected_pacts.sort_by(&:consumer_version_order).last
-        selectors = selected_pacts.collect(&:selectors).flatten.uniq
+        selectors = selected_pacts.collect(&:selectors).reduce(&:+)
         SelectedPact.new(latest_selected_pact.pact, selectors)
       end
 
-      def merge(other)
-        if pact_version_sha != other.pact_version_sha
-          raise "These two pacts do not have the same pact_version_sha. They cannot be merged. #{pact_version_sha} and #{other.pact_version_sha}"
-        else
-          SelectedPact.new()
-        end
+      def tag_names_of_selectors_for_latest_pacts
+        selectors.tag_names_of_selectors_for_latest_pacts
+      end
+
+      def overall_latest?
+        selectors.overall_latest?
       end
 
-      def tag_names_for_selectors_for_latest_pacts
-        selectors.select(&:latest_for_tag?).collect(&:tag)
+      def latest_for_tag? potential_tag = nil
+        selectors.latest_for_tag?(potential_tag)
       end
 
       def consumer_version_order