spectre-core 1.15.2 → 2.0.1

metadata

@@ -1,43 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: spectre-core
 version: !ruby/object:Gem::Version
-  version: 1.15.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  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'
 - !ruby/object:Gem::Dependency
   name: ectoplasm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: jsonpath
+  name: stringio
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: A DSL and command line tool to describe and run automated tests
 email:
 - christian.neubauer@ionos.com
@@ -49,30 +90,15 @@ files:
 - exe/spectre
 - lib/spectre.rb
 - lib/spectre/assertion.rb
-- lib/spectre/async.rb
-- lib/spectre/bag.rb
-- lib/spectre/curl.rb
-- lib/spectre/diagnostic.rb
-- lib/spectre/environment.rb
+- lib/spectre/expectation.rb
 - lib/spectre/helpers.rb
-- lib/spectre/http.rb
-- lib/spectre/http/basic_auth.rb
-- lib/spectre/http/keystone.rb
-- lib/spectre/logging.rb
-- lib/spectre/logging/console.rb
-- lib/spectre/logging/file.rb
-- lib/spectre/mixin.rb
-- lib/spectre/reporter.rb
-- lib/spectre/reporter/console.rb
-- lib/spectre/resources.rb
+- lib/spectre/version.rb
 homepage: https://github.com/ionos-spectre/spectre-core
 licenses:
 - GPL-3.0-or-later
 metadata:
-  homepage_uri: https://github.com/ionos-spectre/spectre-core
   source_code_uri: https://github.com/ionos-spectre/spectre-core
   changelog_uri: https://github.com/ionos-spectre/spectre-core/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Describe and run automated tests
 test_files: []

data/lib/spectre/async.rb

@@ -1,31 +0,0 @@
-require_relative '../spectre'
-
-Thread.abort_on_exception = true
-
-module Spectre
-  module Async
-    class << self
-      @@threads = {}
-
-      def async name='default', &block
-        unless @@threads.key? name
-          @@threads[name] = []
-        end
-
-        @@threads[name] << Thread.new(&block)
-      end
-
-      def await name='default'
-        return unless @@threads.key? name
-
-        threads = @@threads[name].map { |x| x.join() }
-
-        @@threads.delete(name)
-
-        threads.map { |x| x.value }
-      end
-    end
-
-    Spectre.delegate :async, :await, to: self
-  end
-end

data/lib/spectre/bag.rb

@@ -1,17 +0,0 @@
-require_relative '../spectre'
-
-require 'ostruct'
-
-module Spectre
-  module Bag
-    class << self
-      @@bag = OpenStruct.new
-
-      def bag
-        @@bag
-      end
-    end
-
-    Spectre.delegate :bag, to: self
-  end
-end

data/lib/spectre/curl.rb

