webspicy 0.16.3 → 0.20.1

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,72 @@ 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
+        descriptions = [Condition::MATCH_ALL] if descriptions.empty?
+        mapping = {}
+        instances = conditions.map{|c|
+          instance = nil
+          descr = descriptions.find do |d|
+            instance = c.match(self, d)
+          end
+          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
+            }
           }
-          .flatten
+        mapped + unmapped + unexpected
       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,34 @@
+module Webspicy
+  module Support
+
+    SORL_OPTS = { max: 5, wait: 0.05, raise: false }
+
+    def sooner_or_later(opts = nil, &bl)
+      opts = SORL_OPTS.merge(opts || {})
+      left, wait_ms = opts[:max], opts[:wait]
+      r = _sooner_or_later(&bl)
+      until (r && !r.is_a?(Tester::Failure)) || left == 0
+        sleep(wait_ms)
+        wait_ms, left = wait_ms*2, left - 1
+        r = _sooner_or_later(&bl)
+      end
+      raise r if r.is_a?(Tester::Failure)
+      raise TimeoutError, "Timeout on sooner-or-later" if r.nil? && opts[:raise]
+      r
+    end
+    module_function :sooner_or_later
+
+    def _sooner_or_later(&bl)
+      bl.call
+    rescue Tester::Failure => ex
+      ex
+    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/data_object.rb

@@ -0,0 +1,25 @@
+module Webspicy
+  module Support
+    module DataObject
+
+      def initialize(raw)
+        @raw = raw
+      end
+      attr_accessor :raw
+      protected :raw, :raw=
+
+      def method_missing(name, *args, &bl)
+        if @raw.has_key?(name) && args.empty? && bl.nil?
+          @raw[name]
+        else
+          super
+        end
+      end
+
+      def to_info
+        @raw
+      end
+
+    end # module DataObject
+  end # module Support
+end # module Webspicy

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,89 +1,209 @@
 module Webspicy
   class Tester
-    include Webspicy::Support::Colorize
+    extend Forwardable
+
+    class FailFast < Exception; end
 
     def initialize(config)
       @config = Configuration.dress(config)
-      @test_suite = load
+      @scope = nil
+      @hooks = nil
+      @client = nil
+      @spec_file = nil
+      @specification = nil
+      @service = nil
+      @test_case = nil
+      @invocation = nil
+      @invocation_error = nil
+      @reporter = default_reporter
     end
-    attr_reader :config
+    attr_reader :config, :scope, :hooks, :client
+    attr_reader :specification, :spec_file
+    attr_reader :service, :test_case
+    attr_reader :invocation, :invocation_error, :result
+    attr_reader :reporter
+
+    def_delegators :@config, *[
+      :world
+    ]
 
-    def call(err=$stderr, out=$stdout)
-      $_rspec_core_load_started_at = nil
-      options = RSpec::Core::ConfigurationOptions.new(config.rspec_options)
-      conf = RSpec::Core::Configuration.new
-      RSpec::Core::Runner.new(options, conf).run(err, out)
+    def failfast?
+      config.failfast
     end
 
-  # protected
+    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 load
-      tester = self
-      RSpec.reset
-      rspec_config!
-      RSpec.describe "" do
-        before(:all) do
-          tester.config.listeners(:before_all).each do |l|
-            l.call(tester.config)
-          end
-        end
-        after(:all) do
-          tester.config.listeners(:after_all).each do |l|
-            l.call(tester.config)
-          end
-        end
-        tester.config.each_scope do |scope|
-          client = scope.get_client
-          scope.each_specification do |specification|
-            scope.each_service(specification) do |service|
-              tester.rspec_service!(self, service, client, scope)
-            end
-          end
+    def call
+      reporter.init(self)
+      begin
+        run_config
+      rescue FailFast
+      end
+      reporter.report
+      reporter.find(Reporter::ErrorCount).report
+    end
+
+    def find_and_call(method, url, mutation)
+      unless tc = scope.find_test_case(method, url)
+        raise Error, "No such service `#{method} #{url}`"
+      end
+      mutated = tc.mutate(mutation)
+      fork_tester(test_case: mutated) do |t|
+        instrumented = t.instrument_test_case
+        t.client.call(instrumented)
+      end
+    end
+
+  protected
+
+    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(self)
+        reporter.before_all_done
+        reporter.before_scope
+        run_scope
+        reporter.scope_done
+        reporter.after_all
+        @hooks.fire_after_all(self)
+        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
-      self
     end
 
-    def rspec_service!(on, service, client, scope)
+    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|
-        str = "#{service} #{test_case}"
-        str = colorize_highlight(str)
-        on.describe(str) do
-          include_examples 'a successful test case invocation', client, test_case
-        end
+        @test_case = test_case
+        reporter.before_test_case
+        run_test_case
+        reporter.test_case_done
       end
     end
 
-    def rspec_config!
-      RSpec.shared_examples "a successful test case invocation" do |client, test_case|
-
-        around(:each) do |example|
-          client.around(test_case) do
-            client.before(test_case)
-            test_case.instrument(client)
-            client.instrument(test_case)
-            @response = client.call(test_case)
-            @invocation = Tester::Invocation.new(test_case, @response, client)
-            example.run
-            client.after(test_case, @invocation)
-            @invocation
-          end
-        end
+    def run_test_case
+      hooks.fire_around(self) do
+        reporter.before_each
+        hooks.fire_before_each(self)
+        reporter.before_each_done
 
-        let(:invocation) do
-          @invocation
-        end
+        reporter.before_instrument
+        instrument_test_case
+        reporter.instrument_done
 
-        it "meets its specification" do
-          raise "Test not ran" unless invocation.done?
-          invocation.rspec_assert!(self)
-        end
+        call_test_case_target
+
+        reporter.before_assertions
+        check_invocation
+        reporter.assertions_done
+
+        reporter.after_each
+        hooks.fire_after_each(self)
+        reporter.after_each_done
+
+        raise FailFast if !result.success? and failfast?
       end
     end
 
+    def call_test_case_target
+      reporter.before_invocation
+      @invocation = client.call(test_case)
+      reporter.invocation_done
+    rescue *PASSTHROUGH_EXCEPTIONS
+      raise
+    rescue => ex
+      @invocation_error = ex
+      reporter.invocation_done
+    end
+
+    def instrument_test_case
+      service = test_case.service
+      service.preconditions.each do |pre|
+        instrument_one(pre)
+      end
+      service.postconditions.each do |post|
+        instrument_one(post)
+      end if test_case.example?
+      service.errconditions.each do |err|
+        instrument_one(err)
+      end if test_case.counterexample?
+      config.listeners(:instrument).each do |i|
+        i.call(self)
+      end
+      test_case
+    end
+
+    def instrument_one(condition)
+      condition.bind(self).instrument
+    rescue ArgumentError
+      raise "#{condition.class} implements old PRE/POST contract"
+    end
+
+    def check_invocation
+      @result = Result.from(self)
+    end
+
+    def fork_tester(binding = {})
+      yield dup.tap{|t|
+        binding.each_pair do |k,v|
+          t.send(:"#{k}=", v)
+        end
+      }
+    end
+
+  private
+
+    attr_writer :test_case
+
   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'