Skip to content

Fix GetCollectionResponseSchema false negative #478

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix GetCollectionResponseSchema false negative #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f586c9
Add test for reported false negative
bdefoy Mar 20, 2023
ca0f6a5
Merge branch 'Azure:main' into get-collections-response-schema-false-…
bdefoy Apr 6, 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
7 changes: 7 additions & 0 deletions packages/rulesets/src/native/tests/composite-azure-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ describe("CompositeAzureTests", () => {
assertValidationRuleCount(messages, GetCollectionResponseSchema, 1)
})

test("get collection response schema should match the ARM specification", async () => {
console.log("hello")
const fileName = "armResource/containerApps.json"
const messages: LintResultMessage[] = await collectTestMessagesFromValidator(fileName, OpenApiTypes.arm, GetCollectionResponseSchema)
assertValidationRuleCount(messages, GetCollectionResponseSchema, 0)
})

test("all resources must have get operation", async () => {
const fileName = "armResource/cluster.json"
const messages: LintResultMessage[] = await collectTestMessagesFromValidator(
Expand Down
265 changes: 265 additions & 0 deletions packages/rulesets/src/native/tests/resources/armResource/containerApps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
{
"swagger": "2.0",
"info": {
"version": "2022-11-01-preview",
"title": "ContainerApps API Client"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprResiliencyCircuitBreakerPolicies": {
"get": {
"tags": [
"DaprResiliencyCircuitBreakerPolicies"
],
"summary": "Get the Dapr Resiliency Circuit Breaker Policies for a managed environment.",
"operationId": "DaprResiliencyCircuitBreakerPolicies_List",
"parameters": [
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DaprResiliencyCircuitBreakerPoliciesCollection"
}
},
"default": {
"description": "Common error response.",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Dapr Resiliency Circuit Breaker Policy": {
"name": "./examples/DaprResiliencyCircuitBreakerPolicies_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprResiliencyCircuitBreakerPolicies/{policyName}": {
"get": {
"tags": [
"DaprResiliencyCircuitBreakerPolicies"
],
"summary": "Get a Dapr Resiliency Circuit Breaker policy.",
"operationId": "DaprResiliencyCircuitBreakerPolicies_Get",
"parameters": [
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "policyName",
"in": "path",
"description": "Name of the Dapr resiliency circuit breaker policy.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DaprResiliencyCircuitBreakerPolicy"
}
},
"default": {
"description": "Common error response.",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Dapr Resiliency Circuit Breaker Policy": {
"name": "./examples/DaprResiliencyCircuitBreakerPolicies_Get.json"
}
}
},
"put": {
"tags": [
"DaprResiliencyCircuitBreakerPolicies"
],
"summary": "Creates or updates a Dapr Resiliency Circuit Breaker Policy.",
"description": "Creates or updates a Dapr Resiliency Circuit Breaker Policy in a Managed Environment.",
"operationId": "DaprResiliencyCircuitBreakerPolicies_CreateOrUpdate",
"parameters": [
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "policyName",
"in": "path",
"description": "Name of the Dapr Resiliency Circuit Breaker Policy.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "daprResiliencyCircuitBreakerPoliciesEnvelope",
"in": "body",
"description": "Configuration details of the Dapr Resiliency Circuit Breaker Policy.",
"required": true,
"schema": {
"name": "./CommonDefinitions.json#/definitions/DaprResiliencyCircuitBreakerPolicy"
}
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DaprResiliencyCircuitBreakerPolicy"
}
},
"201": {
"description": "Created",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DaprResiliencyCircuitBreakerPolicy"
}
},
"default": {
"description": "Common error response.",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update Dapr Resiliency Circuit Breaker Policy": {
"name": "./examples/DaprResiliencyCircuitBreakerPolicies_CreateOrUpdate.json"
}
}
},
"delete": {
"tags": [
"DaprResiliencyCircuitBreakerPolicies"
],
"summary": "Delete a Dapr Resiliency Circuit Breaker Policy.",
"description": "Delete a Dapr Resiliency Circuit Breaker Policy from a Managed Environment.",
"operationId": "DaprResiliencyCircuitBreakerPolicies_Delete",
"parameters": [
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "policyName",
"in": "path",
"description": "Name of the Dapr Resiliency Circuit Breaker Policy.",
"required": true,
"pattern": "^.*",
"type": "string"
},
{
"name": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Delete operation completed"
},
"204": {
"description": "Environment does not exist"
},
"default": {
"description": "Common error response.",
"schema": {
"name": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Dapr Resiliency Circuit Breaker Policy": {
"name": "./examples/DaprResiliencyCircuitBreakerPolicies_Delete.json"
}
}
}
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
]
}