ExtentManager (autonomx-core 1.0.9 API)

java.lang.Object
- core.support.logger.ExtentManager

public class ExtentManager
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static Map<String,com.aventstack.extentreports.ExtentTest>`	`classList`
`static String`	`ENABLE_EMAIL_REPORT`
`static String`	`ENABLE_SLACK_NOTIFICATION`
`static String`	`HTML_REPORT_TYPE`
`static String`	`KLOV_MONGODB_URL`
`static String`	`KLOV_REPORT_TYPE`
`static String`	`KLOV_SERVER_URL`
`static com.aventstack.extentreports.reporter.ExtentKlovReporter`	`klovReporter`
`static String`	`LAUNCH_AFTER_REPORT`
`static String`	`NOTIFY_EMAIL_ON_FAIL_ONLY`
`static String`	`NOTIFY_SLACK_ON_FAIL_ONLY`
`static String`	`REPORT_DEFAULT_NAME`
`static String`	`REPORT_EXPIRE_DAYS`
`static String`	`REPORT_TYPE`
`static String`	`TEST_OUTPUT_FULL_PATH`
`static String`	`TEST_OUTPUT_PATH`

Constructor Summary

Constructors
Constructor and Description

ExtentManager()

Constructors
Constructor and Description
`ExtentManager()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearOldTestReports()`
`static void`	`clearTestReport()` deletes test report for particular run based on test run name
`static com.aventstack.extentreports.ExtentReports`	`createInstance(String fileName)`
`static void`	`emailTestReport(String message)` zips up And emails test report with screenshot to specified email address
`static String`	`getMediaFolderFullPath()`
`static String`	`getMediaFolderRelativePathFromHtmlReport()`
`static String`	`getMediaFolderRelativePathFromRoot()`
`static com.aventstack.extentreports.ExtentReports`	`getReporter()`
`static String`	`getReportHTMLFullPath()`
`static String`	`getReportName()` returns the test report name the report name is stored in default test object if test suit runs, Then suit name is the report name if test is run without suit, Then app name is used for report name
`static String`	`getReportRootFullPath()`
`static String`	`getReportRootRelativePath()` gets report folder path eg.selenium/test-output/testReports/20181124/core/
`static String`	`getScreenshotsFolderFullPath()`
`static String`	`getScreenshotsFolderRelativePath()`
`static void`	`launchReportAfterTest()` launches the report html page after test run
`static String`	`parseTestName(String value)` formats test name to format from: "loginTest" to "Login Test"
`static void`	`printReportLink()` prints the test report link for klov or html report type
`static void`	`removeEmptyTestNodesFromReport()` Note: currently disabled as we're only adding test nodes to report removes empty logs from the test report these are logs that are initialized, But no test steps have been added to them note: test suite is removed, cause the feature When empty cannot be removed.
`static void`	`reportSetup()` setup report only for test methods, including before and after test not including: before suite, after suite, before class, after class this means only logs for test methods will show up in the reports reason: test report treats before/after suite, before/after class as tests and increases test count
`static void`	`setKlovReportReporter()` if test are run through suite, set project name as suite if test are run outside of suite, use the module/app name
`static void`	`setupReportPage()`
`static void`	`slackNotification(String message)` sends test report to slack slack notification must be enabled in properties file
`static void`	`writeTestReport()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LAUNCH_AFTER_REPORT
```
public static final String LAUNCH_AFTER_REPORT
```
    See Also:
    
    Constant Field Values
  - NOTIFY_SLACK_ON_FAIL_ONLY
```
public static final String NOTIFY_SLACK_ON_FAIL_ONLY
```
    See Also:
    
    Constant Field Values
  - NOTIFY_EMAIL_ON_FAIL_ONLY
```
public static final String NOTIFY_EMAIL_ON_FAIL_ONLY
```
    See Also:
    
    Constant Field Values
  - ENABLE_SLACK_NOTIFICATION
```
public static final String ENABLE_SLACK_NOTIFICATION
```
    See Also:
    
    Constant Field Values
  - ENABLE_EMAIL_REPORT
```
public static final String ENABLE_EMAIL_REPORT
```
    See Also:
    
    Constant Field Values
  - REPORT_EXPIRE_DAYS
```
public static final String REPORT_EXPIRE_DAYS
```
    See Also:
    
    Constant Field Values
  - REPORT_TYPE
```
public static final String REPORT_TYPE
```
    See Also:
    
    Constant Field Values
  - HTML_REPORT_TYPE
```
public static final String HTML_REPORT_TYPE
```
    See Also:
    
    Constant Field Values
  - KLOV_REPORT_TYPE
```
public static final String KLOV_REPORT_TYPE
```
    See Also:
    
    Constant Field Values
  - KLOV_SERVER_URL
```
public static final String KLOV_SERVER_URL
```
    See Also:
    
    Constant Field Values
  - KLOV_MONGODB_URL
```
public static final String KLOV_MONGODB_URL
```
    See Also:
    
    Constant Field Values
  - classList
