pact-message 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d08c5d0ff1f47c7645c15116d76899e296609e415a2bd7c316aecb2f3ab350
-  data.tar.gz: c306cdc07c7ec261cdb6908d0c5528a934055d71bfd4ca64cddede5d960d698b
+  metadata.gz: 9e2884875c85c338522d2113d74c7e742309cdc864180a6c7270bf3f3d31a175
+  data.tar.gz: 786c95da06a2c7b44a5eb17c18c7f45b1c52fdbe0cab4d6732ab57d8d49b0954
 SHA512:
-  metadata.gz: e96ced52250984fefe42525d870ef3257bbaf16c6021f6b6426cf49eea83b5d31683e481357ceae672833e58fe930cb7b2cab410d8f0d4f1186bd3013153d443
-  data.tar.gz: 20ef30518e2cf57b1f21e3f2540f4a48858781752318dbe3b2d4dff743830510e83d0335cc59c224a995aacda5860c8a8383bb7c0aa25f60cfde704260ea75da
+  metadata.gz: ad49fca208a2fef4107862750d4349ba890354ecf220c497fc3fa192f1d78cd7dee3abba59770023682734e9d5236932d74faf488fe372637181aad81c569550
+  data.tar.gz: 4b96ecd3a271135ede66c3d2f492030e4daa045362a8db507b236e6bad0e4e54aaaff064703dcbdf1970d7e73cb0673b45c0f8f49895726e6aee9bc3f58ae63e

data/.github/workflows/release_gem.yml

@@ -23,15 +23,15 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     outputs:
-      gem_name: ${{ steps.release.outputs.gem_name }}
-      version: ${{ steps.release.outputs.version }}
-      increment: ${{ steps.release.outputs.increment }}
+      gem_name: ${{ steps.release-gem.outputs.gem_name }}
+      version: ${{ steps.release-gem.outputs.version }}
+      increment: ${{ steps.release-gem.outputs.increment }}
     steps:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
     - uses: pact-foundation/release-gem@v0.0.11
-      id: release
+      id: release-gem
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
         GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

data/.gitignore

@@ -12,3 +12,4 @@ spec/pacts/zoo_consumer-zoo_provider.json
 
 # rspec failure tracking
 .rspec_status
+spec/pacts/

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v0.9.0"></a>
+### v0.9.0 (2020-11-04)
+
+#### Features
+
+* allow pact dir to be configured	 ([f2f9626](/../../commit/f2f9626))
+* verify that each message has been yielded	 ([1d4d92c](/../../commit/1d4d92c))
+
+* **consumer**
+  * only update pact if test suite passes	 ([e99276d](/../../commit/e99276d))
+
 <a name="v0.8.0"></a>
 ### v0.8.0 (2020-09-28)
 

data/lib/pact/consumer_contract/message/contents.rb

@@ -31,6 +31,10 @@ module Pact
           end
         end
 
+        def reified_contents_hash
+          Pact::Reification.from_term(contents)
+        end
+
         def contents
           @contents
         end

data/lib/pact/message/cli.rb

@@ -12,10 +12,10 @@ module Pact
       desc 'update MESSAGE_JSON', 'Update a pact with the given message, or create the pact if it does not exist. The MESSAGE_JSON may be in the legacy Ruby JSON format or the v2+ format.'
       def update(message)
         require 'pact/message'
-        require 'pact/message/consumer/update_pact'
+        require 'pact/message/consumer/write_pact'
         pact_specification_version = Pact::SpecificationVersion.new(options.pact_specification_version)
         message = Pact::Message.from_hash(JSON.load(message), { pact_specification_version: pact_specification_version })
-        Pact::Message::Consumer::UpdatePact.call(message, options.pact_dir, options.consumer, options.provider, options.pact_specification_version)
+        Pact::Message::Consumer::WritePact.call(message, options.pact_dir, options.consumer, options.provider, options.pact_specification_version, :update)
       end
 
       desc 'reify', "Take a JSON document with embedded pact matchers and return a concrete example"

data/lib/pact/message/consumer/configuration/message_builder.rb

@@ -1,6 +1,6 @@
 require 'pact/message/consumer/consumer_contract_builder'
 require 'pact/message/consumer/consumer_contract_builders'
-# require 'pact/consumer/world'
+require 'pact/message/consumer/world'
 
 module Pact
   module Message
