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	captureReportScreenshot() captures screenshot And attaches to extent test report
protected static String	convertListToString(ArrayList<String> list)
protected static String	convertListToString(ArrayList<String> list, String separator)
protected static URL	convertToUrl(String url) converts url string to url object
protected static void	copyDirectory(String dirFrom, String dirTo) Copies directory And all content from dirFrom to dirTo overwrites the content
protected static File	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 or directory
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 String	generateUUID() generate uuid
protected static String	generateUUID(boolean includeDash) generate uuid
protected static String	generateUUID(int length) generate uuid
protected static String	generateUUID(int length, boolean includeDash) generate uuid
protected static List<String>	getAllValuesStartringWith(String source, String value) gets a list of string from 'source' starting with 'value'
protected static double	getDoubleFromString(String value, boolean isFailOnNoInt) get numeric value from string
protected static File	getFile(String directoryPath) get file from file path
protected static File	getFileByName(String path, String filename) get file by name
protected static File	getFileByName(String path, String filename, boolean includeSubDir) get file by name
protected static String	getFileContent(String absolutePath) gets file content as String
protected static String	getFileContent(String absolutePath, boolean verifyFileExists) gets file content as String
protected static ArrayList<File>	getFileList(String directoryPath) returns the list of files in directory
protected static ArrayList<File>	getFileList(String directoryPath, ArrayList<File> files) returns the list of files in directory
protected static ArrayList<File>	getFileList(String directoryPath, boolean includeSubDir) 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 ArrayList<File>	getFileListByType(String directoryPath, String type, boolean includeSubDir) gets the list of files tye: file type.
protected static List<File>	getFileListWithSubfolders(String directoryName, List<File> files)
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 int	getFirstNumber(String value)
protected static String	getFullPath(String path) gets full path from relative path relative path is from root directory ( where pom.xml file is located )
protected static int	getIntFromString(String value, boolean isFailOnNoInt) get numeric value from string
protected static List<String>	getLinesInFileContainingWith(String value, File file) get line in file containing string
protected static List<String>	getLinesInFileStartingWith(String value, File file) get line in file starting with string
static String	getMavenArtifactId()
static String	getMavenDependencyVersion(String dependency)
protected static String	getPageSource() gets page source
protected static String	getRootDir() get current project root directory, where pom.xml is
static String	getValueBetweenStrings(String source, String value1, String value2, int position) get value between 2 strings.
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	isFileContainString(String value, File file) does file contain the given text value
protected static boolean	isFilenameInDir(File dir, String name)
protected static boolean	isLineInFileStartWithString(String value, File file) is line in file start with string
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
static boolean	isProxyRequired(URL url) get proxy state from proxy enabled config values: true, false, auto if auto is set, then through proxy detection, we set value to true or false
protected static boolean	isStringContainNumber(String value) does string have int value
protected static boolean	isStringContainOnlyNumber(String value) does string have only numeric value
protected static boolean	isUnix() returns true if OS is unix or linux
static boolean	isUrlAbleToConnect(URL source, Proxy proxy) check if able to connect to source url
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
protected static void	printPageSource() prints page source to console
protected static String	readFileContent(String absolutePath) gets file content as String
protected static String	removeSurroundingQuotes(String value) remove surrounding double quotes from the string
static boolean	setProxyAutoDetection(URL source) checks if proxy is required first attempt without proxy, second with proxy, checking the validity of the proxy connection
static void	slackNotificationWithFile(String title, String comment, String filePath) TODO: replace slack api with newer library 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:

generateUUID

protected static String generateUUID()

generate uuid

Returns:

generateUUID

protected static String generateUUID(boolean includeDash)

generate uuid

Parameters:

includeDash -

Returns:

generateUUID

protected static String generateUUID(int length)

generate uuid

Parameters:

length -

Returns:

generateUUID

protected static String generateUUID(int length,
                                     boolean includeDash)

generate uuid

Parameters:

length -

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:

isFilenameInDir

protected static boolean isFilenameInDir(File dir,
                                         String name)

slackNotificationWithFile

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

TODO: replace slack api with newer library 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:

getFileListByType

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

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

Returns:

getFileList

protected static ArrayList<File> getFileList(String directoryPath,
                                             boolean includeSubDir)

returns the list of files in directory

Parameters:

directoryPath -

Returns:

getFileList

protected static ArrayList<File> getFileList(String directoryPath,
                                             ArrayList<File> files)

