pact_broker 2.71.0 → 2.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7fe157577be6cdfb603e4607b174224781db0b9b2ee7ccb1325cdda50ce129d
-  data.tar.gz: 9e28ef38f281ac6d6dbf1879d3794a8f915cb78bb8a82c464c7273ac9f8522dc
+  metadata.gz: f848cc7a613de4d084d69d97bf1b835c1d1bb130eec3c4c968800e348daf95bf
+  data.tar.gz: 1cbbbd2832eb98cd3904bba8aff8d909a95663c70abe7ad710473e46b3fb3e7c
 SHA512:
-  metadata.gz: 3e5d4d249f691a3e03725e3b827f4044eb2fde360cd0dd9128fce61a4442288083f825f654473cf1a3220745460675036951242cc801211eda258369e38eeb09
-  data.tar.gz: f8b9f3bdbfe42ca21291b41588ae4b3be15ca53efaec275e5356d8363dfa181e592942cb5e13bbd492fadb61d231cee68aaed009fef559c0645bc4debc4137c1
+  metadata.gz: 2200189e21700c21b67e1f8abc85574c3ed9367287568ce7dab4f808cd81ae01a80acd60fe3309cb134cd4466d2c243244429073d4e3af53b6b009bc58848782
+  data.tar.gz: c304534b3125112f4bd2bead0509e7e711face5f0e84ec88594cae1eb6e14a1618a4e61884ffbb0f66dbd813c4e5d4ebd61867ce276120a471a6a77f4c1e6e61

data/.github/workflows/test.yml

@@ -51,24 +51,4 @@ jobs:
         ruby_version: ["2.7"]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby_version }}
-      - uses: mirromutth/mysql-action@v1.1
-        with:
-          host port: 3306 # Optional, default value is 3306. The port of host
-          #container port: 3307 # Optional, default value is 3306. The port of container
-          character set server: 'utf8' # Optional, default value is 'utf8mb4'. The '--character-set-server' option for mysqld
-          collation server: 'utf8_general_ci' # Optional, default value is 'utf8mb4_general_ci'. The '--collation-server' option for mysqld
-          mysql version: '8.0' # Optional, default value is "latest". The version of the MySQL
-          mysql database: 'pact_broker' # Optional, default value is "test". The specified database which will be create
-          mysql root password: 'pact_broker' # Required if "mysql user" is empty, default is empty. The root superuser password
-          mysql user: 'pact_broker' # Required if "mysql root password" is empty, default is empty. The superuser for the specified database. Can use secrets, too
-          mysql password: 'pact_broker' # Required if "mysql user" exists. The password for the "mysql user"
-      - run: "bundle install"
-        env:
-          INSTALL_MYSQL: "true"
-      - run: "bundle exec rake"
-        env:
-          DATABASE_ADAPTER: github_actions_mysql
-          INSTALL_MYSQL: "true"
+      - run: script/test/run-rake-on-docker-compose-mysql.sh

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v2.72.0"></a>
+### v2.72.0 (2020-12-02)
+
+#### Features
+
+* allow overwritten data deletion to be configured with extra options	 ([fd809737](/../../commit/fd809737))
+* use the consumer version number in the metadata to select the correct consumer version for a pact version resource	 ([422c87fc](/../../commit/422c87fc))
+* return link to latest pact if more pacts exist when deleting pacts by tag	 ([b87ea704](/../../commit/b87ea704))
+* update output for clean dry run	 ([681a5ddd](/../../commit/681a5ddd))
+* update metrics output	 ([0617e9df](/../../commit/0617e9df))
+
 <a name="v2.71.0"></a>
 ### v2.71.0 (2020-11-28)
 

data/Dockerfile

@@ -26,7 +26,7 @@ RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSI
 
 
 COPY Gemfile /home/Gemfile
-COPY Gemfile.lock /home/Gemfile.lock
+# COPY Gemfile.lock /home/Gemfile.lock # lock file does not exist on CI
 COPY pact_broker.gemspec /home/pact_broker.gemspec
 COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
 COPY .gitignore /home/.gitignore
@@ -38,6 +38,10 @@ RUN echo '#!/bin/sh' >> /usr/local/bin/start
 RUN echo 'bundle exec rackup -o 0.0.0.0 -p 9292' >> /usr/local/bin/start
 RUN chmod +x /usr/local/bin/start
 
