diff options
| author | Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> | 2020-03-20 18:10:05 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-21 01:10:05 +0000 |
| commit | 8374e2198841d73d88f63087de305bf15cf79fa2 (patch) | |
| tree | 5e5786886c948cb16bf2814a027fd1f4f9f5a47d /CONTRIBUTING.rst | |
| parent | bb9215ad6dee6c1dc7f255a2e4ed7011b85bd6cf (diff) | |
| download | google-auth-library-python-8374e2198841d73d88f63087de305bf15cf79fa2.tar.gz | |
docs: fix typo for app engine setup, add detail to grpc and GCE test sections (#449)
@arithmetic1728
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bd92ca8..c04a6c6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -42,7 +42,9 @@ You can run the system tests with ``nox``:: To run a single session, specify it with ``nox -s``:: $ nox -f system_tests/noxfile.py -s service_account - + +First, set the environemnt variable ``GOOGLE_APPLICATION_CREDENTIALS`` to a valid service account. +See `Creating and Managing Service Account Keys`_ for how to obtain a service account. Project and Credentials Setup ------------------------------- @@ -113,13 +115,24 @@ If you already have a default service associated with your project, you can skip Edit ``app.yaml`` so ``service`` is ``default`` instead of ``google-auth-system-tests``. From ``system_tests/app_engine_test_app`` run the following commands :: - $ pip install --target-lib -r requirements.txt + $ pip install --target lib -r requirements.txt $ gcloud app deploy -q app.yaml After the app is deployed, change ``service`` in ``app.yaml`` back to ``google-auth-system-tests``. You can now run the App Engine tests: :: $ nox -f system_tests/noxfile.py -s app_engine + +Compute Engine Tests +^^^^^^^^^^^^^^^^^^^^ + +These tests cannot be run locally and will be skipped if they are run outside of Google Compute Engine. + +grpc Tests +^^^^^^^^^^^^ + +These tests use the Pub/Sub API. Grant the service account specified by `GOOGLE_APPLICATION_CREDENTIALS` +permissions to list topics. The service account should have at least `roles/pubsub.viewer`. Coding Style ------------ |