testing/mozbase/docs/mozproxy.rst
author Tarek Ziadé <tarek@mozilla.com>
Fri, 08 Mar 2019 13:23:28 +0000
changeset 521276 62b4aaa7ed95541f31489dc4567af4b1a1879694
parent 520570 76b84ca9cfaa348dba43d74575e7a3b133d4bed3
child 521752 19e13e0edc40bffa1443a45d99af455a486ed70c
permissions -rw-r--r--
Bug 1533671 - Tweak some options in mozproxy r=Bebe - adds playback_artifacts - make playback_pageset_manifest optional - adds the MOZPROXY_DIR environment variable Differential Revision: https://phabricator.services.mozilla.com/D22663

:mod:`mozproxy` --- Provides an HTTP proxy
==========================================

Mozproxy let you launch an HTTP proxy when we need to run tests against
third-part websites in a reliable and reproducible way.

Mozproxy provides an interface to a proxy software, and the currently
supported backend is **mitmproxy** for Desktop and Android.

Mozproxy is used by Raptor to run performance test without having to interact
with the real web site.

Mozproxy provide a function that returns a playback class. The usage pattern is
::

   from mozproxy import get_playback

   config = {'playback_tool': 'mitmproxy'}
   pb = get_playback(config)
   pb.start()
   try:
     # do your test
   finally:
     pb.stop()

**config** is a dict with the following options:

- **playback_tool**: name of the backend. can be "mitmproxy", "mitmproxy-android"
- **playback_recordings**: list of recording files
- **playback_binary_manifest**: tooltool manifests for the proxy backend binary
- **playback_pageset_manifest**: tooltool manifest for the pagesets archive
- **playback_artifacts**: links to downloadable artifacts
- **binary**: path of the browser binary
- **obj_path**: build dir
- **platform**: platform name (provided by mozinfo.os)
- **run_local**: if True, the test is running locally.
- **custom_script**: name of the mitm custom script (-s option)
- **app**: tested app. Can be "firefox",  "geckoview", "refbrow", "fenix" or  "firefox"
- **host**: hostname for the policies.json file
- **local_profile_dir**: profile dir


Supported environment variables:

- **MOZPROXY_DIR**: directory used by mozproxy for all data files, set by mozproxy
- **MOZ_UPLOAD_DIR**: upload directory path
- **GECKO_HEAD_REPOSITORY**: used to find the certutils binary path from the CI
- **GECKO_HEAD_REV**: used to find the certutils binary path frmo the CI
- **HOSTUTILS_MANIFEST_PATH**: used to find the certutils binary path from the CI