Merge pull request #818 from seleniumbase/update-console-output-and-more

Update console output and more

Author: mdmintz

README.md

@@ -359,7 +359,8 @@ The code above will leave your browser window open in case there's a failure. (i
 --headed  # (Run tests with a GUI on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
---archive-logs  # (Archive old log files instead of deleting them.)
+--archive-logs  #  (Archive existing log files instead of deleting them.)
+--archive-downloads  #  (Archive old downloads instead of deleting them.)
 --time-limit=SECONDS  # (Safely fail any test that exceeds the time limit.)
 --slow  # (Slow down the automation. Faster than using Demo Mode.)
 --demo  # (Slow down and visually see test actions as they occur.)
@@ -503,7 +504,7 @@ pytest --dashboard --rs --headless
 python -m http.server 1948
 ```
 
-🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL-C`` to stop the http server.)
+🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL+C`` to stop the http server.)
 
 🔵 Here's a full example of what the SeleniumBase Dashboard may look like:
 

docs/requirements.txt

@@ -1,5 +1,5 @@
 regex>=2020.11.13
-tqdm>=4.56.2
+tqdm>=4.57.0
 livereload==2.6.3;python_version>="3.6"
 joblib==1.0.1;python_version>="3.6"
 Markdown==3.3.3

examples/boilerplates/classic_obj_test.py

@@ -0,0 +1,14 @@
+from seleniumbase import BaseCase
+
+
+class DataPage():
+
+    def go_to_data_url(self, sb):
+        sb.open("data:text/html,<p>Hello!</p>")
+
+
+class MyTests(BaseCase):
+
+    def test_go_to_data_url(self):
+        DataPage().go_to_data_url(self)
+        self.assert_text("Hello!", "p")

examples/boilerplates/samples/swag_labs_test.py

@@ -0,0 +1,18 @@
+from seleniumbase import BaseCase
+
+
+class LoginPage():
+
+    def login_to_swag_labs(self, sb, username):
+        sb.type("#user-name", username)
+        sb.type("#password", "secret_sauce")
+        sb.click('input[type="submit"]')
+
+
+class MyTests(BaseCase):
+
+    def test_swag_labs_login(self):
+        self.open("https://www.saucedemo.com/")
+        LoginPage().login_to_swag_labs(self, "standard_user")
+        self.assert_element("#inventory_container")
+        self.assert_text("Products", "div.product_label")

examples/boilerplates/samples/test_page_objects.py

@@ -0,0 +1,47 @@
+from seleniumbase import BaseCase
+
+
+class GooglePage():
+
+    def go_to_google(self, sb):
+        sb.open("https://google.com/ncr")
+
+    def do_search(self, sb, search_term):
+        sb.type('input[title="Search"]', search_term + '\n')
+
+    def click_search_result(self, sb, content):
+        sb.click('a[href*="%s"]' % content)
+
+
+class SeleniumBaseGitHubPage():
+
+    def click_seleniumbase_io_link(self, sb):
+        sb.js_click('a[href*="seleniumbase.io"]')
+        sb.wait_for_ready_state_complete()
+        current_url = sb.get_current_url()
+        if "seleniumbase.io" not in current_url:
+            # GitHub probably opened a new window
+            sb.switch_to_window(1)
+
+
+class SeleniumBaseIOPage():
+
+    def do_search_and_click(self, sb, search_term):
+        if sb.is_element_visible('[for="__search"] svg'):
+            sb.click('[for="__search"] svg')
+        sb.type('form[name="search"] input', search_term)
+        sb.click('li.md-search-result__item h1:contains(%s)' % search_term)
+
+
+class MyTests(BaseCase):
+
+    def test_page_objects(self):
+        search_term = "SeleniumBase GitHub"
+        expected_text = "seleniumbase/SeleniumBase"
+        GooglePage().go_to_google(self)
+        GooglePage().do_search(self, search_term)
+        self.assert_text(expected_text, '#search')
+        GooglePage().click_search_result(self, expected_text)
+        SeleniumBaseGitHubPage().click_seleniumbase_io_link(self)
+        SeleniumBaseIOPage().do_search_and_click(self, "Dashboard")
+        self.assert_text("Dashboard", 'main h1')

examples/example_logs/ReadMe.md

@@ -5,9 +5,7 @@
 🔵 During test failures, logs and screenshots from the most recent test run will get saved to the ``latest_logs/`` folder. If ``--archive-logs`` is specified (or if ARCHIVE_EXISTING_LOGS is set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py)), test logs will also get archived to the ``archived_logs/`` folder. Otherwise, the log files will be cleaned out when the next test run begins (by default).
 
 ```bash
