pact-v2 2.0.0.pre.preview1

data/lib/pact/pact_broker/pact_selection_description.rb

@@ -0,0 +1,66 @@
+module Pact
+  module PactBroker
+    module PactSelectionDescription
+      def pact_selection_description(provider, consumer_version_selectors, options, broker_base_url)
+        message = "Fetching pacts for #{provider} from #{broker_base_url} with the selection criteria: "
+        if consumer_version_selectors.any?
+          desc = consumer_version_selectors.collect do |selector|
+            desc = nil
+            if selector[:tag]
+              desc = !selector[:latest] ? "all for tag #{selector[:tag]}" : "latest for tag #{selector[:tag]}"
+              desc = "#{desc} of #{selector[:consumer]}" if selector[:consumer]
+            elsif selector[:branch]
+              desc = "latest from branch #{selector[:branch]}"
+              desc = "#{desc} of #{selector[:consumer]}" if selector[:consumer]
+            elsif selector[:mainBranch]
+              desc = "latest from main branch"
+              desc = "#{desc} of #{selector[:consumer]}" if selector[:consumer]
+            elsif selector[:deployed]
+              if selector[:environment]
+                desc = "currently deployed to #{selector[:environment]}"
+              else
+                desc = "currently deployed"
+              end
+              desc = "#{selector[:consumer]} #{desc}" if selector[:consumer]
+            elsif selector[:released]
+              if selector[:environment]
+                desc = "currently released to #{selector[:environment]}"
+              else
+                desc = "currently released"
+              end
+              desc = "#{selector[:consumer]} #{desc}" if selector[:consumer]
+            elsif selector[:deployedOrReleased]
+              if selector[:environment]
+                desc = "currently deployed or released to #{selector[:environment]}"
+              else
+                desc = "currently deployed or released"
+              end
+              desc = "#{selector[:consumer]} #{desc}" if selector[:consumer]
+            elsif selector[:environment]
+              desc = "currently in #{selector[:environment]}"
+              desc = "#{selector[:consumer]} #{desc}" if selector[:consumer]
+            elsif selector[:matchingBranch]
+              desc = "matching current branch"
+              desc = "#{desc} for #{selector[:consumer]}" if selector[:consumer]
+            elsif selector[:matchingTag]
+              desc = "matching tag"
+              desc = "#{desc} for #{selector[:consumer]}" if selector[:consumer]
+            else
+              desc = selector.to_s
+            end
+
+            fallback = selector[:fallback] || selector[:fallbackTag]
+            desc = "#{desc} (or #{fallback} if not found)" if fallback
+
+            desc
+          end.join(", ")
+          if options[:include_wip_pacts_since]
+            desc = "#{desc}, work in progress pacts created after #{options[:include_wip_pacts_since]}"
+          end
+          message << "#{desc}"
+        end
+        message
+      end
+    end
+  end
+end

data/lib/pact/pact_broker.rb

@@ -0,0 +1,25 @@
+require 'pact/pact_broker/fetch_pacts'
+require 'pact/pact_broker/fetch_pact_uris_for_verification'
+require 'pact/provider/pact_uri'
+
+#
+# @public Used by Pact Provider Verifier
+#
+module Pact
+  module PactBroker
+    extend self
+
+    # Keep for backwards compatibility with pact-provider-verifier < 1.23.1
+    def fetch_pact_uris *args
+      Pact::PactBroker::FetchPacts.call(*args).collect(&:uri)
+    end
+
+    def fetch_pact_uris_for_verification *args
+      Pact::PactBroker::FetchPactURIsForVerification.call(*args)
+    end
+
+    def build_pact_uri(*args)
+      Pact::Provider::PactURI.new(*args)
+    end
+  end
+end

data/lib/pact/project_root.rb

@@ -0,0 +1,7 @@
+require 'pathname'
+
+module Pact
+  def self.project_root
+    @project_root ||= Pathname.new(File.expand_path('../../../',__FILE__)).freeze
+  end
+end

data/lib/pact/provider/configuration/configuration_extension.rb

