Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 2.7 KB

README.md

File metadata and controls

92 lines (69 loc) · 2.7 KB
Raw

Evergreen.py

A client library for the Evergreen API written in python. Currently supports the V2 version of the API. For more details, see https://github.com/evergreen-ci/evergreen/wiki/REST-V2-Usage .

PyPI Coverage Status

Usage

>>> from evergreen.api import EvgAuth, EvergreenApi
>>> api = EvergreenApi.get_api(EvgAuth('david.bradford', '***'))
>>> project = api.project_by_id('mongodb-mongo-master')
>>> project.display_name
'MongoDB (master)'

Command Line Application

A command line application is included to explore the evergreen api data. It is called evg-api.

$ evg-api --json list-hosts
{
    "host_id": "host num 0",
    "host_url": "host.num.com",
    "distro": {
        "distro_id": "ubuntu1804-build",
        "provider": "static",
        "image_id": ""
    },
    "provisioned": true,
    "started_by": "mci",
    "host_type": "",
    "user": "mci-exec",
    "status": "running",
    "running_task": {
        "task_id": null,
        "name": null,
        "dispatch_time": null,
        "version_id": null,
        "build_id": null
    },
    "user_host": false
}
...

Contributors Guide

Testing

Tox is being used for multiversion testing. Tests are run on python 2.7 and 3.6. You should have both of these installed locally. To run tests, install the requirements.txt and then run tox.

$ pip install -r requirements.txt
$ tox

To get code coverage information, you can run pytest directly.

$ pip install -r requirements.txt
$ pytest --cov=src --cov-report=html

This will generate an html coverage report in htmlcov/ directory.

There are a few tests that are slow running. These tests are not run by default, but can be included by setting the env variable RUN_SLOW_TESTS to any value.

$ RUN_SLOW_TEST=1 pytest

Versioning and Deploy

Deploys to PyPi are done automatically on merges to master. In order to avoid overwriting a previous deploy, the version should be updated on all changes. The semver versioning scheme should be used for determining the version number.

The version is found in the evergreen package at src/evergreen/__init__.py.

Note: There are evergreen checks to ensure the version does not match the latest version in PyPi.

Merging

Merges to master should be done by the evergreen commit queue. After a PR has been reviewed, add a comment with the text evergreen merge to merge the PR.