-pytest test_fail.py --browser=chrome
-
-nosetests test_fail.py --browser=firefox
+pytest test_fail.py
 ```
 
 <b>Examples of expected log files generated during failures:</b>
@@ -37,7 +35,7 @@ pytest --dashboard --rs --headless
 python -m http.server 1948
 ```
 
-🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL-C`` to stop the http server.)
+🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL+C`` to stop the http server.)
 
 🔵 Here's a full example of what the SeleniumBase Dashboard may look like:
 
@@ -81,10 +79,10 @@ pytest test_suite.py --junit-xml=report.xml
 
 <h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Nosetest Reports:</h3>
 
-The ``--report`` option gives you a fancy report after your test suite completes.
+The ``nosetests`` ``--report`` option gives you a fancy report after your tests complete.
 
 ```bash
-nosetests test_suite.py --report --browser=chrome
+nosetests test_suite.py --report
 ```
 
 <img src="https://seleniumbase.io/cdn/img/nose_report.png" alt="Example Nosetest Report" title="Example Nosetest Report" width="320" />

help_docs/customizing_test_runs.md

@@ -117,7 +117,8 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 --headed  # (Run tests with a GUI on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
---archive-logs  # (Archive old log files instead of deleting them.)
+--archive-logs  #  (Archive existing log files instead of deleting them.)
+--archive-downloads  #  (Archive old downloads instead of deleting them.)
 --time-limit=SECONDS  # (Safely fail any test that exceeds the time limit.)
 --slow  # (Slow down the automation. Faster than using Demo Mode.)
 --demo  # (Slow down and visually see test actions as they occur.)
@@ -280,7 +281,7 @@ pytest --dashboard --rs --headless
 python -m http.server 1948
 ```
 
-🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL-C`` to stop the http server.)
+🔵 Now you can navigate to ``http://localhost:1948/dashboard.html`` in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use ``CTRL+C`` to stop the http server.)
 
 🔵 Here's a full example of what the SeleniumBase Dashboard may look like:
 

integrations/brython/ReadMe.md

@@ -10,7 +10,7 @@
 ```bash
 python -m http.server
 ```
-You can always stop the server by using ``CTRL-C``.
+You can always stop the server by using ``CTRL+C``.
 
 ### 2. Navigate to [http://localhost:8000/](http://localhost:8000/)
 

integrations/node_js/ReadMe.md

@@ -1,4 +1,4 @@
-<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Creating a Test Runner with NodeJS + Express</h2>
+<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Creating a Test Runner with NodeJS + Express</h2>
 
 You can create a customized web app for running SeleniumBase tests by using NodeJS and Express. (This tutorial assumes that you've already installed SeleniumBase by following the instructions from the [top-level ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) file.)
 
@@ -29,7 +29,7 @@ npm install
 node server.js
 ```
 
-(You can always stop the server by using ``CTRL-C``.)
+(You can always stop the server by using ``CTRL+C``.)
 
 #### 5. Open the SeleniumBase Test Runner web app
 

integrations/node_js/server.js

@@ -3,7 +3,7 @@ const express = require('express');
 const path = require('path');
 const app = express();
 const exec = require('child_process').exec;
-var server_info = '\nServer running at http://127.0.0.1:3000/  (CTRL-C to stop)';
+var server_info = '\nServer running at http://127.0.0.1:3000/  (CTRL+C to stop)';
 
 function run_command(command) {
     console.log("\n" + command);