pact_broker 2.38.1 → 2.39.0

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

@@ -1,4 +1,5 @@
 require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/feature_toggle'
 require 'json'
 
 module PactBroker
@@ -18,7 +19,7 @@ module PactBroker
         end
 
         def links
-          {
+          links_hash = {
             'self' =>
             {
               href: base_url,
@@ -109,10 +110,10 @@ module PactBroker
               href: base_url + '/metrics',
               title: "Get Pact Broker metrics",
             },
-            'beta:pending-provider-pacts' =>
+            'pb:can-i-deploy-pacticipant-version-to-tag' =>
             {
-              href: base_url + '/pacts/provider/{provider}/pending',
-              title: 'Pending pact versions for the specified provider',
+              href: base_url + '/can-i-deploy?pacticipant={pacticipant}&version={version}&to={tag}',
+              title: "Determine if an application can be safely deployed to an environment identified by the given tag",
               templated: true
             },
             'curies' =>
@@ -126,6 +127,16 @@ module PactBroker
               templated: true
             }]
           }
+
+          if PactBroker.feature_enabled?(:pacts_for_verification)
+            links_hash['beta:provider-pacts-for-verification'] = {
+                href: base_url + '/pacts/provider/{provider}/for-verification',
+                title: 'Pact versions to be verified for the specified provider',
+                templated: true
+              }
+          end
+
+          links_hash
         end
       end
     end

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

@@ -1,16 +1,18 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/configuration'
+require 'pact_broker/api/decorators/extended_pact_decorator'
 
 module PactBroker
   module Api
     module Resources
-
       class LatestPact < BaseResource
-
         def content_types_provided
