pact_broker 2.2.0 → 2.3.0

data/lib/pact_broker/verifications/repository.rb

@@ -23,7 +23,7 @@ module PactBroker
           .consumer(consumer_name)
           .provider(provider_name)
           .pact_version_sha(pact_version_sha)
-          .verification_number(verification_number).first
+          .verification_number(verification_number).single_record
       end
 
       def find_latest_verifications_for_consumer_version consumer_name, consumer_version_number
@@ -37,13 +37,17 @@ module PactBroker
           .all
       end
 
-      def find_latest_verification_for consumer_name, provider_name
+      def find_latest_verification_for consumer_name, provider_name, tag = nil
         query = LatestVerificationsByConsumerVersion
           .join(:all_pact_publications, pact_version_id: :pact_version_id)
           .consumer(consumer_name)
           .provider(provider_name)
-          .latest
-          query.first
+        if tag == :untagged
+          query = query.untagged
+        elsif tag
+          query = query.tag(tag)
+        end
+        query.latest.single_record
       end
 
       def pact_version_id_for pact

data/lib/pact_broker/verifications/service.rb

@@ -38,8 +38,8 @@ module PactBroker
         verification_repository.find_latest_verifications_for_consumer_version params[:consumer_name], params[:consumer_version_number]
       end
 
-      def find_latest_verification_for consumer, provider
-        verification_repository.find_latest_verification_for consumer.name, provider.name
+      def find_latest_verification_for consumer, provider, tag = nil
+        verification_repository.find_latest_verification_for consumer.name, provider.name, tag
       end
 
       def verification_summary_for_consumer_version params

data/lib/pact_broker/verifications/verification_status.rb

@@ -0,0 +1,47 @@
+module PactBroker
+
+  module Verifications
+
+    class Status
+
+      def initialize latest_pact, latest_verification
+        @latest_pact = latest_pact
+        @latest_verification = latest_verification
+      end
+
+      def to_s
+        to_sym.to_s
+      end
+
+      def to_sym
+        return :never unless latest_pact
+        return :never unless ever_verified?
+        if latest_verification_successful?
+          if pact_changed_since_last_verification?
+            :stale
+          else
+            :success
+          end
+        else
+          :failed
+        end
+      end
+
+      private
+
+      attr_reader :latest_pact, :latest_verification
+
+      def latest_verification_successful?
+        latest_verification.success
+      end
+
+      def pact_changed_since_last_verification?
+        latest_verification.pact_version_sha != latest_pact.pact_version_sha
+      end
+
+      def ever_verified?
+        !!latest_verification
+      end
+    end
+  end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/lib/rack/pact_broker/convert_file_extension_to_accept_header.rb

@@ -7,7 +7,7 @@ module Rack
 
     class ConvertFileExtensionToAcceptHeader
 
-      EXTENSIONS = {".csv" => "text/csv"}
+      EXTENSIONS = {".csv" => "text/csv", ".svg" => "image/svg+xml"}
       EXTENSION_REGEXP = /\.\w+$/
 
       def initialize app

data/public/images/pact-changed-orange.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="94" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="94" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#fe7d37" d="M33 0h61v20H33z"/><path fill="url(#b)" d="M0 0h94v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="16.5" y="15" fill="#010101" fill-opacity=".3">pact</text><text x="16.5" y="14">pact</text><text x="62.5" y="15" fill="#010101" fill-opacity=".3">changed</text><text x="62.5" y="14">changed</text></g></svg>

data/public/images/pact-failed-red.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="72" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="72" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#e05d44" d="M33 0h39v20H33z"/><path fill="url(#b)" d="M0 0h72v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="16.5" y="15" fill="#010101" fill-opacity=".3">pact</text><text x="16.5" y="14">pact</text><text x="51.5" y="15" fill="#010101" fill-opacity=".3">failed</text><text x="51.5" y="14">failed</text></g></svg>

data/public/images/pact-unknown-lightgrey.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="94" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="94" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#9f9f9f" d="M33 0h61v20H33z"/><path fill="url(#b)" d="M0 0h94v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="16.5" y="15" fill="#010101" fill-opacity=".3">pact</text><text x="16.5" y="14">pact</text><text x="62.5" y="15" fill="#010101" fill-opacity=".3">unknown</text><text x="62.5" y="14">unknown</text></g></svg>

