pact_broker 2.76.2 → 2.79.1

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

@@ -0,0 +1,75 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/resources/environment'
+require 'pact_broker/api/contracts/environment_schema'
+
+module PactBroker
+  module Api
+    module Resources
+      class Environments < BaseResource
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+
+        def allowed_methods
+          ["GET", "POST", "OPTIONS"]
+        end
+
+        def resource_exists?
+          true
+        end
+
+        def post_is_create?
+          true
+        end
+
+        def malformed_request?
+          if request.post?
+            invalid_json? || validation_errors_for_schema?(schema, params.merge(uuid: uuid))
+          else
+            false
+          end
+        end
+
+        def create_path
+          environment_url(OpenStruct.new(uuid: uuid), base_url)
+        end
+
+        def from_json
+          response.body = decorator_class(:environment_decorator).new(create_environment).to_json(decorator_options)
+        end
+
+        def policy_name
+          :'deployments::environment'
+        end
+
+        def to_json
+          decorator_class(:environments_decorator).new(environments).to_json(decorator_options)
+        end
+
+        def parsed_environment
+          @parsed_environment ||= decorator_class(:environment_decorator).new(PactBroker::Deployments::Environment.new).from_json(request_body)
+        end
+
+        def create_environment
+          environment_service.create(uuid, parsed_environment)
+        end
+
+        def uuid
+          @uuid ||= environment_service.next_uuid
+        end
+
+        def environments
+          @environments ||= environment_service.find_all
+        end
+
+        def schema
+          PactBroker::Api::Contracts::EnvironmentSchema
+        end
+      end
+    end
+  end
+end

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

@@ -110,6 +110,12 @@ module PactBroker
               title: "Get, create or delete a tag for a pacticipant version",
               templated: true
             },
+            'pb:pacticipant-version' =>
+            {
+              href: base_url + '/pacticipants/{pacticipant}/versions/{version}',
+              title: "Get, create or delete a pacticipant version",
+              templated: true
+            },
             'pb:metrics' =>
             {
               href: base_url + '/metrics',
@@ -144,6 +150,20 @@ module PactBroker
             }]
           }
 
+          if PactBroker.feature_enabled?(:environments)
+            links_hash['pb:environments'] = {
+              title: "Environments",
+              href: environments_url(base_url),
+              templated: false
+            }
+
+            links_hash['pb:environment'] = {
+              title: "Environment",
+              href: environments_url(base_url) + "/{uuid}",
+              templated: true
+            }
+          end
+
           if PactBroker.feature_enabled?('disable_pacts_for_verification', true)
             links_hash.delete('pb:provider-pacts-for-verification')
             links_hash.delete('beta:provider-pacts-for-verification')

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

@@ -0,0 +1,27 @@
+require 'pact_broker/api/resources/version'
+
+module PactBroker
+  module Api
+    module Resources
+      class LatestVersion < Version
+        def content_types_accepted
+          []
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        private
+
+        def version
+          if identifier_from_path[:tag]
+            @version ||= version_service.find_by_pacticipant_name_and_latest_tag(identifier_from_path[:pacticipant_name], identifier_from_path[:tag])
+          else
+            @version ||= version_service.find_latest_by_pacticpant_name(identifier_from_path)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -38,6 +38,7 @@ module PactBroker
         def pacts
           @pacts ||= pact_service.find_for_verification(
             provider_name,
+            parsed_query_params.provider_version_branch,
             parsed_query_params.provider_version_tags,
             parsed_query_params.consumer_version_selectors,
             {

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

@@ -10,20 +10,32 @@ module PactBroker
           [["application/hal+json", :to_json]]
         end
 
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+
         def allowed_methods
-          ["GET", "DELETE", "OPTIONS"]
+          ["GET", "PUT", "DELETE", "OPTIONS"]
         end
 
         def resource_exists?
           !!version
         end
 
+        def from_json
+          response_code = version ? 200 : 201
+          parsed_version = Decorators::VersionDecorator.new(OpenStruct.new).from_json(request_body)
+          @version = version_service.create_or_overwrite(pacticipant_name, pacticipant_version_number, parsed_version)
+          response.body = to_json
+          response_code
+        end
+
         def to_json
           decorator_class(:version_decorator).new(version).to_json(decorator_options)
         end
 
         def delete_resource
-          version_service.delete version
+          version_service.delete(version)
           true
         end
 
@@ -34,13 +46,7 @@ module PactBroker
         private
 
         def version
-          if identifier_from_path[:tag]
-            @version ||= version_service.find_by_pacticipant_name_and_latest_tag(identifier_from_path[:pacticipant_name], identifier_from_path[:tag])
-          elsif identifier_from_path[:pacticipant_version_number]
-            @version ||= version_service.find_by_pacticipant_name_and_number(identifier_from_path)
-          else
-            @version ||= version_service.find_latest_by_pacticpant_name(identifier_from_path)
-          end
+          @version ||= version_service.find_by_pacticipant_name_and_number(identifier_from_path)
         end
       end
     end

data/lib/pact_broker/app.rb

@@ -191,7 +191,7 @@ module PactBroker
       @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {'Content-Type' => 'image/x-icon'}]]
       @app_builder.use Rack::PactBroker::ConvertFileExtensionToAcceptHeader
       # Rack::PactBroker::SetBaseUrl needs to be before the Rack::PactBroker::HalBrowserRedirect
