webspicy 0.15.2 → 0.15.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efdf4060daab47d3319dd29b48ecd26013621e30f6c1d4f1c25b4f518ea7529c
-  data.tar.gz: 52841690093e5d2c6aa109fb9713ed8b61aad46b692372bd2bef4bc9eeb13c33
+  metadata.gz: f4a2e0e1d1ccfacade6173f0ebe8119a71438aeb5403af05bdf08373f98630d7
+  data.tar.gz: 063a4f40b5e8244adc654bb0e60b2dccb67b930b0ec4fa18045e3b005392004d
 SHA512:
-  metadata.gz: e6a7c5fae819129306949642fdb8dab129a490750988fd6ea5b7b65e1f54baec03736f5691487ee8d0008eee3688bd98a094260ef4dfa3f0538ca5fbcafda1e1
-  data.tar.gz: 06e2831456be2cd7fb2dd3ac3cf9135bef1e8ae8aa683977d9670a5724b090d2104b1e8d57b6f3f3d20b88ca72e4e7077d0c99fb47a1123e9c6d1634290beb3c
+  metadata.gz: bdaaf1d7e90215b5f2f4d30ab0efd42ddf08f490dcaa77cba84a822b333020d63c34980420d9b9872c2db423635cf0d0fd0193a578826a31ad950795fa8a806e
+  data.tar.gz: 21a7cf4e9b0bbb8835284132edd029fd7221933d2cc0d044c8ca6f5fb81bfc406621cbefdd33422da1a3ce68a703a030965fd15b7da8e678693e25a78c1526e7

data/bin/webspicy

@@ -29,7 +29,8 @@ if ARGV.size != 1
   exit(-1)
 elsif (p = Path(ARGV.first)).exists?
   config = Webspicy::Configuration.dress(p)
-  Webspicy::Tester.new(config).call
+  res = Webspicy::Tester.new(config).call
+  abort("Some tests failed") unless res == 0
 else
   puts "No such file or directory `#{ARGV.first}`"
   showhelp

data/examples/restful/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.15.2)
+    webspicy (0.15.7)
       finitio (>= 0.8.0)
       http (>= 2)
       mustermann (~> 1.0)

data/examples/restful/app.rb

@@ -119,6 +119,21 @@ patch '/todo/:id', :auth => :user do |id|
   end
 end
 
+put '/todo/:id', :auth => :user do |id|
+  content_type :json
+  todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
+  if todo.nil?
+    status 404
+    {error: "No such todo"}.to_json
+  else
+    put = SCHEMA["TodoPut"].dress(loaded_body.merge(id: Integer(id)))
+    updated = todo.merge(put)
+    settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
+    settings.todolist << updated
+    updated.to_json
+  end
+end
+
 delete '/todo/:id', :auth => :admin do |id|
   content_type :json
   todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }

data/examples/restful/webspicy/schema.fio

@@ -10,6 +10,11 @@ TodoPatch = {
   description :? String
 }
 
+TodoPut = {
+  id          : Integer
+  description : String
+}
+
 ErrorSchema = {
   error: String
 }

data/examples/restful/webspicy/todo/putTodo.yml

@@ -0,0 +1,65 @@
+---
+name: |-
+  Todo
+
+url: |-
+  /todo/{id}
+
+services:
+- method: |-
+    PUT
+
+  description: |-
+    Update a single Todo item
+
+  preconditions:
+    - Must be authenticated
+
+  input_schema: |-
+    TodoPut
+
+  output_schema: |-
+    Todo
+
+  error_schema: |-
+    ErrorSchema
+
+  default_example:
+    expected:
+      content_type: application/json
+      status: 200
+
+  examples:
+
+    - description: |-
+        when requested on an existing TODO
+      params:
+        id: 1
+        description: 'hello world'
+      assert:
+        - "pathFD('', description: 'hello world')"
+
+  counterexamples:
+
+    - description: |-
+        when requested on an unexisting TODO
+      params:
+        id: 999254654
+        description: 'hello world'
+      expected:
+        content_type: application/json
+        status: 404
+      assert:
+        - "pathFD('', error: 'No such todo')"
+
+    - description: |-
+        when violating the Put data type
+      params:
+        id: 1
+        description: 'hello world'
+        nosuchone: 'foobar'
+      dress_params:
+        false
+      expected:
+        content_type: application/json
+        status: 400

