@sap-ux/ui5-test-writer 1.2.18 → 1.2.20

package/dist/types.d.ts

@@ -101,13 +101,18 @@ export interface FFOPAConfig {
     ui5Theme?: string;
     useVirtualPreviewEndpoints?: boolean;
 }
+export type ObjectPageNavigationParent = {
+    name: string;
+    navigationProperty: string;
+};
 export type ObjectPageNavigationParents = {
     parentLRName?: string;
-    parentOPName?: string;
-    parentOPTableSection?: string;
+    parentOPs: ObjectPageNavigationParent[];
 };
 export type SectionFormField = {
     property: string;
+    connectedFields?: string;
+    fieldGroup?: string;
 };
 export type TableColumn = {
     header?: string;

package/dist/utils/modelUtils.d.ts

@@ -107,4 +107,14 @@ export declare function getSelectionFieldItems(selectionFieldsAgg: TreeAggregati
  * @returns An array of filter field descriptions.
  */
 export declare function getFilterFields(pageModel: TreeModel): TreeAggregations;
+/**
+ * Parses a `DataFieldForAnnotation::<property>::<targetAnnotation>` style identifier.
+ *
+ * @param name - aggregation key or `field.name` from the spec model
+ * @returns the parsed property and target annotation, or undefined for non-annotation entries
+ */
+export declare function parseDataFieldForAnnotationName(name: string | undefined): {
+    property: string;
+    targetAnnotation: string;
+} | undefined;
 //# sourceMappingURL=modelUtils.d.ts.map

package/dist/utils/modelUtils.js

@@ -174,4 +174,25 @@ export function getFilterFields(pageModel) {
     const selectionFieldsAggregations = getAggregations(selectionFields);
     return selectionFieldsAggregations;
 }
+/**
+ * Parses a `DataFieldForAnnotation::<property>::<targetAnnotation>` style identifier.
+ *
+ * @param name - aggregation key or `field.name` from the spec model
+ * @returns the parsed property and target annotation, or undefined for non-annotation entries
+ */
+export function parseDataFieldForAnnotationName(name) {
+    if (!name) {
+        return undefined;
+    }
+    const segments = name.split('::');
+    if (segments.length < 3 || segments[0] !== 'DataFieldForAnnotation') {
+        return undefined;
+    }
+    const property = segments[1];
+    const targetAnnotation = segments[2];
+    if (!property || !targetAnnotation) {
+        return undefined;
+    }
+    return { property, targetAnnotation };
+}
 //# sourceMappingURL=modelUtils.js.map

package/dist/utils/objectPageUtils.js

@@ -1,4 +1,4 @@
-import { getAggregations } from './modelUtils.js';
+import { getAggregations, parseDataFieldForAnnotationName } from './modelUtils.js';
 import { extractTableColumnsFromNode } from './tableUtils.js';
 import { PageTypeV4 } from '@sap/ux-specification/dist/types/src/common/page.js';
 import { parse } from '@sap-ux/edmx-parser';
@@ -60,26 +60,40 @@ export function getObjectPages(applicationModel) {
     return objectPages;
 }
 /**
- * Finds parent pages for the object page, and returns their identifiers.
+ * Finds the chain of parent Object Pages leading from the List Report down to the target page.
  *
  * @param targetObjectPageKey - key of the target object page
  * @param objectPages - the array of object pages extracted from the application model
  * @param listReportPageKey - the key of the List Report page in the application model, used to find navigation routes to object pages
- * @returns navigation data including parent page identifiers
+ * @returns navigation data including the ordered ancestor Object Page chain
  */
 function getObjectPageNavigationParents(targetObjectPageKey, objectPages, listReportPageKey) {
-    const navigationParents = {
-        parentLRName: listReportPageKey ?? '' // app is possibly malformed if no LR found
-    };
-    objectPages.forEach((objectPage) => {
-        const navigationRoutes = getNavigationRoutes(objectPage);
-        const routeToTargetOP = navigationRoutes.find((nav) => nav.route === targetObjectPageKey);
-        if (routeToTargetOP) {
-            navigationParents.parentOPName = objectPage.name;
-            navigationParents.parentOPTableSection = routeToTargetOP.identifier;
+    const parentOPs = [];
+    const visited = new Set([targetObjectPageKey]); // guard against infinite loop in case of invalid manifest entries
+    let cursor = targetObjectPageKey;
+    while (true) {
+        const childKey = cursor;
+        let parent;
+        let parentNavigationProperty;
+        for (const objectPage of objectPages) {
+            const route = getNavigationRoutes(objectPage).find((navigation) => navigation.route === childKey);
+            if (route) {
+                parent = objectPage;
+                parentNavigationProperty = route.identifier;
+                break;
+            }
         }
-    });
-    return navigationParents;
+        if (!parent?.name || !parentNavigationProperty || visited.has(parent.name)) {
+            break;
+        }
+        visited.add(parent.name);
+        parentOPs.unshift({ name: parent.name, navigationProperty: parentNavigationProperty });
+        cursor = parent.name;
+    }
+    return {
+        parentLRName: listReportPageKey ?? '', // app is possibly malformed if no LR found
+        parentOPs
+    };
 }
 /**
  *  Extracts header sections data from an object page model.
@@ -133,7 +147,7 @@ function extractObjectPageBodySectionsData(objectPage, convertedMetadata, schema
         const sections = getAggregations(sectionsAggregation);
         Object.entries(sections).forEach(([sectionKey, section]) => {
             const sectionId = getSectionIdentifier(section) ?? sectionKey;
-            const subSections = extractBodySubSectionsData(section, sectionId);
+            const subSections = extractBodySubSectionsData(section, sectionId, convertedMetadata, objectPage.entitySet);
             const navigationProperty = getNavigationPropertyFromKey(sectionKey);
             const isTable = isTableSection(section);
             const sectionData = {
@@ -142,7 +156,9 @@ function extractObjectPageBodySectionsData(objectPage, convertedMetadata, schema
                 isTable,
                 custom: !!section.custom,
                 order: section?.order ?? -1,
-                fields: section.custom || isTable ? [] : extractFormFields(section),
+                fields: section.custom || isTable
+                    ? []
+                    : extractFormFields(section, convertedMetadata, objectPage.entitySet),
                 tableColumns: section.custom || !isTable ? {} : extractTableColumnsFromNode(section),
                 subSections,
                 actions: !section.custom && convertedMetadata && schemaNamespace
@@ -215,9 +231,11 @@ function extractSectionActions(section, convertedMetadata, schemaNamespace) {
  *
  * @param section - body section entry from the application model
  * @param parentSectionId - identifier of the parent section (used as fallback key prefix)
+ * @param convertedMetadata - optional converted OData metadata for drilling into ConnectedFields / FieldGroup wrappers
+ * @param entitySetName - the entity set the section is bound to (used to locate the entity type)
  * @returns array of sub-section feature data
  */
-function extractBodySubSectionsData(section, parentSectionId) {
+function extractBodySubSectionsData(section, parentSectionId, convertedMetadata, entitySetName) {
     const subSections = [];
     const subSectionsAggregation = getAggregations(section)['subSections'];
     const subSectionItems = getAggregations(subSectionsAggregation);
@@ -230,7 +248,7 @@ function extractBodySubSectionsData(section, parentSectionId) {
             isTable,
             custom: !!subSection.custom,
             order: subSection?.order ?? -1, // put a negative order number to signal that order was not in spec
-            fields: subSection.custom || isTable ? [] : extractFormFields(subSection),
+            fields: subSection.custom || isTable ? [] : extractFormFields(subSection, convertedMetadata, entitySetName),
             tableColumns: subSection.custom || !isTable ? {} : extractTableColumnsFromNode(subSection)
         });
     });
@@ -240,9 +258,11 @@ function extractBodySubSectionsData(section, parentSectionId) {
  * Extracts form field property paths from a body sub-section's form aggregation.
  *
  * @param subSection - body sub-section entry from the application model
+ * @param convertedMetadata - optional converted OData metadata for drilling into ConnectedFields / FieldGroup wrappers
+ * @param entitySetName - the entity set the sub-section is bound to (used to locate the entity type)
  * @returns array of form field property paths for use with iCheckField({ property })
  */
-function extractFormFields(subSection) {
+function extractFormFields(subSection, convertedMetadata, entitySetName) {
     const fields = [];
     const formAggregation = getAggregations(subSection)['form'];
     if (!formAggregation) {
@@ -250,14 +270,71 @@ function extractFormFields(subSection) {
     }
     const fieldsAggregation = getAggregations(formAggregation)['fields'];
     const fieldItems = getAggregations(fieldsAggregation);
-    Object.values(fieldItems).forEach((field) => {
-        const property = field.schema?.keys?.find((key) => key.name === 'Value')?.value;
-        if (property) {
-            fields.push({ property });
+    const entityType = convertedMetadata && entitySetName ? resolveEntityType(convertedMetadata, entitySetName) : undefined;
+    Object.values(fieldItems).forEach((fieldItem) => {
+        const annotationParts = parseDataFieldForAnnotationName(fieldItem.name);
+        const valueProperty = fieldItem.schema?.keys?.find((key) => key.name === 'Value')?.value;
+        const baseProperty = valueProperty ?? annotationParts?.property;
+        if (!baseProperty) {
+            return;
+        }
+        if (annotationParts) {
+            const qualifier = annotationParts.targetAnnotation;
+            if (annotationParts.property === 'ConnectedFields' && entityType) {
+                resolveConnectedFieldsInnerProperties(entityType, qualifier).forEach((property) => {
+                    fields.push({ property, connectedFields: qualifier });
+                });
+            }
+            else if (annotationParts.property === 'FieldGroup' && entityType) {
+                resolveFieldGroupInnerProperties(entityType, qualifier).forEach((property) => {
+                    fields.push({ property, fieldGroup: qualifier });
+                });
+            }
+            // ConnectedFields/FieldGroup without metadata: skip
+            // Unknown annotation wrapper type: skip
+        }
+        else {
+            fields.push({ property: baseProperty });
         }
     });
     return fields;
 }
+/**
+ * Resolves the inner `Value` paths of a `@UI.ConnectedFields#<qualifier>` annotation.
+ *
+ * @param entityType - the entity type carrying the annotation
+ * @param qualifier - the annotation qualifier
+ * @returns the inner DataField property paths
+ */
+function resolveConnectedFieldsInnerProperties(entityType, qualifier) {
+    const annotation = entityType.annotations?.UI?.[`ConnectedFields#${qualifier}`];
+    const dictionary = annotation?.Data ?? {};
+    return Object.values(dictionary)
+        .map((dataField) => dataField?.Value?.path)
+        .filter((path) => Boolean(path));
+}
+/**
+ * Resolves the inner `Value` paths of a `@UI.FieldGroup#<qualifier>` annotation.
+ *
+ * @param entityType - the entity type carrying the annotation
+ * @param qualifier - the annotation qualifier
+ * @returns the inner DataField property paths
+ */
+function resolveFieldGroupInnerProperties(entityType, qualifier) {
+    const annotation = entityType.annotations?.UI?.[`FieldGroup#${qualifier}`];
+    const dataFields = annotation?.Data ?? [];
+    return dataFields.map((dataField) => dataField?.Value?.path).filter((path) => Boolean(path));
+}
+/**
+ * Looks up the entity type for the given entity set name in the converted metadata.
+ *
+ * @param convertedMetadata - the converted OData metadata
+ * @param entitySetName - the entity set name
+ * @returns the entity type, or undefined if not found
+ */
+function resolveEntityType(convertedMetadata, entitySetName) {
+    return convertedMetadata.entitySets.find((es) => es.name === entitySetName)?.entityType;
+}
 /**
  * Extracts the OData navigation property from a spec model section key.
  * Section keys for table sections follow the pattern `_NavProperty::@annotation`, so the

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "1.2.18",
+  "version": "1.2.20",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",

package/templates/v4/integration/ObjectPageJourney.js

@@ -33,11 +33,11 @@ sap.ui.define([
             Then.onThe<%- navigationParents.parentLRName%>Generated.onTable().iCheckRows();
             When.onThe<%- navigationParents.parentLRName%>Generated.onTable().iPressRow(0);
 <% } -%>
-<% if(navigationParents.parentOPName) { %>
-            Then.onThe<%- navigationParents.parentOPName%>Generated.iSeeThisPage();
-            Then.onThe<%- navigationParents.parentOPName%>Generated.onTable({ property: "<%- navigationParents.parentOPTableSection %>" }).iCheckRows();
-            When.onThe<%- navigationParents.parentOPName%>Generated.onTable({ property: "<%- navigationParents.parentOPTableSection %>" }).iPressRow(0);
-<% } %>
+<% navigationParents.parentOPs.forEach(function(parent) { %>
+            Then.onThe<%- parent.name %>Generated.iSeeThisPage();
+            Then.onThe<%- parent.name %>Generated.onTable({ property: "<%- parent.navigationProperty %>" }).iCheckRows();
+            When.onThe<%- parent.name %>Generated.onTable({ property: "<%- parent.navigationProperty %>" }).iPressRow(0);
+<% }); %>
             Then.onThe<%- name%>Generated.iSeeThisPage();
         });
 
@@ -129,7 +129,7 @@ sap.ui.define([
             Then.onThe<%- name%>Generated.iCheckSubSection({ section: "<%- subSection.id %>" });
 <% if (subSection.fields && subSection.fields.length > 0) { -%>
 <% subSection.fields.forEach(function(field) { -%>
-            Then.onThe<%- name%>Generated.onForm({ section: "<%- subSection.id %>" }).iCheckField({ property: "<%- field.property %>" });
+            Then.onThe<%- name%>Generated.onForm({ section: "<%- subSection.id %>" }).iCheckField({ property: "<%- field.property %>"<% if (field.connectedFields) { %>, connectedFields: "<%- field.connectedFields %>"<% } %><% if (field.fieldGroup) { %>, fieldGroup: "<%- field.fieldGroup %>"<% } %> });
 <% }) -%>
 <% } -%>
 <% if (subSection.tableColumns && Object.keys(subSection.tableColumns).length > 0 && subSection.navigationProperty) { -%>
@@ -139,7 +139,7 @@ sap.ui.define([
 <% } else { -%>
 <% if (section.fields && section.fields.length > 0) { -%>
 <% section.fields.forEach(function(field) { -%>
-            Then.onThe<%- name%>Generated.onForm({ section: "<%- section.id %>" }).iCheckField({ property: "<%- field.property %>" });
+            Then.onThe<%- name%>Generated.onForm({ section: "<%- section.id %>" }).iCheckField({ property: "<%- field.property %>"<% if (field.connectedFields) { %>, connectedFields: "<%- field.connectedFields %>"<% } %><% if (field.fieldGroup) { %>, fieldGroup: "<%- field.fieldGroup %>"<% } %> });
 <% }) -%>
 <% } -%>
 <% if (section.tableColumns && Object.keys(section.tableColumns).length > 0 && section.navigationProperty) { -%>

package/templates/v4/integration/ObjectPageJourney.ts

@@ -52,11 +52,11 @@ function journey() {
         Then.onThe<%- navigationParents.parentLRName%>Generated.onTable("").iCheckRows();
         When.onThe<%- navigationParents.parentLRName%>Generated.onTable("").iPressRow(0);
 <% } -%>
-<% if(navigationParents.parentOPName) { %>
-        Then.onThe<%- navigationParents.parentOPName%>Generated.iSeeThisPage();
-        Then.onThe<%- navigationParents.parentOPName%>Generated.onTable({ property: "<%- navigationParents.parentOPTableSection %>" }).iCheckRows();
-        When.onThe<%- navigationParents.parentOPName%>Generated.onTable({ property: "<%- navigationParents.parentOPTableSection %>" }).iPressRow(0);
-<% } %>
+<% navigationParents.parentOPs.forEach(function(parent) { %>
+        Then.onThe<%- parent.name %>Generated.iSeeThisPage();
+        Then.onThe<%- parent.name %>Generated.onTable({ property: "<%- parent.navigationProperty %>" }).iCheckRows();
+        When.onThe<%- parent.name %>Generated.onTable({ property: "<%- parent.navigationProperty %>" }).iPressRow(0);
+<% }); %>
         Then.onThe<%- name%>Generated.iSeeThisPage();
     });
 
@@ -148,7 +148,7 @@ function journey() {
         Then.onThe<%- name%>Generated.iCheckSubSection({ section: "<%- subSection.id %>" });
 <% if (subSection.fields && subSection.fields.length > 0) { -%>
 <% subSection.fields.forEach(function(field) { -%>
-        Then.onThe<%- name%>Generated.onForm({ section: "<%- subSection.id %>" } as unknown as FormIdentifier).iCheckField({ property: "<%- field.property %>" });
+        Then.onThe<%- name%>Generated.onForm({ section: "<%- subSection.id %>" } as unknown as FormIdentifier).iCheckField({ property: "<%- field.property %>"<% if (field.connectedFields) { %>, connectedFields: "<%- field.connectedFields %>"<% } %><% if (field.fieldGroup) { %>, fieldGroup: "<%- field.fieldGroup %>"<% } %> });
 <% }) -%>
 <% } -%>
 <% if (subSection.tableColumns && Object.keys(subSection.tableColumns).length > 0 && subSection.navigationProperty) { -%>
@@ -158,7 +158,7 @@ function journey() {
 <% } else { -%>
 <% if (section.fields && section.fields.length > 0) { -%>
 <% section.fields.forEach(function(field) { -%>
-        Then.onThe<%- name%>Generated.onForm({ section: "<%- section.id %>" } as unknown as FormIdentifier).iCheckField({ property: "<%- field.property %>" });
+        Then.onThe<%- name%>Generated.onForm({ section: "<%- section.id %>" } as unknown as FormIdentifier).iCheckField({ property: "<%- field.property %>"<% if (field.connectedFields) { %>, connectedFields: "<%- field.connectedFields %>"<% } %><% if (field.fieldGroup) { %>, fieldGroup: "<%- field.fieldGroup %>"<% } %> });
 <% }) -%>
 <% } -%>
 <% if (section.tableColumns && Object.keys(section.tableColumns).length > 0 && section.navigationProperty) { -%>