pact_broker 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b90ded3cc7cc7a1c2a746508fb134ac6cf17c8a
-  data.tar.gz: c6a2a2c4a07b89818129a2033bab557f263a56c0
+  metadata.gz: 9029e88952b1175c690a65568eb507d2acf08c81
+  data.tar.gz: adf028a7f196fb7e78ae80cec9733fa8eecfc3fe
 SHA512:
-  metadata.gz: ea4852e81136f460f3049d3ab66260e1bc9076569ecb3b81108fa6e369491820b9af042bf473fc384cdba35f024a0a75a4156a85a605ef06b111f3044edd51a5
-  data.tar.gz: ee44bf0feb37587171992692eb3b53f4380d3fae8e011e4e0d94f56493874e9600179eb23c806e1cab77a5e061dc97d17a23e8aeb8ea9214f3cddd9b34bf4b41
+  metadata.gz: c9454daa54e8d1abe94458d753376f76a3381d7d02041671649426dcd2de243a0f0e6557d18ebec40b4db803b23ae0b70811f9fb19aea1bec7799f30e025f1b2
+  data.tar.gz: 0efc0461b3d6a84ea6a78ead513ad850427acb31a8c21c6a3f18ac3c741119554037b041f2d9751fec51e88118c137db7f1cff4e6347da5bf769d6437d3cd1e4

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="v2.6.0"></a>
+### v2.6.0 (2017-10-06)
+
+#### Features
+
+* add configuration option for check_for_potential_duplicate_pacticipant_names	 ([6ab3fda](/../../commit/6ab3fda))
+
+#### Bug Fixes
+
+* add webhook_retry_schedule and semver_formats to list of configuration options that can be saved to the database	 ([5bab062](/../../commit/5bab062))
+* delete related triggered webhooks when webhook is deleted	 ([48f9853](/../../commit/48f9853))
+* use strict mode when using mysql	 ([f991e15](/../../commit/f991e15))
+
 <a name="v2.5.1"></a>
 ### v2.5.1 (2017-09-26)
 

data/db/migrations/39_add_triggered_webhooks_fk_to_execution.rb

@@ -17,7 +17,7 @@ Sequel.migration do
     # TODO drop_column(:webhook_executions, :provider_id)
 
     # TODO
-    # alter_table(:triggered_webhooks) do
+    # alter_table(:webhook_executions) do
     #  set_column_not_null(:triggered_webhook_id)
     # end
   end

data/db/migrations/42_delete_orphan_webhook_data.rb

@@ -0,0 +1,20 @@
+require 'securerandom'
+
+Sequel.migration do
+  up do
+    from(:triggered_webhooks).where(webhook_id: nil).each do | triggered_webhook |
+      from(:webhook_executions).where(triggered_webhook_id: triggered_webhook[:id]).delete
+      from(:triggered_webhooks).where(id: triggered_webhook[:id]).delete
+    end
+
+    from(:webhook_executions).where(webhook_id: nil, triggered_webhook_id: nil).delete
+  end
+
+  # TODO
+  # alter_table(:triggered_webhooks) do
+  #  set_column_not_null(:webhook_id)
+  # end
+
+  down do
+  end
+end

data/lib/db.rb

@@ -30,6 +30,7 @@ module DB
     con.extension(:connection_validator)
     con.pool.connection_validation_timeout = -1 #Check the connection on every request
     con.timezone = :utc
+    con.run("SET sql_mode='STRICT_TRANS_TABLES';") if db_credentials[:adapter].to_s =~ /mysql/
     con
   end
 

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

@@ -5,15 +5,18 @@ module PactBroker
       module PacticipantResourceMethods
 
         def potential_duplicate_pacticipants? pacticipant_names
-          messages = pacticipant_service.messages_for_potential_duplicate_pacticipants pacticipant_names, base_url
-          if messages.any?
-            response.body = messages.join("\n")
-            response.headers['Content-Type'] = 'text/plain'
+          if PactBroker.configuration.check_for_potential_duplicate_pacticipant_names
+            messages = pacticipant_service.messages_for_potential_duplicate_pacticipants pacticipant_names, base_url
+            if messages.any?
+              response.body = messages.join("\n")
+              response.headers['Content-Type'] = 'text/plain'
+            end
+            messages.any?
+          else
+            false
           end
-          messages.any?
         end
-
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/services'
 require 'pact_broker/api/decorators/webhook_decorator'
 