data/lib/webspicy.rb

@@ -14,6 +14,7 @@ module Webspicy
   ### Load library
   ###
 
+  require 'webspicy/support'
   require 'webspicy/configuration'
   require 'webspicy/file_upload'
   require 'webspicy/scope'

data/lib/webspicy/client/http_client.rb

@@ -107,6 +107,18 @@ module Webspicy
         @last_response
       end
 
+      def put(url, params = {}, headers = nil, body = nil)
+        info_request("PUT", url, params, headers, body)
+
+        headers ||= {}
+        headers['Content-Type'] ||= 'application/json'
+        @last_response = HTTP[headers].put(url, body: params.to_json)
+
+        debug_response(@last_response)
+
+        @last_response
+      end
+
       def post_form(url, params = {}, headers = nil, body = nil)
         info_request("POST", url, params, headers, body)
 

data/lib/webspicy/client/rack_test_client.rb

@@ -126,6 +126,19 @@ module Webspicy
         @last_response
       end
 
+      def put(url, params = {}, headers = nil, body = nil)
+        handler = get_handler(headers)
+
+        info_request("PUT", url, params, headers, body)
+
+        handler.put(url, params.to_json, {"CONTENT_TYPE" => "application/json"})
+        @last_response = handler.last_response
+
+        debug_response(@last_response)
+
+        @last_response
+      end
+
       def post_form(url, params = {}, headers = nil, body = nil)
         handler = get_handler(headers)
 

data/lib/webspicy/configuration.rb

@@ -11,6 +11,7 @@ module Webspicy
       @postconditions = []
       @listeners = Hash.new{|h,k| h[k] = [] }
       @rspec_options = default_rspec_options
+      @run_examples = default_run_examples
       @run_counterexamples = default_run_counterexamples
       @file_filter = default_file_filter
       @service_filter = default_service_filter
@@ -94,6 +95,23 @@ module Webspicy
       !children.empty?
     end
 
+    # Sets whether examples have to be ran or not.
+    def run_examples=(run_examples)
+      @run_examples = run_examples
+    end
+    attr_reader :run_examples
+
+    # Whether counter examples must be ran or not.
+    def run_examples?
+      @run_examples
+    end
+
+    # Returns the defaut value for run_examples
+    def default_run_examples
+      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'only')
+    end
+    private :default_run_examples
+
     # Sets whether counter examples have to be ran or not.
     def run_counterexamples=(run_counterexamples)
       @run_counterexamples = run_counterexamples
@@ -249,36 +267,36 @@ module Webspicy
     # Installs a listener that will be called before all tests
     #
     # The `listener` must respond to `call`.
-    def before_all(&listener)
-      register_listener(:before_all, listener)
+    def before_all(l = nil, &listener)
+      register_listener(:before_all, l || listener)
     end
 
     # Installs a listener that will be called before each web service invocation.
     #
     # The `listener` must respond to `call`.
-    def before_each(&listener)
-      register_listener(:before_each, listener)
+    def before_each(l = nil, &listener)
+      register_listener(:before_each, l || listener)
     end
 
     # Installs a listener that will be called after all tests
     #
     # The `listener` must respond to `call`.
-    def after_all(&listener)
-      register_listener(:after_all, listener)
+    def after_all(l = nil, &listener)
+      register_listener(:after_all, l || listener)
     end
 
     # Installs a listener that will be called after each web service invocation.
     #
     # The `listener` must respond to `call`.
