pact-v2 2.0.0.pre.preview1

data/lib/pact/v2/rspec/support/pact_provider_helpers.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative "pact_message_helpers"
+require_relative "webmock/webmock_helpers"
+
+module PactV2ProducerDsl
+  module ClassMethods
+    PACT_PROVIDER_NOT_DECLARED_MESSAGE = "http_pact_provider or grpc_pact_provider should be declared first"
+
+    def http_pact_provider(provider, opts: {})
+      _pact_provider(:http, provider, opts: opts)
+    end
+
+    def grpc_pact_provider(provider, opts: {})
+      _pact_provider(:grpc, provider, opts: opts)
+    end
+
+    def message_pact_provider(provider, opts: {})
+      _pact_provider(:async, provider, opts: opts)
+    end
+
+    def mixed_pact_provider(provider, opts: {})
+      execute_mixed_pact_provider(:mixed, provider, opts: opts)
+    end
+
+    def execute_mixed_pact_provider(transport_type, provider, opts: {})
+      raise "#{transport_type}_pact_provider is designed to be used with RSpec" unless defined?(::RSpec)
+      raise "#{transport_type}_pact_provider has to be declared at the top level of a suite" unless top_level?
+      raise "mixed_pact_provider is designed to be run once per provider so cannot be declared more than once" if defined?(@_pact_config)
+
+      pact_config_instance = Pact::V2::Provider::PactConfig.new(transport_type, provider_name: provider, opts: opts)
+      instance_variable_set(:@_pact_config, pact_config_instance)
+
+      # rubocop:disable RSpec/BeforeAfterAll
+      before(:context) do
+        # rspec allows only context ivars in specs and ignores the rest
+        # so we use block-as-a-closure feature to save pact_config ivar reference and make it available for descendants
+        @_pact_config = pact_config_instance
+      end
+      # rubocop:enable RSpec/BeforeAfterAll
+
+      it "verifies mixed interactions with provider #{provider}" do
+        pact_config.start_servers
+        # todo: call any available verifier, or exit if none specified
+        pact_config.http_config.new_verifier(@_pact_config).verify!
+      end
+    end
+
+    def _pact_provider(transport_type, provider, opts: {})
+      raise "#{transport_type}_pact_provider is designed to be used with RSpec" unless defined?(::RSpec)
+      raise "#{transport_type}_pact_provider has to be declared at the top level of a suite" unless top_level?
+      raise "*_pact_provider is designed to be run once per provider so cannot be declared more than once" if defined?(@_pact_config)
+
+      pact_config_instance = Pact::V2::Provider::PactConfig.new(transport_type, provider_name: provider, opts: opts)
+      instance_variable_set(:@_pact_config, pact_config_instance)
+
+      # rubocop:disable RSpec/BeforeAfterAll
+      before(:context) do
+        # rspec allows only context ivars in specs and ignores the rest
+        # so we use block-as-a-closure feature to save pact_config ivar reference and make it available for descendants
+        @_pact_config = pact_config_instance
+      end
+      # rubocop:enable RSpec/BeforeAfterAll
+
+      it "verifies interactions with provider #{provider}" do
+        pact_config.new_verifier.verify!
+      end
+    end
+
+    def before_state_setup(&block)
+      raise PACT_PROVIDER_NOT_DECLARED_MESSAGE unless pact_config
+      pact_config.before_setup(&block)
+    end
+
+    def after_state_teardown(&block)
+      raise PACT_PROVIDER_NOT_DECLARED_MESSAGE unless pact_config
+      pact_config.after_teardown(&block)
+    end
+
+    def provider_state(name, opts: {}, &block)
+      raise PACT_PROVIDER_NOT_DECLARED_MESSAGE unless pact_config
+      pact_config.new_provider_state(name, opts: opts, &block)
+    end
+
+    def handle_message(name, opts: {}, &block)
+      async_klass = Pact::V2::Provider::PactConfig::Async
+      if defined?(@_pact_config) &&
+          @_pact_config.respond_to?(:async_config) &&
+          @_pact_config.async_config.is_a?(async_klass)
+        @_pact_config.async_config.new_message_handler(name, opts: opts, &block)
+      elsif pact_config &&
+          pact_config.respond_to?(:async_config) &&
+          pact_config.async_config.is_a?(async_klass)
+        pact_config.async_config.new_message_handler(name, opts: opts, &block)
+      elsif defined?(@_pact_config) &&
+          @_pact_config.is_a?(async_klass)
+        @_pact_config.new_message_handler(name, opts: opts, &block)
+      elsif pact_config.is_a?(async_klass)
+        pact_config.new_message_handler(name, opts: opts, &block)
+
+      else
+        raise "handle_message can only be used with message_pact_provider or mixed_pact_provider with an async block"
+      end
+    end
+
+    def pact_config
+      instance_variable_get(:@_pact_config)
+    end
+  end
+
+  def pact_config
+    instance_variable_get(:@_pact_config)
+  end
+end
+
+RSpec.configure do |config|
+  config.include PactV2ProducerDsl, pact_entity: :provider
+  config.extend PactV2ProducerDsl::ClassMethods, pact_entity: :provider
+
+  config.around pact_entity: :provider do |example|
+    WebmockHelpers.turned_off do
+      if defined?(::VCR)
+        VCR.turned_off { example.run }
+      else
+        example.run
+      end
+    end
+  end
+end

