Skip to content

[ResourceNameRestriction] Add test for enums #714

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

Closed
mikeharder wants to merge 1 commit into from
Closed

[ResourceNameRestriction] Add test for enums #714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 74 additions & 2 deletions packages/rulesets/src/spectral/test/resource-names-restriction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ test("ResourceNameRestriction should find errors on path level", () => {
return linter.run(oasDoc).then((results) => {
expect(results.length).toBe(1)
expect(results[0].path.join(".")).toBe(
"paths./subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}"
"paths./subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}",
)
expect(results[0].message).toContain("The resource name parameter 'fooName' should be defined with a 'pattern' restriction.")
})
Expand Down Expand Up @@ -61,7 +61,7 @@ test("ResourceNameRestriction should find errors on operation level", () => {
return linter.run(oasDoc).then((results) => {
expect(results.length).toBe(1)
expect(results[0].path.join(".")).toBe(
"paths./subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}"
"paths./subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}",
)
expect(results[0].message).toContain("The resource name parameter 'fooName' should be defined with a 'pattern' restriction.")
})
Expand Down Expand Up @@ -109,6 +109,78 @@ test("ResourceNameRestriction should find no errors", () => {
})
})

test("ResourceNameRestriction should find no errors for enums", () => {
const oasDoc = {
swagger: "2.0",
paths: {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}": {
parameters: [
{
name: "fooName",
in: "path",
required: true,
type: "string",
enum: ["Foo", "Bar"],
"x-ms-enum": {
name: "FooType",
modelAsString: true,
values: [
{
name: "Foo",
value: "Foo",
description: "Foo",
},
{
name: "Bar",
value: "Bar",
description: "Bar",
},
],
},
},
],
get: {
parameters: [],
responses: {},
},
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/bar/{barName}": {
parameters: [
{
name: "fooName",
in: "path",
required: true,
type: "string",
enum: ["Foo", "Bar"],
"x-ms-enum": {
name: "FooType",
modelAsString: true,
values: [
{
name: "Foo",
value: "Foo",
description: "Foo",
},
{
name: "Bar",
value: "Bar",
description: "Bar",
},
],
},
},
],
get: {
responses: {},
},
},
},
}
return linter.run(oasDoc).then((results) => {
expect(results.length).toBe(0)
})
})

test("ResourceNameRestriction should find no errors for system-defined variables", () => {
const oasDoc = {
swagger: "2.0",
Expand Down