Skip to content

Commit

Permalink
callstack.core: Add tooltip tests in FlameGraphDPTest
Browse files Browse the repository at this point in the history 
Signed-off-by: Arnaud Fiorini <fiorini.arnaud@gmail.com>
Change-Id: Ib9c41153deedd3e3eec106a1c3a5b6f4e4045346
Reviewed-on: https://git.eclipse.org/r/c/tracecompass/org.eclipse.tracecompass/+/202537
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
  • Loading branch information
@arfio @MatthewKhouzam
arfio authored and MatthewKhouzam committed Jul 17, 2023
1 parent 1112945 commit ba84d16
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 6 deletions.
112 changes: 106 additions & 6 deletions ...ipse/tracecompass/analysis/callstack/core/tests/callgraph/FlameGraphDataProviderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,21 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.analysis.callstack.core.tests.CallStackTestBase;
import org.eclipse.tracecompass.analysis.callstack.core.tests.FlameDataProviderTestUtils;
import org.eclipse.tracecompass.analysis.callstack.core.tests.stubs.CallStackAnalysisStub;
import org.eclipse.tracecompass.internal.analysis.callstack.core.flamegraph.FlameGraphDataProvider;
import org.eclipse.tracecompass.internal.analysis.callstack.core.instrumented.FlameChartEntryModel;
import org.eclipse.tracecompass.internal.analysis.callstack.core.tree.AllGroupDescriptor;
import org.eclipse.tracecompass.internal.tmf.core.model.filters.FetchParametersUtils;
import org.eclipse.tracecompass.tmf.core.dataprovider.DataProviderParameterUtils;
import org.eclipse.tracecompass.tmf.core.model.OutputElementStyle;
import org.eclipse.tracecompass.tmf.core.model.filters.SelectionTimeQueryFilter;
import org.eclipse.tracecompass.tmf.core.model.timegraph.ITimeGraphRowModel;
import org.eclipse.tracecompass.tmf.core.model.timegraph.ITimeGraphState;
import org.eclipse.tracecompass.tmf.core.model.timegraph.TimeGraphModel;
Expand Down Expand Up @@ -77,8 +81,9 @@ public class FlameGraphDataProviderTest extends CallStackTestBase {
public void testFlameGraphDataProviderAllItems() throws IOException {
CallStackAnalysisStub cga = getModule();
FlameGraphDataProvider<?, ?, ?> provider = new FlameGraphDataProvider<>(getTrace(), cga, cga.getId());
Map<Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeFull", Collections.emptyMap());
Map<@NonNull Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeFull", Collections.emptyMap());
assertRowsRequests(provider, idsToNames, "Full", 19);
assertWrongTooltipQueries(provider, idsToNames);
}

/**
Expand All @@ -93,8 +98,9 @@ public void testFlameGraphDataProviderAllItems() throws IOException {
public void testFlameGraphDataProviderGroupByProcess() throws IOException {
CallStackAnalysisStub cga = getModule();
FlameGraphDataProvider<?, ?, ?> provider = new FlameGraphDataProvider<>(getTrace(), cga, cga.getId());
Map<Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeProcess", ImmutableMap.of(FlameGraphDataProvider.GROUP_BY_KEY, "Processes/*"));
Map<@NonNull Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeProcess", ImmutableMap.of(FlameGraphDataProvider.GROUP_BY_KEY, "Processes/*"));
assertRowsRequests(provider, idsToNames, "Process", 38);
assertWrongTooltipQueries(provider, idsToNames);
}

/**
Expand All @@ -109,8 +115,9 @@ public void testFlameGraphDataProviderGroupByProcess() throws IOException {
public void testFlameGraphDataProviderGrouped() throws IOException {
CallStackAnalysisStub cga = getModule();
FlameGraphDataProvider<?, ?, ?> provider = new FlameGraphDataProvider<>(getTrace(), cga, cga.getId());
Map<Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeOne", ImmutableMap.of(FlameGraphDataProvider.GROUP_BY_KEY, AllGroupDescriptor.getInstance().getName()));
Map<@NonNull Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeOne", ImmutableMap.of(FlameGraphDataProvider.GROUP_BY_KEY, AllGroupDescriptor.getInstance().getName()));
assertRowsRequests(provider, idsToNames, "One", 72);
assertWrongTooltipQueries(provider, idsToNames);
}

/**
Expand All @@ -125,8 +132,9 @@ public void testFlameGraphDataProviderGrouped() throws IOException {
public void testFlameGraphDataProviderSelection() throws IOException {
CallStackAnalysisStub cga = getModule();
FlameGraphDataProvider<?, ?, ?> provider = new FlameGraphDataProvider<>(getTrace(), cga, cga.getId());
Map<Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeSelection", ImmutableMap.of(FlameGraphDataProvider.SELECTION_RANGE_KEY, ImmutableList.of(5, 15)));
Map<@NonNull Long, FlameChartEntryModel> idsToNames = assertAndGetTree(provider, "expectedFgTreeSelection", ImmutableMap.of(FlameGraphDataProvider.SELECTION_RANGE_KEY, ImmutableList.of(5, 15)));
assertRowsRequests(provider, idsToNames, "Selection", 10);
assertWrongTooltipQueries(provider, idsToNames);
}

private static void assertRowsRequests(FlameGraphDataProvider<?, ?, ?> provider, Map<Long, FlameChartEntryModel> idsToNames, String resultFileSuffix, long maxDuration) throws IOException {
Expand All @@ -149,7 +157,7 @@ private static void assertRowsRequests(FlameGraphDataProvider<?, ?, ?> provider,
assertRows(provider, idsToNames, builder.build(), filePrefix, "Zoom");
}

private static Map<Long, FlameChartEntryModel> assertAndGetTree(FlameGraphDataProvider<?, ?, ?> provider, String filePath, @NonNull Map<@NonNull String, @NonNull Object> additionalParameters) throws IOException {
private static Map<@NonNull Long, FlameChartEntryModel> assertAndGetTree(FlameGraphDataProvider<?, ?, ?> provider, String filePath, @NonNull Map<@NonNull String, @NonNull Object> additionalParameters) throws IOException {
Map<@NonNull String, @NonNull Object> parameters = new HashMap<>(TREE_PARAMETERS);
parameters.putAll(additionalParameters);
@SuppressWarnings("null")
Expand Down Expand Up @@ -181,13 +189,70 @@ private static Map<Long, FlameChartEntryModel> assertAndGetTree(FlameGraphDataPr
assertEquals("End time of entry " + split[0] + ' ' + split[1] + WITH_PARENT + split[5], Long.parseLong(split[3]), fgEntry.getEndTime());
assertEquals("Parent ID of entry " + split[0] + ' ' + split[1] + WITH_PARENT + split[5], parent == null ? -1 : parent.getId(), fgEntry.getParentId());
}
Map<Long, FlameChartEntryModel> map = new HashMap<>();
Map<@NonNull Long, FlameChartEntryModel> map = new HashMap<>();
for (FlameChartEntryModel fgModel : treeEntries) {
map.put(fgModel.getId(), fgModel);
}
return map;
}

private static void assertWrongTooltipQueries(FlameGraphDataProvider<?, ?, ?> provider, Map<@NonNull Long, FlameChartEntryModel> idsToNames) {
@NonNull List<@NonNull Long> wrongEntry = Collections.singletonList(13213L);
@NonNull List<@NonNull Long> twoEntries = Objects.requireNonNull(List.of(1L, 2L));
FlameChartEntryModel entry = FlameDataProviderTestUtils.findEntryByNameAndType(idsToNames.values(), "1", FlameChartEntryModel.EntryType.FUNCTION);
assertNotNull(entry);
@NonNull List<@NonNull Long> correctEntry = Collections.singletonList(entry.getId());

/* No params */
TmfModelResponse<@NonNull Map<@NonNull String, @NonNull String>> tooltipResponse = provider.fetchTooltip(Collections.emptyMap(), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.FAILED, tooltipResponse.getStatus());
Map<@NonNull String, @NonNull String> tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
/* Full query */
tooltipResponse = provider.fetchTooltip(FetchParametersUtils.selectionTimeQueryToMap(new SelectionTimeQueryFilter(0L, Long.MAX_VALUE, 2, idsToNames.keySet())), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.FAILED, tooltipResponse.getStatus());
tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
/* Query with two entries */
tooltipResponse = provider.fetchTooltip(FetchParametersUtils.selectionTimeQueryToMap(new SelectionTimeQueryFilter(3L, 3L, 1, twoEntries)), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.FAILED, tooltipResponse.getStatus());
tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
/* Query with wrong entry */
tooltipResponse = provider.fetchTooltip(FetchParametersUtils.selectionTimeQueryToMap(new SelectionTimeQueryFilter(3L, 3L, 1, wrongEntry)), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.COMPLETED, tooltipResponse.getStatus());
tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
/* Off query */
tooltipResponse = provider.fetchTooltip(FetchParametersUtils.selectionTimeQueryToMap(new SelectionTimeQueryFilter(321837218L, 321837218L, 1, correctEntry)), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.COMPLETED, tooltipResponse.getStatus());
tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
/* Wide query */
tooltipResponse = provider.fetchTooltip(FetchParametersUtils.selectionTimeQueryToMap(new SelectionTimeQueryFilter(0L, 3L, 2, correctEntry)), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.FAILED, tooltipResponse.getStatus());
tooltipModel = tooltipResponse.getModel();
if (tooltipModel != null) {
assertTrue(tooltipModel.isEmpty());
}
}