@@ -0,0 +1,69 @@
+require 'pact/provider/state/provider_state'
+require 'pact/provider/state/provider_state_configured_modules'
+require 'pact/provider/state/set_up'
+require 'pact/provider/state/tear_down'
+
+module Pact
+
+  module Provider
+
+    module Configuration
+
+      module ConfigurationExtension
+
+        attr_accessor :provider_application_version
+
+        def provider= provider
+          @provider = provider
+        end
+
+        def provider
+          if defined? @provider
+            @provider
+          else
+            raise "Please configure your provider. See the Provider section in the README for examples."
+          end
+        end
+
+        def config_ru_path
+          @config_ru_path ||= './config.ru'
+        end
+
+        def config_ru_path= config_ru_path
+          @config_ru_path = config_ru_path
+        end
+
+        def interactions_replay_order
+          @interactions_replay_order ||= :recorded #or :random
+        end
+
+        def interactions_replay_order= interactions_replay_order
+          @interactions_replay_order = interactions_replay_order.to_sym
+        end
+
+        def provider_state_set_up
+          @provider_state_set_up ||= Pact::Provider::State::SetUp
+        end
+
+        def provider_state_set_up= provider_state_set_up
+          @provider_state_set_up = provider_state_set_up
+        end
+
+        def provider_state_tear_down
+          @provider_state_tear_down ||= Pact::Provider::State::TearDown
+        end
+
+        def provider_state_tear_down= provider_state_tear_down
+          @provider_state_tear_down = provider_state_tear_down
+        end
+
+        def include mod
+          Pact::Provider::State::ProviderStateConfiguredModules.instance_eval do
+            include mod
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/dsl.rb

@@ -0,0 +1,18 @@
+require 'pact/provider/configuration/service_provider_dsl'
+require 'pact/provider/configuration/message_provider_dsl'
+
+module Pact
+
+  module Provider
+
+    module DSL
+      def service_provider name, &block
+        Configuration::ServiceProviderDSL.build(name, &block)
+      end
+
+      def message_provider name, &block
+        Configuration::MessageProviderDSL.build(name, &block)
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/message_provider_dsl.rb

@@ -0,0 +1,63 @@
+require 'pact/provider/configuration/service_provider_dsl'
+
+module Pact
+  module Provider
+    module Configuration
+      class MessageProviderDSL < ServiceProviderDSL
+        class RackToMessageAdapter
+          def initialize(message_builder)
+            @message_builder = message_builder
+          end
+
+          def call(env)
+            request_body_json = JSON.parse(env['rack.input'].read)
+            contents = @message_builder.call(request_body_json['description'])
+            [200, {"Content-Type" => "application/json"}, [{ contents: contents }.to_json]]
+          end
+        end
+
+        def initialize name
+          super
+          @mapper_block = lambda { |args|  }
+        end
+
+        dsl do
+          def app &block
+            self.app_block = block
+          end
+
+          def app_version application_version
+            self.application_version = application_version
+          end
+
+          def app_version_tags tags
+            self.tags = tags
+          end
+
+          def app_version_branch branch
+            self.branch = branch
+          end
+
+          def publish_verification_results publish_verification_results
+            self.publish_verification_results = publish_verification_results
+            Pact::RSpec.with_rspec_2 do
+              Pact.configuration.error_stream.puts "WARN: Publishing of verification results is currently not supported with rspec 2. If you would like this functionality, please feel free to submit a PR!"
+            end
+          end
+
+          def honours_pact_with consumer_name, options = {}, &block
+            create_pact_verification consumer_name, options, &block
+          end
+
+          def honours_pacts_from_pact_broker &block
+            create_pact_verification_from_broker(&block)
+          end
+
+          def builder &block
+            self.app_block = lambda { RackToMessageAdapter.new(block)  }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/pact_verification.rb

