ENG-5365 Add bundleDescriptorVersion allowed values validation

entando · Jan 19, 2024 · 716277c · 716277c
1 parent a721f50
commit 716277c
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/src/models/bundle-descriptor-constraints.ts b/src/models/bundle-descriptor-constraints.ts
@@ -16,7 +16,8 @@ import {
   Resources,
   WidgetConfigMicroFrontend,
   WidgetMicroFrontend,
-  WidgetParam
+  WidgetParam,
+  BundleDescriptorVersion
 } from './bundle-descriptor'
 import { MicroFrontendStack, MicroserviceStack } from './component'
 import {
@@ -700,6 +701,7 @@ export const BUNDLE_DESCRIPTOR_CONSTRAINTS: ObjectConstraints<BundleDescriptor>
     bundleDescriptorVersion: {
       required: false,
       type: 'string',
+      validators: [values(BundleDescriptorVersion)]
     },
   }
 

diff --git a/test/helpers/mocks/bundle-descriptor-helper.ts b/test/helpers/mocks/bundle-descriptor-helper.ts
@@ -118,6 +118,17 @@ export class BundleDescriptorHelper {
   }
 }
 
+export const mockBundleWithInvalidBundleDescriptorVersion=
+  `{
+    "name": "test-bundle-v99999",
+    "version": "0.0.1",
+    "type": "bundle",
+    "description": "test description",
+    "bundleDescriptorVersion": "v99999",
+    "microservices": [],
+    "microfrontends": []
+  }`
+
 export const mocksExpectedErrorWithInput = [
   {
     expectedLineError: 9,

diff --git a/test/services/constraints-validator-service.test.ts b/test/services/constraints-validator-service.test.ts
@@ -10,7 +10,10 @@ import {
   INVALID_VERSION_MESSAGE,
   VALID_CONTEXT_PARAM_FORMAT
 } from '../../src/models/bundle-descriptor-constraints'
-import { BundleDescriptorHelper } from '../helpers/mocks/bundle-descriptor-helper'
+import {
+  BundleDescriptorHelper,
+  mockBundleWithInvalidBundleDescriptorVersion,
+} from '../helpers/mocks/bundle-descriptor-helper'
 import { YamlBundleDescriptor } from '../../src/models/yaml-bundle-descriptor'
 import { YAML_BUNDLE_DESCRIPTOR_CONSTRAINTS } from '../../src/models/yaml-bundle-descriptor-constraints'
 import {
@@ -19,6 +22,7 @@ import {
 } from '../../src/models/component'
 import * as sinon from 'sinon'
 import { existsSyncMock } from '../helpers/mocks/validator-helper'
+import {BundleDescriptorService} from "../../src/services/bundle-descriptor-service";
 
 describe('BundleDescriptorValidatorService', () => {
   afterEach(() => {
@@ -32,6 +36,23 @@ describe('BundleDescriptorValidatorService', () => {
     )
   })
 
+  test
+    .do(() => {
+      const bundleDescriptorService = new BundleDescriptorService()
+      bundleDescriptorService.writeDescriptor(mockBundleWithInvalidBundleDescriptorVersion)
+      const invalidDescriptor = bundleDescriptorService.getBundleDescriptor();
+      console.log(invalidDescriptor)
+      ConstraintsValidatorService.validateObjectConstraints(
+        invalidDescriptor,
+        BUNDLE_DESCRIPTOR_CONSTRAINTS
+      )
+    })
+    .catch(error => {
+      console.log(error)
+      expect(error.message).contain('Field "bundleDescriptorVersion" is not valid. Allowed values are: v5, v6')
+    })
+    .it('Validates invalid bundleDescriptorVersion')
+
   test
     .do(() => {
       const invalidDescriptor: any =
@@ -1128,4 +1149,5 @@ describe('Validates YAML descriptor', () => {
       expect(error.message).contain('$.ext.nav[0].target')
     })
     .it('Validates invalid nav target')
+
 })