pact_broker 2.69.0 → 2.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c656c61487fd81baf9eb94f73fa12ab27bdf5cea1bd2d670af63199123b6ef
-  data.tar.gz: '04022874b3eeb6681e79163431ce63c8d6760741dc7ec8db30cc87b8f9257a94'
+  metadata.gz: b57a2f04694ce119675cd5b4fb647e1c2faff71b890958391ca30846ef0d7fab
+  data.tar.gz: 8b6484329b0821600417fc17ad564a14de06edf2edc21939423c34ea2795cee1
 SHA512:
-  metadata.gz: ce0f9fb3186ab25c419b61665245977abfbaa8d245437699c44de54783bde86d8281b950172532d02a31f6aa33f36046dde7a0636075fabe75f3f074c33016c2
-  data.tar.gz: f6b8baa8a66b80b50df9223086f8e67dd9233106897b15f5cfa16328e954805de786d4fbe672f3cee5ba831001edd78f5c0a977dfc5d767d4c79aa46a61b1010
+  metadata.gz: e4d1c82adbbb041f38d64200ccb0f1fc8d4672f3a9e445db0dcf428b25c8353c5922a3fb579b74560114df476886fb8aee93d2b793643ae9bbbbd8f786fec443
+  data.tar.gz: dc130a9cea4a62c741c401290b385f807c4597073a1ae467d3b334bd058267eca2179ebb6be60d53c2f6cf7046c7b567edf473738a2642e122d1c6e40938301a

data/.github/workflows/test.yml

@@ -0,0 +1,62 @@
+name: Test
+
+on: push
+
+jobs:
+  postgres:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        ruby_version: ["2.5", "2.7"]
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+        env:
+          INSTALL_PG: "true"
+      - run: "bundle exec rake"
+        env:
+          DATABASE_ADAPTER: github_actions_postgres
+          INSTALL_PG: "true"
+  mysql:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        ruby_version: ["2.5", "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"

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="v2.70.0"></a>
+### v2.70.0 (2020-11-28)
+
+#### Features
+
+* allow limit to be applied to clean task	 ([d29e5c62](/../../commit/d29e5c62))
+* optimise the query to load the tags with latest flags	 ([bc47613f](/../../commit/bc47613f))
+* optimise query to find head tags for a pact	 ([67309e37](/../../commit/67309e37))
+
+* **wip pacts**
+  * experimental feature - if no provider versions exist, consider all head pacts wip	 ([a635cc53](/../../commit/a635cc53))
+
+#### Bug Fixes
+
+* return empty body when group csv is requested for a pacticipant that does not have any integrations	 ([fb4e28ce](/../../commit/fb4e28ce))
+
 <a name="v2.69.0"></a>
 ### v2.69.0 (2020-11-24)
 

data/DEVELOPER_SETUP.md

@@ -28,6 +28,12 @@ This allows you to open a shell to a development environment where you can run t
 
 Remember to rebuild the image if you change any of the gems or gem versions.
 
+* Run the server on the docker image
+
+    ```sh
+    docker run --rm -v $(PWD):/home -w /home --entrypoint /bin/sh -p 9292:9292 -it pact_broker:dev /usr/local/bin/start
+    ```
+
 ### With native 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].

data/Dockerfile

@@ -26,6 +26,7 @@ RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSI
 
 
 COPY Gemfile /home/Gemfile
+COPY Gemfile.lock /home/Gemfile.lock
 COPY pact_broker.gemspec /home/pact_broker.gemspec
 COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
 COPY .gitignore /home/.gitignore
@@ -33,9 +34,9 @@ COPY .gitignore /home/.gitignore
 RUN gem install bundler -v '~>2.0.0' \
     && bundle install --jobs 3 --retry 3
 
-RUN echo '#!/bin/sh' >> /home/start.sh
-RUN echo 'bundle exec rackup -o 0.0.0.0 -p 9292' >> /home/start.sh
-RUN chmod +x /home/start.sh
+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' >> /home/init-db.sh
 RUN echo 'bundle exec rake db:prepare:test' >> /home/init-db.sh

data/Gemfile

@@ -36,3 +36,7 @@ end
 if ENV['INSTALL_PG'] == 'true'
   gem 'pg', '~>1.2'
 end
+
+if ENV['X_PACT_DEVELOPMENT'] == 'true'
+  gem 'pact-support', path: '../pact-support'
+end

data/ISSUES.md

@@ -0,0 +1,23 @@
+# Issues
+
+## Reproducing an issue
+
+In [script/reproduce-issue.rb](script/reproduce-issue.rb) you will find a fluent API that allows you to simulate client libraries interacting with the Pact Broker.
+
+You can use it to easily reproduce issues.
+
+To use it:
+
+* Run the Pact Broker using the latest development code:
+
+    ```
+    docker-compose -f docker-compose-issue-repro.yml up --build pact-broker
+    ```
+
+* Run the reproduction script.
+
+    ```
+    docker-compose -f docker-compose-issue-repro.yml up repro-issue
+    ```
+
+You can modify `script/reproduce-issue.rb` and then re-run it with the change applied.

data/config/database.yml

@@ -36,6 +36,20 @@ test:
     <<: *default
     adapter: mysql2
     host: "192.168.0.9"
+  github_actions_postgres:
+    adapter: postgres
+    database: postgres
+    username: postgres
+    password: postgres
+    host: localhost
+    port: "5432"
+  github_actions_mysql:
+    adapter: mysql2
+    database: pact_broker
+    username: pact_broker
+    password: pact_broker
+    host: localhost
+    port: 3306
 
 development:
   default:

data/docker-compose-issue-repro.yml

@@ -2,17 +2,21 @@ version: "3"
 
 services:
   pact-broker:
-    build:
-      context: .
-      dockerfile: issue-reproduction/Dockerfile-pact-broker
+    build: .
     ports:
       - "9292:9292"
-    command: bundle exec rackup -p 9292 -o 0.0.0.0
+    entrypoint: /usr/local/bin/start
+    environment:
+      - RACK_ENV=production
+    volumes:
+      - $PWD:/home
 
   repro-issue:
-    build:
-      context: .
-      dockerfile: issue-reproduction/Dockerfile-pact-broker
+    build: .
     depends_on:
       - pact-broker
     command: dockerize -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    environment:
+      - PACT_BROKER_BASE_URL=http://pact-broker:9292
+    volumes:
+      - $PWD:/home

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

@@ -0,0 +1,36 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/db/clean'
+require 'pact_broker/matrix/unresolved_selector'
+
+module PactBroker
+  module Api
+    module Resources
+      class Clean < BaseResource
+        def content_types_accepted
+          [["application/json"]]
+        end
+
+        def content_types_provided
+          [["application/hal+json"]]
+        end
+
+        def allowed_methods
+          ["POST", "OPTIONS"]
+        end
+
+        def process_post
+          keep_selectors = (params[:keep] || []).collect do | hash |
+            PactBroker::Matrix::UnresolvedSelector.new(hash)
+          end
+
+          result = PactBroker::DB::Clean.call(Sequel::Model.db, { keep: keep_selectors })
+          response.body = result.to_json
+        end
+
+        def policy_name
+          :'integrations::clean'
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,11 @@ module PactBroker
         end
 
         def to_csv
-          PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
+          if group
+            PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
+          else
+            ""
+          end
         end
 
         def policy_name

data/lib/pact_broker/db/clean.rb

@@ -1,10 +1,13 @@
 require 'sequel'
 require 'pact_broker/project_root'
 require 'pact_broker/pacts/latest_tagged_pact_publications'
+require 'pact_broker/logging'
 
 module PactBroker
   module DB
     class Clean
+      include PactBroker::Logging
+
 
       class Unionable < Array
         alias_method :union, :+
@@ -46,7 +49,7 @@ module PactBroker
       def latest_tagged_pact_publications_ids_to_keep
         @latest_tagged_pact_publications_ids_to_keep ||= resolve_ids(keep.select(&:tag).select(&:latest).collect do | selector |
           PactBroker::Pacts::LatestTaggedPactPublications.select(:id).for_selector(selector)
-        end.reduce(&:union))
+        end.reduce(&:union) || [])
       end
 
 

