pact_broker 2.70.0 → 2.74.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b57a2f04694ce119675cd5b4fb647e1c2faff71b890958391ca30846ef0d7fab
-  data.tar.gz: 8b6484329b0821600417fc17ad564a14de06edf2edc21939423c34ea2795cee1
+  metadata.gz: 9bb163d5ed55a2b3f98f18b63763749a0a9a337538a69b30af9f01295e720154
+  data.tar.gz: cd8cc58097602d87c09f9af494b49c28666223350f57a2f4f9ccade3f3b1d57c
 SHA512:
-  metadata.gz: e4d1c82adbbb041f38d64200ccb0f1fc8d4672f3a9e445db0dcf428b25c8353c5922a3fb579b74560114df476886fb8aee93d2b793643ae9bbbbd8f786fec443
-  data.tar.gz: dc130a9cea4a62c741c401290b385f807c4597073a1ae467d3b334bd058267eca2179ebb6be60d53c2f6cf7046c7b567edf473738a2642e122d1c6e40938301a
+  metadata.gz: a32dd3179963aac89bff4ca0197e80f73576188355b92984e51ee010522e34d7017ab6a2cac6eaf5ac865391b221d7aa619efdd8950727cac20c2e6d2b686e79
+  data.tar.gz: fbd56c79155229b5900294f13b0ce1ce9390cd2260e678a83ef2b358d4ad8112ae6e4f257bc3380e4ed488b67ed838f80214ba16bb8431c002f85878c5989a33

data/.github/workflows/test.yml

@@ -3,6 +3,18 @@ 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:
@@ -25,7 +37,7 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
-      - run: "bundle install"
+      - run: "gem install bundler && bundle install"
         env:
           INSTALL_PG: "true"
       - run: "bundle exec rake"
@@ -36,27 +48,7 @@ jobs:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        ruby_version: ["2.5", "2.7"]
+        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,60 @@
+<a name="v2.74.1"></a>
+### v2.74.1 (2021-01-05)
+
+#### Bug Fixes
+
+* **deps**
+  * remove manual specification for nokogiri now the fix for CVE-2020-26247 has been released in 1.11	 ([771378a9](/../../commit/771378a9))
+
+<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)
 

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/README.md

@@ -1,6 +1,6 @@
 # Pact Broker
 [![Gem Version](https://badge.fury.io/rb/pact_broker.svg)](http://badge.fury.io/rb/pact_broker)
- [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker)
+ ![Build status](https://github.com/pact-foundation/pact_broker/workflows/Test/badge.svg)
  [![Join the chat at https://pact-foundation.slack.com/](https://img.shields.io/badge/chat-on%20slack-blue.svg?logo=slack)](https://slack.pact.io)
  [![security](https://hakiri.io/github/pact-foundation/pact_broker/master.svg)](https://hakiri.io/github/pact-foundation/pact_broker/master)
  [![Code Climate](https://codeclimate.com/github/pact-foundation/pact_broker/badges/gpa.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)

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/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 = ""

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

@@ -29,7 +29,7 @@ module PactBroker
         end
 
         def self.log_as_warning?(e)
-          PactBroker.configuration.warning_error_classes.any? { |clazz| e.is_a?(clazz) }
+          PactBroker.configuration.warning_error_classes.any? { |clazz| e.is_a?(clazz) || e.cause&.is_a?(clazz) }
         end
 
         def self.display_message(e, obfuscated_message)

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

@@ -0,0 +1,24 @@
+require 'pact_broker/hash_refinements'
+require 'pact_broker/pacts/metadata'
+
+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 ||= PactBroker::Pacts::Metadata.parse_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