Module: Uttk

Classes and Modules

Module Uttk::<
Module Uttk::Dumpers
Module Uttk::Filters
Module Uttk::Generators
Module Uttk::Loaders
Module Uttk::PathFilters
Module Uttk::Strategies
Module Uttk::Streams
Module Uttk::VersionId
Module Uttk::Weights
Class Uttk::AbortStatus
Class Uttk::ErrorStatus
Class Uttk::FailStatus
Class Uttk::Logger
Class Uttk::LoggerFactory
Class Uttk::ObserverError
Class Uttk::PassStatus
Class Uttk::RunningStatus
Class Uttk::SkipStatus
Class Uttk::StartStatus
Class Uttk::Status
Class Uttk::TimeoutAbortStatus
Class Uttk::UttkException

Constants

VersionId	=	::Version.parse("dev-util/uttk-0.4_p2#Teenager")
UTTK_MODULES	=	[]
S	=	Strategies	Modules shortcuts
L	=	Loaders
D	=	Dumpers
F	=	Filters
W	=	Weights
DEFAULT_OPTIONS	=	{ :observers => [], :backend => STDOUT.tty? ? 'DefaultColor' : 'Default', :loader => Loaders::Yaml, :wclass => Weights::Default, :attributes => {}, #FIXME: freeze :symbols => {}, #FIXME: freeze :log_severity => Logger::Severity::INFO, :log_verbosity => 0, :log_section => [], #FIXME: freeze :benchmark => false, :profile => false, :dump_status => false, :cache_mode => false, :cache_proc => DumpableProc.new('\|test, status\| status.pass? or (status.is_a? Uttk::SkipStatus and status.weight.pass?)'	Set default options

Attributes

my_data [R] Contains the OCmd::Datas::Data object, the result of the command running.

Public Class methods

bin()

[Source]

# File lib/uttk.rb, line 278
  def self.bin
    Config::CONFIG["RUBY_INSTALL_NAME"].to_ocmd[dir.parent.parent + 'bin/uttk']
  end

default_log( options=default_options, log_factory=default_log_factory(options) )

Return the default logger factory

[Source]

# File lib/uttk.rb, line 256
  def self.default_log ( options=default_options,
                         log_factory=default_log_factory(options) )
    log = log_factory.create
    options[:observers] << options[:backend] if options[:observers].empty?
    options[:observers].each do |backend|
      Filters[backend].each do |obsv|
        raise ObserverError, obsv unless obsv.respond_to? :update
        log.add_observer(obsv)
      end
    end
    log.info_basicObserver do
      log.add_observer(Uttk::Dumpers::Basic.new(STDERR))
      nil
    end
    log
  end

default_log_factory( options=default_options )

Return the default logger factory

[Source]

# File lib/uttk.rb, line 242
  def self.default_log_factory ( options=default_options )
    log_factory = LoggerFactory.new
    if ENV.has_key?('UTTK_SEVERITY')
      log_factory.severity_level = ENV['UTTK_SEVERITY']
    else
      log_factory.severity_level = options[:log_severity]
    end
    log_factory.verbosity_level = options[:log_verbosity]
    log_factory.section_tree << Logger::SectionNode.new('basicObserver')
    log_factory.active_section = options[:log_section]
    log_factory
  end

default_options()

[Source]

# File lib/uttk.rb, line 216
  def self.default_options
    DEFAULT_OPTIONS
  end

default_symtbl( options=default_options, log_factory=default_log_factory(options), log=default_log(options, log_factory))

Return the default symbol table

[Source]

# File lib/uttk.rb, line 221
  def self.default_symtbl ( options=default_options,
                            log_factory=default_log_factory(options),
                            log=default_log(options, log_factory))
    symtbl = SymTbl.new(options)
    symtbl[:uttk] = Pathname.new($0).expand_path
    symtbl[:ruby] = Config::CONFIG['RUBY_INSTALL_PATH']
    symtbl['uttk-unit''uttk-unit'] = symtbl[:uttk_unit] =
      (Uttk.dir.parent.parent/'bin'/'uttk-unit').expand_path.cleanpath
    symtbl[:core_ex] = CoreEx.dir
    symtbl[:symtbl_class] = symtbl.class
    symtbl[:pwd] = Pathname.pwd.expand_path
    symtbl[:loader] = options[:loader].new
    symtbl[:log_factory] = log_factory
    symtbl[:log] = log
    symtbl[:cache] = {}
    symtbl[:cache_proc] = options[:cache_proc]
    symtbl[:suite_name] = 'root'
    symtbl
  end

setup_autoload_all()

[Source]

# File lib/uttk.rb, line 144
  def self.setup_autoload_all
    UTTK_MODULES.each do |uttk_module|
      uttk_module.setup_autoload
    end
  end

uttk_eval(string, symtbl, filename=__FILE__, lineno=1)

Evaluate code in the context of the Uttk module

[Source]

# File lib/uttk.rb, line 274
  def self.uttk_eval(string, symtbl, filename=__FILE__, lineno=1)
    eval(string, binding, filename, lineno)
  end

Public Instance methods

pathname_to_class(p)

Autoload modules

[Source]

# File lib/uttk.rb, line 88
  def pathname_to_class(p)
    const = p.basename.to_s.sub(/\.rb$/, '')
    if const =~ ConstRegexp::RB_CONST
      const
    else
      raise(ArgumentError,
          "`#{p.to_s}' - your file doesn't follow our convention, " +
          "the filename must be equal to the class name you declared into.")
      nil
    end
  end

Protected Instance methods

abort_hook()

[Source]

# File lib/uttk/generators/templates/strategy-command.rb, line 44
      def abort_hook
        @runner.abort @my_data if @runner and defined? @my_data
        super
      end

assertion()

[Source]

# File lib/uttk/generators/templates/strategy-command.rb, line 33
      def assertion
        assert_cmd UM::StreamMatcher, @my_data,
                   :output => ...,
                   :error  => ...,
                   :exit   => ...
        # ...
        pass
      end

epilogue()

[Source]

# File lib/uttk/generators/templates/strategy-command.rb, line 51
      def epilogue
        @my_data.clean if defined? @my_data
        super
      end

run_impl()

[Source]

# File lib/uttk/generators/templates/strategy-command.rb, line 27
      def run_impl
        @my_data = @command.run @runner
      end

Introduction

How to use Uttk as a library

Methods

Classes and Modules

Constants

Attributes

Public Class methods

Public Instance methods

Protected Instance methods