webspicy 0.20.22 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb926aeeae60b8f3568595dfef40404aa9242b3bc1b44194d73b6716b662a315
-  data.tar.gz: ae5969698e0dfee763d25a9918881c77b18b15f0642b2773813fe58a31ca63aa
+  metadata.gz: 297aab67c7235a6a0100db0b857b15d7897beeaa58aa8a8572b4b13df5ccba28
+  data.tar.gz: a5694c1b122ed3c135790b04e837d88be9baad28c2b5b8cb594311339dc89c34
 SHA512:
-  metadata.gz: 680f7ffeea26ec3fec0884883a3dbd46989ea14cf76d7daf29457032cbb5ba68f0fe8391f3e6edcd244689bc8f5e791b82a68b703e64eeb802190ebcfff5c001
-  data.tar.gz: 7ac2a6f5988916d62745312ef1f3bc16fab09a424204d0643d0dcddce5b5e916afe9f879847fc9256f77db6dd6330ee555d355b76461ed59667d4c450e1b615f
+  metadata.gz: 6c68dfdb65de4636f3cbc85703f6224e7ff7bcf9edd77cdf92aa67de47fd7086ceb2b1c4b91317a944f0acd618c03c8caa9c3f2c5e76f004b4e0fe779adc7085
+  data.tar.gz: 994aa8228e557a3baef8612653dc5d6d30377b2c405eb6f35508acd0c953865d23bd2da0f73be5492ea70c538fdb9ba2ef3fcc4f0f1253e7b6ee9cce2ea8e35a

data/README.md