@@ -40,11 +40,11 @@ module Pact
 
           def create_consumer_contract_builder
             consumer_contract_builder_fields = {
-              :consumer_name => consumer_name,
-              :provider_name => provider_name,
+              consumer_name: consumer_name,
+              provider_name: provider_name,
+              pact_specification_version: pact_specification_version,
+              pact_dir: Pact.configuration.pact_dir
             }
-              # :pactfile_write_mode => Pact.configuration.pactfile_write_mode,
-              # :pact_dir => Pact.configuration.pact_dir
             Pact::Message::Consumer::ConsumerContractBuilder.new consumer_contract_builder_fields
           end
 
@@ -58,7 +58,8 @@ module Pact
             Pact::Message::Consumer::ConsumerContractBuilders.send(:define_method, @name.to_sym) do
               consumer_contract_builder
             end
-            # Pact.consumer_world.add_consumer_contract_builder consumer_contract_builder
+
+            Pact::Message.consumer_world.add_consumer_contract_builder consumer_contract_builder
           end
         end
       end

data/lib/pact/message/consumer/configuration/message_provider.rb

@@ -18,9 +18,13 @@ module Pact
           end
 
           dsl do
-            def builder builder_name, &block
+            def mock_provider(builder_name, &block)
               self.builder = MessageBuilder.build(builder_name, consumer_name, name, &block)
             end
+
+            def builder(builder_name, &block)
+              expectation_builder(builder_name, &block)
+            end
           end
 
           def finalize

data/lib/pact/message/consumer/consumer_contract_builder.rb

@@ -1,5 +1,6 @@
 require 'pact/message/consumer/interaction_builder'
-require 'pact/message/consumer/update_pact'
+require 'pact/message/consumer/write_pact'
+require 'pact/errors'
 
 module Pact
   module Message
@@ -10,11 +11,19 @@ module Pact
           @interaction_builder = nil
           @consumer_name = attributes[:consumer_name]
           @provider_name = attributes[:provider_name]
+          @pact_specification_version = attributes[:pact_specification_version]
+          @pact_dir = attributes[:pact_dir]
           @interactions = []
+          @yielded_interaction = false
         end
 
-        def given(provider_state)
-          interaction_builder.given(provider_state)
+        def reset
+          @interaction_builder = nil
+          @yielded_interaction = false
+        end
+
+        def given(provider_state, params = {})
+          interaction_builder.given(provider_state, params)
         end
 
         def is_expected_to_send(description)
@@ -22,27 +31,59 @@ module Pact
         end
 
         def send_message_string
-          yield contents.reified_contents_string if block_given?
+          if interaction_builder?
+            if block_given?
+              @yielded_interaction = true
+              yield interaction_builder.interaction.contents.reified_contents_string
+            end
+          else
+            raise Pact::Error.new("No message expectation has been defined")
+          end
+        end
+
+        def send_message_hash
+          if interaction_builder?
+            if block_given?
+              @yielded_interaction = true
+              yield interaction_builder.interaction.contents.reified_contents_hash
+            end
+          else
+            raise Pact::Error.new("No message expectation has been defined")
+          end
         end
 
         def handle_interaction_fully_defined(interaction)
           @contents = interaction.contents
           @contents_string = interaction.contents.to_s
-          @interactions << interaction
-          @interaction_builder = nil
-          # TODO pull these from pact config
-          Pact::Message::Consumer::UpdatePact.call(interaction, "./spec/pacts", consumer_name, provider_name, "2.0.0")
         end
 
         def verify example_description
-          #
-          # TODO check that message was actually yielded
+          # There may be multiple message providers defined, and not every one of them
+          # has to define a message for every test.
+          if interaction_builder?
+            if yielded_interaction?
+              interactions << interaction_builder.interaction
+            else
+              raise Pact::Error.new("`send_message_string` was not called for message \"#{interaction_builder.interaction.description}\"")
+            end
+          end
+        end
+
+        def write_pact
+          Pact::Message::Consumer::WritePact.call(interactions, pact_dir, consumer_name, provider_name, pact_specification_version, :overwrite)
         end
 
         private
 
-        attr_writer :interaction_builder
-        attr_accessor :consumer_name, :provider_name, :consumer_contract_details, :contents
+        attr_accessor :consumer_name, :provider_name, :consumer_contract_details, :contents, :interactions, :pact_specification_version, :pact_dir
+
+        def interaction_builder?
+          !!@interaction_builder
+        end
+
+        def yielded_interaction?
+          @yielded_interaction
+        end
 
         def interaction_builder
           @interaction_builder ||=

