rutema 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b895aa680e7df981e4915c65427164a6c0f3e423d7381adcb286c8c625ee11
-  data.tar.gz: eb6409e8c312f835dedd4f5f35588113a870b166eef9d73a8f7a84f4ae4c5101
+  metadata.gz: ce001ba104b5a1bb8b574e10a02a9d74d3a6af1e65b0e40b74aa5c41e6652451
+  data.tar.gz: 4e8c71a5ebb6f960a874d186bd555927699606045e2aba4e7f277e923fc5ba03
 SHA512:
-  metadata.gz: 3f7af65c99c671f3622287ed11ea0cd6fdd95539e339a0cf52561a974cd08f60fd9d57ae9f92328c45d3eb5ba26e37b99ff2d2a6309cee7c14c323cff16567e6
-  data.tar.gz: 0f5a684b9fca67d3b9cb6fed542996e27dc43229f77b87154da5d41bb27d88085f5d3335c747cdab6671e2a69eca929d768cf2a4f4730235db1127d05f94069f
+  metadata.gz: d90e9c5bcb2adb9ebd6f6c9cdd1df33a30521796014d5bb6f451651ac096fa5a88d149a4bd5c398fc95e7f4cc98df0e65fd7bf7512feff01477a70cd031cc464
+  data.tar.gz: 68e7173406f270d158af6a2acca1066b3539937ae07c30affa46f6a9c9ebab8327c49a22e7ff67341bac39782b1fd83d662bb744b7a56b71b60e9a50fb5d08b1

data/History.txt

@@ -1,6 +1,8 @@
-== 2.0.1 2026-03-02
+== 2.0.2 /2026-03-26
+ * Modernize the code base. Code style updated, gem versions updated, ruby 3.x and 4.x deprecations handled
+== 2.0.1/2026-03-02
  * Release the 10 year old changes that fix handling of execution context within steps
-== 2.0.0/ 2017-09-23
+== 2.0.0 /2017-09-23
  * Parsing behaviour has changed, parsing errors are not accepted and the run fails immediately
 == 2.0.0.pre15 /2017-02-08
  * Update gem dependencies

data/README.md

