feat: Add tests for apikind

Author: makeev-pavel

src/apitypes/async/async.utils.ts

@@ -18,8 +18,8 @@ import { v3 as AsyncAPIV3 } from '@asyncapi/parser/esm/spec-types'
 import { isObject } from '../../utils'
 import { AsyncOperationActionType, AsyncProtocol } from './async.types'
 import { normalize } from '@netcracker/qubership-apihub-api-unifier'
-import { APIHUB_API_COMPATIBILITY_KIND_BWC, ApihubApiCompatibilityKind } from '../../consts'
 import { ASYNC_SUPPORTED_PROTOCOLS } from './async.consts'
+import { APIHUB_API_COMPATIBILITY_KIND_BWC, ApihubApiCompatibilityKind } from '../../consts'
 
 // Re-export shared utilities
 export { dump, getCustomTags, resolveApiAudience } from '../../utils/apihubSpecificationExtensions'
@@ -100,8 +100,8 @@ export function toExternalDocumentationObject(
 }
 
 export const calculateAsyncApiKind = (
-  channelApiKind: ApihubApiCompatibilityKind | undefined,
   operationApiKind: ApihubApiCompatibilityKind | undefined,
+  channelApiKind: ApihubApiCompatibilityKind | undefined,
 ): ApihubApiCompatibilityKind => {
-  return channelApiKind || operationApiKind || APIHUB_API_COMPATIBILITY_KIND_BWC
+  return operationApiKind || channelApiKind || APIHUB_API_COMPATIBILITY_KIND_BWC
 }

test/async.operation.test.ts

