updated common-types version to v6 (#735)

* updated types, managedidentity and privatelinks common-types version to v6 * added NetworkSecurityPerimeterConfigurationNameParameter to exclusion list
Azure · Sep 11, 2024 · a19b89c · a19b89c
1 parent 400972e
commit a19b89c
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 15 deletions.
diff --git a/packages/rulesets/generated/spectral/az-arm.js b/packages/rulesets/generated/spectral/az-arm.js
@@ -175,9 +175,9 @@ const mutabilityWithReadOnly = (prop, _opts, ctx) => {
 };
 
 const LATEST_VERSION_BY_COMMON_TYPES_FILENAME = new Map([
-    ["types.json", "v5"],
-    ["managedidentity.json", "v5"],
-    ["privatelinks.json", "v5"],
+    ["types.json", "v6"],
+    ["managedidentity.json", "v6"],
+    ["privatelinks.json", "v6"],
     ["customermanagedkeys.json", "v5"],
     ["managedidentitywithdelegation.json", "v5"],
     ["networksecurityperimeter.json", "v5"],
@@ -2585,7 +2585,12 @@ const reservedResourceNamesModelAsEnum = (pathItem, _opts, ctx) => {
     return errors;
 };
 
-const EXCEPTION_LIST = ["resourceGroupName", "privateEndpointConnectionName", "managementGroupName"];
+const EXCEPTION_LIST = [
+    "resourceGroupName",
+    "privateEndpointConnectionName",
+    "managementGroupName",
+    "networkSecurityPerimeterConfigurationName",
+];
 const resourceNameRestriction = (paths, _opts, ctx) => {
     if (paths === null || typeof paths !== "object") {
         return [];

diff --git a/packages/rulesets/src/spectral/functions/resource-name-restriction.ts b/packages/rulesets/src/spectral/functions/resource-name-restriction.ts
@@ -1,7 +1,12 @@
 // Check conformance to Azure parameter naming conventions:
 
 //system-defined parameters => needs to be excluded from validation
-const EXCEPTION_LIST = ["resourceGroupName", "privateEndpointConnectionName", "managementGroupName"]
+const EXCEPTION_LIST = [
+  "resourceGroupName",
+  "privateEndpointConnectionName",
+  "managementGroupName",
+  "networkSecurityPerimeterConfigurationName",
+]
 export const resourceNameRestriction = (paths: any, _opts: any, ctx: any) => {
   if (paths === null || typeof paths !== "object") {
     return []

diff --git a/packages/rulesets/src/spectral/functions/utils.ts b/packages/rulesets/src/spectral/functions/utils.ts
@@ -1,9 +1,9 @@
 import _ from "lodash"
 
 export const LATEST_VERSION_BY_COMMON_TYPES_FILENAME = new Map([
-  ["types.json", "v5"],
-  ["managedidentity.json", "v5"],
-  ["privatelinks.json", "v5"],
+  ["types.json", "v6"],
+  ["managedidentity.json", "v6"],
+  ["privatelinks.json", "v6"],
   ["customermanagedkeys.json", "v5"],
   ["managedidentitywithdelegation.json", "v5"],
   ["networksecurityperimeter.json", "v5"],

diff --git a/packages/rulesets/src/spectral/test/latest-version-of-common-types-must-be-used.test.ts b/packages/rulesets/src/spectral/test/latest-version-of-common-types-must-be-used.test.ts
@@ -57,9 +57,9 @@ test("LatestVersionOfCommonTypesMustBeUsed should find errors for obsolete versi
     expect(results[0].path.join(".")).toBe("paths./foo.get.parameters.0.$ref")
     expect(results[0].message).toContain("Use the latest version v5 of customermanagedkeys.json.")
     expect(results[1].path.join(".")).toBe("paths./foo.get.parameters.1.$ref")
-    expect(results[1].message).toContain("Use the latest version v5 of managedidentity.json.")
+    expect(results[1].message).toContain("Use the latest version v6 of managedidentity.json.")
     expect(results[2].path.join(".")).toBe("paths./foo.get.responses.200.$ref")
-    expect(results[2].message).toContain("Use the latest version v5 of types.json.")
+    expect(results[2].message).toContain("Use the latest version v6 of types.json.")
   })
 })
 
@@ -73,20 +73,20 @@ test("LatestVersionOfCommonTypesMustBeUsed should find no errors", async () => {
           parameters: [
             {
               $ref: `../../../../../common-types/resource-management/${LATEST_VERSION_BY_COMMON_TYPES_FILENAME.get(
-                "customermanagedkeys.json"
+                "customermanagedkeys.json",
               )}/customermanagedkeys.json#/parameters/ApiVersionParameter`,
             },
             {
               $ref: `../../../../../common-types/resource-management/${LATEST_VERSION_BY_COMMON_TYPES_FILENAME.get(
-                "managedidentity.json"
+                "managedidentity.json",
               )}/managedidentity.json#/parameters/ApiVersionParameter`,
             },
           ],
           responses: {
             200: {
               description: "Success",
               $ref: `../../../../../common-types/resource-management/${LATEST_VERSION_BY_COMMON_TYPES_FILENAME.get(
-                "types.json"
+                "types.json",
               )}/types.json#/parameters/ApiVersionParameter`,
             },
           },

diff --git a/packages/rulesets/src/spectral/test/resource-names-restriction.test.ts b/packages/rulesets/src/spectral/test/resource-names-restriction.test.ts
@@ -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.")
   })
@@ -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.")
   })
@@ -138,6 +138,31 @@ test("ResourceNameRestriction should find no errors for system-defined variables
             responses: {},
           },
         },
+      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/My.NS/foo/{fooName}/networkSecurityPerimeterConfiguration/{networkSecurityPerimeterConfigurationName}":
+        {
+          parameters: [
+            {
+              name: "fooName",
+              in: "path",
+              required: true,
+              type: "string",
+              pattern: "[a-zA-Z_0-9]+",
+              "x-ms-parameter-location": "method",
+            },
+            {
+              name: "networkSecurityPerimeterConfigurationName",
+              in: "path",
+              required: true,
+              type: "string",
+              description: "The name of the network security perimeter configuration associated with the Azure resource.",
+              "x-ms-parameter-location": "method",
+            },
+          ],
+          get: {
+            parameters: [],
+            responses: {},
+          },
+        },
     },
   }
   return linter.run(oasDoc).then((results) => {