diff --git a/README.md b/README.md index a81b25c3..23cdb157 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,20 @@ node('windows') { } } ``` +#### Further Information + +The `testConfig` parameter consists of both the **Test Configuration** (`.tcf`) and **Test Bench Configuration** (`.tbc`) files. These files are essential for defining test settings in ecu.test. + +- **New Configurations**: Both `.tbc` and `.tcf` files must be explicitly set whenever a new configuration is needed. + +- **KEEP Option**: The `KEEP` option prevents reloading new configurations and keeps the currently active ones. +This feature is considered **advanced** and is not recommended for most use cases. +`KEEP` must always be set for both configurations and no constants may be set. + +- **Unload Configurations**: Keeping values empty, such as `[tbcPath: '', tcfPath: '']` will unload the configuration. +Providing an invalid data type for `testConfig` (e.g., an empty list) will result in an error and halt the pipeline execution. + +- **Force Reload**: In ecu.test versions prior to 2023.4, setting `forceConfigurationReload` to `true` forces a configuration reload, even if the same configuration is still active. The [test.guide](https://www.tracetronic.com/products/test-guide/) authentication key has to be set as a Jenkins [credential](https://www.jenkins.io/doc/book/using/using-credentials/) (username and password) to be used in the diff --git a/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.jelly b/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.jelly index 71b3b155..be71ba08 100644 --- a/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.jelly +++ b/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.jelly @@ -1,6 +1,7 @@ + ${%configSection.description} diff --git a/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.properties b/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.properties index cd75f49f..b59885d1 100644 --- a/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.properties +++ b/src/main/resources/de/tracetronic/jenkins/plugins/ecutestexecution/configs/TestConfig/config.properties @@ -1,4 +1,6 @@ configSection.title=Test Configuration +configSection.description=Both the Test Bench Configuration and Test Configuration must be provided to load new configurations. \ + For invalid data types, such as testConfig: [], an Error will be thrown. constants.add=Add Global Constant constants.description=The configured global constants remain available throughout the entire test execution. constants.title=Global Constants @@ -9,9 +11,13 @@ packageParameters.description=Parameters for package execution. packageParameters.title=Package Parameters tbcPath.description=The relative path of the .tbc file in the Configurations directory to be started for this execution. \ Use "KEEP" to use the currently loaded test bench configuration. \ + The "KEEP" option is considered advanced and not recommended for typical use cases. \ + "KEEP" must always be set for both configurations. \ If empty, no test bench configuration will be loaded. tbcPath.title=Test Bench Configuration tcfPath.description=The relative path of the .tcf file in the Configurations directory to be started for this execution. \ Use "KEEP" to use the currently loaded test configuration. \ + The "KEEP" option is considered advanced and not recommended for typical use cases. \ + "KEEP" must always be set for both configurations. \ If empty, no test configuration will be loaded. tcfPath.title=Test Configuration