@@ -109,7 +109,7 @@ describe('AsyncAPI 3.0 Operation Tests', () => {
     })
 
     it('e2e', async () => {
-      const result = await buildPackage('asyncapi/operations/additional-data-and-metadata')
+      const result = await buildPackage('asyncapi/operations/single-operation')
       const operations = Array.from(result.operations.values())
       const [operation] = operations
       expect(operation.metadata.protocol).toBe('protocol')

test/asyncapi-apikind.test.ts

@@ -0,0 +1,51 @@
+import {
+  APIHUB_API_COMPATIBILITY_KIND_BWC,
+  APIHUB_API_COMPATIBILITY_KIND_NO_BWC,
+  ApihubApiCompatibilityKind,
+} from '../src'
+import { calculateAsyncApiKind } from '../src/apitypes/async/async.utils'
+import { buildPackage } from './helpers'
+
+describe('apiKind', () => {
+  it('unit unique values', () => {
+    const data = [
+      [undefined, undefined, APIHUB_API_COMPATIBILITY_KIND_BWC],
+      [APIHUB_API_COMPATIBILITY_KIND_BWC, undefined, APIHUB_API_COMPATIBILITY_KIND_BWC],
+      [undefined, APIHUB_API_COMPATIBILITY_KIND_BWC, APIHUB_API_COMPATIBILITY_KIND_BWC],
+      [APIHUB_API_COMPATIBILITY_KIND_NO_BWC, undefined, APIHUB_API_COMPATIBILITY_KIND_NO_BWC],
+      [undefined, APIHUB_API_COMPATIBILITY_KIND_NO_BWC, APIHUB_API_COMPATIBILITY_KIND_NO_BWC],
+      [APIHUB_API_COMPATIBILITY_KIND_BWC, APIHUB_API_COMPATIBILITY_KIND_NO_BWC, APIHUB_API_COMPATIBILITY_KIND_BWC],
+      [APIHUB_API_COMPATIBILITY_KIND_NO_BWC, APIHUB_API_COMPATIBILITY_KIND_BWC, APIHUB_API_COMPATIBILITY_KIND_NO_BWC],
+    ]
+    data.forEach(([operationApiKind, channelApiKind, expected]) => {
+      const result = calculateAsyncApiKind(operationApiKind as ApihubApiCompatibilityKind, channelApiKind as ApihubApiCompatibilityKind)
+      expect(result).toBe(expected)
+    })
+  })
+
+  it('e2e', async () => {
+    const result = await buildPackage('asyncapi/api-kind/base')
+    const operations = Array.from(result.operations.values())
+
+    const [
+      operation,
+      operationWithCannelBwc,
+      operationWithCannelNoBwc,
+      operationBwc,
+      operationNoBwc,
+      operationBwcWithChannelBwc,
+      operationBwcWithChannelNoBwc,
+      operationNoBwcWithChannelBwc,
+      operationNoBwcWithChannelNoBwc,
+    ] = operations
+    expect(operation.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_BWC)
+    expect(operationWithCannelBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_BWC)
+    expect(operationWithCannelNoBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_NO_BWC)
+    expect(operationBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_BWC)
+    expect(operationNoBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_NO_BWC)
+    expect(operationBwcWithChannelBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_BWC)
+    expect(operationBwcWithChannelNoBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_BWC)
+    expect(operationNoBwcWithChannelBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_NO_BWC)
+    expect(operationNoBwcWithChannelNoBwc.apiKind).toEqual(APIHUB_API_COMPATIBILITY_KIND_NO_BWC)
+  })
+})

test/projects/asyncapi/api-kind/base/config.json

@@ -0,0 +1,11 @@
+{
+  "packageId": "asyncapi-operations",
+  "version": "v1",
+  "files": [
+    {
+      "fileId": "spec.yaml",
+      "publish": true,
+      "labels": []
+    }
+  ]
+}

test/projects/asyncapi/api-kind/base/spec.yaml

@@ -0,0 +1,98 @@
+asyncapi: 3.0.0
+info:
+  title: Account Service
+  version: 1.0.0
+  description: This service is in charge of processing user signups
+channels:
+  channel:
+    address: user/signedup
+    messages:
+      UserSignedUp:
+        $ref: '#/components/messages/UserSignedUp'
+  channel-bwc:
+    x-api-kind: BWC
+    address: user/signedup
+    messages:
+      UserSignedUp:
+        $ref: '#/components/messages/UserSignedUp'
+  channel-no-bwc:
+    x-api-kind: no-BWC
+    address: user/signedup
+    messages:
+      UserSignedUp:
+        $ref: '#/components/messages/UserSignedUp'
+operations:
+  operation:
+    action: send
+    channel:
+      $ref: '#/channels/channel'
+    messages:
+      - $ref: '#/channels/channel/messages/UserSignedUp'
+  operation-with-cannel-bwc:
+    action: send
+    channel:
+      $ref: '#/channels/channel-bwc'
+    messages:
+      - $ref: '#/channels/channel-bwc/messages/UserSignedUp'
+  operation-with-cannel-no-bwc:
+    action: send
+    channel:
+      $ref: '#/channels/channel-no-bwc'
+    messages:
+      - $ref: '#/channels/channel-no-bwc/messages/UserSignedUp'
+  operation-bwc:
+    x-api-kind: BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel'
+    messages:
+      - $ref: '#/channels/channel/messages/UserSignedUp'
+  operation-no-bwc:
+    x-api-kind: no-BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel'
+    messages:
+      - $ref: '#/channels/channel/messages/UserSignedUp'
+  operation-bwc-with-channel-bwc:
+    x-api-kind: BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel-bwc'
+    messages:
+      - $ref: '#/channels/channel-bwc/messages/UserSignedUp'
+  operation-bwc-with-channel-no-bwc:
+    x-api-kind: BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel-no-bwc'
+    messages:
+      - $ref: '#/channels/channel-no-bwc/messages/UserSignedUp'
+  operation-no-bwc-with-channel-bwc:
+    x-api-kind: no-BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel-bwc'
+    messages:
+      - $ref: '#/channels/channel-bwc/messages/UserSignedUp'
+  operation-no-bwc-with-channel-no-bwc:
+    x-api-kind: no-BWC
+    action: send
+    channel:
+      $ref: '#/channels/channel-no-bwc'
+    messages:
+      - $ref: '#/channels/channel-no-bwc/messages/UserSignedUp'
+components:
+  messages:
+    UserSignedUp:
+      title: User Signed Up
+      payload:
+        type: object
+        properties:
+          displayName:
+            type: string
+            description: Name of the user
+          email:
+            type: string
+            format: email
+            description: Email of the user