webspicy 0.20.3 → 0.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438c8ad5287da851bcbfe71f39fb3f53288949e16e4ba0e5c9fbdb12874c141c
-  data.tar.gz: 1b575f4fa2d1b434885fe8a13f41c9975fb9e1d9528cc44cf0d08fa7b36e2306
+  metadata.gz: 9afe697a47ba4391d2e059f1bf3707c04f97f9d6fd50557104a59c6602dbd75c
+  data.tar.gz: 66ec4036f8e76dad7af0f8b0cf83ea139a67a7b1020aa0a304c26fdc9402d593
 SHA512:
-  metadata.gz: 8d0d6d54fedfa5bb9ad1ba6aa1178b8e33db677ff1db5f3f56da73a6df75ee0523f08e6f04916669ce1fe13149c86ebdf826780e5520332c2d0211c95ee25f94
-  data.tar.gz: d33ffb74de8d5d8e0f57af996b49aeb177beff8403f9ab5c22231cc77228112efa47c8373b1d55e957832f414c32b5cf42dbeca0ca58d27ffb037ecbf8c045d8
+  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/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/post/missing_condition_impl.rb

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

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

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

data/lib/webspicy/support/colorize.rb

@@ -3,11 +3,17 @@ module Webspicy
     module Colorize
 
       def colorize(str, kind, config = nil)
+        return str if config && !config.colorize
         color = (config || self.config).colors[kind]
         ColorizedString[str].colorize(color)
       end
       module_function :colorize
 
+      def colorize_section(str, cfg = nil)
+        colorize(str, :section, cfg)
+      end
+      module_function :colorize_section
+
       def colorize_highlight(str, cfg = nil)
         colorize(str, :highlight, cfg)
       end

data/lib/webspicy/tester.rb

@@ -15,7 +15,7 @@ module Webspicy
       @test_case = nil
       @invocation = nil
       @invocation_error = nil
-      @reporter = default_reporter
+      @reporter = @config.reporter
     end
     attr_reader :config, :scope, :hooks, :client
     attr_reader :specification, :spec_file
@@ -31,15 +31,6 @@ module Webspicy
       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
@@ -50,6 +41,11 @@ module Webspicy
       reporter.find(Reporter::ErrorCount).report
     end
 
+    def call!
+      res = call
+      abort("KO") unless res == 0
+    end
+
     def find_and_call(method, url, mutation)
       unless tc = scope.find_test_case(method, url)
         raise Error, "No such service `#{method} #{url}`"
@@ -73,19 +69,15 @@ module Webspicy
         @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
+      reporter.before_all
+      hooks.fire_before_all(self)
+      reporter.before_all_done
+      reporter.before_scope
       scope.each_specification_file do |spec_file|
         @specification = load_specification(spec_file)
         if @specification
@@ -97,6 +89,10 @@ module Webspicy
           raise FailFast
         end
       end
+      reporter.scope_done
+      reporter.after_all
+      hooks.fire_after_all(self)
+      reporter.after_all_done
     end
 
     def load_specification(spec_file)

data/lib/webspicy/tester/reporter.rb

@@ -66,6 +66,11 @@ module Webspicy
         }
       end
 
+      def find(kind)
+        return self if self.is_a?(kind)
+        raise "Missing reporter #{kind}"
+      end
+
     protected
 
       def plural(word, count)

data/lib/webspicy/tester/reporter/documentation.rb

@@ -4,40 +4,56 @@ module Webspicy
       class Documentation < Reporter
 
         module Helpers
+          INDENT = "  ".freeze
+
+          def spec_file_line(spec_file)
+            relative_path = Path(spec_file).relative_to(config.folder)
+            colorize_section(">> #{relative_path}", config)
+          end
+
           def spec_file_error_line(spec_file, ex)
-            str = colorize_highlight(spec_file.to_s)
-            str += "\n  " + colorize_error("X  #{ex.message}")
+            str = ""
+            str += colorize_error(INDENT + "X  #{ex.message}", config)
             if ex.root_cause && ex.root_cause != ex
-              str += "\n    " + colorize_error("#{ex.root_cause.message}")
+              str += "\n"
+              str += INDENT + colorize_error("#{ex.root_cause.message}", config)
             end
             str
           end
 
           def service_line(service, test_case)
