Selenium Pagemodel implementation for Python.
Project description
Selenium-PageModel
This project helps Test Engineers by abstracting out the implementation – in this case Selenium – from the actual set of Actions necessary to perform a single Test Scenario. The Selenium-PageModel library does this by defining a set of well defined PageModel constructs that Test Engineers can extend/implement to describe a Website. These PageModel constructs includes the following:
WebPage
Button
Checkbox
Dropdown
Link
Table
TextElement
TextField
Widget
Using these constructs, you can describe a WebPage as having the following web-elements:
- A Header Widget containing:
A Home Link
A Login Link
A Register Link
- A form Widget containing:
A username TextField
A password TextField
A Submit Button
A potential Error message TextElement (in the event of a login failure)
Once a PageModel is defined, a login test for an imaginary website may look like this:
homePage.open(); loginPage.waitForPageLoad().validate(); loginPage.loginForm.userName.type("myuser"); loginPage.loginForm.password.type("mypassword"); loginPage.loginForm.submitButton.click(); homePage.waitForPageLoad().isLoggedIn();
Please see the project’s Homepage for more information: Selenium-PageModel
Installation
The library can be installed via:
pip install seleniumpm
Or if you want to install from src:
pip install git+https://github.com/gradeawarrior/python-seleniumpm.git
Usage
Here is the ever so popular Google example using seleniumpm:
from selenium import webdriver from seleniumpm.examples.google_page import GooglePage """ Setup for Remote execution against a local standalone-selenium-server and using the PhantomJS driver. This can be changed of course to using the driver of your choice (e.g. Chrome or Firefox) """ driver = webdriver.Remote(command_executor="http://localhost:4444/wd/hub", desired_capabilities=webdriver.DesiredCapabilities.PHANTOMJS) # Instantiate Google Page google = GooglePage(driver, url="https://www.google.com") # Open + wait for page load + validate Google google.open().wait_for_page_load().validate() # Print the page title print google.get_title() # Search for 'Cheese!' search_str = "Cheese!" google.search_field.type(search_str) google.search_field.submit() # Ensure that the page is refreshed from your search print google.wait_for_title(search_str).get_title()
Language Support
The Selenium PageModel implementation is not limited to just one language. Here are other language implementations:
Java - Java-SeleniumPM
Ruby - In consideration depending on needs and popularity.
Contributing to SeleniumPM
Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.
Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.
Fork the project.
Start a feature/bugfix branch.
Commit and push until you are happy with your contribution.
Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
Please try not to mess with the version or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so that I can cherry-pick around it.
Testing and Releasing
1. Uprev the version in seleniumpm/__init__.py
You’ll need to uprev the __version__ attribute in seleniumpm/__init__.py:
... __title__ = 'seleniumpm' __version__ = '1.0.0' __build__ = 0x021000 __author__ = 'Peter Salas' __license__ = 'Apache 2.0' ...
Commit and push your changes to Github!
2. Update HISTORY.md
You should update the Release Notes with the high-level changes contained within the release. If not ready to publish in Step 4 below, then put UN-RELEASED to denote that the feature is still under development has not been published to Pypi.
3. Test your code!
For goodness’ sake! You should always be writing and running the UnitTests:
make test
At this moment, it requires a standalone-selenium-server running locally. If you are running on a Mac, I recommend installing selenium-server-runner to get your system up-and-running in no time!
4. Upload your package to PyPI Test
Run:
make publish.test
You should get no errors, and should also now be able to see your library in the test PyPI repository.
5. Upload to PyPI Live
Once you’ve successfully uploaded to PyPI Test, publish your changes to Live:
make publish
References
A huge shoutout to Peter Downs for his very easy-to-follow instructions for submitting a Python package to the community. See first time with pypi for his instructions.
Also see the following:
selenium-server-runner - If you’re running on a Mac, this project helps you setup and run the standalone-selenium-server on your laptop
Java-SeleniumPM - The Java version of SeleniumPM
requestests - An API testing library
Package Dependencies:
seleniumpm installs the following upstream packages as of the latest release:
Copyright
Copyright (c) 2017 Peter Salas. See LICENSE for further details.
Release History
2.4.2 (2017-02-13)
New Features
Fixed
Fixing issue appending two .rst files together to generate the long_description
Using setuptools for setup.py.
2.4.1 (2017-02-13)
New Features
Fixed
Using disutils.core instead of setuptools for setup.py. Hoping this fixes pretty-print of rst files on PyPi
2.4.0 (2017-02-13)
New Features
Better support for Table type and interacting with them on a page. This includes support for ‘search’ operations and enumerating over rows and columns
Additional methods to Locator object to assist in managing them
implemented get_webelement() and get_webelements() for all Elements. This will return the Selenium WebElement object(s).
Implementation of object equality for all Selenium Page Model classes
UnitTests are now using PhantomJS (Headless) target
Removal of requestest dependency to keep the project simple
Fixed
The Widget type was missing in 2.3.0 release
Expanding of the UnitTest coverage to ensure libraries are working correctly
Fixing issue with get_text() in Python Selenium. Apparently, this call in Python (versus Java) is simply called ‘text’
Conversion of README and HISTORY files to rst. This is so that they are rendered correctly on PyPi server
2.3.0 (2017-02-06)
New Features
Provides a full implementation of the current Java v2.3 of Selenium PageModel
2.0.0 (2017-01-10)
New Features
First release of seleniumpm for the world
Contains minimum proof-of-concept for testing search on Google
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.