webspicy 0.20.6 → 0.20.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 013055707cad05016cb794561d47a0408d39d6f462387c9eb66d31542ff2218c
-  data.tar.gz: b4c4778275ec96271b711ea0956c539fa35bf12b04d635fbc5062698996e7902
+  metadata.gz: 7eba5a8dc97e7c8f2053da2c52e45d728d1de38777ac2088db74aa2852f0ab8a
+  data.tar.gz: dfd0330f95b8c9e64b63919820b7b48ba1dc0f4a7696ba03877670f41a8812b3
 SHA512:
-  metadata.gz: fcc079537f13b76af0e433c8591529824ea1e4f8b255f1411963e88cbd4df6953598504413dc8ad3da6db3005cf2c49867e80790594e3fb56cab039f2de450c7
-  data.tar.gz: e4479277fcec22a0928ae75a0120bc5c0a9644e73be6bb75a577dd33a42a03c445996b9b846a33bd20e6e439b4047a8f3ab4a418abb965777b4ce047e1824d7e
+  metadata.gz: 243d021ca1344f09880a3fbda147c38dbacb8791c3e8f541acb524992f6c3e15bb997fbb4423b06c504c95f7a85079fa24d329379b8368cc0b04b11a0a0ab028
+  data.tar.gz: 47a7462b3b080b276f594b0b1df054488fa69c60038c51d2d22a664aeb83ada0c390380de1497a30d0f990bd97638fbc3acdfc636eb8fbe227e37d3c1512f6f0

data/lib/webspicy/configuration.rb

@@ -447,7 +447,7 @@ module Webspicy
       @reporter << Tester::Reporter::Documentation.new
       @reporter << Tester::Reporter::Exceptions.new
       @reporter << Tester::Reporter::Summary.new
-      @reporter << Tester::Reporter::ErrorCount.new
+      @reporter << Tester::Reporter::SuccessOrNot.new
     end
     attr_accessor :reporter
 

data/lib/webspicy/specification.rb

@@ -14,6 +14,10 @@ module Webspicy
       @location = Path(location)
     end
 
+    def relative_location
+      @location && @location.relative_to(config.folder)
+    end
+
     def locate(relative_path)
       file = @location.parent/relative_path
       raise "File not found: #{file}" unless file.exists?
@@ -21,7 +25,7 @@ module Webspicy
     end
 
     def name
-      @raw[:name]
+      @raw[:name] || relative_location || "Unnamed"
     end
 
     def services

data/lib/webspicy/tester.rb

@@ -38,12 +38,12 @@ module Webspicy
       rescue FailFast
       end
       reporter.report
-      reporter.find(Reporter::ErrorCount).report
+      reporter.find(Reporter::SuccessOrNot).report
     end
 
     def call!
       res = call
-      abort("KO") unless res == 0
+      abort("KO") unless reporter.find(Reporter::SuccessOrNot).success?
     end
 
     def find_and_call(method, url, mutation)
@@ -149,6 +149,8 @@ module Webspicy
     end
 
     def call_test_case_target
+      @invocation = nil
+      @invocation_error = nil
       reporter.before_invocation
       @invocation = client.call(test_case)
       reporter.invocation_done

data/lib/webspicy/tester/fakesendgrid.rb

@@ -0,0 +1,39 @@
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      include Webspicy::Support::World::Item
+
+      DEFAULT_OPTIONS = {
+        endpoint: "http://fakesendgrid"
+      }
+
+      def initialize(options = {})
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+      attr_reader :options
+
+      def endpoint
+        options[:endpoint]
+      end
+
+      def clear!
+        res = HTTP.delete("#{endpoint}/api/mails")
+      end
+
+      def emails
+        res = HTTP.get("#{endpoint}/api/mails")
+        JSON.parse(res.body).map{|data| Email.new(data) }
+      end
+
+      def emails_count
+        emails.length
+      end
+
+      def last_email
+        emails.first
+      end
+
+    end # class Fakesendgrid
+  end # class Tester
+end # module Webspicy
+require_relative 'fakesendgrid/email'

data/lib/webspicy/tester/fakesendgrid/email.rb

@@ -0,0 +1,29 @@
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      class Email
+
+        def initialize(data)
+          @data = data
+        end
+        attr_reader :data
+
+        def from
+          @from ||= data["from"]["email"]
+        end
+
+        def to
+          @to ||= data["personalizations"]
+            .select{|h| h.key? "to" }
+            .map{|(h)| h["to"] }
+            .map{|(h)| h["email"] }
+        end
+
+        def subject
+          @subject ||= data["subject"]
+        end
+
+      end # class Email
+    end # class Fakesendgrid
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/fakesmtp.rb

