Merge pull request #3057 from locustio/Use-enter-to-automatically-open-web-ui-in-default-browser

Use enter to automatically open web UI in default browser

Author: cyberw

Diff for: locust/main.py

@@ -14,6 +14,7 @@
 import sys
 import time
 import traceback
+import webbrowser
 
 import gevent
 
@@ -444,16 +445,12 @@ def kill_workers(children):
         else:
             web_host = options.web_host
         if web_host:
-            logger.info(f"Starting web interface at {protocol}://{web_host}:{options.web_port}{options.web_base_path}")
-        if options.web_host_display_name:
-            logger.info(f"Starting web interface at {options.web_host_display_name}")
+            url = f"{protocol}://{web_host}:{options.web_port}{options.web_base_path}"
+        elif options.web_host_display_name:
+            url = f"{options.web_host_display_name}"
         else:
-            if os.name == "nt":
-                logger.info(
-                    f"Starting web interface at {protocol}://localhost:{options.web_port}{options.web_base_path} (accepting connections from all network interfaces)"
-                )
-            else:
-                logger.info(f"Starting web interface at {protocol}://0.0.0.0:{options.web_port}{options.web_base_path}")
+            url = f"{protocol}://{'localhost' if os.name == 'nt' else '0.0.0.0'}:{options.web_port}{options.web_base_path}"
+        logger.info(f"Starting web interface at {url}, press enter to open your default browser.")
 
         web_ui = environment.create_web_ui(
             host=web_host,
@@ -597,6 +594,8 @@ def start_automatic_run():
                     "S": lambda: runner.start(max(0, runner.user_count - 10), 100)
                     if runner.state != "spawning"
                     else logging.warning("Spawning users, can't stop right now"),
+                    "\r": lambda: webbrowser.open_new_tab(url),
+                    "\n": lambda: webbrowser.open_new_tab(url),
                 },
             )
         )

Diff for: locust/test/test_main.py

@@ -934,6 +934,57 @@ def t(self):
             self.assertIn("Shutting down (exit code 0)", output)
             self.assertEqual(0, proc.returncode)
 
+    @unittest.skipIf(os.name == "nt", reason="termios doesnt exist on windows, and thus we cannot import pty")
+    def test_autospawn_browser(self):
+        import pty
+
+        LOCUSTFILE_CONTENT = textwrap.dedent(
+            """
+
+        from pytest import MonkeyPatch
+        import sys
+        import webbrowser
+
+        monkeypatch = MonkeyPatch()
+
+        def open_new_tab(url):
+            print("browser opened with url", url)
+            sys.exit(0)
+
+        monkeypatch.setattr(webbrowser, "open_new_tab", open_new_tab)
+        print("patched")
+        from locust import User, TaskSet, task, between
+        class UserSubclass(User):
+            @task
+            def t(self):
+                print("Test task is running")
+
+        """
+        )
+        with mock_locustfile(content=LOCUSTFILE_CONTENT) as mocked:
+            stdin_m, stdin_s = pty.openpty()
+            stdin = os.fdopen(stdin_m, "wb", 0)
+
+            proc = subprocess.Popen(
+                [
+                    "locust",
+                    "-f",
+                    mocked.file_path,
+                ],
+                stdin=stdin_s,
+                stdout=PIPE,
+                text=True,
+            )
+            gevent.sleep(1)
+            stdin.write(b"\n")
+            try:
+                output, _ = proc.communicate(timeout=1)
+            except Exception:
+                proc.kill()
+                output, _ = proc.communicate()
+
+            self.assertIn("browser opened", output)
+
     def test_spawning_with_fixed(self):
         LOCUSTFILE_CONTENT = textwrap.dedent(
             """