@@ -1,4 +1,4 @@
-[![Test](https://github.com/enspirit/webspicy/actions/workflows/integration.yml/badge.svg?branch=master)](https://github.com/enspirit/webspicy/actions/workflows/integration.yml)
+[![Test](https://github.com/enspirit/webspicy/actions/workflows/integration.yml/badge.svg)](https://github.com/enspirit/webspicy/actions/workflows/integration.yml/badge.svg)
 # Webspicy
 
 A specification and test framework for web services seen as black-box software

data/bin/webspicy

@@ -21,6 +21,7 @@
 #/ - TAG=...                      execute only tests matching the given tag
 #/ - FAILFAST=yes|no              stop executing tests on first failure
 #/ - INSECURE=yes|no              allow insecure server connections when using SSL
+#/ - WATCH=FOLDER,FOLDER,...      run in watch mode (run tests when files change)
 #/
 require 'webspicy'
 require 'webspicy/tester'
@@ -42,6 +43,9 @@ ARGV.options do |opts|
   opts.on('-k', '--insecure') {
     ENV['INSECURE'] = 'yes'
   }
+  opts.on('-w', '--watch') {
+    ENV['WATCH'] = '.'
+  }
   opts.on("--debug") {
     ENV['LOG_LEVEL'] = 'DEBUG'
     Webspicy::LOGGER.level = Logger.const_get(ENV['LOG_LEVEL'])

data/lib/webspicy/configuration/scope.rb

@@ -136,20 +136,13 @@ module Webspicy
 
         def expand_example(service, example)
           return example unless service.default_example
-          h1 = service.default_example.to_info
-          h2 = example.to_info
-          ex = config.factory.test_case(merge_maps(h1, h2), self)
-          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
+          merged = Support::DeepMerge.deep_merge(
+            service.default_example.to_info,
+            example.to_info
+          )
+          ex = config.factory.test_case(merged, self)
+          ex.bind(service, example.counterexample?)
         end
 
         # Returns a proc that implements file_filter strategy according to the

data/lib/webspicy/configuration.rb

@@ -43,6 +43,7 @@ module Webspicy
       @scope_factory = ->(config){ Scope.new(config) }
       @client = Web::HttpClient
       @reporter = default_reporter
+      @watch_list = default_watchlist
       Path.require_tree(@folder/'support') if (@folder/'support').exists?
       @world = Support::World.new(folder/'world', self)
       yield(self) if block_given?
@@ -451,6 +452,13 @@ module Webspicy
     end
     attr_accessor :reporter
 
+    def default_watchlist
+      return nil unless list = ENV['WATCH']
+
+      list.split(',').map{|x| Path.pwd/x }
+    end
+    attr_accessor :watch_list
+
     # Returns the Data system to use for parsing schemas
     #
     # The data system associated with a configuration is build when the

data/lib/webspicy/support/deep_merge.rb

@@ -0,0 +1,36 @@
+module Webspicy
+  module Support
+    class DeepMerge
+      class << self
+
+        def deep_merge(h1, h2)
+          merge_maps(deep_dup(h1), deep_dup(h2))
+        end
+
+        def deep_dup(x)
+          case x
+          when Array
+            x.map{|y| deep_dup(y) }
+          when Hash
+            x.each_with_object({}){|(k,v),memo| memo[k] = deep_dup(v) }
+          else
+            x
+          end
+        end
+
+        private
+
+        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
+
+      end
+    end
+  end
+end

data/lib/webspicy/support.rb

@@ -28,6 +28,7 @@ module Webspicy
   end # module Support
 end # module Webspicy
 require_relative 'support/data_object'
+require_relative 'support/deep_merge'
 require_relative 'support/status_range'
 require_relative 'support/colorize'
 require_relative 'support/world'

data/lib/webspicy/tester/file_checker.rb

@@ -10,7 +10,7 @@ module Webspicy
         @reporter << Reporter::SuccessOrNot.new
       end
 
-      def run_scope
+      def run_scope(all = true)
         scope.each_specification_file do |spec_file|
           @specification = load_specification(spec_file)
           reporter.spec_file_done

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

@@ -51,16 +51,14 @@ module Webspicy
         end
 
         def before_service
-          @spec_file_line_printed = false
+          @test_case_seen = false
         end
 
         def before_test_case
-          unless @spec_file_line_printed
-            io.puts spec_file_line(spec_file)
-            io.puts
-            io.flush
-            @spec_file_line_printed = true
-          end
+          @test_case_seen = true
+          io.puts spec_file_line(spec_file)
+          io.puts
+          io.flush
           io.puts service_line(service, test_case)
           io.flush
         end
@@ -86,10 +84,8 @@ module Webspicy
         end
 
         def service_done
-          unless @spec_file_line_printed
-            io.puts
-            io.flush
-          end
+          io.puts if @test_case_seen
+          io.flush
         end
 
       end # class Documentation

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

@@ -6,8 +6,7 @@ module Webspicy
 
         def initialize(*args, &bl)
           super
-          @spec_file_errors = []
-          @failed_results = []
+          clear
         end
         attr_reader :failed_results, :spec_file_errors
 
@@ -24,6 +23,11 @@ module Webspicy
           report_failed_results
         end
 
+        def clear
+          @spec_file_errors = []
+          @failed_results = []
+        end
+
       private
 
         def report_spec_file_errors

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

@@ -5,8 +5,7 @@ module Webspicy
 
         def initialize(*args, &bl)
           super
-          @spec_files_count = 0
-          @errors_count = 0
+          clear
         end
         attr_reader :spec_files_count, :errors_count
 
@@ -31,6 +30,11 @@ module Webspicy
           io.flush
         end
 
+        def clear
+          @spec_files_count = 0
+          @errors_count = 0
+        end
+
       private
 
         def success?

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

@@ -5,14 +5,7 @@ module Webspicy
 
         def initialize(*args, &bl)
           super
-          @spec_files_count = 0
-          @examples_count = 0
-          @counterexamples_count = 0
-          @assertions_count = 0
-          #
-          @spec_file_errors_count = 0
-          @errors_count = 0
-          @failures_count = 0
+          clear
         end
         attr_reader :spec_files_count, :examples_count, :counterexamples_count
         attr_reader :assertions_count
@@ -54,6 +47,17 @@ module Webspicy
           io.flush
         end
 
+        def clear
+          @spec_files_count = 0
+          @examples_count = 0
+          @counterexamples_count = 0
+          @assertions_count = 0
+          #
+          @spec_file_errors_count = 0
+          @errors_count = 0
+          @failures_count = 0
+        end
+
         def total_error_count
           @spec_file_errors_count + @errors_count + @failures_count
         end

data/lib/webspicy/tester/reporter.rb

@@ -58,7 +58,8 @@ module Webspicy
         :after_each_done,
         :after_all,
         :after_all_done,
-        :report
+        :report,
+        :clear
       ]
 
       HOOKS.each do |meth|

data/lib/webspicy/tester.rb

@@ -32,9 +32,23 @@ module Webspicy
     end
 
     def call
+      res = call_once(true)
+      if folders = config.watch_list
+        require 'listen'
+        listener = Listen.to(*folders) do
+          reporter.clear
+          res = call_once(false)
+        end
+        listener.start
+        sleep
+      end
+      res
+    end
+
+    def call_once(all = true)
       reporter.init(self)
       begin
-        run_config
+        run_config(all)
       rescue FailFast
       end
       reporter.report
@@ -64,19 +78,21 @@ module Webspicy
 
   protected
 
-    def run_config
+    def run_config(all = true)
       config.each_scope do |scope|
         @scope = scope
         @hooks = Support::Hooks.for(scope.config)
         @client = scope.get_client
-        run_scope
+        run_scope(all)
       end
     end
 
-    def run_scope
-      reporter.before_all
-      hooks.fire_before_all(self)
-      reporter.before_all_done
+    def run_scope(all = true)
+      if all
+        reporter.before_all
+        hooks.fire_before_all(self)
+        reporter.before_all_done
+      end
       reporter.before_scope
       scope.each_specification_file do |spec_file|
         @specification = load_specification(spec_file)
@@ -90,9 +106,11 @@ module Webspicy
         end
       end
       reporter.scope_done
-      reporter.after_all
-      hooks.fire_after_all(self)
-      reporter.after_all_done
+      if all
+        reporter.after_all
+        hooks.fire_after_all(self)
+        reporter.after_all_done
+      end
     end
 
     def load_specification(spec_file)

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 20
-    TINY  = 22
+    MINOR = 21
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/support/test_deep_merge.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+module Webspicy
+  module Support
+    describe DeepMerge, 'deep_dup' do
+      it 'works on scalars' do
+        expect(DeepMerge.deep_dup(12)).to eql(12)
+      end
+
+      it 'works on arrays' do
+        xs = [1, 2, 3]
+        expect(DeepMerge.deep_dup(xs)).to eql(xs)
+        expect(DeepMerge.deep_dup(xs)).not_to be(xs)
+      end
+
+      it 'works on hashes' do
+        xs = { foo: "bar" }
+        expect(DeepMerge.deep_dup(xs)).to eql(xs)
+        expect(DeepMerge.deep_dup(xs)).not_to be(xs)
+      end
+
+      it 'works recursively' do
+        xs = { foo: { bar: [1, 2, 3] } }
+        got = DeepMerge.deep_dup(xs)
+        expect(got[:foo]).not_to be(xs[:foo])
+        expect(got[:foo][:bar]).not_to be(xs[:foo][:bar])
+      end
+    end
+    describe DeepMerge, 'deep_merge' do
+      it 'works as expected' do
+        h1 = { foo: { bar: "baz" }, times: [1, 2], only: { me: true } }
+        h2 = { foo: { bor: "boz" }, times: [3, 4], not: { you: false } }
+        expected = {
+          foo: { bar: "baz", bor: "boz" },
+          times: [1, 2, 3, 4],
+          only: { me: true },
+          not: { you: false }
+        }
+        got = DeepMerge.deep_merge(h1, h2)
+        expect(got).to eql(expected)
+        expect(got[:only]).not_to be(h1[:only])
+        expect(got[:not]).not_to be(h2[:not])
+      end
+    end
+  end
+end

data/spec/unit/test_configuration.rb

@@ -184,6 +184,35 @@ module Webspicy
       end
     end
 
+    describe 'watch_list' do
+
+      it 'is nil by default' do
+        config = Configuration.new
+        expect(config.watch_list).to be_nil
+      end
+
+      it 'supports a single relative folder on WATCH env variable' do
+        ENV['WATCH'] = 'a_folder'
+        config = Configuration.new
+        expect(config.watch_list).to eql([Path.pwd/"a_folder"])
+        ENV.delete('WATCH')
+      end
+
+      it 'supports a commalist on WATCH env variable' do
+        ENV['WATCH'] = 'a_folder,another'
+        config = Configuration.new
+        expect(config.watch_list).to eql([Path.pwd/"a_folder", Path.pwd/'another'])
+        ENV.delete('WATCH')
+      end
+
+      it 'supports absolute folders too' do
+        ENV['WATCH'] = 'a_folder,/tmp'
+        config = Configuration.new
+        expect(config.watch_list).to eql([Path.pwd/"a_folder", Path('/tmp')])
+        ENV.delete('WATCH')
+      end
+    end
+
     describe 'insecure' do
 
       it 'is false by default' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.20.22
+  version: 0.21.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -246,6 +246,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables:
@@ -287,6 +301,7 @@ files:
 - lib/webspicy/support.rb
 - lib/webspicy/support/colorize.rb
 - lib/webspicy/support/data_object.rb
+- lib/webspicy/support/deep_merge.rb
 - lib/webspicy/support/hooks.rb
 - lib/webspicy/support/status_range.rb
 - lib/webspicy/support/world.rb
@@ -354,6 +369,7 @@ files:
 - spec/unit/support/hooks/test_fire_after_each.rb
 - spec/unit/support/hooks/test_fire_around.rb
 - spec/unit/support/hooks/test_fire_before_each.rb
+- spec/unit/support/test_deep_merge.rb
 - spec/unit/support/test_status_range.rb
 - spec/unit/support/world/fixtures/array.json
 - spec/unit/support/world/fixtures/queue.rb
@@ -392,7 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!