test(definitions): refactor security tests

asyncapi#539
Pakisan · Jun 15, 2024 · 74b97ee · 74b97ee
1 parent 1e10bff
commit 74b97ee
Show file tree

Hide file tree

Showing 82 changed files with 317 additions and 815 deletions.
diff --git a/test/definitions/3.0.0/security/apiKey.test.mjs b/test/definitions/3.0.0/security/apiKey.test.mjs
@@ -0,0 +1,72 @@
+import {describe, it} from 'vitest';
+import TestHelper from '@test/test-helper.mjs';
+
+const jsonSchema = require('@definitions/3.0.0/apiKey.json');
+
+describe('API Key', () => {
+  it(TestHelper.exampleIsValidTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": "apiKey",
+      "description": "apiKey",
+      "in": "user"
+    },
+  ));
+
+  it(TestHelper.cannotBeEmptyTestName, () => TestHelper.objectIsNotValid(
+    jsonSchema,
+    {},
+    [
+      'must have required property \'type\'',
+      'must have required property \'in\''
+    ]
+  ));
+
+  it(TestHelper.isNotValidWithoutRequiredPropertiesTestName, () => TestHelper.objectIsNotValid(
+    jsonSchema,
+    {
+      "description": "apiKey"
+    },
+    [
+      'must have required property \'type\'',
+      'must have required property \'in\''
+    ]
+  ));
+
+  it(TestHelper.isValidWithOnlyRequiredPropertiesTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": "apiKey",
+      "in": "user"
+    },
+  ));
+
+  it(TestHelper.isValidWhenIsExtendedTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": "apiKey",
+      "description": "apiKey",
+      "in": "user",
+      "x-number": 0,
+      "x-string": "",
+      "x-object": {
+        "property": {}
+      }
+    },
+  ));
+
+  it(TestHelper.isNotValidWhenIsWronglyExtendedTestName, () => TestHelper.wronglyExtended(
+    jsonSchema,
+    {
+      "type": "apiKey",
+      "description": "apiKey",
+      "in": "user",
+      "x-number": 0,
+      "x-string": "",
+      "x-object": {
+        "property": {}
+      },
+      "ext-number": 1
+    }
+  ));
+});
diff --git a/test/definitions/3.0.0/security/apiKey/empty.json b/test/definitions/3.0.0/security/apiKey/empty.json
diff --git a/test/definitions/3.0.0/security/apiKey/example.json b/test/definitions/3.0.0/security/apiKey/example.json
diff --git a/test/definitions/3.0.0/security/apiKey/extended.json b/test/definitions/3.0.0/security/apiKey/extended.json
diff --git a/test/definitions/3.0.0/security/apiKey/index.mjs b/test/definitions/3.0.0/security/apiKey/index.mjs
diff --git a/test/definitions/3.0.0/security/apiKey/only required properties.json b/test/definitions/3.0.0/security/apiKey/only required properties.json
diff --git a/test/definitions/3.0.0/security/apiKey/without required properties.json b/test/definitions/3.0.0/security/apiKey/without required properties.json
diff --git a/test/definitions/3.0.0/security/apiKey/wrongly extended.json b/test/definitions/3.0.0/security/apiKey/wrongly extended.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/empty.json b/test/definitions/3.0.0/security/asymmetricEncryption/empty.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/example.json b/test/definitions/3.0.0/security/asymmetricEncryption/example.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/extended.json b/test/definitions/3.0.0/security/asymmetricEncryption/extended.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/index.mjs b/test/definitions/3.0.0/security/asymmetricEncryption/index.mjs
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/only required properties.json b/test/definitions/3.0.0/security/asymmetricEncryption/only required properties.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/without required properties.json b/test/definitions/3.0.0/security/asymmetricEncryption/without required properties.json
diff --git a/test/definitions/3.0.0/security/asymmetricEncryption/wrongly extended.json b/test/definitions/3.0.0/security/asymmetricEncryption/wrongly extended.json
diff --git a/test/definitions/3.0.0/security/default-implementation.test.mjs b/test/definitions/3.0.0/security/default-implementation.test.mjs
@@ -0,0 +1,117 @@
+import {describe, it} from 'vitest';
+import TestHelper from '@test/test-helper.mjs';
+
+describe.each([
+  {
+    name: 'X509',
+    type: 'X509',
+    description: 'X509 example',
+    schema: 'X509',
+  },
+  {
+    name: 'userPassword',
+    type: 'userPassword',
+    description: 'userPassword example',
+    schema: 'userPassword',
+  },
+  {
+    name: 'symmetricEncryption',
+    type: 'symmetricEncryption',
+    description: 'symmetricEncryption example',
+    schema: 'symmetricEncryption',
+  },
+  {
+    name: 'asymmetricEncryption',
+    type: 'asymmetricEncryption',
+    description: 'asymmetricEncryption example',
+    schema: 'asymmetricEncryption',
+  },
+  {
+    name: 'SASL: plain',
+    type: 'plain',
+    description: 'SASL plain example',
+    schema: 'SaslPlainSecurityScheme',
+  },
+  {
+    name: 'SASL: GSS-API',
+    type: 'gssapi',
+    description: 'SASL GSS-API example',
+    schema: 'SaslGssapiSecurityScheme',
+  },
+  {
+    name: 'SASL: SCRAM-SHA-256',
+    type: 'scramSha256',
+    description: 'SASL SCRAM-SHA-256 example',
+    schema: 'SaslScramSecurityScheme',
+  },
+  {
+    name: 'SASL: SCRAM-SHA-512',
+    type: 'scramSha512',
+    description: 'SASL SCRAM-SHA-512 example',
+    schema: 'SaslScramSecurityScheme',
+  },
+])('$name', async (params) => {
+
+  const jsonSchema = await import(`@definitions/3.0.0/${params.schema}.json`);
+
+  it(TestHelper.exampleIsValidTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": params.type,
+      "description": params.description,
+    },
+  ));
+
+  it(TestHelper.cannotBeEmptyTestName, () => TestHelper.objectIsNotValid(
+    jsonSchema,
+    {},
+    [
+      'must have required property \'type\''
+    ]
+  ));
+
+  it(TestHelper.isNotValidWithoutRequiredPropertiesTestName, () => TestHelper.objectIsNotValid(
+    jsonSchema,
+    {
+      "description": params.description,
+    },
+    [
+      'must have required property \'type\''
+    ]
+  ));
+
+  it(TestHelper.isValidWithOnlyRequiredPropertiesTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": params.type,
+    },
+  ));
+
+  it(TestHelper.isValidWhenIsExtendedTestName, () => TestHelper.objectIsValid(
+    jsonSchema,
+    {
+      "type": params.type,
+      "description": params.description,
+      "x-number": 0,
+      "x-string": "",
+      "x-object": {
+        "property": {}
+      }
+    },
+  ));
+
+  it(TestHelper.isNotValidWhenIsWronglyExtendedTestName, () => TestHelper.wronglyExtended(
+    jsonSchema,
+    {
+      "type": params.type,
+      "description": params.description,
+      "x-number": 0,
+      "x-string": "",
+      "x-object": {
+        "property": {}
+      },
+      "ext-number": 1
+    },
+  ));
+
+})
diff --git a/test/definitions/3.0.0/security/gssapi/empty.json b/test/definitions/3.0.0/security/gssapi/empty.json
diff --git a/test/definitions/3.0.0/security/gssapi/example.json b/test/definitions/3.0.0/security/gssapi/example.json
diff --git a/test/definitions/3.0.0/security/gssapi/extended.json b/test/definitions/3.0.0/security/gssapi/extended.json