Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.26 KB
Raw

Goblet Contributions

Running locally

clone repo git clone git@github.com:goblet/goblet.git install local version in your env by pip install -e .

If you are running into issues running tests, make sure to set your pythonpath.

export PYTHONPATH=$(pwd)

and install requests-mock

pip install requests-mock

Writing Tests

  • When mocking tests that interact with GCP you will notice the following env vars set.
monkeypatch.setenv("GOOGLE_PROJECT", "goblet")
monkeypatch.setenv("GOOGLE_LOCATION", "us-central1")
monkeypatch.setenv("G_TEST_NAME", "job-destroy")
monkeypatch.setenv("G_HTTP_TEST", "REPLAY")

When writing your own tests you will need to set GOOGLE_PROJECT to the project you are testing in. G_TEST_NAME should correspond to a new folder that you created under /tests/data/http/NEW_FOLDER. Finally you should change G_HTTP_TEST to RECORD. After running the test, make sure to reset envs.

Before running tests you should run

export G_HTTP_TEST=REPLAY
export G_TEST_DATA_DIR=$PWD/goblet/tests/data/http
export G_MOCK_CREDENTIALS=True
export G_TEST_PROJECT_ID="goblet"
  • You can run tests by calling make coverage

Lint

run make lint to run default linter. run black goblet to format all files correctly