data/public/images/pact-verified-brightgreen.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="84" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="84" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h33v20H0z"/><path fill="#4c1" d="M33 0h51v20H33z"/><path fill="url(#b)" d="M0 0h84v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="16.5" y="15" fill="#010101" fill-opacity=".3">pact</text><text x="16.5" y="14">pact</text><text x="57.5" y="15" fill="#010101" fill-opacity=".3">verified</text><text x="57.5" y="14">verified</text></g></svg>

data/public/images/pact_not_found-unknown-lightgrey.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="152" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="152" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h91v20H0z"/><path fill="#9f9f9f" d="M91 0h61v20H91z"/><path fill="url(#b)" d="M0 0h152v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="45.5" y="15" fill="#010101" fill-opacity=".3">pact not found</text><text x="45.5" y="14">pact not found</text><text x="120.5" y="15" fill="#010101" fill-opacity=".3">unknown</text><text x="120.5" y="14">unknown</text></g></svg>

data/spec/features/get_latest_pact_badge_spec.rb

@@ -0,0 +1,53 @@
+require 'webmock/rspec'
+
+describe "get latest pact badge" do
+
+  before do
+    PactBroker.configuration.enable_badge_resources = true
+    TestDataBuilder.new
+      .create_consumer('consumer')
+      .create_provider('provider')
+      .create_consumer_version('1.2.3')
+      .create_pact
+      .create_verification
+  end
+
+  let!(:http_request) do
+    stub_request(:get, /http/).to_return(:status => 200, :body => "<svg/>")
+  end
+
+  let(:path) { "/pacts/provider/provider/consumer/consumer/latest/badge" }
+
+  # In the full app, the .svg extension is turned into an Accept header
+  # by ConvertFileExtensionToAcceptHeader
+
+  subject { get path, nil, {'HTTP_ACCEPT' => "image/svg+xml"}; last_response  }
+
+  it "returns a 200 status" do
+    expect(subject.status).to eq 200
+  end
+
+  it "returns an svg/xml response" do
+    expect(subject.headers['Content-Type']).to include("image/svg+xml")
+  end
+
+  it "returns an svg body" do
+    expect(subject.body).to include "<svg/>"
+  end
+
+  context "when the pact doesn't exist" do
+    let(:path) { "/pacts/provider/foo/consumer/bar/latest/badge" }
+
+    it "returns a 200 status" do
+      expect(subject.status).to eq 200
+    end
+
+    it "returns an svg/xml response" do
+      expect(subject.headers['Content-Type']).to include("image/svg+xml")
+    end
+
+    it "returns a static svg image" do
+      expect(subject.body).to include ">unknown<"
+    end
+  end
+end

data/spec/features/get_latest_tagged_pact_badge_spec.rb

@@ -0,0 +1,38 @@
+require 'webmock/rspec'
+
+describe "get latest tagged pact badge" do
+
+  before do
+    PactBroker.configuration.enable_badge_resources = true
+    PactBroker.configuration.shields_io_base_url = nil
+    TestDataBuilder.new
+      .create_consumer('consumer')
+      .create_provider('provider')
+      .create_consumer_version('1.0.0')
+      .create_consumer_version_tag('prod')
+      .create_pact
+      .create_verification(success: true)
+      .create_consumer_version('1.2.3')
+      .create_pact
+      .create_verification(success: false)
+  end
+
+  let(:path) { "/pacts/provider/provider/consumer/consumer/latest/prod/badge" }
+
+  # In the full app, the .svg extension is turned into an Accept header
+  # by ConvertFileExtensionToAcceptHeader
+
+  subject { get path, nil, {'HTTP_ACCEPT' => "image/svg+xml"}; last_response  }
+
+  it "returns a 200 status" do
+    expect(subject.status).to eq 200
+  end
+
+  it "returns an svg/xml response" do
+    expect(subject.headers['Content-Type']).to include("image/svg+xml")
+  end
+
+  it "returns an svg body" do
+    expect(subject.body).to include ">verified<"
+  end
+end

data/spec/features/get_latest_untagged_pact_badge_spec.rb

