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.

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

Jump to bottom

Fix protocol test: RestJsonMalformedPatternSensitiveString #2321

Merged
merged 8 commits into from
Feb 7, 2023
Merged

Fix protocol test: RestJsonMalformedPatternSensitiveString #2321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
98c5804
Make `RestJsonMalformedPatternSensitiveString` pass
jjant Feb 7, 2023
68d7040
Use `AwsJson11` variable instead of hardcoded string
jjant Feb 7, 2023
1629588
Refactor `errorMessage` into private function
jjant Feb 7, 2023
9874e0a
Add comment about remaining `@range` on floats tests
jjant Feb 7, 2023
b3d6b34
Use `AwsJson11` variable instead of hardcoded string (missed one)
jjant Feb 7, 2023
9dd8ed0
Use `hasTrait` over `getTrait() != null`
jjant Feb 7, 2023
c5a6a53
Merge branch 'main' into jjant/fix-protocol-tests
jjant Feb 7, 2023
498b177
Merge branch 'main' into jjant/fix-protocol-tests
LukeMathWalker Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 0 additions & 12 deletions ...n/software/amazon/smithy/rust/codegen/server/smithy/PatternTraitValidationErrorMessage.kt
View file
Open in desktop

This file was deleted.

46 changes: 37 additions & 9 deletions ...oftware/amazon/smithy/rust/codegen/server/smithy/generators/ConstrainedStringGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import software.amazon.smithy.model.shapes.Shape
import software.amazon.smithy.model.shapes.StringShape
import software.amazon.smithy.model.traits.LengthTrait
import software.amazon.smithy.model.traits.PatternTrait
import software.amazon.smithy.model.traits.SensitiveTrait
import software.amazon.smithy.model.traits.Trait
import software.amazon.smithy.rust.codegen.core.rustlang.Attribute
import software.amazon.smithy.rust.codegen.core.rustlang.RustType
Expand All @@ -22,13 +23,15 @@ import software.amazon.smithy.rust.codegen.core.rustlang.join
import software.amazon.smithy.rust.codegen.core.rustlang.render
import software.amazon.smithy.rust.codegen.core.rustlang.rust
import software.amazon.smithy.rust.codegen.core.rustlang.rustTemplate
import software.amazon.smithy.rust.codegen.core.rustlang.writable
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType
import software.amazon.smithy.rust.codegen.core.smithy.expectRustMetadata
import software.amazon.smithy.rust.codegen.core.smithy.makeMaybeConstrained
import software.amazon.smithy.rust.codegen.core.smithy.module
import software.amazon.smithy.rust.codegen.core.smithy.testModuleForShape
import software.amazon.smithy.rust.codegen.core.testutil.unitTest
import software.amazon.smithy.rust.codegen.core.util.PANIC
import software.amazon.smithy.rust.codegen.core.util.hasTrait
import software.amazon.smithy.rust.codegen.core.util.orNull
import software.amazon.smithy.rust.codegen.core.util.redactIfNecessary
import software.amazon.smithy.rust.codegen.server.smithy.PubCrateConstraintViolationSymbolProvider
Expand Down Expand Up @@ -63,7 +66,7 @@ class ConstrainedStringGenerator(
private val constraintsInfo: List<TraitInfo> =
supportedStringConstraintTraits
.mapNotNull { shape.getTrait(it).orNull() }
.map { StringTraitInfo.fromTrait(symbol, it) }
.map { StringTraitInfo.fromTrait(symbol, it, isSensitive = shape.hasTrait<SensitiveTrait>()) }
.map(StringTraitInfo::toTraitInfo)

fun render() {
Expand Down Expand Up @@ -184,6 +187,7 @@ class ConstrainedStringGenerator(
}
}
}

