Merge pull request #593 from seleniumbase/add-get-user-agent

mdmintz · web-flow · commit ec8ade9fbffd · 2020-06-04T03:33:10.000-04:00
Add get_user_agent() and improve mobile compatibility
diff --git a/examples/offline_examples/demo_page.html b/examples/offline_examples/demo_page.html
@@ -1,6 +1,7 @@
 <html>
     <head>
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=0.5">
         <title>Web Testing Page</title>
         <style>
             html {
diff --git a/examples/offline_examples/user_agent_test.py b/examples/offline_examples/user_agent_test.py
@@ -0,0 +1,11 @@
+import pytest
+from seleniumbase import BaseCase
+
+
+@pytest.mark.offline  # Can be run with: "pytest -m offline"
+class OfflineTestClass(BaseCase):
+
+    def test_get_user_agent(self):
+        self.open("data:,")
+        user_agent = self.get_user_agent()
+        print('\nUser Agent = "%s"' % user_agent)
diff --git a/examples/test_get_user_agent.py b/examples/test_get_user_agent.py
@@ -0,0 +1,12 @@
+from seleniumbase import BaseCase
+
+
+class UserAgentTestClass(BaseCase):
+
+    def test_get_user_agent(self):
+        self.open("data:,")
+        user_agent = self.get_user_agent()
+        print('\nUser Agent = "%s"' % user_agent)
+        self.set_messenger_theme(
+            theme="flat", location="top_center")
+        self.post_message(user_agent, duration=4)
diff --git a/examples/tour_examples/driverjs_maps_tour.py b/examples/tour_examples/driverjs_maps_tour.py
@@ -3,7 +3,7 @@
 
 class MyTestClass(BaseCase):
 
-    def test_basic(self):
+    def test_create_tour(self):
         self.open("https://www.google.com/maps/@42.3598616,-71.0912631,15z")
         self.wait_for_element("#searchboxinput")
         self.wait_for_element("#minimap")
diff --git a/examples/tour_examples/xkcd_tour.py b/examples/tour_examples/xkcd_tour.py
@@ -3,7 +3,7 @@
 
 class MyTestClass(BaseCase):
 
-    def test_basic(self):
+    def test_create_tour(self):
         self.open('https://xkcd.com/1117/')
         self.assert_element('img[alt="My Sky"]')
         self.create_tour(theme="dark")
diff --git a/help_docs/method_summary.md b/help_docs/method_summary.md
@@ -43,6 +43,8 @@ self.get_page_source()
 self.get_title()
 # Duplicates: self.get_page_title()
 
+self.get_user_agent()
+
 self.go_back()
 
 self.go_forward()
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -423,6 +423,10 @@ def get_title(self):
         """ The shorter version of self.get_page_title() """
         return self.get_page_title()
 
+    def get_user_agent(self):
+        user_agent = self.driver.execute_script("return navigator.userAgent;")
+        return user_agent
+
     def go_back(self):
         self.__last_page_load_url = None
         self.driver.back()
@@ -1186,10 +1190,14 @@ def hover_and_click(self, hover_selector, click_selector,
         outdated_driver = False
         element = None
         try:
-            if self.browser == "safari":
+            if self.mobile_emulator:
+                # On mobile, click to hover the element
+                dropdown_element.click()
+            elif self.browser == "safari":
                 # Use the workaround for hover-clicking on Safari
                 raise Exception("This Exception will be caught.")
-            page_actions.hover_element(self.driver, dropdown_element)
+            else:
+                page_actions.hover_element(self.driver, dropdown_element)
         except Exception:
             outdated_driver = True
             element = self.wait_for_element_present(
@@ -1200,8 +1208,12 @@ def hover_and_click(self, hover_selector, click_selector,
                 self.open(self.__get_href_from_partial_link_text(
                     click_selector))
             else:
-                self.js_click(click_selector, click_by)
-        if not outdated_driver:
+                self.js_click(click_selector, by=click_by)
+        if outdated_driver:
+            pass  # Already did the click workaround
+        elif self.mobile_emulator:
+            self.click(click_selector, by=click_by)
+        elif not outdated_driver:
             element = page_actions.hover_and_click(
                 self.driver, hover_selector, click_selector,
                 hover_by, click_by, timeout)
@@ -3612,6 +3624,8 @@ def set_messenger_theme(self, theme="default", location="default",
             location = "default"  # "bottom_right"
         if not max_messages:
             max_messages = "default"  # "8"
+        else:
+            max_messages = str(max_messages)  # Value must be in string format
         js_utils.set_messenger_theme(
             self.driver, theme=theme,
             location=location, max_messages=max_messages)
@@ -5131,6 +5145,11 @@ def setUp(self, masterqa_mode=False):
             if self._reuse_session:
                 sb_config.shared_driver = self.driver
 
+        if self.browser in ["firefox", "ie", "safari"]:
+            # Only Chromium-based browsers have the mobile emulator.
+            # Some actions such as hover-clicking are different on mobile.
+            self.mobile_emulator = False
+
         # Configure the test time limit (if used).
         self.set_time_limit(self.time_limit)
 
diff --git a/seleniumbase/translate/chinese.py b/seleniumbase/translate/chinese.py
@@ -370,6 +370,10 @@ def 写文字(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def 设置消息主题(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def 显示讯息(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def 打开HTML文件(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def 获取用户代理(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_中文(MasterQA, 硒测试用例):
 
diff --git a/seleniumbase/translate/dutch.py b/seleniumbase/translate/dutch.py
@@ -370,6 +370,10 @@ def schrijven(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def kenmerk_thema_van_bericht(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def bericht_weergeven(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def html_bestand_openen(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def gebruikersagent_ophalen(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Nederlands(MasterQA, Testgeval):
 
diff --git a/seleniumbase/translate/french.py b/seleniumbase/translate/french.py
@@ -370,6 +370,10 @@ def écriver(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def définir_thème_du_message(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def afficher_message(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def ouvrir_html_fichier(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def obtenir_agent_utilisateur(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Français(MasterQA, CasDeBase):
 
diff --git a/seleniumbase/translate/italian.py b/seleniumbase/translate/italian.py
@@ -370,6 +370,10 @@ def scrivere(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def impostare_tema_del_messaggio(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def visualizza_messaggio(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def apri_html_file(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def ottenere_agente_utente(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Italiano(MasterQA, CasoDiProva):
 
diff --git a/seleniumbase/translate/japanese.py b/seleniumbase/translate/japanese.py
@@ -370,6 +370,10 @@ def 書く(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def メッセージのスタイルを設定する(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def メッセージを表示する(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def HTMLファイルを開く(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def ユーザーエージェントの取得(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_日本語(MasterQA, セレニウムテストケース):
 
diff --git a/seleniumbase/translate/korean.py b/seleniumbase/translate/korean.py
@@ -370,6 +370,10 @@ def 쓰다(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def 메시지_테마_설정(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def 메시지를_표시(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def HTML_파일_열기(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def 사용자_에이전트_가져_오기(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_한국어(MasterQA, 셀레늄_테스트_케이스):
 
diff --git a/seleniumbase/translate/master_dict.py b/seleniumbase/translate/master_dict.py
@@ -1330,6 +1330,18 @@ class MD:
     md["write"][8] = "написать"
     md["write"][9] = "escribir"
 
+    md["set_messenger_theme"] = ["*"] * num_langs
+    md["set_messenger_theme"][0] = "set_messenger_theme"
+    md["set_messenger_theme"][1] = "设置消息主题"
+    md["set_messenger_theme"][2] = "kenmerk_thema_van_bericht"
+    md["set_messenger_theme"][3] = "définir_thème_du_message"
+    md["set_messenger_theme"][4] = "impostare_tema_del_messaggio"
+    md["set_messenger_theme"][5] = "メッセージのスタイルを設定する"
+    md["set_messenger_theme"][6] = "메시지_테마_설정"
+    md["set_messenger_theme"][7] = "definir_tema_da_mensagem"
+    md["set_messenger_theme"][8] = "набор_тему_сообщения"
+    md["set_messenger_theme"][9] = "establecer_tema_del_mensaje"
+
     md["post_message"] = ["*"] * num_langs
     md["post_message"][0] = "post_message"
     md["post_message"][1] = "显示讯息"
@@ -1450,6 +1462,18 @@ class MD:
     md["open_html_file"][8] = "открыть_HTML_файл"
     md["open_html_file"][9] = "abrir_archivo_html"
 
+    md["get_user_agent"] = ["*"] * num_langs
+    md["get_user_agent"][0] = "get_user_agent"
+    md["get_user_agent"][1] = "获取用户代理"
+    md["get_user_agent"][2] = "gebruikersagent_ophalen"
+    md["get_user_agent"][3] = "obtenir_agent_utilisateur"
+    md["get_user_agent"][4] = "ottenere_agente_utente"
+    md["get_user_agent"][5] = "ユーザーエージェントの取得"
+    md["get_user_agent"][6] = "사용자_에이전트_가져_오기"
+    md["get_user_agent"][7] = "obter_agente_do_usuário"
+    md["get_user_agent"][8] = "получить_агента_пользователя"
+    md["get_user_agent"][9] = "obtener_agente_de_usuario"
+
     ################
     # Duplicates
 
diff --git a/seleniumbase/translate/portuguese.py b/seleniumbase/translate/portuguese.py
@@ -370,6 +370,10 @@ def escreva(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def definir_tema_da_mensagem(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def exibir_mensagem(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def abrir_arquivo_html(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def obter_agente_do_usuário(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Português(MasterQA, CasoDeTeste):
 
diff --git a/seleniumbase/translate/russian.py b/seleniumbase/translate/russian.py
@@ -370,6 +370,10 @@ def написать(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def набор_тему_сообщения(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def показать_сообщение(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def открыть_HTML_файл(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def получить_агента_пользователя(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Русский(MasterQA, ТестНаСелен):
 
diff --git a/seleniumbase/translate/spanish.py b/seleniumbase/translate/spanish.py
@@ -370,6 +370,10 @@ def escribir(self, *args, **kwargs):
         # write(selector, new_value)  # Same as update_text()
         return self.write(*args, **kwargs)
 
+    def establecer_tema_del_mensaje(self, *args, **kwargs):
+        # set_messenger_theme(theme="default", location="default")
+        return self.set_messenger_theme(*args, **kwargs)
+
     def mostrar_mensaje(self, *args, **kwargs):
         # post_message(message, duration=None, pause=True, style="info")
         return self.post_message(*args, **kwargs)
@@ -410,6 +414,10 @@ def abrir_archivo_html(self, *args, **kwargs):
         # open_html_file(html_file)
         return self.open_html_file(*args, **kwargs)
 
+    def obtener_agente_de_usuario(self, *args, **kwargs):
+        # get_user_agent()
+        return self.get_user_agent(*args, **kwargs)
+
 
 class MasterQA_Español(MasterQA, CasoDePrueba):
 
diff --git a/setup.py b/setup.py
@@ -44,7 +44,7 @@
         print("\n*** Installing twine: *** (Required for PyPI uploads)\n")
         os.system("python -m pip install 'twine>=1.15.0'")
         print("\n*** Installing tqdm: *** (Required for PyPI uploads)\n")
-        os.system("python -m pip install 'tqdm>=4.46.0'")
+        os.system("python -m pip install 'tqdm>=4.46.1'")
         print("\n*** Publishing The Release to PyPI: ***\n")
         os.system('python -m twine upload dist/*')  # Requires ~/.pypirc Keys
         print("\n*** The Release was PUBLISHED SUCCESSFULLY to PyPI! :) ***\n")
@@ -54,7 +54,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.39.3',
+    version='1.39.4',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',
