webspicy 0.18.0 → 0.19.0

data/lib/webspicy/configuration/scope.rb

@@ -12,25 +12,28 @@ module Webspicy
       ###
 
       # 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
@@ -68,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
@@ -34,11 +39,6 @@ Specification = .Webspicy::Specification
     examples        :? [TestCase]
     counterexamples :? [TestCase]
   }
-  <info> {
-    name: String
-    url: String
-    services: [Service]
-  }
 
 Service =
     .Webspicy::Specification::Service <info> {

data/lib/webspicy/specification.rb

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

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

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/service.rb

@@ -111,12 +111,17 @@ module Webspicy
       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

data/lib/webspicy/specification/test_case.rb

@@ -16,6 +16,10 @@ module Webspicy
         self
       end
 
+      def example?
+        !@counterexample
+      end
+
       def counterexample?
         !!@counterexample
       end
@@ -85,6 +89,10 @@ module Webspicy
         expected_status === status
       end
 
+      def has_expected_status?
+        not expected[:status].nil?
+      end
+
       def expected_error
         expected[:error]
       end
@@ -109,15 +117,6 @@ module Webspicy
         !assert.empty?
       end
 
-      def instrument(client)
-        service.preconditions.each do |pre|
-          pre.instrument(self, client) if pre.respond_to?(:instrument)
-        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,3 +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'

data/lib/webspicy/support/hooks.rb

@@ -0,0 +1,65 @@
+module Webspicy
+  module Support
+    module Hooks
+
+      class Object
+        def initialize(config)
+          @config = config
+        end
+        attr_accessor :config
+        include Hooks
+      end
+
+      def self.for(config)
+        Object.new(config)
+      end
+
+      def fire_around(*args, &bl)
+        ls = config.listeners(:around_each)
+        if ls.size == 0
+          bl.call
+        elsif ls.size > 1
+          _fire_around(ls.first, ls[1..-1], args, &bl)
+        else
+          ls.first.call(*args, &bl)
+        end
+      end
+
+      def _fire_around(head, tail, args, &bl)
+        head.call(*args) do
+          if tail.empty?
+            bl.call
+          else
+            _fire_around(tail.first, tail[1..-1], args, &bl)
+          end
+        end
+      end
+      private :_fire_around
+
+      def fire_before_each(*args, &bl)
+        config.listeners(:before_each).each do |beach|
+          beach.call(*args, &bl)
+        end
+      end
+
+      def fire_after_each(*args, &bl)
+        config.listeners(:after_each).each do |aeach|
+          aeach.call(*args, &bl)
+        end
+      end
+
+      def fire_before_all(*args, &bl)
+        config.listeners(:before_all).each do |beach|
+          beach.call(*args, &bl)
+        end
+      end
+
+      def fire_after_all(*args, &bl)
+        config.listeners(:after_all).each do |aeach|
+          aeach.call(*args, &bl)
+        end
+      end
+
+    end # module Hooks
+  end # module Support
+end # module Webspicy

data/lib/webspicy/support/world.rb

@@ -0,0 +1,47 @@
+module Webspicy
+  module Support
+    class World < OpenStruct
+
+      def initialize(folder, config = nil)
+        super({})
+        @folder = folder
+        @config = config
+      end
+      attr_reader :folder, :config
+
+      def method_missing(name, *args, &bl)
+        return super if name =~ /=$/
+        file = ['json', 'yml', 'yaml', 'rb']
+          .map{|e| folder/"#{name}.#{e}" }
+          .find{|f| f.file? }
+        data = case file && file.ext
+        when /json/
+          JSON.parse(file.read, object_class: OpenStruct)
+        when /ya?ml/
+          JSON.parse(file.load.to_json, object_class: OpenStruct)
+        when /rb/
+          ::Kernel.eval(file.read).tap{|x|
+            x.config = self.config if x.is_a?(Item)
+          }
+        end
+        self.send(:"#{name}=", data)
+      end
+
+      def to_data(which)
+        case which
+        when Hash
+          OpenStruct.new(which)
+        when Array
+          which.map{|x| to_data(x) }
+        else
+          which
+        end
+      end
+
+      module Item
+        attr_accessor :config
+      end # module Item
+
+    end # class World
+  end # module Support
+end # module Webspicy

data/lib/webspicy/tester.rb

@@ -1,15 +1,148 @@
 module Webspicy
   class Tester
 
-    def self.new(*args, &bl)
-      require_relative 'rspec/tester'
-      RSpecTester.new(*args, &bl)
+    class FailFast < Exception; end
+
+    def initialize(config)
+      @config = Configuration.dress(config)
+      @scope = nil
+      @hooks = nil
+      @client = nil
+      @spec_file = nil
+      @specification = nil
+      @service = nil
+      @test_case = nil
+      @invocation = nil
+      @reporter = default_reporter
+    end
+    attr_reader :config, :scope, :hooks, :client
+    attr_reader :specification, :spec_file
+    attr_reader :service, :test_case
+    attr_reader :invocation, :result
+    attr_reader :reporter
+
+    def failfast?
+      config.failfast
+    end
+
+    def default_reporter
+      @reporter = Reporter::Composite.new
+      #@reporter << Reporter::Progress.new
+      @reporter << Reporter::Documentation.new
+      @reporter << Reporter::Exceptions.new
+      @reporter << Reporter::Summary.new
+      @reporter << Reporter::ErrorCount.new
+    end
+
+    def call
+      reporter.init(self)
+      begin
+        run_config
+      rescue FailFast
+      end
+      reporter.report
+      reporter.find(Reporter::ErrorCount).report
+    end
+
+  private
+
+    def run_config
+      config.each_scope do |scope|
+        @scope = scope
+        @hooks = Support::Hooks.for(scope.config)
+        @client = scope.get_client
+        reporter.before_all
+        @hooks.fire_before_all(@scope, @client)
+        reporter.before_all_done
+        reporter.before_scope
+        run_scope
+        reporter.scope_done
+        reporter.after_all
+        @hooks.fire_after_all(@scope, @client)
+        reporter.after_all_done
+      end
+    end
+
+    def run_scope
+      scope.each_specification_file do |spec_file|
+        @specification = load_specification(spec_file)
+        if @specification
+          reporter.before_specification
+          run_specification
+          reporter.specification_done
+          reporter.spec_file_done
+        elsif failfast?
+          raise FailFast
+        end
+      end
+    end
+
+    def load_specification(spec_file)
+      @spec_file = spec_file
+      reporter.before_spec_file
+      Webspicy.specification(spec_file.load, spec_file, scope)
+    rescue *PASSTHROUGH_EXCEPTIONS
+      raise
+    rescue Exception => e
+      reporter.spec_file_error(e)
+      nil
+    end
+
+    def run_specification
+      scope.each_service(specification) do |service|
+        @service = service
+        reporter.before_service
+        run_service
+        reporter.service_done
+      end
+    end
+
+    def run_service
+      scope.each_testcase(service) do |test_case|
+        @test_case = test_case
+        reporter.before_test_case
+        run_test_case
+        reporter.test_case_done
+      end
+    end
+
+    def run_test_case
+      hooks.fire_around(test_case, client) do
+        reporter.before_each
+        hooks.fire_before_each(test_case, client)
+        reporter.before_each_done
+
+        reporter.before_instrument
+        client.instrument(test_case)
+        reporter.instrument_done
+
+        reporter.before_invocation
+        @invocation = client.call(test_case)
+        reporter.invocation_done
+
+        reporter.before_assertions
+        check_invocation
+        reporter.assertions_done
+
+        reporter.after_each
+        hooks.fire_after_each(test_case, @invocation, client)
+        reporter.after_each_done
+
+        raise FailFast if !result.success? and failfast?
+      end
+    end
+
+    def check_invocation
+      @result = Result.from(self)
     end
 
   end # class Tester
 end # module Webspicy
+require_relative 'tester/reporter'
 require_relative 'tester/client'
 require_relative 'tester/invocation'
+require_relative 'tester/result'
 require_relative 'tester/failure'
 require_relative 'tester/assertions'
 require_relative 'tester/asserter'
+require_relative 'tester/file_checker'