Elements are now read from a json file so that it

doesn't need to be rebuilt for every ui change.

Author: Leith Merrifield

src/Elements.py

@@ -1,69 +1,98 @@
 from selenium.webdriver.common.by import By
+import json
 
-USERNAMEFIELD = (By.ID, "i0116")
-PASSWORDFIELD = (By.ID, "i0118")
-NEXTBUTTON = (By.ID, "idSIButton9")
-NOBUTTON = (By.ID, "idBtn_Back")
 
+class ElementClass:
+    def __init__(self) -> None:
+        self.element_error_flag = False
+        self.elements = self.read_elements_from_json()
 
-NETSUITEHOMEPAGE = (By.ID, "uif53")  # netsuite homepage identifier?
+        if self.element_error_flag:
+            return
 
-NETSUITE_ENVIRONMENT = (
-    By.XPATH,
-    "/html/body/div[2]/div[3]/div/table/tbody/tr[2]/td/table/tbody/tr[2]/td[3]/a",
-)
-WMS = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div/div[2]/div[2]/img")
-WAREHOUSE = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]/div/div/div[6]/div[1]/table/tbody/tr[2]/td",
-)
-PICKING = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]")
-SINGLEORDER = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]")
-RELEASEDORDER = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]")
-SALESORDER = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]")
+        self.assign_ui_elements(self.elements)
 
-ORDERINPUT = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]/div[2]/input",
-)
-ORDERINPUTWITHERROR = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[3]/div[1]/div[2]/input",
-)
-ENTERORDER = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[2]/div[1]/div/div[3]/button",
-)
+    def read_elements_from_json(self):
+        try:
+            with open(r".\src\elements.json", "r", encoding="utf-8") as openfile:
+                return json.load(openfile)
+        except FileNotFoundError:
+            self.element_error_flag = True
 
-FIRSTENTRY = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]/div/div/div[6]/div[1]/table/tbody/tr[1]",
-)
-BINNUMBER = (By.XPATH, "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]/div/span")
-ITEMNUMBER = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]/div/span",
-)
-QUANTITYAMOUNT = (By.XPATH,"/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[2]/div/span",)
-QUANTITYINPUT = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[4]/div/div[2]/div/div/input",
-)
-NEXTPICKTASK = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[2]/div[1]/div/div[3]/button",
-)
-STATIONINPUT = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]/div[2]/input",
-)
-NEXTORDERBUTTON = (
-    By.XPATH,
-    "/html/body/div/div/div[2]/div[2]/div/div[2]/div[1]/div/div[2]/button",
-)
+    def assign_ui_elements(self, dict):
+        self.USERNAMEFIELD = self.elements["USERNAMEFIELD"]
+        self.PASSWORDFIELD = self.elements["PASSWORDFIELD"]
+        self.NEXTBUTTON = self.elements["NEXTBUTTON"]
+        self.NOBUTTON = self.elements["NOBUTTON"]
+        self.NETSUITEHOMEPAGE = self.elements[
+            "NETSUITEHOMEPAGE"
+        ]  # netsuite homepage identifier?
+        self.NETSUITE_ENVIRONMENT = (
+            self.elements["NETSUITE_ENVIRONMENT"][0],
+            self.elements["NETSUITE_ENVIRONMENT"][1],
+        )
+        self.WMS = (self.elements["WMS"][0], self.elements["WMS"][1])
+        self.WAREHOUSE = (self.elements["WAREHOUSE"][0], self.elements["WAREHOUSE"][1])
+        self.PICKING = (self.elements["PICKING"][0], self.elements["PICKING"][1])
+        self.SINGLEORDER = (
+            self.elements["SINGLEORDER"][0],
+            self.elements["SINGLEORDER"][1],
+        )
+        self.RELEASEDORDER = (
+            self.elements["RELEASEDORDER"][0],
+            self.elements["RELEASEDORDER"][1],
+        )
+        self.SALESORDER = (
+            self.elements["SALESORDER"][0],
+            self.elements["SALESORDER"][1],
+        )
+        self.ORDERINPUT = (
+            self.elements["ORDERINPUT"][0],
+            self.elements["ORDERINPUT"][1],
+        )
+        self.ORDERINPUTWITHERROR = (
+            self.elements["ORDERINPUTWITHERROR"][0],
+            self.elements["ORDERINPUTWITHERROR"][1],
+        )
+        self.ENTERORDER = (
+            self.elements["ENTERORDER"][0],
+            self.elements["ENTERORDER"][1],
+        )
+        self.FIRSTENTRY = (
+            self.elements["FIRSTENTRY"][0],
+            self.elements["FIRSTENTRY"][1],
+        )
+        self.BINNUMBER = (self.elements["BINNUMBER"][0], self.elements["BINNUMBER"][1])
+        self.ITEMNUMBER = (
+            self.elements["ITEMNUMBER"][0],
+            self.elements["ITEMNUMBER"][1],
+        )
+        self.QUANTITYAMOUNT = (
+            self.elements["QUANTITYAMOUNT"][0],
+            self.elements["QUANTITYAMOUNT"][1],
+        )
+        self.QUANTITYINPUT = (
+            self.elements["QUANTITYINPUT"][0],
+            self.elements["QUANTITYINPUT"][1],
+        )
+        self.NEXTPICKTASK = (
+            self.elements["NEXTPICKTASK"][0],
+            self.elements["NEXTPICKTASK"][1],
+        )
+        self.STATIONINPUT = (
+            self.elements["STATIONINPUT"][0],
+            self.elements["STATIONINPUT"][1],
+        )
+        self.NEXTORDERBUTTON = (
+            self.elements["NEXTORDERBUTTON"][0],
+            self.elements["NEXTORDERBUTTON"][1],
+        )
+
+        SALESORDERREFRESH = "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]"
+        BACKBUTTONREFRESH = (
+            "/html/body/div/div/div[2]/div[2]/div/div[2]/div[1]/div[1]/button"
+        )
 
