Skip to content

Latest commit

 

History

History
194 lines (127 loc) · 5.12 KB

configuration.md

File metadata and controls

194 lines (127 loc) · 5.12 KB
Raw

Configuration

Menu

Consumer and Provider configuration options

Consumer only configuration options

Provider only configuration options

Consumer and Provider

log_dir

Pact.configure do | config |
  config.log_dir = './log'
end

Default value: ./log

logger

Pact.configure do | config |
  config.logger = Logger.new
end

Default value: file logger to the configured log_dir.

logger.level

Pact.configure do | config |
  config.logger.level = Logger::INFO
end

Default value: Logger::DEBUG

diff_formatter

Pact.configure do | config |
  config.diff_formatter = :list
end

Default value: :list

Options: :unix, :list, :embedded, Custom Diff Formatter

:unix

:list

:embedded

Custom Diff Formatter

Any object can be used that responds to call, accepting the argument diff.

class MyCustomDiffFormatter

  def self.call diff
    ### Do stuff here
  end

end

Pact.configure do | config |
  config.diff_formatter = MyCustomDiffFormatter
end

Consumer

pact_dir

Pact.configure do | config |
  config.pact_dir = './spec/pacts'
end

Default value: ./spec/pacts

doc_generator

Pact.configure do | config |
  config.doc_generator = :markdown
end

Default value: none

Options: :markdown, Custom Doc Generator

:markdown

Generates Markdown documentation based on the contents of the pact files created in this consumer. Files are created in ${Pact.configuration.doc_dir}/markdown.

Custom Doc Generator

Any object can be used that responds to call, accepting the arguments pact_dir and doc_dir.

Pact.configure do | config |
  config.doc_generator = lambda{ | pact_dir, doc_dir | generate_some_docs(pact_dir, doc_dir) }
end

doc_dir

Pact.configure do | config |
  config.doc_dir = './doc'
end

Default value: ./doc

pactfile_write_mode

Default value: :overwrite Options: :overwrite, :update, :smart, :none

By default, the pact file will be overwritten (started from scratch) every time any rspec runs any spec using pacts. This means that if there are interactions that haven't been executed in the most recent rspec run, they are effectively removed from the pact file. If you have long running pact specs (e.g. they are generated using the browser with Capybara) and you are developing both consumer and provider in parallel, or trying to fix a broken interaction, it can be tedious to run all the specs at once. In this scenario, you can set the pactfile_write_mode to :update. This will keep all existing interactions, and update only the changed ones, identified by description and provider state. The down side of this is that if either of those fields change, the old interactions will not be removed from the pact file. As a middle path, you can set pactfile_write_mode to :smart. This will use :overwrite mode when running rake (as determined by a call to system using 'ps') and :update when running an individual spec. :none will not generate any pact files (with pact-mock_service >= 0.8.1).

pactfile_write_order

Default value: :chronological Options: :chronological, :alphabetical

By default, interactions within the pact file will be ordered in chronological order. As a result of this your pact file might be different with each rspec run.

Pact.configure do | config |
  config.pactfile_write_order = :alphabetical
end

Provider

Pact uses RSpec and Rack::Test to create dynamic specs based on the pact files. RSpec configuration can be used to modify test behaviour if there is not an appropriate Pact feature. If you wish to use the same spec_helper.rb file as your unit tests, require it in the pact_helper.rb, but remember that the RSpec configurations for your unit tests may or may not be what you want for your pact verification tests.

include

Pact.configure do | config |
  config.include MyTestHelperMethods
end

To make modules available in the provider state set_up and tear_down blocks, include them in the configuration as shown below. One common use of this to include factory methods for setting up data so that the provider states file doesn't get too bloated.

interactions_replay_order

Default value: :recorded Options: :recorded, :random

Replays interactions in a specific order. In combination with pactfile_write_order will allow you to have a consistent pact contract replayed in random order.

Pact.configure do | config |
  config.interactions_replay_order = :random
end