data/lib/pact_broker/db/clean_incremental.rb

@@ -0,0 +1,78 @@
+require 'pact_broker/logging'
+require 'pact_broker/matrix/unresolved_selector'
+
+module PactBroker
+  module DB
+    class CleanIncremental
+      include PactBroker::Logging
+
+      DEFAULT_KEEP_SELECTORS = [
+        PactBroker::Matrix::UnresolvedSelector.new(tag: true, latest: true),
+        PactBroker::Matrix::UnresolvedSelector.new(latest: true),
+        PactBroker::Matrix::UnresolvedSelector.new(max_age: 90)
+      ]
+      TABLES = [:versions, :pact_publications, :pact_versions, :verifications, :triggered_webhooks, :webhook_executions]
+
+      def self.call database_connection, options = {}
+        new(database_connection, options).call
+      end
+
+      def initialize database_connection, options = {}
+        @db = database_connection
+        @options = options
+      end
+
+      def keep
+        options[:keep] || DEFAULT_KEEP_SELECTORS
+      end
+
+      def limit
+        options[:limit] || 1000
+      end
+
+      def resolve_ids(query, column_name = :id)
+        query.collect { |h| h[column_name] }
+      end
+
+      def version_ids_to_delete
+        db[:versions].where(id: version_ids_to_keep).invert.limit(limit).order(Sequel.asc(:id))
+      end
+
+      def version_ids_to_keep
+        @version_ids_to_keep ||= keep.collect do | selector |
+          PactBroker::Domain::Version.select(:id).for_selector(selector)
+        end.reduce(&:union)
+      end
+
+      def call
+        require 'pact_broker/domain/version'
+        before_counts = current_counts
+
+        result = PactBroker::Domain::Version.where(id: resolve_ids(version_ids_to_delete)).delete
+        delete_orphan_pact_versions
+
+        after_counts = current_counts
+
+        TABLES.each_with_object({}) do | table_name, comparison_counts |
+          comparison_counts[table_name.to_s] = { "deleted" => before_counts[table_name] - after_counts[table_name], "kept" => after_counts[table_name] }
+        end
+      end
+
+      private
+
+      attr_reader :db, :options
+
+      def current_counts
+        TABLES.each_with_object({}) do | table_name, counts |
+          counts[table_name] = db[table_name].count
+        end
+      end
+
+      def delete_orphan_pact_versions
+        logger.info("Deleting orphan pact versions")
+        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
+    end
+  end
+end