data/lib/pact_broker/app.rb

@@ -63,6 +63,7 @@ module PactBroker
       PactBroker::DB.connection = configuration.database_connection
       PactBroker::DB.connection.timezone = :utc
       PactBroker::DB.validate_connection_config if configuration.validate_database_connection_config
+      PactBroker::DB.set_mysql_strict_mode_if_mysql
       Sequel.datetime_class = DateTime
       Sequel.database_timezone = :utc # Store all dates in UTC, assume any date without a TZ is UTC
       Sequel.application_timezone = :local # Convert dates to localtime when retrieving from database

data/lib/pact_broker/configuration.rb

@@ -11,11 +11,20 @@ module PactBroker
 
   class Configuration
 
-    SAVABLE_SETTING_NAMES = [:order_versions_by_date, :use_case_sensitive_resource_names, :enable_public_badge_access, :shields_io_base_url]
+    SAVABLE_SETTING_NAMES = [
+      :order_versions_by_date,
+      :use_case_sensitive_resource_names,
+      :enable_public_badge_access,
+      :shields_io_base_url,
+      :check_for_potential_duplicate_pacticipant_names,
+      :webhook_retry_schedule,
+      :semver_formats
+    ]
 
     attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
+    attr_accessor :check_for_potential_duplicate_pacticipant_names
     attr_accessor :semver_formats
     attr_accessor :enable_public_badge_access, :shields_io_base_url
     attr_accessor :webhook_retry_schedule
@@ -48,8 +57,9 @@ module PactBroker
       # Not recommended to set this to true unless there is no way to
       # consistently extract an orderable object from the consumer application version number.
       config.order_versions_by_date = false
-      config.semver_formats = ["%M.%m.%p%s%d","%M.%m", "%M"]
+      config.semver_formats = ["%M.%m.%p%s%d", "%M.%m", "%M"]
       config.webhook_retry_schedule = [10, 60, 120, 300, 600, 1200] #10 sec, 1 min, 2 min, 5 min, 10 min, 20 min => 38 minutes
+      config.check_for_potential_duplicate_pacticipant_names = true
       config
     end
 

data/lib/pact_broker/db.rb

@@ -24,5 +24,13 @@ module PactBroker
     def self.validate_connection_config
       PactBroker::DB::ValidateEncoding.(connection)
     end
+
+    def self.set_mysql_strict_mode_if_mysql
+      connection.run("SET sql_mode='STRICT_TRANS_TABLES';") if mysql?
+    end
+
+    def self.mysql?
+      connection.adapter_scheme =~ /mysql/
+    end
   end
 end

data/lib/pact_broker/locale/en.yml

@@ -28,8 +28,8 @@ en:
         If you meant to specify one of the above names, please correct the pact configuration, and re-publish the pact.
         If the pact is intended to be for a new consumer or provider, please manually create "%{new_name}" using the following command, and then re-publish the pact:
         $ curl -v -XPOST -H "Content-Type: application/json" -d "{\"name\": \"%{new_name}\"}" %{create_pacticipant_url}
-        If the pact broker requires authentication, include the '-u' flag with the proper credentials:
-        $ curl -v -XPOST -u <username>:<password> -H "Content-Type: application/json" -d "{\"name\": \"%{new_name}\"}" %{create_pacticipant_url}
+        If the pact broker requires basic authentication, add '-u <username:password>' to the command.
+        To disable this check, set `check_for_potential_duplicate_pacticipant_names` to false in the configuration.
       "400":
         title: 400 Malformed Request
         message: The request was malformed and could not be processed.

data/lib/pact_broker/pacticipants/find_potential_duplicate_pacticipant_names.rb

@@ -38,8 +38,6 @@ module PactBroker
               .downcase
               .split("_")
       end
-
     end
-
   end
 end

data/lib/pact_broker/pacts/merger.rb

@@ -19,6 +19,9 @@ module PactBroker
 
       # Accepts two hashes representing pacts, outputs a merged hash
       # Does not make any guarantees about order of interactions
+      # TODO: should not modify original!
+      # TODO: is not checking response for equality!
+      # TODO: should have separate tests!
       def merge_pacts original_json, additional_json
         original, additional = [original_json, additional_json].map{|str| JSON.parse(str, PACT_PARSING_OPTIONS) }
 

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.5.1'
+  VERSION = '2.6.0'
 end

data/lib/pact_broker/webhooks/execution.rb

