pact_broker 2.37.0 → 2.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2f3154a77ea59e200285d2ce7771d02f8333c47
-  data.tar.gz: 5e9096d23e486f5cd2b370b61b7be1733cfa7876
+SHA256:
+  metadata.gz: 2e92bf0689f639ae130896a19f422d0c257a26e287c432692fb3ac5743da5eda
+  data.tar.gz: dbefceec4b74884062b31e0b4c84257252a6fa24f1a1850f149ebb09e3437717
 SHA512:
-  metadata.gz: f1fefb75e3e0e1a7ffe4008c6a35b580569069d4ac3d48b3848d02f730e7723a22a4b425f2306dabc3697d3cdd4d1ae78f728d84b70615d1805736e3dfb48d2c
-  data.tar.gz: 4faa99affeef607ac56cb4feaffd9142fc1351ee101d5eb798f48f8b9d6675814c058d5d00e4af2169ab28b43e511fbda02e717461ae2af6f6e6ef3dc12b48d8
+  metadata.gz: 55ae521524e210a6e136c07af4a0046c51063173ba911db685dcb0779a37310f3c42d9a045dcf2807b4e515924b0487eb5b954e78173f83df8c660ce454ed1d7
+  data.tar.gz: 507652c8d9105a7b8aaad4b3e9241b05829f2067e928df7f901ff3a0cd7ece60941a177dc199144c2b40971bc0cd218f3d7410c6260ee62bf11a2461f823950b

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="v2.38.0"></a>
+### v2.38.0 (2019-09-20)
+
+
+#### Features
+
+* add pactflow message to start up and error logs	 ([530dbfe9](/../../commit/530dbfe9))
+* allow interaction ids to be manually set for test data	 ([4e256102](/../../commit/4e256102))
+
+* **dashboard**
+  * use 'refreshable' link for latest verification result so pact can be refreshed and display the latest result	 ([1ab8a5d9](/../../commit/1ab8a5d9))
+
+
+#### Bug Fixes
+
+* don't drop column from view in down step, because you can't remove a column from a view in posgres	 ([045f3f38](/../../commit/045f3f38))
+* add test results to all verifications views	 ([9bc1eab1](/../../commit/9bc1eab1))
+
+
 <a name="v2.37.0"></a>
 ### v2.37.0 (2019-09-02)
 

data/DEVELOPER_DOCUMENTATION.md

@@ -3,11 +3,17 @@
 ## File structure
 
 * Application code - [lib](lib)
-  * List of API endpoints - [lib/pact_broker/api.rb](lib/pact_broker/api.rb)
+  * The aggregated application (API, UI, middleware, HAL Browser, diagnostic endpoints etc) - [lib/pact_broker/app.rb](lib/pact_broker/app.rb)
   * API - [lib/pact_broker/api](lib/pact_broker/api)
+    * Routes - [lib/pact_broker/api.rb](lib/pact_broker/api.rb)
     * HTTP Resources - [lib/pact_broker/api/resources](lib/pact_broker/api/resources) These handle the HTTP requests.
     * Decorators - [lib/pact_broker/api/decorators](lib/pact_broker/api/decorators) These render the response bodies.
     * Contracts - [lib/pact_broker/api/contracts](lib/pact_broker/api/contracts) These validate incoming API requests.
+  * UI - [lib/pact_broker/ui](lib/pact_broker/ui)
+    * Routes - [lib/pact_broker/ui/app.rb](lib/pact_broker/ui/app.rb)
+    * Controllers - [lib/pact_broker/ui/controllers](lib/pact_broker/ui/controllers) These handle the HTTP requests.
+    * Views - [lib/pact_broker/ui/views](lib/pact_broker/ui/views) These render the view using HAML
+    * View models - [lib/pact_broker/ui/view_models](lib/pact_broker/ui/view_models) These expose the domain model data in a way that is suited to rendering in a view.
   * Domain - Domain classes were intially created in [lib/pact_broker/domain](lib/pact_broker/domain) but are now put in their own modules. The ones left here just haven't been migrated yet. The module name is the plural of the domain class name. eg `lib/pact_broker/widgets/widget.rb`.
   * Services and Repositories - in the module with the name of their domain concept. eg `lib/pact_broker/widgets/service.rb` and `lib/pact_broker/widgets/repository.rb`
   * Standalone "function as class" classes go into the module they relate to. This pattern is used when there is some significant stateless logic that we want to

data/config/database.yml

@@ -17,7 +17,7 @@ test:
     username: postgres
     password: postgres
     host: "localhost"
-    port: "5432"
+    port: "5433"
   mysql:
     <<: *default
     adapter: mysql2

data/db/migrations/20190909_add_test_results_to_all_verifications.rb