@@ -30,7 +30,7 @@ module Webspicy
       end
 
       def last_email
-        emails.last
+        emails.first
       end
 
     end # class Fakesmtp

data/lib/webspicy/tester/file_checker.rb

@@ -7,7 +7,7 @@ module Webspicy
         @reporter << Reporter::FileProgress.new
         @reporter << Reporter::Exceptions.new
         @reporter << Reporter::FileSummary.new
-        @reporter << Reporter::ErrorCount.new
+        @reporter << Reporter::SuccessOrNot.new
       end
 
       def run_scope

data/lib/webspicy/tester/reporter.rb

@@ -80,7 +80,6 @@ module Webspicy
     end # class Reporter
   end # class Tester
 end # module Webspicy
-require_relative 'reporter/error_count'
 require_relative 'reporter/progress'
 require_relative 'reporter/summary'
 require_relative 'reporter/documentation'
@@ -88,3 +87,5 @@ require_relative 'reporter/exceptions'
 require_relative 'reporter/composite'
 require_relative 'reporter/file_progress'
 require_relative 'reporter/file_summary'
+require_relative 'reporter/success_or_not'
+require_relative 'reporter/junit_xml_file'

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

@@ -15,7 +15,7 @@ module Webspicy
           @spec_file_errors << spec_file_error_line(spec_file, e)
         end
 
-        def after_each_done
+        def test_case_done
           @failed_results << result unless result.success?
         end
 
@@ -24,6 +24,8 @@ module Webspicy
           report_failed_results
         end
 
+      private
+
         def report_spec_file_errors
           return if spec_file_errors.empty?
           io.puts

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