@@ -0,0 +1,48 @@
+require 'pact/provider/pact_verification'
+require 'pact/provider/pact_uri'
+require 'pact/shared/dsl'
+require 'pact/provider/world'
+
+module Pact
+  module Provider
+
+    module Configuration
+
+      class PactVerification
+
+        extend Pact::DSL
+
+        attr_accessor :consumer_name, :pact_uri, :ref
+
+        def initialize consumer_name, options = {}
+          @consumer_name = consumer_name
+          @ref = options.fetch(:ref, :head)
+          @pact_uri = nil
+        end
+
+        dsl do
+          def pact_uri pact_uri, options = {}
+            self.pact_uri = ::Pact::Provider::PactURI.new(pact_uri, options) if pact_uri
+          end
+        end
+
+        def finalize
+          validate
+          create_pact_verification
+        end
+
+        private
+
+        def create_pact_verification
+          verification = Pact::Provider::PactVerification.new(consumer_name, pact_uri, ref)
+          Pact.provider_world.add_pact_verification verification
+        end
+
+        def validate
+          raise "Please provide a pact_uri for the verification" unless pact_uri
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/pact_verification_from_broker.rb

@@ -0,0 +1,126 @@
+require 'pact/shared/dsl'
+require 'pact/provider/world'
+require 'pact/pact_broker/fetch_pact_uris_for_verification'
+require 'pact/errors'
+require 'pact/utils/string'
+
+module Pact
+  module Provider
+    module Configuration
+      class PactVerificationFromBroker
+
+        extend Pact::DSL
+
+        # If user declares a variable with the same name as one of these attributes
+        # in parent scope, it will clash with these ones,
+        # so put an underscore in front of the name to be safer.
+
+        attr_accessor :_provider_name, :_pact_broker_base_url, :_consumer_version_tags, :_provider_version_branch, :_provider_version_tags, :_basic_auth_options, :_enable_pending, :_include_wip_pacts_since, :_verbose, :_consumer_version_selectors, :_fail_if_no_pacts_found
+
+        def initialize(provider_name, provider_version_branch, provider_version_tags)
+          @_provider_name = provider_name
+          @_provider_version_branch = provider_version_branch
+          @_provider_version_tags = provider_version_tags
+          @_consumer_version_tags = []
+          @_consumer_version_selectors = []
+          @_enable_pending = false
+          @_include_wip_pacts_since = nil
+          @_verbose = false
+          @_fail_if_no_pacts_found = true # CLI defaults to false, unfortunately for consistency
+        end
+
+        dsl do
+          def pact_broker_base_url pact_broker_base_url, basic_auth_options = {}
+            self._pact_broker_base_url = pact_broker_base_url
+            self._basic_auth_options = basic_auth_options
+          end
+
+          def consumer_version_tags consumer_version_tags
+            self._consumer_version_tags = *consumer_version_tags
+          end
+
+          def consumer_version_selectors consumer_version_selectors
+            self._consumer_version_selectors = *consumer_version_selectors
+          end
+
+          def enable_pending enable_pending
+            self._enable_pending = enable_pending
+          end
+
+          # Underlying code defaults to true if not specified
+          def fail_if_no_pacts_found fail_if_no_pacts_found
+            self._fail_if_no_pacts_found = fail_if_no_pacts_found
+          end
+
+          def include_wip_pacts_since since
+            self._include_wip_pacts_since = if since.respond_to?(:xmlschema)
+              since.xmlschema
+            else
+              since
+            end
+          end
+
+          def verbose verbose
+            self._verbose = verbose
+          end
+        end
+
+        def finalize
+          validate
+          create_pact_verification
+        end
+
+        private
+
+        def create_pact_verification
+          fetch_pacts = Pact::PactBroker::FetchPactURIsForVerification.new(
+            _provider_name,
+            consumer_version_selectors,
+            _provider_version_branch,
+            _provider_version_tags,
+            _pact_broker_base_url,
+            _basic_auth_options.merge(verbose: _verbose),
+            { include_pending_status: _enable_pending, include_wip_pacts_since: _include_wip_pacts_since, fail_if_no_pacts_found: _fail_if_no_pacts_found }
+          )
+
+          Pact.provider_world.add_pact_uri_source fetch_pacts
+        end
+
+        def consumer_version_selectors
+          convert_tags_to_selectors + convert_consumer_version_selectors
+        end
+
+        def convert_tags_to_selectors
+          _consumer_version_tags.collect do | tag |
+            if tag.is_a?(Hash)
+              {
+                tag: tag.fetch(:name),
+                latest: !tag[:all],
+                fallbackTag: tag[:fallback]
+              }
+            elsif tag.is_a?(String)
+              {
+                tag: tag,
+                latest: true
+              }
+            else
+              raise Pact::Error.new("The value supplied for consumer_version_tags must be a String or a Hash. Found #{tag.class}")
+            end
+          end
+        end
+
+        def convert_consumer_version_selectors
+          _consumer_version_selectors.collect do | selector |
+            selector.each_with_object({}) do | (key, value), new_selector |
+              new_selector[Pact::Utils::String.camelcase(key.to_s).to_sym] = value
+            end
+          end
+        end
+
+        def validate
+          raise Pact::Error.new("Please provide a pact_broker_base_url from which to retrieve the pacts") unless _pact_broker_base_url
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/service_provider_config.rb

