pact_broker 2.89.1 → 2.90.0

data/spec/integration/webhooks/certificate_spec.rb

@@ -1,47 +0,0 @@
-require "pact_broker/domain/webhook_request"
-require "faraday"
-# certificates and key generated by script/generate-certificates-for-webooks-certificate-spec.rb
-
-describe "executing a webhook to a server with a self signed certificate" do
-  def wait_for_server_to_start
-    Faraday.new(url: "https://localhost:4444", ssl: {verify: false}) do |builder|
-      builder.request :retry, max: 20, interval: 0.5, exceptions: [StandardError]
-      builder.adapter :net_http
-    end.get
-  end
-
-  before(:all) do
-    @pipe = IO.popen("bundle exec ruby spec/support/ssl_webhook_server.rb")
-    wait_for_server_to_start
-  end
-
-  let(:td) { TestDataBuilder.new }
-  let(:webhook_request) do
-    PactBroker::Domain::WebhookRequest.new(
-      method: "get",
-      url: "https://localhost:4444/")
-  end
-
-  subject { webhook_request.execute }
-
-  context "without the correct cacert" do
-    it "fails" do
-      expect { subject }.to raise_error(OpenSSL::SSL::SSLError)
-    end
-  end
-
-  context "with the correct cacert" do
-    let!(:certificate) do
-      td.create_certificate(path: "spec/fixtures/certificates/cacert.pem")
-    end
-
-    it "succeeds" do
-      puts subject.body unless subject.code == "200"
-      expect(subject.code).to eq "200"
-    end
-  end
-
-  after(:all) do
-    Process.kill "KILL", @pipe.pid
-  end
-end

data/spec/integration/webhooks/contract_publication_spec.rb

@@ -1,68 +0,0 @@
-RSpec.describe "triggering a webhook for a contract publication" do
-  before do
-    td.create_global_webhook(event_names: ["contract_published"], body: webhook_body_template)
-  end
-
-  let(:webhook_body_template) do
-    {
-      "consumer_version_number" => "${pactbroker.consumerVersionNumber}",
-      "consumer_version_branch" => "${pactbroker.consumerVersionBranch}",
-      "build_url" => "${pactbroker.buildUrl}",
-      "consumer_version_tags" => "${pactbroker.consumerVersionTags}",
-    }
-  end
-
-  let(:expected_webhook_body) do
-    {
-      consumer_version_number: "1",
-      consumer_version_branch: "main",
-      consumer_version_tags: "a, b",
-      build_url: "http://ci/builds/1234"
-    }
-  end
-
-  let(:request_body_hash) do
-    {
-      :pacticipantName => "Foo",
-      :pacticipantVersionNumber => "1",
-      :branch => "main",
-      :tags => ["a", "b"],
-      :buildUrl => "http://ci/builds/1234",
-      :contracts => [
-        {
-          :consumerName => "Foo",
-          :providerName => "Bar",
-          :specification => "pact",
-          :contentType => "application/json",
-          :content => encoded_contract
-        }
-      ]
-    }
-  end
-
-  let(:rack_headers) do
-    {
-      "CONTENT_TYPE" => "application/json",
-      "HTTP_ACCEPT" => "application/hal+json",
-      "pactbroker.database_connector" => database_connector}
-  end
-
-  let(:contract) { { consumer: { name: "Foo" }, provider: { name: "Bar" }, interactions: [] }.to_json }
-  let(:encoded_contract) { Base64.strict_encode64(contract) }
-  let(:path) { "/contracts/publish" }
-
-  let!(:request) do
-    stub_request(:post, /http/).to_return(:status => 200)
-  end
-
-  subject { post(path, request_body_hash.to_json, rack_headers) }
-
-  let(:database_connector) { ->(&block) { block.call } }
-
-  it { is_expected.to be_a_hal_json_success_response }
-
-  it "passes through the correct parameters to the webhook" do
-    subject
-    expect(a_request(:post, /http/).with(body: expected_webhook_body)).to have_been_made
-  end
-end

