Codeunit 135104 Perf. Profiler Test Library
src/System Application/Test Library/Performance Profiler/src/PerfProfilerTestLibrary.Codeunit.al241 lines, Copyright (c) Microsoft Corporation. MIT
// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.TestLibraries.Tooling;using System.Tooling;using System.Utilities;/// <summary>/// Exposes methods from "Profiling Data Processor" and "Profiling Chart Helper" codeunits/// </summary>codeunit 135104 "Perf. Profiler Test Library"{ var ProfilingDataProcessor: Codeunit "Profiling Data Processor"; /// <summary> /// Initializes the profiling data processor with the default test profiling data. /// </summary> procedure Initialize() begin Initialize(GetTestPerformanceProfile()); end; /// <summary> /// Initializes the profiling data processor with the test profiling data, allowing to load a specific profile required for a test. /// </summary> procedure Initialize(PerformanceProfile: Text) var TempRawProfilingNode: Record "Profiling Node"; TempCallTreeProfilingNode: Record "Profiling Node"; SamplingPerformanceProfiler: Codeunit "Sampling Performance Profiler"; TempBlob: Codeunit "Temp Blob"; SetDataInStr: InStream; OutStr: OutStream; begin TempBlob.CreateOutStream(OutStr); OutStr.Write(PerformanceProfile); TempBlob.CreateInStream(SetDataInStr); SamplingPerformanceProfiler.SetData(SetDataInStr); SamplingPerformanceProfiler.GetProfilingNodes(TempRawProfilingNode); SamplingPerformanceProfiler.GetProfilingCallTree(TempCallTreeProfilingNode); ProfilingDataProcessor.Initialize(TempRawProfilingNode, TempCallTreeProfilingNode); end; /// <summary> /// Initializes the profiling data processor with the profiling data. /// </summary> /// <param name="RawProfilingNode">The performance profiling data.</param> /// <remarks>The data processor will reference the provided data, not copy it.</remarks> procedure Initialize(var RawProfilingNode: Record "Profiling Node"; var CallTreeProfilingNode: Record "Profiling Node") begin ProfilingDataProcessor.Initialize(RawProfilingNode, CallTreeProfilingNode); end; /// <summary> /// Clears the previously initialized performance profiling data. /// </summary> procedure ClearData(); var SamplingPerformanceProfiler: Codeunit "Sampling Performance Profiler"; EmptyTempBlob: Codeunit "Temp Blob"; InStr: InStream; begin EmptyTempBlob.CreateInStream(InStr); SamplingPerformanceProfiler.SetData(InStr); ProfilingDataProcessor.ClearData(); end; /// <summary> /// Checks if the profiling data processor is initialized with <see cref="Initialize"/> method. /// </summary> /// <returns>True, if the profiling data processor is initialized, false otherwise.</returns> procedure IsInitialized(): Boolean begin exit(ProfilingDataProcessor.IsInitialized()); end; /// <summary> /// Gets aggregate self time of profiling nodes using the provided aggregation type. /// </summary> /// <param name="AggregatedProfilingNode">The resulting aggregation.</param> /// <param name="TestProfilingAggregationType">The value of what to aggregate self time by.</param> procedure GetSelfTimeAggregate(var AggregatedProfilingNode: Record "Profiling Node"; TestProfilingAggregationType: Enum "Test Prof. Aggregation Type") begin ProfilingDataProcessor.GetSelfTimeAggregate(AggregatedProfilingNode, GetAggregationType(TestProfilingAggregationType)); end; /// <summary> /// Gets aggregate self time of profiling nodes using the provided aggregation type. /// </summary> /// <param name="AggregatedProfilingNode">The resulting aggregation.</param> /// <param name="TestProfilingAggregationType">The value of what to aggregate self time by.</param> /// <param name="FilterText">The table view to indicate which profiling nodes should be included in aggregation.</param> procedure GetSelfTimeAggregate(var AggregatedProfilingNode: Record "Profiling Node"; TestProfilingAggregationType: Enum "Test Prof. Aggregation Type"; FilterText: Text) begin ProfilingDataProcessor.GetSelfTimeAggregate(AggregatedProfilingNode, GetAggregationType(TestProfilingAggregationType), FilterText); end; /// <summary> /// Gets aggregate full time of profiling nodes using the provided aggregation type. /// </summary> /// <param name="AggregatedProfilingNode">The resulting aggregation.</param> /// <param name="TestProfilingAggregationType">The value of what to aggregate full time by.</param> procedure GetFullTimeAggregate(var AggregatedProfilingNode: Record "Profiling Node"; TestProfilingAggregationType: Enum "Test Prof. Aggregation Type") begin ProfilingDataProcessor.GetFullTimeAggregate(AggregatedProfilingNode, GetAggregationType(TestProfilingAggregationType)); end; /// <summary> /// Constructs and returns a unique string (with respect to aggregation type) from the provided profiling node. /// </summary> /// <param name="ProfilingNode">The node from which to construct a unique identifier.</param> /// <param name="TestProfilingAggregationType">The aggregation type.</param> /// <returns>A unique (per aggregation type) string from the provided profiling node.</returns> procedure GetUniqueIdentifierByAggregationType(ProfilingNode: Record "Profiling Node"; TestProfilingAggregationType: Enum "Test Prof. Aggregation Type"): Text begin exit(ProfilingDataProcessor.GetUniqueIdentifierByAggregationType(ProfilingNode, GetAggregationType(TestProfilingAggregationType))); end; /// <summary> /// Gets the dictionary with aggregation type identifiers as keys, and aggregated self time / full time as values. /// </summary> /// <param name="TestProfilingAggregationType">The aggregation type.</param> /// <param name="AggregateBySelfTime">True if aggregation should be performed over self time, false indicates that the aggregation should be made over full time.</param> /// <param name="ChartLabels">The labels for the chart.</param> /// <param name="ChartValues">The measure values associated with the labels.</param> /// <remarks>ProfilingDataProcessor must be initialized for this method to work.</remarks> procedure GetChartData(TestProfilingAggregationType: Enum "Test Prof. Aggregation Type"; AggregateBySelfTime: Boolean; ChartLabels: List of [Text]; ChartValues: List of [Integer]) var ProfilingChartHelper: Codeunit "Profiling Chart Helper"; begin ProfilingChartHelper.GetChartData(GetAggregationType(TestProfilingAggregationType), AggregateBySelfTime, ChartLabels, ChartValues); end; /// <summary> /// Gets a test performance profile. /// </summary> /// <returns>A test performance profile.</returns> procedure GetTestPerformanceProfile(): Text var TextPerfProfileTextBuilder: TextBuilder; begin TextPerfProfileTextBuilder.Append('{"nodes":[{"id":1,"callFrame":{"functionName":"TestNode1FunctionName","scriptId":"CodeUnit_1","url":"TestNode1","lineNumber":0,"columnNumber":0},"hitCount":1,"children":[2],"declar'); TextPerfProfileTextBuilder.Append('ingApplication":{"appName":"TestNode1App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"CodeUnit_TestNode1"'); TextPerfProfileTextBuilder.Append(',"objectId":1}},{"id":2,"callFrame":{"functionName":"TestNode2FunctionName","scriptId":"CodeUnit_2","url":"TestNode2","lineNumber":0,"columnNumber":0},"hitCount":1,"children":[3],"'); TextPerfProfileTextBuilder.Append('declaringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"CodeUnit_Test'); TextPerfProfileTextBuilder.Append('Node2","objectId":2}},{"id":3,"callFrame":{"functionName":"TestNode3FunctionName","scriptId":"CodeUnit_3","url":"TestNode3","lineNumber":0,"columnNumber":0},"hitCount":1,"children"'); TextPerfProfileTextBuilder.Append(':[],"declaringApplication":{"appName":"TestNode3App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"CodeUnit'); TextPerfProfileTextBuilder.Append('_TestNode3","objectId":3}},{"id":4,"callFrame":{"functionName":"TestNode4FunctionName","scriptId":"CodeUnit_4","url":"TestNode4","lineNumber":0,"columnNumber":0},"hitCount":1,"chil'); TextPerfProfileTextBuilder.Append('dren":[5],"declaringApplication":{"appName":"TestNode4App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"Co'); TextPerfProfileTextBuilder.Append('deUnit_TestNode4","objectId":4}},{"id":5,"callFrame":{"functionName":"TestNode2FunctionName","scriptId":"CodeUnit_2","url":"TestNode2","lineNumber":0,"columnNumber":0},"hitCount":1'); TextPerfProfileTextBuilder.Append(',"children":[6],"declaringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectNam'); TextPerfProfileTextBuilder.Append('e":"CodeUnit_TestNode2","objectId":2}},{"id":6,"callFrame":{"functionName":"TestNode3FunctionName","scriptId":"CodeUnit_3","url":"TestNode3","lineNumber":0,"columnNumber":0},"hitCo'); TextPerfProfileTextBuilder.Append('unt":1,"children":[],"declaringApplication":{"appName":"TestNode3App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","obje'); TextPerfProfileTextBuilder.Append('ctName":"CodeUnit_TestNode3","objectId":3}}],"startTime":63780017494528714,"endTime":63780017556442928,"samples":[1,2,3,5,6],"timeDeltas":[0,100000,500000,100000,500000],"kind":1}'); exit(TextPerfProfileTextBuilder.ToText()); end; /// <summary> /// Gets a test performance profile containing multiple child nodes for the same parent node. /// </summary> /// <returns>A test performance profile.</returns> procedure GetPerformanceProfileWithMultipleChildNodes(): Text var TextPerfProfileTextBuilder: TextBuilder; begin TextPerfProfileTextBuilder.Append('{"nodes":[{"id":1,"callFrame":{"functionName":"TestNode1FunctionName","scriptId":"Page_1","url":"TestNode1","lineNumber":20,"columnNumber":20},"hitCount":3,"children":[2,6,7],"decl'); TextPerfProfileTextBuilder.Append('aringApplication":{"appName":"TestNode1App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"Page","objectName":"TestPage1","objectId"'); TextPerfProfileTextBuilder.Append(':1},"frameIdentifier":268484896},{"id":2,"callFrame":{"functionName":"TestNode2FunctionName","scriptId":"Table_4","url":"TestNode2","lineNumber":553,"columnNumber":8},"hitCount":1,'); TextPerfProfileTextBuilder.Append('"children":[3],"declaringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"Table","objectName":"'); TextPerfProfileTextBuilder.Append('TestTable1","objectId":4},"frameIdentifier":303604335},{"id":3,"callFrame":{"functionName":"TestNode3FunctionName","scriptId":"Table_4","url":"TestNode3","lineNumber":839,"columnNu'); TextPerfProfileTextBuilder.Append('mber":7},"hitCount":1,"children":[4,5],"declaringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"ob'); TextPerfProfileTextBuilder.Append('jectType":"Table","objectName":"TestTable1","objectId":4},"frameIdentifier":1462541426},{"id":4,"callFrame":{"functionName":"TestNode4FunctionName","scriptId":"CodeUnit_1","url":"T'); TextPerfProfileTextBuilder.Append('estNode4","lineNumber":5,"columnNumber":8},"hitCount":1,"children":[],"declaringApplication":{"appName":"TestNode1App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"appl'); TextPerfProfileTextBuilder.Append('icationDefinition":{"objectType":"CodeUnit","objectName":"TestCodeunit1","objectId":1},"frameIdentifier":918612397},{"id":5,"callFrame":{"functionName":"TestNode5FunctionName","scr'); TextPerfProfileTextBuilder.Append('iptId":"CodeUnit_1","url":"TestNode5","lineNumber":16,"columnNumber":8},"hitCount":2,"children":[],"declaringApplication":{"appName":"TestNode1App","appPublisher":"TestPublisher1",'); TextPerfProfileTextBuilder.Append('"appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"TestCodeunit1","objectId":1},"frameIdentifier":-1430629655},{"id":6,"callFrame":{"functionNam'); TextPerfProfileTextBuilder.Append('e":"TestNode5FunctionName","scriptId":"CodeUnit_1","url":"TestNode6","lineNumber":16,"columnNumber":8},"hitCount":2,"children":[],"declaringApplication":{"appName":"TestNode1App","'); TextPerfProfileTextBuilder.Append('appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"CodeUnit","objectName":"TestCodeunit1","objectId":1},"frameIdentifier":437789830},{"id'); TextPerfProfileTextBuilder.Append('":7,"callFrame":{"functionName":"TestNode7FunctionName","scriptId":"Page_1","url":"TestNode7","lineNumber":39,"columnNumber":8},"hitCount":1,"children":[8],"declaringApplication":{'); TextPerfProfileTextBuilder.Append('"appName":"TestNode1App","appPublisher":"TestPublisher1","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"Page","objectName":"TestPage1","objectId":1},"frameIdentifie'); TextPerfProfileTextBuilder.Append('r":1581969},{"id":8,"callFrame":{"functionName":"TestNode8FunctionName","scriptId":"Table_2","url":"TestNode8","lineNumber":2162,"columnNumber":8},"hitCount":4,"children":[9],"decl'); TextPerfProfileTextBuilder.Append('aringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"Table","objectName":"TestTable2","objectI'); TextPerfProfileTextBuilder.Append('d":2},"frameIdentifier":18711313},{"id":9,"callFrame":{"functionName":"TestNode9FunctionName","scriptId":"Table_2","url":"TestNode9","lineNumber":2200,"columnNumber":8},"hitCount"'); TextPerfProfileTextBuilder.Append(':1,"children":[],"declaringApplication":{"appName":"TestNode2App","appPublisher":"TestPublisher2","appVersion":"0.0.0.0"},"applicationDefinition":{"objectType":"Table","objectName"'); TextPerfProfileTextBuilder.Append(':"TestTable2","objectId":2},"frameIdentifier":650968763}],"startTime":63799826708387251,"endTime":63799826717061017,"samples":[1,4,5,6,8],"timeDeltas":[220413,0,218729,210322,42853'); TextPerfProfileTextBuilder.Append('0],"kind":1}'); exit(TextPerfProfileTextBuilder.ToText()); end; /// <summary> /// Inserts a value into the provided profiling node /// </summary> procedure InsertProfilingNode(var ProfilingNode: Record "Profiling Node"; SessionID: Integer; No: Integer; HitCount: Integer; ObjectTypeText: Text[250]; ObjectID: Integer; ObjectName: Text[250]; AppName: Text[250]; AppPublisher: Text[250]; LineNo: Integer; MethodName: Text[250]; SelfTime: Duration; FullTime: Duration; Indentation: Integer) begin ProfilingNode.Init(); ProfilingNode."Session ID" := SessionID; ProfilingNode."No." := No; ProfilingNode."Hit Count" := HitCount; ProfilingNode."Object Type" := ObjectTypeText; ProfilingNode."Object ID" := ObjectID; ProfilingNode."Object Name" := ObjectName; ProfilingNode."App Name" := AppName; ProfilingNode."App Publisher" := AppPublisher; ProfilingNode."Line No" := LineNo; ProfilingNode."Method Name" := MethodName; ProfilingNode."Self Time" := SelfTime; ProfilingNode."Full Time" := FullTime; ProfilingNode.Indentation := Indentation; ProfilingNode.Insert(); end; /// <summary> /// Checks if all the records in the two provided profiling node temporary tables are the same /// </summary> procedure AreEqual(var FirstProfilingNodes: Record "Profiling Node"; var SecondProfilingNodes: Record "Profiling Node"): Boolean begin if FirstProfilingNodes.Count() <> SecondProfilingNodes.Count() then exit(false); FirstProfilingNodes.FindSet(); repeat if not SecondProfilingNodes.Get(FirstProfilingNodes."Session ID", FirstProfilingNodes."No.") then exit(false); if not (Format(FirstProfilingNodes) = Format(SecondProfilingNodes)) then exit(false); until FirstProfilingNodes.Next() = 0; exit(true) end; local procedure GetAggregationType(TestProfilingAggregationType: Enum "Test Prof. Aggregation Type"): Enum "Profiling Aggregation Type" begin exit(Enum::"Profiling Aggregation Type".FromInteger(TestProfilingAggregationType.AsInteger())); end;}