@@ -0,0 +1,151 @@
+module Webspicy
+  class Tester
+    class Reporter
+      class JunitXmlFile < Reporter
+
+        TPL = <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <testsuites
+            disabled="{{counts.disabled}}"
+            errors="{{counts.errors}}"
+            failures="{{counts.failures}}"
+            tests="{{counts.total}}"
+            time="{{time}}s"
+          >
+            {{#testsuites}}
+              <testsuite
+                name="{{name}}"
+                tests="{{counts.total}}"
+                errors="{{counts.errors}}"
+                failures="{{counts.failures}}"
+                time="{{time}}s"
+              >
+                {{#testcases}}
+                  <testcase
+                    name="{{name}}"
+                    assertions="{{assert}}"
+                    classname="{{classname}}"
+                    status=""
+                    time="{{time}}s"
+                  >
+                    {{#errors}}
+                      <error
+                        message="{{message}}"
+                        type="{{type}}"
+                      ></error>
+                    {{/errors}}
+                    {{#failures}}
+                      <failure
+                        message="{{message}}"
+                        type="{{type}}"
+                        ></failure>
+                    {{/failures}}
+                  </testcase>
+                {{/testcases}}
+              </testsuite>
+            {{/testsuites}}
+          </testsuites>
+        XML
+
+        def initialize(path_or_io = STDOUT)
+          @path_or_io = path_or_io
+          path_or_io.parent.mkdir_p if path_or_io.is_a?(Path)
+        end
+
+        attr_reader :template_data, :timer_all, :timer_specification, :timer_testcase
+
+        def before_all
+          @timer_all = Time.now
+          @template_data = OpenStruct.new({
+            counts: Hash.new{|h,k| h[k] = 0 },
+            testsuites: []
+          })
+        end
+
+        def after_all
+          template_data.time = Time.now - timer_all
+        end
+
+        def before_specification
+          @timer_specification = Time.now
+          template_data.testsuites << OpenStruct.new({
+            :name => specification.name,
+            :counts => Hash.new{|h,k| h[k] = 0 },
+            :testcases => []
+          })
+        end
+
+        def specification_done
+          template_data.testsuites[-1].time = Time.now - timer_specification
+        end
+
+        def spec_file_error(e)
+          template_data.testsuites[-1].testcases << OpenStruct.new({
+            :name => "Specification can be loaded",
+            :assert => 1,
+            :classname => "Webspicy.Specification",
+            :failures => [],
+            :errors => [OpenStruct.new({
+              :type => e.class,
+              :message => e.message
+            })]
+          })
+        end
+
+        def before_test_case
+          @timer_testcase = Time.now
+          template_data.testsuites[-1].testcases << OpenStruct.new({
+            :name => test_case.description,
+            :assert => test_case.assert.length,
+            :classname => test_case.class.name.to_s.gsub(/::/, "."),
+            :failures => [],
+            :errors => [],
+          })
+          template_data.counts[:total] += 1
+          template_data.testsuites[-1].counts[:total] += 1
+        end
+
+        def test_case_done
+          template_data.testsuites[-1].testcases[-1].time = Time.now - timer_testcase
+        end
+
+        def check_failure(check, ex)
+          template_data.testsuites[-1].testcases[-1].failures << OpenStruct.new({
+            :type => check.class.name,
+            :message => ex.message
+          })
+          template_data.counts[:failures] += 1
+          template_data.testsuites[-1].counts[:failures] += 1
+        end
+
+        def check_error(check, ex)
+          template_data.testsuites[-1].testcases[-1].errors << OpenStruct.new({
+            :type => check.class.name,
+            :message => ex.message
+          })
+          template_data.counts[:errors] += 1
+          template_data.testsuites[-1].counts[:errors] += 1
+        end
+
+        def report
+          require 'mustache'
+          with_io do |io|
+            io << Mustache.render(TPL, template_data)
+          end
+        end
+
+      private
+
+        def with_io(&bl)
+          case io = @path_or_io
+          when IO, StringIO
+            bl.call(io)
+          else
+            Path(io).open('w', &bl)
+          end
+        end
+
+      end # class JunitXmlFile
+    end # class Reporter
+  end # class Tester
+end # module Webspicy

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

@@ -7,7 +7,7 @@ module Webspicy
           io.print colorize_error("X", config)
         end
 
-        def after_each_done
+        def test_case_done
           if result.success?
             io.print colorize_success(".", config)
           elsif result.failure?

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

@@ -0,0 +1,14 @@
+module Webspicy
+  class Tester
+    class Reporter
+      class SuccessOrNot < Summary
+
+        def report
+          total_error_count
+        end
+
+      end # class SuccessOrNot
+      ErrorCount = SuccessOrNot # for backward compatibility
+    end # class Reporter
+  end # class Tester
+end # module Webspicy

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

@@ -26,7 +26,7 @@ module Webspicy
           @spec_file_errors_count += 1
         end
 
-        def after_each_done
+        def test_case_done
           if tester.test_case.counterexample?
             @counterexamples_count += 1
           else
@@ -54,8 +54,12 @@ module Webspicy
           io.flush
         end
 
+        def total_error_count
+          @spec_file_errors_count + @errors_count + @failures_count
+        end
+
         def success?
-          @spec_file_errors_count == 0 && @errors_count == 0 && @failures_count == 0
+          total_error_count == 0
         end
 
       end # class Summary

data/lib/webspicy/tester/result.rb

@@ -18,6 +18,7 @@ module Webspicy
           check!
         else
           @errors << [InvocationSuceeded.new(self), tester.invocation_error]
+          reporter.check_error(*errors.first)
         end
       end
       attr_reader :tester, :scope, :client

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 20
-    TINY  = 6
+    TINY  = 11
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/webspicy/web/specification.rb

@@ -9,7 +9,7 @@ module Webspicy
 
         def singleservice(raw)
           converted = {
-            name: raw[:name] || "Unamed specification",
+            name: raw[:name],
             url: raw[:url],
             services: [
               Webspicy::Web.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)

data/spec/unit/tester/fakesendgrid/test_email.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'webspicy/tester/fakesendgrid'
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      describe Email do
+
+        DATA = JSON.parse <<~J
+        {
+          "datetime": "2021-06-02T15:29:27.161Z",
+          "from": {
+            "email": "info@mydomain.be",
+            "name": "Foo Bar"
+          },
+          "subject": "Hello World",
+          "personalizations": [
+            {
+              "to": [
+                {
+                  "email": "support@mydomain.fr"
+                }
+              ]
+            }
+          ],
+          "content": [
+            {
+              "value": "test",
+              "type": "text/plain"
+            },
+            {
+              "value": "test <b>test</b> test",
+              "type": "text/html"
+            }
+          ]
+        }
+        J
+
+        subject{
+          Email.new(DATA)
+        }
+
+        it 'works as expected' do
+          expect(subject.from).to eql("info@mydomain.be")
+          expect(subject.to).to eql(["support@mydomain.fr"])
+          expect(subject.subject).to eql("Hello World")
+        end
+
+      end
+    end
+  end
+end

data/tasks/test.rake

@@ -5,8 +5,12 @@ namespace :test do
 
   desc "Runs unit tests on the library itself"
   RSpec::Core::RakeTask.new(:unit) do |t|
+    require 'path'
+    root_folder = Path.dir.parent
+    test_results = root_folder/"test-results"
+    puts (test_results/"unit-tests.xml").inspect
     t.pattern = "spec/unit/**/test_*.rb"
-    t.rspec_opts = ["-Ilib", "-Ispec/unit", "--color", "--backtrace", "--format=progress"]
+    t.rspec_opts = ["-Ilib", "-Ispec/unit", "--color", "--backtrace", "--format=progress", "--format RspecJunitFormatter", "--out #{test_results}/unit-tests.xml"]
   end
   tests << :unit
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.20.6
+  version: 0.20.11
 platform: ruby
 authors:
 - Bernard Lambeau
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,16 +98,16 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
 - !ruby/object:Gem::Dependency
   name: path
   requirement: !ruby/object:Gem::Requirement
@@ -198,11 +198,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables:
-- sandr
-- search
 - webspicy
 extensions: []
 extra_rdoc_files: []
@@ -210,8 +222,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/sandr
-- bin/search
 - bin/webspicy
 - doc/1-black-box-scene.md
 - doc/2-black-box-testing.md
@@ -251,6 +261,8 @@ files:
 - lib/webspicy/tester/assertions.rb
 - lib/webspicy/tester/client.rb
 - lib/webspicy/tester/failure.rb
+- lib/webspicy/tester/fakesendgrid.rb
+- lib/webspicy/tester/fakesendgrid/email.rb
 - lib/webspicy/tester/fakeses.rb
 - lib/webspicy/tester/fakeses/email.rb
 - lib/webspicy/tester/fakesmtp.rb
@@ -260,11 +272,12 @@ files:
 - lib/webspicy/tester/reporter.rb
 - lib/webspicy/tester/reporter/composite.rb
 - lib/webspicy/tester/reporter/documentation.rb
-- lib/webspicy/tester/reporter/error_count.rb
 - lib/webspicy/tester/reporter/exceptions.rb
 - lib/webspicy/tester/reporter/file_progress.rb
 - lib/webspicy/tester/reporter/file_summary.rb
+- lib/webspicy/tester/reporter/junit_xml_file.rb
 - lib/webspicy/tester/reporter/progress.rb
+- lib/webspicy/tester/reporter/success_or_not.rb
 - lib/webspicy/tester/reporter/summary.rb
 - lib/webspicy/tester/result.rb
 - lib/webspicy/tester/result/assert_met.rb
@@ -312,6 +325,7 @@ files:
 - spec/unit/support/world/fixtures/yaml.yml
 - spec/unit/support/world/test_world.rb
 - spec/unit/test_configuration.rb
+- spec/unit/tester/fakesendgrid/test_email.rb
 - spec/unit/tester/fakeses/test_email.rb
 - spec/unit/tester/fakesmtp/test_email.rb
 - spec/unit/tester/test_asserter.rb
@@ -326,7 +340,7 @@ homepage: http://github.com/enspirit/webspicy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -341,8 +355,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.1
-signing_key:
+rubygems_version: 3.2.15
+signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!
 test_files: []

data/bin/sandr

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-require 'path'
-
-def sandr(file)
-  file.write file.read.gsub(ARGV[0], ARGV[1])
-end
-
-Path.dir.parent.glob("lib/**/*.rb") do |file|
-  sandr(file)
-end
-
-Path.dir.parent.glob("spec/**/*.rb") do |file|
-  sandr(file)
-end

data/bin/search

@@ -1,2 +0,0 @@
-#!/bin/bash
-grep -Rn --color $1 lib spec

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

@@ -1,29 +0,0 @@
-module Webspicy
-  class Tester
-    class Reporter
-      class ErrorCount < Reporter
-
-        def initialize(*args, &bl)
-          super
-          @errors = Hash.new{|h,k| 0 }
-        end
-        attr_reader :errors
-
-        [
-          :spec_file_error,
-          :check_error,
-          :check_failure
-        ].each do |meth|
-          define_method(meth) do |*args, &bl|
-            @errors[meth] += 1
-          end
-        end
-
-        def report
-          @errors.values.inject(0){|memo,x| memo+x }
-        end
-
-      end # class ErrorCount
-    end # class Reporter
-  end # class Tester
-end # module Webspicy