```
public static Map<String,com.aventstack.extentreports.ExtentTest> classList
```
  - REPORT_DEFAULT_NAME
```
public static String REPORT_DEFAULT_NAME
```
  - klovReporter
```
public static com.aventstack.extentreports.reporter.ExtentKlovReporter klovReporter
```
  - TEST_OUTPUT_PATH
```
public static String TEST_OUTPUT_PATH
```
  - TEST_OUTPUT_FULL_PATH
```
public static String TEST_OUTPUT_FULL_PATH
```
- Constructor Detail
  - ExtentManager
```
public ExtentManager()
```
- Method Detail
  - getReporter
```
public static com.aventstack.extentreports.ExtentReports getReporter()
```
  - getScreenshotsFolderFullPath
```
public static String getScreenshotsFolderFullPath()
```
  - getScreenshotsFolderRelativePath
```
public static String getScreenshotsFolderRelativePath()
```
  - getMediaFolderFullPath
```
public static String getMediaFolderFullPath()
```
  - getMediaFolderRelativePathFromHtmlReport
```
public static String getMediaFolderRelativePathFromHtmlReport()
```
  - getMediaFolderRelativePathFromRoot
```
public static String getMediaFolderRelativePathFromRoot()
```
  - getReportHTMLFullPath
```
public static String getReportHTMLFullPath()
```
  - getReportRootFullPath
```
public static String getReportRootFullPath()
```
  - getReportRootRelativePath
```
public static String getReportRootRelativePath()
```
    gets report folder path eg.selenium/test-output/testReports/20181124/core/
    
    Returns:
  - createInstance
```
public static com.aventstack.extentreports.ExtentReports createInstance(String fileName)
```
  - setupReportPage
```
public static void setupReportPage()
```
  - reportSetup
```
public static void reportSetup()
```
    setup report only for test methods, including before and after test not including: before suite, after suite, before class, after class this means only logs for test methods will show up in the reports reason: test report treats before/after suite, before/after class as tests and increases test count
  - setKlovReportReporter
```
public static void setKlovReportReporter()
```
    if test are run through suite, set project name as suite if test are run outside of suite, use the module/app name
  - launchReportAfterTest
```
public static void launchReportAfterTest()
```
    launches the report html page after test run
    
    Throws:
    
    Exception
  - writeTestReport
```
public static void writeTestReport()
```
  - removeEmptyTestNodesFromReport
```
public static void removeEmptyTestNodesFromReport()
```
    Note: currently disabled as we're only adding test nodes to report removes empty logs from the test report these are logs that are initialized, But no test steps have been added to them note: test suite is removed, cause the feature When empty cannot be removed. feature in code is not associated with test steps TODO: find a way to preserve suite logs
  - printReportLink
```
public static void printReportLink()
```
    prints the test report link for klov or html report type
  - getReportName
```
public static String getReportName()
```
    returns the test report name the report name is stored in default test object if test suit runs, Then suit name is the report name if test is run without suit, Then app name is used for report name
    
    Returns:
  - slackNotification
```
public static void slackNotification(String message)
```
    sends test report to slack slack notification must be enabled in properties file
    
    Parameters:
    
    message -
  - emailTestReport
```
public static void emailTestReport(String message)
```
    zips up And emails test report with screenshot to specified email address
    
    Throws:
    
    Exception
  - clearTestReport
```
public static void clearTestReport()
```
    deletes test report for particular run based on test run name
  - clearOldTestReports
```
public static void clearOldTestReports()
```
  - parseTestName
```
public static String parseTestName(String value)
```
    formats test name to format from: "loginTest" to "Login Test"
    
    Parameters:
    
    value -
    
    Returns:

Class ExtentManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAUNCH_AFTER_REPORT

NOTIFY_SLACK_ON_FAIL_ONLY

NOTIFY_EMAIL_ON_FAIL_ONLY

ENABLE_SLACK_NOTIFICATION

ENABLE_EMAIL_REPORT

REPORT_EXPIRE_DAYS

REPORT_TYPE

HTML_REPORT_TYPE

KLOV_REPORT_TYPE

KLOV_SERVER_URL

KLOV_MONGODB_URL

classList

REPORT_DEFAULT_NAME

klovReporter

TEST_OUTPUT_PATH

TEST_OUTPUT_FULL_PATH

Constructor Detail

ExtentManager

Method Detail

getReporter

getScreenshotsFolderFullPath

getScreenshotsFolderRelativePath

getMediaFolderFullPath

getMediaFolderRelativePathFromHtmlReport

getMediaFolderRelativePathFromRoot

getReportHTMLFullPath

getReportRootFullPath

getReportRootRelativePath

createInstance

setupReportPage

reportSetup

setKlovReportReporter

launchReportAfterTest

writeTestReport

removeEmptyTestNodesFromReport

printReportLink

getReportName

slackNotification

emailTestReport

clearTestReport

clearOldTestReports

parseTestName