sbmt-pact 0.12.0

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "pact_message_helpers"
+require_relative "webmock/webmock_helpers"
+
+module SbmtPactProducerDsl
+  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 _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 = Sbmt::Pact::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)
+      raise "message_pact_provider should be declared first" unless pact_config
+      raise "message_pact_provider should be declared first" unless pact_config.is_a?(Sbmt::Pact::Provider::PactConfig::Async)
+      pact_config.new_message_handler(name, opts: opts, &block)
+    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 SbmtPactProducerDsl, pact_entity: :provider
+  config.extend SbmtPactProducerDsl::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/sbmt/pact/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/sbmt/pact/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/sbmt/pact/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
+end

data/lib/sbmt/pact/tasks/pact.rake

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

data/lib/sbmt/pact/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Pact
+    VERSION = "0.12.0"
+  end
+end

data/lib/sbmt/pact.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "pact/ffi"
+
+require "sbmt/pact/railtie" if defined?(Rails::Railtie)
+
+module Sbmt
+  module Pact
+    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 ||= Sbmt::Pact::Configuration.new
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.push_dir(File.join(__dir__, ".."))
+
+loader.tag = "sbmt-pact"
+
+loader.ignore("#{__dir__}/pact/version.rb")
+loader.ignore("#{__dir__}/pact/rspec.rb")
+loader.ignore("#{__dir__}/pact/rspec")
+
+loader.setup
+loader.eager_load

data/sbmt-pact.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "lib/sbmt/pact/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sbmt-pact"
+  spec.license = "MIT"
+  spec.version = Sbmt::Pact::VERSION
+  spec.authors = ["Kuper Ruby Platform Team"]
+
+  spec.summary = "Ruby gem for simplified Pact testing between microservices, supporting the latest Pact specifications and multiple transport protocols"
+  spec.description = "It is a powerful Ruby gem designed to streamline Pact testing in microservice architectures. It supports the latest Pact specifications and offers capabilities beyond the current pact-ruby gem, including support for non-HTTP transports like gRPC and async messaging systems like Kafka."
+  spec.homepage = "https://github.com/Kuper-Tech/sbmt-pact"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "false" # rubocop:disable Gemspec/RequireMFA
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "zeitwerk", "~> 2.3"
+  spec.add_dependency "pact-ffi", "~> 0.4.22"
+  spec.add_dependency "rack", "~> 2.0"
+  spec.add_dependency "webrick"
+  spec.add_dependency "rack-proxy"
+
+  spec.add_development_dependency "appraisal", ">= 2.4"
+  spec.add_development_dependency "bundler", ">= 2.3"
+  spec.add_development_dependency "combustion", ">= 1.3"
+  spec.add_development_dependency "gruf", ">= 2.18"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "sbmt-kafka_consumer", ">= 2.0.1"
+  spec.add_development_dependency "sbmt-kafka_producer", ">= 1.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "standard", ">= 1.35.1"
+  spec.add_development_dependency "vcr", ">= 6.0"
+  spec.add_development_dependency "faraday", "> 1.0"
+  spec.add_development_dependency "webmock", ">= 3.0"
+  spec.add_development_dependency "gruf-rspec", ">= 0.6.0"
+end