webspicy 0.16.1 → 0.19.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

@@ -25,11 +25,12 @@ Specification = .Webspicy::Specification
   }
   <singleservice> {
     name            :? String
-    url             : String
+    url             :  String
     method          :  Method
     description     :  String
     preconditions   :? [String]|String
     postconditions  :? [String]|String
+    errconditions   :? [String]|String
     input_schema    :  Schema
     output_schema   :  Schema
     error_schema    :  Schema
@@ -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)
@@ -14,11 +16,13 @@ module Webspicy
 
     def self.singleservice(raw)
       converted = {
-        name: raw.has_key?(:name) ? raw[:name] : "Unamed specification",
+        name: raw[:name] || "Unamed specification",
         url: raw[:url],
-        services: [raw.reject{|k, _| k == :name || k == :url}]
+        services: [
+          Webspicy.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)
+        ]
       }
-      self.info(raw)
+      info(converted)
     end
 
     def located_at!(location)
@@ -44,7 +48,7 @@ module Webspicy
     end
 
     def services
-      @raw[:services]
+      @raw[:services] || []
     end
 
     def url_placeholders
@@ -60,10 +64,6 @@ module Webspicy
       [ url, rest ]
     end
 
-    def to_info
-      @raw
-    end
-
     def to_singleservice
       raise NotImplementedError
     end
@@ -85,7 +85,7 @@ module Webspicy
     end
 
     def bind_services
-      (@raw[:services] ||= []).each do |s|
+      services.each do |s|
         s.specification = self
       end
     end
@@ -93,7 +93,9 @@ module Webspicy
   end # class Specification
 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/test_case'
 require_relative 'specification/file_upload'

data/lib/webspicy/specification/condition.rb

@@ -0,0 +1,23 @@
+module Webspicy
+  class Specification
+    module Condition
+
+      MATCH_ALL = "__all__"
+
+      attr_accessor :matching_description
+
+      def to_s
+        if matching_description == MATCH_ALL
+          self.class.name
+        else
+          matching_description
+        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/errcondition.rb

@@ -0,0 +1,17 @@
+module Webspicy
+  class Specification
+    module Errcondition
+      include Condition
+
+      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

@@ -1,6 +1,7 @@
 module Webspicy
   class Specification
     module Postcondition
+      include Condition
 
       def self.match(service, descr)
       end

data/lib/webspicy/specification/precondition.rb

@@ -1,6 +1,7 @@
 module Webspicy
   class Specification
     module Precondition
+      include Condition
 
       def self.match(service, pre)
       end

data/lib/webspicy/specification/precondition/robust_to_invalid_input.rb

@@ -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,

data/lib/webspicy/specification/service.rb

@@ -1,13 +1,12 @@
 module Webspicy
   class Specification
     class Service
+      include Support::DataObject
 
       def initialize(raw)
-        @raw = raw
+        super(raw)
         bind_examples
         bind_counterexamples
-        @preconditions = compile_preconditions
-        @postconditions = compile_postconditions
       end
       attr_accessor :specification
 
@@ -15,6 +14,10 @@ module Webspicy
         new(raw)
       end
 
+      def config
+        specification.config
+      end
+
       def method
         @raw[:method]
       end
@@ -24,7 +27,7 @@ module Webspicy
       end
 
       def preconditions
-        @preconditions
+        @preconditions ||= compile_preconditions
       end
 
       def has_preconditions?
@@ -32,23 +35,31 @@ module Webspicy
       end
 
       def postconditions
-        @postconditions
+        @postconditions ||= compile_postconditions
       end
 
       def has_postconditions?
         !postconditions.empty?
       end
 
+      def errconditions
+        @errconditions ||= compile_errconditions
+      end
+
+      def has_errconditions?
+        !errconditions.empty?
+      end
+
       def default_example
         @raw[:default_example]
       end
 
       def examples
-        @raw[:examples]
+        @raw[:examples] || []
       end
 
       def counterexamples
-        @raw[:counterexamples]
+        @raw[:counterexamples] || []
       end
 
       def generated_counterexamples