data/lib/pact/v2/rspec/support/waterdrop/pact_waterdrop_client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class PactWaterdropClient
+  attr_reader :message
+
+  Report = Struct.new(:partition, :offset, :topic_name, keyword_init: true)
+
+  def produce_async(message)
+    @message = message
+  end
+
+  def produce_sync(message)
+    @message = message
+    Report.new(partition: 0, offset: 0, topic_name: message[:topic])
+  end
+
+  def to_pact(content_type: nil)
+    payload = message[:payload]
+    metadata = {
+      key: message[:key],
+      topic: message[:topic],
+      content_type: content_type
+    }.merge(message[:headers] || {})
+
+    [payload, metadata]
+  end
+end

data/lib/pact/v2/rspec/support/webmock/webmock_helpers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WebmockHelpers
+  def self.turned_off
+    yield unless defined?(::WebMock)
+
+    allow_net_connect = WebMock::Config.instance.allow_net_connect
+    allow_localhost = WebMock::Config.instance.allow_localhost
+    allow_hosts = WebMock::Config.instance.allow
+    net_http_connect_on_start = WebMock::Config.instance.net_http_connect_on_start
+
+    return yield if allow_net_connect
+
+    WebMock.allow_net_connect!
+
+    result = yield
+
+    # disable_net_connect! resets previous config settings
+    # so we need to specify them explicitly
+    WebMock.disable_net_connect!(
+      {
+        allow_localhost: allow_localhost,
+        allow: allow_hosts,
+        net_http_connect_on_start: net_http_connect_on_start
+      }
+    )
+
+    result
+  end
+end

data/lib/pact/v2/rspec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rspec"
+require_relative "rspec/support/pact_consumer_helpers"
+require_relative "rspec/support/pact_provider_helpers"
+
+RSpec.configure do |config|
+  config.define_derived_metadata(file_path: %r{spec/pact/}) { |metadata| metadata[:pact] = true }
+
+  # it's not an error: consumer tests contain `providers` subdirectory (because we're testing against different providers)
+  config.define_derived_metadata(file_path: %r{spec/pact/providers/}) { |metadata| metadata[:pact_entity] = :consumer }
+  # for provider tests it's the same thing: we're running tests which test consumers
+  config.define_derived_metadata(file_path: %r{spec/pact/consumers/}) { |metadata| metadata[:pact_entity] = :provider }
+
+  # exclude pact specs from generic rspec pipeline
+  config.filter_run_excluding :pact_v2
+end

data/lib/pact/v2/tasks/pact.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:pact_v2).tap do |task|
+  task.pattern = "spec/pact/consumers/**/*_spec.rb"
+  task.rspec_opts = "--require rails_helper_v2 --tag pact_v2"
+end
+
+namespace :pact_v2 do
+  desc "Verifies the pact files"
+  task verify: :pact_v2
+end

data/lib/pact/v2/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pact
+  module V2
+    VERSION = '2.0.0-preview1'
+    Version = '2.0.0-preview1'
+  end
+end

