Merge pull request #370 from seleniumbase/refactor-and-update-methods

Refactor and update methods

Author: mdmintz

README.md

@@ -26,7 +26,7 @@ python -m easy_install -U pip
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Setup a Virtual Environment: (Optional)
 
-You may want to use a **Python Virtual Environment** to isolate Python dependencies between projects. (The Seleniumbase virtualenv tutorial can be found **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)**, and the official virtualenv tutorial can be found **[here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)**.)
+You may want to use a **Python Virtual Environment** to isolate Python dependencies between projects. Instructions on creating one can be found **[here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)**. (<i>Learn more about virtual environments on the official site **[here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)**.</i>)
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install ``seleniumbase``: [<img src="https://img.shields.io/badge/pypi-seleniumbase-22AAEE.svg" alt=" " />](https://pypi.python.org/pypi/seleniumbase)
 ```bash

examples/my_first_test.py

@@ -5,8 +5,8 @@ class MyTestClass(BaseCase):
 
     def test_basic(self):
         self.open("https://xkcd.com/353/")
-        self.assert_element('img[alt="Python"]')
         self.assert_title("xkcd: Python")
+        self.assert_element('img[alt="Python"]')
         self.click('a[rel="license"]')
         self.assert_text("free to copy and reuse")
         self.go_back()

examples/parameterized_test.py

@@ -5,11 +5,12 @@
 class GoogleTestClass(BaseCase):
 
     @parameterized.expand([
-        ["pypi", "https://pypi.org"],
-        ["wikipedia", "https://www.wikipedia.org"],
-        ["seleniumbase", "https://github.com/seleniumbase/SeleniumBase"],
+        ["pypi", "pypi.org"],
+        ["wikipedia", "wikipedia.org"],
+        ["seleniumbase", "seleniumbase/SeleniumBase"],
     ])
-    def test_parameterized_google_search(self, search_term, expected_url):
+    def test_parameterized_google_search(self, search_term, expected_text):
         self.open('https://google.com/ncr')
         self.update_text('input[title="Search"]', search_term + '\n')
-        self.assert_text(expected_url, '#search')
+        self.assert_element('#resultStats')
+        self.assert_text(expected_text, '#search')

help_docs/method_summary.md

@@ -21,125 +21,133 @@ self.double_click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
 self.click_chain(selectors_list, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, spacing=0)
 
-self.is_link_text_present(link_text)
+self.type(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
 
-self.is_partial_link_text_present(link_text)
+self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
 
-self.get_link_attribute(link_text, attribute, hard_fail)
+self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.get_partial_link_text_attribute(link_text, attribute, hard_fail)
+self.send_keys(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.wait_for_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
+self.submit(selector, by=By.CSS_SELECTOR)
 
-self.wait_for_partial_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
+self.refresh_page()
 
-self.click_link_text(link_text, timeout=settings.SMALL_TIMEOUT)
+self.refresh()
 
-self.click_link(link_text, timeout=settings.SMALL_TIMEOUT)
+self.get_current_url()
 
-self.click_partial_link_text(partial_link_text, timeout=settings.SMALL_TIMEOUT)
+self.get_page_source()
 
-self.get_text(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.get_page_title()
 
-self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.get_title()
 
-self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.go_back()
 
-self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.go_forward()
 
-self.get_property_value(selector, property, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.is_element_present(selector, by=By.CSS_SELECTOR)
 
-self.refresh_page()
+self.is_element_visible(selector, by=By.CSS_SELECTOR)
 
-self.refresh()
+self.is_text_visible(text, selector="html", by=By.CSS_SELECTOR)
 
-self.get_current_url()
+self.is_link_text_visible(link_text)
 
-self.get_page_source()
+self.is_partial_link_text_visible(partial_link_text)
 
-self.get_page_title()
+self.is_link_text_present(link_text)
 
-self.get_title()
+self.is_partial_link_text_present(link_text)
 
-self.go_back()
+self.get_link_attribute(link_text, attribute, hard_fail)
 
-self.go_forward()
+self.get_link_text_attribute(link_text, attribute, hard_fail)
 
-self.get_image_url(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.get_partial_link_text_attribute(link_text, attribute, hard_fail)
 
-self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.click_link_text(link_text, timeout=settings.SMALL_TIMEOUT)
 
-self.send_keys(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.click_link(link_text, timeout=settings.SMALL_TIMEOUT)
 
-self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
+self.click_partial_link_text(partial_link_text, timeout=settings.SMALL_TIMEOUT)
 
-self.type(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
+self.get_text(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.is_element_present(selector, by=By.CSS_SELECTOR)
+self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.is_element_visible(selector, by=By.CSS_SELECTOR)
+self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.is_link_text_visible(link_text)
+self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.is_partial_link_text_visible(partial_link_text)
+self.get_property_value(selector, property, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.is_text_visible(text, selector="html", by=By.CSS_SELECTOR)
+self.get_image_url(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
 self.find_elements(selector, by=By.CSS_SELECTOR, limit=0)
 
 self.find_visible_elements(selector, by=By.CSS_SELECTOR, limit=0)
 
 self.click_visible_elements(selector, by=By.CSS_SELECTOR, limit=0)
 
+self.click_if_visible(selector, by=By.CSS_SELECTOR)
+
 self.is_element_in_an_iframe(selector, by=By.CSS_SELECTOR)
 
 self.switch_to_frame_of_element(selector, by=By.CSS_SELECTOR)
 
-self.execute_script(script)
+self.hover_on_element(selector, by=By.CSS_SELECTOR)
 
-self.set_window_size(width, height)
+self.hover_and_click(hover_selector, click_selector,
+    hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.maximize_window()
+self.hover_and_double_click(hover_selector, click_selector,
+    hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.add_css_link(css_link)
+self.select_option_by_text(dropdown_selector, option,
+    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.add_js_link(js_link)
+self.select_option_by_index(dropdown_selector, option,
+    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.add_css_style(css_style)
+self.select_option_by_value(dropdown_selector, option,
+    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.add_js_code_from_link(js_link)
+self.execute_script(script)
 
-self.add_meta_tag(http_equiv=None, content=None)
+self.execute_async_script(script, timeout=settings.EXTREME_TIMEOUT)
 
-self.activate_jquery()
+self.safe_execute_script(script)
 
-self.create_tour(name=None, theme=None)
+self.set_window_size(width, height)
 
-self.create_shepherd_tour(name=None, theme=None)
+self.maximize_window()
 
-self.create_bootstrap_tour(name=None)
+self.switch_to_frame(frame, timeout=settings.SMALL_TIMEOUT)
 
-self.create_hopscotch_tour(name=None)
+self.switch_to_default_content()
 
-self.create_introjs_tour(name=None)
+self.open_new_window(switch_to=True)
 
-self.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
+self.switch_to_window(window, timeout=settings.SMALL_TIMEOUT)
 
-self.play_tour(name=None)
+self.switch_to_default_window()
 
-self.export_tour(name=None, filename="my_tour.js", url=None)
+self.get_new_driver(browser=None, headless=None, servername=None, port=None,
+                    proxy=None, switch_to=True, cap_file=None)
 
-self.activate_jquery_confirm()
+self.switch_to_driver(driver)
 
-self.activate_messenger()
+self.switch_to_default_driver()
 
-self.post_message(message, duration=None, pause=True, style="info")
+self.save_screenshot(name, folder=None)
 
-self.post_success_message(message, duration=None, pause=True)
+self.wait_for_ready_state_complete(timeout=settings.EXTREME_TIMEOUT)
 
-self.post_error_message(message, duration=None, pause=True)
+self.wait_for_angularjs(timeout=settings.LARGE_TIMEOUT)
 
-self.set_messenger_theme(theme="default", location="default", max_messages="default")
+self.activate_jquery()
 
 self.bring_to_front(selector, by=By.CSS_SELECTOR)
 
@@ -155,8 +163,6 @@ self.js_click(selector, by=By.CSS_SELECTOR)
 
 self.jquery_click(selector, by=By.CSS_SELECTOR)
 
-self.submit(selector, by=By.CSS_SELECTOR)
-
 self.hide_element(selector, by=By.CSS_SELECTOR)
 
 self.hide_elements(selector, by=By.CSS_SELECTOR)
@@ -185,8 +191,6 @@ self.assert_no_404_errors(multithreaded=True)
 
 self.print_unique_links_with_status_codes()
 
-self.safe_execute_script(script)
-
 self.create_folder(folder)
 
 self.choose_file(selector, file_path, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
@@ -231,22 +235,47 @@ self.js_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.LA
 
 self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.hover_on_element(selector, by=By.CSS_SELECTOR)
+########
 
-self.hover_and_click(hover_selector, click_selector,
-    hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.add_css_link(css_link)
 
-self.hover_and_double_click(hover_selector, click_selector,
-    hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.add_js_link(js_link)
 
-self.select_option_by_text(dropdown_selector, option,
-    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.add_css_style(css_style)
 
-self.select_option_by_index(dropdown_selector, option,
-    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.add_js_code_from_link(js_link)
 
-self.select_option_by_value(dropdown_selector, option,
-    dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.add_meta_tag(http_equiv=None, content=None)
+
+########
+
+self.create_tour(name=None, theme=None)
+
+self.create_shepherd_tour(name=None, theme=None)
+
+self.create_bootstrap_tour(name=None)
+
+self.create_hopscotch_tour(name=None)
+
+self.create_introjs_tour(name=None)
+
+self.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
+
+self.play_tour(name=None)
+
+self.export_tour(name=None, filename="my_tour.js", url=None)
+
+self.activate_jquery_confirm()
+
+self.activate_messenger()
+
+self.post_message(message, duration=None, pause=True, style="info")
+
+self.post_success_message(message, duration=None, pause=True)
+
+self.post_error_message(message, duration=None, pause=True)
+
+self.set_messenger_theme(theme="default", location="default", max_messages="default")
 
 ########
 
@@ -262,16 +291,14 @@ self.generate_traffic_chain(pages, loops=1)
 
 self.wait_for_element_present(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
 
-self.get_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
-
-self.assert_element_present(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
-
-########
-
 self.wait_for_element_visible(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
 
 self.wait_for_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
 
+self.get_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
+
+self.assert_element_present(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+
 self.find_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
 
 self.assert_element(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
@@ -296,6 +323,10 @@ self.assert_exact_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settin
 
 ########
 
+self.wait_for_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
+
+self.wait_for_partial_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
+
 self.wait_for_link_text_visible(link_text, timeout=settings.LARGE_TIMEOUT)
 
 self.wait_for_link_text(link_text, timeout=settings.LARGE_TIMEOUT)
@@ -326,35 +357,16 @@ self.assert_element_not_visible(selector, by=By.CSS_SELECTOR, timeout=settings.S
 
 ########
 
-self.wait_for_ready_state_complete(timeout=settings.EXTREME_TIMEOUT)
-
 self.wait_for_and_accept_alert(timeout=settings.LARGE_TIMEOUT)
 
 self.wait_for_and_dismiss_alert(timeout=settings.LARGE_TIMEOUT)
 
 self.wait_for_and_switch_to_alert(timeout=settings.LARGE_TIMEOUT)
 
-self.switch_to_frame(frame, timeout=settings.SMALL_TIMEOUT)
-
-self.switch_to_default_content()
-
-self.open_new_window(switch_to=True)
-
-self.switch_to_window(window, timeout=settings.SMALL_TIMEOUT)
-
-self.switch_to_default_window()
+########
 
 self.check_window(name="default", level=0, baseline=False)
 
-self.save_screenshot(name, folder=None)
-
-self.get_new_driver(browser=None, headless=None, servername=None, port=None,
-                    proxy=None, switch_to=True, cap_file=None)
-
-self.switch_to_driver(driver)
-
-self.switch_to_default_driver()
-
 ########
 
 self.delayed_assert_element(selector, by=By.CSS_SELECTOR, timeout=settings.MINI_TIMEOUT)

integrations/node_js/my_first_test.py

@@ -5,8 +5,8 @@ class MyTestClass(BaseCase):
 
     def test_basic(self):
         self.open("https://xkcd.com/353/")
-        self.assert_element('img[alt="Python"]')
         self.assert_title("xkcd: Python")
+        self.assert_element('img[alt="Python"]')
         self.click('a[rel="license"]')
         self.assert_text("free to copy and reuse")
         self.go_back()