-      @app_builder.use Rack::PactBroker::SetBaseUrl, configuration.base_url
+      @app_builder.use Rack::PactBroker::SetBaseUrl, configuration.base_urls
 
       if configuration.use_hal_browser
         logger.info "Mounting HAL browser"

data/lib/pact_broker/certificates/certificate.rb

@@ -9,7 +9,7 @@ end
 
 # Table: certificates
 # Columns:
-#  id          | integer                     | PRIMARY KEY DEFAULT nextval('certificates_id_seq'::regclass)
+#  id          | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
 #  uuid        | text                        | NOT NULL
 #  description | text                        |
 #  content     | text                        | NOT NULL

data/lib/pact_broker/config/setting.rb

@@ -73,7 +73,7 @@ end
 
 # Table: config
 # Columns:
-#  id         | integer                     | PRIMARY KEY DEFAULT nextval('config_id_seq'::regclass)
+#  id         | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
 #  name       | text                        | NOT NULL
 #  type       | text                        | NOT NULL
 #  value      | text                        |

data/lib/pact_broker/config/space_delimited_integer_list.rb

@@ -0,0 +1,25 @@
+module PactBroker
+  module Config
+    class SpaceDelimitedIntegerList < Array
+      def initialize list
+        super(list)
+      end
+
+      def self.integer?(string)
+        (Integer(string) rescue nil) != nil
+      end
+
+      def self.parse(string)
+        array = (string || '')
+                    .split(' ')
+                    .select { |word| integer?(word) }
+                    .collect(&:to_i)
+        SpaceDelimitedIntegerList.new(array)
+      end
+
+      def to_s
+        collect(&:to_s).join(' ')
+      end
+    end
+  end
+end

data/lib/pact_broker/configuration.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/version'
 require 'pact_broker/error'
 require 'pact_broker/config/space_delimited_string_list'
+require 'pact_broker/config/space_delimited_integer_list'
 require 'semantic_logger'
 
 module PactBroker
@@ -30,6 +31,7 @@ module PactBroker
       :webhook_http_method_whitelist,
       :webhook_scheme_whitelist,
       :webhook_host_whitelist,
+      :webhook_http_code_success,
       :base_equality_only_on_content_that_affects_verification_results,
       :seed_example_data,
       :badge_provider_mode,
@@ -49,7 +51,7 @@ module PactBroker
     attr_accessor :check_for_potential_duplicate_pacticipant_names
     attr_accessor :webhook_retry_schedule
     attr_accessor :user_agent
-    attr_reader :webhook_http_method_whitelist, :webhook_scheme_whitelist, :webhook_host_whitelist
+    attr_reader :webhook_http_method_whitelist, :webhook_scheme_whitelist, :webhook_host_whitelist, :webhook_http_code_success
     attr_accessor :semver_formats
     attr_accessor :enable_public_badge_access, :shields_io_base_url, :badge_provider_mode
     attr_accessor :disable_ssl_verification
@@ -105,6 +107,7 @@ module PactBroker
       config.check_for_potential_duplicate_pacticipant_names = true
       config.disable_ssl_verification = false
       config.webhook_http_method_whitelist = ['POST']
+      config.webhook_http_code_success = [200, 201, 202, 203, 204, 205, 206]
       config.webhook_scheme_whitelist = ['https']
       config.webhook_host_whitelist = []
       # TODO get rid of unsafe-inline
@@ -240,6 +243,10 @@ module PactBroker
       @webhook_http_method_whitelist = parse_space_delimited_string_list_property('webhook_http_method_whitelist', webhook_http_method_whitelist)
     end
 
