Skip to content

Selenium test for source lineage audit detail #2701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
XingY merged 2 commits into from
Sep 23, 2025
Merged

Selenium test for source lineage audit detail #2701

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
867e58e
Selenium test for source lineage audit detail
XingY Sep 19, 2025
d97354d
Merge branch 'develop' into fb_issue53825
XingY Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions src/org/labkey/test/util/AuditLogHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@

import static java.lang.Integer.parseInt;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.labkey.test.WebDriverWrapper.WAIT_FOR_JAVASCRIPT;
import static org.labkey.test.WebDriverWrapper.waitFor;
import static org.labkey.test.util.TestLogger.log;

public class AuditLogHelper
{
Expand Down Expand Up @@ -262,12 +264,30 @@ public void checkAuditEventDiffCount(String containerPath, AuditEvent auditEvent
// filter out RowId as that is not a change, it is added for display purposes
dataChanges = Stream.of(dataChanges).filter(s -> !s.toLowerCase().startsWith("rowid=")).toArray(String[]::new);

TestLogger.log("Audit record data changes diff count check (" + eventDiffFieldName + "): " + dataChangesStr);
log("Audit record data changes diff count check (" + eventDiffFieldName + "): " + dataChangesStr);
assertEquals("Audit record data changes did not include the expected number of diffs in " + eventDiffFieldName + ", expected " + expectedDiffCount + " but was " + dataChanges.length + ": " + dataChangesStr,
expectedDiffCount, dataChanges.length);
}
}

public void checkAuditLogDataChanges(AuditEvent auditEventName, int transactionId, List<String> changes)
{
Connection cn = WebTestHelper.getRemoteApiConnection();
SelectRowsCommand cmd = new SelectRowsCommand("auditLog", auditEventName.getName());
cmd.setRequiredVersion(9.1);
cmd.setColumns(Arrays.asList("oldvalues", "newvalues", "datachanges"));
cmd.addFilter("transactionauditid", transactionId, Filter.Operator.EQUAL);
cmd.setContainerFilter(ContainerFilter.AllFolders);

Map<String, Object> event = executeSelectCommand(cn, cmd).get(0);

String datachanges = getLogColumnDisplayValue(event, "datachanges").toLowerCase();
Copy link
Contributor

@labkey-nicka labkey-nicka Sep 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Consider using case-insensitive comparison instead:

String dataChanges = getLogColumnDisplayValue(event, "datachanges");
log(dataChanges);
for (String change : changes)
    assertTrue("Expected change not found in audit log data changes: " + change, Strings.CI.contains(dataChanges, change));


log(datachanges);
for (String change : changes)
assertTrue("Expected change not found in audit log data changes: " + change, datachanges.contains(change.toLowerCase()));
}

public Integer getLastTransactionId(String containerPath, AuditEvent auditEventName)
{
try
Expand Down Expand Up @@ -340,7 +360,7 @@ public Integer checkAuditEventDiffCountForLastTransaction(String containerPath,
if (expectedEventCount != null)
{
if (expectedEventCount.intValue() != events.size())
TestLogger.log("Last audit event info: " + events.get(0));
log("Last audit event info: " + events.get(0));
assertEquals("Unexpected number of events for transactionId " + transactionId, expectedEventCount.intValue(), events.size());
}
List<Integer> expectedChangeCounts = Collections.nCopies(events.size(), expectedDiffCount);
Expand Down Expand Up @@ -405,7 +425,7 @@ public boolean validateDetailAuditLog(DetailedAuditEventRow expectedAuditDetail,
if (!expectedValue.equalsIgnoreCase(actualValue))
{
pass = false;
TestLogger.log(prop + " is not as expected. Expected: " + expectedValue + ", Actual: " + actualValue);
log(prop + " is not as expected. Expected: " + expectedValue + ", Actual: " + actualValue);
}
}
}
Expand All @@ -421,7 +441,7 @@ public boolean validateDomainPropertiesAuditLog(String domainName, Integer domai
if (expectedAuditDetails.size() != actualAuditDetails.size())
{
pass = false;
TestLogger.log(String.format("Number of DomainPropertyAuditEvent events not as expected. Expected %d, Actual %d.", expectedAuditDetails.size(), actualAuditDetails.size()));
log(String.format("Number of DomainPropertyAuditEvent events not as expected. Expected %d, Actual %d.", expectedAuditDetails.size(), actualAuditDetails.size()));
}

for (String key : expectedAuditDetails.keySet())
Expand All @@ -431,7 +451,7 @@ public boolean validateDomainPropertiesAuditLog(String domainName, Integer domai
if (actualAuditDetail == null)
{
pass = false;
TestLogger.log("Field " + key + " is missing DomainPropertyAuditEvent.");
log("Field " + key + " is missing DomainPropertyAuditEvent.");
}
else
pass = pass && validateDetailAuditLog(expectedAuditDetail, actualAuditDetail);
Expand All @@ -445,7 +465,7 @@ public boolean validateLastDomainAuditEvents(String domainName, String projectNa
DetailedAuditEventRow latestDomainEvent = getLastDomainEvent(projectName, domainName);
if (latestDomainEvent == null)
{
TestLogger.log(String.format("No DomainAuditEvent found for domain '%s' in project '%s'.", domainName, projectName));
log(String.format("No DomainAuditEvent found for domain '%s' in project '%s'.", domainName, projectName));
return false;
}

Expand All @@ -460,7 +480,7 @@ public List<Integer> getDomainEventIds(String projectName, String domainName, @N
List<Integer> domainEventIds = new ArrayList<>();
domainAuditEventAllRows.forEach((event)->domainEventIds.add(event.rowId));

TestLogger.log("Number of 'Domain Event' log entries for '" + domainName + "': " + domainEventIds.size());
log("Number of 'Domain Event' log entries for '" + domainName + "': " + domainEventIds.size());

return domainEventIds;
}
Expand Down Expand Up @@ -599,7 +619,7 @@ public Set<Integer> getDomainEventIdsFromPropertyEvents(List<Map<String, Object>

private List<DetailedAuditEventRow> getDomainAuditEventLog(String projectName, String domainName, @Nullable Collection<Integer> ignoreIds, @Nullable Integer maxRows)
{
TestLogger.log("Get a list of the Domain Events for project '" + projectName + "'. ");
log("Get a list of the Domain Events for project '" + projectName + "'. ");
domainName = domainName.trim();

Connection cn = WebTestHelper.getRemoteApiConnection();
Expand All @@ -620,7 +640,7 @@ private List<DetailedAuditEventRow> getDomainAuditEventLog(String projectName, S
cmd.setMaxRows(maxRows);

List<Map<String, Object>> domainAuditEventAllRows = executeSelectCommand(cn, cmd);
TestLogger.log(String.format("Number of Domain Event log entries for domain '%s' in '%s': %d", domainName, projectName, domainAuditEventAllRows.size()));
log(String.format("Number of Domain Event log entries for domain '%s' in '%s': %d", domainName, projectName, domainAuditEventAllRows.size()));

List<DetailedAuditEventRow> domainAuditEventRows = new ArrayList<>();

Expand Down Expand Up @@ -664,7 +684,7 @@ private List<Map<String, Object>> executeSelectCommand(Connection cn, SelectRows
try
{
SelectRowsResponse response = cmd.execute(cn, "/");
TestLogger.log("Number of rows: " + response.getRowCount());
log("Number of rows: " + response.getRowCount());
rowsReturned.addAll(response.getRows());
}
catch (IOException | CommandException ex)
Expand Down