data/spec/integration/webhooks/contract_requiring_verification_published_spec.rb

@@ -1,67 +0,0 @@
-RSpec.describe "triggering a contract_requiring_verification_published webhook for a contract publication" do
-  before do
-    td.create_global_webhook(event_names: ["contract_requiring_verification_published"], body: webhook_body_template)
-      .create_environment("test")
-      .create_provider("Bar", main_branch: "main")
-      .create_provider_version("1", branch: "main")
-  end
-
-  let(:webhook_body_template) do
-    {
-      "provider_version_number" => "${pactbroker.providerVersionNumber}",
-      "provider_version_descriptions" => "${pactbroker.providerVersionDescriptions}"
-    }
-  end
-
-  let(:expected_webhook_body) do
-    {
-      provider_version_number: "1",
-      provider_version_descriptions: a_kind_of(String)
-    }
-  end
-
-  let(:request_body_hash) do
-    {
-      :pacticipantName => "Foo",
-      :pacticipantVersionNumber => "1",
-      :branch => "main",
-      :tags => ["a", "b"],
-      :buildUrl => "http://ci/builds/1234",
-      :contracts => [
-        {
-          :consumerName => "Foo",
-          :providerName => "Bar",
-          :specification => "pact",
-          :contentType => "application/json",
-          :content => encoded_contract
-        }
-      ]
-    }
-  end
-
-  let(:rack_headers) do
-    {
-      "CONTENT_TYPE" => "application/json",
-      "HTTP_ACCEPT" => "application/hal+json",
-      "pactbroker.database_connector" => database_connector}
-  end
-
-  let(:contract) { { consumer: { name: "Foo" }, provider: { name: "Bar" }, interactions: [] }.to_json }
-  let(:encoded_contract) { Base64.strict_encode64(contract) }
-  let(:path) { "/contracts/publish" }
-
-  let!(:request) do
-    stub_request(:post, /http/).to_return(:status => 200)
-  end
-
-  subject { post(path, request_body_hash.to_json, rack_headers) }
-
-  let(:database_connector) { ->(&block) { block.call } }
-
-  it { is_expected.to be_a_hal_json_success_response }
-
-  it "passes through the correct parameters to the webhook" do
-    subject
-    expect(a_request(:post, /http/).with(body: expected_webhook_body)).to have_been_made
-  end
-end

data/spec/integration/webhooks/pact_publication_spec.rb

@@ -1,51 +0,0 @@
-RSpec.describe "triggering a webhook for a pact publication" do
-  before do
-    td.create_global_webhook(event_names: ["contract_published"], body: { "provider_version" => "${pactbroker.providerVersionNumber}"})
-  end
-
-  let(:pact_content) { td.random_json_content("Foo", "Bar") }
-
-  let!(:request) do
-    stub_request(:post, /http/).with(body: expected_webhook_body).to_return(:status => 200)
-  end
-
-  let(:database_connector) { ->(&block) { block.call } }
-
-  subject { put("/pacts/provider/Bar/consumer/Foo/version/2", pact_content, { "CONTENT_TYPE" => "application/json", "pactbroker.database_connector" => database_connector }) }
-
-  context "when there is a verification from the main branch of the provider" do
-    before do
-      td.create_consumer("Foo")
-        .create_provider("Bar", main_branch: "main")
-        .create_consumer_version("1")
-        .create_pact(json_content: pact_content)
-        .create_verification(provider_version: "1", branch: "main")
-        .create_verification(provider_version: "2", branch: "feat/x", number: 2)
-    end
-
-    let(:expected_webhook_body) { { provider_version: "1"}.to_json }
-
-    it "uses that in the webhook" do
-      subject
-      expect(request).to have_been_made
-    end
-  end
-
-  context "when there is not a verification from the main branch of the provider" do
-    before do
-      td.create_consumer("Foo")
-        .create_provider("Bar", main_branch: "main")
-        .create_consumer_version("1")
-        .create_pact(json_content: pact_content)
-        .create_verification(provider_version: "1", branch: "feat/y")
-        .create_verification(provider_version: "2", branch: "feat/x", number: 2)
-    end
-
-    let(:expected_webhook_body) { { provider_version: "2"}.to_json }
-
-    it "uses the latest verification in the webhook" do
-      subject
-      expect(request).to have_been_made
-    end
-  end
-end