+RUN echo '#!/bin/sh' >> /usr/local/bin/test
+RUN echo 'bundle exec rake' >> /usr/local/bin/test
+RUN chmod +x /usr/local/bin/test
+
 RUN echo '#!/bin/sh' >> /home/init-db.sh
 RUN echo 'bundle exec rake db:prepare:test' >> /home/init-db.sh
 RUN chmod +x /home/init-db.sh

data/docker-compose-ci-mysql.yml

@@ -0,0 +1,37 @@
+version: "3"
+
+services:
+  mysql:
+    image: mysql:5.7.28
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: pact_broker
+      MYSQL_DATABASE: pact_broker
+      MYSQL_USER: pact_broker
+      MYSQL_PASSWORD: pact_broker
+    ports:
+      - "3306:3306"
+
+  tests:
+    build: .
+    depends_on:
+      - mysql
+    environment:
+      DATABASE_ADAPTER: docker_compose_mysql
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_MYSQL: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./spec:/home/spec
+      - ./db:/home/db
+      - ./config.ru:/home/config.ru
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+      - ./.rspec:/home/.rspec
+      - ./.rubocop:/home/.rubocop
+      - ./.gitignore:/home/.gitignore
+      - ./public:/home/public
+      - ./script/docker-container/test.sh:/usr/local/bin/test
+    entrypoint: dockerize
+    command: --wait tcp://mysql:3306 -timeout 60s test

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -75,7 +75,7 @@ module PactBroker
       end
 
       def decode_pact_metadata(metadata)
-        if metadata
+        if metadata && metadata != ''
           begin
             Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
               new_hash[k.to_sym] = v
@@ -116,6 +116,10 @@ module PactBroker
         "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/versions"
       end
 
+      def tagged_pact_versions_url consumer_name, provider_name, tag, base_url = ""
+        "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/tag/#{url_encode(tag)}"
+      end
+
       def integration_url consumer_name, provider_name, base_url = ""
         "#{base_url}/integrations/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end

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

@@ -0,0 +1,23 @@
+require 'pact_broker/hash_refinements'
+
+module PactBroker
+  module Api
+    module Resources
+      module MetadataResourceMethods
+        using PactBroker::HashRefinements
+
+        def pact_params
+          @pact_params ||= PactBroker::Pacts::PactParams.from_request(request, maybe_params_with_consumer_version_number.merge(path_info))
+        end
+
+        def maybe_params_with_consumer_version_number
+          metadata.slice(:consumer_version_number)
+        end
+
+        def metadata
+          @metadata ||= PactBrokerUrls.decode_pact_metadata(identifier_from_path[:metadata])
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/contracts/put_pact_params_contract'
 require 'pact_broker/webhooks/execution_configuration'
 require 'pact_broker/api/resources/webhook_execution_methods'
+require 'pact_broker/api/resources/pact_resource_methods'
 
 module PactBroker
   module Api
@@ -15,6 +16,7 @@ module PactBroker
       class Pact < BaseResource
         include PacticipantResourceMethods
         include WebhookExecutionMethods
