Metadata-Version: 2.1
Name: teamscalerobotplugin
Version: 0.0.2b0
Summary: A plugin that allows integration into the RobotFramework in order to allow testwise coverage recording for TIA.
License: Apache-2.0
Project-URL: Documentation, https://docs.teamscale.com/
Keywords: teamscale,robot,robotframework,robot framework,tia,testwise coverage,coverage
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Classifier: Framework :: Robot Framework :: Tool
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# 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 MyTests.robot
```

There are a number of parameters you can use to customize the plugin:

- `<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`

### Examples

```bash
# Using default values
robot --listener "teamscalerobotplugin.TiaRobotListener" MyTests.robot
```

```bash
# Enabling debug logs
robot --listener "teamscalerobotplugin.TiaRobotListener;log_level=DEBUG" MyTests.robot
```

```bash
# Setting a custom URL and log file
robot --listener "teamscalerobotplugin.TiaRobotListener;url=http::/localhost:9999/;log_file=mylog.log" MyTests.robot
```
