pact_broker 2.31.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f778ef154be3a35cb2cc58deeaa7445228413820
-  data.tar.gz: 27d7c415594fe68b43f0813d7a47392faeb49b25
+  metadata.gz: 9cc025b711061dcb0c7ceecb89e57b5df8560667
+  data.tar.gz: 87e712268e55f5325f1ea3c6a81dd370504b34f9
 SHA512:
-  metadata.gz: 93b6226a1d82f747454a48513a789b2215dedc12fce7e1173554ef2fc36d7584369b551d050c2b6f067f5199e43d1a37a640d7b596717fc8a114826773abca97
-  data.tar.gz: 1d6c6605ea29d1c827b0f2073cde3b9782eefca979b3851b8c84804e210fc1ba71c56d8306de77abde51707557d0e2db8906475903634c6c9e0a10b2921efea9
+  metadata.gz: bc84f0a9394bb378f64bcb04796a4f594c395f4a1f1018e55e2e64a1a97738346be25f5ecf1a6632ec4b0ce100fd36d3fb1167de90af0db62b4abb95ae258e21
+  data.tar.gz: 2b135a336313e79f8f448f8ab466bf9d50c1f096d425c406edbda93a415bb62a28abbea616f64dad1af226650f1340a5d43ac6f263020c9c877c9ec04b945662

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+<a name="v2.32.0"></a>
+### v2.32.0 (2019-05-28)
+
+
+#### Features
+
+* **webhooks**
+  * maintain starred out Authorization header value	 ([cc978582](/../../commit/cc978582))
+  * don't use username if empty string	 ([9327271d](/../../commit/9327271d))
+  * do not show backtrace in webhook test execution response	 ([c8a8194e](/../../commit/c8a8194e))
+  * return a 200 status for webhook test execution response even when execution has failed	 ([d90c4552](/../../commit/d90c4552))
+  * do not require basic auth password to be re-submitted when a webhook is updated - maintain existing value if not present	 ([55d7f4ad](/../../commit/55d7f4ad))
+  * allow description to be edited	 ([302d70f6](/../../commit/302d70f6))
+  * only trigger enabled webhooks	 ([cb2b0321](/../../commit/cb2b0321))
+  * add enabled column to model and database schema	 ([ce452ec8](/../../commit/ce452ec8))
+
+* add metadata to webhook and verification URLs to correctly track relevant versions and tags (#274)	 ([426b0b19](/../../commit/426b0b19))
+* add group url to /integrations _links	 ([e2584f53](/../../commit/e2584f53))
+* add matrix URL to /integration _links	 ([344d3e18](/../../commit/344d3e18))
+* allow dashboard resource to be filtered by consumer/provider	 ([a2408520](/../../commit/a2408520))
+* add hal+json endpoint for listing integrations	 ([40f3e021](/../../commit/40f3e021))
+* allow a custom API to be configured	 ([1c371163](/../../commit/1c371163))
+
+* **webhook**
+  * show user specified description instead of generated one in collection resource	 ([2643d957](/../../commit/2643d957))
+
+* **matrix**
+  * do not default to latestby=cvpv for consumer/provider matrix	 ([742d506c](/../../commit/742d506c))
+
+
+#### Bug Fixes
+
+* **webhooks**
+  * correctly set updated consumer and provider	 ([d865a429](/../../commit/d865a429))
+
+* default matrix limit for /matrix/provider/PROVIDER/consumer/CONSUMER endpoint to 100	 ([7ccc9b6f](/../../commit/7ccc9b6f))
+* gracefully handle situation where webhook is deleted before execution	 ([634ccd53](/../../commit/634ccd53))
+* duplicate key value violates unique constraint uq_ver_ppt_ord	 ([4303e4f7](/../../commit/4303e4f7))
+
+
 <a name="v2.31.0"></a>
 ### v2.31.0 (2019-04-30)
 

data/db/migrations/20190509_create_version_sequence.rb

@@ -0,0 +1,8 @@
+require 'pact_broker/db/data_migrations/set_latest_version_sequence_value'
+Sequel.migration do
+  change do
+    create_table(:version_sequence_number) do
+      Integer :value, null: false
+    end
+  end
+end

data/db/migrations/20190510_set_version_sequence.rb

@@ -0,0 +1,9 @@
+require 'pact_broker/db/data_migrations/set_latest_version_sequence_value'
+Sequel.migration do
+  up do
+    PactBroker::DB::DataMigrations::SetLatestVersionSequenceValue.call(self)
+  end
+
+  down do
+  end
+end

data/db/migrations/20190511_create_integrations_view.rb

@@ -0,0 +1,19 @@
+Sequel.migration do
+  up do
+    create_view(:integrations,
+      from(:pact_publications)
+        .select(
+          :consumer_id,
+          Sequel[:c][:name].as(:consumer_name),
+          :provider_id,
+          Sequel[:p][:name].as(:provider_name)
+        ).distinct
+        .join(:pacticipants, {:id => :consumer_id}, {:table_alias => :c, implicit_qualifier: :pact_publications})
+        .join(:pacticipants, {:id => :provider_id}, {:table_alias => :p, implicit_qualifier: :pact_publications})
+    )
+  end
+
+  down do
+    drop_view(:integrations)
+  end
+end

data/db/migrations/20190523_add_enabled_column_to_webhooks.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:webhooks, :enabled, TrueClass, default: true)
+  end
+end

