feat: Support multiple services for ui5 yaml files and manifest.json

.changeset/empty-snakes-care.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/mockserver-config-writer': minor
+'@sap-ux/odata-service-writer': minor
+'@sap-ux/ui5-config': minor
+'@sap-ux/create': minor
+---
+
+Support multiple services and multiple annotations per service.

examples/simple-generator/src/app/service.ts

@@ -164,10 +164,12 @@ export async function getMetadata(
  metadata,
  annotations:
  annotations?.length > 0
- ? {
- technicalName: annotations[0].TechnicalName,
- xml: annotations[0].Definitions
- }
+ ? [
+ {
+ technicalName: annotations[0].TechnicalName,
+ xml: annotations[0].Definitions
+ }
+ ]
  : undefined
  };
 }

packages/create/src/cli/add/mockserver-config.ts

@@ -53,10 +53,13 @@ async function addMockserverConfig(
  );
  await validateBasePath(basePath);
  const webappPath = await getWebappPath(basePath);
- const config: MockserverConfig = { webappPath };
- if (interactive) {
- const questions = getMockserverConfigQuestions({ webappPath });
- config.ui5MockYamlConfig = await prompt(questions);
+ const config: MockserverConfig = { webappPath, ui5MockYamlConfig: {} };
+ if (interactive && config.ui5MockYamlConfig) {
+ const questions = getMockserverConfigQuestions({ webappPath, askForOverwrite: true });
+ const responses = await prompt(questions);
+ config.ui5MockYamlConfig.path = responses?.path;
+ // User response for whether to overwrite existing services in mock-server config
+ config.ui5MockYamlConfig.overwriteServices = !!responses?.overwrite;
  }
  const fs = await generateMockserverConfig(basePath, config);
  await traceChanges(fs);

packages/create/test/unit/cli/add/mockserver-config.test.ts

@@ -103,7 +103,48 @@ describe('Test command add mockserver-config', () => {
  expect(logLevelSpy).not.toBeCalled();
  expect(loggerMock.debug).toBeCalled();
  expect(loggerMock.error).not.toBeCalled();
- expect(promptSpy).toBeCalledWith([{ webappPath: join(appRoot, 'webapp') }]);
+ expect(promptSpy).toBeCalledWith([{ webappPath: join(appRoot, 'webapp'), askForOverwrite: true }]);
+ expect(fsMock.commit).toBeCalled();
+ expect(spawnSpy).toBeCalled();
+ });
+
+ test('Test create-fiori add mockserver-config <appRoot> --interactive with overwrite option', async () => {
+ // Mock setup
+ jest.spyOn(mockserverWriter, 'getMockserverConfigQuestions').mockReturnValue([
+ {
+ name: 'path',
+ type: 'text',
+ message: 'Path to mocked service'
+ },
+ {
+ type: 'confirm',
+ name: 'overwrite',
+ message: 'Overwrite existing services'
+ }
+ ]);
+ const promptSpy = jest.spyOn(prompts, 'prompt');
+
+ // Test execution
+ const command = new Command('add');
+ addAddMockserverConfigCommand(command);
+ await command.parseAsync(getArgv(['mockserver-config', appRoot, '--interactive']));
+
+ // Result check
+ expect(logLevelSpy).not.toBeCalled();
+ expect(loggerMock.debug).toBeCalled();
+ expect(loggerMock.error).not.toBeCalled();
+ expect(promptSpy).toBeCalledWith([
+ {
+ name: 'path',
+ type: 'text',
+ message: 'Path to mocked service'
+ },
+ {
+ message: 'Overwrite existing services',
+ name: 'overwrite',
+ type: 'confirm'
+ }
+ ]);
  expect(fsMock.commit).toBeCalled();
  expect(spawnSpy).toBeCalled();
  });

packages/fiori-elements-writer/test/__snapshots__/alp.test.ts.snap

@@ -93,8 +93,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata/sap/SEPMRA_ALP_SO_ANA_SRV
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 ",
@@ -138,8 +138,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata/sap/SEPMRA_ALP_SO_ANA_SRV
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/localService/SEPMRA_PROD_MAN_ANNO_MDL.xml
@@ -2338,6 +2338,10 @@ xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\">
 </edmx:Edmx>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>
 <edmx:Edmx xmlns:edmx=\\"http://schemas.microsoft.com/ado/2007/06/edmx\\" xmlns:m=\\"http://schemas.microsoft.com/ado/2007/08/dataservices/metadata\\" xmlns:sap=\\"http://www.sap.com/Protocols/SAPData\\" Version=\\"1.0\\">
@@ -6071,8 +6075,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/sap/c_salesordermanage_srv/srvd/sap/c_salesordermanage_sd_aggregate/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 ",
@@ -6116,8 +6120,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/sap/c_salesordermanage_srv/srvd/sap/c_salesordermanage_sd_aggregate/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/annotations/annotation.xml
@@ -6246,6 +6250,10 @@ appDescription=A Fiori application.",
 </html>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <edmx:Edmx Version=\\"4.0\\" xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\">

packages/fiori-elements-writer/test/__snapshots__/feop.test.ts.snap

@@ -90,8 +90,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 ",
@@ -135,8 +135,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/annotations/annotation.xml
@@ -276,6 +276,10 @@ appDescription=A Fiori application.",
 </html>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <edmx:Edmx Version=\\"4.0\\" xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\"
@@ -3815,8 +3819,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 builder:
@@ -3876,8 +3880,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/annotations/annotation.xml
@@ -4040,6 +4044,10 @@ appDescription=A Fiori application.",
 </html>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <edmx:Edmx Version=\\"4.0\\" xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\"

packages/fiori-elements-writer/test/__snapshots__/fpm.test.ts.snap

@@ -91,8 +91,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 ",
@@ -136,8 +136,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/annotations/annotation.xml
@@ -326,6 +326,10 @@ MainTitle=Main",
 </html>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <edmx:Edmx Version=\\"4.0\\" xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\"
@@ -3834,8 +3838,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations: []
 builder:
@@ -3895,8 +3899,8 @@ server:
  mountPath: /
  services:
  - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
- metadataPath: ./webapp/localService/metadata.xml
- mockdataPath: ./webapp/localService/data
+ metadataPath: ./webapp/localService/mainService/metadata.xml
+ mockdataPath: ./webapp/localService/mainService/data
  generateMockData: true
  annotations:
  - localPath: ./webapp/annotations/annotation.xml
@@ -4160,6 +4164,10 @@ MainTitle=Main",
 </html>",
  "state": "modified",
  },
+ "webapp/localService/data/keep": Object {
+ "contents": "",
+ "state": "modified",
+ },
  "webapp/localService/metadata.xml": Object {
  "contents": "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <edmx:Edmx Version=\\"4.0\\" xmlns:edmx=\\"http://docs.oasis-open.org/odata/ns/edmx\\"