-    def after_each(&listener)
-      register_listener(:after_each, listener)
+    def after_each(l = nil, &listener)
+      register_listener(:after_each, l || listener)
     end
 
     # Installs a listener that will be called around each web service invocation.
     #
     # The `listener` must respond to `call`.
-    def around_each(&listener)
-      register_listener(:around_each, listener)
+    def around_each(l = nil, &listener)
+      register_listener(:around_each, l || listener)
     end
 
     # Installs a listener that will be called right after all precondition

data/lib/webspicy/formaldoc.fio

@@ -1,7 +1,7 @@
 @import finitio/data
 
 Method =
-    String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|OPTIONS)$/ )
+    String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|PUT|OPTIONS)$/ )
 
 Tag = String( s | s.length > 0 )
 
@@ -51,7 +51,7 @@ TestCase =
         requester        :? String
         metadata         :? { ...: .Object }
         expected         :? {
-            status       :? Integer
+            status       :? StatusRange
             content_type :? String|Nil
             error        :? String
             headers      :? .Hash
@@ -61,3 +61,7 @@ TestCase =
     }
 
 Params = .Array|.Hash
+
+StatusRange = .Webspicy::Support::StatusRange
+  <int> Integer
+  <str> String(s | s =~ /^\dxx$/ )

data/lib/webspicy/mocker.rb

@@ -57,7 +57,7 @@ module Webspicy
 
     def best_status_code(service)
       if ex = service.examples.first
-        ex.expected_status || 200
+        (ex.expected_status && ex.expected_status.to_i) || 200
       else
         200
       end

data/lib/webspicy/resource/service.rb

@@ -51,8 +51,7 @@ module Webspicy
         preconditions.map{|pre|
           pre.counterexamples(self).map{|tc|
             tc = Webspicy.test_case(tc, Webspicy.current_scope)
-            tc.service = self
-            tc
+            tc.bind(self, true)
           }
         }.flatten
       end
@@ -107,13 +106,13 @@ module Webspicy
 
       def bind_examples
         (@raw[:examples] ||= []).each do |ex|
-          ex.service = self
+          ex.bind(self, false)
         end
       end
 
       def bind_counterexamples
         (@raw[:counterexamples] ||= []).each do |ex|
-          ex.service = self
+          ex.bind(self, true)
         end
       end
 

data/lib/webspicy/resource/service/invocation.rb

@@ -12,6 +12,32 @@ module Webspicy
 
         attr_reader :service, :test_case, :response, :client
 
+        def errors
+          @errors ||= begin
+            errs = [
+              [:expected_status_unmet, true],
+              [:expected_content_type_unmet, !test_case.is_expected_status?(204)],
+              [:expected_headers_unmet, test_case.has_expected_headers?],
+              [:expected_schema_unmet, !test_case.is_expected_status?(204)],
+              [:assertions_unmet, test_case.has_assertions?],
+              [:postconditions_unmet, test_case.service.has_postconditions? && !test_case.counterexample?],
+              [:expected_error_unmet, test_case.has_expected_error?]
+            ].map do |(expectation,only_if)|
+              next unless only_if
+              begin
+                self.send(expectation)
+              rescue => ex
+                ex.message
+              end
+            end
+            errs.compact
+          end
+        end
+
+        def has_error?
+          !errors.empty?
+        end
+
         ### Getters on response
 
         def response_code
@@ -27,7 +53,7 @@ module Webspicy
         end
 
         def is_expected_success?
-          test_case.expected_status >= 200 && test_case.expected_status < 300
+          test_case.expected_status.to_i >= 200 && test_case.expected_status.to_i < 300
         end
 
         def is_success?
@@ -47,7 +73,7 @@ module Webspicy
         def expected_status_unmet
           expected = test_case.expected_status
           got = response.status
-          expected == got ? nil : "#{expected} != #{got}"
+          expected === got ? nil : "#{expected} !== #{got}"
         end
 
         def meets_expected_status?
