Allows pact verification against a running provider at a configurable base URL (normal pact verification is run against a code base using Rack::Test::Methods - no process is actually spawned).
This allows testing against providers where you have access to a running instance of a provider, but you do not have access to its code base, or where the provider is not a ruby application.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install pact-provider-proxy
Usually, you would configure and run pact:verify in the provider code base. If you are using pact-provider-proxy to run your pact verify task, it is probably because you don't have access to the code base of the provider project, or it is not a ruby project, so it may make sense to include this task in your consumer project.
Specifying a pact_helper is optional, and is only required if you are using provider states or you need to configure Pact. Note that the pact_helper for the
ProxyVerificationTask will not be automatically loaded like it is for the regular
pact:verify - you must specify the path yourself if you need one (see the example below). The configuration options for the provider code will be different from the consumer code, so you cannot reuse the pact_helper from your consumer tests.
require 'pact/provider/proxy/tasks' Pact::ProxyVerificationTask.new :monolith do | task | task.pact_url './spec/pacts/my-consumer_my-monolith.json', :pact_helper => './spec/support/monolith_pact_helper' task.provider_base_url 'http://my-monolith:8080' #scheme, host and optional port end
$ rake pact:verify:monolith
If you have access to your provider code base, and are able to spawn an instance locally, you could add some rake tasks to start and stop your server. (Please note, I have not actually run this code, I just think it should work...)
Pact::ProxyVerificationTask.new :running_local_monolith do | task | task.pact_url './spec/pacts/my-consumer_my-local-monolith.json' task.provider_base_url 'http://localhost:8080' end task :start_provider do system "./provider_start -p 8080" end task :stop_provider do system "./provider_stop" end task 'pact:verify:local_monolith' do begin Rake::Task['start_provider'].execute Rake::Task['pact:verify:running_local_monolith'].execute ensure Rake::Task['stop_provider'].execute end end
If a ruby adapter to the underlying datastore cannot be used to set up provider states, shell scripts that invoke code in the native language might work. If you have access to the code base, another alternative could be to provide an endpoint on your app that sets up data inside itself, that is only mounted in test mode. eg 'http://localhost:8080/set-up-provider-state?name=a%20thing%20exists' and 'http://localhost:8080/tear-down-provider-state?name=a%20thing%20exists'
pact-provider-proxy is fully compatible with pacts generated by the Ruby implementation of Pact, including Pact::Terms. However, it does not yet support the v2.0 regular expression syntax implemented in the JVM version of Pact.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request