pact_broker 2.85.0 → 2.88.0

data/spec/integration/webhooks_documentation_spec.rb

@@ -0,0 +1,348 @@
+require "timecop"
+
+WEBHOOK_TESTED_PATHS = []
+WEBHOOKS_NO_DOCUMENTATION = %w[
+]
+WEBHOOK_ROUTES_REQURING_A_TEST = PactBroker.routes
+      .select { | route | route[:path].include?("webhook") }
+      .reject { | route | WEBHOOKS_NO_DOCUMENTATION.include?(route[:path]) }
+
+# Fails on Github Actions
+RSpec.describe "webhook routes", skip: true do
+  before do
+    Timecop.freeze(Time.new(2021, 9, 1, 10, 7, 21))
+    td.create_consumer("Foo")
+      .create_provider("Bar")
+      .create_consumer_version("2")
+      .create_pact(json_content: { integrations: [] }.to_json )
+      .create_verification(provider_version: "3")
+      .create_webhook(
+        uuid: "d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+        url: "https://example.org/example",
+        description: "an example webhook",
+        body: webhook_body
+      )
+      .create_triggered_webhook(uuid: "6cd5cc48-db3c-4a4c-a36d-e9bedeb9d91e")
+      .create_webhook_execution
+  end
+
+  after do
+    Timecop.return
+  end
+
+  let(:webhook_body) do
+    { "pactUrl" =>"${pactbroker.pactUrl}" }
+  end
+
+  before do
+    if ENV["DEBUG"] == "true"
+      PactBroker.routes.find{ | route| route[:path] == path_template }
+    end
+    WEBHOOK_TESTED_PATHS << path_template
+  end
+
+  after(:all) do
+    missed_routes = WEBHOOK_ROUTES_REQURING_A_TEST.reject { | route | WEBHOOK_TESTED_PATHS.include?(route[:path]) }
+
+    if missed_routes.any? && ENV["DEBUG"] != "true"
+      puts "WEBHOOK ROUTES MISSING COVERAGE:"
+      puts missed_routes.to_yaml
+    end
+  end
+
+  let(:category) { "Webhooks" }
+  let(:pact_version_sha) { PactBroker::Pacts::PactVersion.last.sha }
+  let(:triggered_webhook_uuid) { PactBroker::Webhooks::TriggeredWebhook.last.trigger_uuid }
+  let(:webhook_uuid) { PactBroker::Webhooks::TriggeredWebhook.last.webhook.uuid }
+
+  let(:webhook_hash) do
+    {
+      "description" => "an example webhook",
+      "events" => [{
+        "name" => "contract_content_changed"
+      }],
+      "request" =>{
+        "method" =>"POST",
+        "url" =>"https://example.org/example",
+        "username" =>"username",
+        "password" =>"password",
+        "headers" =>{
+          "Accept" =>"application/json"
+        },
+        "body" => webhook_body
+      }
+    }
+  end
+
+  let(:parameter_values) do
+    {
+      pact_version_sha: pact_version_sha,
+      provider_name: "Bar",
+      consumer_name: "Foo",
+      consumer_version_number: "2",
+      provider_version_number: "3",
+      trigger_uuid: triggered_webhook_uuid,
+      verification_number: "1"
+    }
+  end
+
+  let(:custom_parameter_values) do
+    {
+
+    }
+  end
+
+  let(:rack_headers) do
+    {
+      "ACCEPT" => "application/hal+json"
+    }
+  end
+
+  let(:http_params) { {} }
+  let(:http_method) { "GET" }
+
+  let(:path) do
+    build_path(path_template, parameter_values, custom_parameter_values)
+  end
+
+  let(:approval_request_example_name) do
+    build_approval_name(category, pact_broker_example_name, http_method)
+  end
+
+  let(:pact_broker_example_name) do | example |
+    example.example_group.parent_groups[-2].description
+  end
+
+  subject { send(http_method.downcase, path, http_params, rack_headers) }
+
+  shared_examples "request" do
+    it "returns a body" do
+      subject
+      Approvals.verify(expected_interaction(subject, WEBHOOK_TESTED_PATHS.size), :name => approval_request_example_name, format: :json)
+    end
+  end
+
+  shared_examples "supports GET" do
+    its(:status) { is_expected.to eq 200 }
+    include_examples "request"
+  end
+
+
+  shared_examples "supports POST" do
+    let(:http_method) { "POST" }
+    let(:rack_headers) do
+      {
+        "CONTENT_TYPE" => "application/json",
+        "ACCEPT" => "application/hal+json"
+      }
+    end
+
+    its(:status) { is_expected.to be_between(200, 201) }
+    include_examples "request"
+
+  end
+
+  shared_examples "supports PUT" do
+    describe "PUT" do
+      let(:http_method) { "PUT" }
+      let(:rack_headers) do
+        {
+          "CONTENT_TYPE" => "application/json",
+          "ACCEPT" => "application/hal+json"
+        }
+      end
+
+      its(:status) { is_expected.to be_between(200, 201) }
+
+      include_examples "request"
+    end
+  end
+
+  shared_examples "supports OPTIONS" do
+    let(:http_method) { "OPTIONS" }
+
+    its(:status) { is_expected.to eq 200 }
+    include_examples "request"
+  end
+
+  describe "Webhook" do
+    let(:path_template) { "/webhooks/:uuid" }
+    let(:custom_parameter_values) { { uuid: webhook_uuid } }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "PUT" do
+      let(:http_params) { webhook_hash.to_json }
+      include_examples "supports PUT"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Webhooks" do
+    let(:path_template) { "/webhooks" }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "POST" do
+      before do
+        allow(PactBroker::Webhooks::Service).to receive(:next_uuid).and_return("dCGCl-Ba3PqEFJ_iE9mJkQ")
+      end
+
+      let(:http_params) { webhook_hash.to_json }
+      include_examples "supports POST"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Webhooks for consumer" do
+    let(:path_template) { "/webhooks/consumer/:consumer_name" }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Webhooks for a provider" do
+    let(:path_template) { "/webhooks/provider/:provider_name" }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Webhooks for consumer and provider" do
+    let(:path_template) { "/webhooks/provider/:provider_name/consumer/:consumer_name" }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Pact webhooks" do
+    let(:path_template) do
+      "/pacts/provider/:provider_name/consumer/:consumer_name/webhooks"
+    end
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Webhooks status" do
+    let(:path_template) do
+      "/pacts/provider/:provider_name/consumer/:consumer_name/webhooks/status"
+    end
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Executing a saved webhook" do
+    let(:path_template) { "/webhooks/:uuid/execute" }
+    let(:custom_parameter_values) { { uuid: webhook_uuid } }
+
+    include_examples "supports OPTIONS"
+
+    describe "POST" do
+      before do
+        stub_request(:post, /http/).to_return(:status => 200)
+        allow(PactBroker.configuration).to receive(:webhook_host_whitelist).and_return([/.*/])
+      end
+
+      include_examples "supports POST"
+    end
+
+  end
+
+  describe "Executing an unsaved webhook" do
+    let(:path_template) { "/webhooks/execute" }
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+
+    describe "POST" do
+      before do
+        stub_request(:post, /http/).to_return(:status => 200)
+        allow(PactBroker.configuration).to receive(:webhook_host_whitelist).and_return([/.*/])
+      end
+
+      let(:http_params) do
+        webhook_hash.to_json
+      end
+      include_examples "supports POST"
+    end
+  end
+
+  describe "Triggered webhooks for pact publication" do
+    let(:path_template) do
+      "/pacts/provider/:provider_name/consumer/:consumer_name/version/:consumer_version_number/triggered-webhooks"
+    end
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Triggered webhooks for verification publication" do
+    let(:path_template) do
+      "/pacts/provider/:provider_name/consumer/:consumer_name/pact-version/:pact_version_sha/verification-results/:verification_number/triggered-webhooks"
+    end
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+
+  describe "Logs of triggered webhook" do
+    let(:path_template) { "/triggered-webhooks/:uuid/logs" }
+    let(:custom_parameter_values) { { uuid: triggered_webhook_uuid } }
+
+    describe "GET" do
+      include_examples "supports GET"
+    end
+
+    describe "OPTIONS" do
+      include_examples "supports OPTIONS"
+    end
+  end
+end