data/lib/pact/v2.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "pact/ffi"
+
+require "pact/v2/railtie" if defined?(Rails::Railtie)
+
+module Pact
+  module V2
+    class Error < StandardError; end
+
+    class ImplementationRequired < Error; end
+
+    class FfiError < Error
+      def initialize(msg, reason, status)
+        super(msg)
+
+        @msg = msg
+        @reason = reason
+        @status = status
+      end
+
+      def message
+        "FFI error: reason: #{@reason}, status: #{@status}, message: #{@msg}"
+      end
+    end
+
+    def self.configure
+      yield configuration if block_given?
+    end
+
+    def self.configuration
+      @configuration ||= Pact::V2::Configuration.new
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.push_dir(File.join(__dir__, ".."))
+
+loader.tag = "pact-v2"
+
+# existing pact-ruby ignores
+# loader.ignore("#{__dir__}/../pact") # ignore the pact dir at the root of the repo
+# loader.ignore("#{__dir__}/../pact/v2",false) # ignore the pact dir at the root of the repo
+# loader.push_dir(File.join(__dir__))
+
+
+loader.ignore("#{__dir__}/../pact/version.rb")
+loader.ignore("#{__dir__}/../pact/cli")
+loader.ignore("#{__dir__}/../pact/cli.rb")
+loader.ignore("#{__dir__}/../pact/consumer")
+loader.ignore("#{__dir__}/../pact/consumer.rb")
+loader.ignore("#{__dir__}/../pact/doc")
+loader.ignore("#{__dir__}/../pact/hal")
+loader.ignore("#{__dir__}/../pact/hash_refinements.rb")
+loader.ignore("#{__dir__}/../pact/pact_broker")
+loader.ignore("#{__dir__}/../pact/pact_broker.rb")
+loader.ignore("#{__dir__}/../pact/project_root.rb")
+loader.ignore("#{__dir__}/../pact/provider")
+loader.ignore("#{__dir__}/../pact/provider.rb")
+loader.ignore("#{__dir__}/../pact/retry.rb")
+loader.ignore("#{__dir__}/../pact/tasks")
+loader.ignore("#{__dir__}/../pact/tasks.rb")
+loader.ignore("#{__dir__}/../pact/templates")
+loader.ignore("#{__dir__}/../pact/utils")
+loader.ignore("#{__dir__}/../pact/v2/rspec.rb")
+loader.ignore("#{__dir__}/../pact/v2/rspec")
+loader.ignore("#{__dir__}/../pact/v2/railtie.rb") unless defined?(Rails::Railtie)
+loader.setup
+loader.eager_load

data/lib/pact/version.rb

@@ -0,0 +1,4 @@
+# Remember to bump pact-provider-proxy when this changes major version
+module Pact
+  VERSION = '2.0.0-preview1'
+end

data/lib/pact.rb

@@ -0,0 +1,13 @@
+
+# Selective loading of pact v1 and v2 based on environment variables
+if ENV['PACT_RUBY_V1_ENABLE'] != 'false'
+  require 'pact/support'
+  require 'pact/version'
+  require 'pact/configuration'
+  require 'pact/consumer'
+  require 'pact/provider'
+  require 'pact/consumer_contract'
+end
+if ENV['PACT_RUBY_V2_ENABLE'] == 'true'
+  require 'pact/v2'
+end

data/lib/tasks/pact.rake

@@ -0,0 +1,34 @@
+
+namespace :pact do
+
+  desc "Verifies the pact files configured in the pact_helper.rb against this service provider."
+  task :verify do
+
+    require 'pact/tasks/task_helper'
+
+    include Pact::TaskHelper
+
+    handle_verification_failure do
+      execute_pact_verify
+    end
+  end
+
+  desc "Verifies the pact at the given URI against this service provider."
+  task 'verify:at', :pact_uri do | t, args |
+    require 'rainbow'
+    require 'pact/tasks/task_helper'
+
+    include Pact::TaskHelper
+
+    abort(Rainbow("Please provide a pact URI. eg. rake pact:verify:at[../my-consumer/spec/pacts/my_consumer-my_provider.json]").red) unless args[:pact_uri]
+    handle_verification_failure do
+      execute_pact_verify args[:pact_uri]
+    end
+  end
+
+  desc "Get help debugging pact:verify failures."
+  task 'verify:help', :reports_dir do | t, args |
+    require 'pact/provider/help/console_text'
+    puts Pact::Provider::Help::ConsoleText.(args[:reports_dir])
+  end
+end

data/pact.gemspec

