webspicy 0.12.5 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d8a8db807de1959e59ebc27dec02a35c11749763c64932c4b38be2c763375f
-  data.tar.gz: d8bdd2e5e1dfc7dfbf25034ccb5867f93b1dd09d63e60225c78f30b0d9577a22
+  metadata.gz: df662e6e4d8e94403071753f7f4e3a61919bf6fc8e5913316b847fee3b03d9d3
+  data.tar.gz: 4e18c04cff9b572d4173a267590f6e91cbfe1bbbf40236944c7fad50edff88dc
 SHA512:
-  metadata.gz: 25f00703c45fdef554cb45d8699ed97b9bc61a1d395103260b2e1901960a21740eed8aa47f103c760b8d6e352aebb55d98377322b2fe0bdb033302d52694b50e
-  data.tar.gz: 487fc0463160ff897ceab1ec3782ffb5c1cf89aa701970ddf0478dac71678ae458f95423aa7cdde3fbfa2c0a762fd61d3a9cfc14fe8e02efeacf978897ba5770
+  metadata.gz: 997f7223ba296843ff3ef1c4acaeed45815921c88e03ae756d7e27cf0c4ab60b3a644ddea34e0ac3df4bed41c3472a1135ac15801efc0052cca0c190ca5aceee
+  data.tar.gz: b1cdceb0a8a3b9bc756e2f7a763b4e529c4bb370d7db916d83c273f6e692cb08aa652f296571d846f3112c344d144f03117fecab9d21c7b622c0ed5867231af6

data/examples/restful/Gemfile.lock

@@ -1,25 +1,29 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.12.5)
-      finitio (>= 0.6.1)
+    webspicy (0.13.0)
+      finitio (>= 0.8.0)
       http (~> 2)
+      mustermann (~> 1.0)
+      mustermann-contrib
       path (~> 1.3)
       rack-robustness (~> 1.1, >= 1.1.0)
       rack-test (~> 0.6.3)
       rspec (~> 3.7)
+      rspec_junit_formatter (~> 0.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     citrus (3.0.2)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    finitio (0.7.0)
+    finitio (0.8.0)
       citrus (>= 2.4, < 4.0)
+    hansi (0.2.0)
     http (2.2.2)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -30,34 +34,39 @@ GEM
     http-form_data (1.0.3)
     http_parser.rb (0.6.0)
     mustermann (1.0.3)
+    mustermann-contrib (1.0.3)
+      hansi (~> 0.2.0)
+      mustermann (= 1.0.3)
     path (1.3.3)
-    public_suffix (3.1.1)
+    public_suffix (4.0.3)
     rack (2.0.7)
-    rack-protection (2.0.5)
+    rack-protection (2.0.7)
       rack
     rack-robustness (1.1.0)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    sinatra (2.0.5)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    sinatra (2.0.7)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack-protection (= 2.0.7)
       tilt (~> 2.0)
-    tilt (2.0.9)
+    tilt (2.0.10)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.6)
@@ -71,4 +80,4 @@ DEPENDENCIES
   webspicy!
 
 BUNDLED WITH
-   2.0.1
+   2.1.0.pre.1

data/lib/webspicy.rb

@@ -7,6 +7,7 @@ require 'ostruct'
 require 'yaml'
 require 'rspec'
 require 'rack/test'
+require "mustermann"
 module Webspicy
 
   ###

data/lib/webspicy/client/http_client.rb

@@ -49,7 +49,7 @@ module Webspicy
         @last_response = HTTP[headers || {}].options(url, params: params)
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -60,7 +60,7 @@ module Webspicy
         @last_response = HTTP[headers || {}].get(url, params: params)
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -88,7 +88,7 @@ module Webspicy
         end
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -101,7 +101,7 @@ module Webspicy
         @last_response = HTTP[headers].patch(url, body: params.to_json)
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -112,7 +112,7 @@ module Webspicy
         @last_response = HTTP[headers || {}].post(url, form: params)
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -123,7 +123,7 @@ module Webspicy
         @last_response = HTTP[headers || {}].delete(url, body: params.to_json)
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end

data/lib/webspicy/client/rack_test_client.rb

@@ -70,7 +70,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -85,7 +85,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -110,7 +110,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -124,7 +124,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -138,7 +138,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end
@@ -152,7 +152,7 @@ module Webspicy
         @last_response = handler.last_response
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
-        Webspicy.debug("Response: #{@last_response.body}")
+        Webspicy.debug("Response (#{@last_response.status}):  #{@last_response.body}")
 
         @last_response
       end

data/lib/webspicy/configuration.rb

@@ -273,7 +273,8 @@ module Webspicy
     # - FAILFAST <-> --fail-fast
     #
     def default_rspec_options
-      options = ["--color", "--format=documentation"]
+      dest_folder = (self.folder/'rspec.xml').to_s
+      options = %w{--color --format=documentation --format RspecJunitFormatter --out} << dest_folder
       if ENV['FAILFAST']
         options << (ENV['FAILFAST'] == 'no' ? "--no-fail-fast" : "--fail-fast=#{ENV['FAILFAST']}")
       end
@@ -299,6 +300,13 @@ module Webspicy
       end
     end
 
+    # Returns the data generator to use, for generating random data when
+    # needed.
+    def generator
+      @generator
+    end
+    attr_writer :generator
+
     # Duplicates this configuration and yields the block with the new one,
     # if a block is given.
     #

data/lib/webspicy/mocker.rb