@SuppressWarnings("null")
private static FlameChartEntryModel.EntryType getEntryType(String string) {
return FlameChartEntryModel.EntryType.valueOf(string.toUpperCase());
Expand Down Expand Up @@ -218,10 +283,32 @@ private static void assertRows(FlameGraphDataProvider<?, ?, ?> provider, Map<Lon
ITimeGraphRowModel row = rows.get(fgEntry.getId());
assertNotNull(descriptor + ": Row entry exists" + split[0], row);

@NonNull String[] rowStates = split[1].split(",");
assertTooltip(provider, fgEntry.getId(), Long.parseLong(rowStates[0]), false, rowStates[3], Long.parseLong(rowStates[1]) + " ns");
assertTooltip(provider, fgEntry.getId(), Long.parseLong(rowStates[0]), true, rowStates[3], Long.parseLong(rowStates[1]) + " ns");

assertEqualsStates(split[1], row.getStates(), descriptor + ": " + split[0]);
}
}

private static void assertTooltip(FlameGraphDataProvider<?, ?, ?> provider, Long entryId, Long requestedTime, boolean isAction, String expectedObject, String expectedDuration) {
TmfModelResponse<@NonNull Map<@NonNull String, @NonNull String>> tooltipResponse = provider.fetchTooltip(prepareTooltipParameters(entryId, requestedTime, isAction), new NullProgressMonitor());
assertNotNull(tooltipResponse);
assertEquals(ITmfResponse.Status.COMPLETED, tooltipResponse.getStatus());
Map<@NonNull String, @NonNull String> tooltipModel = tooltipResponse.getModel();
assertNotNull(tooltipModel);
if (expectedObject.equals("null")) {
assertTrue(tooltipModel.isEmpty());
} else {
if (isAction) {
assertNotNull(tooltipModel);
} else {
assertEquals(expectedObject, tooltipModel.get("Object"));
assertEquals(expectedDuration, tooltipModel.get("\tTotal duration"));
}
}
}

