Merge pull request #1522 from seleniumbase/new-methods-and-refactoring

New methods and refactoring

Author: mdmintz

README.md

@@ -5,7 +5,7 @@
 <meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
 <link rel="icon" href="https://seleniumbase.github.io/img/green_logo2.png" />
 
-<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/mac_sb_logo_bg2.png" alt="SeleniumBase" title="SeleniumBase" width="408" /></a></p>
+<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/mac_sb_logo_bw.png" alt="SeleniumBase" title="SeleniumBase" width="408" /></a></p>
 
 <p align="center"><b>A framework for web automation and testing with <a href="https://www.python.org/about/" target="_blank">Python</a>.</b><br />SeleniumBase extends <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">Selenium WebDriver</a> as a <a href="https://docs.pytest.org/en/latest/how-to/usage.html" target="_blank">pytest</a> plugin.</p>
 

examples/raw_parameter_script.py

@@ -47,6 +47,7 @@
     sb.variables = {}
     sb.account = None
     sb.environment = "test"
+    sb.env = "test"  # should match sb.environment
     sb.user_agent = None
     sb.incognito = False
     sb.guest_mode = False
@@ -56,7 +57,7 @@
     sb.extension_zip = None
     sb.extension_dir = None
     sb.database_env = "test"
-    sb.log_path = "latest_logs/"
+    sb.log_path = "latest_logs"
     sb.archive_logs = False
     sb.disable_csp = False
     sb.disable_ws = False

examples/swag_labs_suite.py

@@ -81,10 +81,8 @@ def tearDown(self):
         self.save_teardown_screenshot()
         # Reset App State and Logout if the controls are present
         try:
-            if self.is_element_present("a#reset_sidebar_link"):
-                self.js_click("a#reset_sidebar_link")
-            if self.is_element_present("a#logout_sidebar_link"):
-                self.js_click("a#logout_sidebar_link")
+            self.js_click_if_present("a#reset_sidebar_link")
+            self.js_click_if_present("a#logout_sidebar_link")
         except Exception:
             pass
         super(SwagLabsTests, self).tearDown()

examples/test_image_saving.py

@@ -26,8 +26,9 @@ def test_1_save_element_as_image_file(self):
         file_name = "comic.png"
         folder = "images_exported"
         self.save_element_as_image_file(selector, file_name, folder)
-        self.assert_true(os.path.exists("%s/%s" % (folder, file_name)))
-        print('\n"%s/%s" was saved!' % (folder, file_name))
+        file_path = os.path.join(folder, file_name)
+        self.assert_true(os.path.exists(file_path))
+        print('\n"%s" was saved!' % file_path)
 
     # @pytest.mark.run(order=2)
     def test_2_add_text_overlay_to_image(self):
@@ -40,8 +41,9 @@ def test_2_add_text_overlay_to_image(self):
         self.save_element_as_image_file(
             selector, file_name, folder, overlay_text
         )
-        self.assert_true(os.path.exists("%s/%s" % (folder, file_name)))
-        print('\n"%s/%s" was saved!' % (folder, file_name))
+        file_path = os.path.join(folder, file_name)
+        self.assert_true(os.path.exists(file_path))
+        print('\n"%s" was saved!' % file_path)
 
     # @pytest.mark.run(order=3)
     def test_3_add_text_overlay_to_page_section(self):
@@ -59,8 +61,9 @@ def test_3_add_text_overlay_to_page_section(self):
         self.save_element_as_image_file(
             selector, file_name, folder, overlay_text
         )
-        self.assert_true(os.path.exists("%s/%s" % (folder, file_name)))
-        print('\n"%s/%s" was saved!' % (folder, file_name))
+        file_path = os.path.join(folder, file_name)
+        self.assert_true(os.path.exists(file_path))
+        print('\n"%s" was saved!' % file_path)
 
     # @pytest.mark.run(order=4)
     def test_4_add_text_overlay_to_full_page(self):
@@ -74,5 +77,6 @@ def test_4_add_text_overlay_to_full_page(self):
         self.save_element_as_image_file(
             selector, file_name, folder, overlay_text
         )
-        self.assert_true(os.path.exists("%s/%s" % (folder, file_name)))
-        print('\n"%s/%s" was saved!' % (folder, file_name))
+        file_path = os.path.join(folder, file_name)
+        self.assert_true(os.path.exists(file_path))
+        print('\n"%s" was saved!' % file_path)

examples/test_swag_labs.py

@@ -69,10 +69,8 @@ def tearDown(self):
         self.save_teardown_screenshot()
         # Reset App State and Logout if the controls are present
         try:
-            if self.is_element_present("a#reset_sidebar_link"):
-                self.js_click("a#reset_sidebar_link")
-            if self.is_element_present("a#logout_sidebar_link"):
-                self.js_click("a#logout_sidebar_link")
+            self.js_click_if_present("a#reset_sidebar_link")
+            self.js_click_if_present("a#logout_sidebar_link")
         except Exception:
             pass
         super(SwagLabsTests, self).tearDown()

help_docs/method_summary.md

@@ -356,6 +356,10 @@ self.click_xpath(xpath)
 
 self.js_click(selector, by="css selector", all_matches=False, scroll=True)
 
+self.js_click_if_present(selector, by="css selector")
+
+self.js_click_if_visible(selector, by="css selector")
+
 self.js_click_all(selector, by="css selector")
 
 self.jquery_click(selector, by="css selector")
@@ -454,6 +458,8 @@ self.assert_attribute(
 
 self.assert_title(title)
 
+self.assert_title_contains(substring)
+
 self.assert_no_js_errors()
 
 self.inspect_html()

sbase/steps.py

@@ -604,3 +604,11 @@ def assert_text_not_visible(context, text):
     sb = context.sb
     text = normalize_text(text)
     sb.assert_text_not_visible(text)
+
+
+@step("Assert title contains '{substring}'")
+@step('Assert title contains "{substring}"')
+def assert_title_contains(context, substring):
+    sb = context.sb
+    substring = normalize_text(substring)
+    sb.assert_title_contains(substring)

seleniumbase/__init__.py

@@ -20,5 +20,6 @@
 del sys  # Undo "import sys" / Simplify "dir(seleniumbase)"
 del webdriver  # Undo "import webdriver" / Simplify "dir(seleniumbase)"
 
-version_info = [int(i) for i in __version__.split(".") if i.isdigit()]
-version_tuple = tuple(version_info)  # noqa
+version_list = [int(i) for i in __version__.split(".") if i.isdigit()]
+version_tuple = tuple(version_list)
+version_info = version_tuple  # noqa

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.4.2"
+__version__ = "4.4.3"

seleniumbase/behave/behave_helper.py

@@ -244,6 +244,12 @@ def generate_gherkin(srt_actions):
                 sb_actions.append('%s "%s"' % (method, action[1]))
             else:
                 sb_actions.append("%s '%s'" % (method, action[1]))
+        elif action[0] == "as_tc":
+            method = "Assert title contains"
+            if '"' not in action[1]:
+                sb_actions.append('%s "%s"' % (method, action[1]))
+            else:
+                sb_actions.append("%s '%s'" % (method, action[1]))
         elif action[0] == "as_df":
             method = "Assert downloaded file"
             if '"' not in action[1]: