webspicy 0.19.0 → 0.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614e5904931375bd6f4df435d33736cde757e752d0d759fbc3af4e185b9cd9e4
-  data.tar.gz: 8d63e07e93809bd5139300e5206f0a3b3204e86d77faea60a29302e5787413d1
+  metadata.gz: 9afe697a47ba4391d2e059f1bf3707c04f97f9d6fd50557104a59c6602dbd75c
+  data.tar.gz: 66ec4036f8e76dad7af0f8b0cf83ea139a67a7b1020aa0a304c26fdc9402d593
 SHA512:
-  metadata.gz: 33d6a69e097e14a90f8b69edb4833a4a1325cec38513bf8f88d017b31847e08b310acce50dc7fb3d3cbdeefdff76b3497b489adbc2e965c7e8b12f0228a63524
-  data.tar.gz: 0d6cf55d54a6bb94b48511f9c178a1e5e673772749784b3c7c720d9413670dc1e93029cfa0687efd8fced6f91eb699ea5cae4ab15e40a674dea7843712dec114
+  metadata.gz: 79feb96443a47523b38f16e4cf7e7edfcd675f5a71c6b33aa452ad452aeacd5e64de1ce1ffa9ff3f5bf9cf428d59dc183e8f1455e1ce26126f2eddf9a14795fb
+  data.tar.gz: 2761eb20d67f4c697dedf7c27496cfd36ceed4f988f1f54f17809358e570102f1e40c29c47e46f614671504dcf1c877ce2fe6ccb7a72b510994a9da95bb74de1

data/bin/webspicy

@@ -55,5 +55,4 @@ if ARGV.size != 1
 end
 
 config = Webspicy::Configuration.dress(ARGV[0])
-res = Webspicy::Tester.new(config).call
-abort("#{res} errors occured") unless res == 0
+Webspicy::Tester.new(config).call!

data/lib/webspicy.rb

@@ -33,8 +33,6 @@ module Webspicy
   HttpClient = Web::HttpClient
   RackTestClient = Web::RackTestClient
   Resource = Specification
-  Precondition = Specification::Precondition
-  Postcondition = Specification::Postcondition
   FileUpload = Specification::FileUpload
   Scope = Configuration::Scope
   Checker = Tester::FileChecker

data/lib/webspicy/configuration.rb

@@ -33,12 +33,15 @@ module Webspicy
       @service_filter = default_service_filter
       @test_case_filter = default_test_case_filter
       @colors = {
+        :section => :magenta,
         :highlight => :cyan,
         :error => :red,
         :success => :green
       }
+      @colorize = true
       @scope_factory = ->(config){ Scope.new(config) }
       @client = Web::HttpClient
+      @reporter = default_reporter
       Path.require_tree(@folder/'support') if (@folder/'support').exists?
       @world = Support::World.new(folder/'world', self)
       yield(self) if block_given?
@@ -47,6 +50,8 @@ module Webspicy
     protected :folder=
 
     attr_accessor :colors
+    attr_accessor :colorize
+
     attr_reader :world
 
     def self.dress(arg, &bl)
@@ -434,6 +439,16 @@ module Webspicy
     end
     private :default_rspec_options
 
+    # Returns the default reporter to use.
+    def default_reporter
+      @reporter = Tester::Reporter::Composite.new
+      @reporter << Tester::Reporter::Documentation.new
+      @reporter << Tester::Reporter::Exceptions.new
+      @reporter << Tester::Reporter::Summary.new
+      @reporter << Tester::Reporter::ErrorCount.new
+    end
+    attr_accessor :reporter
+
     # Returns the Data system to use for parsing schemas
     #
     # The data system associated with a configuration is build when the

data/lib/webspicy/configuration/scope.rb

@@ -23,6 +23,7 @@ module Webspicy
         folder = config.folder
         world  = config.folder/"world"
         fs = folder.glob("**/*.yml").reject{|f| f.to_s.start_with?(world.to_s) }
+        fs = fs.sort
         fs = fs.select(&to_filter_proc(config.file_filter)) if apply_filter
         fs.each do |file|
           yield file, folder

data/lib/webspicy/specification.rb

@@ -94,8 +94,9 @@ module Webspicy
 end # module Webspicy
 require_relative 'specification/service'
 require_relative 'specification/condition'
-require_relative 'specification/precondition'
-require_relative 'specification/postcondition'
-require_relative 'specification/errcondition'
+require_relative 'specification/pre'
+require_relative 'specification/post'
+require_relative 'specification/err'
+require_relative 'specification/oldies'
 require_relative 'specification/test_case'
 require_relative 'specification/file_upload'

data/lib/webspicy/specification/condition.rb