-            str = service.to_s + ", " + test_case.to_s
-            str = colorize_highlight(str)
+            str = "#{service}, #{test_case}"
+            str = colorize_highlight(str, config)
           end
 
           def check_success_line(check)
-            "  " + colorize_success("v") + "  " + check.behavior
+            INDENT + colorize_success("v  " + check.behavior, config)
           end
 
           def check_failure_line(check, ex)
-            "  " + colorize_error("F  " + ex.message)
+            INDENT + colorize_error("F  " + ex.message, config)
           end
 
           def check_error_line(check, ex)
-            "  " + colorize_error("E  " + ex.message)
+            INDENT + colorize_error("E  " + ex.message, config)
           end
         end
         include Helpers
 
         def spec_file_error(e)
+          io.puts spec_file_line(spec_file)
+          io.puts
           io.puts spec_file_error_line(spec_file, e)
           io.puts
           io.flush
         end
 
+        def before_service
+          io.puts spec_file_line(spec_file)
+          io.puts
+          io.flush
+        end
+
         def before_test_case
           io.puts service_line(service, test_case)
           io.flush

data/lib/webspicy/tester/reporter/error_count.rb

@@ -5,18 +5,22 @@ module Webspicy
 
         def initialize(*args, &bl)
           super
-          @error_count = 0
+          @errors = Hash.new{|h,k| 0 }
         end
+        attr_reader :errors
 
-        def on_error(*args, &bl)
-          @error_count += 1
+        [
+          :spec_file_error,
+          :check_error,
+          :check_failure
+        ].each do |meth|
+          define_method(meth) do |*args, &bl|
+            @errors[meth] += 1
+          end
         end
-        alias :spec_file_error :on_error
-        alias :check_failure   :on_error
-        alias :check_error     :on_error
 
         def report
-          @error_count
+          @errors.values.inject(0){|memo,x| memo+x }
         end
 
       end # class ErrorCount

data/lib/webspicy/tester/reporter/file_progress.rb

@@ -4,12 +4,12 @@ module Webspicy
       class FileProgress < Reporter
 
         def spec_file_error(e)
-          io.print colorize_error("X")
+          io.print colorize_error("X", config)
           io.flush
         end
 
         def spec_file_done
-          io.print colorize_success(".")
+          io.print colorize_success(".", config)
           io.flush
         end
 

data/lib/webspicy/tester/reporter/file_summary.rb

@@ -22,9 +22,9 @@ module Webspicy
           msg = "#{plural('spec file', spec_files_count)}, "\
                 "#{plural('error', errors_count)}"
           if success?
-            msg = colorize_success(msg)
+            msg = colorize_success(msg, config)
           else
-            msg = colorize_error(msg)
+            msg = colorize_error(msg, config)
           end
           io.puts(msg)
           io.puts

data/lib/webspicy/tester/reporter/progress.rb

@@ -4,16 +4,16 @@ module Webspicy
       class Progress < Reporter
 
         def spec_file_error(e)
-          io.print colorize_error("X")
+          io.print colorize_error("X", config)
         end
 
         def after_each_done
           if result.success?
-            io.print colorize_success(".")
+            io.print colorize_success(".", config)
           elsif result.failure?
-            io.print colorize_error("F")
+            io.print colorize_error("F", config)
           elsif result.error?
-            io.print colorize_error("E")
+            io.print colorize_error("E", config)
           end
           io.flush
         end

data/lib/webspicy/tester/reporter/summary.rb

@@ -9,18 +9,21 @@ module Webspicy
           @examples_count = 0
           @counterexamples_count = 0
           @assertions_count = 0
+          #
+          @spec_file_errors_count = 0
           @errors_count = 0
           @failures_count = 0
         end
         attr_reader :spec_files_count, :examples_count, :counterexamples_count
-        attr_reader :assertions_count, :errors_count, :failures_count
+        attr_reader :assertions_count
+        attr_reader :spec_file_errors_count, :errors_count, :failures_count
 
         def before_spec_file
           @spec_files_count += 1
         end
 
         def spec_file_error(e)
