Merge pull request #93 from neetjn/issue-92-neetjn

Issue 92 - Elements Stale Checks

pyscc/element.py

@@ -25,6 +25,9 @@
 from pyscc.resource import Resource
 
 
+ELEMENTS_STALE_WAIT_TIME = 3
+
+
 # pylint: disable=too-many-public-methods
 class Element(Resource):
     """
@@ -440,6 +443,10 @@ def __find_elements(self):
         return self.controller.browser.find_elements_by_css_selector(self.selector) \
             or self.controller.browser.find_elements_by_xpath(self.selector)
 
+    def __wait_elements_not_stale(self, timeout):
+        # pylint: disable=line-too-long
+        self.controller.wait(timeout, condition=lambda: [element.text for element in self.get()])
+
     def fmt(self, **kwargs):
         """
         Used to format selectors.
@@ -465,14 +472,19 @@ def count(self):
         """
         return len(self.get())
 
-    def text(self, raw=False):
+    def text(self, raw=False, check_stale_element=False):
         """
         Get list of element text values.
 
         :param raw: Extract inner html from element.
         :type raw: bool
+        :param check_stale_element: Ensure retrieved WebElement instances are finished mounting.
+        :type check_stale_element: bool
         :return: [string, ...], None
         """
+        if check_stale_element:
+            # wait in the event element list is actively loading
+            self.__wait_elements_not_stale(ELEMENTS_STALE_WAIT_TIME)
         found = self.get()
         if found:
             collection = []
@@ -485,22 +497,32 @@ def text(self, raw=False):
             return collection
         return []
 
-    def value(self):
+    def value(self, check_stale_element=False):
         """
         Get list of input element values.
 
+        :param check_stale_element: Ensure retrieved WebElement instances are finished mounting.
+        :type check_stale_element: bool
         :return: [string, ...], None
         """
+        if check_stale_element:
+            # wait in the event element list is actively loading
+            self.__wait_elements_not_stale(ELEMENTS_STALE_WAIT_TIME)
         return [self.controller.js.get_value(element) for element in self.get()]
 
-    def get_attribute(self, attribute):
+    def get_attribute(self, attribute, check_stale_element=False):
         """
         Used to fetch list of elements attributes.
 
         :param attribute: Attribute of elements to target.
         :type attribute: string
+        :param check_stale_element: Ensure retrieved WebElement instances are finished mounting.
+        :type check_stale_element: bool
         :return: [(None, bool, int, float, string), ...]
         """
+        if check_stale_element:
+            # wait in the event element list is actively loading
+            self.__wait_elements_not_stale(ELEMENTS_STALE_WAIT_TIME)
         return [self.controller.js.get_attribute(element, attribute) for element in self.get()]
 
     def set_attribute(self, attribute, value):
@@ -517,14 +539,19 @@ def set_attribute(self, attribute, value):
             self.controller.js.set_attribute(element, attribute, value)
         return self
 
-    def get_property(self, prop):
+    def get_property(self, prop, check_stale_element=False):
         """
         Used to fetch list of elements properties.
 
         :param prop: Property of elements to target.
         :type prop: string
+        :param check_stale_element: Ensure retrieved WebElement instances are finished mounting.
+        :type check_stale_element: bool
         :return: None, bool, int, float, string
         """
+        if check_stale_element:
+            # wait in the event element list is actively loading
+            self.__wait_elements_not_stale(ELEMENTS_STALE_WAIT_TIME)
         return [self.controller.js.get_property(element, prop) for element in self.get()]
 
     def set_property(self, prop, value):

tests/test_component_elements.py

@@ -199,6 +199,7 @@ def test_elements_wrapper_text(self):
         """test elements wrapper text aggregation"""
         self.app.wait(timeout=1)  # wait for transitions
         self.assertEqual(len(self.tasks.text()), 3)
+        self.assertEqual(len(self.tasks.text(check_stale_element=True)), 3)
         for task in self.tasks.text():
             self.assertIn('2017', task)
         for task in self.tasks.text(raw=True):
@@ -213,6 +214,7 @@ def test_elements_wrapper_attributes(self):
         self.assertEqual(len(attributes), 3)
         for attr in attributes:
             self.assertEqual(attr, 'barfoo')
+        self.assertEqual(len(self.tasks.get_attribute('foobar', check_stale_element=True)), 3)
 
     def test_elements_wrapper_properties(self):
         """test elements wrapper property aggregation and specification"""
@@ -223,3 +225,4 @@ def test_elements_wrapper_properties(self):
         self.assertEqual(len(properties), 3)
         for prop in properties:
             self.assertEqual(prop, 'barfoo')
+        self.assertEqual(len(self.tasks.get_property('foobar', check_stale_element=True)), 3)