@@ -1,398 +0,0 @@
-require_relative '../spectre'
-
-require 'open3'
-require 'ostruct'
-
-
-module Spectre::Curl
-  class SpectreHttpRequest < Spectre::DslClass
-    def initialize request
-      @__req = request
-    end
-
-    def method method_name
-      @__req['method'] = method_name.upcase
-    end
-
-    def url base_url
-      @__req['base_url'] = base_url
-    end
-
-    def path url_path
-      @__req['path'] = url_path
-    end
-
-    def header name, value
-      @__req['headers'] = [] unless @__req['headers']
-      @__req['headers'].append [name, value.to_s.strip]
-    end
-
-    def param name, value
-      @__req['query'] = [] unless @__req['query']
-      @__req['query'].append [name, value.to_s.strip]
-    end
-
-    def content_type media_type
-      @__req['headers'] = [] unless @__req['headers']
-      @__req['headers'].append ['Content-Type', media_type]
-    end
-
-    def json data
-      body JSON.pretty_generate(data)
-      content_type 'application/json'
-    end
-
-    def body body_content
-      @__req['body'] = body_content
-    end
-
-    def ensure_success!
-      @__req['ensure_success'] = true
-    end
-
-    def ensure_success?
-      @__req['ensure_success']
-    end
-
-    def authenticate method
-      @__req['auth'] = method
-    end
-
-    def certificate path
-      @__req['cert'] = path
-      use_ssl!
-    end
-
-    def use_ssl!
-      @__req['use_ssl'] = true
-    end
-
-    alias_method :auth, :authenticate
-    alias_method :cert, :certificate
-    alias_method :media_type, :content_type
-  end
-
-  class SpectreHttpHeader
-    def initialize headers
-      @headers = headers || {}
-    end
-
-    def [] key
-      @headers[key.downcase]
-    end
-  end
-
-  class SpectreHttpResponse
-    def initialize res
-      @res = res
-      @data = nil
-    end
-
-    def code
-      @res[:code]
-    end
-
-    def message
-      @res[:message]
-    end
-
-    def protocol
-      @res[:protocol]
-    end
-
-    def version
-      @res[:version]
-    end
-
-    def headers
-      SpectreHttpHeader.new @res[:headers]
-    end
-
-    def body
-      @res[:body]
-    end
-
-    def json
-      return nil unless @res[:body]
-
-      if @data == nil
-        begin
-          @data = JSON.parse(@res[:body], object_class: OpenStruct)
-        rescue
-          raise 'invalid json'
-        end
-      end
-
-      @data
-    end
-
-    def success?
-      @res[:code] < 400
-    end
-
-    def pretty
-      @res.pretty
-    end
-  end
-
-  # DEFAULT_HTTP_REQUEST = {
-  #   'method' => 'GET',  # -X, --request <cmd>
-  #   'base_url' => nil,
-  #   'path' => nil,
-  #   'headers' => nil,   # -H, --header <header/@file>
-  #   'query' => nil,
-  #   'body' => nil,      # -d, --data <data>
-  #   'cert' => nil,      # --cacert
-  #   'follow' => false,  # -L, --location
-  #   'username' => nil,  # -u, --user <user:password>
-  #   'password' => nil,
-  #   'use_ssl' => false, # -k
-  # }
-
-
-  class << self
-    @@http_cfg = {}
-    @@response = nil
-    @@request = nil
-    @@modules = []
-
-    def curl name, secure: false, &block
-      req = {
-        'use_ssl' => secure,
-      }
-
-      if @@http_cfg.key? name
-        req.merge! @@http_cfg[name]
-        raise "No `base_url' set for HTTP client '#{name}'. Check your HTTP config in your environment." unless req['base_url']
-      else
-        req['base_url'] = name
-      end
-
-      SpectreHttpRequest.new(req)._evaluate(&block) if block_given?
-
-      invoke(req)
-    end
-
-    def curl_request
-      raise 'No request has been invoked yet' unless @@request
-
-      @@request
-    end
-
-    def curl_response
-      raise 'There is no response. No request has been invoked yet.' unless @@response
-
-      @@response
-    end
-
-    def register mod
-      raise 'Module must not be nil' unless mod
-
-      @@modules << mod
-    end
-
-    private
-
-    def try_format_json str, pretty: false
-      return str unless str or str.empty?
-
-      begin
-        json = JSON.parse(str)
-        json.obfuscate!(@@secure_keys) unless @@debug
-
-        if pretty
-          str = JSON.pretty_generate(json)
-        else
-          str = JSON.dump(json)
-        end
-      rescue
-        # do nothing
-      end
-
-      str
-    end
-
-    def secure? key
-      @@secure_keys.any? { |x| key.to_s.downcase.include? x.downcase }
-    end
-
-    def header_to_s headers
-      s = ''
-
-      return s unless headers
-
-      headers.each do |header|
-        key = header[0].to_s
-        value = header[1].to_s
-        value = '*****' if secure?(key) and not @@debug
-        s += "#{key.ljust(30, '.')}: #{value}\n"
-      end
-
-      s
-    end
-
-    def invoke req
-      cmd = [@@curl_path]
-
-      if req['cert'] or req['use_ssl']
-        scheme = 'https'
-      else
-        scheme = 'http'
-      end
-
-      uri = req['base_url']
-
-      unless uri.match /http(?:s)?:\/\//
-        uri = scheme + '://' + uri
-      end
-
-      if req['path']
-        uri += '/' unless uri.end_with? '/'
-        uri += req['path']
-      end
-
-      if req['query']
-        uri += '?'
-        uri += req['query']
-          .map { |x| x.join '='}
-          .join('&')
-      end
-
-      cmd.append('"' + uri + '"')
-      cmd.append('-X', req['method']) unless req['method'] == 'GET' or (req['body'] and req['method'] == 'POST')
-
-      # Call all registered modules
-      @@modules.each do |mod|
-        mod.on_req(req, cmd) if mod.respond_to? :on_req
-      end
-
-      # Add headers to curl command
-      req['headers'].each do |header|
-        cmd.append('-H', '"' + header.join(':') + '"')
-      end if req['headers']
-
-      # Add request body
-      if req['body'] != nil and not req['body'].empty?
-        req_body = try_format_json(req['body']).gsub(/"/, '\\"')
-        cmd.append('-d', '"' + req_body + '"')
-      elsif ['POST', 'PUT', 'PATCH'].include? req['method'].upcase
-        cmd.append('-d', '"\n"')
-      end
-
-      # Add certificate path if one is given
-      if req['cert']
-        raise "Certificate '#{req['cert']}' does not exist" unless File.exist? req['cert']
-
-        cmd.append('--cacert', req['cert'])
-      elsif req['use_ssl'] or uri.start_with? 'https'
-        cmd.append('-k')
-      end
-
-      cmd.append('-i')
-      cmd.append('-v')
-
-      @@request = OpenStruct.new(req)
-
-      sys_cmd = cmd.join(' ')
-
-      @@logger.debug(sys_cmd)
-
-      req_id = SecureRandom.uuid()[0..5]
-
-      req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
-      req_log += header_to_s(req['headers'])
-
-      if req[:body] != nil and not req[:body].empty?
-        req_log += try_format_json(req['body'], pretty: true)
-      end
-
-      @@logger.info(req_log)
-
-      start_time = Time.now
-
-      _, stdout, stderr, wait_thr = Open3.popen3(sys_cmd)
-
-      end_time = Time.now
-
-      output = stdout.gets(nil)
-      stdout.close
-
-      debug_log = stderr.gets(nil)
-      stderr.close
-
-      # debug_log.lines.each { |x| @@logger.debug x unless x.empty? }
-
-      raise "Unable to request #{uri}. Please check if this URL is correctly configured and reachable." unless output
-
-      @@logger.debug("[<] #{req_id} stdout:\n#{output}")
-
-      header, body = output.split /\r?\n\r?\n/
-
-      result = header.lines.first
-
-      exit_code = wait_thr.value.exitstatus
-
-      raise Exception.new "An error occurred while executing curl:\n#{debug_log.lines.map { |x| not x.empty? }}" unless exit_code == 0
-
-      # Parse protocol, version, status code and status message from response
-      match = /^(?<protocol>[A-Za-z0-9]+)\/(?<version>\d+\.?\d*) (?<code>\d+) (?<message>.*)/.match result
-
-      raise "Unexpected result from curl request:\n#{result}" unless match
-
-      res_headers = header.lines[1..-1]
-        .map { |x| /^(?<key>[A-Za-z0-9-]+):\s*(?<value>.*)$/.match x }
-        .select { |x| x != nil }
-        .map { |x| [x[:key].downcase, x[:value]] }
-
-      res = {
-        protocol: match[:protocol],
-        version: match[:version],
-        code: match[:code].to_i,
-        message: match[:message],
-        headers: Hash[res_headers],
-        body: body,
-      }
-
-      # Call all registered modules
-      @@modules.each do |mod|
-        mod.on_res(res, output) if mod.respond_to? :on_res
-      end
-
-      res_log = "[<] #{req_id} #{res[:code]} #{res[:message]} (#{end_time - start_time}s)\n"
-      res_headers.each do |http_header|
-        res_log += "#{http_header[0].to_s.ljust(30, '.')}: #{http_header[1].to_s}\n"
-      end
-
-      if res[:body] != nil and not res[:body].empty?
-        res_log += try_format_json(res[:body], pretty: true)
-      end
-
-      @@logger.info res_log
-
-      @@response = SpectreHttpResponse.new(res)
-
-      raise "Response did not indicate success: #{@@response.code} #{@@response.message}" if req['ensure_success'] and not @@response.success?
-
-      @@response
-    end
-  end
-
-  Spectre.register do |config|
-    @@debug = config['debug']
-
-    @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/curl')
-
-    @@secure_keys = config['secure_keys'] || []
-    @@curl_path = config['curl_path'] || 'curl'
-
-    if config.key? 'http'
-      @@http_cfg = {}
-
-      config['http'].each do |name, cfg|
-        @@http_cfg[name] = cfg
-      end
-    end
-  end
-
-  Spectre.delegate :curl, :curl_response, :curl_request, to: self
-end

data/lib/spectre/diagnostic.rb

@@ -1,39 +0,0 @@
-require_relative '../spectre'
-
-module Spectre
-  module Diagnostic
-    module Stopwatch
-      @@duration = 0.0
-
-      class << self
-        def start_watch
-          @@start_time = Time.now
-        end
-
-        def stop_watch
-          @@end_time = Time.now
-        end
-
-        def measure
-          start_watch
-          yield
-          stop_watch
-        end
-
-        def duration
-          @@end_time - @@start_time
-        end
-
-        def started_at
-          @@start_time
-        end
-
-        def finished_at
-          @@end_time
-        end
-      end
-
-      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: self
-    end
-  end
-end

data/lib/spectre/environment.rb

@@ -1,30 +0,0 @@
-require_relative '../spectre'
-
-require 'ostruct'
-
-def to_recursive_ostruct(hash)
-  OpenStruct.new(
-    hash.each_with_object({}) do |(key, val), memo|
-      memo[key] = val.is_a?(Hash) ? to_recursive_ostruct(val) : val
-    end
-  )
-end
-
-module Spectre
-  module Environment
-    class << self
-      @@environment = OpenStruct.new
-
-      def env
-        @@environment
-      end
-    end
-
-    Spectre.register do |config|
-      @@environment = to_recursive_ostruct(config)
-      @@environment.freeze
-    end
-
-    Spectre.delegate :env, to: self
-  end
-end

data/lib/spectre/http/basic_auth.rb

@@ -1,25 +0,0 @@
-require_relative '../http'
-
-module Spectre::Http
-  class SpectreHttpRequest
-    def basic_auth username, password
-      @__req['basic_auth'] = {} unless @__req.key? 'basic_auth'
-
-      @__req['basic_auth']['username'] = username
-      @__req['basic_auth']['password'] = password
-
-      @__req['auth'] = 'basic_auth'
-    end
-  end
-
-  module BasicAuth
-    def self.on_req _http, net_req, req
-      return unless req.key? 'basic_auth' and req['auth'] == 'basic_auth'
-
-      basic_auth_cfg = req['basic_auth']
-      net_req.basic_auth(basic_auth_cfg['username'], basic_auth_cfg['password'])
-    end
-
-    Spectre::Http.register(self)
-  end
-end