core.helpers

Class UtilityHelper

java.lang.Object

core.helpers.UtilityHelper

public class UtilityHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
UtilityHelper()

Method Summary

Modifier and Type	Method and Description
protected static void	addFileToZip(String path, String srcFile, ZipOutputStream zip)
protected static void	appendToFile(String value, String absolutePath) appends to existing file
protected static void	appendToFile(String value, String directory, String filename, String type) appends to existing file
static File	captureElementPicture(EnhancedBy element) Gets a picture of specific element displayed on the page
static File	captureElementPicture(EnhancedBy element, int index) Gets a picture of specific element displayed on the page
protected static void	captureExtentReportScreenshot() captures screenshot And attaches to extent test report
protected static void	copyDirectory(String dirFrom, String dirTo) Copies directory And all content from dirFrom to dirTo overwrites the content
protected static void	createFileFromPath(String absolutePath) create directories and files based on absolute path set permissions to rw-r--r-- set executable to true
protected static ZipOutputStream	createZip(String destZipFile)
protected static void	deleteFile(String absolutePath) delete file
protected static ArrayList<String>	excuteCommand(String command) run command and return results as array list will run bash on linux or mac will run batch command on windows
protected static ArrayList<String>	excuteCommandFromFile(String filePath) run script file and return results as array list will run bash on linux or mac will run batch command on windows
protected static void	executeJavascript(String script)
protected static Object	executeJs(String script, Object... args) execute javascript
protected static List<String>	executeJsWithListReturn(String script, Object... args) execute javascript
protected static String	executeJsWithStringReturn(String script, Object... args) execute javascript
protected static String	generateRandomInteger(int len) generates random int of length len
protected static int	generateRandomNumber(int min, int max) generates random number between two numbers, min, max
protected static String	generateRandomString(int len) generates random string of length len
protected static List<String>	getAllValuesStartringWith(String source, String value) gets a list of string from 'source' starting with 'value'
protected static String	getFileContent(String absolutePath) gets file content as String
protected static ArrayList<File>	getFileList(String directoryPath) returns the list of files in directory
protected static ArrayList<File>	getFileListByType(String directoryPath, String type) gets the list of files tye: file type.
protected static List<File>	getFileListWithSubfolders(String directoryName, String type, List<File> files) gets list of files including from sub folder based on type.
protected static String	getRootDir() get current project root directory, where pom.xml is
protected static String	getValueFromPattern(String str, String pattern)
protected static List<String>	getValuesFromPattern(String str, String pattern)
protected static void	highLightWebElement(EnhancedBy by, int index) highlights the web element use on clicks and send key elements applicable to web driver
protected static boolean	isBoolean(String value) returns if string is boolean
protected static boolean	isMac() returns true if OS is mac
protected static boolean	isNumeric(String str) return if string is a number
protected static boolean	isProcessRunning(String serviceName) returns true if process is running
protected static boolean	isUnix() returns true if OS is unix or linux
protected static boolean	isUUID(String value) is the string value UDID
protected static boolean	isWindows() returns true if OS is windows
protected static void	killMacProcess(String serviceName)
protected static void	killWindowsProcess(String serviceName) returns kills the process if running
static void	slackNotificationWithFile(String title, String comment, String filePath) sends slack notification token: generate at: https://api.slack.com/custom-integrations/legacy-tokens for channel id: right click And channel And copy link.
protected static String	stringNormalize(String value) normalizes string removes space, new line chars, quotes
protected static String	stringRemoveLines(String value) normalizes string removes space, new line chars
protected static void	writeFile(String value, String absolutePath) Create file (where pom.xml is) and write to it
protected static void	writeFile(String value, String directory, String filename, String type) Create file with path starting from root directory (where pom.xml is) and write to it.
static String	zipDir(String sourceDir, String destFilePath) zips directory path starts from root pom directory
protected static ZipOutputStream	zipFolder(String srcFolder, String destZipFile) zip folder

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilityHelper

public UtilityHelper()

Method Detail

generateRandomString

protected static String generateRandomString(int len)

generates random string of length len

Parameters:

len -

Returns:

generateRandomInteger

protected static String generateRandomInteger(int len)

generates random int of length len

Parameters:

len -

Returns:

generateRandomNumber

protected static int generateRandomNumber(int min,
                                          int max)

generates random number between two numbers, min, max

Parameters:

min -

max -

Returns:

stringNormalize

protected static String stringNormalize(String value)

normalizes string removes space, new line chars, quotes

Parameters:

value -

Returns:

stringRemoveLines

protected static String stringRemoveLines(String value)

normalizes string removes space, new line chars

Parameters:

value -

Returns:

isProcessRunning

protected static boolean isProcessRunning(String serviceName)
                                   throws Exception

returns true if process is running

Parameters:

serviceName -

Returns:

Throws:

Exception

killWindowsProcess

protected static void killWindowsProcess(String serviceName)

returns kills the process if running

Parameters:

serviceName -

Throws:

Exception

killMacProcess

protected static void killMacProcess(String serviceName)

excuteCommand

protected static ArrayList<String> excuteCommand(String command)

run command and return results as array list will run bash on linux or mac will run batch command on windows

Parameters:

command -

Returns:

Throws:

IOException

excuteCommandFromFile

protected static ArrayList<String> excuteCommandFromFile(String filePath)

