pact_broker 2.87.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_broker/deployments/environment_service_spec.rb

@@ -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

data/spec/lib/pact_broker/domain/webhook_spec.rb

@@ -32,18 +32,53 @@ module PactBroker
 
         context "with a consumer and provider" do
           it { is_expected.to eq "A webhook for the pact between Consumer and Provider" }
+
+          context "when provider is specified by a label" do
+            let(:provider) { WebhookPacticipant.new(label: "provider-label")}
+
+            it { is_expected.to eq "A webhook for the pact between Consumer and providers labeled 'provider-label'" }
+          end
+
+          context "when consumer is specified by a label" do
+            let(:consumer) { WebhookPacticipant.new(label: "consumer-label")}
+
+            it { is_expected.to eq "A webhook for the pact between consumers labeled 'consumer-label' and Provider" }
+          end
+
+          context "when both are specified by labels" do
+            let(:consumer) { WebhookPacticipant.new(label: "consumer-label")}
+            let(:provider) { WebhookPacticipant.new(label: "provider-label")}
+
+            it do
+              is_expected.to eq(
+                "A webhook for the pact between consumers labeled 'consumer-label' and providers labeled 'provider-label'"
+              )
+            end
+          end
         end
 
         context "with a consumer only" do
           let(:provider) { nil }
 
           it { is_expected.to eq "A webhook for all pacts with consumer Consumer" }
+
+          context "when specified by a label" do
+            let(:consumer) { WebhookPacticipant.new(label: "consumer-label")}
+
+            it { is_expected.to eq "A webhook for all pacts with consumer labeled 'consumer-label'" }
+          end
         end
 
         context "with a provider only" do
           let(:consumer) { nil }
 
           it { is_expected.to eq "A webhook for all pacts with provider Provider" }
+
+          context "when specified by a label" do
+            let(:provider) { WebhookPacticipant.new(label: "provider-label")}
+
+            it { is_expected.to eq "A webhook for all pacts with provider labeled 'provider-label'" }
+          end
         end
 
         context "with neither a consumer nor a provider" do

data/spec/lib/pact_broker/versions/abbreviate_number_spec.rb

@@ -8,7 +8,8 @@ module PactBroker
           ["202326572516dea6998a7f311fcaa161c0768fc2", "2023265"],
           ["1.2.3+areallyreallyreallylongexplanation", "1.2.3+areallyreallyreallylongexplanation"],
           ["2516dea6998a7f", "2516dea6998a7f"],
-          ["1.2.3+202326572516dea6998a7f311fcaa161c0768fc2", "1.2.3+2023265"]
+          ["1.2.3+202326572516dea6998a7f311fcaa161c0768fc2", "1.2.3+2023265"],
+          ["this-is-very-long-text-this-is-very-long-text-this-is-very-long-text-this-is-very-long-text", "this-is-very-long-text-this-is-very-lon…-long-text"]
         ]
 
         TEST_CASES.each do |(input, output)|

data/spec/support/documentation.rb

@@ -0,0 +1,64 @@
+module PactBroker
+  module Documentation
+
+    def remove_deprecated_links(thing)
+      case thing
+      when Hash then remove_deprecated_links_from_hash(thing)
+      when Array then thing.collect { |value| remove_deprecated_links(value) }
+      else thing
+      end
+    end
+
+    def remove_deprecated_links_from_hash(body)
+      body.each_with_object({}) do | (key, value), new_body |
+        if key == "_links"
+          links = value.select do | link_key, _value |
+            link_key.start_with?("pb:", "self", "next", "previous", "curies")
+          end
+          new_body["_links"] = links
+        else
+          new_body[key] = remove_deprecated_links(value)
+        end
+      end
+    end
+
+    def build_approval_name(category, example_name, http_method)
+      "docs_#{category}_" + example_name.tr(" ", "_") + "_" + http_method
+    end
+
+    def build_path(path_template, parameter_values, custom_parameter_values)
+      parameter_values.merge(custom_parameter_values).inject(path_template) do | new_path, (name, value) |
+        new_path.gsub(/:#{name}(\/|$)/, value + '\1')
+      end
+    end
+
+    def expected_interaction(response, order)
+      expectated_body = response.headers["Content-Type"]&.include?("json") && response.body && response.body != "" ? remove_deprecated_links(JSON.parse(response.body)) : response.body
+      expected_response = {
+        status: response.status,
+        headers: determinate_headers(response.headers),
+        body: expectated_body
+      }
+      request = {
+        method: http_method,
+        path_template: path_template,
+        path: path,
+        headers: rack_env_to_http_headers(rack_headers),
+        body: http_params.is_a?(String) ? JSON.parse(http_params) : nil
+      }.compact
+
+      {
+        category: category,
+        name: pact_broker_example_name,
+        order: order,
+        request: request,
+        response: expected_response
+      }
+    end
+
+  end
+end
+
+RSpec.configure do | config |
+  config.include(PactBroker::Documentation)
+end

data/spec/support/rack_helpers.rb

@@ -7,7 +7,7 @@ module PactBroker
     using PactBroker::StringRefinements
 
     def determinate_headers(headers)
-      headers.without("Date", "Server")
+      headers.without("Date", "Server", "Content-Length")
     end
 
     def rack_env_to_http_headers(rack_env)

data/tasks/development.rake

@@ -18,12 +18,17 @@ task "pact_broker:dev:setup" do
 end
 
 desc "List the Pact Broker API routes"
-task "pact_broker:routes", [:search_term] do | _, args |
-  puts "Listing routes containing the term '#{args[:search_term]}'" if args[:search_term]
+task :'pact_broker:routes', [:search_term] do | _t, args |
+  project_root = File.absolute_path(File.join(__dir__, "..", "..", ".."))
+  $LOAD_PATH << File.join(project_root,"app_shared","lib")
+
+  search_term = args[:search_term]
+  puts "Listing Pact Broker routes containing the term '#{search_term}'" if search_term
   require "tempfile"
   require "sequel"
   require "pact_broker"
   require "pact_broker/project_root"
+  require "pathname"
 
   Tempfile.create("pact_broker_routes") do |f|
     CONNECTION = Sequel.connect({ adapter: "sqlite", database: f.path, encoding: "utf8", sql_log_level: :debug })
@@ -32,20 +37,16 @@ task "pact_broker:routes", [:search_term] do | _, args |
     PactBroker::DB.run_migrations(CONNECTION)
 
     require "pact_broker/api"
+    require "webmachine/describe_routes"
 
-    routes_debugging = PactBroker::API.application.routes.collect do | route |
-      ["/" + route.path_spec.collect{ |part| part.is_a?(Symbol) ? ":#{part}" : part  }.join("/"), route.resource]
-    end
-
-    if args[:search_term]
-      routes_debugging = routes_debugging.select{ |(route, _)| route.include?(args[:search_term]) }
-    end
+    routes = Webmachine::DescribeRoutes.call([PactBroker::API.application], search_term: search_term)
 
-    routes_debugging.sort_by(&:first).each do | (path, resource_class) |
+    routes.each do | route |
       puts ""
-      puts "#{path}"
-      puts "      class: #{resource_class}"
-      puts "      location: #{resource_class.instance_method(:allowed_methods).source_location.first.gsub(PactBroker.project_root.to_s + "/", "")}"
+      puts "#{route[:path]}"
+      puts "      allowed_methods: #{route[:allowed_methods].join(", ")}"
+      puts "      class: #{route[:resource_class]}"
+      puts "            location: #{route[:resource_class_location]}"
     end
   end
 end