README (2207B)
1 TPS is a test automation framework for Firefox Sync. See 2 https://developer.mozilla.org/en/TPS for documentation. 3 4 Installation 5 ============ 6 7 TPS requires several packages to operate properly. To install TPS and 8 required packages, use the INSTALL.sh script, provided: 9 10 python3 create_venv.py /path/to/create/virtualenv 11 12 This script will create a virtalenv and install TPS into it. 13 14 You must then activate the virtualenv by executing: 15 16 - (mac/linux): source /path/to/virtualenv/Scripts/activate 17 - (win): /path/to/virtualenv/Scripts/activate.bat 18 19 TPS can then be run by executing: 20 21 runtps --binary=/path/to/firefox 22 23 > Note: You can run the tps tests in headless mode by using `MOZ_HEADLESS=1`. This will make 24 > your computer somewhat useable while the tests are running. 25 26 When you are done with TPS, you can deactivate the virtualenv by executing 27 `deactivate` 28 29 Configuration 30 ============= 31 To edit the TPS configuration, do not edit config/config.json.in in the tree. 32 Instead, edit config.json inside your virtualenv; it will be located at the 33 top level of where you specified the virtualenv be created - eg, for the 34 example above, it will be `/path/to/create/virtualenv/config.json` 35 36 Setting Up Test Accounts 37 ======================== 38 39 Firefox Accounts 40 ---------------- 41 To create a test account for using the Firefox Account authentication perform the 42 following steps: 43 44 > Note: Currently, the TPS tests rely on how restmail returns the verification code 45 > You should use restmail or something very similar. 46 > Gmail and other providers might give a `The request was blocked for security reasons` 47 48 1. Go to the URL: http://restmail.net/mail/%account_prefix%@restmail.net 49 - Replace `%account_prefix%` with your own test name 50 2. Go to https://accounts.firefox.com/signup?service=sync&context=fx_desktop_v1 51 3. Sign in with the previous chosen email address and a password 52 4. Go back to the Restmail URL, reload the page 53 5. Search for the verification link and open that page 54 55 Now you will be able to use this account for TPS. Note that these 56 steps can be done in either a test profile or in a private browsing window - you 57 might want to avoid doing that in a "real" profile that's already connected to 58 Sync.