Merge pull request #335 from seleniumbase/standardize-methods

Standardize methods

Author: mdmintz

examples/github_test.py

@@ -1,16 +1,13 @@
 from seleniumbase import BaseCase
-import time
 
 
 class GitHubTests(BaseCase):
 
     # Selenium can trigger GitHub's abuse detection mechanism:
     # "You have triggered an abuse detection mechanism."
     # "Please wait a few minutes before you try again."
-    # To avoid this, slow down Selenium actions.
-    def slow_click(self, css_selector):
-        time.sleep(1.05)
-        self.click(css_selector)
+    # To avoid this, slow_click() is being used to
+    # slow down Selenium actions.
 
     def test_github(self):
         self.open("https://github.com/")

examples/upload_file_test.py

@@ -0,0 +1,19 @@
+from seleniumbase import BaseCase
+
+
+class FileUploadButtonTests(BaseCase):
+
+    """ The main purpose of this is to test the self.choose_file() method. """
+
+    def test_file_upload_button(self):
+        self.open("https://www.w3schools.com/jsref/tryit.asp"
+                  "?filename=tryjsref_fileupload_get")
+        self.wait_for_element('[id*="google_ads"]')
+        self.remove_elements('[id*="google_ads"]')
+        self.switch_to_frame('iframeResult')
+        self.add_css_style(
+            'input[type="file"]{zoom: 1.5;-moz-transform: scale(1.5);}')
+        self.highlight('input[type="file"]')
+        self.choose_file('input[type="file"]', "example_logs/screenshot.png")
+        self.demo_mode = True  # Adds highlighting to the assert statement
+        self.assert_element('input[type="file"]')

help_docs/method_summary.md

@@ -9,12 +9,15 @@ self.open(url)
 
 self.open_url(url)
 
-self.click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+self.visit(url)
+
+self.click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, delay=0)
+
+self.slow_click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
 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.click_chain(selectors_list, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, spacing=0)
 
 self.is_link_text_present(link_text)
 
@@ -30,17 +33,13 @@ self.click_partial_link_text(partial_link_text, timeout=settings.SMALL_TIMEOUT)
 
 self.get_text(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.get_attribute(selector, attribute, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.get_property_value(selector, property, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+self.get_property_value(selector, property, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
 self.refresh_page()
 
@@ -60,15 +59,13 @@ self.go_forward()
 
 self.get_image_url(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.add_text(selector, new_value, timeout=settings.SMALL_TIMEOUT)
+self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.send_keys(selector, new_value, timeout=settings.SMALL_TIMEOUT)
+self.send_keys(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.update_text_value(selector, new_value,
-    timeout=settings.SMALL_TIMEOUT, retry=False)
+self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
 
-self.update_text(selector, new_value, timeout=settings.SMALL_TIMEOUT,
-    retry=False)
+self.type(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
 
 self.is_element_present(selector, by=By.CSS_SELECTOR)
 
@@ -118,8 +115,7 @@ 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.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
 
 self.play_tour(name=None)
 
@@ -135,8 +131,7 @@ 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")
+self.set_messenger_theme(theme="default", location="default", max_messages="default")
 
 self.bring_to_front(selector, by=By.CSS_SELECTOR)
 
@@ -186,6 +181,8 @@ self.safe_execute_script(script)
 
 self.create_folder(folder)
 
+self.choose_file(selector, file_path, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
+
 self.save_element_as_image_file(selector, file_name, folder=None)
 
 self.download_file(file_url, destination_folder=None)
@@ -218,23 +215,16 @@ self.convert_xpath_to_css(xpath)
 
 self.convert_to_css_selector(selector, by)
 
-self.set_value(selector, new_value, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
-
-self.js_update_text(selector, new_value, by=By.CSS_SELECTOR,
-    timeout=settings.LARGE_TIMEOUT)
+self.set_value(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
-self.jquery_update_text_value(selector, new_value, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+self.js_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
 
-self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
+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)
+    hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 
 self.select_option_by_text(dropdown_selector, option,
     dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)

seleniumbase/core/log_helper.py

@@ -130,3 +130,9 @@ def log_folder_setup(log_path, archive_logs=False):
             os.makedirs(log_path)
             if not settings.ARCHIVE_EXISTING_LOGS and not archive_logs:
                 shutil.rmtree(archived_logs)
+            elif len(os.listdir(archived_logs)) == 0:
+                # Don't archive an empty directory
+                shutil.rmtree(archived_logs)
+            else:
+                # Logs are saved/archived
+                pass