data/lib/pact/message/consumer/interaction_builder.rb

@@ -17,13 +17,17 @@ module Pact
           self
         end
 
-        def given provider_state
-          @interaction.provider_state = provider_state.nil? ? nil : provider_state.to_s
+        def given name, params = {}
+          if name
+            @interaction.provider_states << Pact::ProviderState.new(name, params)
+          end
           self
         end
 
+        alias_method :and, :given
+
         def with_metadata(object)
-          # TODO implement this
+          interaction.metadata = object
           self
         end
 

data/lib/pact/message/consumer/interaction_decorator.rb

@@ -17,7 +17,9 @@ module Pact
           hash[:providerStates] = provider_states
           hash[:contents] = extract_contents
           hash[:matchingRules] = extract_matching_rules
-          hash[:metaData] = message.metadata || {}
+          if message.metadata
+            hash[:metaData] = message.metadata
+          end
           fix_all_the_things hash
         end
 
@@ -42,9 +44,14 @@ module Pact
         end
 
         def extract_matching_rules
-          {
-            body: Pact::MatchingRules.extract(message.contents.contents, pact_specification_version: pact_specification_version)
-          }
+          body_matching_rules = Pact::MatchingRules.extract(message.contents.contents, pact_specification_version: pact_specification_version)
+          if body_matching_rules.any?
+            {
+              body: body_matching_rules
+            }
+          else
+            {}
+          end
         end
 
         def pact_specification_version

data/lib/pact/message/consumer/rspec.rb

@@ -20,7 +20,15 @@ hooks = Pact::Message::Consumer::SpecHooks.new
 RSpec.configure do |config|
   config.include Pact::Message::Consumer::RSpec, :pact => :message
 
-  config.after :each, :pact => true do | example |
+  config.before :each, :pact => :message do | example |
+    hooks.before_each Pact::RSpec.full_description(example)
+  end
+
+  config.after :each, :pact => :message do | example |
     hooks.after_each Pact::RSpec.full_description(example)
   end
+
+  config.after :all do
+    hooks.after_suite
+  end
 end

data/lib/pact/message/consumer/spec_hooks.rb

@@ -1,12 +1,25 @@
+require 'pact/message/consumer/world'
+
 module Pact
   module Message
     module Consumer
       class SpecHooks
+        def before_each example_description
+          Pact::Message.consumer_world.register_pact_example_ran
+          Pact::Message.consumer_world.consumer_contract_builders.each(&:reset)
+        end
+
         def after_each example_description
           Pact.configuration.message_provider_verifications.each do | message_provider_verification |
             message_provider_verification.call example_description
           end
         end
+
+        def after_suite
+          if Pact::Message.consumer_world.any_pact_examples_ran?
+            Pact::Message.consumer_world.consumer_contract_builders.each(&:write_pact)
+          end
+        end
       end
     end
   end

data/lib/pact/message/consumer/world.rb

@@ -0,0 +1,36 @@
+module Pact
+  module Message
+    def self.consumer_world
+      @consumer_world ||= Consumer::World.new
+    end
+
+    # internal api, for testing only
+    def self.clear_consumer_world
+      @consumer_world = nil
+    end
+
+    module Consumer
+      class World
+        def initialize
+          @any_pact_examples_ran = false
+        end
+
+        def consumer_contract_builders
+          @consumer_contract_builders ||= []
+        end
+
+        def add_consumer_contract_builder consumer_contract_builder
+          consumer_contract_builders << consumer_contract_builder
+        end
+
+        def register_pact_example_ran
+          @any_pact_examples_ran = true
+        end
+
+        def any_pact_examples_ran?
+          @any_pact_examples_ran
+        end
+      end
+    end
+  end
+end

data/lib/pact/message/consumer/{update_pact.rb → write_pact.rb}

@@ -4,26 +4,27 @@ require 'pact/message/consumer/consumer_contract_decorator'
 module Pact
   module Message
     module Consumer
-      class UpdatePact
+      class WritePact
 
-        def initialize message, pact_dir, consumer_name, provider_name, pact_specification_version
+        def initialize messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode
           @pact_dir = pact_dir
-          @message = message
+          @messages = messages
           @consumer_name = consumer_name
           @provider_name = provider_name
           @pact_specification_version = pact_specification_version
+          @pactfile_write_mode = pactfile_write_mode
         end
 