@@ -76,49 +87,51 @@ module Webspicy
         input_schema.dress(params)
       end
 
-      def to_info
-        @raw
-      end
-
       def to_s
         "#{method} #{specification.url}"
       end
 
     private
 
-      def scope
-        Webspicy.current_scope
-      end
-
       def compile_preconditions
         @raw[:preconditions] = [@raw[:preconditions]] if @raw[:preconditions].is_a?(String)
-        compile_conditions(@raw[:preconditions] ||= [], scope.preconditions)
+        compile_conditions(@raw[:preconditions] ||= [], config.preconditions)
       end
 
       def compile_postconditions
         @raw[:postconditions] = [@raw[:postconditions]] if @raw[:postconditions].is_a?(String)
-        compile_conditions(@raw[:postconditions] ||= [], scope.postconditions)
+        compile_conditions(@raw[:postconditions] ||= [], config.postconditions)
+      end
+
+      def compile_errconditions
+        @raw[:errconditions] = [@raw[:errconditions]] if @raw[:errconditions].is_a?(String)
+        compile_conditions(@raw[:errconditions] ||= [], config.errconditions)
       end
 
       def compile_conditions(descriptions, conditions)
         # Because we want pre & post to be able to match in all cases
         # we need at least one condition
-        descriptions = ["all"] if descriptions.empty?
-        descriptions
-          .map{|descr|
-            conditions.map{|c| c.match(self, descr) }.compact
-          }
-          .flatten
+        descriptions = [Condition::MATCH_ALL] if descriptions.empty?
+        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
+        }.compact
       end
 
       def bind_examples
-        (@raw[:examples] ||= []).each do |ex|
+        examples.each do |ex|
           ex.bind(self, false)
         end
       end
 
       def bind_counterexamples
-        (@raw[:counterexamples] ||= []).each do |ex|
+        counterexamples.each do |ex|
           ex.bind(self, true)
         end
       end

data/lib/webspicy/specification/test_case.rb

@@ -1,23 +1,25 @@
 module Webspicy
   class Specification
     class TestCase
+      include Support::DataObject
 
       def initialize(raw)
-        @raw = raw
+        super(raw)
         @counterexample = nil
       end
       attr_reader :service
       attr_reader :counterexample
 
-      attr_accessor :raw
-      protected :raw, :raw=
-
       def bind(service, counterexample)
         @service = service
         @counterexample = counterexample
         self
       end
 
+      def example?
+        !@counterexample
+      end
+
       def counterexample?
         !!@counterexample
       end
@@ -87,6 +89,10 @@ module Webspicy
         expected_status === status
       end
 
+      def has_expected_status?
+        not expected[:status].nil?
+      end
+
       def expected_error
         expected[:error]
       end
@@ -111,19 +117,6 @@ module Webspicy
         !assert.empty?
       end
 
-      def to_info
-        @raw
-      end
-
-      def instrument(client)
-        service.preconditions.each do |pre|
-          pre.instrument(self, client)
-        end
-        service.postconditions.each do |post|
-          post.instrument(self, client) if post.respond_to?(:instrument)
-        end
-      end
-
       def mutate(override)
         m = self.dup
         m.raw = self.raw.merge(override)

data/lib/webspicy/support.rb

@@ -1,2 +1,24 @@
+module Webspicy
+  module Support
+
+    SORL_OPTS = { max: 5, wait: 0.05, raise: false }
+
+    def sooner_or_later(opts = nil)
+      opts = SORL_OPTS.merge(opts || {})
+      left, wait_ms = opts[:max], opts[:wait]
+      until (r = yield) || left == 0
+        sleep(wait_ms)
+        wait_ms, left = wait_ms*2, left - 1
+      end
+      raise TimeoutError, "Timeout on sooner-or-later" if r.nil? && opts[:raise]
+      r
+    end
+    module_function :sooner_or_later
+
+  end # module Support
+end # module Webspicy
+require_relative 'support/data_object'
 require_relative 'support/status_range'
 require_relative 'support/colorize'
+require_relative 'support/world'
+require_relative 'support/hooks'