pact_broker 2.33.0 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97134f270141a482c9af9641cffd34827002be42
-  data.tar.gz: '058cf5c4bdddd00ffd77b8a366cfdfbf539e40ff'
+  metadata.gz: fe2b3ac695d8a843322fa534dfeab9fe17956c99
+  data.tar.gz: 7f0fccfb8bc7b2713feb0effa685e2773ad2a90b
 SHA512:
-  metadata.gz: cf993532a2a921c255d35c52918f5aba61f310109f2d0beaacac3abddd16b8a55bcd12b4f21b7ecbade8a9c7e2104dc3198a2efbb1d3cfa3ec45c738e5357385
-  data.tar.gz: d5544a81be59d19d52b906f8a3c320bc25620e9020c9bc7e4d02217c7d3c549719564fa226f2df3ddd15bb8bb0776f8208d502105d0e8088cac3f018beb43804
+  metadata.gz: 1c339fb970aa844ebfb4efb48055a7807641076cbcad153f93a7f03df9631a86e6d36a3ad36f804d0e72f63f621805cad0fb872a609ed25399b59107f38ecaa4
+  data.tar.gz: 2b55bccea03acdd7304abf226109abb0a21a86b0aa43f18f4c92743b4b2e6bc5ab24e5f81cc9c10b761b86eba55038a47a94392d194cde790d841dd75df26751

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.5.3

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="v2.34.0"></a>
+### v2.34.0 (2019-06-14)
+
+
+#### Features
+
+* **webhooks**
+  * provide mapping to bitbucket build status names (#277)	 ([7bdf0c47](/../../commit/7bdf0c47))
+
+* change log level for webhook triggering logs from debug to info	 ([2dca79c1](/../../commit/2dca79c1))
+
+
+#### Bug Fixes
+
+* gracefully handle two requests coming in at the same time to create the same pacticipant	 ([78d92ada](/../../commit/78d92ada))
+* gracefully handle pact webhook status when there is no pact yet	 ([ba1f6bc7](/../../commit/ba1f6bc7))
+* do not overwrite existing pactbroker.database_connector in rack env	 ([0da5d070](/../../commit/0da5d070))
+
+
 <a name="v2.33.0"></a>
 ### v2.33.0 (2019-06-07)
 

data/DEVELOPER_SETUP.md

@@ -1,6 +1,6 @@
 # Developer setup
 
-* You will need to install Ruby 2.4, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-install].
+* You will need to install Ruby 2.5, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-install].
 * Install bundler (the Ruby gem dependency manager) `gem install bundler`
 * Check out the pact_broker repository and cd into it.
 * Run `bundle install`. If you have not got mysql or postgres installed locally, comment out the `mysql2` and `pg` development dependency lines in `pact_broker.gemspec`, as these are only really required on Travis.
@@ -13,5 +13,23 @@
 
 * The application will be available on `http://localhost:9292`
 
+## Running the tests
+
+To run everything (specs, pact verifications, vulnerability scan...):
+
+`bundle exec rake`
+
+To run a smaller subset of the tests:
+
+`bundle exec rake spec`
+
+To run the "quick tests" (skip the lengthy migration specs)
+
+`bundle exec rake spec:quick`
+
+To run a single spec:
+
+`bundle exec rspec path_to_your_spec.rb`
+
 [chruby]: https://github.com/postmodern/chruby
 [ruby-install]: https://github.com/postmodern/ruby-install

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

@@ -34,7 +34,7 @@ module PactBroker
           if pacticipant
             @pacticipant = pacticipant_service.update params_with_string_keys.merge('name' => pacticipant_name)
           else
-            @pacticipant = pacticipant_service.create params_with_string_keys.merge('name' => pacticipant_name)
+            @pacticipant = pacticipant_service.create params.merge(:name => pacticipant_name)
             response.headers["Location"] = pacticipant_url(base_url, pacticipant)
           end
           response.body = to_json

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

@@ -32,7 +32,7 @@ module PactBroker
         end
 
         def from_json
-          created_model = pacticipant_service.create params_with_string_keys
+          created_model = pacticipant_service.create(params)
           response.body = decorator_for(created_model).to_json(user_options: decorator_context)
         end
 

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