+        include PactResourceMethods
 
         def content_types_provided
           [
@@ -110,19 +112,6 @@ module PactBroker
           @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
         end
 
-        def set_post_deletion_response
-          latest_pact = pact_service.find_latest_pact(pact_params)
-          response_body = { "_links" => { index: { href: base_url } } }
-          if latest_pact
-            response_body["_links"]["pb:latest-pact-version"] = {
-              href: latest_pact_url(base_url, latest_pact),
-              title: "Latest pact"
-            }
-          end
-          response.body = response_body.to_json
-          response.headers["Content-Type" => "application/hal+json;charset=utf-8"]
-        end
-
         def webhook_options
           {
             database_connector: database_connector,

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

@@ -0,0 +1,23 @@
+module PactBroker
+  module Api
+    module Resources
+      module PactResourceMethods
+        def set_post_deletion_response
+          latest_pact = pact_service.find_latest_pact(
+            consumer_name: pact_params[:consumer_name],
+            provider_name: pact_params[:provider_name]
+          )
+          response_body = { "_links" => { index: { href: base_url } } }
+          if latest_pact
+            response_body["_links"]["pb:latest-pact-version"] = {
+              href: latest_pact_url(base_url, latest_pact),
+              title: "Latest pact"
+            }
+          end
+          response.body = response_body.to_json
+          response.headers["Content-Type" => "application/hal+json;charset=utf-8"]
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,12 @@
 require 'pact_broker/api/resources/pact'
+require 'pact_broker/api/resources/metadata_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class PactVersion < Pact
+        include MetadataResourceMethods
+
         def allowed_methods
           ["GET", "OPTIONS"]
         end

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

@@ -1,11 +1,14 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/configuration'
 require 'pact_broker/api/decorators/tagged_pact_versions_decorator'
+require 'pact_broker/api/resources/pact_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class TaggedPactVersions < BaseResource
+        include PactResourceMethods
+
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
@@ -24,6 +27,7 @@ module PactBroker
 
         def delete_resource
           pact_service.delete_all_pact_publications_between consumer_name, and: provider_name, tag: identifier_from_path[:tag]
+          set_post_deletion_response
           true
         end
 

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

@@ -4,12 +4,14 @@ require 'pact_broker/domain/verification'
 require 'pact_broker/api/contracts/verification_contract'
 require 'pact_broker/api/decorators/verification_decorator'
 require 'pact_broker/api/resources/webhook_execution_methods'
+require 'pact_broker/api/resources/metadata_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class Verifications < BaseResource
         include WebhookExecutionMethods
+        include MetadataResourceMethods
 
         def content_types_accepted
           [["application/json", :from_json]]
@@ -75,10 +77,6 @@ module PactBroker
           PactBroker::Api::Decorators::VerificationDecorator.new(model)
         end
 
-        def metadata
-          PactBrokerUrls.decode_pact_metadata(identifier_from_path[:metadata])
-        end
-
         def wip?
           metadata[:wip] == 'true'
         end

data/lib/pact_broker/db/clean_incremental.rb

@@ -43,35 +43,20 @@ module PactBroker
       end
 
       def version_ids_to_keep
-        @version_ids_to_keep ||= keep.collect do | selector |
+        @version_ids_to_keep ||= selected_versions_to_keep.reduce(&:union)
+      end
+
+      def selected_versions_to_keep
+        keep.collect do | selector |
           PactBroker::Domain::Version.select(:id).for_selector(selector)
-        end.reduce(&:union)
+        end
       end
 
       def call
         require 'pact_broker/db/models'
 
         if dry_run?
-          to_delete = PactBroker::Domain::Version
-            .where(id: version_ids_to_delete.select(:id))
-            .all
-            .group_by{ | v | v.pacticipant_id }
-            .each_with_object({}) do | (pacticipant_id, versions), thing |
-              thing[versions.first.pacticipant.name] = {
-                count: versions.count,
-                from_version: {
-                  number: versions.first.number,
-                  created: DateHelper.distance_of_time_in_words(versions.first.created_at, DateTime.now) + " ago",
-                  tags: versions.first.tags.collect(&:name)
-                },
-                to_version: {
-                  number: versions.last.number,
-                  created: DateHelper.distance_of_time_in_words(versions.last.created_at, DateTime.now) + " ago",
-                  tags: versions.last.tags.collect(&:name)
-                }
-              }
-            end
-          { "to_delete" => to_delete }
+          dry_run_results
         else
           before_counts = current_counts
           result = PactBroker::Domain::Version.where(id: resolve_ids(version_ids_to_delete)).delete
@@ -102,6 +87,131 @@ module PactBroker
         referenced_pact_version_ids = db[:pact_publications].select(:pact_version_id).union(db[:verifications].select(:pact_version_id))
         db[:pact_versions].where(id: referenced_pact_version_ids).invert.delete
       end
+
+      def version_info(version)
+        {
+          "number" => version.number,
+          "created" => DateHelper.distance_of_time_in_words(version.created_at, DateTime.now) + " ago",
+          "tags" => version.tags.collect(&:name).sort
+        }
+      end
+
+      def dry_run_results
+        to_delete = dry_run_to_delete
+        to_keep = dry_run_to_keep
+
+        kept_per_selector = keep.collect do | selector |
+          {
+            selector: selector.to_hash,
+            count: PactBroker::Domain::Version.for_selector(selector).count
+          }
+        end
+
+        pacticipant_results = pacticipants.each_with_object({}) do | pacticipant, results |
+          results[pacticipant.name] = {
+            "toDelete" => to_delete[pacticipant.name] || { "count" => 0 },
+            "toKeep" => to_keep[pacticipant.id]
+          }
+        end
+
+        total_versions_count = PactBroker::Domain::Version.count
+        versions_to_keep_count = version_ids_to_keep.count
+        versions_to_delete_count = version_ids_to_delete.count
+
+        {
+          "counts" => {
+            "totalVersions" => total_versions_count,
+            "versionsToDelete" => versions_to_delete_count,
+            "versionsNotToKeep" => total_versions_count - versions_to_keep_count,
+            "versionsToKeep" => versions_to_keep_count,
+            "versionsToKeepBySelector" => kept_per_selector,
+          },
+          "versionSummary" => pacticipant_results
+        }
+      end
+
+      def dry_run_latest_versions_to_keep
+        latest_undeleted_versions_by_order = PactBroker::Domain::Version.where(id: version_ids_to_delete.select(:id))
+          .invert
+          .select_group(:pacticipant_id)
+          .select_append{ max(order).as(latest_order) }
+
+        lv_versions_join = {
+          Sequel[:lv][:latest_order] => Sequel[:versions][:order],
+          Sequel[:lv][:pacticipant_id] => Sequel[:versions][:pacticipant_id]
+        }
+
+        PactBroker::Domain::Version
+          .select_all_qualified
+          .join(latest_undeleted_versions_by_order, lv_versions_join, { table_alias: :lv })
+      end
+
+      def dry_run_earliest_versions_to_keep
+        earliest_undeleted_versions_by_order = PactBroker::Domain::Version.where(id: version_ids_to_delete.select(:id))
+          .invert
+          .select_group(:pacticipant_id)
+          .select_append{ min(order).as(first_order) }
+
+        ev_versions_join = {
+          Sequel[:lv][:first_order] => Sequel[:versions][:order],
+          Sequel[:lv][:pacticipant_id] => Sequel[:versions][:pacticipant_id]
+        }
+
+        PactBroker::Domain::Version
+          .select_all_qualified
+          .join(earliest_undeleted_versions_by_order, ev_versions_join, { table_alias: :lv })
+      end
+
+      def dry_run_to_delete
+        PactBroker::Domain::Version
+          .where(id: version_ids_to_delete.select(:id))
+          .all
+          .group_by{ | v | v.pacticipant_id }
+          .each_with_object({}) do | (pacticipant_id, versions), thing |
+            thing[versions.first.pacticipant.name] = {
+              "count" => versions.count,
+              "fromVersion" => version_info(versions.first),
+              "toVersion" => version_info(versions.last)
+            }
+          end
+      end
+
+      def dry_run_to_keep
+        latest_to_keep = dry_run_latest_versions_to_keep.eager(:tags).each_with_object({}) do | version, r |
+          r[version.pacticipant_id] = {
+            "firstVersion" => version_info(version)
+          }
+        end
+
+        earliest_to_keep = dry_run_earliest_versions_to_keep.eager(:tags).each_with_object({}) do | version, r |
+          r[version.pacticipant_id] = {
+            "latestVersion" => version_info(version)
+          }
+        end
+
+        counts = counts_to_keep
+
+        pacticipants.collect(&:id).each_with_object({}) do | pacticipant_id, results |
+          results[pacticipant_id] = { "count" => counts[pacticipant_id] || 0 }
+                      .merge(earliest_to_keep[pacticipant_id] || {})
+                      .merge(latest_to_keep[pacticipant_id] || {})
+        end
+      end
+
+      def counts_to_keep
+        db[:versions].where(id: version_ids_to_delete.select(:id))
+          .invert
+          .select_group(:pacticipant_id)
+          .select_append{ count(1).as(count) }
+          .all
+          .each_with_object({}) do | row, counts |
+            counts[row[:pacticipant_id]] = row[:count]
+          end
+      end
+
+      def pacticipants
+        @pacticipants ||= PactBroker::Domain::Pacticipant.order_ignore_case(:name).all
+      end
     end
   end
 end