# Teamscale Robot Plugin
This plugin allows you to record testwise coverage for the RobotFramework.
## Installation
You can install this package via `pip install teamscalerobotplugin`
## Usage
You can specify the plugin via the `--listener` option when executing your test suite.
```bash
robot --listener teamscalerobotplugin.TiaRobotListener;partition=PARTITION MyTests.robot
```
There are a number of parameters you can use to customize the plugin:
- `partition`
- Mandatory. The partition in Teamscale for which to retrieve impacted tests and to which to upload testwise coverage.
Must be the same partition as supplied to the JaCoCo agent.
- `url`
- The URL on which the [JaCoCo Agent](https://docs.teamscale.com/howto/setting-up-profiler-tga/java/#using-the-teamscale-jacoco-agent) is listening.
- DEFAULT: `http://localhost:7001/`
- `log_file`
- The name of the file that should be used to write logs
- DEFAULT: `./teamscale-robot-plugin.log`
- `log_level`
- The [level](https://docs.python.org/3/library/logging.html#logging-levels) at which events should be logged to the log file.
Errors are always logged to the console as well.
- DEFAULT: `INFO`
- `partial`
- Whether the produced testwise coverage report is partial or not.
If not, then all tests not contained in the report are deleted from Teamscale.
- DEFAULT: true
### Examples
```bash
# Using default values
robot --listener "teamscalerobotplugin.TiaRobotListener;partition=Robot Tests" MyTests.robot
```
```bash
# Enabling debug logs
robot --listener "teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;log_level=DEBUG" MyTests.robot
```
```bash
# Setting a custom URL and log file
robot --listener "teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;url=http://localhost:9999/;log_file=mylog.log" MyTests.robot
```
```bash
# Setting a custom URL and making the upload partial
robot --listener "teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;url=http://localhost:9999/;partial=true" MyTests.robot
```
Raw data
{
"_id": null,
"home_page": "",
"name": "teamscalerobotplugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "teamscale,robot,robotframework,robot framework,tia,testwise coverage,coverage",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f2/e8/04d76e53508f8e7229a0f05a913e3a332f7d88a511f1dbf42a2403b00b46/teamscalerobotplugin-0.0.4b0.tar.gz",
"platform": null,
"description": "# Teamscale Robot Plugin\n\nThis plugin allows you to record testwise coverage for the RobotFramework.\n\n## Installation\n\nYou can install this package via `pip install teamscalerobotplugin`\n\n## Usage\n\nYou can specify the plugin via the `--listener` option when executing your test suite.\n\n```bash\nrobot --listener teamscalerobotplugin.TiaRobotListener;partition=PARTITION MyTests.robot\n```\n\nThere are a number of parameters you can use to customize the plugin:\n\n- `partition`\n - Mandatory. The partition in Teamscale for which to retrieve impacted tests and to which to upload testwise coverage.\n Must be the same partition as supplied to the JaCoCo agent.\n- `url`\n - The URL on which the [JaCoCo Agent](https://docs.teamscale.com/howto/setting-up-profiler-tga/java/#using-the-teamscale-jacoco-agent) is listening.\n - DEFAULT: `http://localhost:7001/`\n- `log_file`\n - The name of the file that should be used to write logs\n - DEFAULT: `./teamscale-robot-plugin.log`\n- `log_level`\n - The [level](https://docs.python.org/3/library/logging.html#logging-levels) at which events should be logged to the log file.\n Errors are always logged to the console as well.\n - DEFAULT: `INFO`\n- `partial`\n - Whether the produced testwise coverage report is partial or not.\n If not, then all tests not contained in the report are deleted from Teamscale.\n - DEFAULT: true\n\n### Examples\n\n```bash\n# Using default values\nrobot --listener \"teamscalerobotplugin.TiaRobotListener;partition=Robot Tests\" MyTests.robot\n```\n\n```bash\n# Enabling debug logs\nrobot --listener \"teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;log_level=DEBUG\" MyTests.robot\n```\n\n```bash\n# Setting a custom URL and log file\nrobot --listener \"teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;url=http://localhost:9999/;log_file=mylog.log\" MyTests.robot\n```\n\n```bash\n# Setting a custom URL and making the upload partial\nrobot --listener \"teamscalerobotplugin.TiaRobotListener;partition=Robot Tests;url=http://localhost:9999/;partial=true\" MyTests.robot\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A plugin that allows integration into the RobotFramework in order to allow testwise coverage recording for TIA.",
"version": "0.0.4b0",
"project_urls": {
"Documentation": "https://docs.teamscale.com/"
},
"split_keywords": [
"teamscale",
"robot",
"robotframework",
"robot framework",
"tia",
"testwise coverage",
"coverage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d28b89c93bf9d5faf0caade0880f6dc65d8add2440626964f6a654737768bb6",
"md5": "3a53108b28c79797d961946ed0b80ded",
"sha256": "953b51e3636c08fc56e9e7a1353b01bc936ccf01b558bfedf56f6ce21c028057"
},
"downloads": -1,
"filename": "teamscalerobotplugin-0.0.4b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a53108b28c79797d961946ed0b80ded",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9873,
"upload_time": "2023-10-24T09:15:12",
"upload_time_iso_8601": "2023-10-24T09:15:12.588436Z",
"url": "https://files.pythonhosted.org/packages/0d/28/b89c93bf9d5faf0caade0880f6dc65d8add2440626964f6a654737768bb6/teamscalerobotplugin-0.0.4b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2e804d76e53508f8e7229a0f05a913e3a332f7d88a511f1dbf42a2403b00b46",
"md5": "30bfa4d4fad301a17e555268d148af1a",
"sha256": "15f75ff680b8dd8ec61ab774ded2433e4842773ba9c17760267cf0f448988469"
},
"downloads": -1,
"filename": "teamscalerobotplugin-0.0.4b0.tar.gz",
"has_sig": false,
"md5_digest": "30bfa4d4fad301a17e555268d148af1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10024,
"upload_time": "2023-10-24T09:15:14",
"upload_time_iso_8601": "2023-10-24T09:15:14.014836Z",
"url": "https://files.pythonhosted.org/packages/f2/e8/04d76e53508f8e7229a0f05a913e3a332f7d88a511f1dbf42a2403b00b46/teamscalerobotplugin-0.0.4b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 09:15:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "teamscalerobotplugin"
}
JSON