webspicy 0.15.8 → 0.17.0

data/lib/webspicy/rspec/tester/rspec_tester.rb

@@ -0,0 +1,63 @@
+module Webspicy
+  class Tester
+    class RSpecTester
+      include Webspicy::Support::RSpecRunnable
+
+    protected
+
+      def load_rspec_examples
+        tester = self
+        RSpec.describe "Webspicy test suite" 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|
+                scope.each_testcase(service) do |test_case|
+                  str = "#{service} #{test_case}"
+                  str = Webspicy::Support::Colorize.colorize_highlight(str, tester.config)
+                  describe(str) do
+
+                    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
+        
+                    let(:invocation) do
+                      @invocation
+                    end
+        
+                    it "meets its specification" do
+                      raise "Test not ran" unless invocation.done?
+                      RSpecAsserter.call(self, invocation)
+                    end
+
+                  end
+                end
+              end
+            end
+          end
+        end
+        self
+      end
+
+    end # class RSpecTester
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/{resource.rb → specification.rb}

@@ -1,17 +1,30 @@
 module Webspicy
-  class Resource
+  class Specification
+    include Support::DataObject
 
     def initialize(raw, location = nil)
-      @raw = raw
+      super(raw)
       @location = location
       bind_services
     end
+    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
@@ -22,6 +35,10 @@ module Webspicy
       file
     end
 
+    def name
+      @raw[:name]
+    end
+
     def url
       @raw[:url]
     end
@@ -31,7 +48,7 @@ module Webspicy
     end
 
     def services
-      @raw[:services]
+      @raw[:services] || []
     end
 
     def url_placeholders
@@ -47,8 +64,8 @@ module Webspicy
       [ url, rest ]
     end
 
-    def to_info
-      @raw
+    def to_singleservice
+      raise NotImplementedError
     end
 
   private
@@ -68,11 +85,15 @@ module Webspicy
     end
 
     def bind_services
-      (@raw[:services] ||= []).each do |s|
-        s.resource = self
+      services.each do |s|
+        s.specification = self
       end
     end
 
-  end
-end
-require_relative 'resource/service'
+  end # class Specification
+end # module Webspicy
+require_relative 'specification/service'
+require_relative 'specification/precondition'
+require_relative 'specification/postcondition'
+require_relative 'specification/test_case'
+require_relative 'specification/file_upload'

data/lib/webspicy/specification/errcondition.rb

@@ -0,0 +1,16 @@
+module Webspicy
+  class Specification
+    module Errcondition
+
+      def self.match(service, descr)
+      end
+
+      def instrument(test_case, client)
+      end
+
+      def check(invocation)
+      end
+
+    end # module Errcondition
+  end # module Specification
+end # module Webspicy

data/lib/webspicy/specification/file_upload.rb

@@ -0,0 +1,37 @@
+module Webspicy
+  class Specification
+    class FileUpload
+
+      def initialize(raw)
+        @path = raw[:path]
+        @content_type = raw[:content_type]
+        @param_name = raw[:param_name] || "file"
+      end
+
+      attr_reader :path, :content_type, :param_name
+
+      def self.info(raw)
+        new(raw)
+      end
+
+      def locate(specification)
+        FileUpload.new({
+          path: specification.locate(path),
+          content_type: content_type
+        })
+      end
+
+      def to_info
+        { path: path.to_s,
+          content_type: content_type,
+          param_name: param_name }
+      end
+
+      def to_s
+        "FileUpload(#{to_info})"
+      end
+      alias :inspect :to_s
+
+    end # class FileUpload
+  end # class Specification
+end # module Webspicy

data/lib/webspicy/specification/postcondition.rb

@@ -0,0 +1,16 @@
+module Webspicy
+  class Specification
+    module Postcondition
+
+      def self.match(service, descr)
+      end
+
+      def instrument(test_case, client)
+      end
+
+      def check(invocation)
+      end
+
+    end # module Postcondition
+  end # module Specification
+end # module Webspicy

data/lib/webspicy/specification/precondition.rb