@@ -1,15 +1,14 @@
-## rutema
-[![Build Status](https://secure.travis-ci.org/damphyr/rutema.png)](http://travis-ci.org/damphyr/rutema) [![Coverage Status](https://coveralls.io/repos/damphyr/rutema/badge.svg)](https://coveralls.io/r/damphyr/rutema) [![Code Climate](https://codeclimate.com/github/damphyr/rutema.png)](https://codeclimate.com/github/damphyr/rutema) ![doc status](http://inch-ci.org/github/damphyr/rutema.svg?branch=master) [![Gem Version](https://badge.fury.io/rb/rutema.svg)](https://badge.fury.io/rb/rutema)
+# rutema
 
-rutema [http://github.com/damphyr/rutema](http://github.com/damphyr/rutema)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/damphyr/rutema/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/damphyr/rutema/tree/master) [![Coverage Status](https://coveralls.io/repos/damphyr/rutema/badge.svg)](https://coveralls.io/r/damphyr/rutema) [![Maintainability](https://qlty.sh/gh/damphyr/projects/rutema/maintainability.svg)](https://qlty.sh/gh/damphyr/projects/rutema) ![doc status](http://inch-ci.org/github/damphyr/rutema.svg?branch=master) [![Gem Version](https://badge.fury.io/rb/rutema.svg)](https://badge.fury.io/rb/rutema)
 
-rutema is a test execution tool and a framework for organizing and managing test execution across different tools.
+rutema [http://github.com/damphyr/rutema](http://github.com/damphyr/rutema) is a test execution tool and a framework for organizing and managing test execution across different tools.
 
 It enables the combination of different test tools while it takes care of logging, reporting, archiving of results and formalizes execution of automated and manual tests.
 
-It's purpose is to make testing in heterogeneous environments easier. 
+It's purpose is to make testing in heterogeneous environments easier.
 
-### Why?
+## Why?
 
 Require consistency, repeatability and reliability from your test infrastructure while gathering data on every run.
 
@@ -17,15 +16,15 @@ Whether running through a checklist of manual steps, or executing a sequence of
 
 rutema will gather all logs, timestamp them, store them and report on them. 
 
-Rutema core provides a reference implementation of a parser for a simple but extensible XML test specification format which works well out of the box but the framework provides clearly defined interfaces so you can write the parser for your own format and add reporters that log wherever is needed.
+rutema core provides a reference implementation of a parser for a simple but extensible XML test specification format which works well out of the box but the framework provides clearly defined interfaces so you can write the parser for your own format and add reporters that log wherever is needed.
 
-### The dry stuff
+## The dry stuff
 
 * Unified test execution environment for automated and manual tests
 * Extensible reports and notifications in various formats (email, rss, pdf, html etc.)
 * A well defined way to create a project specific test specification format
 
-### Further Reading
+## Further Reading
 
 * [Configuring rutema](doc/CONFIGURATION.md)
 * An [example](doc/EXAMPLE.md) of a (very simple) testing DSL with rutema 
@@ -38,14 +37,15 @@ Rutema core provides a reference implementation of a parser for a simple but ext
 ## Dependencies
 
 The core functionality of rutema depends on the following gems:
- * [patir](http://github.com/damphyr/patir)
- * [highline](http://highline.rubyforge.org/)
+
+* [patir](http://github.com/damphyr/patir)
+* [highline](http://highline.rubyforge.org/)
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2007-2017 Vassilis Rizopoulos
+Copyright (c) 2007-2026 Vassilis Rizopoulos
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/rutema

@@ -2,10 +2,10 @@
 
 #  Copyright (c) 2007-2021 Vassilis Rizopoulos. All rights reserved.
 
-require 'rutema/application'
+require "rutema/application"
 begin
-	Rutema::App.new(ARGV)
+  Rutema::App.new(ARGV)
 rescue Rutema::RutemaError
- puts $!.message
- exit 1
+  puts $!.message
+  exit 1
 end

data/lib/rutema/application.rb

@@ -1,6 +1,6 @@
 #  Copyright (c) 2021 Vassilis Rizopoulos. All rights reserved.
 
-require  'optparse'
+require "optparse"
 
 require_relative "core/configuration"
 require_relative "core/engine"
@@ -15,17 +15,17 @@ module Rutema
     ##
     # Configure and start the application flow according to the passed
     # commandline options
-    def initialize command_line_args
+    def initialize(command_line_args)
       parse_command_line(command_line_args)
-      @configuration=Rutema::Configuration.new(@config_file)
-      @configuration.context||={}
-      @configuration.context[:config_file]=File.expand_path(@config_file)
-      @configuration.context[:config_name]=File.basename(@config_file)
-      @configuration.context[:start_time]=Time.now
-      @configuration.reporters||={}
-      @configuration.reporters[Rutema::Reporters::Console]||={:class=>Rutema::Reporters::Console, "silent"=>@silent} unless @bare
-      @configuration.reporters[Rutema::Reporters::Summary]||={:class=>Rutema::Reporters::Summary, "silent"=>(@silent||@bare)}
-      @engine=Rutema::Engine.new(@configuration)
+      @configuration = Rutema::Configuration.new(@config_file)
+      @configuration.context ||= {}
+      @configuration.context[:config_file] = File.expand_path(@config_file)
+      @configuration.context[:config_name] = File.basename(@config_file)
+      @configuration.context[:start_time] = Time.now
+      @configuration.reporters ||= {}
+      @configuration.reporters[Rutema::Reporters::Console] ||= { :class => Rutema::Reporters::Console, "silent" => @silent } unless @bare
+      @configuration.reporters[Rutema::Reporters::Summary] ||= { :class => Rutema::Reporters::Summary, "silent" => @silent || @bare }
+      @engine = Rutema::Engine.new(@configuration)
       application_flow
     end
 
@@ -34,30 +34,34 @@ module Rutema
     ##
     # Define the available commandline options and parse the given commandline
     # accordingly
-    def parse_command_line args
+    def parse_command_line(args)
       args.options do |opt|
         opt.on("rutema v#{Version::STRING}")
         opt.on("Options:")
-        opt.on("--config FILE", "-c FILE",String,"Loads the configuration from FILE") { |config_file| @config_file=config_file}
-        opt.on("--check","Runs just the suite setup test"){@check=true}
-        #opt.on("--step","Runs test cases step by step"){@step=true}
-        opt.on("--silent","Suppresses console output (only for the default reporters)") { @silent=true}
-        opt.on("--bare","No default reporters whatsoever") { @bare=true}
-        #opt.on("--color","Adds color to the Console reporter") { @color=true}
-        opt.on("-v", "--version","Displays the version") { $stdout.puts("rutema v#{Version::STRING}");exit 0 }
-        opt.on("--help", "-h", "-?", "This text") { $stdout.puts opt; exit 0 }
-        opt.on("--debug", "-d", "Turn on debug messages") { $DEBUG=true }
+        opt.on("--config FILE", "-c FILE", String, "Loads the configuration from FILE") { |config_file| @config_file = config_file }
+        opt.on("--check", "Runs just the suite setup test") { @check = true }
+        # opt.on("--step","Runs test cases step by step"){@step=true}
+        opt.on("--silent", "Suppresses console output (only for the default reporters)") { @silent = true }
+        opt.on("--bare", "No default reporters whatsoever") { @bare = true }
+        # opt.on("--color","Adds color to the Console reporter") { @color=true}
+        opt.on("-v", "--version", "Displays the version") do
+          $stdout.puts("rutema v#{Version::STRING}")
+          exit 0
+        end
+        opt.on("--help", "-h", "-?", "This text") do
+          $stdout.puts opt
+          exit 0
+        end
+        opt.on("--debug", "-d", "Turn on debug messages") { $DEBUG = true }
         opt.on("You can provide a specification filename in order to run a single test")
         opt.parse!
-        #and now the rest
+        # and now the rest
         unless @config_file
           puts "No configuration file defined!\n"
-          $stdout.puts opt 
+          $stdout.puts opt
           exit 1
         end
-        if !args.empty?
-          @test_identifier=args.shift
-        end
+        @test_identifier = args.shift unless args.empty?
       end
     end
 
@@ -66,11 +70,10 @@ module Rutema
     def application_flow
       if @check
         # run just the suite setup test if requested
-        if @configuration.suite_setup
-          exit @engine.run(@configuration.suite_setup)
-        else
-          raise Rutema::RutemaError,"There is no suite setup test defined in the configuration."
-        end
+        raise Rutema::RutemaError, "There is no suite setup test defined in the configuration." unless @configuration.suite_setup
+
+        exit @engine.run(@configuration.suite_setup)
+
       else
         # run everything
         exit @engine.run(@test_identifier)

data/lib/rutema/core/configuration.rb

@@ -1,9 +1,9 @@
 #  Copyright (c) 2007-2021 Vassilis Rizopoulos. All rights reserved.
 
-  require 'ostruct'
-  require_relative 'parser'
-  require_relative 'reporter'
-  module Rutema
+require "ostruct"
+require_relative "parser"
+require_relative "reporter"
+module Rutema
   ##
   # Mix-in module defining all configuration directives available for rutema
   #
@@ -16,12 +16,12 @@
   # the language including _require_ directives.
   #
   #     require "rake/file_list"
-  #     
+  #
   #     configure do |cfg|
   #       cfg.parser = { :class => Rutema::Parsers::XML }
   #       cfg.tests = FileList['all/of/the/tests/**/*.*']
   #     end
-    module ConfigurationDirectives
+  module ConfigurationDirectives
     ##
     # Hash of context data which may be utilized throughout test runs
     #
@@ -99,10 +99,11 @@
     # The path to NUnit can be accessed the following way:
     #
     #     @configuration.tools["nunit"][:path]
-      def tool= definition
-        raise ConfigurationException,"required key :name is missing from #{definition}" unless definition[:name]
-        @tools[definition[:name]]=definition
-      end
+    def tool=(definition)
+      raise ConfigurationException, "required key :name is missing from #{definition}" unless definition[:name]
+
+      @tools[definition[:name]] = definition
+    end
 
     ##
     # Add a path indexed by a representative name to the paths attribute
@@ -118,11 +119,12 @@
     #     configure do |cfg|
     #       cfg.path = { :name => "doc", :path => "/usr/local/share/doc" }
     #     end
-      def path= definition
-        raise ConfigurationException,"required key :name is missing from #{definition}" unless definition[:name]
-        raise ConfigurationException,"required key :path is missing from #{definition}" unless definition[:path]
-        @paths[definition[:name]]=definition[:path]
-      end
+    def path=(definition)
+      raise ConfigurationException, "required key :name is missing from #{definition}" unless definition[:name]
+      raise ConfigurationException, "required key :path is missing from #{definition}" unless definition[:path]
+
+      @paths[definition[:name]] = definition[:path]
+    end
 
     ##
     # Path to a setup specification (optional)
@@ -130,9 +132,9 @@
     # This setup specification will be run before every test specification.
     #
     # Later calls override earlier ones.
-      def setup= path
-        @setup=check_path(path)
-      end
+    def setup=(path)
+      @setup = check_path(path)
+    end
 
     ##
     # Path to a teardown specification (optional)
@@ -140,9 +142,9 @@
     # This teardown specification will be run after every test specification.
     #
     # Later calls override earlier ones.
-      def teardown= path
-        @teardown=check_path(path)
-      end
+    def teardown=(path)
+      @teardown = check_path(path)
+    end
 
     ##
     # Path to a suite setup specification (optional)
@@ -154,12 +156,12 @@
     # This is aliased as #check= for backwards compatibility.
     #
     # Later calls override earlier ones.
-      def suite_setup= path
-        @suite_setup=check_path(path)
-      end
+    def suite_setup=(path)
+      @suite_setup = check_path(path)
+    end
 
-      alias_method :check,:suite_setup
-      alias_method :check=,:suite_setup=
+    alias check suite_setup
+    alias check= suite_setup=
 
     ##
     # Path to a suite teardown specification (optional)
@@ -168,9 +170,9 @@
     # specifications have been executed.
     #
     # Later calls override earlier ones.
-      def suite_teardown= path
-        @suite_teardown=check_path(path)
-      end
+    def suite_teardown=(path)
+      @suite_teardown = check_path(path)
+    end
 
     ##
     # Context information which shall be accessible during test execution
@@ -180,20 +182,21 @@
     #
     # This could be used e.g. to pass data as tester names, version numbers,
     # etc. to the reporters.
-      def context= definition
-        @context||=Hash.new
-        raise ConfigurationException,"Only accepting hash values as context_data" unless definition.kind_of?(Hash)
-        @context.merge!(definition)
-      end
+    def context=(definition)
+      @context ||= {}
+      raise ConfigurationException, "Only accepting hash values as context_data" unless definition.is_a?(Hash)
+
+      @context.merge!(definition)
+    end
 
     ##
     # Add an array of (paths of) test specifications to be executed
     #
     # Usually an array of file paths would be given. Generally the passed array
     # can contain anything intelligible for the parser.
-      def tests= array_of_identifiers
-        @tests+=array_of_identifiers.map{|f| full_path(f)}
-      end
+    def tests=(array_of_identifiers)
+      @tests += array_of_identifiers.map { |f| full_path(f) }
+    end
 
     ##
     # Set the parser class which shall be used to parse test specifications
@@ -208,10 +211,11 @@
     #     configure do |cfg|
     #      cfg.parser = { :class => Rutema::Parsers::XML }
     #     end
-      def parser= definition
-        raise ConfigurationException,"required key :class is missing from #{definition}" unless definition[:class]
-        @parser=definition
-      end
+    def parser=(definition)
+      raise ConfigurationException, "required key :class is missing from #{definition}" unless definition[:class]
+
+      @parser = definition
+    end
 
     ##
     # Set the runner which shall be used to execute the tests
@@ -229,10 +233,11 @@
     #     configure do |cfg|
     #      cfg.runner = { :class => Rutema::Runners::Default }
     #     end
-      def runner= definition
-        raise ConfigurationException,"required key :class is missing from #{definition}" unless definition[:class]
-        @runner=definition
-      end
+    def runner=(definition)
+      raise ConfigurationException, "required key :class is missing from #{definition}" unless definition[:class]
+
+      @runner = definition
+    end
 
     ##
     # Add a reporter for the test execution
@@ -248,47 +253,50 @@
     #      cfg.reporters = { :class => Rutema::Reporters::Console }
     #      cfg.reporters = { :class => Rutema::Reporters::JUnit }
     #     end
-      def reporter= definition
-        raise ConfigurationException,"required key :class is missing from #{definition}" unless definition[:class]
-        @reporters[definition[:class]]=definition
-      end
+    def reporter=(definition)
+      raise ConfigurationException, "required key :class is missing from #{definition}" unless definition[:class]
+
+      @reporters[definition[:class]] = definition
+    end
 
     ##
     # Initialize member variables which are needed to process a configuration
-      def init
-        @reporters={}
-        @context={}
-        @tests=[]
-        @tools=OpenStruct.new
-        @paths=OpenStruct.new
-      end
+    def init
+      @reporters = {}
+      @context = {}
+      @tests = []
+      @tools = OpenStruct.new
+      @paths = OpenStruct.new
+    end
 
-      private
+    private
 
     ##
     # Check if the given path exists and raise a ConfigurationException if not
-      def check_path path
-        path=File.expand_path(path)
-        raise ConfigurationException,"#{path} does not exist" unless File.exist?(path)
-        return path
-      end
+    def check_path(path)
+      path = File.expand_path(path)
+      raise ConfigurationException, "#{path} does not exist" unless File.exist?(path)
+
+      return path
+    end
 
     ##
     # Return a string in the form of "key=value,key=value" for a given hash
-      def definition_string definition
-        msg=Array.new
-        definition.each{|k,v| msg<<"#{k}=#{v}"}
-        return msg.join(",")
-      end
+    def definition_string(definition)
+      msg = definition.map { |k, v| "#{k}=#{v}" }
+      # definition.each { |k, v| msg << "#{k}=#{v}" }
+      return msg.join(",")
+    end
 
     ##
     # Convert the given filename to an absolute path if the file exists or
     # otherwise return the passed filename as is
-      def full_path filename
-        return File.expand_path(filename) if File.exist?(filename)
-        return filename
-      end
+    def full_path(filename)
+      return File.expand_path(filename) if File.exist?(filename)
+
+      return filename
     end
+  end
 
   ##
   # Exception which is being raised upon errors concerning configurations passed
@@ -299,8 +307,8 @@
   # * a file or path could not be found/does not exist
   # * passed hash arguments being of an unexpected/unhandled type
   # * passed hash arguments missing required keys
-    class ConfigurationException<RuntimeError
-    end
+  class ConfigurationException < RuntimeError
+  end
 
   ##
   # Class for reading, parsing and representing the configuration for a rutema
@@ -310,24 +318,24 @@
   # component which tests to execute how.
   #
   # Rutema::ConfigurationDirectives defines all relevant methods and attributes.
-    class Configuration
-      include ConfigurationDirectives
+  class Configuration
+    include ConfigurationDirectives
 
     ##
     # The filename of the root configuration file from which the Configuration
     # instance was built
-      attr_reader :filename
+    attr_reader :filename
 
     ##
     # Create a new instance by parsing the given configuration file
     #
     # * +config_file+ - the configuration file which shall be parsed on
     #   initializing the new instance
-      def initialize config_file
-        @filename=config_file
-        init
-        load_configuration(@filename)
-      end
+    def initialize(config_file)
+      @filename = config_file
+      init
+      load_configuration(@filename)
+    end
 
     ##
     # Yield the instance itself if a block is given
@@ -335,11 +343,11 @@
     # This can be used e.g. in configuration files to execute a block on the
     # Configuration instance itself (e.g. to modify it through the setter
     # methods of the ConfigurationDirectives module).
-      def configure
-        if block_given?
-          yield self
-        end
-      end
+    def configure
+      return unless block_given?
+
+      yield self
+    end
 
     ##
     # Load and import the configuration from a file
@@ -353,42 +361,40 @@
     # the specialized configurations can import the "main.rutema" as follows:
     #
     #     import("main.rutema")
-      def import filename
-        fnm = File.expand_path(filename)
-        if File.exist?(fnm)          
-          load_configuration(fnm)
-        else
-          raise ConfigurationException, "Import error: Can't find #{fnm}"
-        end
-      end
+    def import(filename)
+      fnm = File.expand_path(filename)
+      raise ConfigurationException, "Import error: Can't find #{fnm}" unless File.exist?(fnm)
+
+      load_configuration(fnm)
+    end
 
-      private
+    private
 
     ##
     # Load the configuration from the file given by +filename+
     #
     # On many common parsing errors a ConfigurationException is being raised.
-      def load_configuration filename
-        begin 
-          cfg_txt=File.read(filename)
-          cwd=File.expand_path(File.dirname(filename))
-          # WORKAROUND for ruby 2.3.1
-          fname=File.basename(filename)
-          # evaluate in the working directory to enable relative paths in
-          # configuration
-          Dir.chdir(cwd){eval(cfg_txt,binding(),fname,__LINE__)}
-        rescue ConfigurationException
-          # pass it on, do not wrap again
-          raise
-        rescue SyntaxError
-          # just wrap the exception so we can differentiate
-          raise ConfigurationException.new,"Syntax error in the configuration file '#{filename}':\n#{$!.message}"
-        rescue NoMethodError
-          raise ConfigurationException.new,"Encountered an unknown directive in configuration file '#{filename}':\n#{$!.message}"
-        rescue 
-          # just wrap the exception so we can differentiate
-          raise ConfigurationException.new,"#{$!.message}"
-        end
-      end
+    def load_configuration(filename)
+      cfg_txt = File.read(filename)
+      cwd = File.expand_path(File.dirname(filename))
+      # WORKAROUND for ruby 2.3.1
+      fname = File.basename(filename)
+      # evaluate in the working directory to enable relative paths in
+      # configuration
+      # rubocop:disable  Security/Eval
+      Dir.chdir(cwd) { eval(cfg_txt, binding, fname, __LINE__) }
+      # rubocop:enable  Security/Eval
+    rescue ConfigurationException
+      # pass it on, do not wrap again
+      raise
+    rescue SyntaxError
+      # just wrap the exception so we can differentiate
+      raise ConfigurationException.new, "Syntax error in the configuration file '#{filename}':\n#{$!.message}"
+    rescue NoMethodError
+      raise ConfigurationException.new, "Encountered an unknown directive in configuration file '#{filename}':\n#{$!.message}"
+    rescue StandardError
+      # just wrap the exception so we can differentiate
+      raise ConfigurationException.new, $!.message
     end
   end
+end