data/spec/lib/pact/doc/markdown/consumer_contract_renderer_spec.rb

@@ -27,8 +27,8 @@ module Pact
             let(:consumer_contract) { Pact::ConsumerContract.from_uri "./spec/support/markdown_pact_with_markdown_chars_in_names.json" }
 
             it "escapes the markdown characters" do
-              expect(subject.call).to include '# A pact between Some\*Consumer\*App and Some\_Provider\_App'
-              expect(subject.call).to include '### Requests from Some\*Consumer\*App to Some\_Provider\_App'
+              expect(subject.call).to include "# A pact between Some\\*Consumer\\*App and Some\\_Provider\\_App"
+              expect(subject.call).to include "### Requests from Some\\*Consumer\\*App to Some\\_Provider\\_App"
             end
           end
 

data/spec/lib/pact_broker/api/contracts/publish_contracts_schema_spec.rb

@@ -108,6 +108,19 @@ module PactBroker
 
           its([:contracts, 0]) { is_expected.to include "provider name in contract content ('WRONG') must match providerName ('Bar') in contracts at index 0" }
         end
+
+        context "when the consumer name is missing and there is a validation error with the content" do
+          let(:params) do
+            JSON.parse(File.read("spec/fixtures/invalid-publish-contract-body.json"), symbolize_names: true)
+          end
+
+          it "handles multiple errors" do
+            expect(subject[:contracts]).to include "consumerName is missing at index 0"
+            expect(subject[:contracts]).to include "providerName is missing at index 0"
+            expect(subject[:contracts]).to include "contentType is missing at index 0"
+            expect(subject[:contracts]).to include "specification is missing at index 0"
+          end
+        end
       end
     end
   end