private data class Length(val lengthTrait: LengthTrait) : StringTraitInfo() {
override fun toTraitInfo(): TraitInfo = TraitInfo(
tryFromCheck = { rust("Self::check_length(&value)?;") },
Expand Down Expand Up @@ -229,10 +233,9 @@ private data class Length(val lengthTrait: LengthTrait) : StringTraitInfo() {
}
}

private data class Pattern(val symbol: Symbol, val patternTrait: PatternTrait) : StringTraitInfo() {
private data class Pattern(val symbol: Symbol, val patternTrait: PatternTrait, val isSensitive: Boolean) :
StringTraitInfo() {
override fun toTraitInfo(): TraitInfo {
val pattern = patternTrait.pattern

return TraitInfo(
tryFromCheck = { rust("let value = Self::check_pattern(value)?;") },
constraintViolationVariant = {
Expand All @@ -241,13 +244,14 @@ private data class Pattern(val symbol: Symbol, val patternTrait: PatternTrait) :
rust("Pattern(String)")
},
asValidationExceptionField = {
rust(
rustTemplate(
"""
Self::Pattern(string) => crate::model::ValidationExceptionField {
message: format!("${patternTrait.validationErrorMessage()}", &string, &path, r##"$pattern"##),
Self::Pattern(_string) => crate::model::ValidationExceptionField {
message: #{ErrorMessage:W},
path
},
""",
"ErrorMessage" to errorMessage(),
)
},
this::renderValidationFunction,
Expand All @@ -264,6 +268,28 @@ private data class Pattern(val symbol: Symbol, val patternTrait: PatternTrait) :
)
}

private fun errorMessage(): Writable {
val pattern = patternTrait.pattern

return if (isSensitive) {
writable {
rust(
"""
format!("Value at '{}' failed to satisfy constraint: Member must satisfy regular expression pattern: {}", &path, r##"$pattern"##)
""",
)
}
} else {
writable {
rust(
"""
format!("Value {} at '{}' failed to satisfy constraint: Member must satisfy regular expression pattern: {}", &_string, &path, r##"$pattern"##)
""",
)
}
}
}

/**
* Renders a `check_pattern` function to validate the string matches the
* supplied regex in the `@pattern` trait.
Expand Down Expand Up @@ -303,14 +329,16 @@ private data class Pattern(val symbol: Symbol, val patternTrait: PatternTrait) :

private sealed class StringTraitInfo {
companion object {
fun fromTrait(symbol: Symbol, trait: Trait) =
fun fromTrait(symbol: Symbol, trait: Trait, isSensitive: Boolean) =
when (trait) {
is PatternTrait -> {
Pattern(symbol, trait)
Pattern(symbol, trait, isSensitive)
}

is LengthTrait -> {
Length(trait)
}

else -> PANIC("StringTraitInfo.fromTrait called with unsupported trait $trait")
}
}
Expand Down
20 changes: 7 additions & 13 deletions ...azon/smithy/rust/codegen/server/smithy/generators/protocol/ServerProtocolTestGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -774,13 +774,12 @@ class ServerProtocolTestGenerator(

FailingTest(RestJson, "RestJsonWithBodyExpectsApplicationJsonContentType", TestType.MalformedRequest),

// Tests involving constraint traits, which are not yet fully implemented.
// See https://github.com/awslabs/smithy-rs/issues/1401.
// Tests involving `@range` on floats.
// Pending resolution from the Smithy team, see https://github.com/awslabs/smithy-rs/issues/2007.
FailingTest(RestJsonValidation, "RestJsonMalformedRangeFloat_case0", TestType.MalformedRequest),
FailingTest(RestJsonValidation, "RestJsonMalformedRangeFloat_case1", TestType.MalformedRequest),
FailingTest(RestJsonValidation, "RestJsonMalformedRangeMaxFloat", TestType.MalformedRequest),
FailingTest(RestJsonValidation, "RestJsonMalformedRangeMinFloat", TestType.MalformedRequest),
FailingTest(RestJsonValidation, "RestJsonMalformedPatternSensitiveString", TestType.MalformedRequest),

// See https://github.com/awslabs/smithy-rs/issues/1969
FailingTest(MalformedRangeValidation, "RestJsonMalformedRangeShortOverride_case0", TestType.MalformedRequest),
Expand Down Expand Up @@ -872,16 +871,11 @@ class ServerProtocolTestGenerator(
FailingTest("aws.protocoltests.json10#JsonRpc10", "AwsJson10EndpointTrait", TestType.Request),

// AwsJson1.1 failing tests.
FailingTest("aws.protocoltests.json#JsonProtocol", "AwsJson11EndpointTraitWithHostLabel", TestType.Request),
FailingTest("aws.protocoltests.json#JsonProtocol", "AwsJson11EndpointTrait", TestType.Request),
FailingTest("aws.protocoltests.json#JsonProtocol", "parses_httpdate_timestamps", TestType.Response),
FailingTest("aws.protocoltests.json#JsonProtocol", "parses_iso8601_timestamps", TestType.Response),
FailingTest(
"aws.protocoltests.json#JsonProtocol",
"parses_the_request_id_from_the_response",
TestType.Response,
),

FailingTest(AwsJson11, "AwsJson11EndpointTraitWithHostLabel", TestType.Request),
FailingTest(AwsJson11, "AwsJson11EndpointTrait", TestType.Request),
FailingTest(AwsJson11, "parses_httpdate_timestamps", TestType.Response),
FailingTest(AwsJson11, "parses_iso8601_timestamps", TestType.Response),
FailingTest(AwsJson11, "parses_the_request_id_from_the_response", TestType.Response),
)
private val RunOnly: Set<String>? = null

Expand Down