Spector datetime matchers #10011
+1,434
−323
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| changeKind: feature | ||
| packages: | ||
| - "@typespec/spec-api" | ||
| - "@typespec/spector" | ||
| - "@typespec/http-specs" | ||
| --- | ||
|
|
||
| Add matcher framework for flexible value comparison in scenarios. `match.dateTime()` enables semantic datetime comparison that handles precision and timezone differences across languages. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,274 +1,167 @@ | ||
| import { json, match, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api"; | ||
|
|
||
| export const Scenarios: Record<string, ScenarioMockApi> = {}; | ||
|
|
||
| function createQueryServerTests( | ||
| uri: string, | ||
| value: any, | ||
| format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined, | ||
| ) { | ||
| return passOnSuccess({ | ||
| uri, | ||
| method: "get", | ||
| request: { | ||
| query: { value: format ? match.dateTime[format](value) : value }, | ||
| }, | ||
| response: { | ||
| status: 204, | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }); | ||
| } | ||
| Scenarios.Encode_Datetime_Query_default = createQueryServerTests( | ||
| "/encode/datetime/query/default", | ||
| "2022-08-26T18:38:00.000Z", | ||
| "utcRfc3339", | ||
| ); | ||
| Scenarios.Encode_Datetime_Query_rfc3339 = createQueryServerTests( | ||
| "/encode/datetime/query/rfc3339", | ||
| "2022-08-26T18:38:00.000Z", | ||
| "utcRfc3339", | ||
| ); | ||
| Scenarios.Encode_Datetime_Query_rfc7231 = createQueryServerTests( | ||
| "/encode/datetime/query/rfc7231", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| "rfc7231", | ||
| ); | ||
| Scenarios.Encode_Datetime_Query_unixTimestamp = createQueryServerTests( | ||
| "/encode/datetime/query/unix-timestamp", | ||
| "1686566864", | ||
| undefined, | ||
| ); | ||
| Scenarios.Encode_Datetime_Query_unixTimestampArray = createQueryServerTests( | ||
| "/encode/datetime/query/unix-timestamp-array", | ||
| [1686566864, 1686734256].join(","), | ||
| undefined, | ||
| ); | ||
| function createPropertyServerTests( | ||
| uri: string, | ||
| value: any, | ||
| format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined, | ||
| ) { | ||
| const matcherBody = { value: format ? match.dateTime[format](value) : value }; | ||
| return passOnSuccess({ | ||
| uri, | ||
| method: "post", | ||
| request: { | ||
| body: json(matcherBody), | ||
| }, | ||
| response: { | ||
| status: 200, | ||
| body: json(matcherBody), | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }); | ||
| } | ||
| Scenarios.Encode_Datetime_Property_default = createPropertyServerTests( | ||
| "/encode/datetime/property/default", | ||
| "2022-08-26T18:38:00.000Z", | ||
| "utcRfc3339", | ||
| ); | ||
| Scenarios.Encode_Datetime_Property_rfc3339 = createPropertyServerTests( | ||
| "/encode/datetime/property/rfc3339", | ||
| "2022-08-26T18:38:00.000Z", | ||
| "utcRfc3339", | ||
| ); | ||
| Scenarios.Encode_Datetime_Property_rfc7231 = createPropertyServerTests( | ||
| "/encode/datetime/property/rfc7231", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| "rfc7231", | ||
| ); | ||
| Scenarios.Encode_Datetime_Property_unixTimestamp = createPropertyServerTests( | ||
| "/encode/datetime/property/unix-timestamp", | ||
| 1686566864, | ||
| undefined, | ||
| ); | ||
| Scenarios.Encode_Datetime_Property_unixTimestampArray = createPropertyServerTests( | ||
| "/encode/datetime/property/unix-timestamp-array", | ||
| [1686566864, 1686734256], | ||
| undefined, | ||
| ); | ||
| function createHeaderServerTests( | ||
| uri: string, | ||
| value: any, | ||
| format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined, | ||
| ) { | ||
| const matcherHeaders = { value: format ? match.dateTime[format](value) : value }; | ||
| return passOnSuccess({ | ||
| uri, | ||
| method: "get", | ||
| request: { | ||
| headers: matcherHeaders, | ||
| }, | ||
| response: { | ||
| status: 204, | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }); | ||
| } | ||
| Scenarios.Encode_Datetime_Header_default = createHeaderServerTests( | ||
| "/encode/datetime/header/default", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| "rfc7231", | ||
| ); | ||
| Scenarios.Encode_Datetime_Header_rfc3339 = createHeaderServerTests( | ||
| "/encode/datetime/header/rfc3339", | ||
| "2022-08-26T18:38:00.000Z", | ||
| "utcRfc3339", | ||
| ); | ||
| Scenarios.Encode_Datetime_Header_rfc7231 = createHeaderServerTests( | ||
| "/encode/datetime/header/rfc7231", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| "rfc7231", | ||
| ); | ||
| Scenarios.Encode_Datetime_Header_unixTimestamp = createHeaderServerTests( | ||
| "/encode/datetime/header/unix-timestamp", | ||
| 1686566864, | ||
| undefined, | ||
| ); | ||
| Scenarios.Encode_Datetime_Header_unixTimestampArray = createHeaderServerTests( | ||
| "/encode/datetime/header/unix-timestamp-array", | ||
| [1686566864, 1686734256].join(","), | ||
| undefined, | ||
| ); | ||
| function createResponseHeaderServerTests(uri: string, value: any) { | ||
| return passOnSuccess({ | ||
| uri, | ||
| method: "get", | ||
| request: {}, | ||
| response: { | ||
| status: 204, | ||
| headers: { value }, | ||
| }, | ||
| handler: (req: MockRequest) => { | ||
| return { | ||
| status: 204, | ||
| headers: { value }, | ||
| }; | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }); | ||
| } | ||
| Scenarios.Encode_Datetime_ResponseHeader_default = createResponseHeaderServerTests( | ||
| "/encode/datetime/responseheader/default", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| ); | ||
| Scenarios.Encode_Datetime_ResponseHeader_rfc3339 = createResponseHeaderServerTests( | ||
| "/encode/datetime/responseheader/rfc3339", | ||
| "2022-08-26T18:38:00.000Z", | ||
| ); | ||
| Scenarios.Encode_Datetime_ResponseHeader_rfc7231 = createResponseHeaderServerTests( | ||
| "/encode/datetime/responseheader/rfc7231", | ||
| "Fri, 26 Aug 2022 14:38:00 GMT", | ||
| ); | ||
| Scenarios.Encode_Datetime_ResponseHeader_unixTimestamp = createResponseHeaderServerTests( | ||
| "/encode/datetime/responseheader/unix-timestamp", | ||
| "1686566864", | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do these changes belong in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah pr also make base url a matcher which cleans that up