pact_broker 2.76.1 → 2.79.0

data/db/migrations/20210205_add_pacticipant_id_to_tag.rb

@@ -0,0 +1,17 @@
+require_relative 'migration_helper'
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  change do
+    alter_table(:tags) do
+      # TODO set_column_not_null(:pacticipant_id)
+      # TODO set_column_not_null(:version_order)
+      add_column(:pacticipant_id, Integer)
+      add_column(:version_order, Integer)
+      add_index(:version_order, name: "tags_version_order_index")
+      add_index(:version_id, name: "tags_version_id_index")
+      add_index(:pacticipant_id, name: "tags_pacticipant_id_index")
+    end
+  end
+end

data/db/migrations/20210206_add_index_to_tags_and_versions.rb

@@ -0,0 +1,27 @@
+require_relative 'migration_helper'
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if postgres?
+      run("CREATE INDEX tags_pacticipant_id_name_version_order_desc_index ON tags (pacticipant_id, name, version_order DESC);")
+      run("CREATE INDEX versions_pacticipant_id_order_desc_index ON versions (pacticipant_id, \"order\" DESC);")
+    else
+      alter_table(:tags) do
+        add_index([:pacticipant_id, :name, :version_order], name: "tags_pacticipant_id_name_version_order_index")
+      end
+    end
+  end
+
+  down do
+    if postgres?
+      run("DROP INDEX tags_pacticipant_id_name_version_order_desc_index")
+      run("DROP INDEX versions_pacticipant_id_order_desc_index")
+    else
+      alter_table(:tags) do
+        drop_index([:pacticipant_id, :name, :version_order], name: "tags_pacticipant_id_name_version_order_index")
+      end
+    end
+  end
+end

data/db/migrations/20210207_optimise_latest_verification_ids_for_consumer_version_tags.rb

@@ -0,0 +1,13 @@
+require_relative '../ddl_statements'
+
+Sequel.migration do
+  up do
+    create_or_replace_view(:latest_verification_ids_for_consumer_version_tags,
+      LATEST_VERIFICATION_IDS_FOR_CONSUMER_VERSION_TAGS_V4)
+  end
+
+  down do
+    create_or_replace_view(:latest_verification_ids_for_consumer_version_tags,
+      LATEST_VERIFICATION_IDS_FOR_CONSUMER_VERSION_TAGS_V3)
+  end
+end

data/db/migrations/20210208_optimise_latest_tagged_pact_cv_orders.rb

@@ -0,0 +1,13 @@
+require_relative '../ddl_statements'
+
+Sequel.migration do
+  up do
+    create_or_replace_view(:latest_tagged_pact_consumer_version_orders,
+      latest_tagged_pact_consumer_version_orders_v4(self))
+  end
+
+  down do
+    create_or_replace_view(:latest_tagged_pact_consumer_version_orders,
+      latest_tagged_pact_consumer_version_orders_v3(self))
+  end
+end

data/db/migrations/20210210_create_environments_table.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+  change do
+    create_table(:environments, charset: 'utf8') do
+      primary_key :id
+      String :uuid, nullable: false
+      String :name, nullable: false
+      String :display_name
+      Boolean :production, nullable: false
+      String :contacts
+      DateTime :created_at, nullable: false
+      DateTime :updated_at, nullable: false
+      index [:uuid], unique: true, name: "environments_uuid_index"
+      index [:name], unique: true, name: "environments_name_index"
+    end
+  end
+end

data/docker-compose-dev-postgres.yml

@@ -23,7 +23,9 @@ services:
     environment:
       DATABASE_URL: postgres://postgres:postgres@postgres/postgres
       PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
-    command: dockerize -wait tcp://postgres:5432 /home/start.sh
+      PACT_BROKER_BASE_URL: 'http://localhost:9292 http://pact-broker:9292'
+    command: -wait tcp://postgres:5432 /usr/local/bin/start
+    entrypoint: dockerize
     volumes:
       - ./lib:/home/lib
       - ./db:/home/db
@@ -31,5 +33,11 @@ services:
       - ./tasks:/home/tasks
       - ./Rakefile:/home/Rakefile
 
+  shell:
+    image: ruby:2.5.3-alpine
+    depends_on:
+      - pact-broker
+    entrypoint: /bin/sh
+
 volumes:
   postgres-volume:

data/docker-compose-issue-repro-with-pact-broker-docker-image.yml

@@ -11,23 +11,34 @@ services:
       POSTGRES_DB: postgres
 
   pact-broker:
-    image: pactfoundation/pact-broker:2.73.0.0
+    image: pactfoundation/pact-broker:2.76.0.0
     ports:
       - "9292:9292"
-    depends_on:
-      - postgres
+    # depends_on:
+    #   - postgres
     environment:
       PACT_BROKER_PORT: '9292'
-      PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
+      #PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
+      PACT_BROKER_DATABASE_URL: "sqlite:////tmp/pact_broker.sqlite3"
       PACT_BROKER_LOG_LEVEL: INFO
       PACT_BROKER_SQL_LOG_LEVEL: DEBUG
+      PACT_BROKER_WEBHOOK_SCHEME_WHITELIST: "http https"
+      PACT_BROKER_WEBHOOK_HOST_WHITELIST: "/.*/"
 
   repro-issue:
     build: .
     depends_on:
       - pact-broker
-    command: dockerize -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    command: -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    entrypoint: dockerize
     environment:
       - PACT_BROKER_BASE_URL=http://pact-broker:9292
     volumes:
       - $PWD:/home
+    working_dir: /home
+
+  webhook-server:
+    build: .
+    entrypoint: ["/bin/sh", "-c", "bundle exec rackup -p 9393 -o 0.0.0.0 /home/script/webhook-server.ru"]
+    volumes:
+      - ./script/webhook-server.ru:/home/script/webhook-server.ru

data/lib/pact_broker/api.rb

@@ -71,10 +71,10 @@ module PactBroker
         add ['pacticipants', :pacticipant_name], Api::Resources::Pacticipant, {resource_name: "pacticipant"}
         add ['pacticipants', :pacticipant_name, 'versions'], Api::Resources::Versions, {resource_name: "pacticipant_versions"}
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number], Api::Resources::Version, {resource_name: "pacticipant_version"}
-        add ['pacticipants', :pacticipant_name, 'latest-version', :tag], Api::Resources::Version, {resource_name: "latest_tagged_pacticipant_version"}
+        add ['pacticipants', :pacticipant_name, 'latest-version', :tag], Api::Resources::LatestVersion, {resource_name: "latest_tagged_pacticipant_version"}
         add ['pacticipants', :pacticipant_name, 'latest-version', :tag, 'can-i-deploy', 'to', :to], Api::Resources::CanIDeployPacticipantVersion, { resource_name: "can_i_deploy_latest_tagged_version" }
         add ['pacticipants', :pacticipant_name, 'latest-version', :tag, 'can-i-deploy', 'to', :to, 'badge'], Api::Resources::CanIDeployBadge, { resource_name: "can_i_deploy_badge" }
-        add ['pacticipants', :pacticipant_name, 'latest-version'], Api::Resources::Version, {resource_name: "latest_pacticipant_version"}
+        add ['pacticipants', :pacticipant_name, 'latest-version'], Api::Resources::LatestVersion, {resource_name: "latest_pacticipant_version"}
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number, 'tags', :tag_name], Api::Resources::Tag, {resource_name: "pacticipant_version_tag"}
         add ['pacticipants', :pacticipant_name, 'labels', :label_name], Api::Resources::Label, {resource_name: "pacticipant_label"}
 
