Skip to content

Move server usage methods out of MothershipHelper #6877

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
labkey-tchad merged 1 commit into from
Jul 28, 2025
Merged

Move server usage methods out of MothershipHelper #6877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions mothership/test/src/org/labkey/test/tests/mothership/MothershipReportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.junit.experimental.categories.Category;
import org.junit.runner.OrderWith;
import org.junit.runner.manipulation.Alphanumeric;
import org.labkey.serverapi.util.UsageReportingLevel;
import org.labkey.test.BaseWebDriverTest;
import org.labkey.test.Locator;
import org.labkey.test.TestFileUtils;
Expand Down Expand Up @@ -94,7 +95,7 @@ public void preTest() throws Exception
@Test
public void testTopLevelItems() throws Exception
{
_mothershipHelper.createUsageReport(MothershipHelper.ReportLevel.ON, true, null);
_mothershipHelper.createUsageReport(UsageReportingLevel.ON, true, null);
ShowInstallationDetailPage installDetail = ShowInstallationDetailPage.beginAt(this, TEST_HOST_NAME);
String distributionName = getDeployedDistributionName();
Assert.assertEquals("Distribution name.", distributionName, installDetail.getDistributionName());
Expand Down Expand Up @@ -129,7 +130,7 @@ else if (propsFile.getParentFile().isDirectory())
@Test
public void testJsonMetrics() throws Exception
{
_mothershipHelper.createUsageReport(MothershipHelper.ReportLevel.ON, false, null);
_mothershipHelper.createUsageReport(UsageReportingLevel.ON, false, null);
assertTextPresent("jsonMetrics",
"modules",
"controllerHits", // Should have multiple sections for this across different modules
Expand Down Expand Up @@ -193,7 +194,7 @@ public void testForwardedRequest() throws Exception
{
log("Simulate receiving a report behind a load balancer");
String forwardedFor = "172.217.5.68"; // The IP address for www.google.com, so unlikely to ever be the real test server IP address
_mothershipHelper.createUsageReport(MothershipHelper.ReportLevel.ON, true, forwardedFor);
_mothershipHelper.createUsageReport(UsageReportingLevel.ON, true, forwardedFor);
ShowInstallationDetailPage installDetail = ShowInstallationDetailPage.beginAt(this, TEST_HOST_NAME);
Assert.assertEquals("Forwarded for", forwardedFor, installDetail.getServerIP());
}
Expand All @@ -213,7 +214,7 @@ private int triggerNpeAndGetCount()
public void testServerHostName() throws Exception
{
log("Send test server host name from base server url");
_mothershipHelper.createUsageReport(MothershipHelper.ReportLevel.ON, true, null);
_mothershipHelper.createUsageReport(UsageReportingLevel.ON, true, null);

String hostName = new URI(CustomizeSitePage.beginAt(this).getBaseServerUrl()).getHost();
String hostName2 = "TEST_" + hostName;
Expand Down
53 changes: 10 additions & 43 deletions mothership/test/src/org/labkey/test/util/mothership/MothershipHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,14 @@
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.labkey.remoteapi.CommandException;
import org.labkey.remoteapi.CommandResponse;
import org.labkey.remoteapi.Connection;
import org.labkey.remoteapi.SimpleGetCommand;
import org.labkey.remoteapi.SimplePostCommand;
import org.labkey.remoteapi.query.Filter;
import org.labkey.remoteapi.query.SelectRowsCommand;
import org.labkey.remoteapi.query.SelectRowsResponse;
import org.labkey.remoteapi.query.Sort;
import org.labkey.remoteapi.query.UpdateRowsCommand;
import org.labkey.serverapi.util.UsageReportingLevel;
import org.labkey.test.LabKeySiteWrapper;
import org.labkey.test.WebTestHelper;
import org.labkey.test.pages.core.admin.CustomizeSitePage;
Expand All @@ -49,6 +48,7 @@
import org.labkey.test.util.LoggedParam;
import org.labkey.test.util.Maps;
import org.labkey.test.util.TestLogger;
import org.labkey.test.util.core.admin.ServerUsageUtils;
import org.openqa.selenium.NotFoundException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WrapsDriver;
Expand All @@ -59,6 +59,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import static org.junit.Assert.assertEquals;

Expand All @@ -85,7 +86,7 @@ public MothershipHelper(WrapsDriver driver)
}

@Override
public WebDriver getWrappedDriver()
public @NotNull WebDriver getWrappedDriver()
{
return _driver.getWrappedDriver();
}
Expand Down Expand Up @@ -192,7 +193,7 @@ public void updateStackTrace(int exceptionStackTraceId, String bugNumber, String
params.put("comments", comments);
if (assignedToEmail != null)
{
String assignedToId = assignedToEmail.isEmpty() ? "" : new APIUserHelper(this).getUserId(assignedToEmail).toString();
String assignedToId = assignedToEmail.isEmpty() ? "" : Objects.requireNonNull(new APIUserHelper(this).getUserId(assignedToEmail), () -> "User not found: " + assignedToEmail).toString();
params.put("assignedTo", assignedToId);
}
command.setParameters(params);
Expand Down Expand Up @@ -222,45 +223,31 @@ public int getReportCount(int stackTraceId)
}
}

public enum ReportLevel
{
NONE,
ON
}

public void createUsageReport(ReportLevel level, boolean submit, String forwardedFor)
public void createUsageReport(UsageReportingLevel level, boolean submit, String forwardedFor)
{
createMothershipReport("CheckForUpdates", level, submit, forwardedFor);
}

public void createExceptionReport(ReportLevel level, boolean submit)
public void createExceptionReport(UsageReportingLevel level, boolean submit)
{
createMothershipReport("ReportException", level, submit, null);
}

private void createMothershipReport(String type, ReportLevel level, boolean submit, @Nullable String forwardedFor)
private void createMothershipReport(String type, UsageReportingLevel level, boolean submit, @Nullable String forwardedFor)
{
String relativeUrl = getTestMothershipReportUrl(type, level, submit, forwardedFor);
String relativeUrl = ServerUsageUtils.getTestMothershipReportUrl(type, level, submit, forwardedFor);
beginAt(relativeUrl);
}

public void submitMockUsageReport(String hostName, String serverGUID, String sessionGUID) throws IOException, CommandException
{
Map<String, Object> usageReportJson = getUsageReportJson();
Map<String, Object> usageReportJson = ServerUsageUtils.getUsageReportJson(createDefaultConnection());
usageReportJson.put("serverHostName", hostName);
usageReportJson.put("serverGUID", serverGUID);
usageReportJson.put("serverSessionGUID", sessionGUID);
submitUsageReport(usageReportJson);
}

public Map<String, Object> getUsageReportJson() throws IOException, CommandException
{
SimpleGetCommand command = new SimpleGetCommand("admin", "testMothershipReport");
command.setParameters(getMothershipReportParams("CheckForUpdates", ReportLevel.ON, false, null));
CommandResponse response = command.execute(createDefaultConnection(), "/");
return response.getParsedData();
}

private void submitUsageReport(Map<String, Object> report) throws IOException
{
// 'jsonMetrics' is converted to a JSON object by 'testMothershipReport'. Needs to be a string to submit.
Expand Down Expand Up @@ -288,26 +275,6 @@ private void submitUsageReport(Map<String, Object> report) throws IOException
}
}

@NotNull
public static String getTestMothershipReportUrl(String type, ReportLevel level, boolean submit, @Nullable String forwardedFor)
{
Map<String, Object> params = getMothershipReportParams(type, level, submit, forwardedFor);
return WebTestHelper.buildURL("admin", "testMothershipReport", params);
}

@NotNull
private static Map<String, Object> getMothershipReportParams(String type, ReportLevel level, boolean submit, @Nullable String forwardedFor)
{
Map<String, Object> params = new HashMap<>();
params.put("type", type);
params.put("level", level.toString());
params.put("submit", submit);
params.put("testMode", true);
if (null != forwardedFor)
params.put("forwardedFor", forwardedFor);
return params;
}

@LogMethod
public void setIgnoreExceptions(boolean ignore) throws IOException, CommandException
{
Expand Down