@@ -0,0 +1,23 @@
+Sequel.migration do
+  up do
+    create_or_replace_view(:all_verifications,
+      from(:verifications).select(
+        Sequel[:verifications][:id],
+        Sequel[:verifications][:number],
+        :success,
+        :provider_version_id,
+        Sequel[:v][:number].as(:provider_version_number),
+        Sequel[:v][:order].as(:provider_version_order),
+        :build_url,
+        :pact_version_id,
+        :execution_date,
+        Sequel[:verifications][:created_at],
+        :test_results
+        ).join(:versions, {id: :provider_version_id}, {:table_alias => :v})
+    )
+  end
+
+  down do
+    # do nothing - you can't drop columns from a postgres view
+  end
+end

data/db/migrations/20190910_add_test_results_to_latest_verifications.rb

@@ -0,0 +1,37 @@
+Sequel.migration do
+  up do
+    # The most recent verification for each pact_version
+    # provider_version column is DEPRECATED, use provider_version_number
+    # Think this can be replaced by latest_verification_id_for_pact_version_and_provider_version?
+    v = :verifications
+    create_or_replace_view(:latest_verifications,
+      from(v)
+        .select(
+          Sequel[v][:id],
+          Sequel[v][:number],
+          Sequel[v][:success],
+          Sequel[:s][:number].as(:provider_version),
+          Sequel[v][:build_url],
+          Sequel[v][:pact_version_id],
+          Sequel[v][:execution_date],
+          Sequel[v][:created_at],
+          Sequel[v][:provider_version_id],
+          Sequel[:s][:number].as(:provider_version_number),
+          Sequel[:s][:order].as(:provider_version_order),
+          Sequel[v][:test_results])
+        .join(:latest_verification_numbers,
+          {
+            Sequel[v][:pact_version_id] => Sequel[:lv][:pact_version_id],
+            Sequel[v][:number] => Sequel[:lv][:latest_number]
+          }, { table_alias: :lv })
+        .join(:versions,
+          {
+            Sequel[v][:provider_version_id] => Sequel[:s][:id]
+          }, { table_alias: :s })
+    )
+  end
+
+  down do
+    # do nothing - you can't drop columns from a postgres view
+  end
+end

data/db/migrations/20190911_add_test_results_to_latest_verifications_for_pact_versions.rb

@@ -0,0 +1,34 @@
+Sequel.migration do
+  up do
+    # The most recent verification for each pact_version
+    v = :verifications
+    create_or_replace_view(:latest_verifications_for_pact_versions,
+      from(v)
+        .select(
+          Sequel[v][:id],
+          Sequel[v][:number],
+          Sequel[v][:success],
+          Sequel[v][:build_url],
+          Sequel[v][:pact_version_id],
+          Sequel[v][:execution_date],
+          Sequel[v][:created_at],
+          Sequel[v][:provider_version_id],
+          Sequel[:s][:number].as(:provider_version_number),
+          Sequel[:s][:order].as(:provider_version_order),
+          Sequel[v][:test_results])
+        .join(:latest_verification_ids_for_pact_versions,
+          {
+            Sequel[v][:pact_version_id] => Sequel[:lv][:pact_version_id],
+            Sequel[v][:id] => Sequel[:lv][:latest_verification_id]
+          }, { table_alias: :lv })
+        .join(:versions,
+          {
+            Sequel[v][:provider_version_id] => Sequel[:s][:id]
+          }, { table_alias: :s })
+    )
+  end
+
+  down do
+    # do nothing - you can't drop columns from a postgres view
+  end
+end

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

@@ -102,13 +102,15 @@ module PactBroker
         end
 
         def verification_hash(index_item, base_url)
+          # Use the 'latest pact' URL instead of the permalink URL so that the page can be
+          # refreshed, and the latest verification result will be updated to the  most recent
           if index_item.latest_verification
             {
               success: index_item.latest_verification.success,
               verifiedAt: format_date_time(index_item.latest_verification.created_at),
               _links: {
                 self: {
-                  href: verification_url(index_item.latest_verification, base_url)
+                  href: latest_verification_for_pact_url(index_item.latest_pact, base_url, false)
                 }
               }
             }

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -157,12 +157,20 @@ module PactBroker
         "#{base_url}/verification-results/consumer/#{url_encode(version.pacticipant.name)}/version/#{version.number}/latest"
       end
 
-      def latest_verification_for_pact_url pact, base_url
-        verification_url_from_params(
-          provider_name: pact.provider_name,
-          consumer_name: pact.consumer_name,
-          pact_version_sha: pact.pact_version_sha,
-          verification_number: 'latest')
+      def latest_verification_for_pact_url pact, base_url, permalink = true
+        if permalink
+          verification_url_from_params(
+            {
+              provider_name: provider_name(pact),
+              consumer_name: consumer_name(pact),
+              pact_version_sha: pact.pact_version_sha,
+              verification_number: 'latest'
+            },
+            base_url
+          )
+        else
+          pact_url(base_url, pact) + "/verification-results/latest"
+        end
       end
 
       def verification_triggered_webhooks_url verification, base_url = ''
