webspicy 0.15.1 → 0.15.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7df7fb7b7355b799757a5f58d93e38d273c18e371abb8bec697da6ae0f2bd2d
-  data.tar.gz: e1b01e07b8a00610336a8d2415a0e6b911c08515fcfbc0cb2b10631e76844814
+  metadata.gz: 8e1b4727e5991117fae5493694aa7a27d7de9811039d74eca4592a60b40d20c3
+  data.tar.gz: dd3d6d1d836dd19cda286a8de96663711b5c1682b6a8411e6a051aa6a5d7c7e7
 SHA512:
-  metadata.gz: 341c0de577225743a1cca6cf60471210c720c7385f3c2bfad7a32db4172214ebb5ad5af2aab0719ffaca2bf2f5a29f1ecfe2b74a92a14901e1aecaa4f8032aee
-  data.tar.gz: 6424b90b6cc4dce2336bf2076da859726c19eaeecf9d8ee33f08769c814549087326f353eef68f54663b68e8d8a633648a215ffd7c69c57e11ac520421e72243
+  metadata.gz: 0d37e5d27ca8f93b1745b4ef0515d710bc6e00b85023c3cf6d3e9e3fc6d2e7d2e5b55eaf0a3c1d756f8dbc5048be6a5b50b7d03ed021263af8a943a15bc883ef
+  data.tar.gz: af84325bb759302a20d0cb9cc96eb5015ee5e07815d8d00083bad3950024e1f70b09c03b17989e703bf448a7c6184814bd321fe2fb597c4ca6e0d209f27bd20d

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.1)
+    webspicy (0.15.6)
       finitio (>= 0.8.0)
       http (>= 2)
       mustermann (~> 1.0)

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/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

@@ -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
@@ -69,6 +81,10 @@ module Webspicy
           expected[:status]
         end
 
+        def is_expected_status?(status)
+          expected_status === status
+        end
+
         def expected_error
           expected[:error]
         end

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, 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?
+          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  = 1
+    TINY  = 6
   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.1
+  version: 0.15.6
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -224,6 +224,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 +241,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
@@ -262,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.0.pre1
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!