pact_broker 2.29.0 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d618dcd0c7582bad7822bac6bf8b32db26a25cea
-  data.tar.gz: 2a0d1f85dbdb9d2291308e483d60422431fe4013
+  metadata.gz: '081cc254335adf8cdabb9bfbc1819c8bf23bb292'
+  data.tar.gz: c02b5d34019e3f645df1a47bdc271f0cb0f32919
 SHA512:
-  metadata.gz: f7ee32711c4be853ccfb0d0eefd62c87ec9aad7407c2344a0d12c9537aeaa88483e0fce93c33e1ed51389c98f41dae1125f11ce47869e5b73a11e866473c03aa
-  data.tar.gz: 3b8217e5d02bff7be409a8dbfa51a4caf8ca1f6dfb2132b470926100efa7aa5c2dd9c85525ae4bd54c8997091c2c2495ebce785342dc4341c41b7562b093edf8
+  metadata.gz: a58feed7d9ff5c59f84387cd8e5293fbdd480d11ce6ca6f7ee0a12bc86fba8c2d127f1a7135efb4cabb8bbdabae2a44bc9ed5ebf31125def2a810806a3a822ec
+  data.tar.gz: 613811b6f2f348e0a18ea825e995b6a33fcf72ca50f66065c84a8de88eb9e20d308a776d4d4eef9c641c0b98870dca36df3391990272fd00b86b6a0ba2831ff0

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+<a name="v2.30.0"></a>
+### v2.30.0 (2019-03-29)
+
+
+#### Features
+
+* add helper text on index page for getting started	 ([cdeb2cd9](/../../commit/cdeb2cd9))
+* allow rack protection to be turned off so that the headers can be managed in nginx	 ([941371ec](/../../commit/941371ec))
+* allow all pacts between a given consumer and provider to be deleted at once	 ([9f1ce9c3](/../../commit/9f1ce9c3))
+* correctly identify javascript and css content types	 ([6470d199](/../../commit/6470d199))
+* add .css and .js file extensions to middleware that sets the accept header	 ([eb1cd323](/../../commit/eb1cd323))
+* add helper text on index page for getting started	 ([222d8965](/../../commit/222d8965))
+* allow rack protection to be turned off so that the headers can be managed in nginx	 ([b43e60ee](/../../commit/b43e60ee))
+* allow all pacts between a given consumer and provider to be deleted at once	 ([0c8106b6](/../../commit/0c8106b6))
+* correctly identify javascript and css content types	 ([03e156cb](/../../commit/03e156cb))
+* add .css and .js file extensions to middleware that sets the accept header	 ([2aa533dc](/../../commit/2aa533dc))
+* add a new webhook event for contract_published	 ([2e2a2034](/../../commit/2e2a2034))
+
+* **matrix**
+  * improve reasons in response when pacticipant cannot be deployed	 ([85e11616](/../../commit/85e11616))
+  * allow provider to be deployed to an environment without the consumer having to be deployed there already	 ([125c2722](/../../commit/125c2722))
+
+
 <a name="v2.29.0"></a>
 ### v2.29.0 (2019-03-15)
 

data/lib/pact_broker/api/resources/pact_versions.rb

@@ -13,7 +13,7 @@ module PactBroker
         end
 
         def allowed_methods
-          ["GET", "OPTIONS"]
+          ["GET", "DELETE", "OPTIONS"]
         end
 
         def resource_exists?
@@ -29,6 +29,10 @@ module PactBroker
           pact_service.find_all_pact_versions_between consumer_name, :and => provider_name
         end
 
+        def delete_resource
+          pact_service.delete_all_pact_versions_between(consumer_name, and: provider_name)
+          true
+        end
       end
     end
   end

data/lib/pact_broker/app.rb

@@ -118,7 +118,9 @@ module PactBroker
 
     def configure_middleware
       # NOTE THAT NONE OF THIS IS PROTECTED BY AUTH - is that ok?
