pacto 0.3.1 → 0.4.0.rc1

data/docs/server.md

@@ -0,0 +1,34 @@
+
+```rb
+require 'pacto/rspec'
+require 'pacto/test_helper'
+
+describe 'ping service' do
+  include Pacto::TestHelper
+
+  it 'pongs' do
+    with_pacto(
+      port: 6000,
+      backend_host: 'http://localhost:5000',
+      live: true,
+      stub: false,
+      generate: false,
+      directory: 'contracts'
+      ) do |pacto_endpoint|
+```
+
+call your code
+
+```rb
+      system "curl #{pacto_endpoint}/api/ping"
+    end
+```
+
+check citations
+
+```rb
+    expect(Pacto).to have_validated(:get, 'http://localhost:5000/api/ping')
+  end
+end
+```
+

data/docs/server_cli.md

@@ -0,0 +1,18 @@
+# Standalone server
+You can run Pacto as a server in order to test non-Ruby projects. In order to get the full set
+of options, run:
+
+```sh
+bundle exec pacto-server -h
+```
+
+You probably want to run with the -sv option, which will display verbose output to stdout. You can
+run server that proxies to a live endpoint:
+
+```sh
+bundle exec pacto-server -sv --port 9000 --live http://example.com &
+bundle exec pacto-server -sv --port 9001 --stub &
+
+pkill -f pacto-server
+```
+

data/docs/stenographer.md

@@ -0,0 +1,20 @@
+
+```rb
+require 'pacto'
+Pacto.configure do |c|
+  c.contracts_path = 'contracts'
+end
+contracts = Pacto.load_contracts('contracts', 'http://localhost:5000')
+contracts.stub_providers
+
+Pacto.simulate_consumer do
+  request 'Echo', values: nil, response: { status: 200 } # 0 contract violations
+  request 'Ping', values: nil, response: { status: 200 } # 0 contract violations
+  request 'Unknown (http://localhost:8000/404)', values: nil, response: { status: 500 } # 0 contract violations
+end
+
+Pacto.simulate_consumer :my_consumer do
+  playback 'pacto_stenographer.log'
+end
+```
+

data/features/configuration/strict_matchers.feature

@@ -17,7 +17,7 @@ Feature: Strict Matching
       """json
       {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello/:id",
           "headers": {
             "Accept": "application/json"
@@ -28,7 +28,7 @@ Feature: Strict Matching
         "response": {
           "status": 200,
           "headers": { "Content-Type": "application/json" },
-          "body": {
+          "schema": {
             "type": "object",
             "required": true,
             "properties": {
@@ -50,7 +50,7 @@ Feature: Strict Matching
       Pacto.configure do |config|
         config.strict_matchers = strict
       end
-      Pacto.load_contracts('contracts', 'http://dummyprovider.com').stub_all
+      Pacto.load_contracts('contracts', 'http://dummyprovider.com').stub_providers
 
       def response url, headers
         begin
@@ -67,7 +67,7 @@ Feature: Strict Matching
       puts response 'http://dummyprovider.com/hello/:id', headers: {'Accept' => 'application/json' }
 
       print 'Wrong headers: '
-      puts response 'http://dummyprovider.com/hello/:id', headers: {'Content-Type' => 'application/json' }
+      puts response 'http://dummyprovider.com/hello/123', headers: {'Content-Type' => 'application/json' }
 
       print 'ID placeholder: '
       puts response 'http://dummyprovider.com/hello/123', headers: {'Accept' => 'application/json' }
@@ -75,23 +75,23 @@ Feature: Strict Matching
 
   Scenario: Default (strict) behavior
     When I run `bundle exec ruby requests.rb true`
-    Then the output should contain:
+    Then the stdout should contain:
       """
       Pacto.configuration.strict_matchers = true
 
-      Exact: {"message":"Hello, world!"}
+      Exact: WebMock::NetConnectNotAllowedError
       Wrong headers: WebMock::NetConnectNotAllowedError
