Skip to content

Commit

Permalink
[C#] Extend tests to cover extended schemas.
Browse files Browse the repository at this point in the history 
These tests showed some deficiencies in the DTO generation. For example,
added variable-length data was not represented as nullable nor properly
handled in `EncodeInto(...)`.

During this work, I noticed composite "field" tokens (i.e., types)
take their `token.version()` from their containing message/group field.
I had to adjust some code that was using `token.version() > 0` to
determine whether a field had been added, as this only works with
message/group fields.
  • Loading branch information
@ZachBray
ZachBray committed Oct 23, 2023
1 parent b9e603f commit da32de0
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 38 deletions.
87 changes: 65 additions & 22 deletions sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpDtoGenerator.java
View file
Expand Up @@ -93,8 +93,8 @@ public void generate() throws IOException
collectVarData(messageBody, offset, varData);
generateVarData(sb, ctorArgs, varData, BASE_INDENT + INDENT);

generateDecodeFrom(sb, className, codecClassName, fields, groups, varData, BASE_INDENT + INDENT);
generateEncodeInto(sb, codecClassName, fields, groups, varData, BASE_INDENT + INDENT);
generateMessageDecodeFrom(sb, className, codecClassName, fields, groups, varData, BASE_INDENT + INDENT);
generateMessageEncodeInto(sb, codecClassName, fields, groups, varData, BASE_INDENT + INDENT);
generateDisplay(sb, codecClassName, "WrapForEncode", null, BASE_INDENT + INDENT);

removeTrailingComma(ctorArgs);
Expand All @@ -119,6 +119,12 @@ public void generate() throws IOException
}
}

private enum DefinitionKind
{
Composite,
Message
}