@@ -0,0 +1,88 @@
+require "finitio/generation"
+require "json"
+module Webspicy
+  class Mocker
+
+    def initialize(config)
+      @config = Configuration.dress(config)
+      @generator = config.generator || Finitio::Generation.new
+    end
+    attr_reader :config, :generator
+
+    def call(env)
+      req = Rack::Request.new(env)
+      path = req.path
+      meth = req.request_method
+      if meth == "OPTIONS" && has_service?(path)
+        [204, {}, []]
+      elsif service = find_service(meth, path)
+        status = best_status_code(service)
+        body = status == 204 ? "" : random_body(service, req)
+        headers = generate_headers(service)
+        [ status, headers, [ body ].compact ]
+      else
+        [404, {}, []]
+      end
+    end
+
+  private
+
+    def has_service?(path)
+      config.each_scope do |scope|
+        scope.each_resource do |resource|
+          next unless url_matches?(resource, path)
+          return true
+        end
+      end
+      return false
+    end
+
+    def find_service(method, path)
+      config.each_scope do |scope|
+        scope.each_resource do |resource|
+          next unless url_matches?(resource, path)
+          scope.each_service(resource) do |service|
+            return service if service.method == method
+          end
+        end
+      end
+      nil
+    end
+
+    def generate_headers(service)
+      {
+        "Content-Type" => best_content_type(service)
+      }.delete_if{|k,v| v.nil? }
+    end
+
+    def best_status_code(service)
+      if ex = service.examples.first
+        ex.expected_status || 200
+      else
+        200
+      end
+    end
+
+    def best_content_type(service)
+      if ex = service.examples.first
+        ex.expected_content_type
+      else
+        "application/json"
+      end
+    end
+
+    def url_matches?(resource, path)
+      resource.url_pattern.match(path)
+    end
+
+    def random_body(service, request)
+      world = OpenStruct.new({
+        service: service,
+        request: request
+      })
+      data = generator.call(service.output_schema.main, world)
+      JSON.pretty_generate(data) if data
+    end
+
+  end # class Mocker
+end # module Webspicy

data/lib/webspicy/resource.rb

@@ -26,6 +26,10 @@ module Webspicy
       @raw[:url]
     end
 
+    def url_pattern
+      @url_pattern ||= Mustermann.new(url, type: :template)
+    end
+
     def services
       @raw[:services]
     end

data/lib/webspicy/tester.rb

@@ -20,7 +20,7 @@ module Webspicy
       tester = self
       RSpec.reset
       rspec_config!
-      RSpec.describe "Webspicy test suite" do
+      RSpec.describe "" do
         before(:all) do
           tester.config.listeners(:before_all).each do |l|
             l.call(tester.config)
@@ -71,15 +71,26 @@ module Webspicy
           @invocation
         end
 
-        it 'meets its specification' do
-          expect(invocation.done?).to eq(true)
-          expect(invocation.expected_status_unmet).to(be_nil)
-          expect(invocation.expected_content_type_unmet).to(be_nil)
-          expect(invocation.expected_headers_unmet).to(be_nil) if test_case.has_expected_headers?
-          expect(invocation.expected_schema_unmet).to(be_nil)
-          expect(invocation.assertions_unmet).to(be_nil) if test_case.has_assertions?
-          expect(invocation.postconditions_unmet).to(be_nil) if test_case.service.has_postconditions? and not(counterexample)
-          expect(invocation.expected_error_unmet).to(be_nil) if test_case.has_expected_error?
+        it 'works' do
+          raise "Test not ran" unless invocation.done?
+          fails = [
+            [:expected_status_unmet, true],
+            [:expected_content_type_unmet, true],
+            [:expected_headers_unmet, test_case.has_expected_headers?],
+            [:expected_schema_unmet, true],
+            [:assertions_unmet, test_case.has_assertions?],
+            [:postconditions_unmet, test_case.service.has_postconditions? && !counterexample],
+            [:expected_error_unmet, test_case.has_expected_error?]
+          ].map do |(expectation,only_if)|
+            next unless only_if
+            begin
+              invocation.send(expectation)
+            rescue => ex
+              ex.message
+            end
+          end
+          fails = fails.compact
+          raise "\n* " + fails.join("\n* ") + "\n" unless fails.empty?
         end
       end
     end

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 12
-    TINY  = 5
+    MINOR = 13
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/mocker/test_mocker.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'rack/test'
+require 'webspicy/mocker'
+module Webspicy
+  describe Mocker do
+    include Rack::Test::Methods
+
+    let(:app) {
+      Mocker.new(Configuration.dress(restful_folder))
+    }
+
+    it 'works as expected' do
+      get '/todo/'
+      expect(last_response.status).to eql(200)
+      expect(last_response.body).not_to be_empty
+    end
+
+    it 'supports CORS on OPTIONS' do
+      options '/todo/'
+      expect(last_response.status).to eql(204)
+      expect(last_response.body).to be_empty
+    end
+
+    it 'returns the correct status code, taken from first example' do
+      delete '/todo/1'
+      expect(last_response.status).to eql(204)
+      expect(last_response.body).to be_empty
+      expect(last_response["Content-Type"]).to be_nil
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.13.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +92,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +148,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mustermann-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables: []
@@ -171,6 +213,7 @@ files:
 - lib/webspicy/configuration.rb
 - lib/webspicy/file_upload.rb
 - lib/webspicy/formaldoc.fio
+- lib/webspicy/mocker.rb
 - lib/webspicy/postcondition.rb
 - lib/webspicy/precondition.rb
 - lib/webspicy/resource.rb
@@ -184,6 +227,7 @@ files:
 - lib/webspicy/version.rb
 - spec/unit/client/test_around.rb
 - spec/unit/configuration/config.rb
+- spec/unit/mocker/test_mocker.rb
 - spec/unit/resource/service/test_dress_params.rb
 - spec/unit/resource/test_instantiate_url.rb
 - spec/unit/resource/test_url_placeholders.rb
@@ -215,8 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.0.pre1
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!