-      ID placeholder: WebMock::NetConnectNotAllowedError
+      ID placeholder: {"message":"Hello, world!"}
 
       """
 
   Scenario: Non-strict matching
     When I run `bundle exec ruby requests.rb false`
-    Then the output should contain:
+    Then the stdout should contain:
       """
       Pacto.configuration.strict_matchers = false
 
-      Exact: {"message":"Hello, world!"}
+      Exact: WebMock::NetConnectNotAllowedError
       Wrong headers: {"message":"Hello, world!"}
       ID placeholder: {"message":"Hello, world!"}
-      """    
+      """

data/features/evolve/existing_services.feature

@@ -23,14 +23,16 @@ Feature: Existing services journey
   @no-clobber
   Scenario: Ensuring all contracts are valid
     When I successfully run `bundle exec rake pacto:meta_validate['contracts']`
-    Then the output should contain exactly:
+    Then the stdout should contain exactly:
     """
-    Validating contracts/www.example.com/service1.json
-    Validating contracts/www.example.com/service2.json
+       validated  contracts/www.example.com/service1.json
+       validated  contracts/www.example.com/service2.json
     All contracts successfully meta-validated
 
     """
 
+  # TODO: find where Webmock is being called with and an empty :with
+  # and update it, to not use with so we can upgrade Webmock past 1.20.2
   @no-clobber
   Scenario: Stubbing with the contracts
     Given a file named "test.rb" with:
@@ -42,16 +44,16 @@ Feature: Existing services journey
     end
 
     contracts = Pacto.load_contracts('contracts/www.example.com/', 'http://www.example.com')
-    contracts.stub_all
+    contracts.stub_providers
 
     puts Faraday.get('http://www.example.com/service1').body
     puts Faraday.get('http://www.example.com/service2').body
     """
     When I successfully run `bundle exec ruby test.rb`
-    Then the output should contain exactly:
+    Then the stdout should contain exactly:
     """
-    {"thoughtworks":"bar"}
-    {"service2":["bar"]}
+    {"thoughtworks":"pacto"}
+    {"service2":["thoughtworks","pacto"]}
 
     """
 
@@ -70,13 +72,13 @@ Feature: Existing services journey
       c.contracts_path = 'contracts'
     end
 
-    Pacto.load_contracts('contracts', 'http://www.example.com').stub_all
+    Pacto.load_contracts('contracts', 'http://www.example.com').stub_providers
     Pacto.validate!
 
     Faraday.get 'http://www.example.com/service1'
     Faraday.get 'http://www.example.com/service2'
     """
-    Then the output should contain exactly:
+    Then the stdout should contain exactly:
     """
-    
+
     """

data/features/generate/generation.feature

@@ -12,7 +12,7 @@ Feature: Contract Generation
     """
         {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello",
           "headers": {
             "Accept": "application/json"
@@ -20,7 +20,7 @@ Feature: Contract Generation
         },
         "response": {
           "status": 200,
-          "body": {
+          "schema": {
             "required": true
           }
         }
@@ -30,29 +30,29 @@ Feature: Contract Generation
   Scenario: Generating a contract using the rake task
     Given a directory named "contracts"
     When I successfully run `bundle exec rake pacto:generate['tmp/aruba/requests','tmp/aruba/contracts','http://localhost:8000']`
-    Then the output should contain "Successfully generated all contracts"
+    Then the stdout should contain "Successfully generated all contracts"
 
   Scenario: Generating a contract programmatically
     Given a file named "generate.rb" with:
     """ruby
     require 'pacto'
+    Pacto.configuration.generator_options[:no_examples] = true
 
     WebMock.allow_net_connect!