@@ -1,11 +1,40 @@
 module Webspicy
   class Specification
     module Condition
+      extend Forwardable
 
       MATCH_ALL = "__all__"
 
       attr_accessor :matching_description
 
+      # Given a service and a condition, returns a Pre instance of there is a
+      # match, nil otherwise.
+      def self.match(service, condition)
+      end
+
+      # Bind the condition instance to a current tester.
+      def bind(tester)
+        @tester = tester
+        self
+      end
+      attr_reader :tester
+
+      def_delegators :@tester, *[
+        :config, :scope, :client,
+        :specification, :spec_file,
+        :service, :test_case,
+        :invocation, :result,
+        :reporter
+      ]
+
+      def sooner_or_later(*args, &bl)
+        Webspicy::Support.sooner_or_later(*args, &bl)
+      end
+
+      def fail!(msg)
+        raise Tester::Failure, msg
+      end
+
       def to_s
         if matching_description == MATCH_ALL
           self.class.name
@@ -14,10 +43,6 @@ module Webspicy
         end
       end
 
-      def sooner_or_later(*args, &bl)
-        Webspicy::Support.sooner_or_later(*args, &bl)
-      end
-
     end # module Condition
   end # class Specification
 end # module Webspicy

data/lib/webspicy/specification/err.rb

@@ -0,0 +1,18 @@
+module Webspicy
+  class Specification
+    module Err
+      include Condition
+
+      # Instrument the current test_case so as to prepare for errcondition
+      # check later
+      def instrument
+      end
+
+      # Check that the errcondition is met on last invocation & result
+      # of an counterexample
+      def check!
+      end
+
+    end # module Err
+  end # module Specification
+end # module Webspicy

data/lib/webspicy/specification/oldies.rb

@@ -0,0 +1,4 @@
+require_relative 'oldies/precondition'
+require_relative 'oldies/postcondition'
+require_relative 'oldies/errcondition'
+require_relative 'oldies/bridge'

data/lib/webspicy/specification/oldies/bridge.rb

@@ -0,0 +1,32 @@
+module Webspicy
+  class Specification
+    module Oldies
+      class Bridge
+        include Condition
+
+        def initialize(target)
+          @target = target
+        end
+        attr_reader :target
+
+        def instrument
+          return unless target.respond_to?(:instrument)
+          target.instrument(test_case, client)
+        end
+
+        def check!
+          return unless target.respond_to?(:check)
+          res = target.check(invocation)
+          res ? fail!(res) : nil
+        end
+
+        def to_s
+          "#{target} (backward compatibility bridge)"
+        end
+
+      end # class Bridge
+    end # module Errcondition
+  end # module Specification
+  Precondition = Specification::Precondition
+  Postcondition = Specification::Postcondition
+end # module Webspicy

data/lib/webspicy/specification/{errcondition.rb → oldies/errcondition.rb}

@@ -1,8 +1,13 @@
 module Webspicy
   class Specification
+    # Deprecated, use Err instead
     module Errcondition
       include Condition
 
+      def bind(tester)
+        Oldies::Bridge.new(self).bind(tester)
+      end
+
       def self.match(service, descr)
       end
 

data/lib/webspicy/specification/{postcondition.rb → oldies/postcondition.rb}

@@ -1,8 +1,13 @@
 module Webspicy
   class Specification
+    # Deprecated, use Post instead
     module Postcondition
       include Condition
 
+      def bind(tester)
+        Oldies::Bridge.new(self).bind(tester)
+      end
+
       def self.match(service, descr)
       end
 

data/lib/webspicy/specification/{precondition.rb → oldies/precondition.rb}

@@ -1,8 +1,13 @@
 module Webspicy
   class Specification
+    # Deprecated, use Pre instead
     module Precondition
       include Condition
 
+      def bind(tester)
+        Oldies::Bridge.new(self).bind(tester)
+      end
+
       def self.match(service, pre)
       end
 
@@ -16,5 +21,3 @@ module Webspicy
     end # module Precondition
   end # class Specification
 end # module Webspicy
-require_relative 'precondition/global_request_headers'
-require_relative 'precondition/robust_to_invalid_input'

data/lib/webspicy/specification/post.rb

@@ -0,0 +1,20 @@
+module Webspicy
+  class Specification
+    module Post
+      include Condition
+
+      # Instrument the current test_case so as to prepare for postcondition
+      # check later
+      def instrument
+      end
+
+      # Check that the postcondition is met on last invocation & result
+      # of an example
+      def check!
+      end
+
+    end # module Post
+  end # module Specification
+end # module Webspicy
+require_relative "post/missing_condition_impl"
+require_relative "post/unexpected_condition_impl"

