Skip to content

Commit b0f511d

Browse files
authored
docs: fix typo for app engine setup, add detail to grpc and GCE test sections (#449)
@arithmetic1728
1 parent dce9fc6 commit b0f511d

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

packages/google-auth/CONTRIBUTING.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ You can run the system tests with ``nox``::
4242
To run a single session, specify it with ``nox -s``::
4343

4444
$ nox -f system_tests/noxfile.py -s service_account
45-
45+
46+
First, set the environemnt variable ``GOOGLE_APPLICATION_CREDENTIALS`` to a valid service account.
47+
See `Creating and Managing Service Account Keys`_ for how to obtain a service account.
4648

4749
Project and Credentials Setup
4850
-------------------------------
@@ -113,13 +115,24 @@ If you already have a default service associated with your project, you can skip
113115
Edit ``app.yaml`` so ``service`` is ``default`` instead of ``google-auth-system-tests``.
114116
From ``system_tests/app_engine_test_app`` run the following commands ::
115117

116-
$ pip install --target-lib -r requirements.txt
118+
$ pip install --target lib -r requirements.txt
117119
$ gcloud app deploy -q app.yaml
118120

119121
After the app is deployed, change ``service`` in ``app.yaml`` back to ``google-auth-system-tests``.
120122
You can now run the App Engine tests: ::
121123

122124
$ nox -f system_tests/noxfile.py -s app_engine
125+
126+
Compute Engine Tests
127+
^^^^^^^^^^^^^^^^^^^^
128+
129+
These tests cannot be run locally and will be skipped if they are run outside of Google Compute Engine.
130+
131+
grpc Tests
132+
^^^^^^^^^^^^
133+
134+
These tests use the Pub/Sub API. Grant the service account specified by `GOOGLE_APPLICATION_CREDENTIALS`
135+
permissions to list topics. The service account should have at least `roles/pubsub.viewer`.
123136

124137
Coding Style
125138
------------

0 commit comments

Comments
 (0)