com.epam.reportportal.selenide

Class ReportPortalSelenideEventListener

java.lang.Object

com.epam.reportportal.selenide.ReportPortalSelenideEventListener

All Implemented Interfaces:

com.codeborne.selenide.logevents.LogEventListener

public class ReportPortalSelenideEventListener
extends java.lang.Object
implements com.codeborne.selenide.logevents.LogEventListener

Selenide step logging listener for Report Portal.

The listener listen for Selenide log events and send them to Report Portal as steps. It has ability to log screenshots and page sources on failure, this is enabled by default. Also, it is possible to attach different types of WebDriver logs on failure.

Basic usage:

     SelenideLogger.addListener("Report Portal logger", new ReportPortalSelenideEventListener());
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Function<java.lang.String,java.lang.String>	DEFAULT_STEP_NAME_CONVERTER

Constructor Summary

Constructors

Constructor and Description
ReportPortalSelenideEventListener() Create listener instance with default attachment LogLevel: "INFO".
ReportPortalSelenideEventListener(com.epam.reportportal.listeners.LogLevel defaultLogLevel) Create listener instance with specified log level.
ReportPortalSelenideEventListener(com.epam.reportportal.listeners.LogLevel defaultLogLevel, java.util.function.Function<java.lang.String,java.lang.String> stepConverter) Create listener instance with specified log level and step name converter.

Method Summary

Modifier and Type	Method and Description
void	afterEvent(com.codeborne.selenide.logevents.LogEvent currentLog)
void	beforeEvent(com.codeborne.selenide.logevents.LogEvent currentLog)
ReportPortalSelenideEventListener	disableSelenideLogs(java.lang.Class<? extends com.codeborne.selenide.logevents.LogEvent> selenideLogType) Disable custom selenide step logging.
ReportPortalSelenideEventListener	disableSeleniumLogs(java.lang.String logType) Disable certain selenium log attach on failure.
ReportPortalSelenideEventListener	enableSelenideLogs(java.lang.Class<? extends com.codeborne.selenide.logevents.LogEvent> selenideLogType) Enable custom selenide step logging.
ReportPortalSelenideEventListener	enableSeleniumLogs(java.lang.String logType, java.util.logging.Level logLevel) Enable certain selenium log attach on failure.
ReportPortalSelenideEventListener	logPageSources(boolean logPageSources) Set page sources on failure logging enable/disable.
ReportPortalSelenideEventListener	logScreenshots(boolean logScreenshots) Set screenshot on failure logging enable/disable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_STEP_NAME_CONVERTER

public static final java.util.function.Function<java.lang.String,java.lang.String> DEFAULT_STEP_NAME_CONVERTER

Constructor Detail

ReportPortalSelenideEventListener

public ReportPortalSelenideEventListener(@Nonnull
                                         com.epam.reportportal.listeners.LogLevel defaultLogLevel,
                                         java.util.function.Function<java.lang.String,java.lang.String> stepConverter)

Create listener instance with specified log level and step name converter.

Parameters:

defaultLogLevel - logging level of attachments

stepConverter - step name converter, suitable to sanitize step string from secret data

ReportPortalSelenideEventListener

public ReportPortalSelenideEventListener(@Nonnull
                                         com.epam.reportportal.listeners.LogLevel defaultLogLevel)

Create listener instance with specified log level.

Parameters:

defaultLogLevel - logging level of attachments

ReportPortalSelenideEventListener

public ReportPortalSelenideEventListener()

Create listener instance with default attachment LogLevel: "INFO".

Method Detail

logScreenshots

public ReportPortalSelenideEventListener logScreenshots(boolean logScreenshots)

Set screenshot on failure logging enable/disable. Enabled by default.

Parameters:

logScreenshots - use false to disable screenshot logging

Returns:

self instance for convenience

logPageSources

public ReportPortalSelenideEventListener logPageSources(boolean logPageSources)

Set page sources on failure logging enable/disable. Enabled by default.

Parameters:

logPageSources - use false to disable page sources logging

Returns:

self instance for convenience

enableSeleniumLogs

public ReportPortalSelenideEventListener enableSeleniumLogs(@Nonnull
                                                            java.lang.String logType,
                                                            @Nonnull
                                                            java.util.logging.Level logLevel)

Enable certain selenium log attach on failure.

Parameters:

logType - a string from LogType describing desired log type to be logged

logLevel - desired log level to see in attachment

Returns:

self instance for convenience

disableSeleniumLogs

public ReportPortalSelenideEventListener disableSeleniumLogs(@Nonnull
                                                             java.lang.String logType)

Disable certain selenium log attach on failure.

Parameters:

logType - a string from LogType describing desired log type to be muted

Returns:

self instance for convenience

enableSelenideLogs

public ReportPortalSelenideEventListener enableSelenideLogs(@Nonnull
                                                            java.lang.Class<? extends com.codeborne.selenide.logevents.LogEvent> selenideLogType)

Enable custom selenide step logging.

Parameters:

selenideLogType - type of selenide event to enable logging

Returns:

self instance for convenience

disableSelenideLogs

public ReportPortalSelenideEventListener disableSelenideLogs(@Nonnull
                                                             java.lang.Class<? extends com.codeborne.selenide.logevents.LogEvent> selenideLogType)

Disable custom selenide step logging.

Parameters:

selenideLogType - type of selenide event to mute

Returns:

self instance for convenience

beforeEvent

public void beforeEvent(@Nonnull
                        com.codeborne.selenide.logevents.LogEvent currentLog)

Specified by:

beforeEvent in interface com.codeborne.selenide.logevents.LogEventListener

afterEvent

public void afterEvent(@Nonnull
                       com.codeborne.selenide.logevents.LogEvent currentLog)

Specified by:

afterEvent in interface com.codeborne.selenide.logevents.LogEventListener