-      @app_builder.use Rack::Protection, except: [:path_traversal, :remote_token, :session_hijacking, :http_origin]
+      if configuration.use_rack_protection
+        @app_builder.use Rack::Protection, except: [:path_traversal, :remote_token, :session_hijacking, :http_origin]
+      end
       @app_builder.use Rack::PactBroker::InvalidUriProtection
       @app_builder.use Rack::PactBroker::StoreBaseURL
       @app_builder.use Rack::PactBroker::AddPactBrokerVersionHeader

data/lib/pact_broker/configuration.rb

@@ -32,7 +32,7 @@ module PactBroker
       :base_equality_only_on_content_that_affects_verification_results
     ]
 
-    attr_accessor :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :use_hal_browser, :html_pact_renderer
+    attr_accessor :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :check_for_potential_duplicate_pacticipant_names
@@ -62,6 +62,7 @@ module PactBroker
       config.log_dir = File.expand_path("./log")
       config.auto_migrate_db = true
       config.auto_migrate_db_data = true
+      config.use_rack_protection = true
       config.use_hal_browser = true
       config.validate_database_connection_config = true
       config.enable_diagnostic_endpoints = true

data/lib/pact_broker/doc/views/consumer.markdown

@@ -1,6 +1,6 @@
 # Consumer
 
-Allowed methods: GET, PATCH, DELETE
+Allowed methods: `GET`, `PATCH`, `DELETE`
 
 The application that initiates the HTTP request.
 

data/lib/pact_broker/doc/views/pact/all-pact-versions.markdown

@@ -0,0 +1,10 @@
+# All versions of a pact between a given consumer and provider
+
+Allowed methods: `GET`, `DELETE`
+Path: `/pacts/provider/{provider}/consumer/{consumer}/versions`
+
+This resource returns a history of all the versions of the given pact between a consumer and provider.
+
+## Deleting pacts
+
+Sending a `DELETE` to this resource will delete all the pacts between the specified applications.

data/lib/pact_broker/pacts/repository.rb

@@ -234,6 +234,14 @@ module PactBroker
         end
       end
 
+      def find_previous_pacts pact
+        if pact.consumer_version_tag_names.any?
+          pact.consumer_version_tag_names.map { |tag| find_previous_pact(pact, tag) }
+        else
+          [find_previous_pact(pact, :untagged)]
+        end
+      end
+
       private
 
       def find_previous_distinct_pact_by_sha pact

data/lib/pact_broker/pacts/service.rb

@@ -108,7 +108,7 @@ module PactBroker
 
       # TODO also take into account overridden revisions
       def pact_is_new_or_pact_has_changed_since_previous_version? pact
-        find_previous_pacts(pact).any? { |previous_pact| previous_pact.nil? || pact.json_content != previous_pact.json_content}
+        pact_repository.find_previous_pacts(pact).any? { |previous_pact| previous_pact.nil? || pact.json_content != previous_pact.json_content}
       end
 
       private
@@ -118,10 +118,11 @@ module PactBroker
         logger.debug "Content #{params[:json_content]}"
         updated_pact = pact_repository.update existing_pact.id, params
 
+        webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED
         if existing_pact.json_content != updated_pact.json_content
           webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED
         else
-          logger.debug "Pact has not changed since previous revision, not triggering webhooks"
+          logger.debug "Pact has not changed since previous version, not triggering webhooks for changed content"
         end
 
         updated_pact
@@ -137,18 +138,11 @@ module PactBroker
 
       def trigger_webhooks pact
         # TODO add tests for this
+        webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED
         if pact_is_new_or_pact_has_changed_since_previous_version?(pact)
           webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED
         else
-          logger.debug "Pact has not changed since previous version, not triggering webhooks"
-        end
-      end
-
-      def find_previous_pacts pact
-        if pact.consumer_version_tag_names.any?
-          pact.consumer_version_tag_names.map { |tag| pact_repository.find_previous_pact(pact, tag) }
-        else
-          [pact_repository.find_previous_pact(pact, :untagged)]
+          logger.debug "Pact has not changed since previous version, not triggering webhooks for changed content"
         end
       end
     end

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

@@ -21,6 +21,10 @@ module PactBroker
           end
         end
 