@@ -27,6 +27,8 @@ module PactBroker
       end
     end
 
+    # For a brief time, the code was released with a direct relationship between
+    # webhook and execution. Need to make sure any existing data is handled properly.
     class DeprecatedExecution < Sequel::Model(:webhook_executions)
       associate(:many_to_one, :provider, :class => "PactBroker::Domain::Pacticipant", :key => :provider_id, :primary_key => :id)
       associate(:many_to_one, :consumer, :class => "PactBroker::Domain::Pacticipant", :key => :consumer_id, :primary_key => :id)

data/lib/pact_broker/webhooks/repository.rb

@@ -104,9 +104,11 @@ module PactBroker
         Execution.where(id: execution_ids).delete
       end
 
-      def unlink_triggered_webhooks_by_webhook_uuid uuid
-        TriggeredWebhook.where(webhook: Webhook.where(uuid: uuid)).update(webhook_id: nil)
-        DeprecatedExecution.where(webhook_id: Webhook.where(uuid: uuid).select(:id)).update(webhook_id: nil)
+      def delete_triggered_webhooks_by_webhook_uuid uuid
+        triggered_webhook_ids = TriggeredWebhook.where(webhook: Webhook.where(uuid: uuid)).select_for_subquery(:id)
+        Execution.where(triggered_webhook_id: triggered_webhook_ids).delete
+        DeprecatedExecution.where(webhook_id: Webhook.where(uuid: uuid).select_for_subquery(:id)).delete
+        TriggeredWebhook.where(id: triggered_webhook_ids).delete
       end
 
       def delete_triggered_webhooks_by_pact_publication_ids pact_publication_ids

data/lib/pact_broker/webhooks/service.rb

@@ -40,7 +40,7 @@ module PactBroker
       end
 
       def self.delete_by_uuid uuid
-        webhook_repository.unlink_triggered_webhooks_by_webhook_uuid uuid
+        webhook_repository.delete_triggered_webhooks_by_webhook_uuid uuid
         webhook_repository.delete_by_uuid uuid
       end
 

data/lib/pact_broker/webhooks/webhook.rb

@@ -11,6 +11,10 @@ module PactBroker
       associate(:many_to_one, :consumer, :class => "PactBroker::Domain::Pacticipant", :key => :consumer_id, :primary_key => :id)
       one_to_many :headers, :class => "PactBroker::Webhooks::WebhookHeader", :reciprocal => :webhook
 
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+      end
+
       def before_destroy
         WebhookHeader.where(webhook_id: id).destroy
       end

data/spec/features/create_pacticipant_spec.rb

@@ -0,0 +1,30 @@
+require 'support/test_data_builder'
+
+describe "Creating a pacticipant" do
+  let(:path) { "/pacticipants" }
+  let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:pacticipant_hash) { {name: 'Foo Thing'}}
+
+  subject { post path, pacticipant_hash.to_json, headers; last_response }
+
+  it "returns a 201 response" do
+    subject
+    expect(last_response.status).to be 201
+  end
+
+  it "returns the Location header" do
+    subject
+    expect(last_response.headers['Location']).to eq 'http://example.org/pacticpants/Foo%20Thing'
+  end
+
+  it "returns a JSON Content Type" do
+    subject
+    expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+  end
+
+  it "returns the newly created webhook" do
+    subject
+    expect(response_body).to include pacticipant_hash
+  end
+end

data/spec/features/publish_pact_spec.rb

@@ -46,4 +46,30 @@ describe "Publishing a pact" do
       expect(subject).to be_a_json_error_response "does not match"
     end
   end
+
+  context "when the pacticipant name is an almost duplicate of an existing pacticipant name" do
+    before do
+      TestDataBuilder.new.create_pacticipant("A Provider Service")
+    end
+
+    context "when duplicate checking is on" do
+      before do
+        PactBroker.configuration.check_for_potential_duplicate_pacticipant_names = true
+      end
+
+      it "returns a 409" do
+        expect(subject.status).to eq 409
+      end
+    end
+
+    context "when duplicate checking is off" do
+      before do
+        PactBroker.configuration.check_for_potential_duplicate_pacticipant_names = false
+      end
+
+      it "returns a 201" do
+        expect(subject.status).to eq 201
+      end
+    end
+  end
 end

data/spec/lib/pact_broker/messages_spec.rb

@@ -3,8 +3,6 @@ require 'pact_broker/messages'
 
 module PactBroker
   module Messages