-    generator = Pacto::Generator.new
-    contract = generator.generate('requests/my_contract.json', 'http://localhost:8000')
+    generator = Pacto::Generator.contract_generator
+    contract = generator.generate_from_partial_contract('requests/my_contract.json', 'http://localhost:8000')
     puts contract
     """
     When I successfully run `bundle exec ruby generate.rb`
-    Then the output should contain exactly:
+    Then the stdout should match this contract:
     """json
     {
+      "name": "/hello",
       "request": {
         "headers": {
           "Accept": "application/json"
         },
-        "method": "get",
-        "params": {
-        },
+        "http_method": "get",
         "path": "/hello"
       },
       "response": {
@@ -61,7 +61,7 @@ Feature: Contract Generation
           "Vary": "Accept"
         },
         "status": 200,
-        "body": {
+        "schema": {
           "$schema": "http://json-schema.org/draft-03/schema#",
           "description": "Generated from requests/my_contract.json with shasum 210fa3b144ef2db8d1c160c4d9e8d8bf738ed851",
           "type": "object",
@@ -76,4 +76,4 @@ Feature: Contract Generation
       }
     }
 
-    """
+    """

data/features/steps/pacto_steps.rb

@@ -1,23 +1,24 @@
+# -*- encoding : utf-8 -*-
 Given(/^Pacto is configured with:$/) do |string|
-  steps %Q{
+  steps %(
     Given a file named "pacto_config.rb" with:
     """ruby
     #{string}
     """
-  }
+  )
 end
 
 Given(/^I have a Rakefile$/) do
-  steps %Q{
+  steps %(
     Given a file named "Rakefile" with:
     """ruby
     require 'pacto/rake_task'
     """
-  }
+  )
 end
 
 When(/^I request "(.*?)"$/) do |url|
-  steps %Q{
+  steps %{
     Given a file named "request.rb" with:
     """ruby
     require 'pacto'
@@ -34,10 +35,10 @@ When(/^I request "(.*?)"$/) do |url|
 end
 
 Given(/^an existing set of services$/) do
-  WebMock.stub_request(:get, 'www.example.com/service1').to_return(:body => {'thoughtworks' => 'pacto' }.to_json)
-  WebMock.stub_request(:post, 'www.example.com/service1').with(:body => 'thoughtworks').to_return(:body => 'pacto')
-  WebMock.stub_request(:get, 'www.example.com/service2').to_return(:body => {'service2' => %w{'thoughtworks', 'pacto'} }.to_json)
-  WebMock.stub_request(:post, 'www.example.com/service2').with(:body => 'thoughtworks').to_return(:body => 'pacto')
+  WebMock.stub_request(:get, 'www.example.com/service1').to_return(body: { 'thoughtworks' => 'pacto' }.to_json)
+  WebMock.stub_request(:post, 'www.example.com/service1').with(body: 'thoughtworks').to_return(body: 'pacto')
+  WebMock.stub_request(:get, 'www.example.com/service2').to_return(body: { 'service2' => %w(thoughtworks pacto) }.to_json)
+  WebMock.stub_request(:post, 'www.example.com/service2').with(body: 'thoughtworks').to_return(body: 'pacto')
 end
 
 When(/^I execute:$/) do |script|
@@ -54,11 +55,10 @@ When(/^I execute:$/) do |script|
       end
 eof
       eval(script) # rubocop:disable Eval
-                   # It's just for testing...
+    # It's just for testing...
 
     rescue SyntaxError => e
-      puts e
-      puts e.backtrace
+      raise e
     end
   end
 end
@@ -73,3 +73,8 @@ When(/^I make replacements in "([^"]*)":$/) do |file_name, replacements|
     File.open(file_name, 'w') { |file| file.write content }
   end
 end
+
+Then(/^the stdout should match this contract:$/) do |expected_contract|
+  actual_contract = all_stdout
+  expect(actual_contract).to be_json_eql(expected_contract).excluding('description')
+end

data/features/stub/templates.feature

@@ -8,13 +8,13 @@ Feature: Templating
       Pacto.configure do |c|
         c.register_hook Pacto::Hooks::ERBHook.new
       end
-      Pacto.load_contracts('contracts', 'http://example.com').stub_all
+      Pacto.load_contracts('contracts', 'http://example.com').stub_providers
       """
     Given a file named "contracts/template.json" with:
       """json
       {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello",
           "headers": {
             "Accept": "application/json"
@@ -25,7 +25,7 @@ Feature: Templating
         "response": {
           "status": 200,
           "headers": { "Content-Type": "application/json" },
-          "body": {
+          "schema": {
             "type": "object",
             "required": true,
             "properties": {
@@ -40,7 +40,7 @@ Feature: Templating
 
   Scenario: ERB Template
     When I request "http://example.com/hello"
-    Then the output should contain:
+    Then the stdout should contain:
       """
       {"message":"!dlrow ,olleH"}
       """

data/features/support/env.rb

@@ -1,22 +1,34 @@
+# -*- encoding : utf-8 -*-
 require_relative '../../spec/coveralls_helper'
-require 'rake'
-require 'webmock'
 require 'aruba'
 require 'aruba/cucumber'
+require 'json_spec/cucumber'
 require 'aruba/jruby' if RUBY_PLATFORM == 'java'
-require_relative '../../spec/pacto/server'
+require 'pacto/test_helper'
+require_relative '../../spec/pacto/dummy_server'
+
+Pacto.configuration.hide_deprecations = true
 
 Before do
   # Given I successfully run `bundle install` can take a while.
   @aruba_timeout_seconds = RUBY_PLATFORM == 'java' ? 60 : 10
 end
 
-# Was only going to use for @needs_server, but its easier to leave it running
-@server = Pacto::Server::Dummy.new 8000, '/hello', '{"message": "Hello World!"}'
-@server.start
+class PactoWorld
+  include Pacto::TestHelper
+  include Pacto::DummyServer::JRubyWorkaroundHelper
+end
+
+World do
+  PactoWorld.new
+end
 
-Around do | scenario, block |
-  Bundler.with_clean_env do
-    block.call
+Around do | _scenario, block |
+  # This is a cucumber bug (see cucumber #640)
+  world = self || PactoWorld.new
+  world.run_pacto do
+    Bundler.with_clean_env do
+      block.call
+    end
   end
 end

data/features/validate/meta_validation.feature

@@ -9,7 +9,7 @@ Feature: Meta-validation
       """
           {
           "request": {
-            "method": "GET",    
+            "http_method": "GET",
             "path": "/hello_world",
             "headers": {
               "Accept": "application/json"
@@ -22,9 +22,10 @@ Feature: Meta-validation
             "headers": {
               "Content-Type": "application/json"
             },
-            "body": {
+            "schema": {
               "description": "A simple response",
               "type": "object",
+              "required": ["message"],
               "properties": {
                 "message": {
                   "type": "string"
@@ -37,16 +38,7 @@ Feature: Meta-validation
 
   Scenario: Meta-validation via a rake task
     When I successfully run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
-    Then the output should contain "All contracts successfully meta-validated"
-
-  Scenario: Programmatic meta-validation
-    Given a file named "meta_validate.rb" with:
-    """ruby
-    require 'pacto'
-    Pacto.validate_contract 'contracts/my_contract.json'
-    """
-    When I successfully run `bundle exec ruby meta_validate.rb`
-    Then the output should contain "Validating contracts/my_contract.json"
+    Then the stdout should contain "All contracts successfully meta-validated"
 
 # The tests from here down should probably be specs instead of relish
 
@@ -57,7 +49,7 @@ Feature: Meta-validation
     """
     When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
     Then the exit status should be 1
-    And the output should contain "did not match the following type"
+    And the stdout should contain "did not match the following type"
 
 
   Scenario: Meta-validation of a contract with empty request and response
@@ -67,20 +59,20 @@ Feature: Meta-validation
     """
     When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
     Then the exit status should be 1
-    And the output should contain "did not contain a required property"
+    And the stdout should contain "did not contain a required property"
 
   Scenario: Meta-validation of a contracts response body
     Given a file named "contracts/my_contract.json" with:
     """
         {
         "request": {
-          "method": "GET",
+          "http_method": "GET",
           "path": "/hello_world"
         },
 
         "response": {
           "status": 200,
-          "body": {
+          "schema": {
             "required": "anystring"
             }
           }
@@ -88,4 +80,4 @@ Feature: Meta-validation
     """
     When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
     Then the exit status should be 1
-    And the output should contain "did not match the following type"
+    And the stdout should contain "did not match the following type"