Skip to content

Commit

Permalink
Unify ReportPortal name spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
@HardNorth
HardNorth committed Sep 25, 2023
1 parent 254f024 commit ee64a2a
Show file tree
Hide file tree
Showing 27 changed files with 69 additions and 68 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Changelog

## [Unreleased]
### Changed
- Unified ReportPortal product naming, by @HardNorth

## [5.1.22]
### Changed
Expand Down Expand Up @@ -141,7 +143,7 @@
## [5.1.0-RC-7]
### Added
- Error message on incompatible OkHttp dependency version
- It's now possible to obtain Report Portal client by `Launch.currentLaunch().getClient()`
- It's now possible to obtain ReportPortal client by `Launch.currentLaunch().getClient()`

## [5.1.0-RC-6]

Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> **DISCLAIMER**: We use Google Analytics for sending anonymous usage information such as agent's and client's names,
> and their versions after a successful launch start. This information might help us to improve both ReportPortal
> backend and client sides. It is used by the Report Portal team only and is not supposed for sharing with 3rd parties.
> backend and client sides. It is used by the ReportPortal team only and is not supposed for sharing with 3rd parties.
[![Maven Central](https://img.shields.io/maven-central/v/com.epam.reportportal/client-java.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.epam.reportportal/client-java)
[![CI Build](https://github.com/reportportal/client-java/actions/workflows/ci.yml/badge.svg)](https://github.com/reportportal/client-java/actions/workflows/ci.yml)
Expand All @@ -29,7 +29,7 @@ from file can be overridden by JVM variables.

### JVM arguments

Report Portal client does not necessarily need properties file to be configured. One of the option is to use JVM
ReportPortal client does not necessarily need properties file to be configured. One of the option is to use JVM
arguments which have the highest priority among configuration ways. To use them you need to specify them in command line
after Java executable using `-D` flag.
Example:
Expand Down Expand Up @@ -93,16 +93,16 @@ value will be used.
| rp.launch.uuid | String | A unique Launch UUID to which the whole test execution will be uploaded. No new launch will be created if the property specified. | No |
| rp.launch.uuid.print | Boolean | Enables printing Launch UUID on test run start. Default `False`. | No |
| rp.launch.uuid.print.output | Enum | Launch UUID print output. Default `stdout`. Possible values: `stderr`, `stdout`. | No |
| rp.enable | Boolean | Enable/Disable logging to Report Portal: rp.enable=true - enable log to RP server. Any other value means 'false': rp.enable=false - disable log to RP server. If parameter is absent in properties file then automation project results will be posted on RP. | No |
| rp.enable | Boolean | Enable/Disable logging to ReportPortal: rp.enable=true - enable log to RP server. Any other value means 'false': rp.enable=false - disable log to RP server. If parameter is absent in properties file then automation project results will be posted on RP. | No |
| rp.description | String | Launch description | No |
| rp.attributes | String | Set of attributes for specifying additional meta information for current launch. Format: key:value;value;build:12345-6. Attributes should be separated by “;”, keys and values - “:”. | No |
| rp.reporting.async | Boolean | Enables asynchronous reporting. Available values - `true`(by default) or `false`. Supported only in 5+ version. | No |
| rp.reporting.callback | Boolean | Enables [callback reporting](https://github.com/reportportal/client-java/wiki/Callback-reporting-usefulness). Available values - `true` or `false`(by default). Supported only in 5+ vesion | No |
| rp.reporting.callback | Boolean | Enables [callback reporting](https://github.com/reportportal/client-java/wiki/Callback-reporting-usefulness). Available values - `true` or `false`(by default). Supported only in 5+ version | No |
| rp.rerun | Boolean | Enables [rerun mode](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md). Available values - `true` or `false`(by default). Supported only in 5+ version | No |
| rp.rerun.of | String | Specifies UUID of launch that has to be rerun. | No |
| rp.convertimage | Boolean | Colored log images can be converted to grayscale for reducing image size. Values: ‘true’ – will be converted. Any other value means ‘false’. | No |
| rp.mode | Enum | ReportPortal provides possibility to specify visibility of executing launch. Currently two modes are supported: DEFAULT - all users from project can see this launch; DEBUG - all users except of Customer role can see this launch (in debug sub tab). Note: for all java based clients (TestNG, Junit) mode will be set automatically to "DEFAULT" if it is not specified. | No |
| rp.skipped.issue | Boolean | ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side. Parameter could be equal boolean values: <li>`true` - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal. <li>`false` - skipped tests will not be marked as 'To Investigate' on application. | No |
| rp.skipped.issue | Boolean | ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side. Parameter could be equal boolean values: <li>`true` - skipped tests considered as issues and will be marked as 'To Investigate' on ReportPortal. <li>`false` - skipped tests will not be marked as 'To Investigate' on application. | No |
| rp.batch.size.logs | Integer | Put logs into batches of specified size in order to rise up performance and reduce number of requests to server. Default = 10 | No |
| rp.batch.payload.limit | Long | Limit batches by payload size to avoid request rejection due to server limitations. | No |
| rp.rx.buffer.size | Integer | Internal queue size for log processing, increase this value along with log batch size if you see not all your logs passing to server. Default = 128 | No |
Expand Down Expand Up @@ -158,14 +158,14 @@ etc.

## Proxy configuration

Report Portal supports 2 options for setting Proxy configuration:
ReportPortal supports 2 options for setting Proxy configuration:

* JVM arguments (-Dhttps.proxyHost=localhost)
* `reportportal.properties` file

### JVM arguments

Report Portal uses OkHttp as HTTP client, which can pick up JVM proxy settings. This is the most flexible and preferable
ReportPortal uses OkHttp as HTTP client, which can pick up JVM proxy settings. This is the most flexible and preferable
way to configure proxies, since it supports different proxy types. You can find out more about JVM proxies on
[Java networking and proxies](http://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) page.

Expand Down
12 changes: 6 additions & 6 deletions README_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> **DISCLAIMER**: We use Google Analytics for sending anonymous usage information such as agent's and client's names,
> and their versions after a successful launch start. This information might help us to improve both ReportPortal
> backend and client sides. It is used by the Report Portal team only and is not supposed for sharing with 3rd parties.
> backend and client sides. It is used by the ReportPortal team only and is not supposed for sharing with 3rd parties.
[![Maven Central](https://img.shields.io/maven-central/v/com.epam.reportportal/client-java.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.epam.reportportal/client-java)
[![CI Build](https://github.com/reportportal/client-java/actions/workflows/ci.yml/badge.svg)](https://github.com/reportportal/client-java/actions/workflows/ci.yml)
Expand All @@ -29,7 +29,7 @@ from file can be overridden by JVM variables.

### JVM arguments

Report Portal client does not necessarily need properties file to be configured. One of the option is to use JVM
ReportPortal client does not necessarily need properties file to be configured. One of the option is to use JVM
arguments which have the highest priority among configuration ways. To use them you need to specify them in command line
after Java executable using `-D` flag.
Example:
Expand Down Expand Up @@ -93,7 +93,7 @@ value will be used.
| rp.launch.uuid | String | A unique Launch UUID to which the whole test execution will be uploaded. No new launch will be created if the property specified. | No |
| rp.launch.uuid.print | Boolean | Enables printing Launch UUID on test run start. Default `False`. | No |
| rp.launch.uuid.print.output | Enum | Launch UUID print output. Default `stdout`. Possible values: `stderr`, `stdout`. | No |
| rp.enable | Boolean | Enable/Disable logging to Report Portal: rp.enable=true - enable log to RP server. Any other value means 'false': rp.enable=false - disable log to RP server. If parameter is absent in properties file then automation project results will be posted on RP. | No |
| rp.enable | Boolean | Enable/Disable logging to ReportPortal: rp.enable=true - enable log to RP server. Any other value means 'false': rp.enable=false - disable log to RP server. If parameter is absent in properties file then automation project results will be posted on RP. | No |
| rp.description | String | Launch description | No |
| rp.attributes | String | Set of attributes for specifying additional meta information for current launch. Format: key:value;value;build:12345-6. Attributes should be separated by “;”, keys and values - “:”. | No |
| rp.reporting.async | Boolean | Enables asynchronous reporting. Available values - `true` (by default) or `false`. Supported only in 5+ version. | No |
Expand All @@ -102,7 +102,7 @@ value will be used.
| rp.rerun.of | String | Specifies UUID of launch that has to be rerun. | No |
| rp.convertimage | Boolean | Colored log images can be converted to grayscale for reducing image size. Values: ‘true’ – will be converted. Any other value means ‘false’. | No |
| rp.mode | Enum | ReportPortal provides possibility to specify visibility of executing launch. Currently two modes are supported: DEFAULT - all users from project can see this launch; DEBUG - all users except of Customer role can see this launch (in debug sub tab). Note: for all java based clients (TestNG, Junit) mode will be set automatically to "DEFAULT" if it is not specified. | No |
| rp.skipped.issue | Boolean | ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side. Parameter could be equal boolean values: <li>`true` - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal. <li>`false` - skipped tests will not be marked as 'To Investigate' on application. | No |
| rp.skipped.issue | Boolean | ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side. Parameter could be equal boolean values: <li>`true` - skipped tests considered as issues and will be marked as 'To Investigate' on ReportPortal. <li>`false` - skipped tests will not be marked as 'To Investigate' on application. | No |
| rp.batch.size.logs | Integer | Put logs into batches of specified size in order to rise up performance and reduce number of requests to server. Default = 10 | No |
| rp.batch.payload.limit | Long | Limit batches by payload size to avoid request rejection due to server limitations. | No |
| rp.rx.buffer.size | Integer | Internal queue size for log processing, increase this value along with log batch size if you see not all your logs passing to server. Default = 128 | No |
Expand Down Expand Up @@ -158,14 +158,14 @@ etc.

## Proxy configuration

Report Portal supports 2 options for setting Proxy configuration:
ReportPortal supports 2 options for setting Proxy configuration:

* JVM arguments (-Dhttps.proxyHost=localhost)
* `reportportal.properties` file

### JVM arguments

Report Portal uses OkHttp as HTTP client, which can pick up JVM proxy settings. This is the most flexible and preferable
ReportPortal uses OkHttp as HTTP client, which can pick up JVM proxy settings. This is the most flexible and preferable
way to configure proxies, since it supports different proxy types. You can find out more about JVM proxies on
[Java networking and proxies](http://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) page.

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
version=5.1.23-SNAPSHOT
description=EPAM Report portal. Client
description=EPAM ReportPortal. Client
retrofit_version=2.9.0
junit_version=5.6.3
junit_runner_version=1.6.3
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/epam/reportportal/annotations/ParameterKey.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
import java.lang.annotation.Target;

/**
* Used in parametrized tests. Report portal waiting test parameters
* Used in parametrized tests. ReportPortal waiting test parameters
* in <b>key - value</b> style. Using the annotation for method parameter
* the specific <b>key</b> can be provided.
*
* @author Pavel Bortnik
* @since Report Portal Api v3.1.0
* @since ReportPortal Api v3.1.0
*/

@Retention(RetentionPolicy.RUNTIME)
Expand Down
Loading

0 comments on commit ee64a2a

Please sign in to comment.