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

[sdk-testgen] change sdk-testgen manager from rushjs to npm #9072

Merged
merged 20 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 19 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
15 changes: 0 additions & 15 deletions eng/pipelines/templates/steps/sdk-testgen-set-env.yml

This file was deleted.

2 changes: 2 additions & 0 deletions tools/sdk-testgen/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
registry=https://registry.npmjs.org/
always-auth=false
235 changes: 200 additions & 35 deletions tools/sdk-testgen/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,200 @@
# AutoRest SDK Test Generation Tools
<hr>

## Packages

| Name | Changelog | Latest |
| ----------------------------------------------- | ------------------------------- | ------------------------------------------------------------ |
| [@autorest/testmodeler][testmodeler_src] | [Changelog][testmodeler_chg] | ![](https://img.shields.io/npm/v/@autorest/testmodeler) |
| [@autorest/gotest][gotest_src] | [Changelog][gotest_chg] | ![](https://img.shields.io/npm/v/@autorest/gotest) |

[testmodeler_src]: packages/autorest.testmodeler
[gotest_src]: packages/autorest.gotest

[testmodeler_chg]: packages/autorest.testmodeler/CHANGELOG.md
[gotest_chg]: packages/autorest.gotest/CHANGELOG.md

## Contributing

For instructions on cloning/building/etc, see [Development](docs/development.md)

### Contributor License Agreement Requirements

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

### Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
# AutoRest SDK Test Generation Tools
<hr>

## Packages

| Name | Changelog | Latest |
| ----------------------------------------------- | ------------------------------- | ------------------------------------------------------------ |
| [@autorest/testmodeler][testmodeler_src] | [Changelog][testmodeler_chg] | ![](https://img.shields.io/npm/v/@autorest/testmodeler) |
| [@autorest/gotest][gotest_src] | [Changelog][gotest_chg] | ![](https://img.shields.io/npm/v/@autorest/gotest) |

[testmodeler_src]: packages/autorest.testmodeler
[gotest_src]: packages/autorest.gotest

[testmodeler_chg]: packages/autorest.testmodeler/CHANGELOG.md
[gotest_chg]: packages/autorest.gotest/CHANGELOG.md

## Contributing

For instructions on cloning/building/etc, see [Development](docs/development.md)

### Contributor License Agreement Requirements

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

### Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.


# Autorest Extension for Test Modeler

Generate \*.md config files in Azure REST API specification:

https://github.com/Azure/azure-rest-api-specs

## How to Generate Test Model

```
autorest --version=3.7.3 --use=<test model extension> --output-folder=<RP package path> --testmodeler.export-codemodel --clear-output-folder=false --debug <RP config md file path>
```

## Contribution

The testmodeler use rush managing the projects. So if there is changes on package.json, remember to execute `rush update` updated.
~~~
> rush update
~~~

## Configurations

Below are options can be used for autorest.testmodeler

### --debug

Generate modeler files in [output-foler]/\_\_debuger for debug purpose.

### --testmodeler.mock.send-example-id

In generated mock test, send swagger example-id to mock service host in each request. This implicitly ask the mock service host to verify request body by swagger example content. Default true.

### --testmodeler.mock.verify-response

In generated mock test, response value will be verified with the example files. Default true.

### --testmodeler.mock.disabled-examples

This is an array parameter can be assigned in autorest readme file.
For instance, examples Extensions_Get and Extensions_Delete will not be used in mock test generation with below configuration.

```
testmodeler:
mock:
disabled-examples:
- Extensions_Get
- Extensions_Delete
```

### --testmodeler.scenario.variable-defaults.location

Set location used in scenario test, for instance:

```
testmodeler:
scenario:
variable-defaults:
location: eastus
```

### --testmodeler.scenario.codemodel-restcall-only

If there is no 'test-resources' defined in readme file and the readme is located in local file system, testmodeler will search all available api-scenario and try to load them as test scenario.
In this context, option codemodel-restcall-only defined whether testmodeler abandon api-scenarios who contains restcall steps that can't be linked to an operation in codemodel.

The default value of this option is true.

### --testmodeler.use-example-model

This option switch whether ExampleModel in generated in test model. While default to be true, it can be disabled like below:
```
testmodeler:
use-example-model: false
```

### --testmodeler.add-armtemplate-payload-string

This option switch whether StepArmTemplateModel.armTemplatePayloadString is added into testmodeler. While default to be false, it can be enabled like below:
```
testmodeler:
add-armtemplate-payload-string: true
```

### --testmodeler.api-scenario-loader-option

The api-scenarios are loaded from the autorest input-files by default. This option provide a gate to load api-scenario from other remote/branch/commit.
This option are passed through directly to oav scenario loader, refer to https://github.com/Azure/oav/blob/develop/lib/apiScenario/apiScenarioLoader.ts#L60 for more detail of it. A sample for this option:
```
testmodeler:
api-scenario-loader-option:
fileRoot: https://github.com/Azure/azure-rest-api-specs/blob/eb829ed4739fccb03dd2327b7762392e74c80ae4/specification/appplatform/resource-manager
swaggerFilePaths:
- 'Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json'
```

### --test-resources

The list of api-scenarios want to get loaded into testmodeler. Below is a sample:
```
test-resources:
- test: Microsoft.AppPlatform/preview/2020-11-01-preview/scenarios/Spring.yaml
```

### --testmodeler.export-explicit-type

Whether to export codemodel with tags on primitive types, default as false. Demonstrate on the output values:
```
// with primitive types:
isDataAction: !!bool false
count: !!int 64


// with no types:
isDataAction: false
count: 64
```

### --testmodeler.explicit-types

A list for types need to explicitly tagged when export-explicit-type is true. The default explicitTypes are ['bool', 'int', 'float', 'timestamp']. Test generators can change it like below:

```
testmodeler:
explicit-types:
- bool
- int
- float
```

## Autorest Pipeline Configurations

```yaml
clear-output-folder: false

try-require:
- ./readme.test.md
- ./readme.testmodeler.md

version: 3.9.7

use-extension:
"@autorest/modelerfour" : "4.25.0"

pipeline:
test-modeler:
input: modelerfour/identity
output-artifact: source-file-test-modeler
testmodeler/emitter:
input: test-modeler
scope: scope-testmodeler/emitter

scope-testmodeler/emitter:
input-artifact:
- source-file-test-modeler
output-uri-expr: $key

testmodeler:
split-parents-value: true
```

```yaml $(debug)
testmodeler:
export-codemodel: true
```
Loading