webspicy 0.16.2 → 0.20.0

data/lib/webspicy/configuration/scope.rb

@@ -7,38 +7,33 @@ module Webspicy
       end
       attr_reader :config
 
-      def preconditions
-        config.preconditions
-      end
-
-      def postconditions
-        config.postconditions
-      end
-
       ###
       ### Eachers -- Allow navigating the web service definitions
       ###
 
       # Yields each specification file in the current scope
-      def each_specification_file(&bl)
-        return enum_for(:each_specification_file) unless block_given?
-        _each_specification_file(config, &bl)
+      def each_specification_file(apply_filter = true, &bl)
+        return enum_for(:each_specification_file, apply_filter) unless block_given?
+        _each_specification_file(config, apply_filter, &bl)
       end
 
       # Recursive implementation of `each_specification_file` for each
       # folder in the configuration.
-      def _each_specification_file(config)
+      def _each_specification_file(config, apply_filter = true)
         folder = config.folder
-        folder.glob("**/*.yml").select(&to_filter_proc(config.file_filter)).each do |file|
+        world  = config.folder/"world"
+        fs = folder.glob("**/*.yml").reject{|f| f.to_s.start_with?(world.to_s) }
+        fs = fs.select(&to_filter_proc(config.file_filter)) if apply_filter
+        fs.each do |file|
           yield file, folder
         end
       end
       private :_each_specification_file
 
       # Yields each specification in the current scope in turn.
-      def each_specification(&bl)
-        return enum_for(:each_specification) unless block_given?
-        each_specification_file do |file, folder|
+      def each_specification(apply_filter = true, &bl)
+        return enum_for(:each_specification, apply_filter) unless block_given?
+        each_specification_file(apply_filter) do |file, folder|
           yield Webspicy.specification(file.load, file, self)
         end
       end
@@ -76,6 +71,17 @@ module Webspicy
         each_generated_counterexamples(service, &bl)
       end
 
+      def find_test_case(method, url)
+        each_specification(false) do |spec|
+          next unless spec.url == url
+          spec.services.each do |service|
+            next unless service.method == method
+            return service.examples.first
+          end
+        end
+        nil
+      end
+
       ###
       ### Schemas -- For parsing input and output data schemas found in
       ### web service definitions

data/lib/webspicy/formaldoc.fio

@@ -18,6 +18,11 @@ FileUpload =
     }
 
 Specification = .Webspicy::Specification
+  <info> {
+    name: String
+    url: String
+    services: [Service]
+  }
   <singleservice> {
     name            :? String
     url             :  String
@@ -25,6 +30,7 @@ Specification = .Webspicy::Specification
     description     :  String
     preconditions   :? [String]|String
     postconditions  :? [String]|String
+    errconditions   :? [String]|String
     input_schema    :  Schema
     output_schema   :  Schema
     error_schema    :  Schema
@@ -33,11 +39,6 @@ Specification = .Webspicy::Specification
     examples        :? [TestCase]
     counterexamples :? [TestCase]
   }
-  <info> {
-    name: String
-    url: String
-    services: [Service]
-  }
 
 Service =
     .Webspicy::Specification::Service <info> {
@@ -45,6 +46,7 @@ Service =
         description     :  String
         preconditions   :? [String]|String
         postconditions  :? [String]|String
+        errconditions   :? [String]|String
         input_schema    :  Schema
         output_schema   :  Schema
         error_schema    :  Schema

data/lib/webspicy/specification.rb

@@ -1,11 +1,13 @@
 module Webspicy
   class Specification
+    include Support::DataObject
 
     def initialize(raw, location = nil)
-      @raw = raw
+      super(raw)
       @location = location
       bind_services
     end
+    attr_accessor :config
     attr_reader :location
 
     def self.info(raw)
@@ -46,7 +48,7 @@ module Webspicy
     end
 
     def services
-      @raw[:services]
+      @raw[:services] || []
     end
 
     def url_placeholders
@@ -62,10 +64,6 @@ module Webspicy
       [ url, rest ]
     end
 
-    def to_info
-      @raw
-    end
-
     def to_singleservice
       raise NotImplementedError
     end
@@ -87,7 +85,7 @@ module Webspicy
     end
 
     def bind_services
-      (@raw[:services] ||= []).each do |s|
+      services.each do |s|
         s.specification = self
       end
     end
@@ -95,7 +93,10 @@ module Webspicy
   end # class Specification
 end # module Webspicy
 require_relative 'specification/service'
-require_relative 'specification/precondition'
-require_relative 'specification/postcondition'
+require_relative 'specification/condition'
+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

@@ -0,0 +1,48 @@
+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
+        else
+          matching_description
+        end
+      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,29 @@
+module Webspicy
+  class Specification
+    module Oldies
+      class Bridge
+        include Condition
+
+        def initialize(target)
+          @target = target
+        end
+        attr_reader :target
+
+        def instrument
+          target.instrument(test_case, client)
+        end
+
+        def check!
+          target.check(invocation)
+        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/oldies/errcondition.rb

@@ -0,0 +1,22 @@
+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
+
+      def instrument(test_case, client)
+      end
+
+      def check(invocation)
+      end
+
+    end # module Errcondition
+  end # module Specification
+end # module Webspicy

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

@@ -1,6 +1,12 @@
 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,6 +1,12 @@
 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
@@ -15,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\)/, "<!>")
+          raise "#{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>")
+          raise "#{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
@@ -40,7 +40,7 @@ module Webspicy
         def empty_input_counterexamples(service, first)
           placeholders = service.specification.url_placeholders
           empty_input = first.params.reject{|k| !placeholders.include?(k) }
-          if !empty_input.empty? && invalid_input?(service, empty_input)
+          if invalid_input?(service, empty_input)
             [first.mutate({
               :description => "it is robust to an invalid empty input (RobustToInvalidInput)",
               :dress_params => false,
@@ -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