data/spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb

@@ -85,6 +85,31 @@ module PactBroker
             end
           end
 
+          context "with a consumer label" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash["consumer"].delete("name")
+                hash["consumer"]["label"] = "my_label"
+              end
+            end
+
+            it "contains no errors" do
+              expect(subject.errors).to be_empty
+            end
+          end
+
+          context "with a consumer label and name provided" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash["consumer"]["label"] = "my_label"
+              end
+            end
+
+            it "contains consumer.label error" do
+              expect(subject.errors.messages).to eq({:'consumer.label' => ["cannot be provided"]})
+            end
+          end
+
           context "with a nil provider name" do
             let(:json) do
               valid_webhook_with do |hash|
@@ -131,6 +156,31 @@ module PactBroker
             end
           end
 
+          context "with provider label" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash["provider"].delete("name")
+                hash["provider"]["label"] = "my_label"
+              end
+            end
+
+            it "contains no errors" do
+              expect(subject.errors).to be_empty
+            end
+          end
+
+          context "with a provider label and name" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash["provider"]["label"] = "my_label"
+              end
+            end
+
+            it "contains provider.label error" do
+              expect(subject.errors.messages).to eq({:'provider.label' => ["cannot be provided"]})
+            end
+          end
+
           context "with no request defined" do
             let(:json) { {}.to_json }
 

data/spec/lib/pact_broker/api/decorators/matrix_decorator_spec.rb

@@ -129,7 +129,7 @@ module PactBroker
               verifiedAt: "2017-12-31T00:00:00+00:00",
               _links: {
                 self: {
-                  href: "http://example.org/pacts/provider/Provider/consumer/Consumer/pact-version/1234/verification-results/1"
+                  href: "http://example.org/pacts/provider/Provider/consumer/Consumer/pact-version/1234/metadata/Y3ZuPTEuMC4w/verification-results/1"
                 }
               }
             }

data/spec/lib/pact_broker/api/decorators/verification_decorator_spec.rb

@@ -6,6 +6,7 @@ module PactBroker
       describe VerificationDecorator do
         before do
           allow_any_instance_of(VerificationDecorator).to receive(:verification_triggered_webhooks_url).and_return("http://triggered-webhooks")
+          allow_any_instance_of(VerificationDecorator).to receive(:pact_version_with_consumer_version_metadata_url).and_return("http://pact")
         end
 
         let(:verification) do
@@ -18,23 +19,25 @@ module PactBroker
             test_results: { "arbitrary" => "json" },
             build_url: "http://build-url",
             pact_version_sha: "1234",