-        def self.call(message, pact_dir, consumer_name, provider_name, pact_specification_version)
-          new(message, pact_dir, consumer_name, provider_name, pact_specification_version).call
+        def self.call(messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode)
+          new(messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode).call
         end
 
         def call
           details = {
-            consumer: {name: consumer_name},
-            provider: {name: provider_name},
-            interactions: [message],
-            pactfile_write_mode: :update,
+            consumer: { name: consumer_name },
+            provider: { name: provider_name },
+            interactions: [*messages],
+            pactfile_write_mode: pactfile_write_mode,
             pact_dir: pact_dir,
             pact_specification_version: pact_specification_version,
             error_stream: StringIO.new,
@@ -36,7 +37,7 @@ module Pact
 
         private
 
-        attr_reader :message, :pact_dir, :consumer_name, :provider_name, :pact_specification_version
+        attr_reader :messages, :pact_dir, :consumer_name, :provider_name, :pact_specification_version, :pactfile_write_mode
       end
     end
   end

data/lib/pact/message/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Message
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

data/lib/pact/pact-message.rb

@@ -0,0 +1 @@
+require 'pact/message'

data/pact-message.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "pact-mock_service", "~> 3.1"
   spec.add_runtime_dependency "thor", "~> 0.20"
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency 'conventional-changelog', '~>1.2'

data/tasks/test.rake

@@ -0,0 +1,60 @@
+require "rspec/core/rake_task"
+
+ZOO_PACT_FILE_PATH = "spec/pacts/zoo_consumer-zoo_provider.json"
+
+RSpec::Core::RakeTask.new(:pass) do | task |
+  task.pattern = "spec/features/create_message_pact_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:fail) do | task |
+  task.pattern = "spec/features/create_message_pact_with_failure_test.rb"
+end
+
+task :pass_writes_pact_file do
+  require 'json'
+  puts "Ensuring that pact file is written for successful test suites"
+  FileUtils.rm_rf(ZOO_PACT_FILE_PATH)
+  Rake::Task['pass'].execute
+  if !File.exist?(ZOO_PACT_FILE_PATH)
+    raise "Expected pact file to be written at #{ZOO_PACT_FILE_PATH}"
+  end
+
+  pact_hash = JSON.parse(File.read(ZOO_PACT_FILE_PATH))
+  if pact_hash['messages'].size < 2
+    raise "Expected pact file to contain more than 1 message"
+  end
+end
+
+task :fail_does_not_write_pact_file do
+  puts "Ensuring that pact file is NOT written for failed test suites"
+  FileUtils.rm_rf(ZOO_PACT_FILE_PATH)
+  expect_to_fail('bundle exec rake fail')
+  if File.exist?(ZOO_PACT_FILE_PATH)
+    raise "Expected pact file NOT to be written at #{ZOO_PACT_FILE_PATH}"
+  end
+end
+
+task :default => [:pass_writes_pact_file, :fail_does_not_write_pact_file]
+
+def expect_to_fail command, options = {}
+  success = execute_command command, options
+  fail "Expected '#{command}' to fail" if success
+end
+
+def execute_command command, options
+  require 'open3'
+  result = nil
+  Open3.popen3(command) {|stdin, stdout, stderr, wait_thr|
+    result = wait_thr.value
+    ensure_patterns_present(command, options, stdout, stderr) if options[:with]
+  }
+  result.success?
+end
+
+def ensure_patterns_present command, options, stdout, stderr
+  require 'term/ansicolor'
+  output = stdout.read + stderr.read
+  options[:with].each do | pattern |
+    raise (::Term::ANSIColor.red("Could not find #{pattern.inspect} in output of #{command}") + "\n\n#{output}") unless output =~ pattern
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-message
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pact-support
@@ -58,14 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -165,9 +171,11 @@ files:
 - lib/pact/message/consumer/interaction_decorator.rb
 - lib/pact/message/consumer/rspec.rb
 - lib/pact/message/consumer/spec_hooks.rb
-- lib/pact/message/consumer/update_pact.rb
+- lib/pact/message/consumer/world.rb
+- lib/pact/message/consumer/write_pact.rb
 - lib/pact/message/consumer_contract_parser.rb
 - lib/pact/message/version.rb
+- lib/pact/pact-message.rb
 - pact-message.gemspec
 - script/docker-functions
 - script/functions
@@ -177,6 +185,7 @@ files:
 - script/trigger-release.sh
 - script/update-pact.sh
 - tasks/release.rake
+- tasks/test.rake
 homepage: http://pact.io
 licenses:
 - MIT