pact_broker 2.30.0 → 2.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '081cc254335adf8cdabb9bfbc1819c8bf23bb292'
-  data.tar.gz: c02b5d34019e3f645df1a47bdc271f0cb0f32919
+  metadata.gz: f778ef154be3a35cb2cc58deeaa7445228413820
+  data.tar.gz: 27d7c415594fe68b43f0813d7a47392faeb49b25
 SHA512:
-  metadata.gz: a58feed7d9ff5c59f84387cd8e5293fbdd480d11ce6ca6f7ee0a12bc86fba8c2d127f1a7135efb4cabb8bbdabae2a44bc9ed5ebf31125def2a810806a3a822ec
-  data.tar.gz: 613811b6f2f348e0a18ea825e995b6a33fcf72ca50f66065c84a8de88eb9e20d308a776d4d4eef9c641c0b98870dca36df3391990272fd00b86b6a0ba2831ff0
+  metadata.gz: 93b6226a1d82f747454a48513a789b2215dedc12fce7e1173554ef2fc36d7584369b551d050c2b6f067f5199e43d1a37a640d7b596717fc8a114826773abca97
+  data.tar.gz: 1d6c6605ea29d1c827b0f2073cde3b9782eefca979b3851b8c84804e210fc1ba71c56d8306de77abde51707557d0e2db8906475903634c6c9e0a10b2921efea9

data/CHANGELOG.md

@@ -1,3 +1,54 @@
+<a name="v2.31.0"></a>
+### v2.31.0 (2019-04-30)
+
+
+#### Features
+
+* display times in UTC in API responses	 ([a4231117](/../../commit/a4231117))
+* log the reason why a webhook has been triggered	 ([30522c0d](/../../commit/30522c0d))
+* add _ids to interactions added via the TestDataBuilder	 ([d21e7092](/../../commit/d21e7092))
+* update names of example apps	 ([2b2a3f81](/../../commit/2b2a3f81))
+* ignore order of keys when generating interaction sha	 ([e6a0e8d8](/../../commit/e6a0e8d8))
+* use _id instead of id for the interaction identifier	 ([010a14ab](/../../commit/010a14ab))
+* add ids to interactions when pacts are published	 ([cd377850](/../../commit/cd377850))
+* remove whitespace from pact content when saving to database	 ([1f53682e](/../../commit/1f53682e))
+* monkeypatch webmachine to make the rack env available on the request	 ([40be97db](/../../commit/40be97db))
+* ensure index page is not cached	 ([0cfa9bbf](/../../commit/0cfa9bbf))
+* correct provider state matching for merging	 ([41ff6e5d](/../../commit/41ff6e5d))
+* only seed example data when database is empty	 ([0f2d00a6](/../../commit/0f2d00a6))
+* seed app with example data on first startup	 ([cf27ad8c](/../../commit/cf27ad8c))
+* batch delete versions and tags using delete instead of destroy for efficiency	 ([1315e0b1](/../../commit/1315e0b1))
+* allow pact to be deleted through the UI	 ([df0f35cb](/../../commit/df0f35cb))
+* upgrade bootstrap	 ([1be9f1b2](/../../commit/1be9f1b2))
+* allow an integration to be deleted via the UI	 ([f520520e](/../../commit/f520520e))
+* add delete integration which deletes all objects pertaining to an integration that are not referenced by other objects	 ([718f0218](/../../commit/718f0218))
+* simplify the logic that determines if the request is for the UI or the API	 ([73ae0fc2](/../../commit/73ae0fc2))
+* change pact rendering log message from warn to info	 ([93229103](/../../commit/93229103))
+* upgrade jquery version to 3.3.1	 ([82b830cf](/../../commit/82b830cf))
+
+* **dashboard**
+  * sort items by most recent activity	 ([f6f8fb20](/../../commit/f6f8fb20))
+
+* **index**
+  * add button to delete all pact versions	 ([b5d15d5d](/../../commit/b5d15d5d))
+
+
+#### Bug Fixes
+
+* ensure datetime tests run correctly regardless of timezone	 ([0506be30](/../../commit/0506be30))
+* correct logic for filtering ui/api requests	 ([725c6ccb](/../../commit/725c6ccb))
+* ensure that the templating in the webhook body uses the correct base URL for the broker	 ([3d5a5380](/../../commit/3d5a5380))
+* handle deleting integration when consumer and provider are the same pacticipant	 ([f31e8df2](/../../commit/f31e8df2))
+* correct tbody in show-with-tags index page	 ([325a98ed](/../../commit/325a98ed))
+* delete overwritten pact publications when deleting all pact publications between a consumer and provider	 ([5456eda5](/../../commit/5456eda5))
+* escape html on index pages	 ([6ee34afe](/../../commit/6ee34afe))
+* sanitize html in matrix	 ([c4d74d87](/../../commit/c4d74d87))
+* sanitize fields when rendering pact html	 ([dca76506](/../../commit/dca76506))
+
+* **readme**
+  * Change gitter link to slack. + Minor typo	 ([6b1c7843](/../../commit/6b1c7843))
+
+
 <a name="v2.30.0"></a>
 ### v2.30.0 (2019-03-29)
 