+        def empty?
+          index_items.empty?
+        end
+
         private
 
         attr_reader :index_items

data/lib/pact_broker/ui/views/index/_getting-started.haml

@@ -0,0 +1,6 @@
+%div.getting-started
+  %h3 Welcome!
+  %p
+    Just getting started? Confused as to why there's nothing "clicky clicky" to see here? The Pact workflow is a "code first" approach. Your pacts will be generated by your consumer tests and then published here, ready to be retrieved by your provider tests for verification.
+  %p
+    For step by step instructions on getting started, check out the <a href="https://docs.pact.io/best_practices/pact_nirvana">Effective Pact Setup Guide</a>.

data/lib/pact_broker/ui/views/index/show-with-tags.haml

@@ -3,6 +3,8 @@
   %script{type: 'text/javascript', src:'/javascripts/jquery.tablesorter.min.js'}
   .container
     = render :haml, :'index/_navbar', :layout => false, locals: {tag_toggle: false}
+    - if index_items.empty?
+      = render :haml, :'index/_getting-started', :layout => false
     %h1.page-header
       Pacts
     %table.table.table-bordered.table-striped{ id: 'relationships' }

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

@@ -3,6 +3,8 @@
   %script{type: 'text/javascript', src:'/javascripts/jquery.tablesorter.min.js'}
   .container
     = render :haml, :'index/_navbar', :layout => false, locals: {tag_toggle: true}
+    - if index_items.empty?
+      = render :haml, :'index/_getting-started', :layout => false
     %h1.page-header
       Pacts
     %table.table.table-bordered.table-striped{ id: 'relationships' }

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.29.0'
+  VERSION = '2.30.0'
 end

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -5,18 +5,23 @@ module PactBroker
   module Webhooks
     class WebhookEvent < Sequel::Model
 
+      CONTRACT_PUBLISHED = 'contract_published'
       CONTRACT_CONTENT_CHANGED = 'contract_content_changed'
       VERIFICATION_PUBLISHED = 'provider_verification_published'
       DEFAULT_EVENT_NAME = CONTRACT_CONTENT_CHANGED
       #CONTRACT_VERIFIABLE_CONTENT_CHANGED = 'contract_verifiable_content_changed'
       #VERIFICATION_STATUS_CHANGED = 'verification_status_changed'
 
-      EVENT_NAMES = [CONTRACT_CONTENT_CHANGED, VERIFICATION_PUBLISHED]
+      EVENT_NAMES = [CONTRACT_PUBLISHED, CONTRACT_CONTENT_CHANGED, VERIFICATION_PUBLISHED]
 
       dataset_module do
         include PactBroker::Repositories::Helpers
       end
 
+      def contract_published?
+        name == CONTRACT_PUBLISHED
+      end
+
       def contract_content_changed?
         name == CONTRACT_CONTENT_CHANGED
       end

data/lib/rack/pact_broker/accepts_html_filter.rb

@@ -1,29 +1,29 @@
+# Decides whether this is a browser request or a request for the API
 module Rack
   module PactBroker
     class AcceptsHtmlFilter
-
       def initialize app
         @app = app
       end
 
       def call env
-        if accepts_html_and_not_json_or_csv env
+        if accepts_web_content_types_and_not_api_media env
           @app.call(env)
         else
           [404, {},[]]
         end
       end
 
-      def accepts_html_and_not_json_or_csv env
+      def accepts_web_content_types_and_not_api_media env
         accept = env['HTTP_ACCEPT'] || ''
-        accepts_html(accept) && !accepts_json_or_csv(accept)
+        accepts_web_content_types(accept) && !accepts_api_content_types(accept)
       end
 
-      def accepts_html(accept)
-        accept.include?("html")
+      def accepts_web_content_types(accept)
+        accept.include?("*/*") || accept.include?("html") || accept.include?("text/css") || accept.include?("text/javascript")
       end
 
-      def accepts_json_or_csv accept
+      def accepts_api_content_types accept
         accept.include?("json") || accept.include?("csv")
       end
     end

data/lib/rack/pact_broker/convert_404_to_hal.rb

@@ -9,7 +9,7 @@ module Rack
       def call env
         response = @app.call(env)
 
-        if response.first == 404 && response[1]['Content-Type'] == 'text/html' && !(env['HTTP_ACCEPT'] =~ /html/)
+        if response.first == 404 && response[1]['Content-Type'] == 'text/html' && !(env['HTTP_ACCEPT'] =~ /html|javascript|css/)
           [404, { 'Content-Type' => 'application/hal+json'},[]]
         else
           response

data/public/stylesheets/index.css

@@ -113,4 +113,9 @@ table#relationships .label {
 
 div.tag {
   display: inline-block;
+}
+
+div.getting-started {
+  max-width: 600px;
+  margin-bottom: 50px;
 }

data/spec/features/delete_pact_versions_spec.rb

@@ -0,0 +1,29 @@
+describe "Deleting pact versions" do
+
+  let(:path) { "/pacts/provider/Bar/consumer/Foo/versions" }
+
+  subject { delete(path)  }
+
+  context "when the pact exists" do
+    before do
+      TestDataBuilder.new
+        .create_pact_with_hierarchy("Foo", "1.2.3", "Bar")
+        .create_provider("Baz")
+        .create_pact
+    end
+
+    it "deletes the pacts" do
+      expect{ subject }.to change{ PactBroker::Pacts::PactPublication.count }.by(-1)
+    end
+
+    it "returns a 204" do
+      expect(subject.status).to be 204
+    end
+  end
+
+  context "when the pact does not exist" do
+    it "returns a 404 Not Found" do
+      expect(subject.status).to be 404
+    end
+  end
+end

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

@@ -7,9 +7,59 @@ module PactBroker
 
   module Pacts
     describe Service do
-
       let(:td) { TestDataBuilder.new }
 
+      describe "create_or_update_pact" do
+        include_context "stubbed repositories"
+
+        before do
+          allow(described_class).to receive(:webhook_service).and_return(webhook_service)
+          allow(pacticipant_repository).to receive(:find_by_name_or_create).with(params[:consumer_name]).and_return(consumer)
+          allow(pacticipant_repository).to receive(:find_by_name_or_create).with(params[:provider_name]).and_return(provider)
+          allow(version_repository).to receive(:find_by_pacticipant_id_and_number_or_create).and_return(version)
+          allow(pact_repository).to receive(:find_by_version_and_provider).and_return(existing_pact)
+          allow(pact_repository).to receive(:create).and_return(new_pact)
+          allow(pact_repository).to receive(:update).and_return(new_pact)
+          allow(pact_repository).to receive(:find_previous_pacts).and_return(previous_pacts)
+          allow(webhook_service).to receive(:trigger_webhooks)
+        end
+
+        let(:webhook_service) { class_double("PactBroker::Webhooks::Service").as_stubbed_const }
+        let(:consumer) { double('consumer', id: 1) }
+        let(:provider) { double('provider', id: 2) }
+        let(:version) { double('version', id: 3, pacticipant_id: 1) }
+        let(:existing_pact) { nil }
+        let(:new_pact) { double('new_pact', json_content: json_content) }
+        let(:json_content) { { the: "contract" }.to_json }
+        let(:previous_pacts) { [] }
+        let(:params) do
+          {
+            consumer_name: "Foo",
+            provider_name: "Bar",
+            consumer_version_number: "1",
+            json_content: json_content
+          }
+        end
+
+        subject { Service.create_or_update_pact(params) }
+
+        context "when no pact exists with the same params" do
+          it "triggers webhooks for contract publications" do
+            expect(webhook_service).to receive(:trigger_webhooks).with(new_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED)
+            subject
+          end
+        end
+
+        context "when a pact exists with the same params" do
+          let(:existing_pact) { double('existing_pact', id: 4, json_content: { the: "contract" }.to_json) }
+
+          it "triggers webhooks for contract publications" do
+            expect(webhook_service).to receive(:trigger_webhooks).with(new_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED)
+            subject
+          end
+        end
+      end
+
       describe "find_distinct_pacts_between" do
         let(:pact_1) { double('pact 1', json_content: 'content 1')}
         let(:pact_2) { double('pact 2', json_content: 'content 2')}