data/lib/pact_broker/domain/tag.rb

@@ -2,27 +2,88 @@ require 'pact_broker/db'
 require 'pact_broker/repositories/helpers'
 
 module PactBroker
-
   module Domain
     class Tag < Sequel::Model
+      plugin :timestamps, update_on_create: true
+      plugin :insert_ignore, identifying_columns: [:name, :version_id]
+
+      unrestrict_primary_key
+      associate(:many_to_one, :version, :class => "PactBroker::Domain::Version", :key => :version_id, :primary_key => :id)
 
       dataset_module do
         include PactBroker::Repositories::Helpers
-      end
 
-      plugin :insert_ignore, identifying_columns: [:name, :version_id]
+        # Does NOT care about whether or not there is a pact publication
+        # for the version
+        def latest_tags_for_pacticipant_ids(pacticipant_ids)
+          tags_versions_join = {
+            Sequel[:tags][:version_id] => Sequel[:versions][:id],
+            Sequel[:versions][:pacticipant_id] => pacticipant_ids
+          }
 
-      unrestrict_primary_key
+          latest_tags_versions_join = {
+            Sequel[:latest_tags][:name] => Sequel[:tags][:name],
+            Sequel[:latest_tags][:latest_order] => Sequel[:versions][:order],
+            Sequel[:latest_tags][:pacticipant_id] => Sequel[:versions][:pacticipant_id],
+            Sequel[:versions][:pacticipant_id] => pacticipant_ids
+          }
 
-      associate(:many_to_one, :version, :class => "PactBroker::Domain::Version", :key => :version_id, :primary_key => :id)
+          latest_tags = PactBroker::Domain::Tag
+            .select_group(Sequel[:tags][:name], Sequel[:versions][:pacticipant_id])
+            .select_append{ max(order).as(latest_order) }
+            .join(:versions, tags_versions_join)
+
+          PactBroker::Domain::Tag
+            .select_all_qualified
+            .join(:versions,
+              { Sequel[:tags][:version_id] => Sequel[:versions][:id],
+                Sequel[:versions][:pacticipant_id] => pacticipant_ids
+              })
+            .join(latest_tags, latest_tags_versions_join, { table_alias: :latest_tags })
+        end
+
+        def head_tags_for_consumer_id(consumer_id)
+          lp = :latest_pact_publication_ids_for_consumer_versions
+          tags_versions_join = {
+            Sequel[:tags][:version_id] => Sequel[:versions][:id],
+            Sequel[:versions][:pacticipant_id] => consumer_id
+          }
+
+          versions_pact_publications_join = {
+            Sequel[:versions][:id] => Sequel[lp][:consumer_version_id],
+            Sequel[lp][:consumer_id] => consumer_id
+          }
+          # head tags for this consumer
+          # the latest tag, pacticipant_id, version order
+          # for versions that have a pact publication
+          PactBroker::Domain::Tag
+            .select_group(Sequel[:tags][:name], Sequel[:versions][:pacticipant_id])
+            .select_append{ max(order).as(latest_consumer_version_order) }
+            .join(:versions, tags_versions_join)
+            .join(lp, versions_pact_publications_join)
+        end
+
+        def head_tags_for_pact_publication(pact_publication)
+          head_tags_versions_join = {
+            Sequel[:head_tags][:latest_consumer_version_order] => Sequel[:versions][:order],
+            Sequel[:head_tags][:pacticipant_id] => Sequel[:versions][:pacticipant_id],
+            Sequel[:versions][:pacticipant_id] => pact_publication.consumer_id
+          }
+
+          # Find the head tags that belong to this pact publication
+          # Note: The tag model has the name and version_id,
+          # but does not have the created_at value set - but don't need it for now
+          head_tags_for_consumer_id(pact_publication.consumer_id).from_self(alias: :head_tags)
+            .select(Sequel[:head_tags][:name], Sequel[:versions][:id].as(:version_id))
+            .join(:versions, head_tags_versions_join)
+            .where(Sequel[:versions][:id] => pact_publication.consumer_version_id)
+        end
+      end
 
       def <=> other
         name <=> other.name
       end
-
     end
-
-    Tag.plugin :timestamps, :update_on_create=>true
   end
 end