-
-
     describe "#potential_duplicate_pacticipant_message" do
       let(:new_name) { 'Contracts' }
       let(:fred) { double('Contracts Service', name: 'Contracts Service') }
@@ -19,14 +17,12 @@ The name "Contracts" is very similar to the following existing consumers/provide
 If you meant to specify one of the above names, please correct the pact configuration, and re-publish the pact.
 If the pact is intended to be for a new consumer or provider, please manually create "Contracts" using the following command, and then re-publish the pact:
 $ curl -v -XPOST -H "Content-Type: application/json" -d "{\\\"name\\\": \\\"Contracts\\\"}" http://example.org/pacticipants
-If the pact broker requires authentication, include the '-u' flag with the proper credentials:
-$ curl -v -XPOST -u <username>:<password> -H "Content-Type: application/json" -d "{\\\"name\\\": \\\"Contracts\\\"}" http://example.org/pacticipants
 EOS
       }
       subject { Messages.potential_duplicate_pacticipant_message new_name, potential_duplicate_pacticipants, 'http://example.org' }
 
       it "returns a message" do
-        expect(subject).to eq expected_message
+        expect(subject).to start_with expected_message
       end
     end
   end

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

@@ -354,7 +354,7 @@ module PactBroker
         end
       end
 
-      describe "unlink_triggered_webhooks_by_webhook_uuid" do
+      describe "delete_triggered_webhooks_by_webhook_uuid" do
         let(:td) { TestDataBuilder.new }
 
         before do
@@ -365,22 +365,38 @@ module PactBroker
             .create_webhook
             .create_triggered_webhook
             .create_deprecated_webhook_execution
+            .create_webhook_execution
+            .create_webhook
+            .create_triggered_webhook
+            .create_deprecated_webhook_execution
+            .create_webhook_execution
+        end
+
+        let(:webhook_id) { Webhook.find(uuid: td.webhook.uuid).id }
+        subject { Repository.new.delete_triggered_webhooks_by_webhook_uuid td.webhook.uuid }
+
+        it "deletes the related triggered webhooks" do
+          expect { subject }.to change {
+              TriggeredWebhook.where(id: td.triggered_webhook.id).count
+            }.from(1).to(0)
         end
 
-        subject { Repository.new.unlink_triggered_webhooks_by_webhook_uuid td.webhook.uuid }
+        it "does not delete the unrelated triggered webhooks" do
+          expect { subject }.to_not change {
+              TriggeredWebhook.exclude(id: td.triggered_webhook.id).count
+            }
+        end
 
-        it "sets the webhook id to nil" do
-          webhook_id = Webhook.find(uuid: td.webhook.uuid).id
+        it "deletes the related deprecated webhook executions" do
           expect { subject }.to change {
-              TriggeredWebhook.find(id: td.triggered_webhook.id).webhook_id
-            }.from(webhook_id).to(nil)
+              DeprecatedExecution.count
+            }.by(-2)
         end
 
-        it "sets the webhook id to nil for the deprecated webhook execution field" do
-          webhook_id = Webhook.find(uuid: td.webhook.uuid).id
+        it "deletes the related webhook executions" do
           expect { subject }.to change {
-              DeprecatedExecution.find(id: td.webhook_execution.id).webhook_id
-            }.from(webhook_id).to(nil)
+              Execution.count
+            }.by(-2)
         end
       end
 

data/spec/migrations/42_delete_ophan_webhook_data_spec.rb