@@ -63,7 +89,7 @@ module Webspicy
           if ect.nil?
             got.nil? ? nil : "#{ect} != #{got}"
           else
-            ect.to_s == got.to_s ? nil : "#{ect} != #{got}"
+            got.to_s.start_with?(ect.to_s) ? nil : "#{ect} != #{got}"
           end
         end
 

data/lib/webspicy/resource/service/test_case.rb

@@ -5,8 +5,20 @@ module Webspicy
 
         def initialize(raw)
           @raw = raw
+          @counterexample = nil
+        end
+        attr_reader :service
+        attr_reader :counterexample
+
+        def bind(service, counterexample)
+          @service = service
+          @counterexample = counterexample
+          self
+        end
+
+        def counterexample?
+          !!@counterexample
         end
-        attr_accessor :service
 
         def resource
           service.resource
@@ -70,7 +82,7 @@ module Webspicy
         end
 
         def is_expected_status?(status)
-          expected_status == status
+          expected_status === status
         end
 
         def expected_error

data/lib/webspicy/scope.rb

@@ -46,23 +46,26 @@ module Webspicy
       resource.services.select(&to_filter_proc(config.service_filter)).each(&bl)
     end
 
-    def each_example(service)
-      service.examples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-        yield(expand_example(service, e), false)
-      }
+    def each_example(service, &bl)
+      service.examples
+        .map{|e| expand_example(service, e) }
+        .select(&to_filter_proc(config.test_case_filter))
+        .each(&bl) if config.run_examples?
     end
 
     def each_counterexamples(service, &bl)
-      service.counterexamples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-        yield(expand_example(service, e), true)
-      } if config.run_counterexamples?
+      service.counterexamples
+        .map{|e| expand_example(service, e) }
+        .select(&to_filter_proc(config.test_case_filter))
+        .each(&bl) if config.run_counterexamples?
     end
 
     def each_generated_counterexamples(service, &bl)
       Webspicy.with_scope(self) do
-        service.generated_counterexamples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-          yield(expand_example(service, e), true)
-        }
+        service.generated_counterexamples
+          .map{|e| expand_example(service, e) }
+          .select(&to_filter_proc(config.test_case_filter))
+          .each(&bl) if config.run_counterexamples?
       end if config.run_counterexamples?
     end
 
@@ -128,8 +131,7 @@ module Webspicy
         h1 = service.default_example.to_info
         h2 = example.to_info
         ex = Resource::Service::TestCase.new(merge_maps(h1, h2))
-        ex.service = service
-        ex
+        ex.bind(service, example.counterexample?)
       end
 
       def merge_maps(h1, h2)

data/lib/webspicy/support.rb

@@ -0,0 +1 @@
+require_relative 'support/status_range'

data/lib/webspicy/support/status_range.rb

@@ -0,0 +1,50 @@
+module Webspicy
+  module Support
+    class StatusRange
+
+      def initialize(range)
+        @range = range
+      end
+      attr_reader :range
+
+      def self.int(i)
+        new(i..i)
+      end
+
+      def to_int
+        @range.first
+      end
+
+      def self.str(s)
+        from = s[/^(\d)/,1].to_i * 100
+        new(from...from+100)
+      end
+
+      def to_str
+        "#{@range.first/100}xx"
+      end
+
+      def to_i
+        @range.first
+      end
+
+      def ===(status)
+        range === status
+      end
+
+      def ==(other)
+        other.is_a?(StatusRange) && self.range == other.range
+      end
+      alias :eql? :==
+
+      def hash
+        @range.hash
+      end
+
+      def to_s
+        @range.to_s
+      end
+
+    end # class StatusRange
+  end # module Support
+end # module Webspicy

data/lib/webspicy/tester.rb

@@ -45,16 +45,16 @@ module Webspicy
 
     def rspec_service!(on, service, client, scope)
       on.describe service do