@@ -276,6 +284,30 @@ module PactBroker
           'consumer', url_encode(params[:consumer_name])
         ].join('/')
       end
+
+      def consumer_name(thing)
+        if thing.respond_to?(:consumer_name)
+          thing.consumer_name
+        elsif thing.respond_to?(:consumer)
+          thing.consumer.name
+        elsif thing.respond_to?(:[])
+          thing[:consumer_name]
+        else
+          nil
+        end
+      end
+
+      def provider_name(thing)
+        if thing.respond_to?(:provider_name)
+          thing.provider_name
+        elsif thing.respond_to?(:provider)
+          thing.provider.name
+        elsif thing.respond_to?(:[])
+          thing[:provider_name]
+        else
+          nil
+        end
+      end
     end
   end
 end

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

@@ -4,9 +4,7 @@ require 'json'
 module PactBroker
   module Api
     module Resources
-
       class Index < BaseResource
-
         def content_types_provided
           [["application/hal+json", :to_json]]
         end

data/lib/pact_broker/app.rb

@@ -36,6 +36,7 @@ module PactBroker
       prepare_database
       load_configuration_from_database
       seed_example_data
+      print_startup_message
     end
 
     # Allows middleware to be inserted at the bottom of the shared middlware stack
@@ -223,5 +224,9 @@ module PactBroker
         @app_builder
       end
     end
+
+    def print_startup_message
+      logger.info "\n\n#{'*' * 80}\n\nWant someone to manage your Pact Broker for you? Check out https://pactflow.io/oss for a hardened, fully supported SaaS version of the Pact Broker with an improved UI + more.\n\n#{'*' * 80}\n"
+    end
   end
 end

data/lib/pact_broker/logging.rb

@@ -35,6 +35,7 @@ module PactBroker
       message = "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
       message = "#{description} - #{message}" if description
       logger.error message
+      logger.info "\n\n#{'*' * 80}\n\nPrefer it was someone else's job to deal with this error? Check out https://pactflow.io/oss for a hardened, fully supported SaaS version of the Pact Broker with an improved UI  + more.\n\n#{'*' * 80}\n"
     end
   end
 

data/lib/pact_broker/pacts/content.rb

@@ -31,14 +31,26 @@ module PactBroker
         Content.from_hash(SortContent.call(pact_hash))
       end
 
-      def with_ids
+      def with_test_results(test_results)
         new_pact_hash = pact_hash.dup
         if interactions && interactions.is_a?(Array)
-          new_pact_hash['interactions'] = add_ids(interactions)
+          new_pact_hash['interactions'] = merge_verification_results(interactions, test_results)
         end
 
         if messages && messages.is_a?(Array)
-          new_pact_hash['messages'] = add_ids(messages)
+          new_pact_hash['messages'] = merge_verification_results(messages, test_results)
+        end
+        Content.from_hash(new_pact_hash)
+      end
+
+      def with_ids(overwrite_existing_id = true)
+        new_pact_hash = pact_hash.dup
+        if interactions && interactions.is_a?(Array)
+          new_pact_hash['interactions'] = add_ids(interactions, overwrite_existing_id)
+        end
+
+        if messages && messages.is_a?(Array)
+          new_pact_hash['messages'] = add_ids(messages, overwrite_existing_id)
         end
         Content.from_hash(new_pact_hash)
       end
@@ -64,6 +76,10 @@ module PactBroker
         pact_hash.is_a?(Hash) ? pact_hash['interactions'] : nil
       end
 
+      def messages_or_interactions
+        messages || interactions
+      end
+
       def pact_specification_version
         maybe_pact_specification_version_1 = pact_hash['metadata']['pactSpecification']['version'] rescue nil
         maybe_pact_specification_version_2 = pact_hash['metadata']['pact-specification']['version'] rescue nil
@@ -75,13 +91,17 @@ module PactBroker
 
       attr_reader :pact_hash
 
-      def add_ids(interactions)
+      def add_ids(interactions, overwrite_existing_id)
         interactions.map do | interaction |
           if interaction.is_a?(Hash)
-            # just in case there is a previous ID in there
-            interaction_without_id = interaction.reject { |k, _| k == "_id" }
-            # make the _id the first key in the hash when rendered to JSON
-            { "_id" => generate_interaction_sha(interaction_without_id) }.merge(interaction)
+            if !interaction.key?("_id") || overwrite_existing_id
+              # just in case there is a previous ID in there
+              interaction_without_id = interaction.reject { |k, _| k == "_id" }
+              # make the _id the first key in the hash when rendered to JSON
+              { "_id" => generate_interaction_sha(interaction_without_id) }.merge(interaction)
+            else
+              interaction
+            end
           else
             interaction
           end