@@ -0,0 +1,32 @@
+module Pact
+  module Provider
+    module Configuration
+      class ServiceProviderConfig
+
+        attr_accessor :application_version
+        attr_reader :branch, :build_url
+
+        def initialize application_version, branch, tags, publish_verification_results, build_url, &app_block
+          @application_version = application_version
+          @branch = branch
+          @tags = [*tags]
+          @publish_verification_results = publish_verification_results
+          @app_block = app_block
+          @build_url = build_url
+        end
+
+        def app
+          @app_block.call
+        end
+
+        def publish_verification_results?
+          @publish_verification_results
+        end
+
+        def tags
+          @tags
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/service_provider_dsl.rb

@@ -0,0 +1,107 @@
+require 'pact/provider/configuration/pact_verification'
+require 'pact/provider/configuration/pact_verification_from_broker'
+require 'pact/provider/configuration/service_provider_config'
+require 'pact/errors'
+
+module Pact
+
+  module Provider
+
+    module Configuration
+
+      class Error < ::Pact::Error; end
+
+      class ServiceProviderDSL
+
+        extend Pact::DSL
+
+        attr_accessor :name, :app_block, :application_version, :branch, :tags, :publish_verification_results, :build_url
+
+        CONFIG_RU_APP = lambda {
+          unless File.exist? Pact.configuration.config_ru_path
+            raise "Could not find config.ru file at #{Pact.configuration.config_ru_path} Please configure the service provider app or create a config.ru file in the root directory of the project. See https://github.com/pact-foundation/pact-ruby/wiki/Verifying-pacts for more information."
+          end
+          result = Rack::Builder.parse_file(Pact.configuration.config_ru_path)
+
+          if result.respond_to?(:first) # rack 2
+            result.first
+          else # rack 3
+            result
+          end
+        }
+
+        def initialize name
+          @name = name
+          @publish_verification_results = false
+          @tags = []
+          @app_block = CONFIG_RU_APP
+        end
+
+        dsl do
+          def app &block
+            self.app_block = block
+          end
+
+          def app_version application_version
+            self.application_version = application_version
+          end
+
+          def app_version_tags tags
+            self.tags = tags
+          end
+
+          def app_version_branch branch
+            self.branch = branch
+          end
+
+          def build_url build_url
+            self.build_url = build_url
+          end
+
+          def publish_verification_results publish_verification_results
+            self.publish_verification_results = publish_verification_results
+            Pact::RSpec.with_rspec_2 do
+              Pact.configuration.error_stream.puts "WARN: Publishing of verification results is currently not supported with rspec 2. If you would like this functionality, please feel free to submit a PR!"
+            end
+          end
+
+          def honours_pact_with consumer_name, options = {}, &block
+            create_pact_verification consumer_name, options, &block
+          end
+
+          def honours_pacts_from_pact_broker &block
+            create_pact_verification_from_broker(&block)
+          end
+        end
+
+        def create_pact_verification consumer_name, options, &block
+          PactVerification.build(consumer_name, options, &block)
+        end
+
+        def create_pact_verification_from_broker(&block)
+          PactVerificationFromBroker.build(name, branch, tags, &block)
+        end
+
+        def finalize
+          validate
+          create_service_provider
+        end
+
+        private
+
+        def validate
+          raise Error.new("Please provide a name for the Provider") unless name && !name.strip.empty?
+          raise Error.new("Please set the app_version when publish_verification_results is true") if publish_verification_results && application_version_blank?
+        end
+
+        def application_version_blank?
+          application_version.nil? || application_version.strip.empty?
+        end
+
+        def create_service_provider
+          Pact.configuration.provider = ServiceProviderConfig.new(application_version, branch, tags, publish_verification_results, build_url, &@app_block)
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration.rb