@@ -0,0 +1,98 @@
+describe 'creating triggered webhooks from webhook executions (migrate 36-41)', migration: true do
+  before do
+    PactBroker::Database.migrate(41)
+  end
+
+  let(:before_now) { DateTime.new(2016, 1, 1) }
+  let(:now) { DateTime.new(2018, 2, 2) }
+  let!(:consumer) { create(:pacticipants, {name: 'Consumer', created_at: now, updated_at: now}) }
+  let!(:provider) { create(:pacticipants, {name: 'Provider', created_at: now, updated_at: now}) }
+  let!(:consumer_version) { create(:versions, {number: '1.2.3', order: 1, pacticipant_id: consumer[:id], created_at: now, updated_at: now}) }
+  let!(:pact_version) { create(:pact_versions, {content: {some: 'json'}.to_json, sha: '1234', consumer_id: consumer[:id], provider_id: provider[:id], created_at: now}) }
+  let!(:pact_publication) do
+    create(:pact_publications, {
+      consumer_version_id: consumer_version[:id],
+      provider_id: provider[:id],
+      revision_number: 1,
+      pact_version_id: pact_version[:id],
+      created_at: (now - 1)
+    })
+  end
+  let!(:webhook) do
+    create(:webhooks, {
+      uuid: '1234',
+      method: 'GET',
+      url: 'http://www.example.org',
+      consumer_id: consumer[:id],
+      provider_id: provider[:id],
+      is_json_request_body: false,
+      created_at: now
+    })
+  end
+  let!(:triggered_webhook) do
+    create(:triggered_webhooks, {
+      trigger_uuid: '12345',
+      trigger_type: 'publication',
+      pact_publication_id: pact_publication[:id],
+      webhook_id: webhook[:id],
+      webhook_uuid: webhook[:uuid],
+      consumer_id: consumer[:id],
+      provider_id: provider[:id],
+      status: 'success',
+      created_at: now,
+      updated_at: now
+    })
+  end
+  let!(:webhook_execution) do
+    create(:webhook_executions, {
+      triggered_webhook_id: triggered_webhook[:id],
+      success: true,
+      logs: 'logs',
+      created_at: now
+    })
+  end
+
+  let!(:orphan_triggered_webhook) do
+    create(:triggered_webhooks, {
+      trigger_uuid: '12345',
+      trigger_type: 'publication',
+      pact_publication_id: pact_publication[:id],
+      webhook_id: nil,
+      webhook_uuid: webhook[:uuid],
+      consumer_id: consumer[:id],
+      provider_id: provider[:id],
+      status: 'success',
+      created_at: now,
+      updated_at: now
+    })
+  end
+
+  let!(:orphan_webhook_execution) do
+    create(:webhook_executions, {
+      triggered_webhook_id: orphan_triggered_webhook[:id],
+      success: true,
+      logs: 'logs',
+      created_at: now
+    })
+  end
+
+  let!(:deprecated_orphan_webhook_execution) do
+    create(:webhook_executions, {
+      triggered_webhook_id: nil,
+      webhook_id: nil,
+      success: true,
+      logs: 'logs',
+      created_at: now
+    })
+  end
+
+  subject { PactBroker::Database.migrate(42) }
+
+  it "deletes the orphan triggered webhooks" do
+    expect { subject }.to change { database[:triggered_webhooks].count }.by(-1)
+  end
+
+  it "deletes the orphan webhook executions" do
+    expect { subject }.to change { database[:webhook_executions].count }.by(-2)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -490,6 +490,7 @@ files:
 - db/migrations/39_add_triggered_webhooks_fk_to_execution.rb
 - db/migrations/40_create_latest_triggered_webhooks_view.rb
 - db/migrations/41_migrate_execution_data.rb
+- db/migrations/42_delete_orphan_webhook_data.rb
 - db/migrations/migration_helper.rb
 - db/pact_broker_database.sqlite3
 - db/test/backwards_compatibility/.rspec
@@ -761,6 +762,7 @@ files:
 - script/seed.rb
 - script/update-hal-browser
 - script/webhook-server.ru
+- spec/features/create_pacticipant_spec.rb
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_label_spec.rb
 - spec/features/delete_pact_spec.rb
@@ -905,6 +907,7 @@ files:
 - spec/migrations/34_latest_tagged_pacts_spec.rb
 - spec/migrations/34_pact_revisions_spec.rb
 - spec/migrations/41_migrate_execution_data_spec.rb
+- spec/migrations/42_delete_ophan_webhook_data_spec.rb
 - spec/service_consumers/pact_helper.rb
 - spec/service_consumers/provider_states_for_pact_broker_client.rb
 - spec/spec_helper.rb
@@ -984,6 +987,7 @@ signing_key:
 specification_version: 4
 summary: See description
 test_files:
+- spec/features/create_pacticipant_spec.rb
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_label_spec.rb
 - spec/features/delete_pact_spec.rb
@@ -1128,6 +1132,7 @@ test_files:
 - spec/migrations/34_latest_tagged_pacts_spec.rb
 - spec/migrations/34_pact_revisions_spec.rb
 - spec/migrations/41_migrate_execution_data_spec.rb
+- spec/migrations/42_delete_ophan_webhook_data_spec.rb
 - spec/service_consumers/pact_helper.rb
 - spec/service_consumers/provider_states_for_pact_broker_client.rb
 - spec/spec_helper.rb