HandyWrapper.py

from selenium.webdriver.common.by import By
from selenium.common.exceptions import NoSuchElementException
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as ec
from selenium.common.exceptions import *
from time import strftime
from os import path
from traceback import print_stack
import inspect
import logging

def printRed(prt):
    print("\033[91m{}\033[00m".format(prt))


class HandyWrapper():
    def __init__(self, driver):
        self.driver = driver

    def GetByType(self, locator_type):
        locator_type = locator_type.lower()
        if locator_type == "id":
            return By.ID

        if locator_type == "xpath":
            return By.XPATH

        if locator_type == "css":
            return By.CSS_SELECTOR

        if locator_type == "class_name":
            return By.CLASS_NAME

        if locator_type == "link_text":
            return By.LINK_TEXT

        if locator_type == "tag_name":
            return By.TAG_NAME

        if locator_type == "name":
            return By.NAME

        if locator_type == "partial_link_text":
            return By.PARTIAL_LINK_TEXT

        else:
            printRed("Locator type " + str(locator_type) + " is not supported")
        return locator_type

    def get_element(self,locator,locator_type="id"):
        element = None
        try:
            by_type = self.GetByType(locator_type)
            element = self.driver.find_element(by_type,locator)
            if element is not None:
                print("Element %s was found by %s " % (locator,by_type))
        except:
            printRed("!!! Element %s was not found by %s !!!" % (locator,by_type))
        return element

class Explicitly_Wait():
    def __init__(self, driver):
        self.driver = driver
        self.hw = HandyWrapper(driver)

    def wait_for_element(self,locator,locator_type="id",
                         timeout=10,poll_frequency=0.5):
        element = None
        try:
            by_type = self.hw.GetByType(locator_type)
            wait = WebDriverWait(
                self.driver,
                timeout=timeout,
                poll_frequency=poll_frequency,
                ignored_exceptions=[
                    NoSuchElementException,
                    ElementNotSelectableException,
                    ElementNotVisibleException])
            element = wait.until(ec.element_to_be_clickable((
                by_type, locator))
            )
            print("Element appeared on the page")
        except:
            print ("Element didn't appear on the page")
            print_stack()
        return element


def screenshot(driver):

    """Implementation of  webdriver.save_screenshot()
     function that takes static directory and adds to it
     a name of the executing script + timestamp + png.
     Thus having dynamic  explicit name for screenshot """

    filename = str(path.basename(__file__)) + str(strftime("%Y-%m-%d %H:%M:%S")) + ".png"
    directory = '/home/andrew/Documents/workspace_automation/Automation/Screenshots/'
    screenshot_directory = directory + filename
    try:
        driver.save_screenshot(screenshot_directory)
        print("Screenshot was saved to: " + screenshot_directory)
    except NotADirectoryError:
        print("Directory error")


def customLogger(logLevel):
    #getting the name of the method
    loggerName = inspect.stack()[1][3]
    logger = logging.getLogger(loggerName)

    #all messages

    logger.setLevel(logging.DEBUG)

    fileHandler = logging.FileHandler(filename="{0}.log".format(loggerName),mode='w')
    fileHandler.setLevel(logLevel)

    formatter = logging.Formatter('%(asctime)s, %(name)s: %(levelname)s: %(message)s', datefmt='%Y-%m-%d %H:%M:%S %p')
    fileHandler.setFormatter(formatter)
    logger.addHandler(fileHandler)
    return logger