returns the list of files in directory

Parameters:

directoryPath -

Returns:

getFileList

protected static ArrayList<File> getFileList(String directoryPath)

returns the list of files in directory

Parameters:

directoryPath -

Returns:

getFullPath

protected static String getFullPath(String path)

gets full path from relative path relative path is from root directory ( where pom.xml file is located )

Parameters:

path -

Returns:

getFile

protected static File getFile(String directoryPath)

get file from file path

Parameters:

directoryPath -

Returns:

getFileByName

protected static File getFileByName(String path,
                                    String filename)

get file by name

Parameters:

path -

filename -

Returns:

getFileByName

protected static File getFileByName(String path,
                                    String filename,
                                    boolean includeSubDir)

get file by name

Parameters:

path -

filename -

Returns:

getFileListWithSubfolders

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

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:

readFileContent

protected static String readFileContent(String absolutePath)

gets file content as String

Parameters:

absolutePath -

Returns:

getFileContent

protected static String getFileContent(String absolutePath)

gets file content as String

Parameters:

absolutePath -

Returns:

getFileContent

protected static String getFileContent(String absolutePath,
                                       boolean verifyFileExists)

gets file content as String

Parameters:

absolutePath -

Returns:

createFileFromPath

protected static File createFileFromPath(String absolutePath)

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

Parameters:

path -

Returns:

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 or directory

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 -

captureReportScreenshot

protected static void captureReportScreenshot()

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 -

getIntFromString

protected static int getIntFromString(String value,
                                      boolean isFailOnNoInt)

get numeric value from string

Parameters:

value -

isFailOnNoInt -

Returns:

getFirstNumber

protected static int getFirstNumber(String value)

getDoubleFromString

protected static double getDoubleFromString(String value,
                                            boolean isFailOnNoInt)

get numeric value from string

Parameters:

value -

isFailOnNoInt -

Returns:

isStringContainOnlyNumber

protected static boolean isStringContainOnlyNumber(String value)

does string have only numeric value

Parameters:

value -

Returns:

isStringContainNumber

protected static boolean isStringContainNumber(String value)

does string have int value

Parameters:

value -

Returns:

removeSurroundingQuotes

protected static String removeSurroundingQuotes(String value)

remove surrounding double quotes from the string

Parameters:

value -

Returns:

convertToUrl

protected static URL convertToUrl(String url)

converts url string to url object

Parameters:

url -

Returns:

isUrlAbleToConnect

public static boolean isUrlAbleToConnect(URL source,
                                         Proxy proxy)

check if able to connect to source url

Parameters:

source -

Returns:

isProxyRequired

public static boolean isProxyRequired(URL url)

get proxy state from proxy enabled config values: true, false, auto if auto is set, then through proxy detection, we set value to true or false

Parameters:

url -

Returns:

setProxyAutoDetection

public static boolean setProxyAutoDetection(URL source)

checks if proxy is required first attempt without proxy, second with proxy, checking the validity of the proxy connection

Parameters:

source -

Returns:

getMavenArtifactId

public static String getMavenArtifactId()

getMavenDependencyVersion

public static String getMavenDependencyVersion(String dependency)

isFileContainString

protected static boolean isFileContainString(String value,
                                             File file)

does file contain the given text value

Parameters:

value -

file -

Returns:

isLineInFileStartWithString

protected static boolean isLineInFileStartWithString(String value,
                                                     File file)

is line in file start with string

Parameters:

value -

file -

Returns:

getLinesInFileStartingWith

protected static List<String> getLinesInFileStartingWith(String value,
                                                         File file)

get line in file starting with string

Parameters:

value -

file -

Returns:

getLinesInFileContainingWith

protected static List<String> getLinesInFileContainingWith(String value,
                                                           File file)

get line in file containing string

Parameters:

value -

file -

Returns:

printPageSource

protected static void printPageSource()

prints page source to console

getPageSource

protected static String getPageSource()

gets page source

Returns:

convertListToString

protected static String convertListToString(ArrayList<String> list)

convertListToString

protected static String convertListToString(ArrayList<String> list,
                                            String separator)

getValueBetweenStrings

public static String getValueBetweenStrings(String source,
                                            String value1,
                                            String value2,
                                            int position)

get value between 2 strings. eg. value . and are the 2 values passed.

Parameters:

source -

value1 -

value2 -

position -

Returns: