ARM: add arm-resource-name-pattern rule to allow disabling LintDiff ResourceNamePattern rule
#359
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| # Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking | ||
| changeKind: feature | ||
| packages: | ||
| - "@azure-tools/typespec-azure-resource-manager" | ||
| --- | ||
|
|
||
| ARM: add `arm-resource-name-pattern` rule to allow disabling LintDiff `ResourceNamePattern` rule |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: resource-name-pattern | ||
| --- | ||
|
|
||
| ```text title=- Full name- | ||
| @azure-tools/typespec-azure-resource-manager/resource-name-pattern | ||
| ``` | ||
|
|
||
| Resource names must specify a pattern string using `@pattern`, providing a regular expression that the name must match. | ||
|
|
||
| #### ❌ Incorrect | ||
|
|
||
| ```tsp | ||
| model Employee is ProxyResource<{}> { | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
| ``` | ||
|
|
||
| #### ✅ Correct | ||
|
|
||
| ```tsp | ||
| model Employee is ProxyResource<{}> { | ||
| @pattern("^[a-zA-Z0-9-]{3,24}$") | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| import { | ||
| DiagnosticTarget, | ||
| Program, | ||
| SourceLocation, | ||
| createRule, | ||
| defineCodeFix, | ||
| getPattern, | ||
| getSourceLocation, | ||
| } from "@typespec/compiler"; | ||
|
|
||
| import { getArmResources } from "../resource.js"; | ||
|
|
||
| // TODO: Replace this with a reusable implementation from the compiler package when implemented. | ||
| // Issue: https://github.com/microsoft/typespec/issues/3044 | ||
| function createPatternCodeFix(diagnosticTarget: DiagnosticTarget) { | ||
| return defineCodeFix({ | ||
| id: "add-pattern-decorator", | ||
| label: "Add `@pattern` decorator to the resource name property with the default ARM pattern.", | ||
| fix: (context) => { | ||
| const location = getSourceLocation(diagnosticTarget); | ||
| const { lineStart, indent } = findLineStartAndIndent(location); | ||
| const updatedLocation = { ...location, pos: lineStart }; | ||
| return context.prependText(updatedLocation, `${indent}@pattern(/^[a-zA-Z0-9-]{3,24}$/)\n`); | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| function findLineStartAndIndent(location: SourceLocation): { lineStart: number; indent: string } { | ||
| const text = location.file.text; | ||
| let pos = location.pos; | ||
| let indent = 0; | ||
| while (pos > 0 && text[pos - 1] !== "\n") { | ||
| if ([" ", "\t", "\n"].includes(text[pos - 1])) { | ||
| indent++; | ||
| } else { | ||
| indent = 0; | ||
| } | ||
| pos--; | ||
| } | ||
| return { lineStart: pos, indent: location.file.text.slice(pos, pos + indent) }; | ||
| } | ||
|
|
||
| /** | ||
| * Verify that a delete operation only | ||
| */ | ||
| export const armResourceNamePatternRule = createRule({ | ||
| name: "arm-resource-name-pattern", | ||
| severity: "warning", | ||
| url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/resource-name-pattern", | ||
| description: "The resource name parameter should be defined with a 'pattern' restriction.", | ||
| messages: { | ||
| default: `The resource name parameter should be defined with a 'pattern' restriction. Decorate the "name" property in the resource definition using the @pattern decorator, with a regular expression indicating the allowed characters in the resource name.`, | ||
| }, | ||
| create(context) { | ||
| return { | ||
| root: (program: Program) => { | ||
| const resources = getArmResources(program); | ||
| for (const resource of resources) { | ||
| // find the name property | ||
| const nameProperty = resource.typespecType.properties.get("name"); | ||
|
There was a problem hiding this comment. This is likely to change soon, but is accurate for now |
||
| if (nameProperty !== undefined) { | ||
| const pattern = getPattern(program, nameProperty); | ||
| if (pattern === undefined) { | ||
| context.reportDiagnostic({ | ||
| target: nameProperty, | ||
| codefixes: [createPatternCodeFix(nameProperty)], | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import { | ||
| BasicTestRunner, | ||
| LinterRuleTester, | ||
| createLinterRuleTester, | ||
| } from "@typespec/compiler/testing"; | ||
| import { beforeEach, it } from "vitest"; | ||
| import { armResourceNamePatternRule } from "../../src/rules/arm-resource-name-pattern.js"; | ||
| import { createAzureResourceManagerTestRunner } from "../test-host.js"; | ||
|
|
||
| let runner: BasicTestRunner; | ||
| let tester: LinterRuleTester; | ||
|
|
||
| beforeEach(async () => { | ||
| runner = await createAzureResourceManagerTestRunner(); | ||
| tester = createLinterRuleTester( | ||
| runner, | ||
| armResourceNamePatternRule, | ||
| "@azure-tools/typespec-azure-resource-manager" | ||
| ); | ||
| }); | ||
|
|
||
| it("Emits a warning for an ARM resource that doesn't specify `@pattern` on the name", async () => { | ||
| await tester | ||
| .expect( | ||
| ` | ||
| @armProviderNamespace | ||
| @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) | ||
| namespace Microsoft.Contoso; | ||
|
|
||
| model Employee is ProxyResource<{}> { | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
|
|
||
| @parentResource(Employee) | ||
| model EmployeeRole is ProxyResource<{}> { | ||
| @key("roleName") | ||
| @segment("roles") | ||
| @path | ||
| @visibility("read") | ||
| name: string; | ||
| } | ||
| ` | ||
| ) | ||
| .toEmitDiagnostics([ | ||
| { | ||
| code: "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern", | ||
| }, | ||
| { | ||
| code: "@azure-tools/typespec-azure-resource-manager/arm-resource-name-pattern", | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
| it("Allows codefix when ARM resource name is missing pattern.", async () => { | ||
| await tester | ||
| .expect( | ||
| ` | ||
| @armProviderNamespace | ||
| @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) | ||
| namespace Microsoft.Contoso; | ||
|
|
||
| model Employee is ProxyResource<{}> { | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
| ` | ||
| ) | ||
| .applyCodeFix("add-pattern-decorator").toEqual(` | ||
| @armProviderNamespace | ||
| @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) | ||
| namespace Microsoft.Contoso; | ||
|
|
||
| model Employee is ProxyResource<{}> { | ||
| @pattern(/^[a-zA-Z0-9-]{3,24}$/) | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
| `); | ||
| }); | ||
|
|
||
| it("Does not emit a warning for an ARM resource that specifies `@pattern` on the name", async () => { | ||
| await tester | ||
| .expect( | ||
| ` | ||
| @armProviderNamespace | ||
| @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) | ||
| namespace Microsoft.Contoso; | ||
|
|
||
| model Employee is ProxyResource<{}> { | ||
| @doc("Name of employee") | ||
| @pattern("^[a-zA-Z0-9-]{3,24}$") | ||
| @key("employeeName") | ||
| @path | ||
| @segment("employees") | ||
| name: string; | ||
| } | ||
|
|
||
| @parentResource(Employee) | ||
| model EmployeeRole is ProxyResource<{}> { | ||
| @key("roleName") | ||
| @segment("roles") | ||
| @pattern("^[a-zA-Z0-9-]{3,24}$") | ||
| @path | ||
| @visibility("read") | ||
| name: string; | ||
| }` | ||
| ) | ||
| .toBeValid(); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a refactoring of this existing rule to be more efficient. It doesn't change the behavior.