+    def webhook_http_code_success= webhook_http_code_success
+      @webhook_http_code_success = parse_space_delimited_integer_list_property('webhook_http_code_success', webhook_http_code_success)
+    end
+
     def webhook_scheme_whitelist= webhook_scheme_whitelist
       @webhook_scheme_whitelist = parse_space_delimited_string_list_property('webhook_scheme_whitelist', webhook_scheme_whitelist)
     end
@@ -248,6 +255,10 @@ module PactBroker
       @webhook_host_whitelist = parse_space_delimited_string_list_property('webhook_host_whitelist', webhook_host_whitelist)
     end
 
+    def base_urls
+      base_url ? base_url.split(" ") : []
+    end
+
     def warning_error_classes
       warning_error_class_names.collect do | class_name |
         begin
@@ -269,5 +280,15 @@ module PactBroker
         raise ConfigurationError.new("Pact Broker configuration property `#{property_name}` must be a space delimited String or an Array")
       end
     end
+
+    def parse_space_delimited_integer_list_property property_name, property_value
+      case property_value
+      when String then Config::SpaceDelimitedIntegerList.parse(property_value)
+      when Array then Config::SpaceDelimitedIntegerList.new(property_value)
+      else
+        raise ConfigurationError.new("Pact Broker configuration property `#{property_name}` must be a space delimited String or an Array with Integer values")
+      end
+    end
+
   end
 end

data/lib/pact_broker/db/data_migrations/helpers.rb

@@ -5,6 +5,10 @@ module PactBroker
         def column_exists?(connection, table, column)
           connection.table_exists?(table) && connection.schema(table).find{|col| col.first == column }
         end
+
+        def columns_exist?(connection, table, columns)
+          columns.all?{ | column | column_exists?(connection, table, column) }
+        end
       end
     end
   end

data/lib/pact_broker/db/data_migrations/set_extra_columns_for_tags.rb

