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

Add test for @include over @internal #371

Closed
wants to merge 6 commits into from
Closed

Add test for @include over @internal #371

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
42fb330
Add test for @include over @internal
tadelesh Jul 7, 2023
0b97ec1
review
tadelesh Jul 10, 2023
8893755
fix
tadelesh Jul 10, 2023
74c2561
add nested model test
tadelesh Jul 10, 2023
ead78e6
add doc
tadelesh Jul 10, 2023
137e950
Merge branch 'main' into internal_include
tadelesh Jul 11, 2023
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
5 changes: 5 additions & 0 deletions .changeset/nine-otters-change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@azure-tools/cadl-ranch-specs": patch
---

Add test for @include over @internal
tadelesh marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 18 additions & 0 deletions packages/cadl-ranch-specs/cadl-ranch-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,24 @@ Expected response body:
}
```

### Azure_ClientGenerator_Core_Internal_postInternalOnly

- Endpoint: `post /azure/client-generator-core/internal/internal`

This scenario contains an internal operation. It should be generated but not exposed.
Expected body parameter:

````json
{
"name": <any string>
}
Expected response body:
```json
{
"result": <any string>
}
````

### Azure_ClientGenerator_Core_Internal_publicOnly

- Endpoint: `get /azure/client-generator-core/internal/public`
Expand Down
26 changes: 26 additions & 0 deletions packages/cadl-ranch-specs/http/azure/client-generator-core/internal/main.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ model InternalModel {
name: string;
}

@doc("This is a model only used by internal operation. Also, it is decorated with @include. It should be generated and exported.")
@global.Azure.ClientGenerator.Core.include
model InternaIncludelModel {
tadelesh marked this conversation as resolved.
Show resolved Hide resolved
name: string;
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Jul 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a nested model to also test transitivity?

Or, if we are not sure how transitivity works for @include, I am fine to leave as this.

Copy link
Member Author

@tadelesh tadelesh Jul 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think transitivity should be the work of isInclude (though it seems current TCGC has not implemented it yet). I've created an issue to track.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should figure out this issue now.

}

@doc("This is a model used by both public and internal operation. It should be generated and exported.")
model SharedModel {
name: string;
Expand Down Expand Up @@ -56,6 +62,26 @@ Expected response body:
@global.Azure.ClientGenerator.Core.internal
op internalOnly(@query name: string): InternalModel;

@scenario
@scenarioDoc("""
This scenario contains an internal operation. It should be generated but not exposed.
Expected body parameter:
```json
{
"name": <any string>
}
Expected response body:
```json
{
"result": <any string>
}
```
""")
@route("/internal")
@post
@global.Azure.ClientGenerator.Core.internal
op postInternalOnly(@body body: InternalModel): InternaIncludelModel;
tadelesh marked this conversation as resolved.
Show resolved Hide resolved

@route("/shared")
@global.Azure.ClientGenerator.Core.operationGroup
@scenario
Expand Down
20 changes: 15 additions & 5 deletions packages/cadl-ranch-specs/http/azure/client-generator-core/internal/mockapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";

export const Scenarios: Record<string, ScenarioMockApi> = {};

function createInternalMockApis(route: string): MockApi {
function createInternalGetMockApis(route: string): MockApi {
const url = `/azure/client-generator-core/internal/${route}`;
return mockapi.get(url, (req) => {
if (!("name" in req.query)) {
Expand All @@ -16,9 +16,19 @@ function createInternalMockApis(route: string): MockApi {
});
}

Scenarios.Azure_ClientGenerator_Core_Internal_publicOnly = passOnSuccess(createInternalMockApis("public"));
Scenarios.Azure_ClientGenerator_Core_Internal_internalOnly = passOnSuccess(createInternalMockApis("internal"));
Scenarios.Azure_ClientGenerator_Core_Internal_publicOnly = passOnSuccess(createInternalGetMockApis("public"));
Scenarios.Azure_ClientGenerator_Core_Internal_internalOnly = passOnSuccess(createInternalGetMockApis("internal"));
Scenarios.Azure_ClientGenerator_Core_Internal_Shared = passOnSuccess([
createInternalMockApis("shared/public"),
createInternalMockApis("shared/internal"),
createInternalGetMockApis("shared/public"),
createInternalGetMockApis("shared/internal"),
]);

Scenarios.Azure_ClientGenerator_Core_Internal_postInternalOnly = passOnSuccess(
mockapi.post("/azure/client-generator-core/internal/internal", (req) => {
req.expect.bodyNotEmpty();
return {
status: 200,
body: json({ result: req.body["name"] }),
};
}),
);