-          [ ["application/hal+json", :to_json],
+          [
+            ["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 allowed_methods
@@ -26,6 +28,10 @@ module PactBroker
           PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(user_options: { base_url: base_url })
         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/latest_verification_for_latest_pact.rb

@@ -0,0 +1,19 @@
+require 'pact_broker/api/resources/verification'
+
+module PactBroker
+  module Api
+    module Resources
+      class LatestVerificationForLatestPact < Verification
+        private
+
+        def pact
+          @pact ||= pact_service.find_latest_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/pact.rb

@@ -25,10 +25,11 @@ module PactBroker
         include WebhookExecutionMethods
 
         def content_types_provided
-          [["application/hal+json", :to_json],
-           ["application/json", :to_json],
-           ["text/html", :to_html],
-           ["application/vnd.pactbrokerextended.v1+json", :to_extended_json]
+          [
+            ["application/hal+json", :to_json],
+            ["application/json", :to_json],
+            ["text/html", :to_html],
+            ["application/vnd.pactbrokerextended.v1+json", :to_extended_json]
           ]
         end
 

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

@@ -0,0 +1,54 @@
+require 'pact_broker/api/resources/provider_pacts'
+require 'pact_broker/api/decorators/verifiable_pacts_decorator'
+require 'pact_broker/api/contracts/verifiable_pacts_query_schema'
+require 'pact_broker/api/decorators/verifiable_pacts_query_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+      class ProviderPactsForVerification < ProviderPacts
+        def initialize
+          @query = Rack::Utils.parse_nested_query(request.uri.query)
+        end
+
+        def malformed_request?
+          if (errors = query_schema.call(query)).any?
+            set_json_validation_error_messages(errors)
+            true
+          else
+            false
+          end
+        end
+
+        private
+
+        attr_reader :query
+
+        def pacts
+          pact_service.find_for_verification(
+            provider_name,
+            parsed_query_params.provider_version_tags,
+            parsed_query_params.consumer_version_selectors
+          )
+        end
+
+        def resource_title
+          "Pacts to be verified by provider #{provider_name}"
+        end
+
+        def to_json
+          PactBroker::Api::Decorators::VerifiablePactsDecorator.new(pacts).to_json(to_json_options)
+        end
+
+
+        def query_schema
+          PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+        end
+
+        def parsed_query_params
+          @parsed_query_params ||= PactBroker::Api::Decorators::VerifiablePactsQueryDecorator.new(OpenStruct.new).from_hash(query)
+        end
+      end
+    end
+  end
+end

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

@@ -24,7 +24,12 @@ module PactBroker
         end
 
         def resource_exists?
-          !!verification
+          if identifier_from_path[:verification_number] == "all"
+            set_json_error_message("To see all the verifications for a pact, use the Matrix page")
+            false
+          else
+            !!verification
+          end
         end
 
         def to_json

data/lib/pact_broker/badges/service.rb

@@ -15,14 +15,14 @@ module PactBroker
       SPACE_DASH_UNDERSCORE = /[\s_\-]/
       CACHE = {}
 
-      def pact_verification_badge pact, label, initials, verification_status
-        return static_svg(pact, verification_status) unless pact
+      def pact_verification_badge pact, label, initials, pseudo_branch_verification_status
+        return static_svg(pact, pseudo_branch_verification_status) unless pact
 
         title = badge_title pact, label, initials
-        status = badge_status verification_status
-        color = badge_color verification_status
+        status = badge_status pseudo_branch_verification_status
+        color = badge_color pseudo_branch_verification_status
 
-        dynamic_svg(title, status, color) || static_svg(pact, verification_status)
+        dynamic_svg(title, status, color) || static_svg(pact, pseudo_branch_verification_status)
       end
 
       def clear_cache
@@ -60,8 +60,8 @@ module PactBroker
             .split('_')
       end
 
-      def badge_status verification_status
-        case verification_status
+      def badge_status pseudo_branch_verification_status
+        case pseudo_branch_verification_status
           when :success then "verified"
           when :failed then "failed"
           when :stale then "changed"
@@ -69,8 +69,8 @@ module PactBroker
         end
       end
 
-      def badge_color verification_status
-        case verification_status
+      def badge_color pseudo_branch_verification_status
+        case pseudo_branch_verification_status
           when :success then "brightgreen"
           when :failed then "red"
           when :stale then "orange"
@@ -122,8 +122,8 @@ module PactBroker
         response
       end
 
-      def static_svg pact, verification_status
-        file_name = case verification_status
+      def static_svg pact, pseudo_branch_verification_status
+        file_name = case pseudo_branch_verification_status
           when :success then "pact-verified-brightgreen.svg"
           when :failed then "pact-failed-red.svg"
           when :stale then "pact-changed-orange.svg"

data/lib/pact_broker/db/clean.rb

@@ -14,31 +14,91 @@ module PactBroker
       end
 
       def call
-        db[:verifications].where(id: db[:head_matrix].select(:verification_id)).invert.delete
-        pp_ids = db[:head_matrix].select(:pact_publication_id)
+        deleted_counts = {}
+        kept_counts = {}
+        date = options[:date]
+        pact_publication_ids_to_delete = if date
+          db[:pact_publications].select(:id).where(Sequel.lit('created_at < ?', date))
+        else
+          db[:pact_publications].select(:id).where(id: db[:head_matrix].select(:pact_publication_id)).invert
+        end
 
-        triggered_webhook_ids = db[:triggered_webhooks].where(pact_publication_id: pp_ids).invert.select(:id)
+        deleted_counts[:pact_publications] = pact_publication_ids_to_delete.count
+        kept_counts[:pact_publications] = db[:pact_publications].where(id: pact_publication_ids_to_delete).invert.count
+
+        # TODO head matrix is the head for the consumer tags, not the provider tags.
+        # Work out how to keep the head verifications for the provider tags.
+        verification_ids = get_verification_ids(pact_publication_ids_to_delete)
+        deleted_counts[:verification_results] = verification_ids.count
+        kept_counts[:verification_results] = db[:verifications].where(id:verification_ids ).invert.count
+
+        delete_webhook_data(db[:triggered_webhooks].where(verification_id: verification_ids).select(:id))
+        verification_ids.delete
+
+        delete_webhook_data(db[:triggered_webhooks].where(pact_publication_id: pact_publication_ids_to_delete).select(:id))
+        delete_deprecated_webhook_executions(pact_publication_ids_to_delete)
+        delete_pact_publications(pact_publication_ids_to_delete)
+
+        delete_orphan_pact_versions
+        overwritten_delete_counts = delete_overwritten_verifications
+        deleted_counts[:verification_results] = deleted_counts[:verification_results] + overwritten_delete_counts[:verification_results]
+        kept_counts[:verification_results] = kept_counts[:verification_results] - overwritten_delete_counts[:verification_results]
+
+
+        referenced_version_ids = db[:pact_publications].select(:consumer_version_id).collect{ | h| h[:consumer_version_id] } +
+          db[:verifications].select(:provider_version_id).collect{ | h| h[:provider_version_id] }
+
+        delete_orphan_tags(referenced_version_ids)
+        delete_orphan_versions(referenced_version_ids)
+
+        { kept: kept_counts, deleted: deleted_counts }
+      end
+
+      private
+
+      attr_reader :db, :options
+
+      def get_verification_ids(pact_publication_ids)
+        db[:verifications].select(:id).where(pact_version_id: db[:pact_publications].select(:pact_version_id).where(id: pact_publication_ids))
+      end
+
+      def delete_webhook_data(triggered_webhook_ids)
         db[:webhook_executions].where(triggered_webhook_id: triggered_webhook_ids).delete
         db[:triggered_webhooks].where(id: triggered_webhook_ids).delete
-        db[:webhook_executions].where(pact_publication_id: pp_ids).invert.delete
 
-        db[:pact_publications].where(id: pp_ids).invert.delete
+      end
+
+      def delete_deprecated_webhook_executions(pact_publication_ids)
+        db[:webhook_executions].where(pact_publication_id: pact_publication_ids).delete
+      end
+
+      def delete_pact_publications(pact_publication_ids)
+        db[:pact_publications].where(id: pact_publication_ids).delete
+        db[:pact_versions].where(id: db[:pact_publications].select(:pact_version_id)).invert.delete
+      end
 
+      def delete_orphan_pact_versions
+        # TODO use union
         referenced_pact_version_ids = db[:pact_publications].select(:pact_version_id).collect{ | h| h[:pact_version_id] } +
           db[:verifications].select(:pact_version_id).collect{ | h| h[:pact_version_id] }
         db[:pact_versions].where(id: referenced_pact_version_ids).invert.delete
+      end
 
-        referenced_version_ids = db[:pact_publications].select(:consumer_version_id).collect{ | h| h[:consumer_version_id] } +
-          db[:verifications].select(:provider_version_id).collect{ | h| h[:provider_version_id] }
-
+      def delete_orphan_tags(referenced_version_ids)
         db[:tags].where(version_id: referenced_version_ids).invert.delete
-        db[:versions].where(id: referenced_version_ids).invert.delete
       end
 
-      private
-
-      attr_reader :db
+      def delete_orphan_versions(referenced_version_ids)
+        db[:versions].where(id: referenced_version_ids).invert.delete
+      end
 
+      def delete_overwritten_verifications
+        verification_ids = db[:verifications].select(:id).where(id: db[:latest_verification_id_for_pact_version_and_provider_version].select(:verification_id)).invert
+        deleted_counts = { verification_results: verification_ids.count }
+        delete_webhook_data(db[:triggered_webhooks].where(verification_id: verification_ids).select(:id))
+        verification_ids.delete
+        deleted_counts
+      end
     end
   end
 end

data/lib/pact_broker/doc/controllers/app.rb

@@ -13,7 +13,9 @@ module PactBroker
 
         MAPPINGS = {
           'webhooks-create' => 'webhooks',
-          'webhooks-webhooks' => 'webhooks'
+          'webhooks-webhooks' => 'webhooks',
+          'can-i-deploy-pacticipant-version-to-tag' => 'can-i-deploy',
+          'pacticipant' => 'pacticipants'
         }.freeze
 
         helpers do

data/lib/pact_broker/doc/views/can-i-deploy.markdown

@@ -0,0 +1,14 @@
+# Can I Deploy
+
+Allowed methods: `GET`
+
+A simplified resource that accepts the same parameters as the basic usage of the `can-i-deploy` CLI command.
+
+**Parameters**:
+
+* _pacticipant_: The name of the pacticipant (application) you want to deploy (required).
+* _version_: The version of the pacticipant (application) you want to deploy (required).
+* _to_: The tag used to identify the environment into which you wish to deploy the application (eg. `test` or `prod`). This assumes you have already tagged the currently deployed versions of each of the integrated applications with the same tag. To be specific, the logic checks if the application version you have specified is compatible with the latest versions _for the specified tag_ of all the other applications it is integrated with. This parameter is optional - if not specified, it checks for compatiblity with the latest version of all the integrated applications.
+
+
+If you have an environment that you identify with the tag `prod`, and each time you deployed an application to the prod environment you tagged the relevant application version in the Pact Broker with the tag `prod`, then calling `/can-i-deploy?pacticipant=Foo&version=734137278d&to=prod` will check that version 734137278d of Foo has a successful verification result with each of the integrated application versions that are currently in prod. That is, it is safe to deploy.

data/lib/pact_broker/doc/views/index/pacticipant-version-tag.markdown

@@ -0,0 +1,8 @@
+# Pacticipant version tag
+
+Allowed methods: `GET`, `PUT`, `DELETE`
+Path: `/pacticipants/{pacticipant}/versions/{version}/tags/{tag}`
+
+To create a tag, send an empty request with the URL specified above and `Content-Type` of `application/json`.
+
+Tags must be applied before pacts or verification results are published to ensure that the webhook fires with the correct metadata.

data/lib/pact_broker/doc/views/integrations.markdown

@@ -2,6 +2,6 @@
 
 Allowed methods: `GET`
 
-Content types: `text/vnd.graphviz`
+Content types: `text/vnd.graphviz`, `application/hal+json`
 
 A list of all the integrations (consumer/provider pairs) stored in the Pact Broker.

data/lib/pact_broker/doc/views/matrix.markdown

@@ -0,0 +1,7 @@
+# Matrix
+
+Allowed methods: `GET`
+
+This resource returns the "cartesian join" of every pact publication and every verification results publication, and is used to determine whether or not an application is safe to deploy.
+
+If you need to use this API, consider calling the `/can-i-deploy` resource instead.

data/lib/pact_broker/doc/views/metrics.markdown

@@ -0,0 +1,5 @@
+# Metrics
+
+Allowed methods: `GET`
+
+Returns counts for the Pact Broker resources.

data/lib/pact_broker/domain/index_item.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/verifications/verification_status'
+require 'pact_broker/verifications/pseudo_branch_status'
 require 'pact_broker/webhooks/status'
 
 module PactBroker
@@ -85,8 +85,8 @@ module PactBroker
         @last_webhook_execution_date ||= @triggered_webhooks.any? ? @triggered_webhooks.sort{|a, b| a.created_at <=> b.created_at }.last.created_at : nil
       end
 
-      def verification_status
-        @verification_status ||= PactBroker::Verifications::Status.new(@latest_pact, @latest_verification).to_sym
+      def pseudo_branch_verification_status
+        @pseudo_branch_verification_status ||= PactBroker::Verifications::PseudoBranchStatus.new(@latest_pact, @latest_verification).to_sym
       end
 
       def ever_verified?

data/lib/pact_broker/domain/pact.rb

@@ -1,13 +1,17 @@
 require 'pact_broker/db'
 require 'pact_broker/json'
 
+=begin
+This class most accurately represents a PactPublication
+=end
+
 module PactBroker
 
   module Domain
     class Pact
 
+      # The ID is the pact_publication ID
       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 |
           self.send(key.to_s + "=", value)
@@ -30,6 +34,10 @@ module PactBroker
         consumer_version.tags.collect(&:name)
       end
 
+      def latest_consumer_version_tag_names= latest_consumer_version_tag_names
+        @latest_consumer_version_tag_names = latest_consumer_version_tag_names
+      end
+
       def to_s
         "Pact: consumer=#{consumer.name} provider=#{provider.name}"
       end
@@ -53,6 +61,25 @@ module PactBroker
       def pact_publication_id
         id
       end
+
+      def select_pending_provider_version_tags(provider_version_tags)
+        provider_version_tags - db_model.pact_version.select_provider_tags_with_successful_verifications(provider_version_tags)
+      end
+
+      def pending?
+        !pact_version.verified_successfully_by_any_provider_version?
+      end
+
+      private
+
+      attr_accessor :db_model
+
+      # Really not sure about mixing Sequel model class into this PORO...
+      # But it's much nicer than using a repository to find out the pending information :(
+      def pact_version
+        db_model.pact_version
+      end
     end
+
   end
 end