Skip to content

[asset] Add sample code for two new RPCs. #4080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jun 18, 2020
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions asset/cloud-client/quickstart_searchalliampolicies.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env python

# Copyright 2020 Google LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


import argparse


def search_all_iam_policies(scope, query=None, page_size=None):
# [START asset_quickstart_search_all_iam_policies]
from google.cloud import asset_v1

client = asset_v1.AssetServiceClient()
response = client.search_all_iam_policies(
scope, query=query, page_size=page_size)
for page in response.pages:
for policy in page:
print(policy)
break
# [END asset_quickstart_search_all_iam_policies]


if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument(
'scope',
help='The search is limited to the resources within the scope.')
parser.add_argument('--query', help='The query statement.')
parser.add_argument(
'--page_size',
type=int,
help='The page size for search result pagination.')
args = parser.parse_args()
search_all_iam_policies(args.scope, args.query, args.page_size)
29 changes: 29 additions & 0 deletions asset/cloud-client/quickstart_searchalliampolicies_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/usr/bin/env python

# Copyright 2020 Google LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os

import quickstart_searchalliampolicies

PROJECT = os.environ['GOOGLE_CLOUD_PROJECT']


def test_search_all_iam_policies(capsys):
scope = "projects/{}".format(PROJECT)
query = "policy:roles/owner"
quickstart_searchalliampolicies.search_all_iam_policies(scope, query=query)
out, _ = capsys.readouterr()
assert "roles/owner" in out
62 changes: 62 additions & 0 deletions asset/cloud-client/quickstart_searchallresources.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
#!/usr/bin/env python

# Copyright 2020 Google LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


import argparse


def search_all_resources(scope,
query=None,
asset_types=None,
page_size=None,
order_by=None):
# [START asset_quickstart_search_all_resources]
from google.cloud import asset_v1

client = asset_v1.AssetServiceClient()
response = client.search_all_resources(
scope,
query=query,
asset_types=asset_types,
page_size=page_size,
order_by=order_by)
for page in response.pages:
for resource in page:
print(resource)
break
# [END asset_quickstart_search_all_resources]


if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument(
'scope',
help='The search is limited to the resources within the scope.')
parser.add_argument('--query', help='The query statement.')
parser.add_argument(
'--asset_types', nargs='+', help='A list of asset types to search for.')
parser.add_argument(
'--page_size',
type=int,
help='The page size for search result pagination.')
parser.add_argument(
'--order_by',
help='Fields specifying the sorting order of the results.')
args = parser.parse_args()
search_all_resources(args.scope, args.query, args.asset_types,
args.page_size, args.order_by)
62 changes: 62 additions & 0 deletions asset/cloud-client/quickstart_searchallresources_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
#!/usr/bin/env python

# Copyright 2020 Google LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import uuid

import backoff
from google.api_core.exceptions import InvalidArgument, NotFound
from google.cloud import bigquery
import pytest

import quickstart_searchallresources

PROJECT = os.environ['GOOGLE_CLOUD_PROJECT']
DATASET = 'dataset_{}'.format(uuid.uuid4().hex)


@pytest.fixture(scope='module')
def bigquery_client():
yield bigquery.Client()


@pytest.fixture(scope='module')
def asset_dataset(bigquery_client):
dataset = bigquery_client.create_dataset(DATASET)

yield DATASET

try:
bigquery_client.delete_dataset(dataset)
except NotFound as e:
print('Failed to delete dataset {}'.format(DATASET))
raise e


def test_search_all_resources(asset_dataset, capsys):
scope = "projects/{}".format(PROJECT)
query = "name:{}".format(DATASET)

@backoff.on_exception(
backoff.expo, (AssertionError, InvalidArgument), max_time=30
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we added a backoff for this sample? Can we add a comment with context on why this is?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It takes some time for the created dataset to be searchable. I realized sleep() may be more intuitive in this case than using backoff to retry the search.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but why? I recommend backoff over sleep.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I'll switch back to backoff. I don't code python a lot so may I ask why backoff is preferred?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using backoff is tmatsuo's personal preference, and it's not one I agree with here. I believe backoff.on_exception has max_tries default to None, which means this will never fail and instead will continue to retry until the whole build fails out.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have max_time set to 30. It take no more than a few seconds to propagate, so maybe reduce it to 10s?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with 30 - the difference seems negligible.

)
def eventually_consistent_test():
quickstart_searchallresources.search_all_resources(scope, query=query)
out, _ = capsys.readouterr()

assert DATASET in out

eventually_consistent_test()
1 change: 1 addition & 0 deletions asset/cloud-client/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ google-cloud-storage==1.28.1
google-cloud-asset==1.1.0
google-cloud-resource-manager==0.30.2
google-cloud-pubsub==1.5.0
google-cloud-bigquery==1.25.0