-            latest_pact_publication: pact_publication,
             execution_date: DateTime.now,
-            provider_version_tags: provider_version_tags)
+            provider_version_tags: provider_version_tags,
+            verified_by_implementation: "Ruby",
+            verified_by_version: "1234")
         end
 
-        let(:pact_publication) do
-          instance_double("PactBroker::Pacts::PactPublication",
+        let(:pact) do
+          instance_double("PactBroker::Domain::Pact",
             name: "A name",
             provider_name: "Provider",
             consumer_name: "Consumer",
-            consumer_version_number: "1.2.3"
+            consumer_version_number: "1.2.3",
+            pact_version_sha: "1234",
           )
         end
 
         let(:provider_version_tags) { [instance_double(PactBroker::Tags::TagWithLatestFlag, name: "prod", latest?: true)] }
 
-        let(:options) { { user_options: { base_url: "http://example.org" } } }
+        let(:options) { { user_options: { base_url: "http://example.org", pact: pact } } }
 
         let(:json) { VerificationDecorator.new(verification).to_json(options) }
 
@@ -61,12 +64,17 @@ module PactBroker
         end
 
         it "includes a link to its pact" do
-          expect(subject[:_links][:'pb:pact-version'][:href]).to match %r{http://example.org/pacts/}
+          expect(subject[:_links][:'pb:pact-version'][:href]).to eq "http://pact"
         end
 
         it "includes a link to the triggered webhooks" do
           expect(subject[:_links][:'pb:triggered-webhooks'][:href]).to eq "http://triggered-webhooks"
         end
+
+        it "includes the framework that did the verification" do
+          expect(subject[:verifiedBy][:implementation]).to eq "Ruby"
+          expect(subject[:verifiedBy][:version]).to eq "1234"
+        end
       end
     end
   end

data/spec/lib/pact_broker/api/decorators/verification_summary_decorator_spec.rb

@@ -21,7 +21,9 @@ module PactBroker
             latest_pact_publication: pact,
             test_results: nil,
             execution_date: DateTime.now,
-            provider_version_tags: provider_version_tags)
+            provider_version_tags: provider_version_tags,
+            verified_by_implementation: "Ruby",
+            verified_by_version: "1234")
         end
 
         let(:pact_version) do
@@ -29,7 +31,7 @@ module PactBroker
         end
 
         let(:provider_version_tags) { [instance_double(PactBroker::Tags::TagWithLatestFlag, name: "prod", latest?: true)] }
-        let(:pact) { instance_double("PactBroker::Domain::Pact", name: "Some pact", consumer_name: "Foo", provider_name: "Bar", consumer_version_number: "1.2.3") }
+        let(:pact) { instance_double("PactBroker::Domain::Pact", name: "Some pact", consumer_name: "Foo", provider_name: "Bar", consumer_version_number: "1.2.3", pact_version_sha: "1234") }
         let(:is_pending) { true }
         let(:options) { {base_url: "http://example.org", consumer_name: "Foo", consumer_version_number: "1.2.3", resource_url: "http://self"} }
 

data/spec/lib/pact_broker/api/decorators/webhook_decorator_spec.rb

@@ -20,8 +20,8 @@ module PactBroker
           Webhooks::WebhookRequestTemplate.new(request)
         end
 
-        let(:consumer) { Domain::Pacticipant.new(name: "Consumer") }
-        let(:provider) { Domain::Pacticipant.new(name: "Provider") }
+        let(:consumer) { Domain::WebhookPacticipant.new(name: "Consumer") }
+        let(:provider) { Domain::WebhookPacticipant.new(name: "Provider") }
         let(:event)    { Webhooks::WebhookEvent.new(name: "something_happened") }
         let(:created_at) { DateTime.now }
         let(:updated_at) { created_at + 1 }
@@ -193,8 +193,8 @@ module PactBroker
           context "when the decorated object has a consumer/provider but the incoming JSON does not" do
             let(:webhook) do
               Domain::Webhook.new(
-                consumer: Domain::Pacticipant.new(name: "consumer"),
-                provider: Domain::Pacticipant.new(name: "provider")
+                consumer: Domain::WebhookPacticipant.new(name: "consumer"),
+                provider: Domain::WebhookPacticipant.new(name: "provider")
               )
             end
 

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -100,6 +100,24 @@ module PactBroker
         end
       end
 
