@sap-ux/ui5-test-writer 0.7.96 → 0.7.98

package/dist/types.d.ts

@@ -67,12 +67,26 @@ export type ObjectPageNavigationParents = {
     parentOPName?: string;
     parentOPTableSection?: string;
 };
+export type BodySubSectionFeatureData = {
+    id: string;
+    isTable: boolean;
+    custom: boolean;
+    order: number;
+};
+export type BodySectionFeatureData = {
+    id: string;
+    isTable: boolean;
+    custom: boolean;
+    order: number;
+    subSections: BodySubSectionFeatureData[];
+};
 export type ObjectPageFeatures = {
     name?: string;
     navigationParents?: ObjectPageNavigationParents;
     headerTitle?: string;
     headerDescription?: string;
     headerSections?: HeaderSectionFeatureData[];
+    bodySections?: BodySectionFeatureData[];
 };
 export type ListReportFeatures = {
     name?: string;
@@ -121,6 +135,11 @@ export type AppFeatures = {
     objectPages?: ObjectPageFeatures[];
     fpm?: FPMFeatures;
 };
+export type FormField = {
+    fieldGroupQualifier?: string;
+    field?: string;
+    targetAnnotation?: string;
+};
 export type HeaderSectionFeatureData = {
     facetId?: string;
     title?: string;
@@ -129,10 +148,7 @@ export type HeaderSectionFeatureData = {
     microChart?: boolean;
     form?: boolean;
     stashed?: boolean | string;
-    fields?: {
-        fieldGroupQualifier?: string;
-        field?: string;
-    }[];
+    fields?: FormField[];
 };
 export interface ButtonState {
     visible: boolean;

package/dist/utils/modelUtils.d.ts

@@ -10,6 +10,7 @@ export interface AggregationItem extends TreeAggregation {
             name: string;
             value: string;
         }[];
+        dataType?: string;
     };
 }
 export interface FieldItem extends AggregationItem {
@@ -19,6 +20,7 @@ export interface SectionItem extends AggregationItem {
     title?: string;
     custom?: boolean;
     name?: string;
+    order?: number;
     schema: {
         keys: {
             name: string;
@@ -27,6 +29,9 @@ export interface SectionItem extends AggregationItem {
         dataType?: string;
     };
 }
+export interface BodySectionItem extends SectionItem {
+    isTable?: boolean;
+}
 export interface HeaderSectionItem extends SectionItem {
     properties: {
         stashed: {

package/dist/utils/objectPageUtils.js

@@ -25,6 +25,8 @@ async function getObjectPageFeatures(objectPages, listReportPageKey, log) {
         pageFeatureData.navigationParents = getObjectPageNavigationParents(objectPage.name, objectPages, listReportPageKey);
         // extract header sections (facets)
         pageFeatureData.headerSections = extractObjectPageHeaderSectionsData(objectPage);
+        // extract body sections
+        pageFeatureData.bodySections = extractObjectPageBodySectionsData(objectPage);
         objectPageFeatures.push(pageFeatureData);
     }
     return objectPageFeatures;
@@ -103,6 +105,53 @@ function extractObjectPageHeaderSectionsData(objectPage) {
     }
     return headerSections;
 }
+/**
+ * Extracts body sections data from an object page model.
+ *
+ * @param objectPage - object page from the application model
+ * @returns body sections data including sub-sections
+ */
+function extractObjectPageBodySectionsData(objectPage) {
+    const bodySections = [];
+    if (objectPage.model) {
+        const sectionsAggregation = (0, modelUtils_1.getAggregations)(objectPage.model.root)['sections'];
+        const sections = (0, modelUtils_1.getAggregations)(sectionsAggregation);
+        Object.entries(sections).forEach(([sectionKey, section]) => {
+            const sectionId = getSectionIdentifier(section) ?? sectionKey;
+            const subSections = extractBodySubSectionsData(section, sectionId);
+            bodySections.push({
+                id: sectionId,
+                isTable: !!section.isTable,
+                custom: !!section.custom,
+                order: section?.order ?? -1, // put a negative order number to signal that order was not in spec
+                subSections
+            });
+        });
+    }
+    return bodySections;
+}
+/**
+ * Extracts sub-sections data from a body section.
+ *
+ * @param section - body section entry from the application model
+ * @param parentSectionId - identifier of the parent section (used as fallback key prefix)
+ * @returns array of sub-section feature data
+ */
+function extractBodySubSectionsData(section, parentSectionId) {
+    const subSections = [];
+    const subSectionsAggregation = (0, modelUtils_1.getAggregations)(section)['subSections'];
+    const subSectionItems = (0, modelUtils_1.getAggregations)(subSectionsAggregation);
+    Object.entries(subSectionItems).forEach(([subSectionKey, subSection]) => {
+        const subSectionId = getSectionIdentifier(subSection) ?? `${parentSectionId}_${subSectionKey}`;
+        subSections.push({
+            id: subSectionId,
+            isTable: !!subSection.isTable,
+            custom: !!subSection.custom,
+            order: subSection?.order ?? -1 // put a negative order number to signal that order was not in spec
+        });
+    });
+    return subSections;
+}
 /**
  * Gets the identifier of a section for OPA5 tests.
  *
@@ -113,14 +162,14 @@ function getSectionIdentifier(section) {
     return getSectionIdentifierFromKey(section) ?? getSectionIdentifierFromTitle(section);
 }
 /**
- * Gets the identifier of a section from the 'ID' entry in the schema keys for OPA5 tests.
+ * Gets the identifier of a section from the 'ID' or 'Key' entry in the schema keys for OPA5 tests.
  * If no such entry is found, undefined is returned.
  *
  * @param section - section entry from ux specification
- * @returns identifier of the section for OPA5 tests; can be undefined if no 'ID' entry is found
+ * @returns identifier of the section for OPA5 tests; can be undefined if no 'ID' or 'Key' entry is found
  */
 function getSectionIdentifierFromKey(section) {
-    const keyEntry = section?.schema?.keys?.find((key) => key.name === 'ID');
+    const keyEntry = section?.schema?.keys?.find((key) => key.name === 'ID' || key.name === 'Key');
     return keyEntry ? keyEntry.value.replace('#', '::') : undefined;
 }
 /**
@@ -155,16 +204,38 @@ function getHeaderSectionFormFields(section) {
     if (fields) {
         Object.keys(fields).forEach((fieldKey) => {
             const field = fields[fieldKey];
-            if (field?.name) {
-                formFields.push({
-                    fieldGroupQualifier: getFieldGroupQualifier(formAggregation),
-                    field: field.schema.keys.find((key) => key.name === 'Value')?.value
-                });
+            const fieldData = getFormFieldData(field, formAggregation);
+            if (fieldData) {
+                formFields.push(fieldData);
             }
         });
     }
     return formFields;
 }
+/**
+ * Gets field data for a form field in a header section for OPA5 tests, including its identifier, bound property, and target annotation.
+ *
+ * @param field - field entry from ux specification
+ * @param formAggregation - form aggregation entry from ux specification, used to get field group qualifier for the field
+ * @returns field data including its identifier, bound property, and target annotation for OPA5 tests; can be undefined if the field type is not supported or necessary information is missing
+ */
+function getFormFieldData(field, formAggregation) {
+    if (!field.name) {
+        return undefined;
+    }
+    let [_, propertyName, targetAnnotation] = field.name.split('::');
+    // fall back to Value property in case of malformed or otherwise irregular field name
+    if (!propertyName) {
+        propertyName = field.schema.keys.find((key) => key.name === 'Value')?.value;
+    }
+    const fieldIdentifier = {
+        fieldGroupQualifier: getFieldGroupQualifier(formAggregation),
+        field: propertyName,
+        targetAnnotation: targetAnnotation
+    };
+    // avoid creating identifier if field property could not be determined
+    return fieldIdentifier.field ? fieldIdentifier : undefined;
+}
 /**
  * Gets the field group qualifier of a form aggregation for OPA5 tests.
  *

package/package.json

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

package/templates/v4/integration/ObjectPageJourney.js

@@ -51,6 +51,7 @@ sap.ui.define([
             Then.onThe<%- name%>.onHeader().iCheckFieldInFieldGroup({
                 fieldGroup: "FieldGroup::<%- field.fieldGroupQualifier %>",
                 field: "<%- field.field %>",
+                targetAnnotation: "<%- field.targetAnnotation %>"
             });
 <% }) -%>
 <% } -%>
@@ -59,6 +60,22 @@ sap.ui.define([
         });
 <% } -%>
 
+<% if (bodySections?.length > 0) { -%>
+        opaTest("Check body sections of the Object Page", function (Given, When, Then) {
+            Then.onThe<%- name%>.iCheckNumberOfSections(<%- bodySections.length %>);
+<% bodySections.forEach(function(section) { -%>
+            When.onThe<%- name%>.iGoToSection({ section: "<%- section.id %>" });
+            Then.onThe<%- name%>.iCheckSection({ section: "<%- section.id %>" });
+<% if (section?.subSections?.length > 0) { -%>
+<% section.subSections.forEach(function(subSection) { -%>
+            When.onThe<%- name%>.iGoToSection({ section: "<%- section.id %>", subSection: "<%- subSection.id %>" });
+            Then.onThe<%- name%>.iCheckSubSection({ section: "<%- subSection.id %>" });
+<% }) -%>
+<% } -%>
+<% }) -%>
+       });
+<% } -%>
+
         opaTest("Teardown", function (Given, When, Then) { 
             // Cleanup
             Given.iTearDownMyApp();