data/spec/integration/webhooks_documentation_spec.rb

@@ -1,348 +0,0 @@
-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/generator_spec.rb

@@ -1,80 +0,0 @@
-require "pact/doc/generator"
-require "fileutils"
-
-module Pact
-  module Doc
-    describe Generator do
-
-      let(:doc_dir) { "./tmp/doc" }
-      let(:pact_dir) { "./tmp/pacts" }
-      let(:file_name) { "Some Consumer - Some Provider#{file_extension}" }
-      let(:consumer_contract_renderer) { double("ConsumerContractRenderer", :call => doc_content) }
-      let(:doc_content) { "doc_content" }
-      let(:index_content) { "index_content" }
-      let(:expected_doc_path) { "#{doc_dir}/#{doc_type}/#{file_name}" }
-      let(:expected_index_path) { "#{doc_dir}/#{doc_type}/#{index_name}#{file_extension}" }
-      let(:doc_type) { "markdown" }
-      let(:file_extension) { ".md" }
-      let(:actual_file_contents) { File.read(expected_doc_path) }
-      let(:actual_index_contents) { File.read(expected_index_path)}
-      let(:index_renderer) { double("IndexRenderer", :call => index_content)}
-      let(:index_name) { "README" }
-      let(:after_hook) { double("hook", :call => nil)}
-
-      before do
-        FileUtils.rm_rf doc_dir
-        FileUtils.rm_rf pact_dir
-        FileUtils.mkdir_p doc_dir
-        FileUtils.mkdir_p pact_dir
-        FileUtils.cp "./spec/support/markdown_pact.json", pact_dir
-      end
-
-      let(:options) { { consumer_contract_renderer: consumer_contract_renderer, doc_type: doc_type, file_extension: file_extension, index_renderer: index_renderer, index_name: index_name } }
-
-      subject { Generator.new(pact_dir, doc_dir, options) }
-
-      context "when there are existing files" do
-        let(:existing_doc_file_path) { File.join(doc_dir, doc_type, "leftover") }
-
-        before do
-          FileUtils.mkdir_p File.dirname(existing_doc_file_path)
-          FileUtils.touch existing_doc_file_path
-        end
-
-        it "clears the existing files" do
-          expect(File.exist?(existing_doc_file_path)).to be true
-          subject.call
-          expect(File.exist?(existing_doc_file_path)).to be false
-        end
-      end
-
-      it "creates an index" do
-        expect(index_renderer).to receive(:call).with("Some Consumer", {"Some Provider"=>"Some Consumer - Some Provider.md"})
-        subject.call
-        expect(actual_index_contents).to eq(index_content)
-      end
-
-      it "creates documentation" do
-        subject.call
-        expect(actual_file_contents).to eq(doc_content)
-      end
-
-      context "with an after hook specified" do
-
-        subject { Generator.new(pact_dir, doc_dir, options.merge(:after => after_hook)) }
-
-        it "executes the hook" do
-          expect(after_hook).to receive(:call).with(pact_dir, "#{doc_dir}/#{doc_type}", instance_of(Array))
-          subject.call
-        end
-
-        it "passes in the consumer_contracts" do
-          expect(after_hook).to receive(:call) do | _, _, consumer_contracts |
-            expect(consumer_contracts.first).to be_instance_of(Pact::ConsumerContract)
-          end
-          subject.call
-        end
-      end
-    end
-  end
-end