webspicy 0.20.2 → 0.20.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0039cf2e5ebbb990cc29c6ed76e4eabf941feeb031f4761d30e120f32e31a41f'
-  data.tar.gz: c743e9f1650e7d9a09bef50d54e2e35e261761b085456d4bd8b4f7a6060f5304
+  metadata.gz: 890e7c6106835b720e92b9282f0425006c4a5e0749f06dde5111ed47a08d5ab0
+  data.tar.gz: aa48c031524976b874a76a366994cc91245fc2ed68a9e63412960ff21447d2f9
 SHA512:
-  metadata.gz: d9a039f3919a201378847ab7db291dcd72a345d594d11900e941f65c6c9e211825851778c4dea9969c2dc1ed88d80ae177af03f977e9437eba15471acd111127
-  data.tar.gz: 61347ee21583f15bb966e279221604fe6b7f89c2a2833bc7dfa92d062ff238b2f26949b89674c97eb651d09d435610d5bf5689bf8596b4ed75a6ea4e4a1a981c
+  metadata.gz: 4e881fd94d9bcc3aae7a90f558a95c85affcc12655e56bc816c64a4ede8519a24bacc7ef9a7edb03195aeae0c61d62e3575a7b0ec99b26773138b3b5dcd0ead0
+  data.tar.gz: 72f0902d4121bea8bbe994038191dc7f688547dc90aad9ffc7ed94ff12d7dc925daba4aaafcf3e1736d845406c38411774e500c750a34addbdf0dbf42d2bf38f

data/bin/webspicy

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #/
 #/ Document & test web services as black-box operations.
-#/ (c) Enspirit SRL. Distributed under MIT licence.
+#/ Webspicy vVERSION, (c) Enspirit SRL. Distributed under MIT licence.
 #/
 #/ Usage: webspicy [options] URL                 # run default test againt url
 #/ Usage: webspicy [options] path/to/config.rb   # run whole test suite
@@ -28,7 +28,7 @@ require 'optparse'
 
 def showhelp
   file = __FILE__
-  exec "grep ^#/<'#{file}'|cut -c4-"
+  exec "grep ^#/<'#{file}'|cut -c4-|sed s/VERSION/#{Webspicy::VERSION}/g"
 end
 
 ARGV.options do |opts|
@@ -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/finitio/webspicy/shared.fio

@@ -0,0 +1,10 @@
+@import finitio/data
+
+Tag = String( s | s.length > 0 )
+
+Schema =
+    .Finitio::System <fio> String
+      \( s | ::Webspicy.schema(s) )
+      \( s | raise "Unsupported"  )
+
+Params = .Array|.Hash

data/lib/webspicy.rb

@@ -7,7 +7,7 @@ require 'ostruct'
 require 'yaml'
 require 'rack/test'
 require 'mustermann'
-require 'colorized_string'
+require 'paint'
 require 'securerandom'
 require 'forwardable'
 module Webspicy
@@ -21,22 +21,10 @@ module Webspicy
   require 'webspicy/specification'
   require 'webspicy/configuration'
   require 'webspicy/tester'
-  require 'webspicy/web'
 
   class Error < StandardError; end
   class TimeoutError < Error; end
 
-  ###
-  ### Backward compatibility
-  ###
-  Client = Tester::Client
-  HttpClient = Web::HttpClient
-  RackTestClient = Web::RackTestClient
-  Resource = Specification
-  FileUpload = Specification::FileUpload
-  Scope = Configuration::Scope
-  Checker = Tester::FileChecker
-
   ###
   ### About folders
   ###
@@ -49,10 +37,11 @@ module Webspicy
   ### About formal doc and specifications defined there
   ###
   Finitio.stdlib_path(Path.dir/"finitio")
+
   DEFAULT_SYSTEM = Finitio.system(<<~FIO)
     @import webspicy/scalars
   FIO
