You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
With the Blueriq Encore it is possible to create and run test cases for Data Mappings. This Command Line Interface Test Runner is created to run the created tests in a Continuous Integration/ Continuous Deployment environment to enhance the quality control of your Blueriq Models. When the Test Runner is ran the test results are stored in a file which can be interpreted by a CI/CD like Jenkins. The file output format follows the Apache Ant's JUnit task XML Schema, which is widely used by different reporting tools.
How to Use
The Test Runner is packaged as an executable for windows, which required command line arguments to be ran. Below all the command line arguments are listed which can be used by the Test Runner. An example of the using the Test Runner would look like this.
C:\blueriq-encore\cli-test-runner-win.exe --proxyServerUrl=http://localhost:1337 --studioUsername=username --studioPassword=password --repository=MyRepository --branch=Trunk --projects=MyProject1,MyProject2
When this configuration is used and the Test Runner has been executed, the test results will we available at C:\blueriq-encore\target\TestResults-MyProject1.xml. Another way to execute the Test Runner is via configuration file, which can be used to pass in the command line arguments. An example of such configuration file would look like this.
{ "proxyServerUrl": "http://localhost:1337", "studioUsername": "username", "studioPassword": "password", "repository": "MyRepository", "branch": "Trunk", "projects": "MyProject1,MyProjects2" }
To use the configuration file config.json, execute the Test Runner with the following command.
C:\blueriq-encore\cli-test-runner-win.exe --config=config.json
Command Line Arguments
The Test Runner can be either configured by a JSON configuration file or by command line arguments. when running the Test Runner with the argument --help a list of configurable arguments is displayed.
Argument | Required | Explanation | Default value |
---|---|---|---|
--proxyServerUrl | yes | The url of the proxy server(NGINX) of Blueriq Encore Example: http://myurl:port/ | - |
--studioUsername | yes | The Studio/Encore username which is used to retrieve information from the Studio server / Encore | - |
--studioPassword | yes | The Studio/Encore password which is used to retrieve information from the Studio server / Encore | - |
--repository, -r | yes | The Studio/Encore repository which is used to retrieve information from the Studio server / Encore | - |
--branch, -b | yes | The Studio/Encore branch which is used to retrieve information from the Studio server / Encore | - |
--projects, -p | no | The projects which are used to retrieve information from the Studio server / Encore, when not provided all projects are retrieved | - |
--outputDir | no | The output directory where the ouput file will be created in | <currentDirectory>/target |
-c ,--config | no | The location of a JSON config file containing configured test runner argument | - |