@sap/open.fe 1.96.0 → 1.97.0

package/packages/sap.fe.macros/test/sap/fe/macros/jest/ChartHelper.spec.ts

@@ -0,0 +1,440 @@
+//@ts-ignore
+import { ChartHelper } from "sap/fe/macros/chart";
+//@ts-ignore
+import { CommonHelper } from "sap/fe/macros";
+
+describe("ChartHelper", function() {
+	afterAll(() => {
+		jest.restoreAllMocks();
+	});
+	const mockAnnotationContext = {
+		oModel: {},
+		sPath: "/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath",
+		getPath: jest.fn(() => {
+			return "/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath";
+		}),
+		getObject: jest.fn(),
+		getModel: jest.fn()
+	};
+	const mockModel = {
+		getMetaContext: jest.fn((sPath: String) => {
+			return {
+				sPath: sPath
+			};
+		}),
+		getObject: jest.fn(),
+		createBindingContext: jest.fn(),
+		requestObject: jest.fn()
+	};
+	const chartCollection = {
+		Actions: [
+			{
+				$Type: "com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation",
+				SemanticObject: "someSO",
+				Action: "someAction",
+				Label: "IBN",
+				RequiresContext: true
+			},
+			{
+				$Type: "com.sap.vocabularies.UI.v1.DataFieldForAction",
+				Label: "Dummy action",
+				Action: "com.service.someBoundAction",
+				RequiresContext: true
+			}
+		]
+	};
+	const mockOData = {
+		chartCollection: chartCollection,
+		oInterface: { context: mockAnnotationContext }
+	};
+
+	describe("formatDimensions", function() {
+		it("verify chart dimensions", async function() {
+			mockModel.getObject.mockReturnValue("some label");
+			mockModel.createBindingContext.mockReturnValue({
+				oModel: {},
+				sPath: "/SalesOrderManage/SalesOrder",
+				bForceRefresh: false,
+				sDeepPath: ""
+			});
+			mockModel.requestObject.mockReturnValue(Promise.resolve({}));
+			mockAnnotationContext.getObject.mockReturnValue({
+				$Type: "com.sap.vocabularies.UI.v1.ChartDefinitionType",
+				ChartType: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartType/Column" },
+				Description: "Testing Line Chart",
+				DimensionAttributes: [
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartDimensionAttributeType",
+						Dimension: { $PropertyPath: "SalesOrder" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartDimensionRoleType/Axis1" }
+					},
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartDimensionAttributeType",
+						Dimension: { $PropertyPath: "SoldToParty" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartDimensionRoleType/Axis1" }
+					}
+				],
+				Dimensions: [{ $PropertyPath: "SalesOrder" }, { $PropertyPath: "SoldToParty" }],
+				MeasureAttributes: [
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartMeasureAttributeType",
+						Measure: { $PropertyPath: "maxPricing" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartMeasureRoleType/Axis1" }
+					}
+				],
+				Measures: [{ $PropertyPath: "maxPricing" }],
+				Title: "Height Line Chart"
+			});
+			mockAnnotationContext.getModel.mockReturnValue(mockModel);
+			expect(
+				ChartHelper.formatDimensions(mockAnnotationContext)
+					.getModel()
+					.getJSON()
+			).toEqual(
+				'[{"key":"SalesOrder","label":"some label","role":"category","criticality":{}},{"key":"SoldToParty","label":"some label","role":"category","criticality":{}}]'
+			);
+		});
+	});
+
+	describe("formatMeasures", function() {
+		it("verify chart measures", async function() {
+			mockModel.getObject.mockImplementation((sPath: String) => {
+				if (sPath.indexOf("AggregatedProperties") > -1) {
+					return [
+						{
+							Name: "minPricing",
+							"@com.sap.vocabularies.Common.v1.Label": "Minimal Net Amount",
+							$Type: "com.sap.vocabularies.Analytics.v1.AggregatedPropertyType",
+							Value: "minPricing",
+							AggregationMethod: "min",
+							AggregatableProperty: { $PropertyPath: "NetPricing" }
+						},
+						{
+							Name: "maxPricing",
+							"@com.sap.vocabularies.Common.v1.Label": "Maximal Net Amount",
+							$Type: "com.sap.vocabularies.Analytics.v1.AggregatedPropertyType",
+							Value: "maxPricing",
+							AggregationMethod: "max",
+							AggregatableProperty: { $PropertyPath: "NetPricing" }
+						},
+						{
+							Name: "avgPricing",
+							"@com.sap.vocabularies.Common.v1.Label": "Average Net Amount",
+							$Type: "com.sap.vocabularies.Analytics.v1.AggregatedPropertyType",
+							Value: "avgPricing",
+							AggregationMethod: "average",
+							AggregatableProperty: { $PropertyPath: "NetPricing" }
+						}
+					];
+				}
+				return "Maximal Net Amount";
+			});
+			mockModel.createBindingContext.mockReturnValue({
+				oModel: {},
+				sPath: "/SalesOrderManage/SalesOrder",
+				bForceRefresh: false,
+				sDeepPath: ""
+			});
+			mockModel.requestObject.mockReturnValue(Promise.resolve({}));
+			mockAnnotationContext.getObject.mockReturnValue({
+				$Type: "com.sap.vocabularies.UI.v1.ChartDefinitionType",
+				ChartType: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartType/Column" },
+				Description: "Testing Line Chart",
+				DimensionAttributes: [
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartDimensionAttributeType",
+						Dimension: { $PropertyPath: "SalesOrder" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartDimensionRoleType/Axis1" }
+					},
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartDimensionAttributeType",
+						Dimension: { $PropertyPath: "SoldToParty" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartDimensionRoleType/Axis1" }
+					}
+				],
+				Dimensions: [{ $PropertyPath: "SalesOrder" }, { $PropertyPath: "SoldToParty" }],
+				MeasureAttributes: [
+					{
+						$Type: "com.sap.vocabularies.UI.v1.ChartMeasureAttributeType",
+						Measure: { $PropertyPath: "maxPricing" },
+						Role: { $EnumMember: "com.sap.vocabularies.UI.v1.ChartMeasureRoleType/Axis1" }
+					}
+				],
+				Measures: [{ $PropertyPath: "maxPricing" }],
+				Title: "Height Line Chart"
+			});
+			mockAnnotationContext.getModel.mockReturnValue(mockModel);
+			expect(
+				ChartHelper.formatMeasures(mockAnnotationContext)
+					.getModel()
+					.getJSON()
+			).toEqual(
+				'[{"key":"maxPricing","label":"Maximal Net Amount","role":"axis1","propertyPath":"NetPricing","aggregationMethod":"max"}]'
+			);
+		});
+	});
+
+	describe("getUiChart", function() {
+		it("with Chart annotation", async function() {
+			mockAnnotationContext.sPath =
+				"/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath";
+			mockAnnotationContext.getPath.mockReturnValue(mockAnnotationContext.sPath);
+			mockAnnotationContext.getObject.mockReturnValue("@com.sap.vocabularies.UI.v1.Chart");
+			expect(ChartHelper.getUiChart(mockAnnotationContext).sPath).toBe(
+				"/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath"
+			);
+		});
+
+		it("with Presentation Variant", async function() {
+			mockAnnotationContext.sPath = "/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant";
+			mockAnnotationContext.getPath.mockReturnValue(mockAnnotationContext.sPath);
+			mockAnnotationContext.getObject.mockImplementation((sParam: String) => {
+				if (sParam.indexOf("@sapui.name") > -1) {
+					return "@com.sap.vocabularies.UI.v1.PresentationVariant";
+				}
+
+				return {
+					$Type: "com.sap.vocabularies.UI.v1.PresentationVariantType",
+					Visualizations: [
+						{ $AnnotationPath: "@com.sap.vocabularies.UI.v1.Chart" },
+						{ $AnnotationPath: "@com.sap.vocabularies.UI.v1.Line" }
+					]
+				};
+			});
+			mockAnnotationContext.getModel.mockReturnValue(mockModel);
+			expect(ChartHelper.getUiChart(mockAnnotationContext).sPath).toBe("/SalesOrderManage/@com.sap.vocabularies.UI.v1.Chart");
+		});
+	});
+
+	describe("getMultiSelectDisabledActions", function() {
+		beforeAll(() => {
+			jest.spyOn(CommonHelper, "getActionPath").mockImplementationOnce((sActionName: string) => {
+				return "SalesOrderManager" + sActionName;
+			});
+		});
+
+		it("no annotations for action parameter", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.indexOf("@$ui5.overload") > -1) {
+					return {
+						$kind: "Action",
+						$IsBound: true,
+						$EntitySetPath: "_it",
+						$Parameter: [
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "_it"
+							}
+						],
+						$ReturnType: {
+							$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+						}
+					};
+				}
+				return {};
+			});
+			mockAnnotationContext.sPath =
+				"/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath/actions";
+			expect(ChartHelper.getMultiSelectDisabledActions(mockOData.chartCollection, mockOData.oInterface)).toEqual([]);
+		});
+
+		it("static value of ui.hidden annotated for action parameter", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				{
+					if (sPath.indexOf("@$ui5.overload") > -1) {
+						return {
+							$kind: "Action",
+							$IsBound: true,
+							$EntitySetPath: "_it",
+							$Parameter: [
+								{
+									$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+									$Name: "_it"
+								},
+								{
+									$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+									$Name: "someParameter"
+								}
+							],
+							$ReturnType: {
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+							}
+						};
+					} else if (sPath.endsWith("@")) {
+						return {
+							"@com.sap.vocabularies.UI.v1.Hidden": true
+						};
+					}
+					return {};
+				}
+			});
+			expect(ChartHelper.getMultiSelectDisabledActions(mockOData.chartCollection, mockOData.oInterface)).toEqual([]);
+		});
+
+		it("path based ui.hidden annotated for action parameter", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.indexOf("@$ui5.overload") > -1) {
+					return {
+						$kind: "Action",
+						$IsBound: true,
+						$EntitySetPath: "_it",
+						$Parameter: [
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "_it"
+							},
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "someParameter"
+							}
+						],
+						$ReturnType: {
+							$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+						}
+					};
+				} else if (sPath.endsWith("@")) {
+					return {
+						"@com.sap.vocabularies.UI.v1.Hidden": {
+							$Path: "somePath"
+						}
+					};
+				}
+				return {};
+			});
+			expect(ChartHelper.getMultiSelectDisabledActions(mockOData.chartCollection, mockOData.oInterface)).toEqual([
+				"com.service.someBoundAction"
+			]);
+		});
+
+		it("path based field control annotated for action parameter", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.indexOf("@$ui5.overload") > -1) {
+					return {
+						$kind: "Action",
+						$IsBound: true,
+						$EntitySetPath: "_it",
+						$Parameter: [
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "_it"
+							},
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "someParameter"
+							}
+						],
+						$ReturnType: {
+							$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+						}
+					};
+				} else if (sPath.endsWith("@")) {
+					return {
+						"@com.sap.vocabularies.Common.v1.FieldControl": {
+							$Path: "somePath"
+						}
+					};
+				}
+				return {};
+			});
+			expect(ChartHelper.getMultiSelectDisabledActions(mockOData.chartCollection, mockOData.oInterface)).toEqual([
+				"com.service.someBoundAction"
+			]);
+		});
+
+		it("action parameter annotated with static field control", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.indexOf("@$ui5.overload") > -1) {
+					return {
+						$kind: "Action",
+						$IsBound: true,
+						$EntitySetPath: "_it",
+						$Parameter: [
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "_it"
+							},
+							{
+								$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage",
+								$Name: "someParameter"
+							}
+						],
+						$ReturnType: {
+							$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+						}
+					};
+				} else if (sPath.endsWith("@")) {
+					return {
+						"@com.sap.vocabularies.Common.v1.FieldControl": "ReadOnly"
+					};
+				}
+				return {};
+			});
+			expect(ChartHelper.getMultiSelectDisabledActions(mockOData.chartCollection, mockOData.oInterface)).toEqual([]);
+		});
+	});
+
+	describe("getOperationAvailableMap", function() {
+		beforeAll(() => {
+			jest.spyOn(CommonHelper, "getEntitySetName").mockImplementationOnce(() => {
+				return "SalesOrderManage";
+			});
+		});
+		mockAnnotationContext.sPath =
+			"/SalesOrderManage/@com.sap.vocabularies.UI.v1.PresentationVariant/Visualizations/0/$AnnotationPath/actions";
+		mockAnnotationContext.getPath.mockReturnValue(mockAnnotationContext.sPath);
+		it("static value of operation available", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.endsWith("@Org.OData.Core.V1.OperationAvailable")) {
+					return true;
+				} else if (sPath.endsWith("/$Path")) {
+					return;
+				} else if (sPath.endsWith("/@$ui5.overload/0/$Parameter/0/$Name")) {
+					return "_it";
+				}
+				return {
+					$kind: "EntitySet",
+					$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+				};
+			});
+			expect(ChartHelper.getOperationAvailableMap(mockOData.chartCollection, mockOData.oInterface)).toBe("{}");
+		});
+
+		it("operation available annotated as null", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.endsWith("@Org.OData.Core.V1.OperationAvailable")) {
+					return null;
+				} else if (sPath.endsWith("/$Path")) {
+					return;
+				} else if (sPath.endsWith("/@$ui5.overload/0/$Parameter/0/$Name")) {
+					return "_it";
+				}
+				return {
+					$kind: "EntitySet",
+					$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+				};
+			});
+			expect(ChartHelper.getOperationAvailableMap(mockOData.chartCollection, mockOData.oInterface)).toBe(
+				'{"com.service.someBoundAction":null}'
+			);
+		});
+
+		it("operation available having $path", async function() {
+			mockAnnotationContext.getObject.mockImplementation((sPath: String) => {
+				if (sPath.endsWith("@Org.OData.Core.V1.OperationAvailable")) {
+					return { $Path: "_it/somePath" };
+				} else if (sPath.endsWith("/$Path")) {
+					return "_it/somePath";
+				} else if (sPath.endsWith("/@$ui5.overload/0/$Parameter/0/$Name")) {
+					return "_it";
+				}
+				return {
+					$kind: "EntitySet",
+					$Type: "com.c_salesordermanage_sd_aggregate.SalesOrderManage"
+				};
+			});
+			expect(ChartHelper.getOperationAvailableMap(mockOData.chartCollection, mockOData.oInterface)).toBe(
+				'{"com.service.someBoundAction":"somePath"}'
+			);
+		});
+	});
+});