From e5e98561bbec40d5474214982be8f4e31d55686d Mon Sep 17 00:00:00 2001 From: Razvan Crainea Date: Fri, 30 Aug 2024 17:38:00 +0300 Subject: [PATCH] change global with run name --- README.md | 10 +++++----- docs/config/{global.md => run.md} | 12 ++++++------ docs/logging.md | 4 ++-- sipssert/main.py | 4 ++-- 4 files changed, 15 insertions(+), 15 deletions(-) rename docs/config/{global.md => run.md} (79%) diff --git a/README.md b/README.md index 6b55ecf..44a1da4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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) diff --git a/docs/config/global.md b/docs/config/run.md similarity index 79% rename from docs/config/global.md rename to docs/config/run.md index 6591c61..6d59b66 100644 --- a/docs/config/global.md +++ b/docs/config/run.md @@ -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 @@ -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 ``` diff --git a/docs/logging.md b/docs/logging.md index db49856..eb55745 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -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. diff --git a/sipssert/main.py b/sipssert/main.py index 50fa547..1fb3fff 100644 --- a/sipssert/main.py +++ b/sipssert/main.py @@ -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',