@@ -105,6 +105,11 @@ module PactBroker
         add ['dashboard', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::Dashboard, {resource_name: "integration_dashboard"}
         add ['test','error'], Api::Resources::ErrorTest, {resource_name: "error_test"}
 
+        if PactBroker.feature_enabled?(:environments)
+          add ['environments'], Api::Resources::Environments, { resource_name: "environments" }
+          add ['environments', :environment_uuid], Api::Resources::Environment, { resource_name: "environment" }
+        end
+
         add ['integrations'], Api::Resources::Integrations, {resource_name: "integrations"}
         add ['integrations', 'provider', :provider_name, 'consumer', :consumer_name], Api::Resources::Integration, {resource_name: "integration"}
         add ['metrics'], Api::Resources::Metrics, {resource_name: 'metrics'}

data/lib/pact_broker/api/contracts/dry_validation_predicates.rb

@@ -13,6 +13,14 @@ module PactBroker
         predicate(:not_blank?) do | value |
           value && value.is_a?(String) && value.strip.size > 0
         end
+
+        predicate(:single_line?) do | value |
+          value && value.is_a?(String) && !value.include?("\n")
+        end
+
+        predicate(:no_spaces?) do | value |
+          value && value.is_a?(String) && !value.include?(" ")
+        end
       end
     end
   end

data/lib/pact_broker/api/contracts/environment_schema.rb

@@ -0,0 +1,49 @@
+require 'dry-validation'
+require 'pact_broker/api/contracts/dry_validation_workarounds'
+require 'pact_broker/api/contracts/dry_validation_predicates'
+require 'pact_broker/messages'
+
+module PactBroker
+  module Api
+    module Contracts
+      class EnvironmentSchema
+        extend DryValidationWorkarounds
+        extend PactBroker::Messages
+        using PactBroker::HashRefinements
+
+        SCHEMA = Dry::Validation.Schema do
+          configure do
+            predicates(DryValidationPredicates)
+            config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
+          end
+          required(:name).filled(:str?, :single_line?, :no_spaces?)
+          required(:displayName).filled(:str?, :single_line?)
+          required(:production).filled(included_in?: [true, false])
+          optional(:contacts).each do
+            schema do
+              required(:name).filled(:str?, :single_line?)
+              optional(:details).schema do
+              end
+            end
+          end
+        end
+
+        def self.call(params_with_string_keys)
+          params = params_with_string_keys&.symbolize_keys
+          results = select_first_message(flatten_indexed_messages(SCHEMA.call(params).messages(full: true)))
+          validate_name(params, results)
+          results
+        end
+
+        def self.validate_name(params, results)
+          if (environment_with_same_name = PactBroker::Deployments::EnvironmentService.find_by_name(params[:name]))
+            if environment_with_same_name.uuid != params[:uuid]
+              results[:name] ||= []
+              results[:name] << message('errors.validation.environment_name_must_be_unique', name: params[:name])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@ require 'roar/json/hal'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/api/decorators/decorator_context'
 require 'pact_broker/api/decorators/format_date_time'
+require 'pact_broker/string_refinements'
 
 module PactBroker
   module Api
@@ -12,6 +13,16 @@ module PactBroker
         include Roar::JSON::HAL::Links
         include PactBroker::Api::PactBrokerUrls
         include FormatDateTime
+        using PactBroker::StringRefinements
+
+        def self.property(name, options={}, &block)
+          if options.delete(:camelize)
+            camelized_name = name.to_s.camelcase(false).to_sym
+            super(name, { as: camelized_name }.merge(options), &block)
+          else
+            super
+          end
+        end
       end
     end
   end

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

@@ -58,6 +58,7 @@ module PactBroker
             name: index_item.consumer_name,
             version: {
               number: index_item.consumer_version_number,
+              branch: index_item.consumer_version_branch,
               _links: {
                 self: {
                   href: version_url(base_url, index_item.consumer_version)
@@ -84,7 +85,10 @@ module PactBroker
           }
 
           if index_item.latest_verification
-            hash[:version] = { number: index_item.provider_version_number }
+            hash[:version] = {
+              number: index_item.provider_version_number,
+              branch: index_item.provider_version_branch
+            }
           end
 
           hash

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

@@ -0,0 +1,30 @@
+require_relative 'base_decorator'
+require_relative 'timestamps'
+
+module PactBroker
+  module Api
+    module Decorators
+      class EnvironmentDecorator < BaseDecorator
+        property :uuid, writeable: false
+        property :name
+        property :display_name, camelize: true
+        property :production
+
+        collection :contacts, class: OpenStruct do
+          property :name
+          property :details
+        end
+
+        include Timestamps
+
+        link :self do | options |
+          {
+            title: 'Environment',
+            name: represented.name,
+            href: environment_url(represented, options[:base_url])
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'pact_broker/api/decorators/base_decorator'
+require 'pact_broker/api/decorators/environment_decorator'
+require 'pact_broker/deployments/environment'
+
+module PactBroker
+  module Api
+    module Decorators
+      class EnvironmentsDecorator < BaseDecorator
+
+        collection :entries, :as => :environments, :class => PactBroker::Deployments::Environment, :extend => PactBroker::Api::Decorators::EnvironmentDecorator, embedded: true
+
+        link :self do | options |
+          {
+            title: 'Environments',
+            href: options[:resource_url]
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -75,6 +75,7 @@ module PactBroker
             name: line.consumer_name,
             version: {
               number: line.consumer_version_number,
+              branch: line.consumer_version_branch,
               _links: {
                 self: {
                   href: version_url(base_url, consumer_version)
@@ -91,7 +92,7 @@ module PactBroker
         end
 
         def tags(tags, base_url)
-          tags.collect do | tag |
+          tags.sort_by(&:created_at).collect do | tag |
             {
               name: tag.name,
               latest: tag.latest?,
@@ -118,6 +119,7 @@ module PactBroker
           if !line.provider_version_number.nil?
             hash[:version] = {
               number: line.provider_version_number,
+              branch: line.provider_version_branch,
               _links: {
                 self: {
                   href: version_url(base_url, provider_version)

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

@@ -12,9 +12,11 @@ module PactBroker
         using PactBroker::HashRefinements
 
         collection :provider_version_tags, default: []
+        property :provider_version_branch
 
         collection :consumer_version_selectors, default: PactBroker::Pacts::Selectors.new, class: PactBroker::Pacts::Selector do
           property :tag
+          property :branch
           property :latest,
             setter: ->(fragment:, represented:, **) {
               represented.latest = (fragment == 'true' || fragment == true)

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

@@ -6,9 +6,11 @@ module PactBroker
     module Decorators
       class VersionDecorator < BaseDecorator
 
-        property :number
+        property :number, writeable: false
+        property :branch
+        property :build_url, as: :buildUrl
 
-        collection :tags, embedded: true, :extend => PactBroker::Api::Decorators::EmbeddedTagDecorator
+        collection :tags, embedded: true, :extend => PactBroker::Api::Decorators::EmbeddedTagDecorator, class: OpenStruct
 
         include Timestamps
 
@@ -61,6 +63,17 @@ module PactBroker
           }]
         end
 
+        def from_hash(hash, options = {})
+          if hash["tags"]
+            updated_hash = hash.dup
+            updated_hash["_embedded"] ||= {}
+            updated_hash["_embedded"]["tags"] = updated_hash.delete("tags")
+            super(updated_hash, options)
+          else
+            super
+          end
+        end
+
         private
 
         def sorted_pacts

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -307,6 +307,14 @@ module PactBroker
         "#{base_url}/groups/#{url_encode(pacticipant_name)}"
       end
 
+      def environments_url(base_url = '')
+        "#{base_url}/environments"
+      end
+
+      def environment_url(environment, base_url = '')
+        "#{environments_url(base_url)}/#{environment.uuid}"
+      end
+
       def hal_browser_url target_url, base_url = ''
         "#{base_url}/hal-browser/browser.html#" + target_url
       end

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

@@ -68,6 +68,11 @@ module PactBroker
         alias_method :path_info, :identifier_from_path
 
         def base_url
+          # Have to use something for the base URL here - we can't use an empty string as we can in the UI.
+          # Can't work out if cache poisoning is a vulnerability for APIs or not.
+          # Using the request base URI as a fallback if the base_url is not configured may be a vulnerability,
+          # but the documentation recommends that the
+          # base_url should be set in the configuration to mitigate this.
           request.env["pactbroker.base_url"] || request.base_uri.to_s.chomp('/')
         end
 
@@ -149,6 +154,10 @@ module PactBroker
           identifier_from_path[:consumer_version_number]
         end
 
+        def pacticipant_version_number
+          identifier_from_path[:pacticipant_version_number]
+        end
+
         def consumer_specified?
           identifier_from_path.key?(:consumer_name)
         end
@@ -239,6 +248,15 @@ module PactBroker
         def decorator_class(name)
           application_context.decorator_configuration.class_for(name)
         end
+
+        def validation_errors_for_schema?(schema, params_to_validate = params)
+          if (errors = schema.call(params_to_validate)).any?
+            set_json_validation_error_messages(errors)
+            true
+          else
+            false
+          end
+        end
       end
     end
   end