data/lib/pact_broker/test/test_data_builder.rb

@@ -331,7 +331,7 @@ module PactBroker
       end
 
       def prepare_json_content(json_content)
-        PactBroker::Pacts::Content.from_json(json_content).with_ids.to_json
+        PactBroker::Pacts::Content.from_json(json_content).with_ids(false).to_json
       end
 
       def set_created_at_if_set created_at, table_name, selector

data/lib/pact_broker/verifications/all_verifications.rb

@@ -38,3 +38,4 @@ end
 #  pact_version_id         | integer                     |
 #  execution_date          | timestamp without time zone |
 #  created_at              | timestamp without time zone |
+#  test_results            | text                        |

data/lib/pact_broker/verifications/latest_verification_for_pact_version.rb

@@ -36,3 +36,4 @@ end
 #  provider_version_id     | integer                     |
 #  provider_version_number | text                        |
 #  provider_version_order  | integer                     |
+#  test_results            | text                        |

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.37.0'
+  VERSION = '2.38.0'
 end

data/lib/pact_broker/webhooks/webhook.rb

@@ -108,6 +108,7 @@ end
 #  password             | text                        |
 #  enabled              | boolean                     | DEFAULT true
 #  description          | text                        |
+#  headers              | text                        |
 # Indexes:
 #  webhooks_pkey   | PRIMARY KEY btree (id)
 #  uq_webhook_uuid | UNIQUE btree (uuid)

data/spec/fixtures/dashboard.json

@@ -26,7 +26,7 @@
       "latestVerificationResult": {
         "_links": {
           "self": {
-            "href": "verification_url"
+            "href": "latest_verification_url"
           }
         },
         "success": true,

data/spec/lib/pact_broker/api/decorators/dashboard_decorator_spec.rb

@@ -49,7 +49,7 @@ module PactBroker
 
         before do
           allow_any_instance_of(DashboardDecorator).to receive(:pact_url).with(base_url, pact).and_return('pact_url')
-          allow_any_instance_of(DashboardDecorator).to receive(:verification_url).with(verification, base_url).and_return('verification_url')
+          allow_any_instance_of(DashboardDecorator).to receive(:latest_verification_for_pact_url).with(pact, base_url, false).and_return('latest_verification_url')
           allow_any_instance_of(DashboardDecorator).to receive(:pacticipant_url).with(base_url, consumer).and_return('consumer_url')
           allow_any_instance_of(DashboardDecorator).to receive(:pacticipant_url).with(base_url, provider).and_return('provider_url')
           allow_any_instance_of(DashboardDecorator).to receive(:version_url).with(base_url, consumer_version).and_return('consumer_version_url')

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -113,6 +113,20 @@ module PactBroker
           end
         end
       end
+
+      describe "latest_verification_for_pact_url" do
+        context "when permalink = true" do
+          subject { PactBrokerUrls.latest_verification_for_pact_url(pact, base_url, true) }
+
+          it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/5hbfu/verification-results/latest" }
+        end
+
+        context "when permalink = false" do
+          subject { PactBrokerUrls.latest_verification_for_pact_url(pact, base_url, false) }
+
+          it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/version/123%2F456/verification-results/latest" }
+        end
+      end
     end
   end
 end

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

@@ -59,6 +59,14 @@ module PactBroker
             expect(subject.messages.first["_id"]).to eq "some-id"
           end
         end
+
+        context "when override_existing_ids = false (for setting up test data)" do
+          let(:interaction) { { "_id" => "1", "foo" => "bar" } }
+
+          it "does not override the existing ids" do
+            expect(subject.interactions.first["_id"]).to eq "1"
+          end
+        end
       end
 
       describe "content_that_affects_verification_results" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.37.0
+  version: 2.38.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -714,6 +714,9 @@ files:
 - db/migrations/20190525_add_description_column_to_webhooks.rb
 - db/migrations/20190602_add_headers_column_to_webhooks.rb
 - db/migrations/20190603_migrate_webhook_headers.rb
+- db/migrations/20190909_add_test_results_to_all_verifications.rb
+- db/migrations/20190910_add_test_results_to_latest_verifications.rb
+- db/migrations/20190911_add_test_results_to_latest_verifications_for_pact_versions.rb
 - db/migrations/migration_helper.rb
 - db/test/backwards_compatibility/.rspec
 - db/test/backwards_compatibility/Appraisals
@@ -753,7 +756,6 @@ files:
 - example/basic_auth/config.ru
 - example/config.ru
 - example/example_data.sql
-- example/pact_broker_database.sqlite3
 - lib/db.rb
 - lib/pact/doc/README.md
 - lib/pact/doc/doc_file.rb
@@ -1527,7 +1529,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: See description