data/README.md

@@ -43,7 +43,7 @@ Features:
 #### Step 1. Consumer CI build
 1. The consumer project runs its tests using the [Pact][pact] library to provide a mock service.
 2. While the tests run, the mock service writes the requests and the expected responses to a JSON "pact" file - this is the consumer contract.
-3. The generated pact is then published to the Pact Broker. Most Pact libries will make a task available for you to do this easily, however, at its simplest, it is a `PUT` to a resource that specifies the consumer name and application version, and the provider name. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/version/1.0.0`
+3. The generated pact is then published to the Pact Broker. Most Pact libraries will make a task available for you to do this easily, however, at its simplest, it is a `PUT` to a resource that specifies the consumer name and application version, and the provider name. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/version/1.0.0`
 (Note that you are specifying the _consumer application version_ in the URL, not the pact version. The broker will take care of versioning the pact behind the scenes when its content changes. It is expected that the consumer application version will increment with every CI build.)
 4. When a pact is published, a webhook in the Pact Broker kicks off a build of the provider project if the pact content has changed since the previous version.
 
@@ -73,7 +73,7 @@ See the [wiki][wiki] for documentation on the Pact Broker. Please read the [over
 * Check the [wiki][wiki] first.
 * See if there is an existing or closed [issue][issues] and raise a new issue if not.
 * See if there is an existing question on [stackoverflow][stackoverflow] tagged with `pact-broker`, and ask a new question if not.
-* Have a chat to us on the Pact [gitter][gitter].
+* Have a chat to us on the Pact [slack][slack].
 * Tweet us at [@pact_up][twitter] on the twitters.
 
 ### Screenshots
@@ -166,7 +166,7 @@ Please read the [UPGRADING.md](UPGRADING.md) documentation before upgrading your
 [reverse-proxy-docs]: https://github.com/pact-foundation/pact_broker/wiki/Configuration#running-the-broker-behind-a-reverse-proxy
 [stackoverflow]: http://stackoverflow.com/questions/tagged/pact-broker
 [twitter]: https://twitter.com/pact_up
-[gitter]: https://gitter.im/realestate-com-au/pact
+[slack]: https://slack.pact.io/
 [issues]: https://github.com/pact-foundation/pact_broker/issues
 [pact-docs]: http://docs.pact.io
 [cli]: https://github.com/pact-foundation/pact-ruby-standalone/releases

data/config/database.yml

@@ -12,10 +12,12 @@ test:
     <<: *default
     adapter: postgres
   docker_postgres:
-    <<: *default
     adapter: postgres
-    host: "127.0.0.1"
-    port: "5433"
+    database: postgres
+    username: postgres
+    password: postgres
+    host: "localhost"
+    port: "5432"
   docker_compose_postgres:
     <<: *default
     adapter: postgres

data/lib/db.rb

@@ -26,6 +26,7 @@ module DB
   #
   def self.connect db_credentials
     Sequel.datetime_class = DateTime
+    # logger = Logger.new($stdout)
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.pool.connection_validation_timeout = -1 #Check the connection on every request

data/lib/pact/doc/markdown/consumer_contract_renderer.rb

@@ -1,5 +1,6 @@
 require 'pact/doc/markdown/interaction_renderer'
 require 'pact/doc/sort_interactions'
+require 'rack/utils'
 
 module Pact
   module Doc
@@ -15,7 +16,7 @@ module Pact
         end
 
         def call
-          title + summaries_title + summaries.join + interactions_title + full_interactions.join
+          title + summaries_title + summaries + interactions_title + full_interactions
         end
 
         private
@@ -39,11 +40,11 @@ module Pact
         end
 
         def summaries
-          interaction_renderers.collect(&:render_summary)
+          interaction_renderers.collect(&:render_summary).join
         end
 
         def full_interactions
-          interaction_renderers.collect(&:render_full_interaction)
+          interaction_renderers.collect(&:render_full_interaction).join
         end
 
         def sorted_interactions
@@ -51,17 +52,20 @@ module Pact
         end
 
         def consumer_name
-          markdown_escape consumer_contract.consumer.name
+          h(markdown_escape consumer_contract.consumer.name)
         end
 
         def provider_name
-          markdown_escape consumer_contract.provider.name
+          h(markdown_escape consumer_contract.provider.name)
         end
 
         def markdown_escape string
           string.gsub('*','\*').gsub('_','\_')
         end
 
+        def h(text)
+          Rack::Utils.escape_html(text)
+        end
       end
     end
   end

data/lib/pact/doc/markdown/interaction.erb

@@ -1,14 +1,14 @@
 <a name="<%= interaction.id %>"></a>
 <%= if interaction.has_provider_state?
-  "Given **#{interaction.provider_state}**, upon receiving"
+  "Given **#{h(interaction.provider_state)}**, upon receiving"
    else
   "Upon receiving"
    end
-%> **<%= interaction.description %>** from <%= interaction.consumer_name %>, with
+%> **<%= h(interaction.description) %>** from <%= h(interaction.consumer_name) %>, with
 ```json
 <%= interaction.request  %>
 ```
-<%= interaction.provider_name %> will respond with:
+<%= h(interaction.provider_name) %> will respond with:
 ```json
 <%= interaction.response %>
 ```

data/lib/pact/doc/markdown/interaction_renderer.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'pact/doc/interaction_view_model'
+require 'rack/utils'
 
 module Pact
   module Doc
@@ -12,8 +13,8 @@ module Pact
         end
 
         def render_summary
-          suffix = interaction.has_provider_state? ? " given #{interaction.provider_state}" : ""
-          "* [#{interaction.description(true)}](##{interaction.id})#{suffix}\n\n"
+          suffix = interaction.has_provider_state? ? " given #{h(interaction.provider_state)}" : ""
+          "* [#{h(interaction.description(true))}](##{interaction.id})#{suffix}\n\n"
         end
 
         def render_full_interaction
@@ -36,6 +37,9 @@ module Pact
           File.dirname(__FILE__) + template_file
         end
 
+        def h(text)
+          Rack::Utils.escape_html(text)
+        end
       end
     end
   end

data/lib/pact_broker.rb

@@ -1,13 +1,4 @@
-require 'reform'
-require 'reform/form/dry'
-
 require 'pact_broker/version'
 require 'pact_broker/logging'
 require 'pact_broker/app'
 require 'pact_broker/db/log_quietener'
-
-module PactBroker
-  Reform::Form.class_eval do
-    feature Reform::Form::Dry
-  end
-end

data/lib/pact_broker/api.rb

@@ -1,4 +1,5 @@
 require 'webmachine/adapters/rack_mapped'
+require 'webmachine/rack_adapter_monkey_patch'
 require 'pact_broker/api/resources'
 require 'pact_broker/feature_toggle'
 
@@ -86,6 +87,7 @@ module PactBroker
         add ['test','error'], Api::Resources::ErrorTest, {resource_name: "error_test"}
 
         add ['integrations'], Api::Resources::Integrations, {resource_name: "integrations"}
+        add ['integrations', 'provider', :provider_name, 'consumer', :consumer_name], Api::Resources::Integration, {resource_name: "integration"}
         add [], Api::Resources::Index, {resource_name: "index"}
       end
     end

data/lib/pact_broker/api/contracts/base_contract.rb

@@ -0,0 +1,15 @@
+require 'reform'
+require 'reform/form/dry'
+
+Reform::Form.class_eval do
+  feature Reform::Form::Dry
+end
+
+module PactBroker
+  module Api
+    module Contracts
+      class BaseContract < Reform::Form
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/pacticipant_name_contract.rb

@@ -1,10 +1,9 @@
-require 'reform'
-require 'reform/form'
+require 'pact_broker/api/contracts/base_contract'
 
 module PactBroker
   module Api
     module Contracts
-      class PacticipantNameContract < Reform::Form
+      class PacticipantNameContract < BaseContract
         property :name
         property :name_in_pact
         property :pacticipant

data/lib/pact_broker/api/contracts/put_pact_params_contract.rb

@@ -1,10 +1,9 @@
-require 'reform'
-require 'reform/form'
+require 'pact_broker/api/contracts/base_contract'
 
 module PactBroker
   module Api
     module Contracts
-      class PutPacticipantNameContract < Reform::Form
+      class PutPacticipantNameContract < BaseContract
         property :name
         property :name_in_pact
         property :pacticipant
@@ -24,7 +23,7 @@ module PactBroker
         end
       end
 
-      class PutPactParamsContract < Reform::Form
+      class PutPactParamsContract < BaseContract
         property :consumer_version_number
         property :consumer, form: PutPacticipantNameContract
         property :provider, form: PutPacticipantNameContract

data/lib/pact_broker/api/contracts/request_validations.rb

@@ -1,6 +1,5 @@
-require 'reform'
-require 'reform/contract'
 require 'net/http'
+require 'uri'
 
 module PactBroker
   module Api

data/lib/pact_broker/api/contracts/verification_contract.rb

@@ -1,11 +1,10 @@
-require 'reform'
-require 'reform/form'
+require 'pact_broker/api/contracts/base_contract'
 require 'uri'
 
 module PactBroker
   module Api
     module Contracts
-      class VerificationContract < Reform::Form
+      class VerificationContract < BaseContract
 
         property :success
         property :provider_version, as: :providerApplicationVersion

data/lib/pact_broker/api/contracts/webhook_contract.rb

@@ -1,5 +1,4 @@
-require 'reform'
-require 'reform/form'
+require 'pact_broker/api/contracts/base_contract'
 require 'pact_broker/webhooks/check_host_whitelist'
 require 'pact_broker/webhooks/render'
 require 'pact_broker/pacticipants/service'
@@ -7,7 +6,7 @@ require 'pact_broker/pacticipants/service'
 module PactBroker
   module Api
     module Contracts
-      class WebhookContract < Reform::Form
+      class WebhookContract < BaseContract
 
         def validate(*)
           result = super

data/lib/pact_broker/api/decorators/base_decorator.rb

@@ -2,6 +2,7 @@ require 'roar/decorator'
 require 'roar/json/hal'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/api/decorators/decorator_context'
+require 'pact_broker/api/decorators/format_date_time'
 
 module PactBroker
 
@@ -13,6 +14,7 @@ module PactBroker
         include Roar::JSON::HAL
         include Roar::JSON::HAL::Links
         include PactBroker::Api::PactBrokerUrls
+        include FormatDateTime
       end
     end
   end

data/lib/pact_broker/api/decorators/dashboard_decorator.rb

@@ -1,11 +1,13 @@
 require 'ostruct'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/api/decorators/format_date_time'
 
 module PactBroker
   module Api
     module Decorators
       class DashboardDecorator
         include PactBroker::Api::PactBrokerUrls
+        include FormatDateTime
 
         def initialize(index_items)
           @index_items = index_items
@@ -26,11 +28,15 @@ module PactBroker
         attr_reader :index_items
 
         def items(index_items, base_url)
-          index_items.collect do | index_item |
+          sorted_index_items.collect do | index_item |
             index_item_hash(index_item.consumer, index_item.provider, index_item.consumer_version, index_item, base_url)
           end
         end
 
+        def sorted_index_items
+          index_items.sort{ |i1, i2| i2.last_activity_date <=> i1.last_activity_date }
+        end
+
         def index_item_hash(consumer, provider, consumer_version, index_item, base_url)
           {
             consumer: consumer_hash(index_item, consumer, consumer_version, base_url),
@@ -86,7 +92,7 @@ module PactBroker
 
         def pact_hash(index_item, base_url)
           {
-            createdAt: index_item.latest_pact.created_at.to_datetime.xmlschema,
+            createdAt: format_date_time(index_item.latest_pact.created_at),
             _links: {
               self: {
                 href: pact_url(base_url, index_item.latest_pact)
@@ -99,7 +105,7 @@ module PactBroker
           if index_item.latest_verification
             {
               success: index_item.latest_verification.success,
-              verifiedAt: index_item.latest_verification.created_at.to_datetime.xmlschema,
+              verifiedAt: format_date_time(index_item.latest_verification.created_at),
               _links: {
                 self: {
                   href: verification_url(index_item.latest_verification, base_url)
@@ -144,7 +150,7 @@ module PactBroker
         def latest_webhook_execution(index_item, base_url)
           if index_item.last_webhook_execution_date
             {
-              triggeredAt: index_item.last_webhook_execution_date.to_datetime.xmlschema
+              triggeredAt: format_date_time(index_item.last_webhook_execution_date)
             }
           end
         end

data/lib/pact_broker/api/decorators/format_date_time.rb

@@ -0,0 +1,15 @@
+module PactBroker
+  module Api
+    module Decorators
+      module FormatDateTime
+        def self.call(date_time)
+          date_time.to_time.utc.to_datetime.xmlschema if date_time
+        end
+
+        def format_date_time(date_time)
+          FormatDateTime.call(date_time)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/matrix_decorator.rb

@@ -1,12 +1,14 @@
 require 'ostruct'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/api/decorators/reason_decorator'
+require 'pact_broker/api/decorators/format_date_time'
 
 module PactBroker
   module Api
     module Decorators
       class MatrixDecorator
         include PactBroker::Api::PactBrokerUrls
+        include FormatDateTime
 
         def initialize(query_results_with_deployment_status_summary)
           @query_results_with_deployment_status_summary = query_results_with_deployment_status_summary
@@ -102,7 +104,7 @@ module PactBroker
 
         def pact_hash(line, base_url)
           {
-            createdAt: line.pact_created_at.to_datetime.xmlschema,
+            createdAt: format_date_time(line.pact_created_at),
             _links: {
               self: {
                 href: pact_url(base_url, line)
@@ -120,7 +122,7 @@ module PactBroker
             }
             {
               success: line.success,
-              verifiedAt: line.verification_executed_at.to_datetime.xmlschema,
+              verifiedAt: format_date_time(line.verification_executed_at),
               _links: {
                 self: {
                   href: verification_url_from_params(url_params, base_url)