add nested test cases for client-initialization #3697
Conversation
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
kazrael2119
requested review from
iscai-msft,
jhendrixMSFT,
joheredi,
lmazuel,
m-nash,
srnagar,
tadelesh and
weidongxu-microsoft
as code owners
Collaborator
|
All changed packages have been documented.
|
commit: |
Collaborator
|
You can try these changes here
|
…/kazrael2119/typespec-azure into nested-test-cases-for-clientinit
kazrael2119
requested review from
bterlson,
markcowl and
timotheeguerin
as code owners
...e-http-specs/specs/azure/client-generator-core/client-initialization/individually/client.tsp
Outdated
Show resolved
Hide resolved
...-specs/specs/azure/client-generator-core/client-initialization/individuallyParent/client.tsp
Outdated
Show resolved
Hide resolved
...e-http-specs/specs/azure/client-generator-core/client-initialization/individually/client.tsp
Show resolved
Hide resolved
...ure-http-specs/specs/azure/client-generator-core/client-initialization/individually/main.tsp
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request refactors the client-initialization test cases from a flat structure into a nested directory structure, adding comprehensive test coverage for different client initialization patterns. The changes address issue #3405 by organizing test scenarios into three distinct categories: default, individually, and individuallyParent initialization behaviors.
Changes:
- Removed the monolithic
mockapi.tsfile and reorganized test cases into three subdirectories - Added new test scenarios for individually-initialized and individually-parent-initialized clients
- Updated routing paths and namespace definitions to reflect the new nested structure
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/mockapi.ts | Deleted the original flat mockapi.ts file |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/default/mockapi.ts | Created mock API definitions for default client initialization scenarios |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/default/main.tsp | Added service interface definitions for default initialization patterns |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/default/client.tsp | Defined client interfaces with default initialization behavior, including new QueryParam scenario |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individually/mockapi.ts | Created mock API definitions for individually-initialized client scenarios |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individually/main.tsp | Added service interface definitions for individual initialization patterns |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individually/client.tsp | Defined client interfaces with individually initialization behavior |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individuallyParent/mockapi.ts | Created mock API definitions for individually-parent-initialized client scenarios |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individuallyParent/main.tsp | Added service interface definitions for individually-parent initialization patterns |
| packages/azure-http-specs/specs/azure/client-generator-core/client-initialization/individuallyParent/client.tsp | Defined client interfaces with both individual and parent initialization behavior (incomplete - missing ParamAlias scenario) |
| .chronus/changes/nested-test-cases-for-clientinit-2025-11-25-9-26-9.md | Added changelog entry documenting the fix |
| request: { | ||
| query: { | ||
| blobName: "test-blob", | ||
| format: "text", |
There was a problem hiding this comment.
The mock API expects both blobName and format query parameters in the delete request, but the TypeSpec definition for deleteStandalone only specifies ...DefaultQueryParam (which only includes blobName). The format parameter should either be added to the TypeSpec definition or removed from the mock API request.
Suggested change
| format: "text", |
Comment on lines
+248
to
+270
|
|
||
| // Mock responses for IndividuallyParentNestedWithParamAliasClient scenario | ||
| Scenarios.Azure_ClientGenerator_Core_ClientInitialization_IndividuallyParentClient_IndividuallyParent_IndividuallyParentNestedWithParamAliasClient = | ||
| passOnSuccess([ | ||
| { | ||
| uri: "/azure/client-generator-core/client-initialization/individually-parent/nested-default-individually-parent-param-alias/sample-blob/with-aliased-name", | ||
| method: "get", | ||
| request: {}, | ||
| response: { | ||
| status: 204, | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }, | ||
| { | ||
| uri: "/azure/client-generator-core/client-initialization/individually-parent/nested-default-individually-parent-param-alias/sample-blob/with-original-name", | ||
| method: "get", | ||
| request: {}, | ||
| response: { | ||
| status: 204, | ||
| }, | ||
| kind: "MockApiDefinition", | ||
| }, | ||
| ]); |
There was a problem hiding this comment.
A mock API scenario is defined for IndividuallyParentNestedWithParamAliasClient but there is no corresponding client interface definition in the client.tsp file. This scenario needs to be added to match the mock API and main.tsp service interface NestedDefaultIndividuallyParentParamAlias.
Suggested change
| // Mock responses for IndividuallyParentNestedWithParamAliasClient scenario | |
| Scenarios.Azure_ClientGenerator_Core_ClientInitialization_IndividuallyParentClient_IndividuallyParent_IndividuallyParentNestedWithParamAliasClient = | |
| passOnSuccess([ | |
| { | |
| uri: "/azure/client-generator-core/client-initialization/individually-parent/nested-default-individually-parent-param-alias/sample-blob/with-aliased-name", | |
| method: "get", | |
| request: {}, | |
| response: { | |
| status: 204, | |
| }, | |
| kind: "MockApiDefinition", | |
| }, | |
| { | |
| uri: "/azure/client-generator-core/client-initialization/individually-parent/nested-default-individually-parent-param-alias/sample-blob/with-original-name", | |
| method: "get", | |
| request: {}, | |
| response: { | |
| status: 204, | |
| }, | |
| kind: "MockApiDefinition", | |
| }, | |
| ]); |
Member
|
I've requested Copilot review. If comment is not valid, feel free to resolve them. |
qiaozha
reviewed
Jan 14, 2026
| blobName: string; | ||
| } | ||
|
|
||
| model DefaultQueryParamClientOptions { |
Member
There was a problem hiding this comment.
wonder why do we need Default prefix here but not for other ClientOptions?
| name: string; | ||
| } | ||
|
|
||
| model DefaultQueryParam { |
| @global.Azure.ClientGenerator.Core.clientInitialization({ | ||
| parameters: DefaultQueryParamClientOptions, | ||
| }) | ||
| @route("/query") |
| ``` | ||
| """) | ||
| @scenario | ||
| @global.Azure.ClientGenerator.Core.client({ |
Member
There was a problem hiding this comment.
Can we use @@global.Azure.ClientGenerator.Core.client(Service.QueryParam, {name: "QueryParamClient", service: Service})?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
fixes Azure/autorest.typescript#3405