@@ -0,0 +1,38 @@
+require 'webmock/rspec'
+
+describe "get latest untagged pact badge" do
+
+  before do
+    PactBroker.configuration.enable_badge_resources = true
+    PactBroker.configuration.shields_io_base_url = nil
+    TestDataBuilder.new
+      .create_consumer('consumer')
+      .create_provider('provider')
+      .create_consumer_version('1.0.0')
+      .create_pact
+      .create_verification(success: true)
+      .create_consumer_version('1.2.3')
+      .create_consumer_version_tag('prod')
+      .create_pact
+      .create_verification(success: false)
+  end
+
+  let(:path) { "/pacts/provider/provider/consumer/consumer/latest-untagged/badge" }
+
+  # In the full app, the .svg extension is turned into an Accept header
+  # by ConvertFileExtensionToAcceptHeader
+
+  subject { get path, nil, {'HTTP_ACCEPT' => "image/svg+xml"}; last_response  }
+
+  it "returns a 200 status" do
+    expect(subject.status).to eq 200
+  end
+
+  it "returns an svg/xml response" do
+    expect(subject.headers['Content-Type']).to include("image/svg+xml")
+  end
+
+  it "returns an svg body" do
+    expect(subject.body).to include ">verified<"
+  end
+end

data/spec/features/publish_verification_spec.rb

@@ -12,6 +12,8 @@ describe "Recording a pact verification" do
     TestDataBuilder.new
       .create_provider("Provider")
       .create_consumer("Consumer")
+      .create_consumer_version("1.0.0")
+      .create_pact
       .create_consumer_version("1.2.3")
       .create_pact
       .revise_pact
@@ -22,10 +24,15 @@ describe "Recording a pact verification" do
     expect(subject.status).to be 201
   end
 
-  it "saves a verification against the pact" do
+  it "saves new verification" do
     expect { subject }.to change { PactBroker::Domain::Verification.count }.by(1)
   end
 
+  it "saves the verification against the correct pact" do
+    subject
+    expect(PactBroker::Domain::Verification.order(:id).last.pact_version_sha).to eq pact.pact_version_sha
+  end
+
   it "returns a link to itself that can be followed" do
     get_verification_link = parsed_response_body['_links']['self']['href']
     get get_verification_link

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

@@ -0,0 +1,104 @@
+require 'pact_broker/api/resources/badge'
+require 'pact_broker/badges/service'
+
+module PactBroker
+  module Api
+    module Resources
+      describe Badge do
+        let(:path) { "/pacts/provider/provider/consumer/consumer/latest/badge" }
+        let(:params) { {} }
+
+        subject { get path, params, {'HTTP_ACCEPT' => 'image/svg+xml'}; last_response }
+
+        context "when enable_badge_resources is false" do
+          before do
+            PactBroker.configuration.enable_badge_resources = false
+          end
+
+          it "returns a 404" do
+            expect(subject.status).to eq 404
+          end
+        end
+
+        context "when enable_badge_resources is true" do
+          before do
+            PactBroker.configuration.enable_badge_resources = true
+            allow(PactBroker::Pacts::Service).to receive(:find_latest_pact).and_return(pact)
+            allow(PactBroker::Verifications::Service).to receive(:find_latest_verification_for).and_return(verification)
+            allow(PactBroker::Badges::Service).to receive(:pact_verification_badge).and_return("badge")
+            allow(PactBroker::Verifications::Status).to receive(:new).and_return(verification_status)
+          end
+
+          let(:pact) { instance_double("PactBroker::Domain::Pact", consumer: consumer, provider: provider) }
+          let(:consumer) { double('consumer') }
+          let(:provider) { double('provider') }
+          let(:verification) { double("verification") }
+          let(:verification_status) { instance_double("PactBroker::Verifications::Status", to_sym: :verified) }
+
+          it "retrieves the latest pact" do
+            expect(PactBroker::Pacts::Service).to receive(:find_latest_pact)
+            subject
+          end
+
+          it "retrieves the latest verification for the pact's consumer and provider" do
+            expect(PactBroker::Verifications::Service).to receive(:find_latest_verification_for).with(consumer, provider, nil)
+            subject
+          end
+
+          it "determines the pact's verification status based on the latest pact and latest verification" do
+            expect(PactBroker::Verifications::Status).to receive(:new).with(pact, verification)
+            subject
+          end
+
+          it "creates a badge" do
+            expect(PactBroker::Badges::Service).to receive(:pact_verification_badge).with(pact, nil, false, :verified)
+            subject
+          end
+
+          it "returns a 200 status" do
+            expect(subject.status).to eq 200
+          end
+
+          it "returns the badge" do
+            expect(subject.body).to eq "badge"
+          end
+
+          context "when the label param is specified" do
+            let(:params) { {label: 'consumer'} }
+
+            it "creates a badge with the specified label" do
+              expect(PactBroker::Badges::Service).to receive(:pact_verification_badge).with(anything, 'consumer', anything, anything)
+              subject
+            end
+          end
+
+          context "when the initials param is true" do
+            let(:params) { {initials: 'true'} }
+
+            it "creates a badge with initials" do
+              expect(PactBroker::Badges::Service).to receive(:pact_verification_badge).with(anything, anything, true, anything)
+              subject
+            end
+          end
+
+          context "when the pact is not found" do
+            let(:pact) { nil }
+
+            it "returns a 200 status" do
+              expect(subject.status).to eq 200
+            end
+          end
+
+          context "when retrieving the badge for the latest pact with a tag" do
+            let(:path) { "/pacts/provider/provider/consumer/consumer/latest/prod/badge" }
+
+            it "retrieves the latest verification for the pact's consumer and provider and specified tag" do
+              expect(PactBroker::Verifications::Service).to receive(:find_latest_verification_for).with(anything, anything, 'prod')
+              subject
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/badges/service_spec.rb