@@ -27,7 +77,6 @@ module PactBroker
         it "returns the distinct pacts" do
           expect(subject).to eq [pact_4, pact_2, pact_1]
         end
-
       end
 
       describe "#pact_is_new_or_pact_has_changed_since_previous_version?" do

data/spec/support/logging.rb

@@ -2,4 +2,5 @@ require 'semantic_logger'
 require 'pact_broker/logging/default_formatter'
 
 FileUtils.mkdir_p("log")
+SemanticLogger.default_level = :error
 SemanticLogger.add_appender(file_name: "log/test.log", formatter: PactBroker::Logging::DefaultFormatter.new)

data/spec/support/shared_context.rb

@@ -2,9 +2,26 @@ RSpec.shared_context "stubbed services" do
 
   let(:pact_service) { class_double("PactBroker::Pacts::Service").as_stubbed_const }
   let(:pacticipant_service) { class_double("PactBroker::Pacticipants::Service").as_stubbed_const }
+  let(:version_service) { class_double("PactBroker::Versions::Service").as_stubbed_const }
+  let(:webhook_service) { class_double("PactBroker::Webhooks::Service").as_stubbed_const }
 
   before do
     allow_any_instance_of(described_class).to receive(:pact_service).and_return(pact_service)
     allow_any_instance_of(described_class).to receive(:pacticipant_service).and_return(pacticipant_service)
+    allow_any_instance_of(described_class).to receive(:version_service).and_return(version_service)
+    allow_any_instance_of(described_class).to receive(:webhook_service).and_return(webhook_service)
+  end
+end
+
+RSpec.shared_context "stubbed repositories" do
+
+  let(:pact_repository) { instance_double("PactBroker::Pacts::Repository") }
+  let(:pacticipant_repository) { instance_double("PactBroker::Pacticipants::Repository") }
+  let(:version_repository) { instance_double("PactBroker::Version::Repository") }
+
+  before do
+    allow(described_class).to receive(:pact_repository).and_return(pact_repository)
+    allow(described_class).to receive(:pacticipant_repository).and_return(pacticipant_repository)
+    allow(described_class).to receive(:version_repository).and_return(version_repository)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.29.0
+  version: 2.30.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -881,6 +881,7 @@ files:
 - lib/pact_broker/doc/views/layouts/main.haml
 - lib/pact_broker/doc/views/not_found.markdown
 - lib/pact_broker/doc/views/pact-versions.markdown
+- lib/pact_broker/doc/views/pact/all-pact-versions.markdown
 - lib/pact_broker/doc/views/pact/diff-previous-distinct.markdown
 - lib/pact_broker/doc/views/pact/diff.markdown
 - lib/pact_broker/doc/views/pact/latest-pact-version.markdown
@@ -979,6 +980,7 @@ files:
 - lib/pact_broker/ui/view_models/matrix_tag.rb
 - lib/pact_broker/ui/views/clusters/show.haml
 - lib/pact_broker/ui/views/groups/show.html.erb
+- lib/pact_broker/ui/views/index/_getting-started.haml
 - lib/pact_broker/ui/views/index/_navbar.haml
 - lib/pact_broker/ui/views/index/show-with-tags.haml
 - lib/pact_broker/ui/views/index/show.haml
@@ -1094,6 +1096,7 @@ files:
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_label_spec.rb
 - spec/features/delete_pact_spec.rb
+- spec/features/delete_pact_versions_spec.rb
 - spec/features/delete_tagged_pact_versions_spec.rb
 - spec/features/delete_version_spec.rb
 - spec/features/delete_webhook_spec.rb
@@ -1422,6 +1425,7 @@ test_files:
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_label_spec.rb
 - spec/features/delete_pact_spec.rb
+- spec/features/delete_pact_versions_spec.rb
 - spec/features/delete_tagged_pact_versions_spec.rb
 - spec/features/delete_version_spec.rb
 - spec/features/delete_webhook_spec.rb