+      describe "verification_url_from_params" do
+        context "with consumer_version_number" do
+          let(:params) do
+            {
+              consumer_name: consumer_name,
+              provider_name: provider_name,
+              pact_version_sha: "1234",
+              consumer_version_number: "2",
+              verification_number: "1"
+            }
+          end
+
+          subject { PactBrokerUrls.verification_url_from_params(params, base_url)}
+
+          it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/1234/metadata/Y3ZuPTI/verification-results/1" }
+        end
+      end
+
       describe "templated_diff_url" do
         subject { PactBrokerUrls.templated_diff_url(pact, base_url) }
 

data/spec/lib/pact_broker/api/resources/triggered_webhook_logs_spec.rb

@@ -15,15 +15,16 @@ module PactBroker
             .create_webhook_execution(logs: "waffle")
         end
 
-        let(:path) { "/webhooks/5432/trigger/1234/logs" }
-
         subject { get(path) }
 
         let(:triggered_webhook_uuid) { PactBroker::Webhooks::TriggeredWebhook.first.uuid }
-        let(:path) { "/triggered-webhooks/#{triggered_webhook_uuid}/logs" }
 
-        it "returns the concatenated webhook execution logs" do
-          expect(subject.body).to eq "foo\nbar"
+        describe "by triggered webhook uuid" do
+          let(:path) { "/triggered-webhooks/1234/logs" }
+
+          it "returns the concatenated webhook execution logs" do
+            expect(subject.body).to eq "foo\nbar"
+          end
         end
       end
     end

data/spec/lib/pact_broker/config/runtime_configuration_documentation_spec.rb

@@ -0,0 +1,30 @@
+require "pact_broker/config/runtime_configuration"
+
+module PactBroker
+  module Config
+    describe RuntimeConfiguration do
+      ATTRIBUTES = RuntimeConfiguration.config_attributes
+      DOCUMENTATION = File.read("docs/configuration.yml")
+      DOCUMENTED_ATTRIBUTES = YAML.load(DOCUMENTATION)["groups"].flat_map{ | group | group["vars"].keys.collect(&:to_sym) }
+      DELIBERATELY_UNDOCUMENTED_ATTRIBUTES = [
+        :warning_error_class_names,
+        :log_configuration_on_startup,
+        :use_hal_browser,
+        :use_rack_protection,
+        :use_case_sensitive_resource_names,
+        :order_versions_by_date,
+        :base_equality_only_on_content_that_affects_verification_results,
+        :semver_formats,
+        :seed_example_data,
+        :use_first_tag_as_branch_time_limit,
+        :validate_database_connection_config
+      ]
+
+      (ATTRIBUTES - DELIBERATELY_UNDOCUMENTED_ATTRIBUTES).each do | attribute_name |
+        it "has documentation for #{attribute_name}" do
+          expect(DOCUMENTED_ATTRIBUTES & [attribute_name]).to include(attribute_name)
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/deployments/environment_service_spec.rb

@@ -2,7 +2,7 @@ require "pact_broker/deployments/environment_service"
 
 module PactBroker
   module Deployments
-    module EnvironmentService
+    describe EnvironmentService do
       describe ".create" do
         let(:environment) do
           Environment.new(
@@ -32,6 +32,27 @@ module PactBroker
           end
         end
       end
+
+      describe ".replace" do
+        before do
+          td.create_environment("foo", uuid: "1", display_name: "bar", production: false)
+        end
+
+        subject { EnvironmentService.replace("1", Environment.new(name: "bar", display_name: "bar-2", production: true) ) }
+
+        it "replaces the attributes" do
+          subject
+          expect(Environment.first).to have_attributes(name: "bar", display_name: "bar-2", production: true)
+        end
+
+        context "with missing attributes" do
+          subject { EnvironmentService.replace("1", Environment.new ) }
+
+          it "raises an error" do
+            expect { subject }.to raise_error Sequel::DatabaseError
+          end
+        end
+      end
     end
   end
 end