pact-mock_service 0.2.3.pre.rc1 → 0.2.3.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e4c79027ecd3c1da41ed2b2305c7d02ab8422bb
-  data.tar.gz: b6900749dbe4f721b7c958d2522caa6fdabf0fe4
+  metadata.gz: 200c03efe0a34bab41ab409685601a5d069e5319
+  data.tar.gz: ffa20a890680ccf3dc0bc3c1aa20a78de93e64f6
 SHA512:
-  metadata.gz: 8945a97c67fc3f7d6531a963f9325690781e95914f37b41e8ab091fc45bdeaedec1907ec6fc84d42c12fe660f7a343a0cec7396bf519b378cfed4a4abd0b4795
-  data.tar.gz: a3c82d60ef644fd1057f2188d6d86571f026d1e59b8fc7333e8a14b91b8b397affb4558bfdc6dfb21546604c45d36197cc22f6eb173f0c509108ab8bf268d57c
+  metadata.gz: 143b3ff38ebc4689c56201b6f6280dd089a4a77883284571c7a07e89e1bdeb5b3b5b78a4eabb5226c7bfab4d5c797c436395c6e7b0c34050e9e32834b8993f05
+  data.tar.gz: 42a1f1bb0d3f374fa23b739b3bfb2273d46a51babced8496d1814e174f6da465896cce4f1fbb414f20fcad47fb346cf3b1d4fee136cdf4ebde2177586ea3d258

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 0.2.3.rc2 (13 Jan 2015)
+
+* daf0696 - Added --consumer and --provider options to CLI. Automatically write pact if both options are given at startup. (Beth, Mon Jan 5 20:48:47 2015 +1100)
+* 351c44e - Write pact on shutdown (Beth, Mon Jan 5 17:17:24 2015 +1100)
+* e206c9f - Adding cross domain headers (André Allavena, Tue Dec 23 18:01:46 2014 +1000)
+
 ### 0.2.3.rc1 (3 Jan 2015)
 
 * afd9cf3 - Removed awesome print gem dependency. (Beth, Sat Jan 3 16:49:40 2015 +1100)

data/README.md

@@ -1,314 +1,50 @@
-# Pact
+# Pact Mock Service
 
-Define a pact between service consumers and providers, enabling "consumer driven contract" testing.
+This codebase provides the mock service used by implementations of [Pact][pact]. It is packaged as a gem, and as a standalone executable for Mac OSX and Linux (Windows coming soon.)
 
-Pact provides an fluent API for service consumers to define the HTTP requests they will make to a service provider and the HTTP responses they expect back. These expectations are used in the consumer specs to provide a mock service provider. The interactions are recorded, and played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.
+The mock service provides the following endpoints:
 
-This allows testing of both sides of an integration point using fast unit tests.
+* DELETE /interactions - clear previously mocked interactions
+* POST /interactions - set up an expected interaction
+* GET /interactions/verification - determine whether the expected interactions have taken place
+* POST /pact - write the pact file
 
