Merge pull request #191 from entando/ENG-5365-add-retrocompatibility-…

…to-v5-bundles ENG-5365 Add bundleDescriptorVersion field to improve backwards compatibility
entando · Jan 22, 2024 · 0632926 · 0632926
2 parents a9ce8f5 + 716277c
commit 0632926
Show file tree

Hide file tree

Showing 9 changed files with 174 additions and 17 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 {
@@ -696,7 +697,12 @@ export const BUNDLE_DESCRIPTOR_CONSTRAINTS: ObjectConstraints<BundleDescriptor>
           children: NAV_CONSTRAINTS
         }
       }
-    }
+    },
+    bundleDescriptorVersion: {
+      required: false,
+      type: 'string',
+      validators: [values(BundleDescriptorVersion)]
+    },
   }
 
 function microfrontendValidator(

diff --git a/src/models/bundle-descriptor.ts b/src/models/bundle-descriptor.ts
@@ -35,7 +35,10 @@ export enum DBMS {
   Oracle = 'oracle',
   Embedded = 'embedded'
 }
-
+export enum BundleDescriptorVersion {
+  v5 = 'v5',
+  v6 = 'v6'
+}
 export enum SecurityLevel {
   Strict = 'strict',
   Lenient = 'lenient'
@@ -130,6 +133,7 @@ export type BundleDescriptor = {
   global?: {
     nav: Nav[]
   }
+  bundleDescriptorVersion?: BundleDescriptorVersion
 }
 
 export type BundleGroup = {

diff --git a/src/services/bundle-descriptor-converter-service.ts b/src/services/bundle-descriptor-converter-service.ts
@@ -2,6 +2,7 @@ import {
   ApiClaim,
   ApiType,
   BundleDescriptor,
+  BundleDescriptorVersion,
   DBMS,
   EnvironmentVariable,
   ExternalApiClaim,
@@ -67,7 +68,7 @@ export class BundleDescriptorConverterService {
     const bundleDescriptor = this.bundleDescriptorService.getBundleDescriptor()
 
     for (const microFrontend of bundleDescriptor.microfrontends) {
-      this.generateMicroFrontendYamlDescriptor(microFrontend)
+      this.generateMicroFrontendYamlDescriptor(microFrontend, bundleDescriptor.bundleDescriptorVersion)
     }
 
     const versionedMicroservices = this.componentService.getVersionedComponents(
@@ -80,7 +81,8 @@ export class BundleDescriptorConverterService {
       )!
       this.generateMicroserviceYamlDescriptor(
         microservice,
-        versionedMicroservice.version
+        versionedMicroservice.version,
+        bundleDescriptor.bundleDescriptorVersion
       )
     }
 
@@ -91,7 +93,7 @@ export class BundleDescriptorConverterService {
     )
   }
 
-  private generateMicroFrontendYamlDescriptor(microFrontend: MicroFrontend) {
+  private generateMicroFrontendYamlDescriptor(microFrontend: MicroFrontend, bundleDescriptorVersion: BundleDescriptorVersion | undefined) {
     const customUiFile = path.resolve(
       MICROFRONTENDS_FOLDER,
       microFrontend.name,
@@ -104,7 +106,8 @@ export class BundleDescriptorConverterService {
       | YamlWidgetConfigDescriptor
       | YamlAppBuilderWidgetDescriptor = this.mapMicroFrontendToYamlDescriptor(
       microFrontend,
-      customUiFileExists
+      customUiFileExists,
+      bundleDescriptorVersion
     )
 
     if (customUiFileExists) {
@@ -145,7 +148,8 @@ export class BundleDescriptorConverterService {
 
   private mapMicroFrontendToYamlDescriptor(
     microFrontend: MicroFrontend,
-    customUiFileExists: boolean
+    customUiFileExists: boolean,
+    bundleDescriptorVersion: BundleDescriptorVersion | undefined
   ):
     | YamlWidgetDescriptor
     | YamlWidgetConfigDescriptor
@@ -157,7 +161,7 @@ export class BundleDescriptorConverterService {
       type: microFrontend.type,
       ...('titles' in microFrontend && { titles: microFrontend.titles }),
       group: microFrontend.group,
-      descriptorVersion: WIDGET_DESCRIPTOR_VERSION,
+      descriptorVersion: bundleDescriptorVersion ?? WIDGET_DESCRIPTOR_VERSION,
       ...(microFrontend.customElement
         ? { customElement: microFrontend.customElement }
         : {}),
@@ -238,11 +242,12 @@ export class BundleDescriptorConverterService {
 
   private generateMicroserviceYamlDescriptor(
     microservice: Microservice,
-    version: string
+    version: string,
+    bundleDescriptorVersion?: string,
   ) {
     const pluginDescriptor: YamlPluginDescriptor = {
       name: microservice.name,
-      descriptorVersion: PLUGIN_DESCRIPTOR_VERSION,
+      descriptorVersion: bundleDescriptorVersion ?? PLUGIN_DESCRIPTOR_VERSION,
       dbms: microservice.dbms ?? DBMS.None,
       image: DockerService.getDockerImageName(
         this.dockerOrganization,
@@ -304,7 +309,7 @@ export class BundleDescriptorConverterService {
       description: bundleDescriptor.description,
       components: {},
       ext: bundleDescriptor.global,
-      descriptorVersion: BUNDLE_DESCRIPTOR_VERSION
+      descriptorVersion: bundleDescriptor.bundleDescriptorVersion ?? BUNDLE_DESCRIPTOR_VERSION
     }
     if (thumbnail?.base64) {
       yamlBundleDescriptor.thumbnail = thumbnail.base64

diff --git a/src/services/bundle-descriptor-service.ts b/src/services/bundle-descriptor-service.ts
@@ -68,6 +68,7 @@ export class BundleDescriptorService {
       const componentService = new ComponentService()
       componentService.checkDuplicatedComponentNames()
       componentService.checkConfigMfes()
+      componentService.checkDescriptorFieldsCompatibility()
       return bundleDescriptor
     } catch (error) {
       throw new CLIError(

diff --git a/src/services/component-service.ts b/src/services/component-service.ts
@@ -1,5 +1,5 @@
 import {
-  BundleDescriptor,
+  BundleDescriptor, BundleDescriptorVersion,
   Commands,
   MicroFrontend,
   MicroFrontendType,
@@ -48,7 +48,7 @@ export class ComponentService {
   }
 
   public getComponents(type?: ComponentType): Array<Component<ComponentType>> {
-    const { microfrontends, microservices }: BundleDescriptor =
+    const {microfrontends, microservices}: BundleDescriptor =
       this.bundleDescriptorService.getBundleDescriptor()
 
     let components: Array<Component<ComponentType>>
@@ -185,6 +185,20 @@ export class ComponentService {
     }
   }
 
+  public checkDescriptorFieldsCompatibility(): void {
+    const bundleDescriptor = this.bundleDescriptorService.getBundleDescriptor()
+    const bundleDescriptorVersion = bundleDescriptor.bundleDescriptorVersion;
+
+    for (const ms of bundleDescriptor.microservices) {
+      // Microservice Resources has been added starting from v6 bundles
+      if (ms.resources && bundleDescriptorVersion === BundleDescriptorVersion.v5) {
+        throw new CLIError(
+          `Incompatible "resources" field for the microservice ${ms.name}, this field can't be set in v5 bundle version`
+        )
+      }
+    }
+  }
+
   public getComponent(name: string): Component<ComponentType> {
     const component = this.getComponents().find(comp => comp.name === name)
     if (component === undefined) {

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/bundle-descriptor-converter-service.test.ts b/test/services/bundle-descriptor-converter-service.test.ts
@@ -19,7 +19,8 @@ import {
   DBMS,
   SecurityLevel,
   MicroFrontendType,
-  MicroFrontendAppBuilderSlot
+  MicroFrontendAppBuilderSlot,
+  BundleDescriptorVersion
 } from '../../src/models/bundle-descriptor'
 
 describe('bundle-descriptor-converter-service', () => {
@@ -419,6 +420,71 @@ describe('bundle-descriptor-converter-service', () => {
       components: {}
     })
   })
+
+  test.it('test bundle conversion with a specific bundle descriptor version', () => {
+    const bundleDir = tempDirHelper.createInitializedBundleDir(
+      'test-bundle-v5'
+    )
+    const bundleDescriptorPath = path.resolve(
+      bundleDir,
+      ...OUTPUT_FOLDER,
+      'descriptors',
+      BUNDLE_DESCRIPTOR_NAME
+    )
+
+    const converterService = new BundleDescriptorConverterService('docker-org')
+    const bundleDescriptorService = new BundleDescriptorService()
+
+    bundleDescriptorService.createBundleDescriptor({
+      name: 'test-bundle-v5',
+      version: '0.0.1',
+      type: 'bundle',
+      description: 'test-bundle-v5 description',
+      bundleDescriptorVersion: BundleDescriptorVersion.v5,
+      microservices: [
+        {
+          name: 'test-ms',
+          stack: MicroserviceStack.SpringBoot,
+          dbms: DBMS.PostgreSQL,
+          version: '0.0.1',
+          healthCheckPath: '/path/to/check'
+        }
+      ],
+      microfrontends: [
+        {
+          name: 'test-mfe',
+          customElement: 'test-mfe',
+          stack: MicroFrontendStack.React,
+          type: MicroFrontendType.Widget,
+          titles: {
+            en: 'mfe title',
+            it: 'titolo mfe'
+          },
+          group: 'free',
+          publicFolder: 'public',
+          configMfe: 'test-mfe-no-code',
+        }
+      ]
+    })
+
+    fs.writeFileSync(`${bundleDir}/thumbnail.png`, 'this is a thumbnail')
+
+    converterService.generateYamlDescriptors({})
+
+    checkYamlFile(bundleDescriptorPath, {
+      name: 'test-bundle-v5',
+      descriptorVersion: 'v5',
+      description: 'test-bundle-v5 description',
+      components: {
+        plugins: [
+          "plugins/test-ms.yaml"
+        ],
+        widgets: [
+          "widgets/test-mfe.yaml"
+        ]
+      }
+    })
+  })
 })
 
 function checkYamlFile(filePath: string, expectedContent: any) {

diff --git a/test/services/component-service.test.ts b/test/services/component-service.test.ts
@@ -11,7 +11,7 @@ import { MICROSERVICES_FOLDER } from '../../src/paths'
 import { ProcessExecutorService } from '../../src/services/process-executor-service'
 import { BundleDescriptorHelper } from '../helpers/mocks/bundle-descriptor-helper'
 import { ComponentHelper } from '../helpers/mocks/component-helper'
-import { MicroFrontendType } from '../../src/models/bundle-descriptor'
+import { BundleDescriptorVersion, MicroFrontendType } from '../../src/models/bundle-descriptor'
 
 describe('component-service', () => {
   let componentService: ComponentService
@@ -181,6 +181,34 @@ describe('component-service', () => {
       'Checks for config MFE that has invalid requirements with non-existent mfe name'
     )
 
+  test
+    .do(() => {
+      const bundleDescriptor = BundleDescriptorHelper.newBundleDescriptor()
+      bundleDescriptor.bundleDescriptorVersion = BundleDescriptorVersion.v5
+      bundleDescriptor.microservices = [
+        ComponentHelper.newMicroservice('ms-name-1', {
+          resources: {
+            cpu: '100m',
+            memory: '20gb',
+            storage: '10gb'
+          }
+        })
+      ]
+
+      sinon
+        .stub(BundleDescriptorService.prototype, 'getBundleDescriptor')
+        .returns(bundleDescriptor)
+      componentService.checkDescriptorFieldsCompatibility()
+    })
+    .catch(error => {
+      expect(error.message).contain(
+        'Incompatible "resources" field for the microservice ms-name-1, this field can\'t be set in v5 bundle version'
+      )
+    })
+    .it(
+      'Check bundle v5 fields compatibility'
+    )
+
   test
     .do(() => {
       const bundleDescriptor = BundleDescriptorHelper.newBundleDescriptor()

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')
+
 })