find json samples for HttpMocks

[b10n1k]

Looking at https://github.com/googleapis/google-api-python-client/blob/main/docs/mocks.md i see that i need some json representation of the services. I try to mock service accounts and i do not know where to find those files.

in my case, i want to mock for instance

iam_client = googleapiclient.discovery.build('iam', 'v1', credentials=self.credentials)
iam_client.projects().serviceAccounts().list(name='projects/my_proj') .execute()

Taking the example i have

http = HttpMock('service_account_discovery.json', {'status': '200'})
api_key = 'secret_key'
service = build('iam', 'v1', http=http, developerKey=secret_key)
request = service.projects().serviceAccounts().list(name='projects/my_proj') 
http = HttpMock('iam_accounts.json', {'status': '200'})
response = request.execute(http=http)
pprint.pprint(response)

Where can i find the representation of service_account_discovery.json and iam_accounts.json?

[parthea]

Hi @b10n1k!

For 'service_account_discovery.json' and iam_accounts.json you would need to create those files based on the actual API responses. Please see the 2nd note listed under the example.

Notes:

...
As you develop and test your application, it is a good idea to save actual API responses in files like books-discovery.json or books-android.json for use in testing.
...

Note, if you change

service = build('iam', 'v1', http=http, developerKey=secret_key)

to

service = build('iam', 'v1')

in your testing. You won't need to mock building of the client as the default behaviour for googleapiclient.discovery.build() is to fetch discovery artifacts which are shipped with the library rather than from the internet. For example, see iam.v1.json which is included with the library.

[b10n1k]

i changed the build() as suggested however the test breaks

>       raise exceptions.DefaultCredentialsError(_HELP_MESSAGE)
E       google.auth.exceptions.DefaultCredentialsError: Could not automatically determine credentials. Please set GOOGLE_APPLICATION_CREDENTIALS or explicitly create credentials and re-run the application. For more information, please see https://cloud.google.com/docs/authentication/getting-started

../../Envs/pcwenv/lib/python3.8/site-packages/google/auth/_default.py:488: DefaultCredentialsError
----------------------------------------------------------------------------------------------------------- Captured stderr call ------------------------------------------------------------------------------------------------------------
2021-12-13 12:32:47,208 google.auth.compute_engine._metadata WARNING  Compute Engine Metadata server unavailable on attempt 1 of 3. Reason: timed out
2021-12-13 12:32:50,212 google.auth.compute_engine._metadata WARNING  Compute Engine Metadata server unavailable on attempt 2 of 3. Reason: timed out
2021-12-13 12:32:53,214 google.auth.compute_engine._metadata WARNING  Compute Engine Metadata server unavailable on attempt 3 of 3. Reason: timed out
2021-12-13 12:32:53,215 google.auth._default WARNING  Authentication failed using Compute Engine authentication due to unavailable metadata server.
------------------------------------------------------------------------------------------------------------- Captured log call -------------------------------------------------------------------------------------------------------------
WARNING  google.auth.compute_engine._metadata:_metadata.py:99 Compute Engine Metadata server unavailable on attempt 1 of 3. Reason: timed out
WARNING  google.auth.compute_engine._metadata:_metadata.py:99 Compute Engine Metadata server unavailable on attempt 2 of 3. Reason: timed out
WARNING  google.auth.compute_engine._metadata:_metadata.py:99 Compute Engine Metadata server unavailable on attempt 3 of 3. Reason: timed out
WARNING  google.auth._default:_default.py:286 Authentication failed using Compute Engine authentication due to unavailable metadata server.
========================================================================================================== short test summary info ==========================================================================================================
FAILED tests/test_gce.py::test_cleanup_serviceAccounts - google.auth.exceptions.DefaultCredentialsError: Could not automatically determine credentials. Please set GOOGLE_APPLICATION_CREDENTIALS or explicitly create credentials and re-...

[parthea]

It looks like the error is due to this line which attempts to fetch default credentials: https://github.com/googleapis/google-api-python-client/blob/main/googleapiclient/discovery.py#L575 . Let's revert back to the original code. Please can you try the following and let me know if the error is still present?

from googleapiclient.discovery import build
from googleapiclient.http import HttpMock
http = HttpMock(<path to>/'iam.v1.json', {'status': '200'})
api_key = 'your_api_key'
service = build('iam', 'v1', http=http, developerKey=api_key)

Copy this file locally as iam.v1.json and update the path in the code snippet above.

[b10n1k]

regarding

As you develop and test your application, it is a good idea to save actual API responses in files like books-discovery.json or books-android.json for use in testing.

Could you provide an example for catch the response for discovery.json of iam?

the actual self.__iam_client = googleapiclient.discovery.build("iam", "v1", credentials=self.credentials, cache_discovery=False) returns <googleapiclient.discovery.Resource object>. Which call gives me the json in this case?

[parthea]

For iam v1, you can copy the file directly from here .

[parthea]

Here is a working example with mock:

from googleapiclient.discovery import build
from googleapiclient.http import HttpMock
api_key = 'your_api_key'
http = HttpMock(<your path to>/'iam.v1.json', {'status': '200'})
iam_client = build('iam', 'v1', http=http, developerKey=api_key)
http = HttpMock(<your path to>/'iam_accounts.json', {'status': '200'})
request = iam_client.projects().serviceAccounts().list(name='projects/<your project>') 
response = request.execute(http=http)

The contents of 'iam.v1.json is the same as this file.
The contents of iam_accounts.json was captured locally using this code:

from googleapiclient.discovery import build
iam_client = build('iam', 'v1')
print(iam_client.projects().serviceAccounts().list(name='projects/<your project>').execute())