Release Clearcode < and associates (see AUTHORS)

Transcription

1 pytest s aucedocumentation Release Clearcode < and associates (see AUTHORS) July 14, 2014

2

3 Contents 1 Contents Usage Advanced Api Authors TODO 7 Python Module Index 9 i

4 ii

5 pytest s aucedocumentation, Release0.3.3 To install this package, download code, and run python setup.py develop or python setup.py install Once it s packaged on egg end deployed on some pypi, it ll be enough to add it to your project s requirements, or install it by means of pip. Contents 1

6 pytest s aucedocumentation, Release Contents

7 CHAPTER 1 Contents 1.1 Usage pytest_sauce does not provide tasks to run your tests (yet!), so far, this package provides methods, that run tests, but provides functions, that you can use within your pacer tasks or console scripts. All these tasks requires is argument with yaml config location Configuration Package provides default configuration. 1 # browsers key accepts all keys, as mozwebqa: 2 # 3 # but please keep it only browser related 4 browsers: [] 5 # - browsername: chrome 6 7 # basic setting for each run (py.test call parameters) 8 run: 9 baseurl: 10 skipurlcheck: true 11 #k: test_module_name # this sets the test type (selenium or saucelabs) 14 type: selenium 15 testpath:./ # basepath to run tests in 16 selenium: 17 xvfb: 18 # xvfb settings for xvfb mode (consult man xvfb-run here) 19 options: 20 server-args: -screen x768x24 21 auto-servernum: true 22 chromedriver: 23 file:./chromedriver # chromedriver location 24 url: # chromedriver repository 25 zips: # filenames 26 win: chromedriver_win32.zip 27 mac: chromedriver_mac32.zip 28 linux32: chromedriver_linux32.zip 29 linux64: chromedriver_linux64.zip 30 3

8 pytest s aucedocumentation, Release saucelabs: 32 connect: # saucelabs connect and download url 33 path:./sc-4.3-linux 34 url: Anything can be overriden in your test configuration. Note: You have to define separate configs for selenium and saucelabs Browsers To define browsers for tests follow convention presented in pytest_mozwebqa: Each parameter is a key in browsers list: Note: Mind, that for chrome you do not have to define chromedriver location, as pytest_sauce will download it anyway and pass it s path to chromepath argument to whenever you use chrome in your selenium tests. Saucelabs Saucelabs configuration should also contain these three keys: username: <saucelabs_username> password: <saucelabs_password> api-key: <saucelabs_apikey> It s important to have it here, as the same configuration file is passed to saucelabs argument xvfb selenium.xvfb is a little bit specific. you pass here xvfb-run arguments, that will configure xvfb environment. However if the whole key, will have false value, tests will be run without xvfb mode To run test in normal mode, simply set this key to false in your config: selenium: xvfb: false 1.2 Advanced This chapter will describe few advanced behaviours package provides pdb - ipdb When providing pdb option (run.pdb: true in config), pytest will drop to debug console, once error occurs within script. But when you have pytest_ipdb installed, along with ipdb, pytest_ipdb will replace pdb for ipdb, for better debbuging experience. 4 Chapter 1. Contents

9 pytest s aucedocumentation, Release0.3.3 To be able to use this, simply install pytest_sauce[ipdb] extras. Warning: pytest_ipdb provides only.egg distribution files, which pip is not able to download/install. Please use easy_install for this task, or add this to your standard setup.py requirement. 1.3 Api pytest_sauce pytest_sauce.get_config(config=none) Reads yaml configuration (default and given) Parameters config (str) url to config file returns config object pytest_sauce.utils pytest_sauce.utils.download_and_extract(url, path) Downloads data from url and extracts tar.gz file Args: url - url from wchich file will be downloaded path - path to file in which data of file from archive will be written Returns: None, result should be extracted file on disk pytest_sauce.utils.download_and_unzip(url, filename, path) Downloads data from url and unpacks zip file Args: url - url from wchich file will be downloaded filename - filename of file in zip to extract path - path to file in which data of file from zip will be written Returns: None, result should be extracted file on disk pytest_sauce.utils.get_chromedriver(config=none, config_path=none, update=false) Downloads chromedriver binary into config.selenium.chromedriver.file path Parameters config (pymlconf.configmanager) configuration object update (optional) if True overwrites existing binary pytest_sauce.utils.get_saucelabs_connect(config=none, config_path=none, update=false) Downloads saucelabs connect binary into config.saucelabs.connect.path Parameters config (pymlconf.configmanager) configuration object config_path (str) path to config update (bool) (optional) if True overwrites exisiting binary pytest_sauce.utils.read_run_arguments(config) Returns additional configuration option to run tests 1.3. Api 5

10 pytest s aucedocumentation, Release0.3.3 pytest_sauce.utils.run(command, config) joins list of run arguments and runs them pytest_sauce.utils.run_saucelabs(config_path) Runs saucelabs (by setting up tunnel via saucelabs connect) pytest_sauce.utils.run_tests(config_path) Runs test suite based on configuration passed Parameters config_path (str) path to yaml config file pytest_sauce.utils.test_saucelabs(config, credentials_yaml) runs selenium test based on config pytest_sauce.utils.test_selenium(config) runs selenium test based on config pytest_sauce.utils.test_unit(config) runs unit or integration tests based on config 1.4 Authors This file contains the list of people involved in the development of pytest_sauce along its history. Grzegorz Śliwiński Jarosław Śmiejczak Paweł Wilczyński Krzysztof Trębicki Great thanks to Clearcode for allowing releasing pytest_sauce as free software! 6 Chapter 1. Contents

11 CHAPTER 2 TODO 1. create a console tasks to run tests 7

12 pytest s aucedocumentation, Release Chapter 2. TODO

13 Python Module Index p pytest_sauce, 5 pytest_sauce.utils, 5 9