@@ -0,0 +1,244 @@
+require 'pact_broker/badges/service'
+require 'webmock/rspec'
+
+module PactBroker
+  module Badges
+    module Service
+      describe "#pact_verification_badge" do
+        let(:pacticipant_name) { "Foo-Bar_Thing Service" }
+        let(:pact) { double("pact", consumer_name: "Foo-Bar", provider_name: "Thing_Blah") }
+        let(:label) { nil }
+        let(:initials) { false }
+        let(:verification_status) { :success }
+
+        let(:expected_url) { "https://img.shields.io/badge/#{expected_left_text}-#{expected_right_text}-#{expected_color}.svg" }
+        let(:expected_color) { "brightgreen" }
+        let(:expected_right_text) { "verified" }
+        let(:expected_left_text) { "foo--bar%2Fthing__blah%20pact" }
+        let(:response_status) { 200 }
+        let!(:http_request) do
+          stub_request(:get, expected_url).to_return(:status => response_status, :body => "svg")
+        end
+
+        let(:subject) { PactBroker::Badges::Service.pact_verification_badge pact, label, initials, verification_status }
+
+        it "returns the svg file" do
+           expect(subject).to eq "svg"
+        end
+
+        context "when the label is not specified" do
+          it "creates a badge with the consumer and provider names" do
+            subject
+            expect(http_request).to have_been_made
+          end
+
+          context "when initials is true" do
+            let(:expected_left_text) { "fb%2Ftb%20pact" }
+            let(:initials) { true }
+
+            it "creates a badge with the consumer and provider initials" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+
+          context "when initials is true but the consumer and provider names only contain one word" do
+            let(:expected_left_text) { "foo%2Fbar%20pact" }
+            let(:initials) { true }
+            let(:pact) { double("pact", consumer_name: "Foo", provider_name: "Bar") }
+
+            it "creates a badge with the consumer and provider names, not initials" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+
+          context "when initials is true but the consumer and provider names are one camel cased word" do
+            let(:expected_left_text) { "fa%2Fbp%20pact" }
+            let(:initials) { true }
+            let(:pact) { double("pact", consumer_name: "FooApp", provider_name: "barProvider") }
+
+            it "creates a badge with the consumer and provider names, not initials" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+
+          context "when initials is true but the consumer and provider names are one camel cased word" do
+            let(:expected_left_text) { "fa%2Fdat%20pact" }
+            let(:initials) { true }
+            let(:pact) { double("pact", consumer_name: "FooApp", provider_name: "doAThing") }
+
+            it "creates a badge with the consumer and provider names, not initials", pending: "Need to make regexp smarter" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+        end
+
+        context "when label is consumer" do
+          let(:expected_left_text) { "foo--bar%20pact" }
+          let(:label) { 'consumer' }
+
+          it "creates a badge with only the consumer name" do
+            subject
+            expect(http_request).to have_been_made
+          end
+
+          context "when initials is true" do
+            let(:expected_left_text) { "fb%20pact" }
+            let(:initials) { true }
+
+            it "creates a badge with only the consumer initials" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+        end
+
+        context "when label is provider" do
+          let(:expected_left_text) { "thing__blah%20pact" }
+          let(:label) { 'provider' }
+
+          it "creates a badge with only the provider name" do
+            subject
+            expect(http_request).to have_been_made
+          end
+
+          context "when initials is true" do
+            let(:expected_left_text) { "tb%20pact" }
+            let(:initials) { true }
+
+            it "creates a badge with only the provider initials" do
+              subject
+              expect(http_request).to have_been_made
+            end
+          end
+        end
+
+        context "when the verification_status is :success" do
+          it "create a green badge with left text 'verified'" do
+            subject
+            expect(http_request).to have_been_made
+          end
+        end
+
+        context "when the verification_status is :never" do
+          let(:verification_status) { :never }
+          let(:expected_color) { "lightgrey" }
+          let(:expected_right_text) { "unknown" }
+
+          it "create a lightgrey badge with left text 'unknown'" do
+            subject
+            expect(http_request).to have_been_made
+          end
+        end
+
+        context "when the verification_status is :failed" do
+          let(:verification_status) { :failed }
+          let(:expected_color) { "red" }
+          let(:expected_right_text) { "failed" }
+
+          it "create a red badge with left text 'failed'" do
+            subject
+            expect(http_request).to have_been_made
+          end
+        end
+
+        context "when the verification_status is :stale" do
+          let(:verification_status) { :stale }
+          let(:expected_color) { "orange" }
+          let(:expected_right_text) { "changed" }
+
+          it "create a orange badge with left text 'changed'" do
+            subject
+            expect(http_request).to have_been_made
+          end
+        end
+
+        context "when the pact is nil" do
+          let(:pact) { nil }
+          it "does not make a dynamic badge" do
+            subject
+            expect(http_request).to_not have_been_made
+          end
+
+          it "returns a static image" do
+            expect(subject).to include ">pact not found</"
+            expect(subject).to include ">unknown</"
+          end
+        end
+
+        context "when a non-200 response is returned" do
+          let(:expected_url) { /http/ }
+          let(:response_status) { 404 }
+
+          context "when the verification_status is success" do
+            it "returns a static success image" do
+              expect(subject).to include ">pact</"
+              expect(subject).to include ">verified</"
+            end
+          end
+
+          context "when the verification_status is failed" do
+            let(:verification_status) { :failed }
+
+            it "returns a static failed image" do
+              expect(subject).to include ">pact</"
+              expect(subject).to include ">failed</"
+            end
+          end
+
+          context "when the verification_status is stale" do
+            let(:verification_status) { :stale }
+
+            it "returns a static stale image" do
+              expect(subject).to include ">pact</"
+              expect(subject).to include ">changed</"
+            end
+          end
+
+          context "when the verification_status is never" do
+            let(:verification_status) { :never }
+
+            it "returns a static stale image" do
+              expect(subject).to include ">pact</"
+              expect(subject).to include ">unknown</"
+            end
+          end
+        end
+
+        context "when an exception is raised connecting to the shields.io server" do
+          before do
+            allow(Net::HTTP).to receive(:start).and_raise("an error")
+          end
+
+          it "logs the error" do
+            expect(PactBroker.logger).to receive(:error).with(/Error retrieving badge from.*shield.*an error/)
+            subject
+          end
+
+          it "returns a static image" do
+            expect(subject).to include ">pact</"
+          end
+        end
+
+        context "when the shields_io_base_url is not configured" do
+          before do
+            PactBroker.configuration.shields_io_base_url = nil
+          end
+
+          it "does not make an http request" do
+            subject
+            expect(http_request).to_not have_been_made
+          end
+
+          it "returns a static image" do
+            expect(subject).to include ">pact</"
+            expect(subject).to include ">verified</"
+          end
+        end
+      end
+    end
+  end
+end