Test false "false positive" for ProvisioningStateMustBeReadOnly

common/changes/@microsoft.azure/openapi-validator-rulesets/false-negative-provisioningStateMustBeReadOnly_2023-07-25-20-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft.azure/openapi-validator-rulesets",
+      "comment": "Add test for ProvisioingStateMustBeReadOnly ",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft.azure/openapi-validator-rulesets"
+}

packages/rulesets/src/spectral/az-arm.ts

@@ -810,7 +810,7 @@ const ruleset: any = {
     ProvisioningStateMustBeReadOnly: {
       description: "This is a rule introduced to validate if provisioningState property is set to readOnly or not.",
       message: "{{error}}",
-      severity: "off", // See https://github.com/Azure/azure-sdk-tools/issues/6191#issuecomment-1571334585
+      severity: "warn",
       stagingOnly: true,
       resolved: true,
       formats: [oas2],

packages/rulesets/src/spectral/test/provisioning-state-must-be-read-only.test.ts

@@ -212,6 +212,106 @@ test("ProvisioningStateMustBeReadOnly should find errors when multiple verbs spe
   })
 })
 
+test("ProvisioningStateSpecified should find errors when readOnly property is present in the envelope property", () => {
+  const oasDoc = {
+    swagger: "2.0",
+    paths: {
+      "/foo": {
+        put: {
+          tags: ["SampleTag"],
+          operationId: "Foo_Update",
+          description: "Test Description",
+          parameters: [
+            {
+              name: "foo_put",
+              in: "body",
+              schema: {
+                $ref: "#/definitions/FooRequestParams",
+              },
+            },
+          ],
+          responses: {
+            "200": {
+              description: "Success",
+              schema: {
+                $ref: "#/definitions/FooProps",
+              },
+            },
+            "201": {
+              schema: {
+                $ref: "#/definitions/FooRule",
+              },
+            },
+          },
+          "x-ms-long-running-operation": true,
+          "x-ms-long-running-operation-options": {
+            "final-state-via": "azure-async-operation",
+          },
+        },
+      },
+    },
+    definitions: {
+      FooRequestParams: {
+        allOf: [
+          {
+            $ref: "#/definitions/FooProps",
+          },
+        ],
+      },
+      ProvisioningState: {
+        type: "string",
+        enum: ["Succeeded", "Failed", "Canceled"],
+        "x-ms-enum": {
+          name: "ProvisioningState",
+          modelAsString: true,
+        },
+      },
+      FooResource: {
+        "x-ms-azure-resource": true,
+        properties: {
+          provisioningState: {
+            $ref: "#/definitions/ProvisioningState",
+            readOnly: true,
+            type: "string",
+            description: "Provisioning state of the foo rule.",
+            enum: ["Creating", "Canceled", "Deleting", "Failed"],
+          },
+        },
+      },
+      FooRule: {
+        type: "object",
+        properties: {
+          properties: {
+            $ref: "#/definitions/FooResource",
+            "x-ms-client-flatten": true,
+          },
+        },
+        required: ["properties"],
+      },
+      FooProps: {
+        properties: {
+          servicePrecedence: {
+            description:
+              "A precedence value that is used to decide between services when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all services configured in the mobile network.",
+            type: "integer",
+            format: "int32",
+            minimum: 0,
+            maximum: 255,
+          },
+          id: {
+            type: "string",
+          },
+        },
+      },
+    },
+  }
+  return linter.run(oasDoc).then((results) => {
+    expect(results.length).toBe(1)
+    expect(results[0].path.join(".")).toBe("paths./foo.put.responses.201.schema")
+    expect(results[0].message).toContain("provisioningState property must be set to readOnly.")
+  })
+})
+
 test("ProvisioningStateSpecified should find no errors", () => {
   const oasDoc = {
     swagger: "2.0",
@@ -258,10 +358,20 @@ test("ProvisioningStateSpecified should find no errors", () => {
           },
         ],
       },
+      ProvisioningState: {
+        type: "string",
+        enum: ["Succeeded", "Failed", "Canceled"],
+        "x-ms-enum": {
+          name: "ProvisioningState",
+          modelAsString: true,
+        },
+        readOnly: true,
+      },
       FooResource: {
         "x-ms-azure-resource": true,
         properties: {
           provisioningState: {
+            $ref: "#/definitions/ProvisioningState",
             readOnly: true,
             type: "string",
             description: "Provisioning state of the foo rule.",