@@ -0,0 +1,106 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pact/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pact-v2"
+  gem.version       = Pact::VERSION
+  gem.authors       = ["James Fraser", "Sergei Matheson", "Brent Snook", "Ronald Holshausen", "Beth Skurrie"]
+  gem.email         = ["james.fraser@alumni.swinburne.edu", "sergei.matheson@gmail.com", "brent@fuglylogic.com", "uglyog@gmail.com", "bskurrie@dius.com.au"]
+  gem.description   = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}
+  gem.summary       = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}
+  gem.homepage      = "https://github.com/pact-foundation/pact-ruby"
+
+  gem.required_ruby_version = '>= 2.0'
+
+  gem.files         = `git ls-files bin lib pact.gemspec CHANGELOG.md LICENSE.txt`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+
+  gem.metadata = {
+    'changelog_uri'     => 'https://github.com/pact-foundation/pact-ruby/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/pact-foundation/pact-ruby',
+    'bug_tracker_uri'   => 'https://github.com/pact-foundation/pact-ruby/issues',
+    'documentation_uri' => 'https://github.com/pact-foundation/pact-ruby/blob/master/README.md'
+  }
+
+  # Shared dependencies between v1 and v2
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'faraday', '~>2.0', '<3.0'
+  gem.add_development_dependency 'webmock', '~> 3.0'
+
+  # Control which version of pact to use
+  # PACT_RUBY_V1_ENABLE=true to disable v1 (default is enabled)
+  # PACT_RUBY_V2_ENABLE=true to enable v2 (default is disabled)
+  # Both can be enabled at the same time, to enable transition
+  
+  if ENV['PACT_RUBY_V1_ENABLE'] != 'false'
+    gem.add_runtime_dependency 'rspec', '~> 3.0'
+    gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 3.0.0'
+    gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
+    gem.add_runtime_dependency "rainbow", '~> 3.1'
+    gem.add_runtime_dependency 'string_pattern', '~> 2.0'
+    gem.add_runtime_dependency 'jsonpath', '~> 1.0'
+
+    gem.add_runtime_dependency "pact-support" , "~> 1.21", ">=1.21.2"
+    gem.add_runtime_dependency 'pact-mock_service', '~> 3.0', '>= 3.3.1'
+    gem.add_development_dependency 'fakefs', '2.4'
+    gem.add_development_dependency 'hashie', '~> 5.0'
+    gem.add_development_dependency 'faraday-multipart', '~> 1.0'
+    gem.add_development_dependency 'conventional-changelog', '~> 1.3'
+    gem.add_development_dependency 'bump', '~> 0.5'
+    gem.add_development_dependency 'pact-message', '~> 0.8'
+    gem.add_development_dependency 'rspec-its', '~> 1.3'
+    gem.add_development_dependency 'webrick', '~> 1.8'
+    gem.add_development_dependency 'ostruct'
+  end
+
+  if ENV['PACT_RUBY_V2_ENABLE'] == 'true'
+
+    # Core dependencies (code loading)
+    gem.add_dependency "zeitwerk", "~> 2.3"
+    
+    # For Pact support via Pact Rust Core
+    gem.add_dependency "pact-ffi", "~> 0.4.28"
+   
+    # For Provider Side Verification
+    gem.add_dependency "rack"
+    gem.add_dependency "rack-proxy"
+    gem.add_dependency "webrick", '~> 1.8'
+    
+    # For Rails support, including testing non rails apps
+    gem.add_development_dependency "combustion", ">= 1.3"
+
+    # For Kafka support
+    unless RUBY_PLATFORM =~ /win32|x64-mingw32|x64-mingw-ucrt/
+      # windows does not support librdkafka
+      gem.add_development_dependency "sbmt-kafka_consumer", ">= 2.0.1"
+      gem.add_development_dependency "sbmt-kafka_producer", ">= 1.0"
+    end
+    if ENV['X_PACT_DEVELOPMENT_RDKAFKA'] == 'true'
+      # darwin-arm64 prebuilt gems available from 0.20.0
+      gem.add_development_dependency "karafka-rdkafka", ">= 0.20.0"
+    end
+    
+    # For gRPC support
+    gem.add_development_dependency "gruf", ">= 2.18"
+    gem.add_development_dependency "gruf-rspec", ">= 0.6.0"
+
+    # Testing tools
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "rspec-rails"
+    gem.add_development_dependency "rspec_junit_formatter"
+    gem.add_development_dependency "vcr", ">= 6.0"
+
+    # Development and linting tools
+    gem.add_development_dependency "appraisal", ">= 2.4"
+    gem.add_development_dependency "bundler", ">= 2.2"
+    gem.add_development_dependency "rubocop"
+    gem.add_development_dependency "rubocop-rspec"
+    gem.add_development_dependency "rubocop-rails"
+    gem.add_development_dependency "rubocop-performance"
+    gem.add_development_dependency "standard", ">= 1.35.1"
+  end
+end