pact_broker 2.69.0 → 2.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c656c61487fd81baf9eb94f73fa12ab27bdf5cea1bd2d670af63199123b6ef
-  data.tar.gz: '04022874b3eeb6681e79163431ce63c8d6760741dc7ec8db30cc87b8f9257a94'
+  metadata.gz: 4a3779dfce4701e31c25e10a37154785df8745aa022869f70bcdd3c080066169
+  data.tar.gz: d9c48a07a42949aea37a84ca43930a53d6403abe02a96d1c1de2d58a27d763bc
 SHA512:
-  metadata.gz: ce0f9fb3186ab25c419b61665245977abfbaa8d245437699c44de54783bde86d8281b950172532d02a31f6aa33f36046dde7a0636075fabe75f3f074c33016c2
-  data.tar.gz: f6b8baa8a66b80b50df9223086f8e67dd9233106897b15f5cfa16328e954805de786d4fbe672f3cee5ba831001edd78f5c0a977dfc5d767d4c79aa46a61b1010
+  metadata.gz: 2a4a61fe0838766004ab06723b406d51149d748ec449c81139ada966a223b5491d4728fa0cdd52d6e369081af490eb03b4b7036c12c6f2a6b014bf20608c9d68
+  data.tar.gz: 569774601622663f53d824d40b0013afd6728f0c603fb9f2f8d66f759603daf7d361d6481003dc83a2a844415d93eae78694a076be1172eb45728d678cd672a2

data/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: Test
+
+on: push
+
+jobs:
+  sqlite:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        ruby_version: ["2.7"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake"
+  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: "gem install bundler && 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.7"]
+    steps:
+      - uses: actions/checkout@v2
+      - run: script/test/run-rake-on-docker-compose-mysql.sh

data/CHANGELOG.md

@@ -1,3 +1,68 @@
+<a name="v2.74.0"></a>
+### v2.74.0 (2021-01-04)
+
+#### Features
+
+* include the consumer version selectors in the metadata of the 'pact for verification' URL	 ([32bbe1c3](/../../commit/32bbe1c3))
+
+#### Bug Fixes
+
+* **deps**
+  * update nokogiri for CVE-2020-26247	 ([336ec897](/../../commit/336ec897))
+
+<a name="v2.73.0"></a>
+### v2.73.0 (2020-12-16)
+
+#### Features
+
+* **wip**
+  * permenently enable feature that keeps pacts as WIP when verified via the URL from a webhook triggered by pact publication	 ([70071373](/../../commit/70071373))
+
+* allow error causes to be configured to log at warning level	 ([3a7bf5ea](/../../commit/3a7bf5ea))
+* add self relations for tags in matrix resource	 ([727cee99](/../../commit/727cee99))
+* add self relation to tags in extended pact and verification resources	 ([a560ce6d](/../../commit/a560ce6d))
+
+* **metrics**
+  * timeout matrix count	 ([43091b57](/../../commit/43091b57))
+
+#### Bug Fixes
+
+* url encode tag name in tag URL	 ([80df832d](/../../commit/80df832d))
+
+<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)
+
+#### Features
+
+* allow clean to be performed in dry run mode	 ([a7a18fde](/../../commit/a7a18fde))
+
+<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 # 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
@@ -33,9 +34,13 @@ 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' >> /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

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-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/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/db.rb

@@ -33,6 +33,7 @@ module DB
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)
+    con.extension(:statement_timeout)
     con.extend_datasets do
       def any?
         !empty?

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

@@ -11,6 +11,14 @@ module PactBroker
           property :name
           property :latest, getter: ->(_) { true }
 
+          link :self do | options |
+            {
+              title: 'Tag',
+              name: represented.name,
+              href: tag_url(options[:base_url], represented)
+            }
+          end
+
           link "pb:latest-pact" do | opts |
             {
               name: "The latest pact with the tag #{represented.name}",
@@ -33,7 +41,7 @@ module PactBroker
 
         def head_tags
           represented.head_tag_names.collect do | tag_name |
-            OpenStruct.new(name: tag_name, pact: represented)
+            OpenStruct.new(name: tag_name, pact: represented, version: represented.consumer_version)
           end
         end
       end

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

@@ -7,6 +7,14 @@ module PactBroker
         class TagDecorator < BaseDecorator
           property :name
           property :latest?, as: :latest
+
+          link :self do | options |
+            {
+              title: 'Tag',
+              name: represented.name,
+              href: tag_url(options[:base_url], represented)
+            }
+          end
         end
 
         collection :provider_version_tags, as: :tags, embedded: true, extend: TagDecorator

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

@@ -76,7 +76,7 @@ module PactBroker
                   href: version_url(base_url, consumer_version)
                 }
               },
-              tags: tags(line.consumer_version_tags)
+              tags: tags(line.consumer_version_tags, base_url)
             },
             _links: {
               self: {
@@ -86,11 +86,16 @@ module PactBroker
           }
         end
 
-        def tags(tags)
+        def tags(tags, base_url)
           tags.collect do | tag |
             {
               name: tag.name,
-              latest: tag.latest?
+              latest: tag.latest?,
+              _links: {
+                self: {
+                  href: tag_url(base_url, tag)
+                }
+              }
             }
           end
         end
@@ -114,7 +119,7 @@ module PactBroker
                   href: version_url(base_url, provider_version)
                 }
               },
-              tags: tags(line.provider_version_tags)
+              tags: tags(line.provider_version_tags, base_url)
             }
           end
 

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

@@ -3,11 +3,8 @@ require_relative 'pact_pacticipant_decorator'
 require_relative 'timestamps'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class TagDecorator < BaseDecorator
 
         property :name

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

@@ -1,11 +1,13 @@
 require_relative 'base_decorator'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/pacts/build_verifiable_pact_notices'
+require 'pact_broker/pacts/metadata'
 
 module PactBroker
   module Api
     module Decorators
       class VerifiablePactDecorator < BaseDecorator
+        include PactBroker::Pacts::Metadata
 
         property :shortDescription, getter: -> (context) { PactBroker::Pacts::VerifiablePactMessages.new(context[:represented], nil).pact_version_short_description }
 
@@ -27,7 +29,7 @@ module PactBroker
         end
 
         link :self do | user_options |
-          metadata = represented.wip ? { wip: true } : nil
+          metadata = build_metadata_for_pact_for_verification(represented)
           {
             href: pact_version_url_with_metadata(represented, metadata, user_options[:base_url]),
             name: represented.name

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -1,6 +1,8 @@
 require 'erb'
 require 'pact_broker/pacts/metadata'
 require 'pact_broker/logging'
+require 'base64'
+require 'rack'
 
 module PactBroker
   module Api
@@ -75,11 +77,9 @@ 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
-            end
+            Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata))
           rescue StandardError => e
             logger.warn("Exception parsing webhook metadata: #{metadata}", e)
             {}
@@ -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
@@ -197,7 +201,7 @@ module PactBroker
       end
 
       def tag_url base_url, tag
-        "#{tags_url(base_url, tag.version)}/#{tag.name}"
+        "#{tags_url(base_url, tag.version)}/#{url_encode(tag.name)}"
       end
 
       def templated_tag_url_for_pacticipant pacticipant_name, base_url = ""