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.

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 spread test cases #247

Merged
merged 21 commits into from
Apr 18, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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/four-geckos-act.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@azure-tools/cadl-ranch-specs": patch
---

Add test case for spread operator
87 changes: 87 additions & 0 deletions packages/cadl-ranch-specs/cadl-ranch-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2454,6 +2454,93 @@ Expected input body:
}
```

### Spread_spreadModelAsRequestBody

- Endpoint: `put /spread/model/request-body`

Test case for spread named model. Should generate request body model named ModelBodyParameter.

Expected request body:

```json
{ "name": "foo" }
```

### Spread_spreadModelAsRequestParameter

- Endpoint: `put /spread/model/request-parameter/{id}`

Test case for spread named model with path and header parameter.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:

```json
{ "name": "foo" }
```

### Spread_spreadAliasAsRequestBody

- Endpoint: `put /spread/alias/request-body`

Test case for spread alias.

Expected request body:

```json
{ "name": "foo" }
```

### Spread_spreadAliasAsRequestParameter

- Endpoint: `put /spread/alias/request-parameter/{id}`

Test case for spread alias with path and header parameter.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:

```json
{ "name": "foo" }
```

### Spread_spreadAliasWithMultipleParameters

- Endpoint: `put /spread/alias/multiple-parameters/{id}`

Test case for spread alias including 6 parameters. May handle as property bag for these parameters.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:

```json
{
"prop1": "foo1",
"prop2": "foo2",
"prop3": "foo3",
"prop4": "foo4",
"prop5": "foo5",
"prop6": "foo6"
}
```

### Spread_spreadAliasNestedSpreadModelParameter

- Endpoint: `put /spread/alias/nested-spread-parameter/{id}`

Test case for spread alias with nested spread model as body parameter.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:

```json
{ "name": "foo" }
```

### Unions_sendInt

- Endpoint: `post /unions/int`
Expand Down
158 changes: 158 additions & 0 deletions packages/cadl-ranch-specs/http/spread/main.tsp
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
import "@typespec/http";
import "@azure-tools/cadl-ranch-expect";

using TypeSpec.Http;

@doc("Test for the spread operator.")
@supportedBy("dpg")
@scenarioService("/spread")
namespace Spread;
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

@doc("This is a simple model.")
model ModelBodyParameter {
name: string;
}

@scenario
@scenarioDoc("""
Test case for spread named model. Should generate request body model named ModelBodyParameter.
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

Expected request body:
```json
{ "name": "foo" }
```
""")
@route("/model/request-body")
@put
op spreadModelAsRequestBody(...ModelBodyParameter): OkResponse;
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

@doc("This is a simple model including path parameter.")
model ModelRequestParamter {
@path
id: string;

@header
`x-ms-test-header`: string;
name: string;
}

@scenario
@scenarioDoc("""
Test case for spread named model with path and header parameter.
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:
```json
{ "name": "foo" }
```
""")
@route("/model/request-parameter/{id}")
@put
op spreadModelAsRequestParameter(...ModelRequestParamter): OkResponse;

alias AliasBodyParameter = {
name: string;
};

@scenario
@scenarioDoc("""
Test case for spread alias.
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

Expected request body:
```json
{ "name": "foo" }
```
""")
@route("/alias/request-body")
@put
op spreadAliasAsRequestBody(...AliasBodyParameter): OkResponse;

alias AliasRequestParameter = {
@path
id: string;

@header
`x-ms-test-header`: string;
name: string;
};

@scenario
@scenarioDoc("""
Test case for spread alias with path and header parameter.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:
```json
{ "name": "foo" }
```
""")
@route("/alias/request-parameter/{id}")
@put
op spreadAliasAsRequestParameter(...AliasRequestParameter): OkResponse;
Copy link
Member

@lmazuel lmazuel Apr 3, 2023

Choose a reason for hiding this comment

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

This scenario is ok, this is not a quantum model since this is an alias.

In spirit, should generate something like:

void spreadAliasAsRequestParameter(id: string, x_ms_test_header: string, name: string)


alias AliasMultipleRequestParameters = {
@path
id: string;

@header
`x-ms-test-header`: string;
prop1: string;
prop2: string;
prop3: string;
prop4: string;
prop5: string;
prop6: string;
};

@scenario
@scenarioDoc("""
Test case for spread alias including 6 parameters. May handle as property bag for these parameters.

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:
```json
{
"prop1":"foo1",
"prop2":"foo2",
"prop3":"foo3",
"prop4":"foo4",
"prop5":"foo5",
"prop6":"foo6"
}
```
""")
@route("/alias/multiple-parameters/{id}")
@put
op spreadAliasWithMultipleParameters(...AliasMultipleRequestParameters): OkResponse;
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

@doc("This is a simple model.")
model ModelParameter {
name: string;
}

alias AliasNestedSpreadParameter = {
@path
id: string;

@header
`x-ms-test-header`: string;
...ModelParameter;
chunyu3 marked this conversation as resolved.
Show resolved Hide resolved
};

@scenario
@scenarioDoc("""
Test case for spread alias with nested spread model as body parameter.
MaryGao marked this conversation as resolved.
Show resolved Hide resolved

Expected path parameter: id="1"
Expected header parameter: x-ms-test-header="bar"
Expected request body:
```json
{ "name": "foo" }
```
""")
@route("/alias/nested-spread-parameter/{id}")
@put
op spreadAliasNestedSpreadModelParameter(...AliasNestedSpreadParameter): OkResponse;
57 changes: 57 additions & 0 deletions packages/cadl-ranch-specs/http/spread/mockapi.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { passOnSuccess, mockapi } from "@azure-tools/cadl-ranch-api";
import { ScenarioMockApi } from "@azure-tools/cadl-ranch-api";

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

Scenarios.Spread_spreadModelAsRequestBody = passOnSuccess(
mockapi.put("/spread/model/request-body", (req) => {
req.expect.bodyEquals({ name: "foo" });
return { status: 200 };
}),
);

Scenarios.Spread_spreadModelAsRequestParameter = passOnSuccess(
mockapi.put("/spread/model/request-parameter/1", (req) => {
req.expect.containsHeader("x-ms-test-header", "bar");
req.expect.bodyEquals({ name: "foo" });
return { status: 200 };
}),
);

Scenarios.Spread_spreadAliasAsRequestBody = passOnSuccess(
mockapi.put("/spread/alias/request-body", (req) => {
req.expect.bodyEquals({ name: "foo" });
return { status: 200 };
}),
);

Scenarios.Spread_spreadAliasAsRequestParameter = passOnSuccess(
mockapi.put("/spread/alias/request-parameter/1", (req) => {
req.expect.containsHeader("x-ms-test-header", "bar");
req.expect.bodyEquals({ name: "foo" });
return { status: 200 };
}),
);

Scenarios.Spread_spreadAliasWithMultipleParameters = passOnSuccess(
mockapi.put("/spread/alias/multiple-parameters/1", (req) => {
req.expect.containsHeader("x-ms-test-header", "bar");
req.expect.bodyEquals({
prop1: "foo1",
prop2: "foo2",
prop3: "foo3",
prop4: "foo4",
prop5: "foo5",
prop6: "foo6",
});
return { status: 200 };
}),
);

Scenarios.Spread_spreadAliasNestedSpreadModelParameter = passOnSuccess(
mockapi.put("/spread/alias/nested-spread-parameter/1", (req) => {
req.expect.containsHeader("x-ms-test-header", "bar");
req.expect.bodyEquals({ name: "foo" });
return { status: 200 };
}),
);