The PyCats aims to provide the well-structured framework with libraries created based on the popular python solutions intended for testing purposes and to make it universal for testing across different domain areas - Web, Mobile, IoT, Embedded.
It uses the pytest library as a test runner, Selenium Web Driver for Web UI testing, Appium for mobile testing, contains wrappers over the Web Driver to simplify its usage, provides layered architecture and recommendations how to organize tests.
PyCATS is implemented based on the layered architecture approach that allows us to differentiate the functionality of tests and modules into different layers and make the use of the framework simple and understandable.
The following diagram displays how it looks like (you can find the examples of how the tests and layers are organized in the project folder):
The sequence diagram below illustrates how PyCATS performs initial framework initialization based on the pytest hooks
TBU
The minimal python version is 3.7
To enable Web UI testing, need to download Web drivers for your browsers versions and provide their names and path to the directory via a configuration file or command-line interface:
Chrome Drivers Firefox Drivers Microsof Edge Safari Drivers are delivered together with browser
PyCats uses WebDriver's RemoteDriver to be able to run a browser remotely. You need to download selenium server and provide its path in the configuration file.
To install the required packages, download GitHub project and execute the following command in the root project's directory:
pip3 install -r requirements.txtCreate directory for configs and prepare the config ini file started with pycats_ prefix and .ini extension, like: pycats_config.ini:
Example of pycats_config.ini:
[global]
;Path to folder to keep the log files. Folder will be created if if does not exist. Logs by default
logdir = Logs
;Log level. The same for all streams. INFO by default
log_level = INFO
; If True, the logging from 3-d party libraries like Selenium, requests, etc, will be included in log file. True by default
enable_libs_logging = True
[api_validation]
;Should the API validator verify response status code. True by default
validate_status_code = True
;Should the API validator verify response headers. True by default
validate_headers = True
;Should the API validator verify response body. (default is True)
validate_body = True
;Should the API validator raise exception if some field from model is absent in response. True by default
validate_is_field_missing = True
[web]
;Folder where browsers drivers are located
webdriver_folder = /home/test/web/webdrivers/
;Time to wait until element appears on the page. 20 seconds by default
default_wait_time = 20
;Webdriver implicit wait time. 60 seconds by default
implicit_wait_time = 60
;Folder where selenium server is located
selenium_server_executable = /home/test/web/webdrivers/selenium-server-standalone-3.141.59.jar
;Chrome driver filename
chrome_driver_name = chromedriver
;Firefox driver filename
firefox_driver_name = gecodriver
;Browser to use in a testing (depending on this field value - appropriate driver name will be looked up in webdriver_folder)
browser = chrome
;Swither that allow or forbid teardown of webdriver server after test session
stop_server = True
;Chrome browser options (in comma separated list format)
chrome_options = incognito, disable-extensions, no-sandbox
[mobile]
;Path to appium server executable
appium_server_path = /Applications/Appium.app/Contents/Resources/app/node_modules/appium/build/lib/main.js
;Path to node executable
node_executable_path = node
;Mobile platform to use in a testing (availible values: android, ios)
platform = android
;The uuid of iOS device for tests
ios_udid = None
;Path to iOS application file (ipa)
ipa_path = None
;The uuid of android device for tests
android_udid = R58M44XFLNV
;Package name of android application for test
android_package = com.yahoo.mobile.client.android.weather
;Activity of first screen after app opens
android_activity = com.yahoo.mobile.client.android.weather.ui.WeatherMainActivity
;Mobiledriver implicit wait time. 30 seconds by default
implicit_wait_time=30
;Time to wait until element appears on the page. 20 seconds by default
default_wait_time=20
global and api_validation sections are optional but you can override their default behaviour in config.
The mandatory settings for web section are:
webdriver_folderchrome_driver_namefirefox_driver_namebrowser
Create pytest.ini file in the root directory with the following content:
[pytest]
config_dir = ./config
where config_dir is absolute or relative path to configs directory.
PyCats configuration system allows users to extend default config file or split it to multiple and load them dynamically. Specify necessary configuration options like application url or api url in custom section of config file:
Example of pycats_config.ini:
[project]
web_app_url = https://openweathermap.org/
web_api_url = http://api.openweathermap.org/data/2.5/
then write section description class in the same config folder or subfolders. It should be inherited from
common.config_parser.config_parser.ConfigSection class and implement all necessary abstract methods.
See example in config/project_section.py
To access Facade API you can use shortcut from common.facade.__init__.py
from common.facade import raw_config, loggerraw_config- shortcut to access pycats.config_manager.config object from Facadelogger- shortcut to access pycats.logger object from Facade
UI testing based on separation of test logic, UI actions and checks for different layers and using keywords style. The main feature of PyCats is the ability to use custom WebPage / WebElements classes that allow to find element on the page in moment when we need to interact with them and provide a lot of useful functions to work with mobile/web ui interfaces.
Detailed description and example you can find on sample folder:
The PyCats's API testing main feature is the ability to use models to validate request/response automatically on the core level without test layer impact. On the tests layer it is needed to prepare a response model and specify expected conditions, and the system does the rest for you.
Detailed description and example you can find on wiki page: Writing API tests
This project is licensed under the Apache2 License - see the LICENSE file for details