-  FORMALDOC = Finitio.system(Path.dir/("webspicy/formaldoc.fio"))
+
 
   ###
   ### Exceptions that we let pass during testing
@@ -66,45 +55,6 @@ module Webspicy
   end
   module_function :default_scope
 
-  def specification(raw, file = nil, scope = default_scope)
-    raw = YAML.load(raw) if raw.is_a?(String)
-    with_scope(scope) do
-      r = FORMALDOC["Specification"].dress(raw)
-      r.config = scope.config
-      r.located_at!(file) if file
-      r
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex, scope)
-  end
-  module_function :specification
-
-  def service(raw, scope = default_scope)
-    with_scope(scope) do
-      FORMALDOC["Service"].dress(raw)
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex)
-  end
-  module_function :service
-
-  def test_case(raw, scope = default_scope)
-    with_scope(scope) do
-      FORMALDOC["TestCase"].dress(raw)
-    end
-  rescue Finitio::Error => ex
-    handle_finitio_error(ex)
-  end
-  module_function :test_case
-
-  def handle_finitio_error(ex, scope)
-    # msg = "#{ex.message}:\n    #{ex.root_cause.message}"
-    # msg = Support::Colorize.colorize_error(msg, scope.config)
-    # fatal(msg)
-    raise
-  end
-  module_function :handle_finitio_error
-
   #
   # Yields the block after having installed `scope` globally.
   #
@@ -185,4 +135,23 @@ module Webspicy
   end
   module_function :fatal
 
+  require 'webspicy/web'
+
+  ###
+  ### Backward compatibility
+  ###
+  Client = Tester::Client
+  HttpClient = Web::HttpClient
+  RackTestClient = Web::RackTestClient
+  Resource = Specification
+  FileUpload = Web::Specification::FileUpload
+  Scope = Configuration::Scope
+  Checker = Tester::FileChecker
+
+  [:specification, :service, :test_case].each do |meth|
+    define_method(meth) do |*args, &bl|
+      Webspicy::Web.send(meth, *args, &bl)
+    end
+    module_function(meth)
+  end
 end

data/lib/webspicy/configuration.rb

@@ -33,12 +33,16 @@ 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
+      @factory = Webspicy::Web
       @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 +51,8 @@ module Webspicy
     protected :folder=
 
     attr_accessor :colors
+    attr_accessor :colorize
+
     attr_reader :world
 
     def self.dress(arg, &bl)
@@ -104,6 +110,7 @@ module Webspicy
       end
     end
 
+    attr_accessor :factory
     attr_accessor :scope_factory
 
     def factor_scope
@@ -434,6 +441,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
@@ -34,7 +35,7 @@ module Webspicy
       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)
+          yield config.factory.specification(file.load, file, self)
         end
       end
 
@@ -137,7 +138,7 @@ module Webspicy
           return example unless service.default_example
           h1 = service.default_example.to_info
           h2 = example.to_info
-          ex = Specification::TestCase.new(merge_maps(h1, h2))
+          ex = config.factory.test_case(merge_maps(h1, h2), self)
           ex.bind(service, example.counterexample?)
         end
 

data/lib/webspicy/configuration/single_url.rb

@@ -10,37 +10,47 @@ module Webspicy
         end
         attr_reader :url
 
-        def each_specification(&bl)
+        def each_specification_file(*args, &bl)
+          return enum_for(:each_specification_file) unless block_given?
+          yield Path.tempfile(["specification",".yml"]).tap{|f|
+            f.write(specification_src)
+          }
+        end
+
+        def each_specification(*args, &bl)
           return enum_for(:each_specification) unless block_given?
-          spec = <<~YML
+          yield config.factory.specification(specification_src, nil, self)
+        end
+
+        def specification_src
+          <<~YML.tap{|s| Webspicy.debug(s) }
           ---
-          name: |-
-            Default specification
+          description: |-
+            Getting #{url}
+
           url: |-
             #{url}
 