data/lib/webspicy/specification/post/missing_condition_impl.rb

@@ -0,0 +1,15 @@
+module Webspicy
+  class Specification
+    module Postcondition
+      class MissingConditionImpl
+        include Post
+
+        def check!
+          msg = matching_description.gsub(/\(x\)/, "<!>")
+          fail!("#{msg} (not instrumented)")
+        end
+
+      end # class MissingConditionImpl
+    end # module Postcondition
+  end # class Specification
+end # module Webspicy

data/lib/webspicy/specification/post/unexpected_condition_impl.rb

@@ -0,0 +1,15 @@
+module Webspicy
+  class Specification
+    module Postcondition
+      class UnexpectedConditionImpl
+        include Post
+
+        def check!
+          msg = matching_description.gsub(/\( \)/, "<x>")
+          fail!("#{msg} (is instrumented)")
+        end
+
+      end # class UnexpectedConditionImpl
+    end # module Postcondition
+  end # class Specification
+end # module Webspicy

data/lib/webspicy/specification/pre.rb

@@ -0,0 +1,19 @@
+module Webspicy
+  class Specification
+    module Pre
+      include Condition
+
+      # Instrument the current test_case so as to meet the precondition
+      def instrument
+      end
+
+      # Provide counterexamples of this precondition for a given service.
+      def counterexamples(service)
+        []
+      end
+
+    end # module Pre
+  end # class Specification
+end # module Webspicy
+require_relative 'pre/global_request_headers'
+require_relative 'pre/robust_to_invalid_input'

data/lib/webspicy/specification/{precondition → pre}/global_request_headers.rb

@@ -1,8 +1,8 @@
 module Webspicy
   class Specification
-    module Precondition
+    module Pre
       class GlobalRequestHeaders
-        include Precondition
+        include Pre
 
         DEFAULT_OPTIONS = {}
 
@@ -22,7 +22,7 @@ module Webspicy
           end
         end
 
-        def instrument(test_case, client)
+        def instrument
           extra = headers.reject{|k|
             test_case.headers.has_key?(k)
           }
@@ -30,6 +30,6 @@ module Webspicy
         end
 
       end # class GlobalRequestHeaders
-    end # module Precondition
+    end # module Pre
   end # class Specification
 end # module Webspicy

data/lib/webspicy/specification/{precondition → pre}/robust_to_invalid_input.rb

@@ -1,8 +1,8 @@
 module Webspicy
   class Specification
-    module Precondition
+    module Pre
       class RobustToInvalidInput
-        include Precondition
+        include Pre
 
         def self.match(service, pre)
           self.new
@@ -49,7 +49,7 @@ module Webspicy
                 status: Support::StatusRange.str("4xx")
               },
               :assert => []
-            })]            
+            })]
           else
             []
           end
@@ -63,6 +63,6 @@ module Webspicy
         end
 
       end # class RobustToInvalidInput
-    end # module Precondition
+    end # module Pre
   end # class Specification
 end # module Webspicy

data/lib/webspicy/specification/service.rb

@@ -10,6 +10,9 @@ module Webspicy
       end
       attr_accessor :specification
 
+      # Deprecated
+      alias :resource :specification
+
       def self.info(raw)
         new(raw)
       end
@@ -112,16 +115,37 @@ module Webspicy
         # Because we want pre & post to be able to match in all cases
         # we need at least one condition
         descriptions = [Condition::MATCH_ALL] if descriptions.empty?
-        conditions.map{|c|
+        mapping = {}
+        instances = conditions.map{|c|
           instance = nil
           descr = descriptions.find do |d|
             instance = c.match(self, d)
           end
-          if instance && instance.respond_to?(:matching_description=)
-            instance.matching_description = descr
-          end
-          instance
+          instance.tap{|i|
+            mapping[descr] ||= i if i
+            i.matching_description = descr if i.respond_to?(:matching_description=)
+          }
         }.compact
+        mapped = descriptions
+          .select{|d| mapping[d] }
+          .map{|d| mapping[d] }
+        unmapped = descriptions
+          .reject{|d| mapping[d] }
+          .select{|d| d.strip =~ /^(\(\w+\))?\(x\)/ }
+          .map{|d|
+            Postcondition::MissingConditionImpl.new.tap{|mc|
+              mc.matching_description = d
+            }
+          }
+        unexpected = descriptions
+          .select{|d| mapping[d] }
+          .select{|d| d.strip =~ /^(\(\w+\))?\( \)/ }
+          .map{|d|
+            Postcondition::UnexpectedConditionImpl.new.tap{|mc|
+              mc.matching_description = d
+            }
+          }
+        mapped + unmapped + unexpected
       end
 
       def bind_examples