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

Create tsp, migrate test-proxy swagger to tsp #9451

Merged
merged 9 commits into from
Dec 4, 2024
+1,536 −474
Merged

Create tsp, migrate test-proxy swagger to tsp #9451

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
718edd0
update the existing start and stop playback routes. add removeSanitiz…
scbedd Dec 3, 2024
30beefa
update existing to unblock heath
scbedd Dec 3, 2024
6320ac0
delete existing swagger file. add typespec for test-proxy
scbedd Dec 3, 2024
212ba9a
add discriminator-based handling for SanitizerAddition[]
scbedd Dec 4, 2024
14f97e5
small update to the exception coming back from test-proxy. also addin…
scbedd Dec 4, 2024
f7ea6e9
add tsp test steps to the build
scbedd Dec 4, 2024
e774739
remove extra spaces
scbedd Dec 4, 2024
fb834bc
fix removesanitizers return type
scbedd Dec 4, 2024
0629788
install the tooling properly
scbedd Dec 4, 2024
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
250 changes: 208 additions & 42 deletions tools/test-proxy/swagger/testproxy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "Test Proxy",
"version": "2021-11",
"version": "2024-11",
"description": "The Test Proxy is used to record and playback live tests."
},
"schemes": [
Expand All @@ -20,10 +20,17 @@
"parameters": [
{
"name": "x-recording-file",
"in": "header",
"in": "body",
"description": "File location of the recording.",
"required": true,
"type": "string"
},
{
"name": "x-recording-assets-file",
"in": "body",
"description": "File location of assets.json location associated with the recording (if one exists).",
"required": false,
"type": "string"
}
],
"responses": {
Expand All @@ -43,11 +50,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand Down Expand Up @@ -76,11 +80,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand All @@ -97,10 +98,17 @@
"parameters": [
{
"name": "x-recording-file",
"in": "header",
"in": "body",
"description": "File location of the recording.",
"required": true,
"type": "string"
},
{
"name": "x-recording-assets-file",
"in": "body",
"description": "File location of assets.json location associated with the recording (if one exists).",
"required": false,
"type": "string"
}
],
"responses": {
Expand All @@ -115,11 +123,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand Down Expand Up @@ -163,13 +168,106 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/admin/RemoveSanitizers": {
"post": {
"summary": "Remove a set of sanitizers from the session or a specific recording.",
"description": "Remove a set of sanitizers from the session or a specific recording. If the recording id is not provided, the session-level sanitizers will be removed.",
"operationId": "TestProxy_RemoveSanitizers",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "x-recording-id",
"in": "header",
"description": "The recording ID. If not provided, the session-level sanitizers will be removed.",
"required": false,
"type": "string"
},
{
"name": "Sanitizers",
"in": "body",
"description": "Set of sanitizerIds that should be removed.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"Removed": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"default": {
"description": "An error response received from the Test Proxy.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/admin/SetRecordingOptions": {
"summary": "Set recording options for a test",
"description": "Sets one or multiple customizations for the recording. See https://github.com/Azure/azure-sdk-tools/blob/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy/README.md#recording-options.",
"operationId": "TestProxy_SetRecordingOptions",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "x-recording-id",
"in": "header",
"description": "The recording ID.If not provided, the customizations will be applied to the session.",
"required": true,
"type": "string"
},
{
"name": "variables",
"in": "body",
"description": "Variables for the recording.",
"required": true,
"schema": {
"$ref": "#/definitions/RecordingOptions"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "An error response received from the Test Proxy.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
Expand Down Expand Up @@ -220,11 +318,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand Down Expand Up @@ -275,11 +370,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand Down Expand Up @@ -330,11 +422,8 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
Expand Down Expand Up @@ -373,18 +462,37 @@
},
"default": {
"description": "An error response received from the Test Proxy.",
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code for specific error that occurred."
}
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"ErrorResponse": {
"type": "object",
"description": "Error response received from the Test Proxy.",
"properties": {
"Status": {
"type": "integer",
"description": "The HTTP status code."
},
"Message": {
"type": "string",
"description": "The error message."
},
"StackTrace": {
"type": "string",
"description": "The stack trace of the error. This is optional and may not be present on a well-understood error."
}
},
"required": [
"Status",
"Message"
]
},
"SanitizerType": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -446,6 +554,64 @@
"regex"
]
},
"Certificate": {
"type": "object",
"description": "A certificate to be used for TLS validation.",
"properties": {
"PemValue": {
"type": "string"
},
"PemKey": {
"type": "string"
}
},
"required": [
"PemValue",
"PemKey"
]
},
"TransportCustomizations": {
"type": "object",
"description": "Customizations for the transpot layer of the testproxy. Either for a specific recording or all recordings after this point.",
"properties": {
"AllowAutoRedirect": {
"type": "boolean"
},
"TLSValidationCert": {
"type": "string"
},
"TLSValidationCertHost": {
"type": "string"
},
"Certificates": {
"type": "array",
"items": {
"$ref": "#/definitions/Certificate"
}
},
"PlaybackResponseTime": {
"type": "integer"
}
}
},
"RecordingOptions": {
"type": "object",
"description": "Options for recording a test.",
"properties": {
"HandleRedirects": {
"type": "boolean"
},
"ContextDirectory": {
"type": "string"
},
"AssetsStore": {
"type": "string"
},
"Transport": {
"$ref": "#/definitions/TransportCustomizations"
}
}
},
"HeaderRegexSanitizer": {
"type": "object",
"description": "Sanitizer for a request header",
Expand Down
Loading