test_framework
/
SeleniumBase
mirror of https://github.com/seleniumbase/SeleniumBase.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add formatted README.rst

This commit is contained in:
Michael Mintz 2016-02-22 20:43:47 -05:00
parent a052ddd1ab
commit a10ed1a779
1 changed files with 785 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

785
README.rst Executable file
View File

@ -0,0 +1,785 @@
SeleniumBase
============
An open-source Python framework for jump-starting your browser
automation and testing goals.
|pypi| |Build Status|
Features include:
^^^^^^^^^^^^^^^^^
- `Python
methods <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py>`__
for quickly building `reliable WebDriver
scripts <https://github.com/mdmintz/SeleniumBase/blob/master/examples/my_first_test.py>`__.
- `Plugins <https://github.com/mdmintz/SeleniumBase/tree/master/seleniumbase/plugins>`__
for logging `data and
screenshots <https://github.com/mdmintz/SeleniumBase/tree/master/examples/logs_for_test_fail>`__
automatically.
- Easy integration with `Selenium
Grid <https://github.com/mdmintz/SeleniumBase/tree/master/integrations/selenium_grid>`__,
`MySQL <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py>`__,
`Docker <https://github.com/mdmintz/SeleniumBase/blob/master/integrations/docker/ReadMe.md>`__,
`Jenkins on Google
Cloud <https://github.com/mdmintz/SeleniumBase/tree/master/integrations/google_cloud>`__,
and `Amazon
S3 <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/plugins/s3_logging_plugin.py>`__.
- Customizable with `command-line
options <https://github.com/mdmintz/SeleniumBase/blob/master/conftest.py>`__
and a `global configuration
file <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/config/settings.py>`__.
*(Trusted by the world's most promising companies, including `HubSpot <http://www.hubspot.com/>`__, `Jana <http://jana.com/>`__, and `Veracode <http://www.veracode.com/>`__. Learn how HubSpot uses SeleniumBase by reading: `Automated Testing with Selenium <http://dev.hubspot.com/blog/bid/88880/Automated-Integration-Testing-with-Selenium-at-HubSpot>`__.)*
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Part I: MAC SETUP INSTRUCTIONS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(WINDOWS users: Ignore "brew install", which is MAC-only. Instead, download the files you need and put them on your `PATH <http://java.com/en/download/help/path.xml>`__.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
(DOCKER users: See the `Docker ReadMe <https://github.com/mdmintz/SeleniumBase/blob/master/integrations/docker/ReadMe.md>`__)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Step 0a:** Get basic requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you don't already have ``python``, ``pip``, ``git``, and either
``virtualenv`` or ``virtualenvwrapper`` installed and accessible from
your terminal (command prompt), you'll need to **`follow these
instructions <https://github.com/mdmintz/SeleniumBase/blob/master/help_docs/requirements_installation.md>`__**.
**Step 0b:** Get web browsers to run automation on
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you haven't already, you'll want to `Download
Firefox <https://www.mozilla.org/en-US/firefox/new/>`__. You can also
`Download
Chrome <https://www.google.com/chrome/browser/desktop/index.html>`__ or
`Download Chromium <https://download-chromium.appspot.com/>`__ to run
automation there.
**Step 0c:** Get drivers for the web browsers that require them
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you want to run automation on browsers other than Firefox (such as
Chrome), you'll need to download
`Chromedriver <https://sites.google.com/a/chromium.org/chromedriver/>`__
and `PhantomJS <http://phantomjs.org/>`__ separately. (Firefox drivers
are already included with Selenium by default, which makes life a bit
easier.)
On a Mac you can install those drivers more easily by using ``brew``
(aka ``homebrew``), but you have to install that first. `Brew
installation instructions are
here <https://github.com/mdmintz/SeleniumBase/blob/master/help_docs/requirements_installation.md>`__.
Mac:
.. code:: bash
brew install chromedriver phantomjs
Windows: \* `Download
Chromedriver <https://sites.google.com/a/chromium.org/chromedriver/downloads>`__
and put it in your PATH. \* OPTIONAL: `Download
PhantomJS <https://bitbucket.org/ariya/phantomjs/downloads>`__ (only if
you want to run headless browser automation) \* For everything you
download, put those files in your PATH. (``Environmental Variables`` on
a Windows machine)
If you want to verify that you successfully installed the web drivers,
**`follow these
instructions <https://github.com/mdmintz/SeleniumBase/blob/master/help_docs/verify_webdriver.md>`__**.
**Step 1:** Download or Clone SeleniumBase to your local machine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: bash
git clone https://github.com/mdmintz/SeleniumBase.git
cd SeleniumBase
(You can use a tool such as
`SourceTree <http://www.sourcetreeapp.com/>`__ to make things easier by
providing you with a simple-to-use user interface for viewing and
managing your git commits and status.)
**Step 2:** Create a virtualenv for seleniumbase and activate it
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you're not sure how to create a virtual environment, **`follow these
instructions <https://github.com/mdmintz/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md>`__**
to learn how.
**Step 3:** Install necessary packages from the SeleniumBase folder and compile the test framework (from within your virtual environment)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: bash
pip install -r requirements.txt
.. code:: bash
python setup.py install
If you wish to use the MySQL functionality with SeleniumBase to store
test results and data in the database, you'll need to `follow these
instructions <https://github.com/mdmintz/SeleniumBase/blob/master/help_docs/mysql_installation.md>`__.
If you make any changes to your local version of SeleniumBase, you may
need to run ``python setup.py install`` each time for those changes to
take effect.
`SeleniumBase is in Pypi <https://pypi.python.org/pypi/seleniumbase>`__,
which means you can also install it like this:
.. code:: bash
pip install seleniumbase
**Step 4:** Verify that SeleniumBase was successfully installed by running the example test
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can verify the installation of SeleniumBase by running a simple
script to perform basic actions such as navigating to a web page,
clicking, waiting for page elements to appear, typing in text, scraping
text on a page, and verifying text. This may be a good time to read up
on CSS selectors. If you use Chrome, you can right-click on a page and
select "Inspect Element" to see the details you need to create such a
script. With CSS selectors, dots represent class names and pound signs
represent IDs.
.. code:: python
from seleniumbase import BaseCase
class MyTestClass(BaseCase):
def test_basic(self):
self.open("http://xkcd.com/353/")
self.wait_for_element("div#comic")
self.click('a[rel="license"]')
text = self.wait_for_element('center').text
self.assertTrue("reuse any of my drawings" in text)
self.open("http://xkcd.com/1481/")
self.click_link_text('Blag')
self.wait_for_text("The blag", "header h2")
self.update_text("input#s", "Robots!\n")
self.wait_for_text("Hooray robots!", "#content")
self.open("http://xkcd.com/1319/")
self.wait_for_text("Automation", "div#ctitle")
Now try running the script (from the "examples" folder) using various
web browsers:
.. code:: bash
cd examples/
nosetests my_first_test.py --browser=firefox --with-selenium -s
nosetests my_first_test.py --browser=chrome --with-selenium -s
nosetests my_first_test.py --browser=phantomjs --with-selenium -s
After the test completes, in the console output you'll see a dot (``.``)
on a new line, representing a passing test. (On test failures you'll see
an ``F`` instead, and on test errors you'll see an ``E``). It looks more
like a moving progress bar when you're running a ton of unit tests side
by side. This is part of nosetests. After all tests complete (in this
case there is only one), you'll see the "``Ran 1 test in ...``\ " line,
followed by an "``OK``\ " if all nosetests passed.
If the example is moving too fast for your eyes to see what's going on,
there are a few things you can do. You can add ``--demo_mode`` on the
command line, which pauses the browser for about a second (by default)
after each action:
.. code:: bash
nosetests my_first_test.py --with-selenium -s --demo_mode
You can override the default wait time by either updating
`settings.py <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/config/settings.py>`__
or by using ``--demo_sleep={NUM}`` when using Demo Mode. (NOTE: If you
use ``--demo_sleep={NUM}`` without using ``--demo_mode``, nothing will
happen.)
If you ever make any changes to your local copy of ``settings.py``, you
may need to run ``python setup.py install`` for those changes to take
effect.
.. code:: bash
nosetests my_first_test.py --with-selenium -s --demo_mode --demo_sleep=1.2
You can also add either of the following to your scripts to slow down
the tests:
.. code:: python
import time; time.sleep(5) # sleep for 5 seconds (add this after the line you want to pause on)
import ipdb; ipdb.set_trace() # waits for your command. n = next line of current method, c = continue, s = step / next executed line (will jump)
(NOTE: If you're using pytest instead of nosetests and you want to use
ipdb in your script for debugging purposes, you'll either need to add
"--capture=no" on the command line, or use "import pytest;
pytest.set\_trace()" instead of using ipdb. More info on that
`here <http://stackoverflow.com/questions/2678792/can-i-debug-with-python-debugger-when-using-py-test-somehow>`__.)
You may also want to have your test sleep in other situations where you
need to have your test wait for something. If you know what you're
waiting for, you should be specific by using a command that waits for
something specific to happen.
If you need to debug things on the fly (in case of errors), use this
line to run the code:
.. code:: bash
nosetests my_first_test.py --browser=chrome --with-selenium --pdb --pdb-failures -s
The above code (with --pdb) will leave your browser window open in case
there's a failure, which is possible if the web pages from the example
change the data that's displayed on the page. (ipdb commands: 'c', 's',
'n' => continue, step, next).
Here are some other useful nosetest arguments that you may want to
append to your run commands:
.. code:: bash
--logging-level=INFO # Hide DEBUG messages, which can be overwhelming.
-x # Stop running the tests after the first failure is reached.
-v # Prints the full test name rather than a dot for each test.
--with-id # If -v is also used, will number the tests for easy counting.
Due to high demand, pytest support has been added. You can run the above
sample script in pytest like this:
.. code:: bash
py.test my_first_test.py --with-selenium --with-testing_base --browser=chrome -s
py.test my_first_test.py --with-selenium --with-testing_base --browser=phantomjs -s
py.test my_first_test.py --with-selenium --with-testing_base --browser=firefox -s
(NOTE: The ``--with-testing_base`` plugin gives you full logging on test
failures for screenshots, page source, and basic test info.)
**Step 5:** Complete the setup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you're planning on using the full power of this test framework, there
are a few more things you'll want to do:
- Setup your `Jenkins <http://jenkins-ci.org/>`__ build server for
running your tests at regular intervals. (Or you can use any build
server you want.)
- Setup an `Amazon S3 <http://aws.amazon.com/s3/>`__ account for saving
your log files and screenshots for future viewing. This test
framework already has the code you need to connect to it. (Modify the
s3\_manager.py file from the seleniumbase/core folder with connection
details to your instance.)
- Install `MySQL
Workbench <http://dev.mysql.com/downloads/tools/workbench/>`__ to
make life easier by giving you a nice GUI tool that you can use to
read & write from your DB directly.
- Setup your Selenium Grid and update your \*.cfg file to point there.
An example config file called selenium\_server\_config\_example.cfg
has been provided for you in the integrations/selenium\_grid folder.
The start-selenium-node.bat and start-selenium-server.sh files are
for running your grid. In an example situation, your Selenium Grid
server might live on a unix box and your Selenium Grid nodes might
live on EC2 Windows virtual machines. When your build server runs a
Selenium test, it would connect to your Selenium Grid to find out
which Grid browser nodes are available to run that test. To simplify
things, you can use `Browser
Stack <https://www.browserstack.com/automate>`__ as your entire
Selenium Grid (and let them do all the fun work of maintaining the
grid for you).
- There are ways of running your tests from Jenkins without having to
utilize a remote machine. One way is by using PhantomJS as your
browser (it runs headlessly). Another way is by using Xvfb (another
headless system). `There's a plugin for Xvfb in
Jenkins <https://wiki.jenkins-ci.org/display/JENKINS/Xvfb+Plugin>`__.
If you have Xvfb running in the background, you can add
``--headless`` to your run command in order to utilize it. Here are
some more helpful resources I found regarding the use of Xvfb:
1. http://stackoverflow.com/questions/6183276/how-do-i-run-selenium-in-xvfb
2. http://qxf2.com/blog/xvfb-plugin-for-jenkins-selenium/
3. http://stackoverflow.com/questions/27202131/firefox-started-by-selenium-ignores-the-display-created-by-pyvirtualdisplay
- If you use `Slack <https://slack.com>`__, you can easily have your
Jenkins jobs display results there by using the `Jenkins Slack
Plugin <https://github.com/jenkinsci/slack-plugin>`__. Another way to
send messages from your tests to Slack is by using `Slack's Incoming
Webhooks API <https://api.slack.com/incoming-webhooks>`__.
- If you use `HipChat <https://www.hipchat.com/>`__, you can easily
have your Jenkins jobs display results there by using the `Jenkins
HipChat
Plugin <https://wiki.jenkins-ci.org/display/JENKINS/HipChat+Plugin>`__.
Another way is by using the `hipchat\_reporting
plugin <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/plugins/hipchat_reporting_plugin.py>`__
(nosetests only).
- Be sure to tell SeleniumBase to use these added features when you set
them up. That's easy to do. You would be running tests like this:
.. code:: bash
nosetests [YOUR_TEST_FILE].py --browser=chrome --with-selenium --with-testing_base --with-db_reporting --with-s3_logging -s
(NOTE: Don't use ``--with-db_reporting`` or ``--with-s3_logging`` if you
haven't configured your MySQL or S3 connections in
`settings.py <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/config/settings.py>`__)
When the testing\_base plugin is used, if there's a test failure, the
basic\_test\_info plugin records test logs, the page\_source plugin
records the page source of the last web page seen by the test, and the
screen\_shots plugin records the image of the last page seen by the test
where the failure occurred. Make sure you always include testing\_base
whenever you include a plugin that logs test data. The db\_reporting
plugin records the status of all tests run into your MySQL DB. The
s3\_logging plugin uploads basic test info, screenshots, and page source
into your S3 storage folder.
To simplify that long run command, you can create a \*.cfg file, such as
the one provided in the example, and enter your plugins there so that
you can run everything by typing:
.. code:: bash
nosetests [YOUR_TEST_FILE].py --config=[MY_CONFIG_FILE].cfg -s
You can simplify that even more by using a setup.cfg file, such as the
one provided for you in the examples folder. If you kick off a test run
from within the folder that setup.cfg is location in, that file will
automatically be used as your configuration, meaning that you wouldn't
have to type out all the plugins that you want to use (or include a
config file) everytime you run tests.
If you tell nosetests to run an entire file, it will run every method in
that python file that starts with "test". You can be more specific on
what to run by doing something like:
.. code:: bash
nosetests [YOUR_TEST_FILE].py:[SOME_CLASS_NAME].test_[SOME_TEST_NAME] --config=[MY_CONFIG_FILE].cfg -s
Let's try an example of a test that fails. Copy the following into a
file called fail\_test.py:
.. code:: python
""" test_fail.py """
from seleniumbase import BaseCase
class MyTestClass(BaseCase):
def test_find_army_of_robots_on_xkcd_desert_island(self):
self.open("http://xkcd.com/731/")
self.wait_for_element("div#ARMY_OF_ROBOTS", timeout=3) # This should fail
Now run it:
.. code:: bash
nosetests test_fail.py --browser=chrome --with-selenium --with-testing_base -s
You'll notice that a logs folder was created to hold information about
the failing test, and screenshots. Take a look at what you get.
Remember, this data can be saved in your MySQL DB and in S3 if you
include the necessary plugins in your run command (and if you set up the
neccessary connections properly). For future test runs, past test
results will get stored in the archived\_logs folder.
Have you made it this far? Congratulations!!! Now you're ready to dive
in at full speed!
Part II: Detailed Method Specifications, Examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Navigating to a Page, Plus Some Other Useful Related Commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
self.open("https://xkcd.com/378/") # Instant navigation to any web page.
self.driver.refresh() # refresh/reload the current page.
where_am_i = self.driver.current_url # this variable changes as the current page changes.
source = self.driver.page_source # this variable changes as the page source changes.
**ProTip™:** You may need to use the page\_source method along with
Python's find() command to parse through the source to find something
that Selenium wouldn't be able to. (You may want to brush up on your
Python programming skills if you're confused.) Ex:
.. code:: python
source = self.driver.page_source
first_image_open_tag = source.find('<img>')
first_image_close_tag = source.find'</img>', first_image_open_tag)
everything_inside_first_image_tags = source[first_image_open_tag+len('<img>'):first_image_close_tag]
Clicking
^^^^^^^^
To click an element on the page:
.. code:: python
self.click("div#my_id")
Asserting existance of an element on a page within some number of seconds:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
self.wait_for_element_present("div.my_class", timeout=10)
Asserting visibility of an element on a page within some number of seconds:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
self.wait_for_element_visible("a.my_class", timeout=5)
(NOTE: The short version of this is ``self.wait_for_element(ELEMENT)``)
Since the line above returns the element, you can combine that with
.click() as shown below:
.. code:: python
self.wait_for_element("a.my_class", timeout=5).click()
# But you're better off using the following statement, which does the same thing:
self.click("a.my_class") # DO IT THIS WAY!
Asserting visibility of text inside an element on a page within some number of seconds:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
self.wait_for_text_visible("Make it so!", "div#trek div.picard div.quotes", timeout=3)
self.wait_for_text_visible("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeout=1)
(NOTE: The short version of this is
``self.wait_for_text(TEXT, ELEMENT)``)
Asserting Anything
^^^^^^^^^^^^^^^^^^
.. code:: python
self.assertTrue(myvar1 == something)
self.assertEqual(var1, var2)
Useful Conditional Statements (with creative examples in action)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
is\_element\_visible(selector) # is an element visible on a page
.. code:: python
import logging
if self.is_element_visible('div#warning'):
logging.debug("Red Alert: Something bad might be happening!")
is\_element\_present(selector) # is an element present on a page
.. code:: python
if self.is_element_present('div#top_secret img.tracking_cookie'):
self.contact_cookie_monster() # Not a real method unless you define it somewhere
else:
current_url = self.driver.current_url
self.contact_the_nsa(url=current_url, message="Dark Zone Found") # Not a real method unless you define it somewhere
Another example:
.. code:: python
def is_there_a_cloaked_klingon_ship_on_this_page():
if self.is_element_present("div.ships div.klingon"):
return not self.is_element_visible("div.ships div.klingon")
return False
is\_text\_visible(text, selector) # is text visible on a page
.. code:: python
def get_mirror_universe_captain_picard_superbowl_ad(superbowl_year):
selector = "div.superbowl_%s div.commercials div.transcript div.picard" % superbowl_year
if self.is_text_visible("For the Love of Marketing and Earl Grey Tea!", selector):
return "Picard HubSpot Superbowl Ad 2015"
elif self.is_text_visible("Delivery Drones... Engage", selector):
return "Picard Amazon Superbowl Ad 2015"
elif self.is_text_visible("Bing it on Screen!", selector):
return "Picard Microsoft Superbowl Ad 2015"
elif self.is_text_visible("OK Glass, Make it So!", selector):
return "Picard Google Superbowl Ad 2015"
elif self.is_text_visible("Number One, I've Never Seen Anything Like It.", selector):
return "Picard Tesla Superbowl Ad 2015"
elif self.is_text_visible("""With the first link, the chain is forged.
The first speech censored, the first thought forbidden,
the first freedom denied, chains us all irrevocably.""", selector):
return "Picard Wikimedia Superbowl Ad 2015"
elif self.is_text_visible("Let us make sure history never forgets the name ... Facebook", selector):
return "Picard Facebook Superbowl Ad 2015"
else:
raise Exception("Reports of my assimilation are greatly exaggerated.")
Typing Text
^^^^^^^^^^^
update\_text(selector, text) # updates the text from the specified
element with the specified value. Exception raised if element missing or
field not editable. Example:
.. code:: python
self.update_text("input#id_value", "2012")
You can also use the WebDriver .send\_keys() command, but it won't clear
the text box first if there's already text inside. If you want to type
in special keys, that's easy too. Here's an example:
.. code:: python
from selenium.webdriver.common.keys import Keys
self.wait_for_element("textarea").send_keys(Keys.SPACE + Keys.BACK_SPACE + '\n') # the backspace should cancel out the space, leaving you with the newline
Switching Tabs
^^^^^^^^^^^^^^
What if your test opens up a new tab/window and now you have more than
one page? No problem. You need to specify which one you currently want
Selenium to use. Switching between tabs/windows is easy: Ex:
.. code:: python
self.driver.switch_to_window(self.driver.window_handles[1]) # this switches to the new tab
driver.window\_handles is a list that will continually get updated when
new windows/tabs appear (index numbering is auto-incrementing from 0,
which represents the main window)
**ProTip™:** iFrames follow the same principle as new windows - you need
to specify the iFrame if you want to take action on something in there
Ex:
.. code:: python
self.driver.switch_to_frame('ContentManagerTextBody_ifr')
# Now you can act inside the iFrame
# Do something cool (here)
self.driver.switch_to_default_content() # exit the iFrame when you're done
Handle Pop-Up Alerts
^^^^^^^^^^^^^^^^^^^^
What if your test makes an alert pop up in your browser? No problem. You
need to switch to it and either accept it or dismiss it: Ex:
.. code:: python
self.wait_for_and_accept_alert()
self.wait_for_and_dismiss_alert()
If you're not sure whether there's an alert before trying to accept or
dismiss it, one way to handle that is to wrap your alert-handling code
in a try/except block. Other methods such as .text and .send\_keys()
will also work with alerts.
Executing Custom jQuery Scripts:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
jQuery is a powerful JavaScript library that allows you to perform
advanced actions in a web browser. If the web page you're on already has
jQuery loaded, you can start executing jQuery scripts immediately. You'd
know this because the web page would contain something like the
following in the HTML:
.. code:: html
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
It's OK if you want to use jQuery on a page that doesn't have it loaded
yet. To do so, run the following command first:
.. code:: python
self.activate_jquery()
Here are some examples of using jQuery in your scripts:
.. code:: python
self.execute_script('jQuery, window.scrollTo(0, 600)') # Scrolling the page
self.execute_script("jQuery('#annoying-widget').hide()") # Hiding elements on a page
self.execute_script("jQuery('#annoying-button a').remove()") # Removing elements on a page
self.execute_script("jQuery('%s').mouseover()" % (mouse_over_item)) # Mouse-over elements on a page
self.execute_script("jQuery('input#the_id').val('my_text')") # Fast text input on a page
self.execute_script("jQuery('div#dropdown a.link').click()") # Click elements on a page
self.execute_script("return jQuery('div#amazing')[0].text") # Returns the css "text" of the element given
self.execute_script("return jQuery('textarea')[2].value") # Returns the css "value" of the 3rd textarea element on the page
In the following example, javascript is used to plant code on a page
that Selenium can then touch after that:
.. code:: python
self.open(SOME_PAGE_TO_PLAY_WITH)
referral_link = '<a class="analytics test" href="%s">Free-Referral Button!</a>' % DESTINATION_URL
self.execute_script("document.body.innerHTML = \"%s\"" % referral_link)
self.click("a.analytics") # Clicks the generated button
Part III: More Details
~~~~~~~~~~~~~~~~~~~~~~
Nosetests automatically runs any python method that starts with "test"
from the file you selected. You can also select specific tests to run
from files or classes. For example, the code in the early examples
could've been run using "nosetests
my\_first\_test.py:MyTestClass.test\_basic ... ...". If you wanted to
run all tests in MyTestClass, you can use: "nosetests
my\_first\_test.py:MyTestClass ... ...", which is useful when you have
multiple tests in the same file. Don't forget the plugins. Use "-s" if
you want better logging in the console output.
To use the SeleniumBase Test Framework calls, don't forget to include
the following import:
.. code:: python
from seleniumbase import BaseCase
And you'll need to inherit BaseCase in your classes like so:
.. code:: python
class MyTestClass(BaseCase):
Checking Email:
^^^^^^^^^^^^^^^
Let's say you have a test that sends an email, and now you want to check
that the email was received:
.. code:: python
from seleniumbase.fixtures.email_manager import EmailManager, EmailException
num_email_results = 0
email_subject = "This is the subject to search for (maybe include a timestamp)"
email_manager = EmailManager("[YOUR SELENIUM GMAIL EMAIL ADDRESS]") # the password for this is elsewhere (in the library) because this is a default email account
try:
html_text = email_manager.search(SUBJECT="%s" % email_subject, timeout=300)
num_email_results = len(html_text)
except EmailException:
num_email_results = 0
self.assertTrue(num_email_results) # true if not zero
Now you can parse through the email if you're looking for specific text
or want to navigate to a link listed there.
Database Powers:
^^^^^^^^^^^^^^^^
Let's say you have a test that needs to access the database. First make
sure you already have a table ready. Then try this example:
.. code:: python
from seleniumbase.core.mysql import DatabaseManager
def write_data_to_db(self, theId, theValue, theUrl):
db = DatabaseManager()
query = """INSERT INTO myTable(theId,theValue,theUrl)
VALUES (%(theId)s,%(theValue)s,%(theUrl)s)"""
db.execute_query_and_close(query, {"theId":theId,
"theValue":theValue,
"theUrl":theUrl})
Access credentials are stored in
`settings.py <https://github.com/mdmintz/SeleniumBase/blob/master/seleniumbase/config/settings.py>`__
for your convenience (you have to add them first).
The following example below (taken from the Delayed Data Manager) shows
how data can be pulled from the database.
.. code:: python
import logging
from seleniumbase.core.mysql import DatabaseManager
def get_delayed_test_data(self, testcase_address, done=0):
""" Returns a list of rows """
db = DatabaseManager()
query = """SELECT guid,testcaseAddress,insertedAt,expectedResult,done
FROM delayedTestData
WHERE testcaseAddress=%(testcase_address)s
AND done=%(done)s"""
data = db.fetchall_query_and_close(query, {"testcase_address":testcase_address, "done":done})
if data:
return data
else:
logging.debug("Could not find any rows in delayedTestData.")
logging.debug("DB Query = " + query % {"testcase_address":testcase_address, "done":done})
return []
Now you know how to pull data from your MySQL DB.
You may also be wondering when you would use the Delayed Data Manager.
Here's one example: If you scheduled an email to go out 12 hours from
now and you wanted to check that the email gets received (but you don't
want the Selenium test of a Jenkins job to sit idle for 12 hours) you
can store the email credentials as a unique time-stamp for the email
subject in the DB (along with a time for when it's safe for the email to
be searched for) and then a later-running test can do the checking after
the right amount of time has passed.
Congratulations! If you've made it this far, it means you have a pretty
good idea about how to move forward! Feel free to check out other
exciting open source projects on GitHub: https://github.com/hubspot
Happy Automating!
~ Michael Mintz (https://github.com/mdmintz)
Legal Disclaimer
~~~~~~~~~~~~~~~~
Automation is a powerful thing. It allows you to take full control of
web browsers and do almost anything that a human could do, but faster.
It can be used for both good and evil. With great power comes great
responsibility. You are fully responsible for how you use this framework
and the automation that you create. You may also want to see a
professional when it comes to setting up your automation environment if
you require assistance.
.. |pypi| image:: https://img.shields.io/pypi/v/seleniumbase.svg
:target: https://pypi.python.org/pypi/seleniumbase
.. |Build Status| image:: https://travis-ci.org/mdmintz/SeleniumBase.svg?branch=master
:target: https://travis-ci.org/mdmintz/SeleniumBase