Skip to content

Be tolerant of emtpy bodies in payload tests #508

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.

Sign up for GitHub

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 2 commits into from
Jun 6, 2025
Merged

Be tolerant of emtpy bodies in payload tests #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98db68d
Be tolerant of null bodies in tests
JordonPhillips May 30, 2025
41a32c0
Always have a string-like payload
JordonPhillips Jun 5, 2025
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
35 changes: 28 additions & 7 deletions ...n/core/src/main/java/software/amazon/smithy/python/codegen/HttpProtocolTestGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.shapes.UnionShape;
import software.amazon.smithy.model.traits.HttpPayloadTrait;
import software.amazon.smithy.model.traits.OutputTrait;
import software.amazon.smithy.model.traits.StreamingTrait;
import software.amazon.smithy.model.traits.TimestampFormatTrait.Format;
import software.amazon.smithy.protocoltests.traits.AppliesTo;
Expand Down Expand Up @@ -399,7 +401,7 @@ private void writeRequestBodyComparison(HttpMessageTestCase testCase, PythonWrit
}
writer.addDependency(SmithyPythonDependency.SMITHY_CORE);
writer.addImport("smithy_core.aio.types", "AsyncBytesReader");
writer.write("actual_body_content = await AsyncBytesReader(actual.body).read()");
writer.write("actual_body_content = await AsyncBytesReader(actual.body or b'').read()");
writer.write("expected_body_content = b$S", testCase.getBody().get());
compareMediaBlob(testCase, writer);
}
Expand Down Expand Up @@ -779,10 +781,20 @@ private Void structureShape(StructureShape shape, ObjectNode node) {
}

private Void structureMemberShapes(StructureShape container, ObjectNode node) {
node.getMembers().forEach((keyNode, valueNode) -> {
var memberShape = container.getMember(keyNode.getValue())
.orElseThrow(() -> new CodegenException("unknown memberShape: " + keyNode.getValue()));
var targetShape = model.expectShape(memberShape.getTarget());
for (MemberShape member : container.members()) {
var optionalValueNode = node.getMember(member.getMemberName());
if (optionalValueNode.isEmpty()) {
if (isStringLikeOutputPayload(container, member)) {
// Massage these outputs to always be present because it will generally be impossible to
// determine the difference between an empty body and a missing body.
optionalValueNode = Optional.of(Node.from(""));
} else {
continue;
}
}
var valueNode = optionalValueNode.get();

var targetShape = model.expectShape(member.getTarget());

var formatString = "$L = $C,";
if (targetShape.isDocumentShape()) {
Expand All @@ -791,12 +803,21 @@ private Void structureMemberShapes(StructureShape container, ObjectNode node) {
}

writer.write(formatString,
context.symbolProvider().toMemberName(memberShape),
context.symbolProvider().toMemberName(member),
(Runnable) () -> valueNode.accept(new ValueNodeVisitor(targetShape)));
});

}
return null;
}

private boolean isStringLikeOutputPayload(StructureShape container, MemberShape member) {
if (container.hasTrait(OutputTrait.class) && member.hasTrait(HttpPayloadTrait.class)) {
var target = model.expectShape(member.getTarget());
return target.isBlobShape() || target.isStringShape();
}
return false;
}

private Void mapShape(MapShape shape, ObjectNode node) {
writer.openBlock("{",
"}",
Expand Down
26 changes: 13 additions & 13 deletions ...in/java/software/amazon/smithy/python/codegen/integrations/RestJsonProtocolGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,33 +360,33 @@ protected void deserializePayloadBody(

var deserializerSymbol = symbolProvider.toSymbol(target);

writer.write("if body:").indent();

if (target.isUnionShape()) {
deserializerSymbol = deserializerSymbol.expectProperty(SymbolProperties.DESERIALIZER);
writer.write("""
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
deserializer = codec.create_deserializer(body)
kwargs[$S] = $T().deserialize(deserializer)
if body:
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
deserializer = codec.create_deserializer(body)
kwargs[$S] = $T().deserialize(deserializer)
""", memberName, deserializerSymbol);
} else if (target.isStringShape()) {
writer.write("kwargs[$S] = body.decode('utf-8')", memberName);
writer.write("kwargs[$S] = body.decode('utf-8') if body else \"\"", memberName);
} else if (target.isBlobShape()) {
writer.write("kwargs[$S] = body", memberName);
writer.write("kwargs[$S] = body or b\"\"", memberName);
} else if (target.isDocumentShape()) {
var schemaSymbol = deserializerSymbol.expectProperty(SymbolProperties.SCHEMA);
writer.write("""
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
deserializer = codec.create_deserializer(body)
kwargs[$S] = deserializer.read_document($T)
if body:
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
deserializer = codec.create_deserializer(body)
kwargs[$S] = deserializer.read_document($T)
""", memberName, schemaSymbol);
} else {
writer.write("""
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
kwargs[$S] = codec.deserialize(body, $T)
if body:
codec = JSONCodec(default_timestamp_format=TimestampFormat.EPOCH_SECONDS)
kwargs[$S] = codec.deserialize(body, $T)
""", memberName, deserializerSymbol);
}
writer.dedent();
}

@Override
Expand Down