Chapter 9: Visual validation of pdf files

Change log:

1. Added a test to generate a pdf and visually assert it
2. Basic base page lib with wrappers over selenium functions
3. Page objects for app.invoicesimple.com
4. validate_pdf method in eyes_manager.py
5. file utils to check if file is present, remove if it exists and move to required dir
6. util to execute command from python
7. generic wait method which can accept a function and then execute it till a certain timeout is reached.

Author: Gaurav Singh

automation/core/eyes_manager.py

@@ -1,7 +1,14 @@
+import os
+
 from applitools.common import BatchInfo
 from applitools.selenium import Eyes
 
 from automation.config.base import APPLITOOLS_API_KEY
+from automation.core.helper import get_resources_dir_path
+from automation.core.io import execute_cmd
+
+IMAGE_TESTER_PATH = "{}/libs/ImageTester_0_4_8.jar".format(
+    os.environ.get('HOME'))
 
 
 class EyesManager:
@@ -36,6 +43,18 @@ def validate_element(self, element, tag=None):
     def validate_frame(self, frame_reference, region, tag=None):
         self.eyes.check_region_in_frame(frame_reference, region, tag=tag)
 
+    @staticmethod
+    def validate_pdf():
+        cmd = """java -jar {} -k {} -f {}""".format(IMAGE_TESTER_PATH,
+                                                    APPLITOOLS_API_KEY,
+                                                    get_resources_dir_path())
+
+        output, _ = execute_cmd(cmd)
+        str_output = output.decode('utf-8')
+
+        print('Command execution completed... \n' + str_output)
+        return str_output
+
     def open_eyes(self, test_name):
         self.eyes.open(self.driver, self.app_name,
                        test_name=test_name)

automation/core/file_utils.py

@@ -0,0 +1,15 @@
+import os
+
+
+def is_file_downloaded(path):
+    if os.path.exists(path):
+        return True
+
+
+def remove_file_if_exists(path):
+    if os.path.exists(path):
+        os.remove(path)
+
+
+def move_file_to_path(src, dst):
+    os.rename(src, dst)

automation/core/helper.py

@@ -0,0 +1,6 @@
+from pathlib import Path
+
+
+def get_resources_dir_path():
+    return str(Path(__file__).parent.parent.resolve()) + '/resources'
+

automation/core/io.py

@@ -0,0 +1,9 @@
+import subprocess
+from subprocess import Popen
+
+
+def execute_cmd(cmd):
+    handle = Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
+                   shell=True)
+    stdout, stderr = handle.communicate()
+    return stdout, stderr

automation/core/wait.py

@@ -0,0 +1,24 @@
+import time
+
+POLL_FREQUENCY = 0.5
+WAIT_TIME = 1
+
+
+def until(method, args=None, timeout=30, message=''):
+    time_to_wait = WAIT_TIME
+
+    end_time = time.time() + timeout
+    while True:
+        try:
+            value = method(args)
+            if value:
+                return value
+        except Exception as exc:
+            print(exc)
+
+        time_to_wait *= POLL_FREQUENCY
+
+        time.sleep(time_to_wait)
+        if time.time() > end_time:
+            break
+    raise NameError(message)

automation/page_objects/base_page.py

@@ -0,0 +1,32 @@
+import selenium.webdriver.support.expected_conditions as ec
+from selenium.webdriver.support.wait import WebDriverWait
+
+
+class BasePage:
+    def __init__(self, driver):
+        self.driver = driver
+
+    def get_visible_element(self, locator, timeout=30):
+        return WebDriverWait(self.driver, timeout).until(
+            ec.visibility_of_element_located(locator))
+
+    @staticmethod
+    def enter_text(element, text):
+        element.send_keys(text)
+
+    @staticmethod
+    def click(element):
+        element.click()
+
+    def switch_to_window(self, index=1):
+        handles = self.driver.window_handles
+
+        if len(handles) == 1:
+            WebDriverWait(self.driver, 30).until(self.open_windows_gt_one)
+
+        handles = self.driver.window_handles
+        self.driver.switch_to.window(handles[index])
+
+    @staticmethod
+    def open_windows_gt_one(driver):
+        return len(driver.window_handles) > 1

automation/page_objects/invoice_simple/__init__.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+
+from selenium.webdriver.common.by import By
+
+from automation.core.file_utils import *
+from automation.core.helper import get_resources_dir_path
+from automation.core.wait import until
+from automation.page_objects.base_page import BasePage
+
+DOWNLOAD_PATH = '{}/Downloads'.format(str(Path.home()))
+
+
+class InvoiceDownloadPage(BasePage):
+    DOWNLOAD_PDF = (By.XPATH, '//a[contains(text(), "PDF")]')
+
+    def __init__(self, driver):
+        super().__init__(driver)
+        self.downloaded_file_path = None
+        self.pdf_file_name = None
+
+    def download_pdf(self, file_name):
+        self.pdf_file_name = '{}.pdf'.format(file_name)
+        self.downloaded_file_path = '{}/{}'.format(DOWNLOAD_PATH,
+                                                   self.pdf_file_name)
+
+        self.switch_to_window()
+        remove_file_if_exists(self.downloaded_file_path)
+
+        self.click(self.get_visible_element(self.DOWNLOAD_PDF))
+        self.wait_till_pdf_download(self.downloaded_file_path)
+
+        return self
+
+    @staticmethod
+    def wait_till_pdf_download(path):
+        until(method=is_file_downloaded, args=path)
+
+    def move_to_resources(self):
+        src = self.downloaded_file_path
+        dst = '{}/{}'.format(get_resources_dir_path(), self.pdf_file_name)
+        move_file_to_path(src, dst)

automation/page_objects/invoice_simple/invoice_download_page.py

@@ -0,0 +1,37 @@
+from selenium.webdriver.common.by import By
+
+from automation.page_objects.base_page import BasePage
+from automation.page_objects.invoice_simple.invoice_download_page import \
+    InvoiceDownloadPage
+
+
+class InvoicePage(BasePage):
+    FROM_NAME = (By.ID, 'invoice-company-name')
+    TO_NAME = (By.ID, 'invoice-client-name')
+    ITEM_DESCRIPTION = (By.ID, 'invoice-item-code')
+    ITEM_RATE = (By.CSS_SELECTOR, 'td[data-label="Price"] input')
+    GET_LINK = (By.CSS_SELECTOR, '.invoice-detail-about button')
+
+    def __init__(self, driver):
+        super().__init__(driver)
+
+    def enter_from_and_to_details(self, from_name, to_name):
+        sender_name = self.get_visible_element(self.FROM_NAME)
+        self.enter_text(sender_name, from_name)
+
+        receiver_name = self.get_visible_element(self.TO_NAME)
+        self.enter_text(receiver_name, to_name)
+        return self
+
+    def enter_item_with_rate(self, item, rate):
+        item_description = self.get_visible_element(self.ITEM_DESCRIPTION)
+        self.enter_text(item_description, item)
+
+        item_rate = self.get_visible_element(self.ITEM_RATE)
+        self.enter_text(item_rate, rate)
+        return self
+
+    def click_on_get_link(self):
+        get_link_btn = self.get_visible_element(self.GET_LINK)
+        self.click(get_link_btn)
+        return InvoiceDownloadPage(self.driver)