Skip to content
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

fix: the common resources are not targets for lookup #650

Merged
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
m = re.match(r"{{ message.path_regex_str }}", path)
return m.groupdict() if m else {}
{% endfor %}
{% for resource_msg in service.common_resources|sort(attribute="type_name") -%}
{% for resource_msg in service.common_resources.values()|sort(attribute="type_name") -%}
@staticmethod
def common_{{ resource_msg.message_type.resource_type|snake_case }}_path({% for arg in resource_msg.message_type.resource_path_args %}{{ arg }}: str, {%endfor %}) -> str:
"""Return a fully-qualified {{ resource_msg.message_type.resource_type|snake_case }} string."""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ def test_parse_{{ message.resource_type|snake_case }}_path():
assert expected == actual

{% endfor -%}
{% for resource_msg in service.common_resources -%}
{% for resource_msg in service.common_resources.values()|sort(attribute="type_name") -%}
def test_common_{{ resource_msg.message_type.resource_type|snake_case }}_path():
{% for arg in resource_msg.message_type.resource_path_args -%}
{{ arg }} = "{{ molluscs.next() }}"
Expand Down
21 changes: 12 additions & 9 deletions gapic/schema/wrappers.py
Original file line number Diff line number Diff line change
Expand Up @@ -909,29 +909,29 @@ class Service:
default_factory=metadata.Metadata,
)

common_resources: ClassVar[Sequence[CommonResource]] = dataclasses.field(
default=(
CommonResource(
common_resources: ClassVar[Mapping[str, CommonResource]] = dataclasses.field(
default={
"cloudresourcemanager.googleapis.com/Project": CommonResource(
"cloudresourcemanager.googleapis.com/Project",
"projects/{project}",
),
CommonResource(
"cloudresourcemanager.googleapis.com/Organization": CommonResource(
"cloudresourcemanager.googleapis.com/Organization",
"organizations/{organization}",
),
CommonResource(
"cloudresourcemanager.googleapis.com/Folder": CommonResource(
"cloudresourcemanager.googleapis.com/Folder",
"folders/{folder}",
),
CommonResource(
"cloudbilling.googleapis.com/BillingAccount": CommonResource(
"cloudbilling.googleapis.com/BillingAccount",
"billingAccounts/{billing_account}",
),
CommonResource(
"locations.googleapis.com/Location": CommonResource(
"locations.googleapis.com/Location",
"projects/{project}/locations/{location}",
),
),
},
init=False,
compare=False,
)
Expand Down Expand Up @@ -1051,7 +1051,10 @@ def gen_indirect_resources_used(message):
resource = field.options.Extensions[
resource_pb2.resource_reference]
resource_type = resource.type or resource.child_type
if resource_type:
# The common resources are defined (and rendered) explicitly
# by separate logic, and the resource definitions are never
# visible in any of the APIs file descriptor protos.
if resource_type and resource_type not in self.common_resources:
yield self.visible_resources[resource_type]

return frozenset(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class {{ service.async_client_name }}:
{{ message.resource_type|snake_case }}_path = staticmethod({{ service.client_name }}.{{ message.resource_type|snake_case }}_path)
parse_{{ message.resource_type|snake_case}}_path = staticmethod({{ service.client_name }}.parse_{{ message.resource_type|snake_case }}_path)
{% endfor %}
{% for resource_msg in service.common_resources %}
{% for resource_msg in service.common_resources.values()|sort(attribute="type_name") %}
common_{{ resource_msg.message_type.resource_type|snake_case }}_path = staticmethod({{ service.client_name }}.common_{{ resource_msg.message_type.resource_type|snake_case }}_path)
parse_common_{{ resource_msg.message_type.resource_type|snake_case }}_path = staticmethod({{ service.client_name }}.parse_common_{{ resource_msg.message_type.resource_type|snake_case }}_path)
{% endfor %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
return m.groupdict() if m else {}

{% endfor %} {# resources #}
{% for resource_msg in service.common_resources|sort(attribute="type_name") -%}
{% for resource_msg in service.common_resources.values()|sort(attribute="type_name") -%}
@staticmethod
def common_{{ resource_msg.message_type.resource_type|snake_case }}_path({% for arg in resource_msg.message_type.resource_path_args %}{{ arg }}: str, {%endfor %}) -> str:
"""Return a fully-qualified {{ resource_msg.message_type.resource_type|snake_case }} string."""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1328,7 +1328,7 @@ def test_parse_{{ message.resource_type|snake_case }}_path():
assert expected == actual

{% endfor -%}
{% for resource_msg in service.common_resources -%}
{% for resource_msg in service.common_resources.values()|sort(attribute="type_name") -%}
def test_common_{{ resource_msg.message_type.resource_type|snake_case }}_path():
{% for arg in resource_msg.message_type.resource_path_args -%}
{{ arg }} = "{{ molluscs.next() }}"
Expand Down
14 changes: 7 additions & 7 deletions tests/unit/schema/wrappers/test_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,28 +311,28 @@ def test_has_pagers():
def test_default_common_resources():
service = make_service(name="MolluscMaker")

assert service.common_resources == (
CommonResource(
assert service.common_resources == {
"cloudresourcemanager.googleapis.com/Project": CommonResource(
"cloudresourcemanager.googleapis.com/Project",
"projects/{project}",
),
CommonResource(
"cloudresourcemanager.googleapis.com/Organization": CommonResource(
"cloudresourcemanager.googleapis.com/Organization",
"organizations/{organization}",
),
CommonResource(
"cloudresourcemanager.googleapis.com/Folder": CommonResource(
"cloudresourcemanager.googleapis.com/Folder",
"folders/{folder}",
),
CommonResource(
"cloudbilling.googleapis.com/BillingAccount": CommonResource(
"cloudbilling.googleapis.com/BillingAccount",
"billingAccounts/{billing_account}",
),
CommonResource(
"locations.googleapis.com/Location": CommonResource(
"locations.googleapis.com/Location",
"projects/{project}/locations/{location}",
),
)
}


def test_common_resource_patterns():
Expand Down