private static FlameChartEntryModel findRowEntry(String entryDetails, Collection<FlameChartEntryModel> models) {
String[] details = entryDetails.split(",");
FlameChartEntryModel parentEntry = FlameDataProviderTestUtils.findEntryByNameAndType(models, details[3], getEntryType(details[2]));
Expand All @@ -235,6 +322,19 @@ private static FlameChartEntryModel findRowEntry(String entryDetails, Collection
return ImmutableMap.of(DataProviderParameterUtils.REQUESTED_TIME_KEY, requestedTimes, DataProviderParameterUtils.REQUESTED_ITEMS_KEY, ids);
}

private static @NonNull Map<@NonNull String, @NonNull Object> prepareTooltipParameters(Long entryId, Long requestedTime, boolean isAction) {
if (isAction) {
return ImmutableMap.of(
DataProviderParameterUtils.REQUESTED_TIME_KEY, Collections.singletonList(requestedTime),
DataProviderParameterUtils.REQUESTED_ITEMS_KEY, Collections.singletonList(entryId),
FlameGraphDataProvider.TOOLTIP_ACTION_KEY, Collections.EMPTY_LIST);

}
return ImmutableMap.of(
DataProviderParameterUtils.REQUESTED_TIME_KEY, Collections.singletonList(requestedTime),
DataProviderParameterUtils.REQUESTED_ITEMS_KEY, Collections.singletonList(entryId));
}

private static void assertEqualsStates(String string, @NonNull List<@NonNull ITimeGraphState> states, String descriptor) {
String[] stringStates = string.split(",");
for (int i = 0; i < stringStates.length / 4; i++) {
Expand Down
3 changes: 3 additions & 0 deletions ...ipse/tracecompass/internal/analysis/callstack/core/flamegraph/FlameGraphDataProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,9 @@ private Map<String, String> getMetricWithStatTooltip(MetricType metric, Weighted
/** Find the callsite at the time and depth requested */
@SuppressWarnings("unchecked")
private @Nullable WeightedTree<@NonNull N> findCallSite(WeightedTreeEntry cgEntry, Long time) {
if (time < 0 || time > cgEntry.fSs.getCurrentEndTime()) {
return null;
}
try {
ITmfStateInterval interval = cgEntry.fSs.querySingleState(time, cgEntry.fQuark);

Expand Down

0 comments on commit ba84d16

Please sign in to comment.