-SALESORDERREFRESH = "/html/body/div/div/div[2]/div[2]/div/div[1]/div[2]/div[1]"
-BACKBUTTONREFRESH = "/html/body/div/div/div[2]/div[2]/div/div[2]/div[1]/div[1]/button"
 
 STAGE = [
     "Select Application",

src/LoginScreen.py

@@ -96,6 +96,9 @@ def do_login(self):
         # if "@bollebrands.com" not in username.lower() or password == "":
         #    return
 
+        if not self.driver.continue_program:
+            return
+
         if self.ids.login_checkbox.active:
             self.store_login(username, password)
 

src/MainWebDriver.py

@@ -6,7 +6,7 @@
 from selenium.common import exceptions
 from selenium.webdriver.common.alert import Alert
 from selenium.webdriver.chrome.options import Options
-from src import Elements
+from src.Elements import ElementClass
 from src.state import State
 from src.CheckDriver import compare_and_download as update_driver
 from selenium.webdriver.chrome.service import (
@@ -57,7 +57,10 @@ def __init__(self) -> None:
         self.order_list = []
         self.state = State()
         self.driver = None
+        self.continue_program = True
         self.pick_delay = 1.5
+        self.elements = ElementClass()
+        self.check_if_elements_exist()
 
     def read_links(self):
         """Reads settings json file and returns json object
@@ -92,6 +95,18 @@ def run_driver(self, chrome_service, chrome_options, manual_flag) -> None:
                 service=chrome_service, chrome_options=chrome_options
             )
 
+    def check_if_elements_exist(self):
+        if self.elements.element_error_flag:
+            Clock.schedule_once(
+                partial(
+                    self.test_popup,
+                    "elements.json doesn't exist",
+                    "reinstall autoscanner",
+                ),
+                1,
+            )
+            self.continue_program = False
+
     def pick(self, order):
         """
         Continually Crawls through individual picking of each item untill it detects
@@ -106,26 +121,27 @@ def pick(self, order):
             while True:
                 sleep(self.pick_delay)
                 WebDriverWait(self.driver, TIMOUT).until(
-                    EC.element_to_be_clickable(Elements.FIRSTENTRY)
+                    EC.element_to_be_clickable(self.elements.FIRSTENTRY)
                 ).click()
                 sleep(self.pick_delay)
                 WebDriverWait(self.driver, TIMOUT).until(
-                    EC.element_to_be_clickable(Elements.BINNUMBER)
+                    EC.element_to_be_clickable(self.elements.BINNUMBER)
                 ).click()
                 sleep(self.pick_delay)
                 WebDriverWait(self.driver, TIMOUT).until(
-                    EC.element_to_be_clickable(Elements.ITEMNUMBER)
+                    EC.element_to_be_clickable(self.elements.ITEMNUMBER)
                 ).click()
                 sleep(self.pick_delay)
 
-
-                amount = self.driver.find_element(Elements.QUANTITYAMOUNT[0],Elements.QUANTITYAMOUNT[1]).text.split(" ")[0]
+                amount = self.driver.find_element(
+                    self.elements.QUANTITYAMOUNT[0], self.elements.QUANTITYAMOUNT[1]
+                ).text.split(" ")[0]
                 amount += "\n"
                 sleep(1)
                 WebDriverWait(self.driver, TIMOUT).until(
-                    EC.element_to_be_clickable(Elements.QUANTITYINPUT)
+                    EC.element_to_be_clickable(self.elements.QUANTITYINPUT)
                 ).send_keys(amount)
-                
+
                 sleep(self.pick_delay)
 
                 mark = self.driver.find_element(
@@ -136,7 +152,7 @@ def pick(self, order):
 
                 if mark.text.lower() == "Pick Task Complete".lower():
                     WebDriverWait(self.driver, TIMOUT).until(
-                        EC.element_to_be_clickable(Elements.NEXTPICKTASK)
+                        EC.element_to_be_clickable(self.elements.NEXTPICKTASK)
                     ).click()
                 else:
                     break
@@ -149,13 +165,13 @@ def pick(self, order):
                 station = "PackStation02\n"
 
             WebDriverWait(self.driver, TIMOUT).until(
-                EC.element_to_be_clickable(Elements.STATIONINPUT)
+                EC.element_to_be_clickable(self.elements.STATIONINPUT)
             ).send_keys(station)
 
             sleep(3)
 
             WebDriverWait(self.driver, TIMOUT).until(
-                EC.element_to_be_clickable(Elements.NEXTORDERBUTTON)
+                EC.element_to_be_clickable(self.elements.NEXTORDERBUTTON)
             ).click()
             sleep(self.pick_delay)
         except exceptions.NoSuchWindowException:
@@ -203,19 +219,23 @@ def scan(
                 # but I may aswell do it this way
                 try:
                     WebDriverWait(self.driver, 2).until(
-                        EC.element_to_be_clickable(Elements.ORDERINPUT)
+                        EC.element_to_be_clickable(self.elements.ORDERINPUT)
                     ).clear()
                     WebDriverWait(self.driver, 2).until(
-                        EC.element_to_be_clickable(Elements.ORDERINPUT)
+                        EC.element_to_be_clickable(self.elements.ORDERINPUT)
                     ).send_keys(order)
                 except exceptions.TimeoutException:
                     # Timeout in finding the normal textbox to enter the order into
                     try:
                         WebDriverWait(self.driver, 2).until(
-                            EC.element_to_be_clickable(Elements.ORDERINPUTWITHERROR)
+                            EC.element_to_be_clickable(
+                                self.elements.ORDERINPUTWITHERROR
+                            )
                         ).clear()
                         WebDriverWait(self.driver, 2).until(
-                            EC.element_to_be_clickable(Elements.ORDERINPUTWITHERROR)
+                            EC.element_to_be_clickable(
+                                self.elements.ORDERINPUTWITHERROR
+                            )
                         ).send_keys(order)
                     except exceptions.TimeoutException as e:
                         # At this point there is no text box to enter into at all
@@ -232,7 +252,7 @@ def scan(
                         continue
 
                 WebDriverWait(self.driver, 2).until(
-                    EC.element_to_be_clickable(Elements.ENTERORDER)
+                    EC.element_to_be_clickable(self.elements.ENTERORDER)
                 ).click()
 
                 try:
@@ -457,10 +477,10 @@ def login_microsoft(self, login_flag, username, password, login_failed_callback)
             try:
                 sleep(2)
                 self.driver.find_element(
-                    Elements.USERNAMEFIELD[0], Elements.USERNAMEFIELD[1]
+                    self.elements.USERNAMEFIELD[0], self.elements.USERNAMEFIELD[1]
                 ).send_keys(username)
                 WebDriverWait(self.driver, TIMOUT).until(
-                    EC.element_to_be_clickable(Elements.NEXTBUTTON)
+                    EC.element_to_be_clickable(self.elements.NEXTBUTTON)
                 ).click()
                 sleep(1)
             except exceptions.NoSuchElementException:
@@ -486,11 +506,11 @@ def login_microsoft(self, login_flag, username, password, login_failed_callback)
                 pass
 
             WebDriverWait(self.driver, TIMOUT).until(
-                EC.element_to_be_clickable(Elements.PASSWORDFIELD)
+                EC.element_to_be_clickable(self.elements.PASSWORDFIELD)
             ).send_keys(password)
 
             WebDriverWait(self.driver, TIMOUT).until(
-                EC.element_to_be_clickable(Elements.NEXTBUTTON)
+                EC.element_to_be_clickable(self.elements.NEXTBUTTON)
             ).click()
 
             try:
@@ -511,21 +531,21 @@ def login_microsoft(self, login_flag, username, password, login_failed_callback)
                 pass
 
             WebDriverWait(self.driver, TIMOUT).until(
-                EC.element_to_be_clickable(Elements.NOBUTTON)
+                EC.element_to_be_clickable(self.elements.NOBUTTON)
             ).click()
 
             count = 0
             while count < TIMOUT:
                 try:
                     WebDriverWait(self.driver, 1).until(
-                        EC.element_to_be_clickable(Elements.NETSUITE_ENVIRONMENT)
+                        EC.element_to_be_clickable(self.elements.NETSUITE_ENVIRONMENT)
                     ).click()
                     break
                 except:
                     pass
                 try:
                     WebDriverWait(self.driver, 1).until(
-                        EC.element_to_be_clickable(Elements.NETSUITEHOMEPAGE)
+                        EC.element_to_be_clickable(self.elements.NETSUITEHOMEPAGE)
                     ).click()
                     break
                 except:
@@ -577,27 +597,27 @@ def get_to_orders(self, login_flag, refresh_flag=False):
             pass
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.WMS)
+            EC.element_to_be_clickable(self.elements.WMS)
         ).click()
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.WAREHOUSE)
+            EC.element_to_be_clickable(self.elements.WAREHOUSE)
         ).click()
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.PICKING)
+            EC.element_to_be_clickable(self.elements.PICKING)
         ).click()
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.SINGLEORDER)
+            EC.element_to_be_clickable(self.elements.SINGLEORDER)
         ).click()
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.RELEASEDORDER)
+            EC.element_to_be_clickable(self.elements.RELEASEDORDER)
         ).click()
         sleep(1)
         WebDriverWait(self.driver, TIMOUT).until(
-            EC.element_to_be_clickable(Elements.SALESORDER)
+            EC.element_to_be_clickable(self.elements.SALESORDER)
         ).click()
 
         self.state.change_state(self.identify_page())