@@ -0,0 +1,19 @@
+module Webspicy
+  class Specification
+    module Precondition
+
+      def self.match(service, pre)
+      end
+
+      def instrument(test_case, client)
+      end
+
+      def counterexamples(service)
+        []
+      end
+
+    end # module Precondition
+  end # class Specification
+end # module Webspicy
+require_relative 'precondition/global_request_headers'
+require_relative 'precondition/robust_to_invalid_input'

data/lib/webspicy/specification/precondition/global_request_headers.rb

@@ -0,0 +1,35 @@
+module Webspicy
+  class Specification
+    module Precondition
+      class GlobalRequestHeaders
+        include Precondition
+
+        DEFAULT_OPTIONS = {}
+
+        def initialize(headers, options = {}, &bl)
+          @headers = headers
+          @options = DEFAULT_OPTIONS.merge(options)
+          @matcher = bl
+        end
+        attr_reader :headers, :matcher
+
+        def match(service, pre)
+          if matcher
+            return self if matcher.call(service)
+            nil
+          else
+            self
+          end
+        end
+
+        def instrument(test_case, client)
+          extra = headers.reject{|k|
+            test_case.headers.has_key?(k)
+          }
+          test_case.headers.merge!(extra)
+        end
+
+      end # class GlobalRequestHeaders
+    end # module Precondition
+  end # class Specification
+end # module Webspicy

data/lib/webspicy/specification/precondition/robust_to_invalid_input.rb

@@ -0,0 +1,68 @@
+module Webspicy
+  class Specification
+    module Precondition
+      class RobustToInvalidInput
+        include Precondition
+
+        def self.match(service, pre)
+          self.new
+        end
+
+        def match(service, pre)
+          self
+        end
+
+        def counterexamples(service)
+          spec = service.specification
+          first = service.examples.first
+          cexamples = []
+          cexamples += url_randomness_counterexamples(service, first) if first
+          cexamples += empty_input_counterexamples(service, first) if first
+          cexamples
+        end
+
+      protected
+
+        def url_randomness_counterexamples(service, first)
+          service.specification.url_placeholders.map{|p|
+            first.mutate({
+              :description => "it is robust to URL randomness on param `#{p}` (RobustToInvalidInput)",
+              :dress_params => false,
+              :params => first.params.merge(p => (SecureRandom.random_number * 100000000).to_i),
+              :expected => {
+                status: Support::StatusRange.str("4xx")
+              },
+              :assert => []
+            })
+          }
+        end
+
+        def empty_input_counterexamples(service, first)
+          placeholders = service.specification.url_placeholders
+          empty_input = first.params.reject{|k| !placeholders.include?(k) }
+          if invalid_input?(service, empty_input)
+            [first.mutate({
+              :description => "it is robust to an invalid empty input (RobustToInvalidInput)",
+              :dress_params => false,
+              :params => empty_input,
+              :expected => {
+                status: Support::StatusRange.str("4xx")
+              },
+              :assert => []
+            })]            
+          else
+            []
+          end
+        end
+
+        def invalid_input?(service, empty_input)
+          service.input_schema.dress(empty_input)
+          false
+        rescue Finitio::Error
+          true
+        end
+
+      end # class RobustToInvalidInput
+    end # module Precondition
+  end # class Specification
+end # module Webspicy

data/lib/webspicy/{resource → specification}/service.rb

@@ -1,26 +1,33 @@
 module Webspicy
-  class Resource
+  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 :resource
+      attr_accessor :specification
 
       def self.info(raw)
         new(raw)
       end
 
+      def config
+        specification.config
+      end
+
       def method
         @raw[:method]
       end
 
+      def description
+        @raw[:description]
+      end
+
       def preconditions
-        @preconditions
+        @preconditions ||= compile_preconditions
       end
 
       def has_preconditions?
@@ -28,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
@@ -72,31 +87,31 @@ module Webspicy
         input_schema.dress(params)
       end
 
-      def to_info
-        @raw
-      end
-
       def to_s
-        "#{method} #{resource.url}"
+        "#{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
@@ -105,19 +120,17 @@ module Webspicy
       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
 
     end # class Service
-  end # class Resource
+  end # class Specification
 end # module Webspicy
-require_relative 'service/test_case'
-require_relative 'service/invocation'