@@ -0,0 +1,29 @@
+require 'pact_broker/db/data_migrations/helpers'
+
+module PactBroker
+  module DB
+    module DataMigrations
+      class SetExtraColumnsForTags
+        extend Helpers
+
+        def self.call(connection)
+          if columns_exist?(connection, :tags, [:version_id, :pacticipant_id]) &&
+              columns_exist?(connection, :versions, [:id, :pacticipant_id])
+            connection[:tags].where(pacticipant_id: nil).update(
+              pacticipant_id: connection[:versions].select(:pacticipant_id)
+                                .where(Sequel[:versions][:id] => Sequel[:tags][:version_id])
+            )
+          end
+
+          if columns_exist?(connection, :tags, [:version_id, :version_order]) &&
+              columns_exist?(connection, :versions, [:id, :order])
+            connection[:tags].where(version_order: nil).update(
+              version_order: connection[:versions].select(:order)
+                                .where(Sequel[:versions][:id] => Sequel[:tags][:version_id])
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/db/migrate_data.rb

@@ -21,6 +21,7 @@ module PactBroker
         DataMigrations::DeleteDeprecatedWebhookExecutions.call(database_connection)
         DataMigrations::SetCreatedAtForLatestPactPublications.call(database_connection)
         DataMigrations::SetCreatedAtForLatestVerifications.call(database_connection)
+        DataMigrations::SetExtraColumnsForTags.call(database_connection)
       end
     end
   end

data/lib/pact_broker/db/seed_example_data.rb

@@ -16,25 +16,25 @@ module PactBroker
         PactBroker::Test::TestDataBuilder.new
           .create_consumer(consumer_name, created_at: days_ago(16))
           .create_provider(provider_name, created_at: days_ago(16))
-          .create_consumer_version("e15da45d3943bf10793a6d04cfb9f5dabe430fe2", created_at: days_ago(16))
+          .create_consumer_version("e15da45d3943bf10793a6d04cfb9f5dabe430fe2", branch: "main", created_at: days_ago(16))
           .create_consumer_version_tag("prod", created_at: days_ago(16))
-          .create_consumer_version_tag("master", created_at: days_ago(16))
+          .create_consumer_version_tag("main", created_at: days_ago(16))
           .create_pact(json_content: pact_1, created_at: days_ago(16))
-          .create_verification(provider_version: "1315e0b1924cb6f42751f977789be3559373033a", execution_date: days_ago(15))
-          .create_provider_version_tag("master", created_at: days_ago(14))
+          .create_verification(provider_version: "1315e0b1924cb6f42751f977789be3559373033a", branch: "main", execution_date: days_ago(15))
+          .create_provider_version_tag("main", created_at: days_ago(14))
           .create_provider_version_tag("prod", created_at: days_ago(14))
-          .create_verification(provider_version: "480e5aeb30467856ca995d0024d2c1800b0719e5", success: false, number: 2, execution_date: days_ago(14))
-          .create_provider_version_tag("master", created_at: days_ago(14))
-          .create_consumer_version("725c6ccb7cf7efc51b4394f9828585eea9c379d9", created_at: days_ago(7))
+          .create_verification(provider_version: "480e5aeb30467856ca995d0024d2c1800b0719e5", branch: "main", success: false, number: 2, execution_date: days_ago(14))
+          .create_provider_version_tag("main", created_at: days_ago(14))
+          .create_consumer_version("725c6ccb7cf7efc51b4394f9828585eea9c379d9", branch: "feat/new-thing", created_at: days_ago(7))
           .create_consumer_version_tag("feat-new-thing", created_at: days_ago(7))
           .create_pact(json_content: pact_2, created_at: days_ago(7))
-          .create_consumer_version("7bd4d9173522826dc3e8704fd62dde0424f4c827", created_at: days_ago(1))
-          .create_consumer_version_tag("master", created_at: days_ago(1))
+          .create_consumer_version("7bd4d9173522826dc3e8704fd62dde0424f4c827", branch: "main", created_at: days_ago(1))
+          .create_consumer_version_tag("main", created_at: days_ago(1))
           .create_pact(json_content: pact_3, created_at: days_ago(1))
-          .create_verification(provider_version: "4fdf20082263d4c5038355a3b734be1c0054d1e1", execution_date: days_ago(1))
-          .create_provider_version_tag("master", created_at: days_ago(1))
-          .create_consumer_version("5556b8149bf8bac76bc30f50a8a2dd4c22c85f30", created_at: days_ago(0.5))
-          .create_consumer_version_tag("master", created_at: days_ago(0.5))
+          .create_verification(provider_version: "4fdf20082263d4c5038355a3b734be1c0054d1e1", branch: "main", execution_date: days_ago(1))
+          .create_provider_version_tag("main", created_at: days_ago(1))
+          .create_consumer_version("5556b8149bf8bac76bc30f50a8a2dd4c22c85f30", branch: "main", created_at: days_ago(0.5))
+          .create_consumer_version_tag("main", created_at: days_ago(0.5))
           .republish_same_pact(created_at: days_ago(0.5))
       end
 

data/lib/pact_broker/deployments/environment.rb

@@ -0,0 +1,15 @@
+require 'sequel'
+require 'sequel/plugins/serialization'
+
+
+module PactBroker
+  module Deployments
+    class Environment < Sequel::Model
+      OPEN_STRUCT_TO_JSON = lambda { |thing| Sequel.object_to_json(thing.collect(&:to_h)) }
+      JSON_TO_OPEN_STRUCT = lambda { | json | Sequel.parse_json(json).collect{ | hash| OpenStruct.new(hash) } }
+      plugin :upsert, identifying_columns: [:uuid]
+      plugin :serialization
+      serialize_attributes [OPEN_STRUCT_TO_JSON, JSON_TO_OPEN_STRUCT], :contacts
+    end
+  end
+end

data/lib/pact_broker/deployments/environment_service.rb

@@ -0,0 +1,39 @@
+require 'pact_broker/deployments/environment'
+require 'securerandom'
+
+module PactBroker
+  module Deployments
+    module EnvironmentService
+
+      def self.next_uuid
+        SecureRandom.uuid
+      end
+
+      def self.create(uuid, environment)
+        environment.uuid = uuid
+        environment.save
+      end
+
+      def self.update(uuid, environment)
+        environment.uuid = uuid
+        environment.upsert
+      end
+
+      def self.find_all
+        PactBroker::Deployments::Environment.order(Sequel.function(:lower, :display_name)).all
+      end
+
+      def self.find(uuid)
+        PactBroker::Deployments::Environment.where(uuid: uuid).single_record
+      end
+
+      def self.find_by_name(name)
+        PactBroker::Deployments::Environment.where(name: name).single_record
+      end
+
+      def self.delete(uuid)
+        PactBroker::Deployments::Environment.where(uuid: uuid).delete
+      end
+    end
+  end
+end