-          @errors_count += 1
+          @spec_file_errors_count += 1
         end
 
         def after_each_done
@@ -42,19 +45,17 @@ module Webspicy
                 "#{plural('error', errors_count)}, "\
                 "#{plural('failure', failures_count)}"
           if success?
-            msg = colorize_success(msg)
+            msg = colorize_success(msg, config)
           else
-            msg = colorize_error(msg)
+            msg = colorize_error(msg, config)
           end
           io.puts(msg)
           io.puts
           io.flush
         end
 
-      private
-
         def success?
-          @errors_count == 0 && @failures_count == 0
+          @spec_file_errors_count == 0 && @errors_count == 0 && @failures_count == 0
         end
 
       end # class Summary

data/lib/webspicy/tester/result/errcondition_met.rb

@@ -18,9 +18,7 @@ module Webspicy
         end
 
         def call
-          if err = post.check!
-            _! err
-          end
+          post.check!
         end
 
       end # class ErrconditionMet

data/lib/webspicy/tester/result/postcondition_met.rb

@@ -18,9 +18,7 @@ module Webspicy
         end
 
         def call
-          if err = post.check!
-            _! err
-          end
+          post.check!
         end
 
       end # class PostconditionMet

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 20
-    TINY  = 3
+    TINY  = 4
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/blackbox/commandline.yml

@@ -0,0 +1,24 @@
+---
+command:
+  webspicy {options} {args}
+
+examples:
+
+- description: |-
+    when called on a passing path
+  args:
+  - ./fixtures/passing/config.rb
+  assert:
+    exit_code:
+      0
+    stdout: |-
+      GET /, when requested
+        v  It has a 200 response status
+        v  It has a `Content-Type: application/json` response header
+        v  Its output meets the expected data schema
+        v  Assert notEmpty
+        v  Assert pathFD('', :hello => "World" )
+
+
+      1 spec file, 1 example, 0 counterexample
+      5 assertions, 0 error, 0 failure

data/spec/blackbox/fixtures/passing/config.rb

@@ -0,0 +1,9 @@
+Webspicy::Configuration.new(Path.dir) do |c|
+  app = ->(env){
+    [ 200,
+      {"Content-Type" => "application/json"},
+      [ {hello: "World"}.to_json ]
+    ]
+  }
+  c.client = Webspicy::Tester::RackTestClient.for(app)
+end

data/spec/blackbox/fixtures/passing/formaldef/get.yml

@@ -0,0 +1,30 @@
+---
+url: |-
+  /
+
+method: |-
+  GET
+
+description: |-
+  Returns hello world
+
+input_schema: |-
+  { }
+
+output_schema: |-
+  { hello: String }
+
+error_schema: |-
+  .
+
+examples:
+
+  - description: |-
+      when requested
+    params: {}
+    expected:
+      content_type: application/json
+      status: 200
+    assert:
+      - notEmpty
+      - pathFD('', :hello => "World" )

data/tasks/test.rake

@@ -18,7 +18,8 @@ namespace :test do
     desc "Runs the integration tests on the #{file.basename} example"
     task(test_name) do
       Bundler.with_original_env do
-        system("cd #{file} && bundle exec rake")
+        x = system("cd #{file} && bundle exec rake")
+        abort("Example test suite failed: #{file}") unless x
       end
     end
     tests << test_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 0.20.4
 platform: ruby
 authors:
 - Bernard Lambeau
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -126,22 +126,22 @@ dependencies:
   name: rack-robustness
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: mustermann
   requirement: !ruby/object:Gem::Requirement
@@ -284,6 +284,9 @@ files:
 - lib/webspicy/web/mocker/config.ru
 - lib/webspicy/web/openapi.rb
 - lib/webspicy/web/openapi/generator.rb
+- spec/blackbox/commandline.yml
+- spec/blackbox/fixtures/passing/config.rb
+- spec/blackbox/fixtures/passing/formaldef/get.yml
 - spec/spec_helper.rb
 - spec/unit/configuration/config.rb
 - spec/unit/configuration/scope/test_each_service.rb
@@ -317,7 +320,7 @@ homepage: http://github.com/enspirit/webspicy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -332,8 +335,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!
 test_files: []