@@ -0,0 +1,7 @@
+require 'pact/provider/configuration/dsl'
+require 'pact/provider/configuration/configuration_extension'
+require 'pact/provider/state/provider_state'
+
+Pact.send(:extend, Pact::Provider::DSL)
+Pact.send(:extend, Pact::Provider::State::DSL)
+Pact::Configuration.send(:include, Pact::Provider::Configuration::ConfigurationExtension)

data/lib/pact/provider/help/console_text.rb

@@ -0,0 +1,76 @@
+require 'pact/provider/help/content'
+require 'fileutils'
+require 'pact/consumer/configuration'
+require 'pact/provider/help/write'
+require 'rainbow'
+
+module Pact
+  module Provider
+    module Help
+      class ConsoleText
+
+        def self.call reports_dir = Pact.configuration.reports_dir, options = {color: true}
+          new(reports_dir || Pact.configuration.reports_dir, options).call
+        end
+
+        def initialize reports_dir, options
+          @reports_dir = File.expand_path(reports_dir)
+          @options = options
+        end
+
+        def call
+          begin
+            options[:color] ? ColorizeMarkdown.(help_text) : help_text
+          rescue Errno::ENOENT
+            options[:color] ? error_text_coloured : error_text_plain
+          end
+        end
+
+        private
+
+        attr_reader :reports_dir, :options
+
+        def help_text
+          File.read(help_file_path)
+        end
+
+        def help_file_path
+          File.join(reports_dir, Write::HELP_FILE_NAME)
+        end
+
+        def error_text_plain
+          "Sorry, could not find help file at #{help_file_path}. Please ensure you have run `rake pact:verify`.\n" +
+           "If this does not fix the problem, please raise a github issues for this bug."
+        end
+
+        def error_text_coloured
+          Rainbow(error_text_plain).red
+        end
+
+        class ColorizeMarkdown
+
+          def self.call markdown
+            markdown.split("\n").collect do | line |
+              if line.start_with?("# ")
+                yellow_underling line.gsub(/^# /, '')
+              elsif line.start_with?("* ")
+                green("* ") + line.gsub(/^\* /, '')
+              else
+                line
+              end
+            end.join("\n")
+          end
+
+          def self.yellow_underling string
+            Rainbow(string).yellow.underline
+          end
+
+          def self.green string
+            Rainbow(string).green
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/help/content.rb

@@ -0,0 +1,38 @@
+require 'pact/provider/help/pact_diff'
+
+module Pact
+  module Provider
+    module Help
+      class Content
+
+        def initialize pact_sources
+          @pact_sources = pact_sources
+        end
+
+        def text
+          help_text + "\n\n" + pact_diffs
+        end
+
+        private
+
+        attr_reader :pact_sources
+
+        def help_text
+          temp_dir = Pact.configuration.tmp_dir
+          log_path = Pact.configuration.log_path
+          ERB.new(template_string).result(binding)
+        end
+
+        def template_string
+          File.read(File.expand_path( '../../../templates/help.erb', __FILE__))
+        end
+
+        def pact_diffs
+          pact_sources.collect do | pact_json |
+            PactDiff.call(pact_json)
+          end.compact.join("\n")
+        end
+      end
+    end
+  end
+end