webspicy 0.15.8 → 0.17.0

data/lib/webspicy/configuration.rb

@@ -9,31 +9,62 @@ module Webspicy
       @children = []
       @preconditions = []
       @postconditions = []
+      @errconditions = []
       @listeners = Hash.new{|h,k| h[k] = [] }
       @rspec_options = default_rspec_options
       @run_examples = default_run_examples
       @run_counterexamples = default_run_counterexamples
+      @run_generated_counterexamples = default_run_generated_counterexamples
       @file_filter = default_file_filter
       @service_filter = default_service_filter
       @test_case_filter = default_test_case_filter
-      @client = HttpClient
+      @colors = {
+        :highlight => :cyan,
+        :error => :red,
+        :success => :green
+      }
+      @scope_factory = ->(config){ Scope.new(config) }
+      @client = Tester::HttpClient
       Path.require_tree(folder/'support') if (folder/'support').exists?
       yield(self) if block_given?
     end
     attr_accessor :folder
     protected :folder=
 
+    attr_accessor :colors
+
     def self.dress(arg, &bl)
-      return arg if arg.is_a?(Configuration)
-      arg = Path(arg)
-      if arg.file?
-        c = Kernel.instance_eval arg.read, arg.to_s
-        yield(c) if block_given?
-        c
-      elsif (arg/'config.rb').file?
-        dress(arg/'config.rb', &bl)
+      case arg
+      when Configuration
+        arg
+      when /^https?:\/\//
+        Configuration.new{|c|
+          c.scope_factory = SingleUrl.new(arg)
+        }
+      when ->(f){ Path(f).exists? }
+        arg = Path(arg)
+        if arg.file? && arg.ext == ".rb"
+          c = Kernel.instance_eval arg.read, arg.to_s
+          yield(c) if block_given?
+          c
+        elsif arg.file? && arg.ext == '.yml'
+          folder = arg.backfind("[config.rb]")
+          if folder && folder.exists?
+            dress(folder/"config.rb"){|c|
+              c.scope_factory = SingleYmlFile.new(arg)
+            }
+          else
+            Configuration.new{|c|
+              c.scope_factory = SingleYmlFile.new(arg)
+            }
+          end
+        elsif arg.directory? and (arg/'config.rb').file?
+          dress(arg/'config.rb', &bl)
+        else
+          raise ArgumentError, "Missing config.rb file"
+        end
       else
-        raise ArgumentError, "Missing config.rb file"
+        raise ArgumentError, "Unable to turn `#{arg}` to a configuration"
       end
     end
 
@@ -51,10 +82,16 @@ module Webspicy
           config.each_scope(&bl)
         end
       else
-        yield Scope.new(self)
+        yield factor_scope
       end
     end
 
+    attr_accessor :scope_factory
+
+    def factor_scope
+      @scope_factory.call(self)
+    end
+
     # Adds a folder to the list of folders where test case definitions are
     # to be found.
     def folder(folder = nil, &bl)
@@ -90,6 +127,13 @@ module Webspicy
     attr_accessor :postconditions
     protected :postconditions=
 
+    # Registers an errcondition matcher
+    def errcondition(clazz)
+      errconditions << clazz
+    end
+    attr_accessor :errconditions
+    protected :errconditions=
+
     # Returns whether this configuration has children configurations or not
     def has_children?
       !children.empty?
@@ -108,7 +152,7 @@ module Webspicy
 
     # Returns the defaut value for run_examples
     def default_run_examples
-      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'only')
+      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'only' && ENV['ROBUST'] != 'generated')
     end
     private :default_run_examples
 
@@ -125,10 +169,27 @@ module Webspicy
 
     # Returns the defaut value for run_counterexamples
     def default_run_counterexamples
-      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'no')
+      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'no' && ENV['ROBUST'] != 'generated')
     end
     private :default_run_counterexamples
 
+    # Sets whether generated counter examples have to be ran or not.
+    def run_generated_counterexamples=(run_generated_counterexamples)
+      @run_generated_counterexamples = run_generated_counterexamples
+    end
+    attr_reader :run_generated_counterexamples
+
+    # Whether generated counter examples must be ran or not.
+    def run_generated_counterexamples?
+      @run_generated_counterexamples
+    end
+
+    # Returns the defaut value for run_generated_counterexamples
+    def default_run_generated_counterexamples
+      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'no')
+    end
+    private :default_run_generated_counterexamples
+
     # Installs a host (resolver).
     #
     # The host resolver is responsible from transforming URLs found in
@@ -347,7 +408,7 @@ module Webspicy
       elsif not(self.parent.nil?)
         self.parent.data_system
       else
-        Finitio::DEFAULT_SYSTEM
+        Webspicy::DEFAULT_SYSTEM
       end
     end
 
@@ -369,6 +430,7 @@ module Webspicy
         d.children = []
         d.preconditions = self.preconditions.dup
         d.postconditions = self.postconditions.dup
+        d.errconditions = self.errconditions.dup
         d.rspec_options = self.rspec_options.dup
         d.listeners = LISTENER_KINDS.inject({}){|ls,kind|
           ls.merge(kind => self.listeners(kind).dup)
@@ -379,3 +441,6 @@ module Webspicy
 
   end
 end
+require_relative 'configuration/scope'
+require_relative 'configuration/single_url'
+require_relative 'configuration/single_yml_file'

data/lib/webspicy/configuration/scope.rb

@@ -0,0 +1,154 @@
+module Webspicy
+  class Configuration
+    class Scope
+
+      def initialize(config)
+        @config = config
+      end
+      attr_reader :config
+
+      ###
+      ### 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)
+      end
+
+      # Recursive implementation of `each_specification_file` for each
+      # folder in the configuration.
+      def _each_specification_file(config)
+        folder = config.folder
+        folder.glob("**/*.yml").select(&to_filter_proc(config.file_filter)).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|
+          yield Webspicy.specification(file.load, file, self)
+        end
+      end
+
+      def each_service(specification, &bl)
+        specification.services.select(&to_filter_proc(config.service_filter)).each(&bl)
+      end
+
+      def each_example(service, &bl)
+        service.examples
+          .map{|e| expand_example(service, e) }
+          .select(&to_filter_proc(config.test_case_filter))
+          .each(&bl) if config.run_examples?
+      end
+
+      def each_counterexamples(service, &bl)
+        service.counterexamples
+          .map{|e| expand_example(service, e) }
+          .select(&to_filter_proc(config.test_case_filter))
+          .each(&bl) if config.run_counterexamples?
+      end
+
+      def each_generated_counterexamples(service, &bl)
+        Webspicy.with_scope(self) do
+          service.generated_counterexamples
+            .map{|e| expand_example(service, e) }
+            .select(&to_filter_proc(config.test_case_filter))
+            .each(&bl) if config.run_generated_counterexamples?
+        end if config.run_generated_counterexamples?
+      end
+
+      def each_testcase(service, &bl)
+        each_example(service, &bl)
+        each_counterexamples(service, &bl)
+        each_generated_counterexamples(service, &bl)
+      end
+
+      ###
+      ### Schemas -- For parsing input and output data schemas found in
+      ### web service definitions
+      ###
+
+      # Parses a Finitio schema based on the data system.
+      def parse_schema(fio)
+        data_system.parse(fio)
+      end
+
+      # Returns the Data system to use for parsing schemas
+      def data_system
+        @data_system ||= config.data_system
+      end
+
+
+      ###
+      ### Service invocation: abstract the configuration about what client is
+      ### used and how to instantiate it
+      ###
+
+      # Returns an instance of the client to use to invoke web services
+      def get_client
+        config.client.new(self)
+      end
+
+      # Convert an instantiated URL found in a webservice definition
+      # to a real URL, using the configuration host.
+      #
+      # When no host resolved on the configuration and the url is not
+      # already an absolute URL, yields the block if given, or raise
+      # an exception.
+      def to_real_url(url, test_case = nil, &bl)
+        case config.host
+        when Proc
+          config.host.call(url, test_case)
+        when String
+          url =~ /^http/ ? url : "#{config.host}#{url}"
+        else
+          return url if url =~ /^http/
+          return yield(url) if block_given?
+          raise "Unable to resolve `#{url}` : no host resolver provided\nSee `Configuration#host="
+        end
+      end
+
+      ###
+      ### Private methods
+      ###
+
+      private
+
+        def expand_example(service, example)
+          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.bind(service, example.counterexample?)
+        end
+
+        def merge_maps(h1, h2)
+          h1.merge(h2) do |k,v1,v2|
+            case v1
+            when Hash  then merge_maps(v1, v2)
+            when Array then v1 + v2
+            else v2
+            end
+          end
+        end
+
+        # Returns a proc that implements file_filter strategy according to the
+        # type of filter installed
+        def to_filter_proc(filter)
+          case ff = filter
+          when NilClass then ->(f){ true }
+          when Proc     then ff
+          when Regexp   then ->(f){ ff =~ f.to_s }
+          else
+            ->(f){ ff === f }
+          end
+        end
+
+    end # class Scope
+  end # class Configuration
+end # module Webspicy

data/lib/webspicy/configuration/single_url.rb

@@ -0,0 +1,58 @@
+module Webspicy
+  class Configuration
+    class SingleUrl
+
+      class SingleUrlScope < Scope
+
+        def initialize(config, url)
+          super(config)
+          @url = url
+        end
+        attr_reader :url
+
+        def each_specification(&bl)
+          return enum_for(:each_specification) unless block_given?
+          spec = <<~YML
+          ---
+          name: |-
+            Default specification
+          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
+          YML
+          Webspicy.debug(spec)
+          yield Webspicy.specification(spec, nil, self)
+        end
+
+      end # class SingleUrlScope
+
+      def initialize(url)
+        @url = url
+      end
+
+      def call(config)
+        SingleUrlScope.new(config, @url)
+      end
+
+    end # class SingleUrl
+  end # class Configuration
+end # module Webspicy

data/lib/webspicy/configuration/single_yml_file.rb

@@ -0,0 +1,30 @@
+module Webspicy
+  class Configuration
+    class SingleYmlFile
+
+      class SingleYmlFileScope < Scope
+
+        def initialize(config, file)
+          super(config)
+          @file = file
+        end
+        attr_reader :file
+
+        def each_specification(&bl)
+          return enum_for(:each_specification) unless block_given?
+          yield Webspicy.specification(file.read, nil, self)
+        end
+
+      end # class SingleYmlFileScope
+
+      def initialize(file)
+        @file = file
+      end
+
+      def call(config)
+        SingleYmlFileScope.new(config, @file)
+      end
+
+    end # class SingleYmlFile
+  end # class Configuration
+end # module Webspicy

data/lib/webspicy/formaldoc.fio

@@ -17,19 +17,36 @@ FileUpload =
         param_name   :? String
     }
 
-Resource =
-    .Webspicy::Resource <info> {
-        name: String
-        url: String
-        services: [Service]
-    }
+Specification = .Webspicy::Specification
+  <singleservice> {
+    name            :? 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
+    blackbox        :? String
+    default_example :? TestCase
+    examples        :? [TestCase]
+    counterexamples :? [TestCase]
+  }
+  <info> {
+    name: String
+    url: String
+    services: [Service]
+  }
 
 Service =
-    .Webspicy::Resource::Service <info> {
+    .Webspicy::Specification::Service <info> {
         method          :  Method
         description     :  String
         preconditions   :? [String]|String
         postconditions  :? [String]|String
+        errconditions   :? [String]|String
         input_schema    :  Schema
         output_schema   :  Schema
         error_schema    :  Schema
@@ -40,7 +57,7 @@ Service =
     }
 
 TestCase =
-    .Webspicy::Resource::Service::TestCase <info> {
+    .Webspicy::Specification::TestCase <info> {
         description      :? String
         dress_params     :? Boolean
         params           :? Params