@@ -78,7 +78,7 @@ To specify an XML body, you will need to use a correctly escaped string (or use
 
 `contract_published:` triggered every time a contract is published. It is not recommended to trigger your provider verification build every time a contract is published - see `contract_content_changed` below.
 
-`contract_content_changed:` triggered when the content of the contract has changed since the previous publication. If `base_equality_only_on_content_that_affects_verification_results` is set to `true` in the configuration (the default), any changes to whitespace, ordering of keys, or the ordering of the `interactions` or `messages` will be ignored, and will not trigger this event. It is recommended to trigger a provider verification build for this event.
+`contract_content_changed:` triggered when the content of the contract, or tags applied to the contract have changed since the previous publication. If `base_equality_only_on_content_that_affects_verification_results` is set to `true` in the configuration (the default), any changes to whitespace, ordering of keys, or the ordering of the `interactions` or `messages` will be ignored, and will not trigger this event. It is recommended to trigger a provider verification build for this event.
 
 `provider_verification_published:` triggered whenever a provider publishes a verification.
 
@@ -95,6 +95,7 @@ The following variables may be used in the request path, parameters or body, and
 * `${pactbroker.consumerLabels}`: the list of labels for the consumer associated with the pact content, separated by ", ".
 * `${pactbroker.providerLabels}`: the list of labels for the provider associated with the pact content, separated by ", ".
 * `${pactbroker.githubVerificationStatus}`: the verification status using the correct keywords for posting to the the [Github commit status API](https://developer.github.com/v3/repos/statuses).
+* `${pactbroker.bitbucketVerificationStatus}`: the verification status using the correct keywords for posting to the the [Bitbucket commit status API](https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/).
 * `${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
 * `${pactbroker.verificationResultUrl}`: the URL to the relevant verification result.
 

data/lib/pact_broker/pacticipants/repository.rb

@@ -41,6 +41,9 @@ module PactBroker
         end
       end
 
+      # Need to be able to handle two calls that make the pacticipant at the same time.
+      # TODO raise error if attributes apart from name are different, because this indicates that
+      # the second request is not at the same time.
       def create args
         PactBroker::Domain::Pacticipant.dataset.insert_ignore.insert(
           name: args[:name],

data/lib/pact_broker/pacticipants/service.rb

@@ -58,6 +58,7 @@ module PactBroker
       end
 
       def self.update params
+        # TODO move this to the repository!
         pacticipant = pacticipant_repository.find_by_name(params.fetch('name'))
         PactBroker::Api::Decorators::PacticipantDecorator.new(pacticipant).from_hash(params)
         pacticipant.save
@@ -65,10 +66,7 @@ module PactBroker
       end
 
       def self.create params
-        pacticipant = PactBroker::Domain::Pacticipant.new
-        PactBroker::Api::Decorators::PacticipantDecorator.new(pacticipant).from_hash(params)
-        pacticipant.save
-        pacticipant
+        pacticipant_repository.create(params)
       end
 
       def self.delete name

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.33.0'
+  VERSION = '2.34.0'
 end

data/lib/pact_broker/webhooks/job.rb

@@ -88,7 +88,7 @@ module PactBroker
       end
 
       def reschedule_job
-        logger.debug "Re-enqeuing job for webhook #{triggered_webhook.webhook_uuid} to run in #{backoff_time} seconds"
+        logger.info "Re-enqeuing job for webhook #{triggered_webhook.webhook_uuid} to run in #{backoff_time} seconds"
         Job.perform_in(backoff_time, @data.merge(error_count: error_count+1))
       end
 

data/lib/pact_broker/webhooks/pact_and_verification_parameters.rb

@@ -20,6 +20,7 @@ module PactBroker
           '${pactbroker.consumerName}' => pact ? pact.consumer_name : "",
           '${pactbroker.providerName}' => pact ? pact.provider_name : "",
           '${pactbroker.githubVerificationStatus}' => github_verification_status,
+          '${pactbroker.bitbucketVerificationStatus}' => bitbucket_verification_status,
           '${pactbroker.consumerLabels}' => pacticipant_labels(pact && pact.consumer),
           '${pactbroker.providerLabels}' => pacticipant_labels(pact && pact.provider)
         }
@@ -29,6 +30,13 @@ module PactBroker
 
       attr_reader :pact, :verification, :webhook_context, :base_url
 
+      def bitbucket_verification_status
+        if verification
+          verification.success ? "SUCCESSFUL" : "FAILED"
+        else
+          "INPROGRESS"
+        end
+      end
 
       def github_verification_status
         if verification

data/lib/pact_broker/webhooks/repository.rb

@@ -164,7 +164,11 @@ module PactBroker
       end
 
       def find_latest_triggered_webhooks_for_pact pact
-        find_latest_triggered_webhooks(pact.consumer, pact.provider)
+        if pact
+          find_latest_triggered_webhooks(pact.consumer, pact.provider)
+        else
+          []
+        end
       end
 
       def find_latest_triggered_webhooks consumer, provider

data/lib/pact_broker/webhooks/service.rb

@@ -122,7 +122,7 @@ module PactBroker
         if webhooks.any?
           run_later(webhooks, pact, verification, event_name, options)
         else
-          logger.debug "No enabled webhooks found for consumer \"#{pact.consumer.name}\" and provider \"#{pact.provider.name}\" and event #{event_name}"
+          logger.info "No enabled webhooks found for consumer \"#{pact.consumer.name}\" and provider \"#{pact.provider.name}\" and event #{event_name}"
         end
       end
 
@@ -131,7 +131,7 @@ module PactBroker
         webhooks.each do | webhook |
           begin
             triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION)
-            logger.info "Scheduling job for #{webhook.description} with uuid #{webhook.uuid}"
+            logger.info "Scheduling job for webhook with uuid #{webhook.uuid}"
             job_data = {
               triggered_webhook: triggered_webhook,
               webhook_context: options.fetch(:webhook_context),

data/lib/pact_broker/webhooks/trigger_service.rb

@@ -14,7 +14,7 @@ module PactBroker
         if pact_is_new_or_newly_tagged_or_pact_has_changed_since_previous_version?(pact)
           webhook_service.trigger_webhooks pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED, webhook_options
         else
-          logger.debug "Pact content has not changed since previous version, not triggering webhooks for changed content"
+          logger.info "Pact content has not changed since previous version, not triggering webhooks for changed content"
         end
       end
 
@@ -22,10 +22,10 @@ module PactBroker
         webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_PUBLISHED, webhook_options
         # TODO this should use the sha!
         if existing_pact.pact_version_sha != updated_pact.pact_version_sha
-          logger.debug "Existing pact for version #{existing_pact.consumer_version_number} has been updated with new content, triggering webhooks for changed content"
+          logger.info "Existing pact for version #{existing_pact.consumer_version_number} has been updated with new content, triggering webhooks for changed content"
           webhook_service.trigger_webhooks updated_pact, nil, PactBroker::Webhooks::WebhookEvent::CONTRACT_CONTENT_CHANGED, webhook_options
         else
-          logger.debug "Pact content has not changed since previous revision, not triggering webhooks for changed content"
+          logger.info "Pact content has not changed since previous revision, not triggering webhooks for changed content"
         end
       end
 
@@ -60,7 +60,7 @@ module PactBroker
               end
             end
           end
-          logger.debug("Webhook triggered for the following reasons: #{messages.join(',')}" )
+          logger.info("Webhook triggered for the following reasons: #{messages.join(',')}" )
         end
       end
     end

data/lib/rack/pact_broker/database_transaction.rb

@@ -20,18 +20,16 @@ module Rack
       end
 
       def call env
-        set_database_connector
         if use_transaction? env
           call_with_transaction(add_database_connector(env))
         else
           call_without_transaction(add_database_connector(env))
         end
-      ensure
-        clear_database_connector
       end
 
       def add_database_connector(env)
-        env.merge("pactbroker.database_connector" => @default_database_connector)
+        # maintain any existing one set by previous middleware
+        { "pactbroker.database_connector" => @default_database_connector }.merge(env)
       end
 
       def use_transaction? env
@@ -56,19 +54,6 @@ module Rack
       def do_not_rollback? response
         response[1].delete(::PactBroker::DO_NOT_ROLLBACK)
       end
-
-      def set_database_connector
-        Thread.current[:pact_broker_thread_data] ||= OpenStruct.new
-        Thread.current[:pact_broker_thread_data].database_connector ||= @default_database_connector
-      end
-
-      def clear_database_connector
-        if thread_data = Thread.current[:pact_broker_thread_data]
-          if thread_data.database_connector == @default_database_connector
-            thread_data.database_connector = nil
-          end
-        end
-      end
     end
   end
 end

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

@@ -47,7 +47,7 @@ module PactBroker
 
           context "with valid JSON" do
             it "creates the pacticipant" do
-              expect(PactBroker::Pacticipants::Service).to receive(:create).with('name' => 'New Consumer')
+              expect(PactBroker::Pacticipants::Service).to receive(:create).with(:name => 'New Consumer')
               subject
             end
 

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

@@ -112,6 +112,12 @@ module PactBroker
           ["${pactbroker.githubVerificationStatus}", "pending", :pact_with_no_verification, :nil_verification],
           ["${pactbroker.githubVerificationStatus}", "success", :pact_with_successful_verification, :nil_verification],
           ["${pactbroker.githubVerificationStatus}", "failure", :pact_with_failed_verification, :nil_verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "SUCCESSFUL", :pact, :verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "FAILED", :pact, :failed_verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "INPROGRESS", :nil_pact, :nil_verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "INPROGRESS", :pact_with_no_verification, :nil_verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "SUCCESSFUL", :pact_with_successful_verification, :nil_verification],
+          ["${pactbroker.bitbucketVerificationStatus}", "FAILED", :pact_with_failed_verification, :nil_verification],
           ["${pactbroker.verificationResultUrl}", "", :pact_with_no_verification, :nil_verification],
           ["${pactbroker.verificationResultUrl}", "http://verification", :pact_with_successful_verification, :nil_verification],
           ["${pactbroker.verificationResultUrl}", "http://verification", :pact_with_successful_verification, :verification],

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

@@ -186,7 +186,7 @@ module PactBroker
           end
 
           it "logs that no webhook was found" do
-            expect(logger).to receive(:debug).with(/No enabled webhooks found/)
+            expect(logger).to receive(:info).with(/No enabled webhooks found/)
             subject
           end
         end

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

@@ -50,7 +50,7 @@ module PactBroker
           include_examples "triggering a contract_content_changed event"
 
           it "logs the reason why it triggered the contract_content_changed event" do
-            expect(logger).to receive(:debug).with(/first time untagged pact published/)
+            expect(logger).to receive(:info).with(/first time untagged pact published/)
             subject
           end
         end
@@ -64,7 +64,7 @@ module PactBroker
           include_examples "triggering a contract_content_changed event"
 
           it "logs the reason why it triggered the contract_content_changed event" do
-            expect(logger).to receive(:debug).with(/pact content has changed since previous untagged version/)
+            expect(logger).to receive(:info).with(/pact content has changed since previous untagged version/)
             subject
           end
         end
@@ -86,7 +86,7 @@ module PactBroker
           include_examples "triggering a contract_content_changed event"
 
           it "logs the reason why it triggered the contract_content_changed event" do
-            expect(logger).to receive(:debug).with(/first time pact published with consumer version tagged dev/)
+            expect(logger).to receive(:info).with(/first time pact published with consumer version tagged dev/)
             subject
           end
         end
@@ -126,7 +126,7 @@ module PactBroker
           include_examples "triggering a contract_content_changed event"
 
           it "logs the reason why it triggered the contract_content_changed event" do
-            expect(logger).to receive(:debug).with(/version 1.2.3 has been updated with new content/)
+            expect(logger).to receive(:info).with(/version 1.2.3 has been updated with new content/)
             subject
           end
         end

data/spec/lib/rack/pact_broker/database_transaction_spec.rb

@@ -23,7 +23,9 @@ module Rack
         ::Rack::PactBroker::DatabaseTransaction.new(api, ::PactBroker::DB.connection)
       end
 
-      subject { self.send(http_method, "/") }
+      let(:rack_headers) { {} }
+
+      subject { self.send(http_method, "/", rack_headers) }
 
       it "sets the pactbroker.database_connector on the env" do
         actual_env = nil
@@ -35,6 +37,21 @@ module Rack
         expect(actual_env).to have_key("pactbroker.database_connector")
       end
 
+      context "when the pactbroker.database_connector already exists" do
+        let(:rack_headers) { { "pactbroker.database_connector" => double('existing database connector') } }
+        let(:existing_database_connector) { double('existing database connector') }
+
+        it "does not overwrite it", pending: "key is not showing up in rack env for some reason" do
+          actual_env = nil
+          allow(api).to receive(:call) do | env |
+            actual_env = env
+            [200, {}, {}]
+          end
+          subject
+          expect(actual_env["pactbroker.database_connector"]).to be existing_database_connector
+        end
+      end
+
       context "for get requests" do
         let(:http_method) { :get }
 
@@ -60,46 +77,6 @@ module Rack
           expect { subject }.to change { ::PactBroker::Domain::Pacticipant.count }.by(1)
         end
       end
-
-      describe "setting the database connector" do
-        let(:api) { double('api', call: [200, {}, []]) }
-
-        it "sets a database connector for use in jobs scheduled by this request" do
-          expect(api).to receive(:call) do | env |
-            expect(Thread.current[:pact_broker_thread_data].database_connector).to_not be nil
-            [200, {}, []]
-          end
-
-          subject
-        end
-
-        it "clears it after the request" do
-          subject
-          expect(Thread.current[:pact_broker_thread_data].database_connector).to be nil
-        end
-
-        context "when other middleware sets the database connector" do
-          before do
-            Thread.current[:pact_broker_thread_data] = OpenStruct.new(database_connector: other_database_connector)
-          end
-
-          let(:other_database_connector) { ->(&block) { block.call } }
-
-          it "does not override it" do
-            expect(api).to receive(:call) do | env |
-              expect(Thread.current[:pact_broker_thread_data].database_connector).to eq other_database_connector
-              [200, {}, []]
-            end
-
-            subject
-          end
-
-          it "does not clear it after the request" do
-            subject
-            expect(Thread.current[:pact_broker_thread_data].database_connector).to_not be nil
-          end
-        end
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.33.0
+  version: 2.34.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty