webspicy 0.15.8 → 0.16.0

data/examples/restful/webspicy/todo/getTodoSingleServiceFormat.yml

@@ -0,0 +1,46 @@
+---
+url: |-
+  /todo/{id}
+
+method: |-
+  GET
+
+description: |-
+  Returns a single todo item
+
+input_schema: |-
+  {
+    id: Integer
+  }
+
+output_schema: |-
+  Todo
+
+error_schema: |-
+  ErrorSchema
+
+examples:
+
+  - description: |-
+      when requested on an existing TODO
+    params:
+      id: 1
+    expected:
+      content_type: application/json
+      status: 200
+    assert:
+      - "pathFD('', id: 1)"
+      - "match('description', /Refactor/)"
+      - "notMatch('description', /Foo/)"
+
+counterexamples:
+
+  - description: |-
+      when requested on an unexisting TODO
+    params:
+      id: 999254654
+    expected:
+      content_type: application/json
+      status: 404
+    assert:
+      - "pathFD('', error: 'No such todo')"

data/examples/restful/webspicy/todo/options.yml

@@ -17,7 +17,7 @@ services:
     }
 
   output_schema: |-
-    .
+    Any
 
   error_schema: |-
     ErrorSchema

data/examples/restful/webspicy/todo/patchTodo.yml

@@ -36,6 +36,9 @@ services:
       params:
         id: 1
         description: 'hello world'
+      expected:
+        content_type: application/json
+        status: 200
       assert:
         - "pathFD('', description: 'hello world')"
 

data/examples/restful/webspicy/todo/postFile.yml

@@ -16,7 +16,7 @@ services:
     - Must be authenticated
 
   input_schema: |-
-    .
+    Any
 
   output_schema: |-
     { count: Integer }

data/examples/single_spec/spec.yml

@@ -0,0 +1,59 @@
+---
+name: |-
+  Todo
+
+url: |-
+  http://127.0.0.1:4567/todo/{id}
+
+services:
+- method: |-
+    GET
+
+  description: |-
+    Returns a single todo item
+
+  input_schema: |-
+    {
+      id: Integer
+    }
+
+  output_schema: |-
+    {
+      id: Integer
+      description: String
+    }
+
+  error_schema: |-
+    {
+      error: String
+    }
+
+  examples:
+
+    - description: |-
+        when requested on an existing TODO
+      headers:
+        Accept: application/json
+      params:
+        id: 1
+      expected:
+        content_type: application/json
+        status: 200
+      assert:
+        - "pathFD('', id: 1)"
+        - "match('description', /Refactor/)"
+        - "notMatch('description', /Foo/)"
+
+  counterexamples:
+
+    - description: |-
+        when requested on an unexisting TODO
+      headers:
+        Accept: application/json
+      params:
+        id: 999254654
+      expected:
+        content_type: application/json
+        status: 404
+      assert:
+        - "pathFD('', error: 'No such todo')"

data/examples/website/config.rb

@@ -0,0 +1,2 @@
+Webspicy::Configuration.new{|c|
+}

data/examples/website/schema.fio

@@ -0,0 +1 @@
+@import webspicy/scalars

data/examples/website/specification/get-http.yml

@@ -0,0 +1,34 @@
+---
+name: |-
+  Your backend is broken website
+
+url: |-
+  http://yourbackendisbroken.dev
+
+services:
+- method: |-
+    GET
+
+  description: |-
+    Redirects to the https version
+
+  input_schema: |-
+    Any
+
+  output_schema: |-
+    Any
+
+  error_schema: |-
+    Any
+
+  examples:
+
+    - description: |-
+        it works
+      params:
+        id: 1
+      expected:
+        content_type: text/html
+        status: 3xx
+        headers:
+          Location: https://yourbackendisbroken.dev/?id=1

data/examples/website/specification/get-https.yml

@@ -0,0 +1,34 @@
+---
+name: |-
+  Your backend is broken website
+
+url: |-
+  https://yourbackendisbroken.dev
+
+services:
+- method: |-
+    GET
+
+  description: |-
+    Returns the web page
+
+  input_schema: |-
+    Any
+
+  output_schema: |-
+    Any
+
+  error_schema: |-
+    Any
+
+  examples:
+
+    - description: |-
+        it works
+      params:
+        id: 1
+      expected:
+        content_type: text/html
+        status: 200
+      assert:
+        - notEmpty

data/lib/finitio/webspicy/scalars.fio

@@ -0,0 +1,25 @@
+# Any
+Any        = .
+
+# Booleans
+Nil        = .NilClass
+True       = .TrueClass
+False      = .FalseClass
+Boolean    = .TrueClass|.FalseClass
+
+# Numbers
+Numeric = .Numeric
+Integer = .Integer
+Float   = .Float
+Real    = .Float
+
+# String
+String  = .String
+
+# Date, Time, DateTime
+Date     = .Date     <iso8601> .String \( s | Date.iso8601(s) )
+                                       \( d | d.iso8601       )
+Time     = .Time     <iso8601> .String \( s | Time.iso8601(s) )
+                                       \( t | t.iso8601       )
+DateTime = .DateTime <iso8601> .String \( s | DateTime.iso8601(s) )
+                                       \( t | t.iso8601           )

data/lib/webspicy.rb

@@ -7,25 +7,33 @@ require 'ostruct'
 require 'yaml'
 require 'rspec'
 require 'rack/test'
-require "mustermann"
+require 'mustermann'
+require 'colorized_string'
+require 'securerandom'
 module Webspicy
 
   ###
   ### Load library
   ###
 
+  require 'webspicy/version'
   require 'webspicy/support'
+  require 'webspicy/specification'
   require 'webspicy/configuration'
-  require 'webspicy/file_upload'
-  require 'webspicy/scope'
-  require 'webspicy/client'
-  require 'webspicy/resource'
-  require 'webspicy/precondition'
-  require 'webspicy/postcondition'
   require 'webspicy/checker'
   require 'webspicy/tester'
-  require 'webspicy/tester/assertions'
-  require 'webspicy/tester/asserter'
+
+  ###
+  ### Backward compatibility
+  ###
+  Client = Tester::Client
+  HttpClient = Tester::HttpClient
+  RackTestClient = Tester::RackTestClient
+  Resource = Specification
+  Precondition = Specification::Precondition
+  Postcondition = Specification::Postcondition
+  FileUpload = Specification::FileUpload
+  Scope = Configuration::Scope
 
   ###
   ### About folders
@@ -36,30 +44,38 @@ module Webspicy
   EXAMPLES_FOLDER = ROOT_FOLDER/('examples')
 
   ###
-  ### About formal doc and resources defined there
+  ### 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"))
 
   # Returns a default scope instance.
   def default_scope
-    Scope.new(Configuration.new)
+    Configuration::Scope.new(Configuration.new)
   end
   module_function :default_scope
 
-  def resource(raw, file = nil, scope = 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["Resource"].dress(raw)
+      r = FORMALDOC["Specification"].dress(raw)
       r.located_at!(file) if file
       r
     end
+  rescue Finitio::Error => ex
+    handle_finitio_error(ex, scope)
   end
-  module_function :resource
+  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
 
@@ -67,9 +83,19 @@ module Webspicy
     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.
   #
@@ -120,7 +146,7 @@ module Webspicy
     if scope = Thread.current[:webspicy_scope]
       scope.parse_schema(fio)
     else
-      Finitio.system(fio)
+      DEFAULT_SYSTEM.system(fio)
     end
   end
   module_function :schema
@@ -132,7 +158,7 @@ module Webspicy
   LOGGER = ::Logger.new(STDOUT)
   LOGGER.level = Logger.const_get(ENV['LOG_LEVEL'] || 'WARN')
   LOGGER.formatter = proc { |severity, datetime, progname, msg|
-    "      " + msg + "\n"
+    "  " + msg + "\n"
   }
 
   def info(*args, &bl)
@@ -145,4 +171,9 @@ module Webspicy
   end
   module_function :debug
 
+  def fatal(*args, &bl)
+    LOGGER && LOGGER.fatal(*args, &bl)
+  end
+  module_function :fatal
+
 end

data/lib/webspicy/checker.rb

@@ -8,11 +8,11 @@ module Webspicy
 
     def call
       config.each_scope do |scope|
-        scope.each_resource_file do |file, folder|
+        scope.each_specification_file do |file, folder|
           RSpec.describe file.relative_to(folder).to_s do
 
             it 'meets the formal doc data schema' do
-              Webspicy.resource(file.load, file, scope)
+              Webspicy.specification(file.load, file, scope)
             end
 
           end

data/lib/webspicy/configuration.rb

@@ -13,27 +13,57 @@ module Webspicy
       @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 +81,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)
@@ -108,7 +144,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 +161,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 +400,7 @@ module Webspicy
       elsif not(self.parent.nil?)
         self.parent.data_system
       else
-        Finitio::DEFAULT_SYSTEM
+        Webspicy::DEFAULT_SYSTEM
       end
     end
 
@@ -379,3 +432,6 @@ module Webspicy
 
   end
 end
+require_relative 'configuration/scope'
+require_relative 'configuration/single_url'
+require_relative 'configuration/single_yml_file'