-          services:
-          - method: |-
-              GET
-            description: |-
-              Getting #{url}
-
-            input_schema: |-
-              Any
-            output_schema: |-
-              Any
-            error_schema: |-
-              Any
-
-            examples:
-              - description: |-
-                  it returns a 200
-                params: {}
-                expected:
-                  status: 200
+          method: |-
+            GET
+
+          input_schema: |-
+            Any
+
+          output_schema: |-
+            Any
+
+          error_schema: |-
+            Any
+
+          examples:
+
+            - description: |-
+                it returns a 200
+              params: {}
+              expected:
+                status: 200
           YML
-          Webspicy.debug(spec)
-          yield Webspicy.specification(spec, nil, self)
         end
 
       end # class SingleUrlScope

data/lib/webspicy/configuration/single_yml_file.rb

@@ -10,9 +10,14 @@ module Webspicy
         end
         attr_reader :file
 
-        def each_specification(&bl)
+        def each_specification_file(*args, &bl)
+          return enum_for(:each_specification_file) unless block_given?
+          yield(file)
+        end
+
+        def each_specification(*args, &bl)
           return enum_for(:each_specification) unless block_given?
-          yield Webspicy.specification(file.read, nil, self)
+          yield config.factory.specification(file.read, nil, self)
         end
 
       end # class SingleYmlFileScope

data/lib/webspicy/specification.rb

@@ -10,21 +10,6 @@ module Webspicy
     attr_accessor :config
     attr_reader :location
 
-    def self.info(raw)
-      new(raw)
-    end
-
-    def self.singleservice(raw)
-      converted = {
-        name: raw[:name] || "Unamed specification",
-        url: raw[:url],
-        services: [
-          Webspicy.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)
-        ]
-      }
-      info(converted)
-    end
-
     def located_at!(location)
       @location = Path(location)
     end
@@ -39,51 +24,12 @@ module Webspicy
       @raw[:name]
     end
 
-    def url
-      @raw[:url]
-    end
-
-    def url_pattern
-      @url_pattern ||= Mustermann.new(url, type: :template)
-    end
-
     def services
       @raw[:services] || []
     end
 
-    def url_placeholders
-      url.scan(/\{([a-zA-Z]+(\.[a-zA-Z]+)*)\}/).map{|x| x.first }
-    end
-
-    def instantiate_url(params)
-      url, rest = self.url, params.dup
-      url_placeholders.each do |placeholder|
-        value, rest = extract_placeholder_value(rest, placeholder)
-        url = url.gsub("{#{placeholder}}", value.to_s)
-      end
-      [ url, rest ]
-    end
-
-    def to_singleservice
-      raise NotImplementedError
-    end
-
   private
 
-    def extract_placeholder_value(params, placeholder, split = nil)
-      return extract_placeholder_value(params, placeholder, placeholder.split(".")) unless split
-
-      key = [ split.first, split.first.to_sym ].find{|k| params.has_key?(k) }
-      raise "Missing URL parameter `#{placeholder}`" unless key
-
-      if split.size == 1
-        [ params[key], params.dup.delete_if{|k| k == key } ]
-      else
-        value, rest = extract_placeholder_value(params[key], placeholder, split[1..-1])
-        [ value, params.merge(key => rest) ]
-      end
-    end
-
     def bind_services
       services.each do |s|
         s.specification = self
@@ -99,4 +45,3 @@ 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/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/specification/service.rb

@@ -21,10 +21,6 @@ module Webspicy
         specification.config
       end
 
-      def method
-        @raw[:method]
-      end
-
       def description
         @raw[:description]
       end
@@ -68,7 +64,7 @@ module Webspicy
       def generated_counterexamples
         preconditions.map{|pre|
           pre.counterexamples(self).map{|tc|
-            tc = Webspicy.test_case(tc, Webspicy.current_scope)
+            tc = config.factory.test_case(tc, Webspicy.current_scope)
             tc.bind(self, true)
           }
         }.flatten