pact_broker 2.16.1 → 2.17.0

data/lib/pact_broker/ui/controllers/matrix.rb

@@ -10,11 +10,10 @@ module PactBroker
       class Matrix < Base
 
         include PactBroker::Services
-        include PactBroker::Logging
 
         get "/" do
           selectors = [OpenStruct.new, OpenStruct.new]
-          options = { limit: 100, latestby: 'cvpv' }
+          options = { limit: 100, latestby: nil }
           locals = {
             lines: [],
             title: "The Matrix",
@@ -35,7 +34,7 @@ module PactBroker
               end
             end
           rescue StandardError => e
-            log_error(e) unless e.is_a?(PactBroker::Error)
+            Padrino.logger.exception(e) unless e.is_a?(PactBroker::Error)
             locals[:errors] = [e.message]
           end
           haml :'matrix/show', {locals: locals, layout: :'layouts/main'}
@@ -43,7 +42,7 @@ module PactBroker
 
         get "/provider/:provider_name/consumer/:consumer_name" do
           selectors = [{ pacticipant_name: params[:consumer_name] }, { pacticipant_name: params[:provider_name] } ]
-          options = {latestby: 'cvpv', limit: 100}
+          options = {latestby: nil, limit: 100}
           lines = matrix_service.find(selectors, options)
           lines = PactBroker::UI::ViewDomain::MatrixLines.new(lines)
           locals = {

data/lib/pact_broker/ui/view_models/matrix_line.rb

@@ -175,6 +175,12 @@ module PactBroker
         def overwritten= overwritten
           @overwritten = overwritten
         end
+
+        def inherited_verification_message
+          if @line[:verification_executed_at] && @line[:pact_created_at] > @line[:verification_executed_at]
+            "The verification date is before the pact publication date because this verification has been inherited from a previously verified pact with identical content."
+          end
+        end
       end
     end
   end

data/lib/pact_broker/ui/views/matrix/show.haml

@@ -53,6 +53,11 @@
           %input{name: 'q[]latest', value: 'true', hidden: true, class: 'latest-flag'}
 
     %div.top-of-group
+      .input-group
+        %input{type: 'radio', name: "latestby", class: '', value: '', id: 'all_rows', checked: options.all_rows_checked}
+        %label{for: 'all_rows'}
+          Show all results
+    %div
       .input-group
         %input{type: 'radio', name: "latestby", class: '', value: 'cvpv', id: 'cvpv', checked: options.cvpv_checked}
         %label{for: 'cvpv'}
@@ -62,14 +67,10 @@
         %input{type: 'radio', name: "latestby", class: '', value: 'cvp', id: 'cvp', checked: options.cvp_checked}
         %label{for: 'cvp'}
           Show latest result for each consumer version/provider
-    %div
-      .input-group
-        %input{type: 'radio', name: "latestby", class: '', value: '', id: 'all_rows', checked: options.all_rows_checked}
-        %label{for: 'all_rows'}
-          Show all results
     %div.top-of-group
-      %label{for: "limit"}
-        Limit
+      - limit_text = "Note that the 'Show latest...' options are summaries of the 'Show all results' query, and that the limit applies to the underlying query, rather than the number of rows returned in the summary."
+      %label{for: "limit", "title": limit_text, "data-toggle": "tooltip", "data-placement": "right"}
+        Limit*
       %input{name: 'limit', id: "limit", value: options.limit}
     %div.top-of-group
       %input{type: 'submit'}
@@ -117,7 +118,7 @@
               %a{href: tag.url}
                 .tag.label.label-default
                   = tag.name
-        %td.pact-published{'data-sort-value' => line.pact_published_order}
+        %td.pact-published{'data-sort-value' => line.pact_published_order, "title": line.inherited_verification_message, "data-toggle": "tooltip"}
           %a{href: line.pact_publication_date_url}
             - if options.all_rows_checked
               = "#{line.pact_publication_date} (revision #{line.pact_revision_number})"
@@ -141,6 +142,9 @@
               %a{href: tag.url}
                 .tag.label.label-default
                   = tag.name
-        %td.verification-result{class: line.verification_status_class}
+        %td.verification-result{class: line.verification_status_class, "title": line.inherited_verification_message, "data-toggle": "tooltip"}
           %a{href: line.verification_status_url}
-            = line.verification_status
+            - if options.all_rows_checked
+              = "#{line.verification_status} (number #{line.number})"
+            - else
+              = line.verification_status

data/lib/pact_broker/ui.rb

@@ -1,14 +1,14 @@
-
+require 'pact_broker/configuration'
 # Stop Padrino creating a log file, as it will try to create it in the gems directory
 # http://www.padrinorb.com/api/Padrino/Logger.html
 unless defined? PADRINO_LOGGER
+  log_path = File.join(PactBroker.configuration.log_dir, 'ui.log')
   PADRINO_LOGGER = {
-    production:  { log_level: :error, stream: :stderr },
-    staging:     { log_level: :error, stream: :stderr },
-    test:        { log_level: :warn,  stream: :stdout },
-    development: { log_level: :warn,  stream: :stdout }
+    production:  { log_level: :error, stream: :to_file, log_path: log_path },
+    staging:     { log_level: :error, stream: :to_file, log_path: log_path },
+    test:        { log_level: :warn,  stream: :to_file, log_path: log_path },
+    development: { log_level: :warn,  stream: :to_file, log_path: log_path }
   }
 end
 
 require 'pact_broker/ui/app'
-

data/lib/pact_broker/verifications/repository.rb

@@ -2,6 +2,7 @@ require 'sequel'
 require 'pact_broker/domain/verification'
 require 'pact_broker/verifications/latest_verifications_by_consumer_version'
 require 'pact_broker/verifications/all_verifications'
+require 'pact_broker/verifications/sequence'
 
 module PactBroker
   module Verifications
@@ -10,6 +11,14 @@ module PactBroker
       include PactBroker::Repositories::Helpers
       include PactBroker::Repositories
 
+      # Ideally this would just be a sequence, but Sqlite and MySQL don't support sequences
+      # in the way we need to use them ie. determining what the next number will be before we
+      # create the record, because Webmachine wants to set the URL of the resource that is about
+      # to be created *before* we actually create it.
+      def next_number
+        Sequence.next_val
+      end
+
       def create verification, provider_version_number, pact
         provider = pacticipant_repository.find_by_name(pact.provider_name)
         version = version_repository.find_by_pacticipant_id_and_number_or_create(provider.id, provider_version_number)
@@ -18,10 +27,6 @@ module PactBroker
         verification.save
       end
 
-      def verification_count_for_pact pact
-        PactBroker::Domain::Verification.where(pact_version_id: pact_version_id_for(pact)).count
-      end
-
       def find consumer_name, provider_name, pact_version_sha, verification_number
         PactBroker::Domain::Verification
           .select_all_qualified

data/lib/pact_broker/verifications/sequence.rb

@@ -0,0 +1,34 @@
+
+require 'sequel'
+
+module PactBroker
+  module Verifications
+    class Sequence < Sequel::Model(:verification_sequence_number)
+
+      dataset_module do
+        # The easiest way to implement a cross database compatible sequence.
+        # Sad, I know.
+        def next_val
+          db.transaction do
+            for_update.first
+            select_all.update(value: Sequel[:value]+1)
+            row = first
+            if row
+              row.value
+            else
+              # The first row should have been created in the migration, so this code
+              # should only ever be executed in a test context.
+              # There would be a risk of a race condition creating two rows if this
+              # code executed in prod, as I don't think you can lock an empty table
+              # to prevent another record being inserted.
+              max_verification_number = PactBroker::Domain::Verification.max(:number)
+              value = max_verification_number ? max_verification_number + 100 : 1
+              insert(value: value)
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/verifications/service.rb

@@ -12,8 +12,8 @@ module PactBroker
       extend PactBroker::Repositories
       extend PactBroker::Services
 
-      def next_number_for pact
-        verification_repository.verification_count_for_pact(pact) + 1
+      def next_number
+        verification_repository.next_number
       end
 
       def create next_verification_number, params, pact

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.16.1'
+  VERSION = '2.17.0'
 end

data/lib/webmachine/convert_request_to_rack_env.rb

@@ -0,0 +1,37 @@
+module Webmachine
+  class ConvertRequestToRackEnv
+    def self.call(request)
+      env = {
+        'REQUEST_METHOD' => request.method.upcase,
+        'CONTENT_TYPE' => request.headers['Content-Type'],
+        'PATH_INFO' => request.uri.path,
+        'QUERY_STRING' => request.uri.query || "",
+        'SERVER_NAME' => request.uri.host,
+        'SERVER_PORT' => request.uri.port.to_s,
+        'SCRIPT_NAME' => '',
+        'rack.url_scheme' => request.uri.scheme,
+        'rack.input' => request.body.to_io ? StringIO.new(request.body.to_s) : nil
+      }.merge(convert_headers(request))
+    end
+
+    def self.convert_headers(request)
+      request.headers.each_with_object({}) do | (key, value), env |
+        v = redact?(key) ? '[Filtered]' : value
+        env[convert_http_header_name_to_rack_header_name(key)] = v
+      end
+    end
+
+    def self.redact?(http_header_name)
+      lower = http_header_name.downcase
+      lower == 'authorization' || lower.include?('token')
+    end
+
+    def self.convert_http_header_name_to_rack_header_name(http_header_name)
+      if http_header_name.downcase == 'content-type' || http_header_name.downcase ==  'content-length'
+        http_header_name.upcase.gsub('-', '_')
+      else
+        "HTTP_" + http_header_name.upcase.gsub('-', '_')
+      end
+    end
+  end
+end

data/script/publish.sh

@@ -1,4 +1,15 @@
+#!/bin/sh
+function finish {
+  rm -rf tmp/pact.json
+}
+trap finish EXIT
+
+consumer=${1:-Foo}
+provider=${2:-Bar}
+echo $consumer $provider
+body=$(cat script/foo-bar.json | sed "s/Foo/${consumer}/" | sed "s/Bar/${provider}/")
+echo $body > tmp/pact.json
 curl -v -XPUT \-H "Content-Type: application/json" \
--d@script/foo-bar.json \
-http://127.0.0.1:9292/pacts/provider/Bar/consumer/Foo/version/1.0.0
+-d@tmp/pact.json \
+http://127.0.0.1:9292/pacts/provider/${provider}/consumer/${consumer}/version/1.0.0
 echo ""

data/script/recreate-mysql-db.sh

@@ -1,6 +1,7 @@
 SCHEMA="pact_broker"
 set -e
-mysql mysql -h localhost -u root -e "select 'drop table "' || tablename || '" cascade;' from pg_tables;'"
+# mysql mysql -h localhost -u root -e "select 'drop table "' || tablename || '" cascade;' from pg_tables;'"
+mysql mysql -h localhost -u root -e 'DROP DATABASE pact_broker;'
 mysql mysql -h localhost -u root -e 'CREATE DATABASE pact_broker;'
 mysql mysql -h localhost -u root -e "GRANT ALL ON pact_broker.* TO 'pact_broker'@'%' identified by 'pact_broker';"
 

data/script/seed-matrix.rb

@@ -41,7 +41,7 @@ A -> B ->  C
 TestDataBuilder.new
   .create_pact_with_hierarchy("A", "1", "B")
   .create_consumer_version_tag("master")
-  .create_verification(provider_version: '1', success: false)
+  .create_verification(provider_version: '1', success: false, execution_date: Date.today - 1 )
   .create_verification(provider_version: '1', number: 2, success: true)
   .create_verification(provider_version: '2', number: 3)
   .create_verification(provider_version: '4', number: 4)

data/spec/features/publish_verification_spec.rb

@@ -10,7 +10,6 @@ describe "Recording a pact verification" do
 
   subject { post path, verification_content, {'CONTENT_TYPE' => 'application/json' }; last_response  }
 
-
   before do
     td.create_provider("Provider")
       .create_consumer("Consumer")

data/spec/features/update_matrix_spec.rb

@@ -0,0 +1,146 @@
+=begin
+
+Things that should update the matrix (ignoring tags):
+* pact created
+* pact content updated
+* pact deleted
+* verification created
+* verification deleted (not yet implemented)
+
+It's easier to update the matrix at the resource level, so we actually update the matrix when:
+* pacticipant deleted
+* version deleted
+* pact deleted
+
+Things that should update the head matrix
+* All of the above
+* tag created
+* tag deleted
+
+=end
+
+describe "Deleting a resource that affects the matrix" do
+
+  let(:td) { TestDataBuilder.new }
+  let(:response_body_json) { JSON.parse(subject.body) }
+
+  subject { delete path; last_response  }
+
+  before do
+    td.create_pact_with_hierarchy("Foo", "1", "Bar")
+      .create_verification(provider_version: "2")
+  end
+
+  context "deleting a pact" do
+    let(:path) { "/pacts/provider/Bar/consumer/Foo/version/1" }
+
+    it "deletes the relevant lines from the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(-1)
+    end
+
+    it "deletes the relevant lines from the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(-1)
+    end
+  end
+
+  context "deleting a pacticipant" do
+    let(:path) { "/pacticipants/Bar" }
+
+    it "deletes the relevant lines from the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(-1)
+    end
+
+    it "deletes the relevant lines from the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(-1)
+    end
+  end
+
+  context "deleting a version" do
+    let(:path) { "/pacticipants/Foo/versions/1" }
+
+    it "deletes the relevant lines from the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(-1)
+    end
+
+    it "deletes the relevant lines from the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(-1)
+    end
+  end
+
+  context "deleting a tag" do
+    before do
+      td.create_consumer_version_tag("prod")
+    end
+
+    let(:path) { "/pacticipants/Foo/versions/1/tags/prod" }
+
+    it "does not delete any lines from the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(0)
+    end
+
+    it "deletes the relevant lines from the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(-1)
+    end
+  end
+end
+
+describe "Creating a resource that affects the matrix" do
+
+  let(:td) { TestDataBuilder.new }
+  let(:response_body_json) { JSON.parse(subject.body) }
+
+  subject { put(path, nil, {'CONTENT_TYPE' => 'application/json'}); last_response }
+
+  context "creating a tag" do
+    before do
+      td.create_pact_with_hierarchy("Foo", "1", "Bar")
+    end
+
+    let(:path) { "/pacticipants/Foo/versions/1/tags/prod" }
+
+    it "adds the relevant lines to the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(1)
+    end
+
+    it "does not add any lines to the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(0)
+    end
+  end
+
+  context "creating a pact" do
+    let(:pact_content) { load_fixture('foo-bar.json') }
+    let(:path) { "/pacts/provider/Bar/consumer/Foo/versions/1.2.3" }
+
+    subject { put path, pact_content, {'CONTENT_TYPE' => 'application/json'}; last_response }
+
+    it "adds the relevant lines to the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.count }.by(1)
+    end
+
+    it "adds the relevant lines to the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.count }.by(1)
+    end
+  end
+
+  context "creating a verification" do
+    let(:td) { TestDataBuilder.new }
+    let(:path) { "/pacts/provider/Bar/consumer/Foo/pact-version/#{pact.pact_version_sha}/verification-results" }
+    let(:verification_content) { load_fixture('verification.json') }
+    let(:parsed_response_body) { JSON.parse(subject.body) }
+    let(:pact) { td.pact }
+
+    subject { post path, verification_content, {'CONTENT_TYPE' => 'application/json' }; last_response  }
+
+    before do
+      td.create_pact_with_hierarchy("Foo", "1", "Bar")
+    end
+
+    it "updates the relevant lines in the matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::Row.first.provider_version_number }.from(nil).to("4.5.6")
+    end
+
+    it "updates the relevant lines in the head matrix" do
+      expect{ subject }.to change{ PactBroker::Matrix::HeadRow.first.provider_version_number }.from(nil).to("4.5.6")
+    end
+  end
+end

data/spec/fixtures/foo-bar.json

@@ -0,0 +1,22 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description" : "a request for something",
+      "providerState": null,
+      "request": {
+        "method": "get",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,55 @@
+require 'pact_broker/api/resources/error_handler'
+
+module PactBroker
+  module Api
+    module Resources
+      describe ErrorHandler do
+        describe "call" do
+          let(:error) { PactBroker::Error.new('test error') }
+          let(:thing) { double('thing', call: nil, another_call: nil) }
+          let(:options) { { env: env } }
+          let(:request) { double('request' ) }
+          let(:response) { double('response', :body= => nil) }
+          let(:env) { double('env') }
+
+          subject { ErrorHandler.call(error, request, response) }
+
+          before do
+            allow(Webmachine::ConvertRequestToRackEnv).to receive(:call).and_return(env)
+            PactBroker.configuration.add_api_error_reporter do | error, options |
+              thing.call(error, options)
+            end
+
+            PactBroker.configuration.add_api_error_reporter do | error, options |
+              thing.another_call(error, options)
+            end
+          end
+
+          it "invokes the api error reporters" do
+            expect(thing).to receive(:call).with(error, options)
+            expect(thing).to receive(:another_call).with(error, options)
+            subject
+          end
+
+          context "when the error reporter raises an error itself" do
+            class TestError < StandardError; end
+
+            before do
+              expect(thing).to receive(:call).and_raise(TestError.new)
+            end
+
+            it "logs the error" do
+              expect(PactBroker.logger).to receive(:error).at_least(1).times
+              subject
+            end
+
+            it "does not propagate the error" do
+              expect(thing).to receive(:another_call)
+              subject
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -46,7 +46,7 @@ module PactBroker
 
             before do
               allow(Pacts::Service).to receive(:find_pact).and_return(pact)
-              allow(PactBroker::Verifications::Service).to receive(:next_number_for).and_return(next_verification_number)
+              allow(PactBroker::Verifications::Service).to receive(:next_number).and_return(next_verification_number)
               allow(PactBroker::Api::Decorators::VerificationDecorator).to receive(:new).and_return(decorator)
             end
 

data/spec/lib/pact_broker/configuration_spec.rb

@@ -40,7 +40,7 @@ module PactBroker
       end
 
       describe "load_from_database!" do
-        let(:configuration) { PactBroker::Configuration.new}
+        let(:configuration) { PactBroker::Configuration.new }
 
         before do
           PactBroker::Config::Setting.create(name: 'use_case_sensitive_resource_names', type: 'string', value: 'foo')
@@ -51,6 +51,24 @@ module PactBroker
           expect(configuration.use_case_sensitive_resource_names).to eq "foo"
         end
       end
+
+      describe "add_api_error_reporter" do
+        let(:configuration) { PactBroker::Configuration.new }
+        let(:block) { Proc.new{ | error, options | } }
+
+        it "should add the error notifier " do
+          configuration.add_api_error_reporter(&block)
+          expect(configuration.api_error_reporters.first).to eq block
+        end
+
+        context "with a proc with the wrong number of arguments" do
+          let(:block) { Proc.new{ | error | } }
+
+          it "raises an error" do
+            expect { configuration.add_api_error_reporter(&block) }.to raise_error PactBroker::ConfigurationError
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/pact_broker/matrix/head_row_spec.rb

@@ -0,0 +1,52 @@
+require 'pact_broker/matrix/head_row'
+
+module PactBroker
+  module Matrix
+    describe HeadRow do
+      describe "refresh", migration: true do
+        before do
+          PactBroker::Database.migrate
+        end
+
+        let(:td) { TestDataBuilder.new(auto_refresh_matrix: false) }
+
+        before do
+          td.create_pact_with_hierarchy("Foo", "1", "Bar")
+        end
+
+        context "with a consumer pacticipant_id and a consumer tag_name" do
+          before do
+            td.create_consumer_version_tag("prod")
+            Row.refresh(ids)
+          end
+          let(:ids) { { pacticipant_id: td.consumer.id, tag_name: "prod"} }
+
+          subject { HeadRow.refresh(ids) }
+
+          it "refreshes the data for the consumer and consumer tag in the head matrix" do
+            subject
+            expect(HeadRow.all.collect(&:values)).to contain_hash(provider_name: "Bar", consumer_name: "Foo", consumer_version_tag_name: "prod")
+          end
+        end
+
+        context "with a provider pacticipant_id and a provider tag_name" do
+          before do
+            td.create_verification(provider_version: "2")
+              .use_provider_version("2")
+              .create_provider_version_tag("prod")
+            Row.refresh(ids)
+          end
+
+          let(:ids) { { pacticipant_id: td.consumer.id, tag_name: "prod" } }
+
+          subject { HeadRow.refresh(ids) }
+
+          it "does not update the head matrix as the head matrix only contains consumer tags" do
+            subject
+            expect(HeadRow.count).to eq 0
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/matrix/repository_spec.rb

@@ -19,6 +19,26 @@ module PactBroker
         rows.collect{ |r| shorten_row(r) }
       end
 
+      describe "refresh" do
+        before do
+          td.create_pact_with_hierarchy("Foo", "1", "Bar")
+          Row.refresh(pacticipant_id: td.provider.id)
+        end
+
+        context "when deleting an object in the block" do
+          it "removes the relevant lines from the matrix" do
+            expect(Row.count).to_not eq 0
+            Repository.new.refresh(pacticipant_name: "Bar") { PactBroker::Pacticipants::Service.delete("Bar") }
+            expect(Row.count).to eq 0
+          end
+
+          it "yields the block" do
+            Repository.new.refresh(pacticipant_name: "Bar") { PactBroker::Pacticipants::Service.delete("Bar") }
+            expect(PactBroker::Domain::Pacticipant.where(name: "Bar").count).to eq 0
+          end
+        end
+      end
+
       describe "find" do
         before do
           # A1 - B1