Skip to content

Commit 57b706b

Browse files
software-dovsoftware-dov
authored
Add tests and impl for request messages with primitive fields (#214)
Fields that are strings, bools, ints, or floats are permitted. Mismatch between the type of the assigned value and type of the field is NOT handled by samplegen yet. Includes a fix for #211
1 parent be39a92 commit 57b706b

5 files changed

Lines changed: 119 additions & 14 deletions

File tree

‎packages/gapic-generator/gapic/samplegen/samplegen.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -280,14 +280,18 @@ def validate_and_transform_request(self,
280280
# and requires less munging of the assigned value
281281
duplicate["value"] = f"'{val}'"
282282
break
283+
elif attr.is_primitive:
284+
# Only valid if this is the last attribute in the chain.
285+
break
283286
else:
284-
raise TypeError
287+
raise TypeError(
288+
f"Could not handle attribute '{attr_name}' of type: {attr.type}")
285289

286290
if i != len(attr_chain) - 1:
287-
# We broke out of the loop after processing an enum.
291+
# We broke out of the loop after processing an enum or a primitive.
288292
extra_attrs = ".".join(attr_chain[i:])
289-
raise types.InvalidEnumVariant(
290-
f"Attempted to reference attributes of enum value: '{extra_attrs}'")
293+
raise types.NonTerminalPrimitiveOrEnum(
294+
f"Attempted to reference attributes of enum value or primitive type: '{extra_attrs}'")
291295

292296
if len(attr_chain) > 1:
293297
duplicate["field"] = ".".join(attr_chain[1:])

‎packages/gapic-generator/gapic/samplegen_utils/types.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ class InvalidEnumVariant(SampleError):
7676
pass
7777

7878

79+
class NonTerminalPrimitiveOrEnum(SampleError):
80+
pass
81+
82+
7983
class InvalidSampleFpath(SampleError):
8084
pass
8185

‎packages/gapic-generator/gapic/templates/examples/feature_fragments.j2‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -236,16 +236,16 @@ def main():
236236
import argparse
237237

238238
parser = argparse.ArgumentParser()
239-
{% with arg_list = [] %}
239+
{% with arg_list = [] -%}
240240
{% for request in request_block if request.body -%}
241241
{% for attr in request.body if attr.input_parameter %}
242242
parser.add_argument("--{{ attr.input_parameter }}",
243243
type=str,
244244
default={{ attr.value }})
245245
{% do arg_list.append("args." + attr.input_parameter) -%}
246246
{% endfor -%}
247-
{% endfor %}
248-
{% for request in request_block if request.single and request.single.input_parameter -%}
247+
{% endfor -%}
248+
{% for request in request_block if request.single and request.single.input_parameter %}
249249
parser.add_argument("--{{ request.single.input_parameter }}",
250250
type=str,
251251
default={{ request.single.value }})

‎packages/gapic-generator/tests/unit/samplegen/common_types.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@
4141
DummyMessage.__new__.__defaults__ = (False,) * len(DummyMessage._fields)
4242

4343
DummyField = namedtuple("DummyField",
44-
["message", "enum", "repeated", "field_pb", "meta"])
44+
["message",
45+
"enum",
46+
"repeated",
47+
"field_pb",
48+
"meta",
49+
"is_primitive",
50+
"type"])
4551
DummyField.__new__.__defaults__ = (False,) * len(DummyField._fields)
4652

4753
DummyService = namedtuple("DummyService", ["methods"])

‎packages/gapic-generator/tests/unit/samplegen/test_samplegen.py‎

Lines changed: 97 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
import yaml
1616
import pytest
1717

18-
from typing import (TypeVar)
19-
from collections import namedtuple
18+
from typing import (TypeVar, Sequence)
19+
from collections import (OrderedDict, namedtuple)
2020
from google.protobuf import descriptor_pb2
2121

2222
import gapic.samplegen.samplegen as samplegen
2323
import gapic.samplegen_utils.types as types
2424
import gapic.samplegen_utils.yaml as gapic_yaml
25-
from gapic.schema import (api, naming)
25+
from gapic.schema import (api, metadata, naming)
2626
import gapic.schema.wrappers as wrappers
2727

2828
from common_types import (DummyField, DummyMessage,
@@ -1555,12 +1555,103 @@ def test_validate_request_enum_invalid_value():
15551555

15561556

15571557
def test_validate_request_enum_not_last_attr():
1558-
enum = enum_factory("subclass", ["AMMONOIDEA", "COLEOIDEA", "NAUTILOIDEA"])
1559-
request_type = message_factory("mollusc.subclass", enum=enum)
1558+
# enum = enum_factory("subclass", ["AMMONOIDEA", "COLEOIDEA", "NAUTILOIDEA"])
1559+
# field = make_field(name="subclass", enum=enum)
1560+
request_type = make_message(
1561+
name="mollusc",
1562+
fields=[
1563+
make_field(
1564+
name="subclass",
1565+
enum=enum_factory(
1566+
"subclass", ["AMMONOIDEA", "COLEOIDEA", "NAUTILOIDEA"]
1567+
)
1568+
)
1569+
]
1570+
)
1571+
1572+
# request_type = message_factory("mollusc.subclass", enum=enum)
15601573
v = samplegen.Validator(DummyMethod(output=message_factory("mollusc_result"),
15611574
input=request_type))
1562-
with pytest.raises(types.InvalidEnumVariant):
1575+
with pytest.raises(types.NonTerminalPrimitiveOrEnum):
15631576
v.validate_and_transform_request(
15641577
types.CallingForm.Request,
15651578
[{"field": "subclass.order", "value": "COLEOIDEA"}]
15661579
)
1580+
1581+
1582+
def test_validate_request_primitive_field():
1583+
field = make_field(name="species", type="TYPE_STRING")
1584+
request_type = make_message(name="request", fields=[field])
1585+
1586+
request = [{"field": "species", "value": "Architeuthis dux"}]
1587+
v = samplegen.Validator(
1588+
DummyMethod(
1589+
output=message_factory("mollusc_result"),
1590+
input=request_type
1591+
)
1592+
)
1593+
1594+
actual = v.validate_and_transform_request(types.CallingForm.Request,
1595+
request)
1596+
expected = [
1597+
samplegen.TransformedRequest(
1598+
base="species",
1599+
body=None,
1600+
single=samplegen.AttributeRequestSetup(
1601+
value="Architeuthis dux"
1602+
)
1603+
)
1604+
]
1605+
1606+
assert actual == expected
1607+
1608+
1609+
def test_validate_request_non_terminal_primitive_field():
1610+
field = make_field(name="species", type="TYPE_STRING")
1611+
request_type = make_message(name="request", fields=[field])
1612+
1613+
request = [{"field": "species.nomenclature", "value": "Architeuthis dux"}]
1614+
v = samplegen.Validator(
1615+
DummyMethod(
1616+
output=message_factory("mollusc_result"),
1617+
input=request_type
1618+
)
1619+
)
1620+
1621+
with pytest.raises(types.NonTerminalPrimitiveOrEnum):
1622+
v.validate_and_transform_request(types.CallingForm.Request,
1623+
request)
1624+
1625+
1626+
def make_message(name: str, package: str = 'animalia.mollusca.v1', module: str = 'cephalopoda',
1627+
fields: Sequence[wrappers.Field] = (), meta: metadata.Metadata = None,
1628+
options: descriptor_pb2.MethodOptions = None,
1629+
) -> wrappers.MessageType:
1630+
message_pb = descriptor_pb2.DescriptorProto(
1631+
name=name,
1632+
field=[i.field_pb for i in fields],
1633+
options=options,
1634+
)
1635+
return wrappers.MessageType(
1636+
message_pb=message_pb,
1637+
fields=OrderedDict((i.name, i) for i in fields),
1638+
nested_messages={},
1639+
nested_enums={},
1640+
meta=meta or metadata.Metadata(address=metadata.Address(
1641+
name=name,
1642+
package=tuple(package.split('.')),
1643+
module=module,
1644+
)),
1645+
)
1646+
1647+
1648+
# Borrowed from test_field.py
1649+
def make_field(*, message=None, enum=None, **kwargs) -> wrappers.Field:
1650+
T = descriptor_pb2.FieldDescriptorProto.Type
1651+
kwargs.setdefault('name', 'my_field')
1652+
kwargs.setdefault('number', 1)
1653+
kwargs.setdefault('type', T.Value('TYPE_BOOL'))
1654+
if isinstance(kwargs['type'], str):
1655+
kwargs['type'] = T.Value(kwargs['type'])
1656+
field_pb = descriptor_pb2.FieldDescriptorProto(**kwargs)
1657+
return wrappers.Field(field_pb=field_pb, message=message, enum=enum)

0 commit comments

Comments
 (0)