pact_broker 2.76.0 → 2.78.1

data/regression/script/clear.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+rm regression/fixtures/approvals/*

data/regression/script/run.sh

@@ -0,0 +1,3 @@
+#/bin/sh
+
+REGRESSION=true INSTALL_PG=true DATABASE_ADAPTER=docker_postgres RACK_ENV=development bundle exec rake regression

data/script/demonstrate-version-branches.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+begin
+
+  $LOAD_PATH << "#{Dir.pwd}/lib"
+  require 'pact_broker/test/http_test_data_builder'
+  base_url = ENV['PACT_BROKER_BASE_URL'] || 'http://localhost:9292'
+
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
+  td.delete_integration(consumer: "Foo", provider: "Bar")
+    .delete_integration(consumer: "foo-consumer", provider: "bar-provider")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "1", provider: "bar-provider", content_id: "111", branch: "main")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "2", provider: "bar-provider", content_id: "222", tag: "feat/x")
+    .get_pacts_for_verification(
+      enable_pending: true,
+      provider_version_branch: "main",
+      provider_version_tag: "dev",
+      include_wip_pacts_since: "2020-01-01",
+      consumer_version_selectors: [{ branch: "main", latest: true }])
+    .verify_pact(
+      index: 0,
+      provider_version: "1",
+      success: true
+    )
+    .can_i_deploy(pacticipant: "bar-provider", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "bar-provider", version: "1")
+    .can_i_deploy(pacticipant: "foo-consumer", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "foo-consumer", version: "1")
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end

data/script/pry.rb

@@ -19,7 +19,7 @@ connection.timezone = :utc
 require 'pact_broker/db'
 require 'pact_broker'
 require 'support/test_data_builder'
-puts "bout to pry"
+puts "about to pry"
 
 require 'pry'; pry(binding);
-puts "fater pry"
+puts "after pry"

data/script/reproduce-issue-starting-up.rb

@@ -1,43 +1,33 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << "#{Dir.pwd}/lib"
-
 begin
 
+  $LOAD_PATH << "#{Dir.pwd}/lib"
   require 'pact_broker/test/http_test_data_builder'
   base_url = ENV['PACT_BROKER_BASE_URL'] || 'http://localhost:9292'
 
-  td = PactBroker::Test::HttpTestDataBuilder.new(base_url, { })
-  td.delete_integration(consumer: "MyConsumer", provider: "MyProvider")
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .publish_pact(consumer: "MyConsumer", consumer_version: "1", provider: "MyProvider", content_id: "111", tag: "feature/a")
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
+  td.delete_integration(consumer: "Foo", provider: "Bar")
+    .delete_integration(consumer: "foo-consumer", provider: "bar-provider")
+    .create_pacticipant("foo-consumer")
+    .create_pacticipant("foo-provider")
+    .create_global_webhook_for_verification_published(uuid: "ba8feb17-558a-4b3f-a078-f52c6fafd014", url: "http://webhook-server:9393")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "1", provider: "bar-provider", content_id: "111", tag: "main")
+    .publish_pact(consumer: "foo-consumer", consumer_version: "2", provider: "bar-provider", content_id: "111", tag: ["feat/x", "feat/y"])
+    .sleep(10)
     .get_pacts_for_verification(
-      enable_pending: true,
       provider_version_tag: "main",
-      include_wip_pacts_since: "2020-01-01",
-      consumer_version_selectors: [{ tag: "main", latest: true }])
+      consumer_version_selectors: [{ tag: "main", latest: true }, { tag: "feat/x", latest: true }, { tag: "feat/y", latest: true }])
     .verify_pact(
       index: 0,
       provider_version_tag: "main",
       provider_version: "1",
-      success: false
+      success: true
     )
-    .get_pacts_for_verification(
-      enable_pending: true,
-      provider_version_tag: "main",
-      include_wip_pacts_since: "2020-01-01",
-      consumer_version_selectors: [{ tag: "main", latest: true }])
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .deploy_to_prod(pacticipant: "MyProvider", version: "1")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .deploy_to_prod(pacticipant: "MyConsumer", version: "1")
+
 
 rescue StandardError => e
   puts "#{e.class} #{e.message}"
   puts e.backtrace
   exit 1
 end
-

data/script/reproduce-issue.rb

@@ -6,7 +6,8 @@ begin
   base_url = ENV['PACT_BROKER_BASE_URL'] || 'http://localhost:9292'
 
   td = PactBroker::Test::HttpTestDataBuilder.new(base_url)
-  td.delete_integration(consumer: "foo-consumer", provider: "bar-provider")
+  td.delete_integration(consumer: "Foo", provider: "Bar")
+    .delete_integration(consumer: "foo-consumer", provider: "bar-provider")
     .publish_pact(consumer: "foo-consumer", consumer_version: "1", provider: "bar-provider", content_id: "111", tag: "main")
     .get_pacts_for_verification(
       enable_pending: true,

data/script/trigger-release.sh

@@ -19,7 +19,7 @@ output=$(curl -v https://api.github.com/repos/${repository_slug}/dispatches \
       -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
       -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
 
-if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
+if  ! echo "${output}" | grep "HTTP\/.* 204" > /dev/null; then
   echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
   echo "Failed to trigger release"
   exit 1

data/script/webhook-server.ru

@@ -1,10 +1,10 @@
 require 'rack/utils'
+STDOUT.sync = true
+puts "Starting webhook server"
 
-count = 0
 run -> (env) {
-  count += 1
-  status = (count % 3 == 0) ? 200 : 500
-  puts Rack::Utils.parse_nested_query(env['QUERY_STRING'])
+  status = 200
+  puts Rack::Utils.parse_nested_query(env['QUERY_STRING']) if env['QUERY_STRING'] && env['QUERY_STRING'] != ''
   puts env['rack.input'].read
-  [status, {}, ["Hello. This might be an error.\n"]]
+  [status, {"Content-Type" => "text/plain"}, ["Webhook response.\n"]]
 }

data/spec/features/create_environment_spec.rb

@@ -0,0 +1,47 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Creating an environment" do
+  let(:path) { PactBroker::Api::PactBrokerUrls.environments_url }
+  let(:headers) { { "CONTENT_TYPE" => "application/json" } }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+  let(:environment_hash) do
+    {
+      name: "test",
+      displayName: "Test",
+      production: false,
+      contacts: [
+        { name: "Team Awesome", details: { email: "foo@bar.com", arbitraryThing: "thing" } }
+      ]
+    }
+  end
+
+  subject { post(path, environment_hash.to_json, headers) }
+
+  it "returns a 201 response" do
+    expect(subject.status).to be 201
+  end
+
+  it "returns the Location header" do
+    expect(subject.headers["Location"]).to eq PactBroker::Api::PactBrokerUrls.environment_url(PactBroker::Deployments::Environment.order(:id).last, "http://example.org")
+  end
+
+  it "returns a JSON Content Type" do
+    expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
+  end
+
+  it "returns the newly created environment" do
+    expect(response_body).to include environment_hash.merge(name: "test")
+    expect(response_body[:uuid]).to_not be nil
+  end
+
+  context "with invalid params" do
+    before do
+      td.create_environment("test")
+    end
+
+    it "returns a 400 response" do
+      expect(subject.status).to be 400
+      expect(response_body[:errors]).to_not be nil
+    end
+  end
+end

data/spec/features/create_tag_spec.rb

@@ -0,0 +1,32 @@
+describe "Creating a tag" do
+  let(:path) { "/pacticipants/Foo/versions/1234/tags/foo" }
+  let(:headers) { { 'CONTENT_TYPE' => 'application/json' } }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+
+  subject { put(path, {}, headers) }
+
+  it "returns a 201 response" do
+    expect(subject.status).to be 201
+  end
+
+  it "returns a HAL JSON Content Type" do
+    expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+  end
+
+  it "returns the newly created tag" do
+    expect(response_body).to include name: "foo"
+  end
+
+  context "when the tag already exists" do
+    before do
+      td.subtract_day
+        .create_consumer("Foo")
+        .create_consumer_version("1234")
+        .create_consumer_version_tag("foo")
+    end
+
+    it "returns a 200 response" do
+      expect(subject.status).to be 200
+    end
+  end
+end

data/spec/features/create_version_spec.rb

@@ -0,0 +1,70 @@
+describe "Creating a pacticipant version" do
+  let(:path) { "/pacticipants/Foo/versions/1234" }
+  let(:headers) { { 'CONTENT_TYPE' => 'application/json' } }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+  let(:version_hash) do
+    {
+      branch: "main",
+      buildUrl: "http://build",
+      tags: [{ name: "foo" }, { name: "bar" }]
+    }
+  end
+
+  subject { put(path, version_hash.to_json, headers) }
+
+  it "returns a 201 response" do
+    expect(subject.status).to be 201
+  end
+
+  it "returns a HAL JSON Content Type" do
+    expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+  end
+
+  it "returns the newly created version" do
+    expect(response_body).to include branch: "main", buildUrl: "http://build"
+    expect(response_body[:_embedded][:tags].size).to eq 2
+  end
+
+  it "creates the specified tags" do
+    expect { subject }.to change { PactBroker::Domain::Tag.count }.by(2)
+  end
+
+  context "when the version already exists" do
+    before do
+      td.subtract_day
+        .create_consumer("Foo")
+        .create_consumer_version("1234", branch: "original-branch", build_url: "original-build-url")
+        .create_consumer_version_tag("dev")
+    end
+
+    let(:version_hash) { { branch: "new-branch" } }
+
+    it "returns a 200" do
+      expect(subject.status).to be 200
+    end
+
+    it "overwrites the direct properties" do
+      expect(response_body[:branch]).to eq "new-branch"
+      expect(response_body).to_not have_key(:buildUrl)
+    end
+
+    context "when not tags are specified" do
+      it "does not change the tags" do
+        expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").tags }
+      end
+    end
+
+    context "when tags are specified" do
+      let(:version_hash) { { branch: "new-branch", tags: [ { name: "main" }] } }
+
+      it "overwrites the tags" do
+        expect(response_body[:_embedded][:tags].size).to eq 1
+        expect(response_body[:_embedded][:tags].first[:name]).to eq "main"
+      end
+    end
+
+    it "does not change the created date" do
+      expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").created_at }
+    end
+  end
+end

data/spec/features/delete_environment_spec.rb

@@ -0,0 +1,16 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Deleting an environment" do
+  before do
+    td.create_environment("test", uuid: "1234")
+  end
+
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+
+  subject { delete(path, nil) }
+
+  it "returns a 204 response" do
+    subject
+    expect(last_response.status).to be 204
+  end
+end

data/spec/features/end_deployment_spec.rb

@@ -0,0 +1,29 @@
+#
+# RPC style seems cleaner than REST here, as setting the endedAt parameter directly
+# seems likely to end in Timezone tears
+# This endpoint would be called by the pact broker client during `record-deployment` if the
+# --end-previous-deployment (on by default) was specified.
+# This allows us to know exactly what is deployed to a particular environment at a given time,
+# (eg. /environments/test/deployments/current)
+# and provides first class support for mobile clients that have multiple versions in prod
+# at once.
+
+describe "Record deployment ended", skip: "Not yet implemented" do
+  before do
+    td.create_environment("test")
+      .create_pacticipant("Foo")
+      .create_pacticipant_version("1")
+      .create_deployment("test")
+  end
+  let(:path) { "/pacticipants/Foo/deployments/test/latest/end" }
+  let(:headers) { {} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true) }
+
+  subject { post(path, nil, headers) }
+
+  it { is_expected.be_a_hal_json_success_response }
+
+  it "returns the updated deployment" do
+    expect(subject[:endedAt]).to_not be nil
+  end
+end

data/spec/features/get_environment_spec.rb

@@ -0,0 +1,19 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Get an environment" do
+  before do
+    td.create_environment("test", display_name: "Test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+  let(:headers) { {'HTTP_ACCEPT' => 'application/hal+json'} }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+
+  subject { get(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the environment" do
+    expect(response_body[:uuid]).to eq "1234"
+    expect(response_body[:name]).to eq "test"
+  end
+end

data/spec/features/get_environments_spec.rb

@@ -0,0 +1,20 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Get all environments" do
+  before do
+    td.create_environment("test", display_name: "Test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+      .create_environment("prod", display_name: "Production", uuid: "5678", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environments_url }
+  let(:headers) { {'HTTP_ACCEPT' => 'application/hal+json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { get(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the environments" do
+    subject
+    expect(response_body[:_embedded][:environments].size).to be 2
+  end
+end

data/spec/features/record_deployment_spec.rb

@@ -0,0 +1,28 @@
+#
+# pact-broker record-deployment --pacticipant Foo --version 1 --environment test --end-previous-deployment
+#
+
+describe "Record deployment", skip: "Not yet implemented" do
+  before do
+    td.create_environment("test")
+      .create_pacticipant("Foo")
+      .create_pacticipant_version("1")
+  end
+  let(:path) { "/pacticipants/Foo/versions/1/deployments/test" }
+  let(:headers) { {"CONTENT_TYPE" => "application/json"} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { post(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_created_response }
+
+  it "returns the Location header" do
+    subject
+    expect(last_response.headers["Location"]).to eq "http://example.org/deployments/123456"
+  end
+
+  it "returns the newly created deployment" do
+    subject
+    expect(response_body).to include_key(:createdAt)
+  end
+end

data/spec/features/update_environment_spec.rb

@@ -0,0 +1,44 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Updating an environment" do
+  before do
+    td.create_environment("test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+  let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:environment_hash) do
+    {
+      name: "test",
+      production: false,
+      displayName: "Testing"
+    }
+  end
+
+  subject { put(path, environment_hash.to_json, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the updated environment" do
+    subject
+    expect(response_body[:displayName]).to eq "Testing"
+    expect(response_body[:contacts]).to be nil
+  end
+
+  context "when the environment doesn't exist" do
+    let(:path) { "/environments/5678" }
+
+    it "returns a 404" do
+      expect(subject.status).to eq 404
+    end
+  end
+
+  context "with invalid params" do
+    let(:environment_hash) { {} }
+
+    it "returns a 400 response" do
+      expect(subject.status).to be 400
+      expect(response_body[:errors]).to_not be nil
+    end
+  end
+end