-This gem is inspired by the concept of "Consumer driven contracts". See [this article](http://martinfowler.com/articles/consumerDrivenContracts.html) by Martin Fowler for more information.
-
-Travis CI Status: [![travis-ci.org Build Status](https://travis-ci.org/realestate-com-au/pact.png)](https://travis-ci.org/realestate-com-au/pact)
-
-## What is it good for?
-
-Pact is most valuable for designing and testing integrations where you (or your team/organisation/partner organisation) control the development of both the consumer and the provider. It is fantastic tool for testing intra-organsation microservices.
-
-## What is it not good for?
-
-* Performance and load testing.
-* Functional testing of the provider - that is what the provider's own tests should do. Pact is about checking the contents and format of requests and responses.
-* Situations where you cannot load data into the provider without using the API that you're actually testing.
-
-## Features
-
-* A service is mocked using an actual process running on a specified port, so javascript clients can be tested as easily as backend clients.
-* "Provider states" (similar to fixtures) allow the same request to be made with a different expected response.
-* Consumers specify only the fields they are interested in, allowing a provider to return more fields without breaking the pact. This allows a provider to have a different pact with a different consumer, and know which fields each cares about in a given response.
-* RSpec and Minitest support for the service consumer codebase.
-* Rake tasks allow pacts to be verified against a service provider codebase.
-* Different versions of a consumer/provider pairs can be easily tested against each other, allowing confidence when deploying new versions of each (see the pact_broker and pact_broker-client gems).
-* Autogenerated API documentation - need we say more?
-* Autogenerated network diagrams with the [Pact Broker](https://github.com/bethesque/pact_broker)
-
-## How does it work?
-
-1. In the specs for the provider facing code in the consumer project, expectations are set up on a mock service provider.
-1. When the specs are run, the mock service returns the expected responses. The requests, and their expected responses, are then written to a "pact" file.
-1. The requests in the pact file are later replayed against the provider, and the actual responses are checked to make sure they match the expected responses.
-
-## Why is developing and testing with Pact better than using traditional system integration tests?
-
-* Faster execution.
-* Reliable responses from mock service reduce likelihood of flakey tests.
-* Causes of failure are easier to identify as only one component is being tested at a time.
-* Design of service provider is improved by considering first how the data is actually going to be used, rather than how it is most easily retrieved and serialised.
-* No separate integration environment required for automated integration tests - pact tests run in standalone CI builds.
-* Integration flows that would traditionally require running multiple services at the same time can be broken down and each integration point tested separately.
-
-## Contact
-
-* Twitter: [@pact_up](https://twitter.com/pact_up)
-* Google users group: https://groups.google.com/forum/#!forum/pact-support
-
-## Installation
-
-Put it in your Gemfile. You know how.
+As the Pact mock service can be used as a standalone executable and administered via HTTP, it can be used for testing with any language. All that is required is a library in the native language to create the HTTP calls listed above. Currently there are binding for [Ruby][pact] and [Javascript][javascript]. If you are interested in creating bindings in a new langauge, and have a chat to one of us on the [pact-dev Google group][pact-dev].
 
 ## Usage
 
-### Service Consumer project
-
-#### 1. Start with your model
-
-Imagine a model class that looks something like this. The attributes for a Something live on a remote server, and will need to be retrieved by an HTTP call.
-
-```ruby
-class Something
-  attr_reader :name
-
-  def initialize name
-    @name = name
-  end
-
-  def == other
-    other.is_a?(Something) && other.name == name
-  end
-end
-```
-
-#### 2. Create a skeleton client class
-
-Imagine a service provider client class that looks something like this.
-
-```ruby
-require 'httparty'
-
-class MyServiceProviderClient
-  include HTTParty
-  base_uri 'http://my-service'
-
-  def get_something
-    # Yet to be implemented because we're doing Test First Development...
-  end
-end
-```
-#### 3. Configure the mock server
-
-The following code will create a mock service on localhost:1234 which will respond to your application's queries over HTTP as if it were the real "My Service Provider" app. It also creates a mock service provider object which you will use to set up your expectations. The method name to access the mock service provider will be what ever name you give as the service argument - in this case "my_service_provider"
-
-
-```ruby
-# In /spec/service_providers/pact_helper.rb
-
-require 'pact/consumer/rspec'
-# or require 'pact/consumer/minitest' if you are using Minitest
-
-Pact.service_consumer "My Service Consumer" do
-  has_pact_with "My Service Provider" do
-    mock_service :my_service_provider do
-      port 1234
-    end
-  end
-end
-```
-
-#### 4. Write a failing spec for the client
-
-```ruby
-# In /spec/service_providers/my_service_provider_client_spec.rb
-
-# When using RSpec, use the metadata `:pact => true` to include all the pact functionality in your spec.
-# When using Minitest, include Pact::Consumer::Minitest in your spec.
-
-describe MyServiceProviderClient, :pact => true do
-
-  before do
-    # Configure your client to point to the stub service on localhost using the port you have specified
-    MyServiceProviderClient.base_uri 'localhost:1234'
-  end
-
-  subject { MyServiceProviderClient.new }
-
-  describe "get_something" do
-
-    before do
-      my_service_provider.given("something exists").
-        upon_receiving("a request for something").with(method: :get, path: '/something', query: '').
-        will_respond_with(
-          status: 200,
-          headers: {'Content-Type' => 'application/json'},
-          body: {name: 'A small something'} )
-    end
-
-    it "returns a Something" do
-      expect(subject.get_something).to eq(Something.new('A small something'))
-    end
-
-  end
-
-end
-```
-
-#### 5. Run the specs
-
-Running the consumer spec will generate a pact file in the configured pact dir (spec/pacts by default).
-Logs will be output to the configured log dir that can be useful when diagnosing problems.
-
-Of course, the above specs will fail because the client method is not implemented, so next, implement your client methods.
-
-#### 6. Implement the client methods
+### With Ruby on Mac OSX and Linux
 
-```ruby
-class MyServiceProviderClient
-  include HTTParty
-  base_uri 'http://my-service'
+    $ gem install pact-mock_service
+    $ pact-mock-service --port 1234
 
-  def get_something
-    name = JSON.parse(self.class.get("/something").body)['name']
-    Something.new(name)
-  end
-end
-```
+Run `pact-mock-service help` for command line options.
 
-#### 7. Run the specs again.
+### With Ruby on Windows
 
-Green! You now have a pact file that can be used to verify your expectations of the provider project.
+Check out the wiki page [here][install-windows].
 
-Now, rinse and repeat for other likely status codes that may be returned. For example, consider how you want your client to respond to a: 
-* 404 (return null, or raise an error?)
-* 500 (specifying that the response body should contain an error message, and ensuring that your client logs that error message will make your life much easier when things go wrong)
-* 401/403 if there is authorisation.
+#### With SSL
 
-### Service Provider project
+If you need to use the mock service with HTTPS, you can use the built-in SSL mode which relies on a self-signed certificate.
 
-#### 1. Create the skeleton API classes
+    $ pact-mock-service --port 1234 --ssl
 
-Create your API class using the framework of your choice (the Pact authors have a preference for [Webmachine][webmachine] and [Roar][roar]) - leave the methods unimplemented, we're doing Test First Develoment, remember?
+### Mac OSX and Linux, without Ruby
 
-#### 2. Tell your provider that it needs to honour the pact file you made earlier
+See the [releases][releases] page for the latest standalone executables.
 
-Require "pact/tasks" in your Rakefile.
+### Windows, without Ruby
 
-```ruby
-# In Rakefile
-require 'pact/tasks'
-```
-
-Create a `pact_helper.rb` in your service provider project. The recommended place is `spec/service_consumers/pact_helper.rb`.
-
-See [Verifying Pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts) and the [Provider](documentation/configuration.md#provider) section of the Configuration documentation for more information.
-
-```ruby
-# In specs/service_consumers/pact_helper.rb
-
-require 'pact/provider/rspec'
-
-Pact.service_provider "My Service Provider" do
-
-  honours_pact_with 'My Service Consumer' do
-
-    # This example points to a local file, however, on a real project with a continuous
-    # integration box, you would use a [Pact Broker](https://github.com/bethesque/pact_broker) or publish your pacts as artifacts,
-    # and point the pact_uri to the pact published by the last successful build.
-
-    pact_uri '../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json'
-  end
-end
-```
-
-#### 3. Run your failing specs
-
-    $ rake pact:verify
-
-Congratulations! You now have a failing spec to develop against.
-
-At this stage, you'll want to be able to run your specs one at a time while you implement each feature. At the bottom of the failed pact:verify output you will see the commands to rerun each failed interaction individually. A command to run just one interaction will look like this:
-
-    $ rake pact:verify PACT_DESCRIPTION="a request for something" PACT_PROVIDER_STATE="something exists"
-
-#### 4. Implement enough to make your first interaction spec pass
-
-Rinse and repeat.
-
-#### 5. Keep going til you're green
-
-Yay! Your provider now honours the pact it has with your consumer. You can now have confidence that your consumer and provider will play nicely together.
-
-### Using provider states
-
-Each interaction in a pact is verified in isolation, with no context maintained from the previous interactions. So how do you test a request that requires data to already exist on the provider? Read about provider states [here](https://github.com/realestate-com-au/pact/wiki/Provider-states).
-
-
-## Configuration
-
-See the [Configuration](/documentation/configuration.md) section of the documentation for options relating to thing like logging, diff formatting, and documentation generation.
-
-## Pact best practices
-
-As in all things, there are good ways to implement Pacts, and there are not so good ways. Check out the [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices) section of the documentation to make sure you're not Pacting it Wrong.
-
-## Docs
-
-* [Example](example)
-* [Configuration](documentation/configuration.md)
-* [Terminology](https://github.com/realestate-com-au/pact/wiki/Terminology)
-* [Provider States](https://github.com/realestate-com-au/pact/wiki/Provider-states)
-* [Verifying pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts)
-* [Sharing pacts between consumer and provider](https://github.com/realestate-com-au/pact/wiki/Sharing-pacts-between-consumer-and-provider)
-* [Using regular expressions with Pact](https://github.com/realestate-com-au/pact/wiki/Using-regular-expressions-with-Pact)
-* [Frequently asked questions](https://github.com/realestate-com-au/pact/wiki/FAQ)
-* [Rarely asked questions](https://github.com/realestate-com-au/pact/wiki/RAQ)
-* [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices)
-* [Troubleshooting](https://github.com/realestate-com-au/pact/wiki/Troubleshooting)
-* [Testing with pact diagram](https://github.com/realestate-com-au/pact/wiki/Testing with pact.png)
-
-## Related libraries
-
-[Pact Provider Proxy](https://github.com/bethesque/pact-provider-proxy) - Verify a pact against a running server, allowing you to use pacts with a provider of any language.
-
-[Pact Broker](https://github.com/bethesque/pact_broker) - A pact repository. Provides endpoints to access published pacts, meaning you don't need to use messy CI URLs in your codebase. Enables cross testing of prod/head versions of your consumer and provider, allowing you to determine whether the head version of one is compatible with the production version of the other. Helps you to answer that ever so important question, "can I deploy without breaking all the things?"
-
-[Pact Broker Client](https://github.com/bethesque/pact_broker-client) - Contains rake tasks for publishing pacts to the pact_broker.
-
-[Pact JVM](https://github.com/DiUS/pact-jvm) - A Pact implementation for the JVM (Java and Scala). It generates pact files that are compatible with the Ruby implementation.
-
-[Pact .NET](https://github.com/SEEK-Jobs/pact-net) - A Pact implementation for .NET.
-
-[Shokkenki](https://github.com/brentsnook/shokkenki) - Another Consumer Driven Contract gem written by one of Pact's original authors, Brent Snook. Shokkenki allows matchers to be composed using jsonpath expressions and allows auto-generation of mock response values based on regular expressions.
-
-## Links
-
-[Simplifying microservices testing with pacts](http://dius.com.au/2014/05/19/simplifying-micro-service-testing-with-pacts/) - Ron Holshausen (one of the original pact authors)
-
-[Pact specification](https://github.com/bethesque/pact-specification)
-
-[Integrated tests are a scam](http://vimeo.com/80533536) - J.B. Rainsberger
-
-[Consumer Driven Contracts](http://martinfowler.com/articles/consumerDrivenContracts.html) - Ian Robinson
-
-[Integration Contract Tests](http://martinfowler.com/bliki/IntegrationContractTest.html) - Martin Fowler
-
-## TODO
-
-Short term:
-- Support hash of query params
-
-Long term:
-- Provide more flexible matching (eg the keys should match, and the classes of the values should match, but the values of each key do not need to be equal). This is to make the pact verification less brittle.
-- Add XML support
-- Decouple Rspec from Pact and make rspec-pact gem for easy integration
+I had a package somewhere lying around, but I lost it, and I don't have a Windows machine. If you are interested in using the mock server on Windows, please check out the instructions for building one [here][windows], and then let me know so I can upload it to the releases page. Thanks!
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-If you would like to implement pact in another language, please check out the [Pact specification](https://github.com/bethesque/pact-specification) and have a chat to one of us on the [pact-dev Google group](https://groups.google.com/forum/#!forum/pact-dev). The vision is to have a compatible pact implementation in all the commonly used languages, your help would be greatly appreciated!
-
-[webmachine]: https://github.com/seancribbs/webmachine-ruby
-[roar]: https://github.com/apotonick/roar
+See [CONTRIBUTING.md](/CONTRIBUTING.md)
 
+[pact]: https://github.com/realestate-com-au/pact
+[releases]: https://github.com/bethesque/pact-mock_service/releases
+[javascript]: https://github.com/DiUS/pact-consumer-js-dsl
+[pact-dev]: https://groups.google.com/forum/#!forum/pact-dev
+[windows]: https://github.com/bethesque/pact-mock_service/wiki/Building-a-Windows-standalone-executable
+[install-windows]: https://github.com/bethesque/pact-mock_service/wiki/Installing-the-pact-mock_service-gem-on-Windows

data/lib/pact/consumer/mock_service/app.rb

@@ -2,7 +2,6 @@ require 'rack'
 require 'uri'
 require 'json'
 require 'logger'
-require 'awesome_print'
 require 'pact/consumer/request'
 require 'pact/consumer/mock_service/expected_interactions'
 require 'pact/consumer/mock_service/actual_interactions'
@@ -14,14 +13,9 @@ require 'pact/consumer/mock_service/missing_interactions_get'
 require 'pact/consumer/mock_service/verification_get'
 require 'pact/consumer/mock_service/log_get'
 require 'pact/consumer/mock_service/pact_post'
+require 'pact/consumer/mock_service/options'
 require 'pact/support'
 
-AwesomePrint.defaults = {
-  indent: -2,
-  plain: true,
-  index: false
-}
-
 module Pact
   module Consumer
 
@@ -35,18 +29,50 @@ module Pact
         expected_interactions = ExpectedInteractions.new
         actual_interactions = ActualInteractions.new
         verified_interactions = VerifiedInteractions.new
+        @consumer_contact_details = {
+          pact_dir: options[:pact_dir],
+          consumer: {name: options[:consumer]},
+          provider: {name: options[:provider]},
+          interactions: verified_interactions
+        }
 
         @handlers = [
+          Options.new(@name, @logger, options[:cors_enabled]),
           MissingInteractionsGet.new(@name, @logger, expected_interactions, actual_interactions),
           VerificationGet.new(@name, @logger, expected_interactions, actual_interactions, log_description),
           InteractionPost.new(@name, @logger, expected_interactions, verified_interactions),
           InteractionDelete.new(@name, @logger, expected_interactions, actual_interactions),
           LogGet.new(@name, @logger),
-          PactPost.new(@name, @logger, verified_interactions, pact_dir),
-          InteractionReplay.new(@name, @logger, expected_interactions, actual_interactions, verified_interactions)
+          PactPost.new(@name, @logger, verified_interactions, pact_dir, options[:consumer_contract_details]),
+          InteractionReplay.new(@name, @logger, expected_interactions, actual_interactions, verified_interactions, options[:cors_enabled])
         ]
       end
 
+      def call env
+        response = []
+        begin
+          relevant_handler = @handlers.detect { |handler| handler.match? env }
+          res = relevant_handler.respond(env)
+          response = relevant_handler.enable_cors? ? add_cors_header(res) : res
+        rescue StandardError => e
+          @logger.error "Error ocurred in mock service: #{e.class} - #{e.message}"
+          @logger.error e.backtrace.join("\n")
+          response = [500, {'Content-Type' => 'application/json'}, [{message: e.message, backtrace: e.backtrace}.to_json]]
+        rescue Exception => e
+          @logger.error "Exception ocurred in mock service: #{e.class} - #{e.message}"
+          @logger.error e.backtrace.join("\n")
+          raise e
+        end
+        response
+      end
+
+      def write_pact_if_configured
+        consumer_contract_writer = ConsumerContractWriter.new(@consumer_contact_details, StdoutLogger.new)
+        consumer_contract_writer.write if consumer_contract_writer.can_write?
+      end
+
+      private
+
       def configure_logger options
         options = {log_file: $stdout}.merge options
         log_stream = options[:log_file]
@@ -65,21 +91,14 @@ module Pact
         "#{@name} #{super.to_s}"
       end
 
-      def call env
-        response = []
-        begin
-          relevant_handler = @handlers.detect { |handler| handler.match? env }
-          response = relevant_handler.respond(env)
-        rescue StandardError => e
-          @logger.error "Error ocurred in mock service: #{e.class} - #{e.message}"
-          @logger.error e.backtrace.join("\n")
-          response = [500, {'Content-Type' => 'application/json'}, [{message: e.message, backtrace: e.backtrace}.to_json]]
-        rescue Exception => e
-          @logger.error "Exception ocurred in mock service: #{e.class} - #{e.message}"
-          @logger.error e.backtrace.join("\n")
-          raise e
+      class StdoutLogger
+        def info message
+          $stdout.puts "\n#{message}"
         end
-        response
+      end
+
+      def add_cors_header response
+        [response[0], response[1].merge('Access-Control-Allow-Origin' => '*'), response[2]]
       end
 
     end

data/lib/pact/consumer/mock_service/candidate_interactions.rb

@@ -10,4 +10,4 @@ module Pact
 
     end
   end
-end
+end

data/lib/pact/consumer/mock_service/interaction_delete.rb

@@ -1,10 +1,10 @@
 require 'pact/consumer/mock_service/rack_request_helper'
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+require 'pact/consumer/mock_service/web_request_administration'
 
 module Pact
   module Consumer
 
-    class InteractionDelete < MockServiceAdministrationEndpoint
+    class InteractionDelete < WebRequestAdministration
 
       include RackRequestHelper
 
@@ -36,4 +36,4 @@ module Pact
       end
     end
   end
-end
+end

data/lib/pact/consumer/mock_service/interaction_post.rb

@@ -1,10 +1,10 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+require 'pact/consumer/mock_service/web_request_administration'
 require 'pact/mock_service/interaction_decorator'
 require 'pact/shared/json_differ'
 
 module Pact
   module Consumer
-    class InteractionPost < MockServiceAdministrationEndpoint
+    class InteractionPost < WebRequestAdministration
 
       def initialize name, logger, expected_interactions, verified_interactions
         super name, logger

data/lib/pact/consumer/mock_service/interaction_replay.rb

@@ -23,12 +23,13 @@ module Pact
 
       attr_accessor :name, :logger, :expected_interactions, :actual_interactions, :verified_interactions
 
-      def initialize name, logger, expected_interactions, actual_interactions, verified_interactions
+      def initialize name, logger, expected_interactions, actual_interactions, verified_interactions, cors_enabled=false
         @name = name
         @logger = logger
         @expected_interactions = expected_interactions
         @actual_interactions = actual_interactions
         @verified_interactions = verified_interactions
+        @cors_enabled = cors_enabled
       end
 
       def match? env
@@ -39,6 +40,10 @@ module Pact
         find_response request_as_hash_from(env)
       end
 
+      def enable_cors?
+        @cors_enabled
+      end
+
       private
 
       def find_response request_hash

data/lib/pact/consumer/mock_service/log_get.rb

@@ -1,8 +1,8 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+require 'pact/consumer/mock_service/web_request_administration'
 
 module Pact
   module Consumer
-    class LogGet < MockServiceAdministrationEndpoint
+    class LogGet < WebRequestAdministration
 
       include RackRequestHelper
 

data/lib/pact/consumer/mock_service/missing_interactions_get.rb

@@ -1,10 +1,10 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+require 'pact/consumer/mock_service/web_request_administration'
 require 'pact/consumer/mock_service/verification'
 
 module Pact
   module Consumer
 
-    class MissingInteractionsGet < MockServiceAdministrationEndpoint
+    class MissingInteractionsGet < WebRequestAdministration
       include RackRequestHelper
 
       def initialize name, logger, expected_interactions, actual_interactions

data/lib/pact/consumer/mock_service/mock_service_administration_endpoint.rb

@@ -3,6 +3,8 @@ module Pact
   module Consumer
     class MockServiceAdministrationEndpoint
 
+      include RackRequestHelper
+
       attr_accessor :logger, :name
 
       def initialize name, logger
@@ -10,12 +12,8 @@ module Pact
         @logger = logger
       end
 
-      include RackRequestHelper
-
       def match? env
-        headers_from(env)['X-Pact-Mock-Service'] &&
-        env['PATH_INFO'] == request_path &&
-          env['REQUEST_METHOD'] == request_method
+        (request_header_match? env) && (request_path_match? env) && (request_method_match? env)
       end
 
       def request_path
@@ -26,6 +24,19 @@ module Pact
         raise NotImplementedError
       end
 
+      private
+
+      def request_header_match? env
+        raise NotImplementedError
+      end
+
+      def request_path_match? env
+        env['PATH_INFO'] == request_path
+      end
+
+      def request_method_match? env
+        env['REQUEST_METHOD'] == request_method
+      end
     end
   end
-end
+end

data/lib/pact/consumer/mock_service/options.rb

@@ -0,0 +1,50 @@
+require 'pact/consumer/mock_service/rack_request_helper'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+
+module Pact
+  module Consumer
+
+    class Options
+
+      include RackRequestHelper
+
+      attr_reader :name, :logger, :cors_enabled
+
+      def initialize name, logger, cors_enabled
+        @name = name
+        @logger = logger
+        @cors_enabled = cors_enabled
+      end
+
+      def match? env
+         is_options_request?(env) && (cors_enabled || is_administration_request?(env))
+      end
+
+      def respond env
+        logger.info "Received OPTIONS request for #{env['HTTP_ACCESS_CONTROL_REQUEST_METHOD']} #{env['PATH_INFO']}. Returning CORS headers."
+        [200,
+         {
+           'Access-Control-Allow-Origin' => '*',
+           'Access-Control-Allow-Headers' => headers_from(env)["Access-Control-Request-Headers"],
+           'Access-Control-Allow-Methods' => 'DELETE, POST, GET, HEAD, PUT, TRACE, CONNECT'
+          },
+         []
+        ]
+      end
+
+      # Access-Control-Domain does not work on OPTIONs requests.
+      def enable_cors?
+        false
+      end
+
+      def is_options_request? env
+        env['REQUEST_METHOD'] == 'OPTIONS'
+      end
+
+      def is_administration_request? env
+        env["HTTP_ACCESS_CONTROL_REQUEST_HEADERS"].match(/x-pact-mock-service/i)
+      end
+
+    end
+  end
+end

data/lib/pact/consumer/mock_service/pact_post.rb

@@ -1,16 +1,19 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 require 'pact/consumer_contract/consumer_contract_writer'
+require 'pact/consumer/mock_service/web_request_administration'
 
 module Pact
   module Consumer
-    class PactPost < MockServiceAdministrationEndpoint
+    class PactPost < WebRequestAdministration
 
       attr_accessor :consumer_contract, :verified_interactions, :default_options
 
-      def initialize name, logger, verified_interactions, pact_dir
+      def initialize name, logger, verified_interactions, pact_dir, consumer_contract_details
         super name, logger
         @verified_interactions = verified_interactions
         @default_options = {pact_dir: pact_dir}
+        if consumer_contract_details
+          @default_options.merge!(consumer_contract_details)
+        end
       end
 
       def request_path

data/lib/pact/consumer/mock_service/rack_request_helper.rb

@@ -1,3 +1,4 @@
+require 'cgi/core'
 module Pact
   module Consumer
 

data/lib/pact/consumer/mock_service/verification_get.rb

@@ -1,8 +1,8 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+require 'pact/consumer/mock_service/web_request_administration'
 
 module Pact
   module Consumer
-    class VerificationGet < MockServiceAdministrationEndpoint
+    class VerificationGet < WebRequestAdministration
 
       include RackRequestHelper
 

data/lib/pact/consumer/mock_service/web_request_administration.rb

@@ -0,0 +1,31 @@
+require 'pact/consumer/mock_service/rack_request_helper'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
+
+module Pact
+  module Consumer
+
+    # Administration web requests (GET, DELETE, POST, PUT, etc.)
+    class WebRequestAdministration < MockServiceAdministrationEndpoint
+
+      def request_path
+        raise NotImplementedError
+      end
+
+      def request_method
+        raise NotImplementedError
+      end
+
+      def enable_cors?
+        true
+      end
+
+      private
+
+      def request_header_match? env
+        headers_from(env)['X-Pact-Mock-Service']
+      end
+
+    end
+
+  end
+end

data/lib/pact/consumer_contract/consumer_contract_writer.rb

@@ -35,17 +35,17 @@ module Pact
       pact_json
     end
 
+    def can_write?
+      consumer_name && provider_name && consumer_contract_details[:pact_dir]
+    end
+
     private
 
     attr_reader :consumer_contract_details, :pactfile_write_mode, :interactions, :logger
 
-    def pactfile_path
-      raise 'You must specify a consumer and provider name' unless (consumer_name && provider_name)
-      file_path consumer_name, provider_name, pact_dir
-    end
-
     def update_pactfile
-      logger.debug "Updating pact file for #{provider_name} at #{pactfile_path}"
+      logger.info log_message
+
       FileUtils.mkdir_p File.dirname(pactfile_path)
       File.open(pactfile_path, 'w') do |f|
         f.write pact_json
@@ -61,7 +61,7 @@ module Pact
     end
 
     def interactions_for_new_consumer_contract
-      if pactfile_write_mode == :update
+      if updating?
         merged_interactions = existing_interactions.dup
         filter = Consumer::UpdatableInteractionsFilter.new(merged_interactions)
         interactions.each {|i| filter << i }
@@ -117,12 +117,28 @@ module Pact
       consumer_contract_details[:provider][:name]
     end
 
+    def pactfile_path
+      raise 'You must specify a consumer and provider name' unless (consumer_name && provider_name)
+      file_path consumer_name, provider_name, pact_dir
+    end
+
     def pact_dir
       unless consumer_contract_details[:pact_dir]
         raise ConsumerContractWriterError.new("Please indicate the directory to write the pact to by specifying the pact_dir field")
       end
       consumer_contract_details[:pact_dir]
     end
-  end
 
-end
+    def updating?
+      pactfile_write_mode == :update
+    end
+
+    def log_message
+      if updating?
+        "Updating pact for #{provider_name} at #{pactfile_path}"
+      else
+        "Writing pact for #{provider_name} to #{pactfile_path}"
+      end
+    end
+  end
+end

data/lib/pact/mock_service/cli.rb

@@ -9,11 +9,14 @@ module Pact
   module MockService
     class CLI < Thor
 
-      desc 'execute', "Start a mock service"
+      desc 'execute', "Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown."
       method_option :port, aliases: "-p", desc: "Port on which to run the service"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS"
       method_option :log, aliases: "-l", desc: "File to which to log output"
+      method_option :cors_enabled, aliases: "-o", desc: "If true, mocks requests will have access control origin headers set to '*'"
       method_option :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
+      method_option :consumer, desc: "Consumer name"
+      method_option :provider, desc: "Provider name"
 
       def execute
         RunStandaloneMockService.call(options)
@@ -26,31 +29,73 @@ module Pact
     class RunStandaloneMockService
 
       def self.call options
+        new(options).call
+      end
+
+      def initialize options
+        @options = options
+      end
+
+      def call
         require 'pact/consumer/mock_service/app'
-        service_options = {pact_dir: options[:pact_dir]}
-        if options[:log]
-          FileUtils.mkdir_p File.dirname(options[:log])
-          log = File.open(options[:log], 'w')
-          log.sync = true
-          service_options[:log_file] = log
+
+        trap(:INT) { call_shutdown_hooks  }
+        trap(:TERM) { call_shutdown_hooks }
+
+        Rack::Handler::WEBrick.run(mock_service, webbrick_opts)
+      end
+
+      private
+
+      attr_reader :options
+
+      def mock_service
+        @mock_service ||= Pact::Consumer::MockService.new(service_options)
+      end
+
+      def call_shutdown_hooks
+        begin
+          mock_service.write_pact_if_configured
+        rescue StandardError => e
+          $stderr.puts "Error writing pact on shutdown. #{e.class} - #{e.message}"
+          $stderr.puts e.backtrace.join("\n")
         end
+        Rack::Handler::WEBrick.shutdown
+      end
+
+      def service_options
+        service_options = {
+          pact_dir: options[:pact_dir],
+          consumer: options[:consumer],
+          provider: options[:provider],
+          cors_enabled: options[:cors_enabled]
+        }
+        service_options[:log_file] = open_log_file if options[:log]
+        service_options
+      end
 
-        mock_service = Pact::Consumer::MockService.new(service_options)
-        trap(:INT) { Rack::Handler::WEBrick.shutdown }
-        trap(:TERM) { Rack::Handler::WEBrick.shutdown }
+      def open_log_file
+        FileUtils.mkdir_p File.dirname(options[:log])
+        log = File.open(options[:log], 'w')
+        log.sync = true
+        log
+      end
 
-        webbrick_opts = {
+      def webbrick_opts
+        opts = {
           :Port => options[:port] || FindAPort.available_port,
           :AccessLog => []
         }
+        opts.merge!(ssl_opts) if options[:ssl]
+        opts
+      end
 
-        webbrick_opts.merge!({
+      def ssl_opts
+        {
           :SSLEnable => true,
-          :SSLCertName => [ %w[CN localhost] ] }) if options[:ssl]
-
-        Rack::Handler::WEBrick.run(mock_service, webbrick_opts)
+          :SSLCertName => [ %w[CN localhost] ]
+        }
       end
     end
-
   end
 end

data/lib/pact/mock_service/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module MockService
-    VERSION = "0.2.3-rc1"
+    VERSION = "0.2.3.pre.rc2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-mock_service
 version: !ruby/object:Gem::Version
-  version: 0.2.3.pre.rc1
+  version: 0.2.3.pre.rc2
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -269,11 +269,13 @@ files:
 - lib/pact/consumer/mock_service/log_get.rb
 - lib/pact/consumer/mock_service/missing_interactions_get.rb
 - lib/pact/consumer/mock_service/mock_service_administration_endpoint.rb
+- lib/pact/consumer/mock_service/options.rb
 - lib/pact/consumer/mock_service/pact_post.rb
 - lib/pact/consumer/mock_service/rack_request_helper.rb
 - lib/pact/consumer/mock_service/verification.rb
 - lib/pact/consumer/mock_service/verification_get.rb
 - lib/pact/consumer/mock_service/verified_interactions.rb
+- lib/pact/consumer/mock_service/web_request_administration.rb
 - lib/pact/consumer/mock_service_client.rb
 - lib/pact/consumer/server.rb
 - lib/pact/consumer_contract/consumer_contract_decorator.rb