refactor(rulesets): simplify oasOpSecurityDefined

packages/rulesets/src/oas/__tests__/oas3-operation-security-defined.test.ts

@@ -116,6 +116,7 @@ testRule('oas3-operation-security-defined', [
                 apikey: [],
                 basic: [],
               },
+              {},
             ],
           },
         },

packages/rulesets/src/oas/functions/index.ts

@@ -4,7 +4,7 @@ import { default as oasDocumentSchema } from './oasDocumentSchema';
 import { default as oasOpFormDataConsumeCheck } from './oasOpFormDataConsumeCheck';
 import { default as oasOpSuccessResponse } from './oasOpSuccessResponse';
 import { default as oasExample } from './oasExample';
-import { default as oasOpSecurityDefined } from './oasOpSecurityDefined';
+import { default as oasSecurityDefined } from './oasSecurityDefined';
 import { default as typedEnum } from './typedEnum';
 import { default as refSiblings } from './refSiblings';
 import { default as oasPathParam } from './oasPathParam';
@@ -20,7 +20,7 @@ export {
   oasOpFormDataConsumeCheck,
   oasOpSuccessResponse,
   oasExample,
-  oasOpSecurityDefined,
+  oasSecurityDefined,
   typedEnum,
   refSiblings,
   oasPathParam,

packages/rulesets/src/oas/functions/oasSecurityDefined.ts

@@ -0,0 +1,53 @@
+import { createRulesetFunction } from '@stoplight/spectral-core';
+import type { IFunctionResult } from '@stoplight/spectral-core';
+import { isPlainObject } from '@stoplight/json';
+
+type Options = {
+  oasVersion: 2 | 3;
+};
+
+export default createRulesetFunction<Record<string, unknown>, Options>(
+  {
+    input: {
+      type: 'object',
+    },
+    options: {
+      type: 'object',
+      properties: {
+        oasVersion: {
+          enum: [2, 3],
+        },
+      },
+      additionalProperties: false,
+    },
+  },
+  function oasSecurityDefined(input, { oasVersion }, { document, path }) {
+    const schemeNames = Object.keys(input);
+    if (schemeNames.length === 0) return;
+
+    if (!isPlainObject(document.data)) return;
+
+    const allDefs =
+      oasVersion === 2
+        ? document.data.securityDefinitions
+        : isPlainObject(document.data.components)
+        ? document.data.components.securitySchemes
+        : null;
+
+    let results: IFunctionResult[] | undefined;
+
+    for (const schemeName of schemeNames) {
+      if (!isPlainObject(allDefs) || !(schemeName in allDefs)) {
+        const object = path.length == 2 ? 'API' : 'Operation';
+        const location = oasVersion === 2 ? 'securityDefinitions' : 'components.securitySchemes';
+        results ??= [];
+        results.push({
+          message: `${object} "security" values must match a scheme defined in the "${location}" object.`,
+          path: [...path, schemeName],
+        });
+      }
+    }
+
+    return results;
+  },
+);

packages/rulesets/src/oas/index.ts

@@ -21,7 +21,7 @@ import {
   oasExample,
   oasUnusedComponent,
   oasDocumentSchema,
-  oasOpSecurityDefined,
+  oasSecurityDefined,
   oasSchema,
   oasDiscriminator,
 } from './functions';
@@ -36,6 +36,7 @@ const ruleset = {
   aliases: {
     PathItem: ['$.paths[*]'],
     OperationObject: ['#PathItem[get,put,post,delete,options,head,patch,trace]'],
+    SecurityRequirementObject: ['$.security[*]', '#OperationObject.security[*]'],
     ResponseObject: {
       targets: [
         {
@@ -451,11 +452,11 @@ const ruleset = {
       message: '{{error}}',
       recommended: true,
       formats: [oas2],
-      given: '$',
+      given: '#SecurityRequirementObject',
       then: {
-        function: oasOpSecurityDefined,
+        function: oasSecurityDefined,
         functionOptions: {
-          schemesPath: ['securityDefinitions'],
+          oasVersion: 2,
         },
       },
     },
@@ -584,11 +585,11 @@ const ruleset = {
       message: '{{error}}',
       recommended: true,
       formats: [oas3],
-      given: '$',
+      given: '#SecurityRequirementObject',
       then: {
-        function: oasOpSecurityDefined,
+        function: oasSecurityDefined,
         functionOptions: {
-          schemesPath: ['components', 'securitySchemes'],
+          oasVersion: 3,
         },
       },
     },