private void generateGroups(
final StringBuilder sb,
final StringBuilder ctorArgs,
Expand Down Expand Up @@ -174,9 +180,9 @@ private void generateGroups(

generateDecodeListFrom(
groupRecordBody, groupClassName, qualifiedCodecClassName, indent + INDENT);
generateDecodeFrom(
generateMessageDecodeFrom(
groupRecordBody, groupClassName, qualifiedCodecClassName, fields, groups, varData, indent + INDENT);
generateEncodeInto(
generateMessageEncodeInto(
groupRecordBody, qualifiedCodecClassName, fields, groups, varData, indent + INDENT);

removeTrailingComma(groupCtorArgs);
Expand Down Expand Up @@ -210,7 +216,8 @@ private void generateCompositeDecodeFrom(
{
final Token token = tokens.get(i);

generateFieldDecodeFrom(sb, token, token, codecClassName, indent + INDENT + INDENT);
generateFieldDecodeFrom(
sb, DefinitionKind.Composite, token, token, codecClassName, indent + INDENT + INDENT);

i += tokens.get(i).componentTokenCount();
}
Expand Down Expand Up @@ -270,7 +277,7 @@ private void generateDecodeListFrom(
.append(indent).append("}\n");
}

private void generateDecodeFrom(
private void generateMessageDecodeFrom(
final StringBuilder sb,
final String dtoClassName,
final String codecClassName,
Expand All @@ -285,7 +292,7 @@ private void generateDecodeFrom(
.append(indent).append("{\n");

sb.append(indent).append(INDENT).append("return new ").append(dtoClassName).append("(\n");
generateFieldsDecodeFrom(sb, fields, codecClassName, indent + INDENT + INDENT);
generateMessageFieldsDecodeFrom(sb, fields, codecClassName, indent + INDENT + INDENT);
generateGroupsDecodeFrom(sb, groups, indent + INDENT + INDENT);
generateVarDataDecodeFrom(sb, varData, indent + INDENT + INDENT);
removeTrailingComma(sb);
Expand All @@ -294,7 +301,7 @@ private void generateDecodeFrom(
sb.append(indent).append("}\n");
}

private void generateFieldsDecodeFrom(
private void generateMessageFieldsDecodeFrom(
final StringBuilder sb,
final List<Token> tokens,
final String codecClassName,
Expand All @@ -307,35 +314,37 @@ private void generateFieldsDecodeFrom(
{
final Token encodingToken = tokens.get(i + 1);

generateFieldDecodeFrom(sb, signalToken, encodingToken, codecClassName, indent);
generateFieldDecodeFrom(sb, DefinitionKind.Message, signalToken, encodingToken, codecClassName, indent);
}
}
}

private void generateFieldDecodeFrom(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token fieldToken,
final Token typeToken,
final String codecClassName, final String indent)
final String codecClassName,
final String indent)
{
switch (typeToken.signal())
{
case ENCODING:
generatePrimitiveDecodeFrom(sb, fieldToken, typeToken, codecClassName, indent);
generatePrimitiveDecodeFrom(sb, rootKind, fieldToken, typeToken, codecClassName, indent);
break;

case BEGIN_SET:
generatePropertyDecodeFrom(sb, fieldToken, "0", null, indent);
generatePropertyDecodeFrom(sb, rootKind, fieldToken, "0", null, indent);
break;

case BEGIN_ENUM:
final String enumName = formatClassName(typeToken.applicableTypeName());
final String nullValue = formatNamespace(ir.packageName()) + "." + enumName + ".NULL_VALUE";
generatePropertyDecodeFrom(sb, fieldToken, nullValue, null, indent);
generatePropertyDecodeFrom(sb, rootKind, fieldToken, nullValue, null, indent);
break;

case BEGIN_COMPOSITE:
generateComplexDecodeFrom(sb, fieldToken, typeToken, indent);
generateComplexDecodeFrom(sb, rootKind, fieldToken, typeToken, indent);
break;

default:
Expand All @@ -345,6 +354,7 @@ private void generateFieldDecodeFrom(

private void generatePrimitiveDecodeFrom(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token fieldToken,
final Token typeToken,
final String codecClassName,
Expand All @@ -360,16 +370,17 @@ private void generatePrimitiveDecodeFrom(
if (arrayLength == 1)
{
final String codecNullValue = codecClassName + "." + formatPropertyName(fieldToken.name()) + "NullValue";
generatePropertyDecodeFrom(sb, fieldToken, "null", codecNullValue, indent);
generatePropertyDecodeFrom(sb, rootKind, fieldToken, "null", codecNullValue, indent);
}
else if (arrayLength > 1)
{
generateArrayDecodeFrom(sb, fieldToken, typeToken, indent);
generateArrayDecodeFrom(sb, rootKind, fieldToken, typeToken, indent);
}
}

private void generateArrayDecodeFrom(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token fieldToken,
final Token typeToken,
final String indent)
Expand All @@ -386,6 +397,7 @@ private void generateArrayDecodeFrom(
{
generateRecordPropertyAssignment(
sb,
rootKind,
fieldToken,
indent,
"codec.Get" + formattedPropertyName + "()",
Expand All @@ -397,6 +409,7 @@ private void generateArrayDecodeFrom(
{
generateRecordPropertyAssignment(
sb,
rootKind,
fieldToken,
indent,
"codec." + formattedPropertyName + "AsSpan().ToArray()",
Expand All @@ -408,6 +421,7 @@ private void generateArrayDecodeFrom(

private void generatePropertyDecodeFrom(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token fieldToken,
final String dtoNullValue,
final String codecNullValue,
Expand All @@ -423,6 +437,7 @@ private void generatePropertyDecodeFrom(

generateRecordPropertyAssignment(
sb,
rootKind,
fieldToken,
indent,
"codec." + formattedPropertyName,
Expand All @@ -433,6 +448,7 @@ private void generatePropertyDecodeFrom(

private void generateComplexDecodeFrom(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token fieldToken,
final Token typeToken,
final String indent)
Expand All @@ -443,6 +459,7 @@ private void generateComplexDecodeFrom(

generateRecordPropertyAssignment(
sb,
rootKind,
fieldToken,
indent,
dtoClassName + ".DecodeFrom(codec." + formattedPropertyName + ")",
Expand All @@ -469,6 +486,7 @@ private void generateGroupsDecodeFrom(

generateRecordPropertyAssignment(
sb,
DefinitionKind.Message,
groupToken,
indent,
groupDtoClassName + ".DecodeListFrom(codec." + formattedPropertyName + ")",
Expand Down Expand Up @@ -511,6 +529,7 @@ private void generateVarDataDecodeFrom(

generateRecordPropertyAssignment(
sb,
DefinitionKind.Message,
token,
indent,
"codec." + accessor + "()",
Expand All @@ -523,6 +542,7 @@ private void generateVarDataDecodeFrom(

private void generateRecordPropertyAssignment(
final StringBuilder sb,
final DefinitionKind rootKind,
final Token token,
final String indent,
final String presentExpression,
Expand All @@ -534,8 +554,20 @@ private void generateRecordPropertyAssignment(

sb.append(indent).append(formattedPropertyName).append(": ");

if (token.version() > 0)
// N.B., in the IR, the composite information is "embedded" into each message/group field.
// When we are looking at a composite "field" (i.e., a type) the `token.version()` method
// returns the "sinceVersion" of the containing field. Therefore, we cannot decide presence
// based on `token.version()` when dealing with composites.
if (rootKind.equals(DefinitionKind.Message) && token.version() > 0)
{
if (token.signal() != Signal.BEGIN_VAR_DATA && !token.isOptionalEncoding())
{
throw new IllegalStateException(
"Expected added field " + propertyName +
" (sinceVersion=" + token.version() + ") to have optional presence."
);
}

sb.append("codec.").append(formattedPropertyName).append("InActingVersion()");

if (null != nullCodecValueOrNull)
Expand All @@ -553,7 +585,7 @@ private void generateRecordPropertyAssignment(
}
}

private void generateEncodeInto(
private void generateMessageEncodeInto(
final StringBuilder sb,
final String codecClassName,
final List<Token> fields,
Expand Down Expand Up @@ -674,7 +706,7 @@ private String nullableConvertedExpression(
final String expression,
final String nullValue)
{
return fieldToken.version() > 0 || fieldToken.isOptionalEncoding() ?
return fieldToken.isOptionalEncoding() ?
expression + " ?? " + nullValue :
expression;
}
Expand Down Expand Up @@ -791,9 +823,19 @@ private void generateVarDataEncodeInto(
if (token.signal() == Signal.BEGIN_VAR_DATA)
{
final String propertyName = token.name();
final String formattedPropertyName = formatPropertyName(propertyName);

if (token.version() > 0)
{
sb.append(indent).append("if (null == ").append(formattedPropertyName).append(")\n")
.append(indent).append("{\n")
.append(indent).append(INDENT).append("throw new System.InvalidOperationException(\"")
.append(formattedPropertyName).append(" must not be null.\");\n")
.append(indent).append("}\n\n");
}

sb.append(indent).append("codec.Set").append(formatPropertyName(propertyName))
.append("(").append(formatPropertyName(propertyName)).append(");\n");
sb.append(indent).append("codec.Set").append(formattedPropertyName)
.append("(").append(formattedPropertyName).append(");\n");
}
}
}
Expand Down Expand Up @@ -1181,7 +1223,8 @@ private void generateVarData(
final String propertyName = token.name();
final Token varDataToken = Generators.findFirst("varData", tokens, i);
final String characterEncoding = varDataToken.encoding().characterEncoding();
final String dtoType = characterEncoding == null ? "byte[]" : "string";
final String nullableSuffix = token.version() > 0 ? "?" : "";
final String dtoType = (characterEncoding == null ? "byte[]" : "string") + nullableSuffix;

final String formattedPropertyName = formatPropertyName(propertyName);

Expand Down
11 changes: 11 additions & 0 deletions sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/CSharpDtosPropertyTest.java
View file
Expand Up @@ -89,6 +89,17 @@ void dtoEncodeShouldBeTheInverseOfDtoDecode(
"SCHEMA:\n" + encodedMessage.schema());
}

final byte[] errorBytes = Files.readAllBytes(stderr);
if (errorBytes.length != 0)
{
throw new AssertionError(
"Process wrote to stderr.\n\n" +
"STDOUT:\n" + new String(Files.readAllBytes(stdout)) + "\n\n" +
"STDERR:\n" + new String(errorBytes) + "\n\n" +
"SCHEMA:\n" + encodedMessage.schema() + "\n\n"
);
}

final byte[] inputBytes = new byte[encodedMessage.length()];
encodedMessage.buffer().getBytes(0, inputBytes);
final byte[] outputBytes = Files.readAllBytes(tempDir.resolve("output.dat"));
Expand Down

0 comments on commit da32de0

Please sign in to comment.