Skip to content

Commit

Permalink
change global with run name
Browse files Browse the repository at this point in the history
  • Loading branch information
razvancrainea committed Aug 30, 2024
1 parent 4893116 commit e5e9856
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ The SIPssert Testing Framework has a hierarchical structure, illustrated below:
![SIPssert Structure](docs/images/sipssert-structure.svg)

* At the top level, is the main `sipssert` application; at this level you can
tune a set of global parameters (such as logging settings); you can find
[here](docs/config/global.md) more information on the configuration file.
tune a set of run parameters (such as logging settings); you can find
[here](docs/config/run.md) more information on the configuration file.
The application requires one or more **tests sets** to run. The `sipssert`
application starts the engine controller, which then runs each **tests set**.
* Each **tests set** provided as parameter represents a directory which
Expand Down Expand Up @@ -195,8 +195,8 @@ The SIPssert tool also accepts as parameters the following values:
* `-h|--help` - used to display information about running `sipssert`
* `-l|--logs-dir DIR` - directory where the logging files should be stored (Default
is `logs/`)
* `-c|--config CONFIG` - [Global Configuration](docs/config/global.md) file (Default
is `global.yml')
* `-c|--config CONFIG` - [Run Configuration](docs/config/run.md) file (Default
is `run.yml')
* `-t|--test [SET/]TEST` - pattern that specifies which scenarios/tests should
be run; if `SET` is specified, only tests within that test set are being matched
* `-e|--exclude [SET/]TEST` - similar to `-t/--test`, but specifies the tests
Expand Down Expand Up @@ -243,7 +243,7 @@ sudo bin/sipssert path/to/tests/set
* [Write Scenarios](docs/guide/scenarios.md)

## Configuration Files:
* [Global Configuration](docs/config/global.md)
* [Run Configuration](docs/config/run.md)
* [Tests Set Configuration](docs/config/tests-set.md)
* [Defines Configuration](docs/config/define.md)
* [Scenario Definition](docs/config/scenario.md)
Expand Down
12 changes: 6 additions & 6 deletions docs/config/global.md → docs/config/run.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# SIPssert Testing - Global Configuration File
# SIPssert Testing - Run Configuration File

This configuration file is used to tune global runtime parameters, such as
logging. It should be defined as a [YAML](https://yaml.org/) and its path
defaults to `global.yml`.
logging, tests, etc. It should be defined as a [YAML](https://yaml.org/) and its path
defaults to `run.yml`.
If a `defines.yml` file exists in the same directory, it is loaded and its
definitions are expanded according to the Jinja2 format.

## Settings

The global configuration file consists of the following settings:
The run configuration file consists of the following settings:

* `logging`: contains information about logging
* `controller`: provides information about controller logging
Expand All @@ -25,12 +25,12 @@ arguments through the (`-e|--exclude` argument) (Default: empty)

## Example

The default global configuration file should look like this:
The default running configuration file should look like this:
```
---
logging:
controller:
console: false
console: false
level: INFO
file: controller.log
```
4 changes: 2 additions & 2 deletions docs/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ logged at a different logging level.

By default, the controller logging is dumped in the `RUNDIR/controller.log`
file, and by default only *INFO* messages and higher are displayed. This,
however, can be modified through the [Global
Configuration](docs/config/global.md) file, which can also instruct to write
however, can be modified through the [Running
Configuration](docs/config/run.md) file, which can also instruct to write
the logs at standard output. This option is however not recommended, as it
hinders the visibility of the testing status.

Expand Down
4 changes: 2 additions & 2 deletions sipssert/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
default=[])

arg_parser.add_argument('-c', '--config',
help='Absolute path of the global config',
default="global.yml",
help='Absolute path of the running config',
default="run.yml",
type=os.path.abspath)

arg_parser.add_argument('-l', '--logs-dir',
Expand Down

0 comments on commit e5e9856

Please sign in to comment.