data/db/migrations/20190524_set_webhooks_enabled.rb

@@ -0,0 +1,10 @@
+require 'pact_broker/db/data_migrations/set_webhooks_enabled'
+
+Sequel.migration do
+  up do
+    PactBroker::DB::DataMigrations::SetWebhooksEnabled.call(self)
+  end
+
+  down do
+  end
+end

data/db/migrations/20190525_add_description_column_to_webhooks.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:webhooks, :description, String)
+  end
+end

data/lib/pact_broker/api.rb

@@ -17,6 +17,7 @@ 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, 'pact-version', :pact_version_sha, 'metadata', :metadata], 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"}
@@ -24,6 +25,7 @@ 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, '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"}
@@ -84,6 +86,7 @@ module PactBroker
         add ['matrix'], Api::Resources::Matrix, {resource_name: "matrix"}
 
         add ['dashboard'], Api::Resources::Dashboard, {resource_name: "dashboard"}
+        add ['dashboard', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::Dashboard, {resource_name: "integration_dashboard"}
         add ['test','error'], Api::Resources::ErrorTest, {resource_name: "error_test"}
 
         add ['integrations'], Api::Resources::Integrations, {resource_name: "integrations"}

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

@@ -5,11 +5,8 @@ require 'pact_broker/api/decorators/decorator_context'
 require 'pact_broker/api/decorators/format_date_time'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class BaseDecorator < Roar::Decorator
         include Roar::JSON::HAL
         include Roar::JSON::HAL::Links

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

@@ -0,0 +1,40 @@
+require_relative 'base_decorator'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class IntegrationDecorator < BaseDecorator
+        include PactBroker::Api::PactBrokerUrls
+
+        property :consumer do
+          property :name
+        end
+
+        property :provider do
+          property :name
+        end
+
+        link "pb:dashboard" do | options |
+          {
+            title: "BETA: Pacts to show on the dashboard",
+            href: dashboard_url_for_integration(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+          }
+        end
+
+        link "pb:matrix" do | options |
+          {
+            title: "Matrix of pacts/verification results for #{represented.consumer.name} and #{represented.provider.name}",
+            href: matrix_url(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+          }
+        end
+
+        link "pb:group" do | options |
+          {
+            href: group_url(represented.consumer.name, options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative 'base_decorator'
+require_relative 'integration_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class IntegrationsDecorator < BaseDecorator
+        collection :entries, as: :integrations, embedded: true, :extend => PactBroker::Api::Decorators::IntegrationDecorator
+
+        link :self do | context |
+          {
+            href: context[:resource_url],
+            title: "All integrations"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -146,7 +146,7 @@ module PactBroker
         link :'pb:publish-verification-results' do | options |
           {
             title: "Publish verification results",
-            href: verification_publication_url(represented, options.fetch(:base_url))
+            href: verification_publication_url(represented, options.fetch(:base_url), options[:metadata])
           }
         end
 

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

@@ -2,21 +2,16 @@ require_relative 'base_decorator'
 require_relative 'pact_pacticipant_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PactDetailsDecorator < BaseDecorator
-
         property :consumer, :extend => PactBroker::Api::Decorators::PactPacticipantDecorator, :embedded => true
         property :provider, :extend => PactBroker::Api::Decorators::PactPacticipantDecorator, :embedded => true
 
         link :self do | options |
           pact_url(options[:base_url], represented)
         end
-
       end
     end
   end
-end
+end

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

@@ -0,0 +1,12 @@
+require_relative 'base_decorator'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class VerifiablePactDecorator < BaseDecorator
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative 'base_decorator'
+require_relative 'verifiable_pact_decorator'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class VerifiablePactsDecorator < BaseDecorator
+        collection :entries, as: :pacts, embedded: true, :extend => PactBroker::Api::Decorators::VerifiablePactDecorator
+
+        link :self do | context |
+          {
+            href: context[:resource_url],
+            title: "Pacts to be verified"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,8 @@ module PactBroker
           property :name
         end
 
+        property :description, getter: lambda { |context| context[:represented].display_description }
+
         property :consumer, :class => PactBroker::Domain::Pacticipant do
           property :name
         end
@@ -24,6 +26,8 @@ module PactBroker
           property :name
         end
 
+        property :enabled, default: true
+
         property :request, :class => PactBroker::Webhooks::WebhookRequestTemplate, extend: WebhookRequestTemplateDecorator
         collection :events, :class => PactBroker::Webhooks::WebhookEvent, extend: WebhookEventDecorator
 
@@ -31,7 +35,7 @@ module PactBroker
 
         link :self do | options |
           {
-            title: represented.description,
+            title: represented.display_description,
             href: webhook_url(represented.uuid, options[:base_url])
           }
 

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

@@ -8,7 +8,6 @@ module PactBroker
       class WebhookExecutionResultDecorator < BaseDecorator
         class ErrorDecorator < BaseDecorator
           property :message
-          property :backtrace
         end
 
         class HTTPRequestDecorator < BaseDecorator

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

@@ -24,8 +24,8 @@ module PactBroker
         links :'pb:webhooks' do | context |
           represented.entries.collect do | webhook |
             {
-              title: webhook.description,
-              name: webhook.request_description,
+              title: "Webhook",
+              name: webhook.display_description,
               href: webhook_url(webhook.uuid, context[:base_url])
             }
           end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -54,6 +54,27 @@ module PactBroker
         "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}"
       end
 
+      def pact_version_url_with_metadata pact, base_url = ''
+        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}/metadata/#{build_webhook_metadata(pact)}"
+      end
+
+      def build_webhook_metadata(pact)
+        Base64.strict_encode64(Rack::Utils.build_nested_query(
+          consumer_version_number: pact.consumer_version_number,
+          consumer_version_tags: pact.consumer_version_tag_names
+        ))
+      end
+
+      def parse_webhook_metadata(metadata)
+        if metadata
+          Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
+            new_hash[k.to_sym] = v
+          end
+        else
+          {}
+        end
+      end
+
       def pact_url_from_params base_url, params
         [ base_url, 'pacts',
           'provider', url_encode(params[:provider_name]),
@@ -81,6 +102,10 @@ module PactBroker
         "#{base_url}/integrations/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end
 
+      def dashboard_url_for_integration consumer_name, provider_name, base_url = ""
+        "#{base_url}/dashboard/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
+      end
+
       def previous_distinct_diff_url pact, base_url
         pact_url(base_url, pact) + "/diff/previous-distinct"
       end
@@ -132,8 +157,9 @@ module PactBroker
         "#{verification_url(verification, base_url)}/triggered-webhooks"
       end
 
-      def verification_publication_url pact, base_url
-        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}/verification-results"
+      def verification_publication_url pact, base_url, metadata = ""
+        metadata_part = metadata ? "/metadata/#{metadata}" : ""
+        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}#{metadata_part}/verification-results"
       end
 
       def tag_url base_url, tag
@@ -200,8 +226,16 @@ module PactBroker
         "#{latest_pact_url(base_url, pact)}/badge.svg"
       end
 
+      def matrix_url consumer_name, provider_name, base_url = ''
+        "/matrix/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
+      end
+
       def matrix_url_from_params params, base_url = ''
-        "#{base_url}/matrix/provider/#{url_encode(params.fetch(:provider_name))}/consumer/#{url_encode(params.fetch(:consumer_name))}"
+        matrix_url(params.fetch(:consumer_name), params.fetch(:provider_name), base_url)
+      end
+
+      def group_url(pacticipant_name, base_url = '')
+        "#{base_url}/groups/#{pacticipant_name}"
       end
 
       def hal_browser_url target_url

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

@@ -167,6 +167,10 @@ module PactBroker
         def pact
           @pact ||= pact_service.find_pact(pact_params)
         end
+
+        def database_connector
+          request.env["pactbroker.database_connector"]
+        end
       end
     end
   end

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

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

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

@@ -1,12 +1,16 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/api/renderers/integrations_dot_renderer'
+require 'pact_broker/api/decorators/integrations_decorator'
 
 module PactBroker
   module Api
     module Resources
       class Integrations < BaseResource
         def content_types_provided
-          [["text/vnd.graphviz", :to_dot]]
+          [
+            ["text/vnd.graphviz", :to_dot],
+            ["application/hal+json", :to_json]
+          ]
         end
 
         def allowed_methods
@@ -17,8 +21,12 @@ module PactBroker
           PactBroker::Api::Renderers::IntegrationsDotRenderer.call(integrations)
         end
 
+        def to_json
+          PactBroker::Api::Decorators::IntegrationsDecorator.new(integrations).to_json(user_options: decorator_context)
+        end
+
         def integrations
-          pact_service.find_latest_pacts
+          integration_service.find_all
         end
 
         def delete_resource