run script file and return results as array list will run bash on linux or mac will run batch command on windows

Parameters:

filePath - path from the root directory ( where pom.xml is )

Returns:

the results as arraylist

copyDirectory

protected static void copyDirectory(String dirFrom,
                                    String dirTo)

Copies directory And all content from dirFrom to dirTo overwrites the content

Parameters:

dirFrom -

dirTo -

executeJavascript

protected static void executeJavascript(String script)

zipFolder

protected static ZipOutputStream zipFolder(String srcFolder,
                                           String destZipFile)
                                    throws Exception

zip folder

Parameters:

srcFolder -

destZipFile -

Returns:

Throws:

Exception

createZip

protected static ZipOutputStream createZip(String destZipFile)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

addFileToZip

protected static void addFileToZip(String path,
                                   String srcFile,
                                   ZipOutputStream zip)
                            throws Exception

Throws:

Exception

getAllValuesStartringWith

protected static List<String> getAllValuesStartringWith(String source,
                                                        String value)

gets a list of string from 'source' starting with 'value'

Parameters:

source -

value -

Returns:

getValueFromPattern

protected static String getValueFromPattern(String str,
                                            String pattern)

Parameters:

str -

pattern - regular expression pattern

Returns:

getValuesFromPattern

protected static List<String> getValuesFromPattern(String str,
                                                   String pattern)

Parameters:

str -

pattern - regular expression pattern

Returns:

getRootDir

protected static String getRootDir()

get current project root directory, where pom.xml is

Returns:

slackNotificationWithFile

public static void slackNotificationWithFile(String title,
                                             String comment,
                                             String filePath)

sends slack notification token: generate at: https://api.slack.com/custom-integrations/legacy-tokens for channel id: right click And channel And copy link. the id is attached to the link see properties file for values to use

zipDir

public static String zipDir(String sourceDir,
                            String destFilePath)

zips directory path starts from root pom directory

Parameters:

sourceDir: - root path + dir

destFilePath: - usage: root + dir + outputFilePath

Returns:

getFileListByType

protected static ArrayList<File> getFileListByType(String directoryPath,
                                                   String type)

gets the list of files tye: file type. eg. ".csv"

Returns:

getFileList

protected static ArrayList<File> getFileList(String directoryPath)

returns the list of files in directory

Parameters:

directoryPath -

Returns:

getFileListWithSubfolders

protected static List<File> getFileListWithSubfolders(String directoryName,
                                                      String type,
                                                      List<File> files)

gets list of files including from sub folder based on type. eg. ".csv"

Returns:

getFileContent

protected static String getFileContent(String absolutePath)

gets file content as String

Parameters:

absolutePath -

Returns:

createFileFromPath

protected static void createFileFromPath(String absolutePath)

create directories and files based on absolute path set permissions to rw-r--r-- set executable to true

Parameters:

path -

writeFile

protected static void writeFile(String value,
                                String directory,
                                String filename,
                                String type)

Create file with path starting from root directory (where pom.xml is) and write to it. eg. writeFile("something","", "myFile", "txt");

Parameters:

value - value in file

directory - directory from root

filename - name of the file

type - type of file

writeFile

protected static void writeFile(String value,
                                String absolutePath)

Create file (where pom.xml is) and write to it

Parameters:

value -

absolutePath -

deleteFile

protected static void deleteFile(String absolutePath)

delete file

Parameters:

absolutePath -

appendToFile

protected static void appendToFile(String value,
                                   String absolutePath)

appends to existing file

Parameters:

value -

absolutePath -

appendToFile

protected static void appendToFile(String value,
                                   String directory,
                                   String filename,
                                   String type)

appends to existing file

Parameters:

value -

directory -

filename -

type -

captureExtentReportScreenshot

protected static void captureExtentReportScreenshot()

captures screenshot And attaches to extent test report

captureElementPicture

public static File captureElementPicture(EnhancedBy element)

Gets a picture of specific element displayed on the page

Parameters:

element - The element

Returns:

File

Throws:

Exception

captureElementPicture

public static File captureElementPicture(EnhancedBy element,
                                         int index)

Gets a picture of specific element displayed on the page

Parameters:

element - The element

Returns:

File

Throws:

Exception

highLightWebElement

protected static void highLightWebElement(EnhancedBy by,
                                          int index)

highlights the web element use on clicks and send key elements applicable to web driver

Parameters:

by -

index -

isMac

protected static boolean isMac()

returns true if OS is mac

Returns:

isWindows

protected static boolean isWindows()

returns true if OS is windows

Returns:

isUnix

protected static boolean isUnix()

returns true if OS is unix or linux

Returns:

isUUID

protected static boolean isUUID(String value)

is the string value UDID

Parameters:

value -

Returns:

isBoolean

protected static boolean isBoolean(String value)

returns if string is boolean

Parameters:

value -

Returns:

isNumeric

protected static boolean isNumeric(String str)

return if string is a number

Parameters:

str -

Returns:

executeJs

protected static Object executeJs(String script,
                                  Object... args)

execute javascript

Parameters:

script -

executeJsWithListReturn

protected static List<String> executeJsWithListReturn(String script,
                                                      Object... args)

execute javascript

Parameters:

script -

executeJsWithStringReturn

protected static String executeJsWithStringReturn(String script,
                                                  Object... args)

execute javascript

Parameters:

script -