pact_broker 2.35.0 → 2.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a87ec2e8bd7d3047768e040433544194b306fa
-  data.tar.gz: 7dda1535ad3341c18acd174f2459cae29be8e287
+  metadata.gz: 248fdb1abb2fb57331796c6e974be143889a589a
+  data.tar.gz: 3c51b8d3b502ffcdc222a0dc8a6b752fbd0876ae
 SHA512:
-  metadata.gz: cf0fa7165f17a13b045d068d78cbe0aebe5cf860055d271a00dc369d56eff478c3946c8a22451f323eb762bee75069c6359c208c6178dfd82c0561a5c03444bd
-  data.tar.gz: 27f0ffd8fceaa7f907fe3e256c4e0f63947ffc4343cb01982e4d1eb5fe2d63b4c0097d602653026cc8deec4349b49e6c7bea9776fa45fc7e67bf80388df94f0b
+  metadata.gz: 99770d645322dbd544ab387a283245c50f24e358e15a5afe2a15b9cb453ef7235815f3cf1d3533d443bc785551fca1e94179862e2b47d3270face9879e9d2a61
+  data.tar.gz: 0ddb143e53ffeaea209268239e64095222b6fcf19047fc0d464ad33dfaaaee02385a37e6a41cb5a97c4ad147f9f729a55d5ed0df5484fd88f7a47391eaef0e7b

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="v2.36.0"></a>
+### v2.36.0 (2019-08-30)
+
+
+#### Features
+
+* add resource to get latest verification for a pact	 ([f02a1ca0](/../../commit/f02a1ca0))
+* add /metrics endpoint	 ([9bcbc1bd](/../../commit/9bcbc1bd))
+* add tags to verification resource	 ([830632a2](/../../commit/830632a2))
+* add content type to return pact with extra metadata (eg tags)	 ([76668639](/../../commit/76668639))
+* remove use of 'stale' for dashboard resource	 ([e173f5cf](/../../commit/e173f5cf))
+
+
+#### Bug Fixes
+
+* pact broker client issue 53 (#299)	 ([aa27cef3](/../../commit/aa27cef3))
+* version column resize when clipboard icon appears (#292)	 ([5aa668e9](/../../commit/5aa668e9))
+
+
 <a name="v2.35.0"></a>
 ### v2.35.0 (2019-08-08)
 

data/db/migrations/000029_create_latest_tagged_pact_publications.rb

@@ -1,5 +1,7 @@
 Sequel.migration do
   up do
+    # The pact for the latest consumer version (ordered by consumer version order) *that has a pact* for each tag
+    # eg. For each tag, find all the consumer versions that have pacts, order them by consumer version order, then get the pact for the latest consumer version.
     create_or_replace_view(:latest_tagged_pact_consumer_version_orders,
       "select provider_id, consumer_id, t.name as tag_name, max(consumer_version_order) as latest_consumer_version_order
       from latest_pact_publications_by_consumer_versions ap

data/lib/pact_broker/api.rb

@@ -26,6 +26,8 @@ module PactBroker
         # Verifications
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results'], Api::Resources::Verifications, {resource_name: "verification_results"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'metadata', :metadata, 'verification-results'], Api::Resources::Verifications, {resource_name: "verification_results"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'verification-results', 'latest'], Api::Resources::LatestVerificationForPact, {resource_name: "latest_verification_results_for_pact_publication"}
+        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 ['verification-results', 'consumer', :consumer_name, 'version', :consumer_version_number,'latest'], Api::Resources::LatestVerificationsForConsumerVersion, {resource_name: "verification_results_for_consumer_version"}
@@ -91,6 +93,7 @@ module PactBroker
 
         add ['integrations'], Api::Resources::Integrations, {resource_name: "integrations"}
         add ['integrations', 'provider', :provider_name, 'consumer', :consumer_name], Api::Resources::Integration, {resource_name: "integration"}
+        add ['metrics'], Api::Resources::Metrics, {resource_name: 'metrics'}
         add [], Api::Resources::Index, {resource_name: "index"}
       end
     end

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

@@ -0,0 +1,42 @@
+require 'pact_broker/api/decorators/pact_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      # Make a different content type for adding extra information for the UI, as
+      # some pact parsing tools blow up when there are unexpected keys :|
+
+      class ExtendedPactDecorator < PactDecorator
+        class TagDecorator < BaseDecorator
+          property :name
+          property :latest, getter: ->(_) { true }
+
+          link "pb:latest-pact" do | opts |
+            {
+              name: "The latest pact with the tag #{represented.name}",
+              href: latest_tagged_pact_url(represented.pact, represented.name, opts[:base_url])
+            }
+          end
+        end
+
+        property :content_hash, as: :contract
+        collection :head_tags, exec_context: :decorator, as: :tags, embedded: true, extend: TagDecorator
+
+        # TODO rather than remove the contract keys that we added in the super class,
+        # it would be better to inherit from a shared super class
+        def to_hash(options = {})
+          keys_to_remove = represented.content_hash.keys
+          super.each_with_object({}) do | (key, value), new_hash |
+            new_hash[key] = value unless keys_to_remove.include?(key)
+          end
+        end
+
+        def head_tags
+          represented.head_tag_names.collect do | tag_name |
+            OpenStruct.new(name: tag_name, pact: represented)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'pact_broker/api/decorators/verification_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class ExtendedVerificationDecorator < VerificationDecorator
+        class TagDecorator < BaseDecorator
+          property :name
+          property :latest?, as: :latest
+        end
+
+        collection :provider_version_tags, as: :tags, embedded: true, extend: TagDecorator
+      end
+    end
+  end
+end

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

@@ -3,11 +3,8 @@ require 'pact_broker/json'
 require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PactDecorator < BaseDecorator
 
         include Timestamps
@@ -149,6 +146,12 @@ module PactBroker
           }
         end
 
+        link :'pb:latest-verification-results' do | options |
+          {
+            href: latest_verification_for_pact_url(represented, options.fetch(:base_url))
+          }
+        end
+
         link :'pb:triggered-webhooks' do | options |
           {
             title: "Webhooks triggered by the publication of this pact",

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

@@ -4,6 +4,10 @@ module PactBroker
   module Api
     module Decorators
       class VerificationDecorator < BaseDecorator
+        class TagDecorator < BaseDecorator
+          property :name
+          property :latest?, as: :latest
+        end
 
         property :provider_name, as: :providerName, writeable: false
         property :provider_version_number, as: :providerApplicationVersion, writeable: false

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -90,6 +90,10 @@ module PactBroker
         "#{pactigration_base_url(base_url, pact)}/latest-untagged"
       end
 
+      def latest_tagged_pact_url pact, tag_name, base_url
+        "#{latest_pact_url(base_url, pact)}/#{url_encode(tag_name)}"
+      end
+
       def latest_pacts_url base_url
         "#{base_url}/pacts/latest"
       end
@@ -153,6 +157,14 @@ module PactBroker
         "#{base_url}/verification-results/consumer/#{url_encode(version.pacticipant.name)}/version/#{version.number}/latest"
       end
 
+      def latest_verification_for_pact_url pact, base_url
+        verification_url_from_params(
+          provider_name: pact.provider_name,
+          consumer_name: pact.consumer_name,
+          pact_version_sha: pact.pact_version_sha,
+          verification_number: 'latest')
+      end
+
       def verification_triggered_webhooks_url verification, base_url = ''
         "#{verification_url(verification, base_url)}/triggered-webhooks"
       end

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

@@ -5,9 +5,7 @@ require 'pact_broker/api/decorators/dashboard_text_decorator'
 module PactBroker
   module Api
     module Resources
-
       class Dashboard < BaseResource
-
         def content_types_provided
           [
             ["application/hal+json", :to_json],
@@ -30,7 +28,7 @@ module PactBroker
         private
 
         def index_items
-          index_service.find_index_items(identifier_from_path.merge(tags: true))
+          index_service.find_index_items(identifier_from_path.merge(tags: true, dashboard: true))
         end
       end
     end

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

@@ -106,6 +106,11 @@ module PactBroker
               title: "Get, create or delete a tag for a pacticipant version",
               templated: true
             },
+            'pb:metrics' =>
+            {
+              href: base_url + '/metrics',
+              title: "Get Pact Broker metrics",
+            },
             'beta:pending-provider-pacts' =>
             {
               href: base_url + '/pacts/provider/{provider}/pending',

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

@@ -0,0 +1,19 @@
+require 'pact_broker/api/resources/verification'
+
+module PactBroker
+  module Api
+    module Resources
+      class LatestVerificationForPact < Verification
+        private
+
+        def pact
+          @pact ||= pact_service.find_pact(pact_params)
+        end
+
+        def verification
+          @verification ||= pact && verification_service.find_latest_for_pact(pact)
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,6 @@ require 'pact_broker/api/decorators/verification_summary_decorator'
 module PactBroker
   module Api
     module Resources
-
       class LatestVerificationsForConsumerVersion < BaseResource
 
         def allowed_methods

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

@@ -0,0 +1,21 @@
+require 'pact_broker/api/resources/base_resource'
+
+module PactBroker
+  module Api
+    module Resources
+      class Metrics < BaseResource
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def to_json
+          metrics_service.metrics.to_json
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@ require 'cgi'
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/api/resources/pacticipant_resource_methods'
 require 'pact_broker/api/decorators/pact_decorator'
+require 'pact_broker/api/decorators/extended_pact_decorator'
 require 'pact_broker/json'
 require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/contracts/put_pact_params_contract'
@@ -26,7 +27,9 @@ module PactBroker
         def content_types_provided
           [["application/hal+json", :to_json],
            ["application/json", :to_json],
-           ["text/html", :to_html]]
+           ["text/html", :to_html],
+           ["application/vnd.pactbrokerextended.v1+json", :to_extended_json]
+          ]
         end
 
         def content_types_accepted
@@ -78,6 +81,10 @@ module PactBroker
           PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(user_options: decorator_context(metadata: identifier_from_path[:metadata]))
         end
 
+        def to_extended_json
+          PactBroker::Api::Decorators::ExtendedPactDecorator.new(pact).to_json(user_options: decorator_context(metadata: identifier_from_path[:metadata]))
+        end
+
         def to_html
           PactBroker.configuration.html_pact_renderer.call(
             pact, {

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

@@ -5,7 +5,6 @@ require 'pact_broker/api/decorators/pact_versions_decorator'
 module PactBroker
   module Api
     module Resources
-
       class PactVersions < BaseResource
 
         def content_types_provided

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

@@ -3,13 +3,18 @@ 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/decorators/extended_verification_decorator'
 
 module PactBroker
   module Api
     module Resources
       class Verification < BaseResource
         def content_types_provided
-          [["application/hal+json", :to_json], ["application/json", :to_json]]
+          [
+            ["application/hal+json", :to_json],
+            ["application/json", :to_json],
+            ["application/vnd.pactbrokerextended.v1+json", :to_extended_json]
+          ]
         end
 
         # Remember to update latest_verification_id_for_pact_version_and_provider_version
@@ -26,6 +31,10 @@ module PactBroker
           decorator_for(verification).to_json(user_options: {base_url: base_url})
         end
 
+        def to_extended_json
+          extended_decorator_for(verification).to_json(user_options: {base_url: base_url})
+        end
+
         private
 
         def verification
@@ -35,6 +44,10 @@ module PactBroker
         def decorator_for model
           PactBroker::Api::Decorators::VerificationDecorator.new(model)
         end
+
+        def extended_decorator_for model
+          PactBroker::Api::Decorators::ExtendedVerificationDecorator.new(model)
+        end
       end
     end
   end

data/lib/pact_broker/domain/pact.rb

@@ -6,7 +6,7 @@ module PactBroker
   module Domain
     class Pact
 
-      attr_accessor :id, :provider, :consumer_version, :consumer, :created_at, :json_content, :consumer_version_number, :revision_number, :pact_version_sha, :latest_verification
+      attr_accessor :id, :provider, :consumer_version, :consumer, :created_at, :json_content, :consumer_version_number, :revision_number, :pact_version_sha, :latest_verification, :head_tag_names
 
       def initialize attributes
         attributes.each_pair do | key, value |
@@ -54,6 +54,5 @@ module PactBroker
         id
       end
     end
-
   end
 end

data/lib/pact_broker/domain/verification.rb

@@ -1,9 +1,10 @@
-require 'pact_broker/db'
-require 'pact_broker/repositories/helpers'
 require 'json'
+require 'sequel'
+require 'pact_broker/repositories/helpers'
+require 'pact_broker/tags/tag_with_latest_flag'
 
-module PactBroker
 
+module PactBroker
   module Domain
     class Verification < Sequel::Model
 
@@ -12,6 +13,7 @@ module PactBroker
       associate(:many_to_one, :provider_version, class: "PactBroker::Domain::Version", key: :provider_version_id, primary_key: :id)
       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)
+      associate(:one_to_many, :provider_version_tags, :class => "PactBroker::Tags::TagWithLatestFlag", primary_key: :provider_version_id, key: :version_id)
       plugin :serialization, :json, :test_results
 
       def before_create

data/lib/pact_broker/index/service.rb

@@ -35,14 +35,29 @@ module PactBroker
         end
         rows = rows.all.group_by(&:pact_publication_id).values.collect{ | rows| Matrix::AggregatedRow.new(rows) }
 
+
+
         rows.sort.collect do | row |
+          # The concept of "stale" (the pact used to be verified but then it changed and we haven't got
+          # a new verification result yet) only really make sense if we're trying to summarise
+          # the latest state of an integration. Once we start showing multiple pacts for each
+          # integration (ie. the latest for each tag) then each pact version is either verified,
+          # or it's not verified.
+          # For backwards compatiblity with the existing UI, don't change the 'stale' concept for the OSS
+          # UI - just ensure we don't use it for the new dashboard endpoint with the consumer/provider specified.
+          latest_verification = if options[:dashboard]
+            row.latest_verification_for_pact_version
+          else
+            row.latest_verification_for_pseudo_branch
+          end
+
           # TODO simplify. Do we really need 3 layers of abstraction?
           PactBroker::Domain::IndexItem.create(
             row.consumer,
             row.provider,
             row.pact,
             row.overall_latest?,
-            row.latest_verification,
+            latest_verification,
             row.webhooks,
             row.latest_triggered_webhooks,
             options[:tags] ? row.consumer_head_tag_names : [],

data/lib/pact_broker/matrix/aggregated_row.rb

@@ -24,7 +24,12 @@ module PactBroker
 
       # If this comes back nil, it won't be "cached", but it's a reasonably
       # quick query, so it's probably ok.
-      def latest_verification
+      # The collection of pacts that belong to the same tag can be considered
+      # a pseudo branch. Find the latest verification for each pseudo branch
+      # and return the most recent. If this pact is the most recent overall,
+      # and there were no verifications found for any of the tags, then
+      # return the most recent verification
+      def latest_verification_for_pseudo_branch
         @latest_verification ||= begin
           verification = matrix_rows.collect do | row|
               row.verification || latest_verification_for_consumer_version_tag(row)
@@ -38,6 +43,14 @@ module PactBroker
         end
       end
 
+      def latest_verification_for_pact_version
+        @latest_verificaton_for_pact_version ||= begin
+          matrix_rows.collect do | row|
+            row.verification
+          end.compact.sort{ |v1, v2| v1.id <=> v2.id }.last
+        end
+      end
+
       # The list of tag names for which this pact publication is the most recent with that tag
       # There could, however, be a later consumer version that does't have a pact (perhaps because it was deleted)
       # that has the same tag.