-        scope.each_testcase(service) do |test_case, counterexample|
+        scope.each_testcase(service) do |test_case|
           describe test_case do
-            include_examples 'a successful test case invocation', client, test_case, counterexample
+            include_examples 'a successful test case invocation', client, test_case
           end
         end
       end
     end
 
     def rspec_config!
-      RSpec.shared_examples "a successful test case invocation" do |client, test_case, counterexample|
+      RSpec.shared_examples "a successful test case invocation" do |client, test_case|
 
         around(:each) do |example|
           client.around(test_case) do
@@ -63,7 +63,8 @@ module Webspicy
             client.instrument(test_case)
             @invocation = client.call(test_case)
             example.run
-            client.after(test_case)
+            client.after(test_case, @invocation)
+            @invocation
           end
         end
 
@@ -73,24 +74,8 @@ module Webspicy
 
         it 'works' do
           raise "Test not ran" unless invocation.done?
-          fails = [
-            [:expected_status_unmet, true],
-            [:expected_content_type_unmet, !test_case.is_expected_status?(204)],
-            [:expected_headers_unmet, test_case.has_expected_headers?],
-            [:expected_schema_unmet, !test_case.is_expected_status?(204)],
-            [: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?
+          errors = invocation.errors
+          raise "\n* " + errors.join("\n* ") + "\n" unless errors.empty?
         end
       end
     end

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 15
-    TINY  = 2
+    TINY  = 7
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/scope/test_expand_example.rb

@@ -53,7 +53,7 @@ module Webspicy
         expect(subject).to be_a(Resource::Service::TestCase)
         expect(subject.description).to eql("Hello world")
         expect(subject.expected).to eql({
-          status: 200,
+          status: Support::StatusRange.int(200),
           content_type: "application/json"
         })
       end

data/spec/unit/support/test_status_range.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+module Webspicy
+  module Support
+    describe StatusRange do
+
+      it 'has a int information contract' do
+        expect(StatusRange.int(100).range).to eql(100..100)
+        expect(StatusRange.int(100).to_int).to eql(100)
+      end
+
+      it 'has a str information contract' do
+        expect(StatusRange.str("3xx").range).to eql(300...400)
+        expect(StatusRange.str("3xx").to_str).to eql("3xx")
+      end
+
+      it 'has a to_i that returns the first status of the range' do
+        expect(StatusRange.int(300).to_i).to eql(300)
+        expect(StatusRange.str("3xx").to_i).to eql(300)
+      end
+
+      it 'has a matching method' do
+        expect(StatusRange.str("3xx") === 300).to eql(true)
+        expect(StatusRange.str("3xx") === 302).to eql(true)
+        expect(StatusRange.str("3xx") === 400).to eql(false)
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.15.7
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -206,6 +206,7 @@ files:
 - examples/restful/webspicy/todo/postCsv.yml
 - examples/restful/webspicy/todo/postFile.yml
 - examples/restful/webspicy/todo/postTodos.yml
+- examples/restful/webspicy/todo/putTodo.yml
 - examples/restful/webspicy/todo/todos.csv
 - lib/webspicy.rb
 - lib/webspicy/checker.rb
@@ -224,6 +225,8 @@ files:
 - lib/webspicy/resource/service/invocation.rb
 - lib/webspicy/resource/service/test_case.rb
 - lib/webspicy/scope.rb
+- lib/webspicy/support.rb
+- lib/webspicy/support/status_range.rb
 - lib/webspicy/tester.rb
 - lib/webspicy/tester/asserter.rb
 - lib/webspicy/tester/assertions.rb
@@ -239,6 +242,7 @@ files:
 - spec/unit/scope/test_expand_example.rb
 - spec/unit/scope/test_to_real_url.rb
 - spec/unit/spec_helper.rb
+- spec/unit/support/test_status_range.rb
 - spec/unit/test_configuration.rb
 - spec/unit/tester/test_assertions.rb
 - tasks/gem.rake