Developer Setup
Below are step-by-step instructions on how to set up a development environment in order to be able to successfully contribute to and execute the ecosystem test scripts.
1. Clone the ecosystem-test-scripts repository
The ecosystem test scripts are hosted on the Mozilla Github and can be cloned using the method of your choice (see Github Cloning A Repository). Contributors should follow the Contributing Guidelines and Community Participation Guidelines for the repository.
2. Copy the Metric Reporter Service Account JSON Key
The metric_reporter script is set up using the ecosystem-test-eng GCP project
with the metric-reporter service accounts. In order to execute the
script, a key for the service account, in the form of a JSON file, needs to be copied from the
1Password Ecosystem Test Engineering Team Vault into the root directory of the
ecosystem-test-scripts project.
3. Set up the config.ini
All settings for the ecosystem-test-scripts are defined in the config.ini file. To set up a
local config.ini file, make a copy of the config.ini.sample file found in the root directory of
the ecosystem-test-scriptsproject and rename it toconfig.ini`
4. Set up the python virtual environment
This project uses Poetry for dependency management in conjunction with a pyproject.toml file. While you can use virtualenv to set up the dev environment, it is recommended to use pyenv and pyenv-virtualenv, as they work nicely with Poetry. Once poetry is installed, dependencies can be installed using the following Make command from the root directory:
make install
For more information on Make commands, run:
make help