pact_broker 2.76.2 → 2.79.1

data/public/javascripts/clipboard.js

@@ -24,9 +24,15 @@ function initializeClipper(selector) {
     .children(".clippy")
     .click(function() {
       const clippyButton = $(this);
-      const text = $.trim(clippyButton.closest(selector).text());
+      const clipTarget = clippyButton.closest(selector);
+      let text = null;
+      if(clipTarget.data('clippable')) {
+        text = clipTarget.data('clippable');
+      } else {
+        text = clippyButton.closest(selector).text();
+      }
+      copyToClipboard($.trim(text));
 
-      copyToClipboard(text);
       flashClipped(clippyButton);
     });
 }

data/public/stylesheets/index.css

@@ -52,7 +52,10 @@ body { padding-top: 10px; }
   word-wrap: break-word;
 }
 
-.consumer-version-number, .provider-version-number {
+.consumer-version,
+.provider-version,
+.consumer-version-number,
+.provider-version-number {
   word-wrap: break-word;
 }
 
@@ -207,4 +210,25 @@ span.warning-icon {
   padding-bottom: 9px;
   margin: 40px 0 20px;
   border-bottom: 1px solid #eee;
-}
+}
+
+span.copy-icon {
+  background-image: url('/images/copy.svg');
+  background-size: 16px 16px;
+  background-repeat: no-repeat;
+  display:block;
+  position: relative;
+  width: 16px;
+  height: 16px;
+  cursor: pointer;
+}
+
+span.copy-success-icon {
+  background-image: url('/images/check.svg');
+  background-size: 16px 16px;
+  background-repeat: no-repeat;
+  display:block;
+  position: relative;
+  width: 16px;
+  height: 16px;
+}

data/public/stylesheets/matrix.css

@@ -70,24 +70,3 @@ img.pact_badge {
   display: flex;
   justify-content: flex-start;
 }
-
-span.copy-icon {
-  background-image: url('/images/copy.svg');
-  background-size: 16px 16px;
-  background-repeat: no-repeat;
-  display:block;
-  position: relative;
-  width: 16px;
-  height: 16px;
-  cursor: pointer;
-}
-
-span.copy-success-icon {
-  background-image: url('/images/check.svg');
-  background-size: 16px 16px;
-  background-repeat: no-repeat;
-  display:block;
-  position: relative;
-  width: 16px;
-  height: 16px;
-}

data/regression/can_i_deploy_spec.rb

@@ -1,9 +1,10 @@
-PACTICIPANT_LIMIT = 2
-VERSION_LIMIT = 1
+require 'pact_broker/domain'
+PACTICIPANT_LIMIT = 10
+VERSION_LIMIT = 10
 
-PACTICIPANTS = PactBroker::Domain::Pacticipant.order(:id).limit(PACTICIPANT_LIMIT).all
+PACTICIPANTS = PactBroker::Domain::Pacticipant.order(Sequel.desc(:id)).limit(PACTICIPANT_LIMIT).all
 
-RSpec.describe "regression tests", no_db_clean: true, regression: true do
+RSpec.describe "regression tests" do
 
   def can_i_deploy(pacticipant_name, version_number, to_tag)
     get("/can-i-deploy", { pacticipant: pacticipant_name, version: version_number, to: to_tag }, { "HTTP_ACCEPT" => "application/hal+json" })

data/regression/index_spec.rb

@@ -0,0 +1,26 @@
+require 'pact_broker/domain'
+require 'pact_broker/policies'
+require 'pact_broker/ui/app'
+
+RSpec.describe "regression tests for index page" do
+  context "HTML" do
+    let(:app) { PactBroker::UI::App.new }
+
+    it "has the same response without tags" do
+      response = get("/", nil, { "HTTP_ACCEPT" => "text/html" } )
+      Approvals.verify(response.body, :name => "index_html", format: :html)
+    end
+
+    it "has the same response with tags" do
+      response = get("/", { "tags" => "true", "pageNumber" => "1", "pageSize" => "100"}, { "HTTP_ACCEPT" => "text/html" } )
+      Approvals.verify(response.body, :name => "index_html_with_tags", format: :html)
+    end
+  end
+
+  context "JSON" do
+    it "has the same response" do
+      response = get("/dashboard", { "HTTP_ACCEPT" => "application/hal+json" } )
+      Approvals.verify(JSON.parse(response.body), :name => "index_json", format: :json)
+    end
+  end
+end

data/regression/regression_helper.rb

@@ -1,10 +1,19 @@
-ENV['DATABASE_ADAPTER'] = 'docker_postgres'
-ENV['RACK_ENV'] = 'development'
+raise "Must set INSTALL_PG=true" unless ENV["INSTALL_PG"] == "true"
+raise "Must set DATABASE_ADAPTER=docker_postgres" unless ENV["DATABASE_ADAPTER"] == "docker_postgres"
+raise "Must set RACK_ENV=development" unless ENV["RACK_ENV"] == "development"
 
-require 'db'
+$LOAD_PATH  << "."
+
+require 'sequel'
+
+load 'lib/db.rb'
 require 'tasks/database'
 require 'pact_broker/db'
 PactBroker::DB.connection = PactBroker::Database.database = DB::PACT_BROKER_DB
+PactBroker::DB::Migrate.call(PactBroker::DB.connection)
+require 'approvals'
+require 'rack/test'
+require 'pact_broker/api'
 
 Approvals.configure do |c|
   c.approvals_path = 'regression/fixtures/approvals/'
@@ -25,10 +34,27 @@ RSpec.configure do | config |
 
   config.example_status_persistence_file_path = "./regression/.examples.txt"
   config.filter_run_excluding skip: true
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
 
   def app
     PactBroker::API
   end
+
+  config.after(:each) do | example, something |
+    if ENV["SHOW_REGRESSION_DIFF"] == "true"
+      if example.exception.is_a?(Approvals::ApprovalError)
+        require "pact/support"
+        parts = example.exception.message.split('"')
+        received_file = parts[1]
+        approved_file = parts[3]
+        received_hash = JSON.parse(File.read(received_file))
+        approved_hash = JSON.parse(File.read(approved_file))
+        diff = Pact::Matchers.diff(approved_hash, received_hash)
+        puts Pact::Matchers::UnixDiffFormatter.call(diff)
+      end
+    end
+  end
 end
 
 if ENV["DEBUG"] == "true"

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