damphyr/rutema

## rutema examples

Where would we be without working examples. All working examples are configured in [suites/](suites).


To run rutema's own system tests do

```
ruby -I lib/ bin/rutema -c examples/suites/rutema.rutema
```

## Structure

The basic structure we follow in rutema usage (and this has been "in production" for almost a decade) is

````
config/ 
specs/
scripts/
suites/
````

Configuration files are stored in config/ and suites/ and have per convention the extension .rutema.

Note that there is no difference between a configuration file with tool
parameters and a configuration file that defines a test suite. The difference
is by convention. Tool, path and test environment specific configuration is
saved in config/ in the tool parameter specifc file and the collection of tests
to run per configuration in suites/*.

## rutema tooling

The configuration system allows to replace every part of the rutema engine.
There are three major parts: the parser, the runner and the reporter. The parser
must always be specified, it handles the specific testing language you will
develop for the project.

The runner is the simplest component and a default implementation is provided.
The reporters that can be made available are limited only by the time and
creativity to come up with solutions, but a simple console output is provided
easily.

The following shows the default configuration if it was explicitly spelled out in a .rutema file:

````
configure do |cfg|
  cfg.parser={:class=>Rutema::Parsers::XML}
  cfg.runner={:class=>Rutema::Runners::Default}
  cfg.reporter={:class=>Rutema::Reporters::Console, "silent"=>false}
  cfg.reporter={:class=>Rutema::Reporters::Summary, "silent"=>false}
end
```` 

Every parser, runner or reporter will receive the complete rutema configuration as a parameter upon instantiation. This means that whatever you add to the Hash will be accessible within the class' constructor.