mirror of
https://github.com/google/nomulus.git
synced 2025-08-03 08:22:13 +02:00
Prepare ICANN reporting for production
This originally started as a small change, but quickly grew into a major refactor as I realized the original parameter structure wasn't conducive to a cron task and manual re-runs. The changes are as follows: 1. Adds DNS metrics to activity reports, thanks to Nick's work with the Zoneman Dremel -> #plx workflow. 2. Surrounds registrar names in transactions reports with quotes, to escape possible commas. 3. Factors out the report generation logic into IcannReportingStager. 4. Assigns default values to the three main parameters - yearMonth defaults to the previous month - subdir defaults to "icann/monthly/yearMonth", i.e. "gs://domain-registry-reporting/icann/monthly/yyyy-MM" - reportType defaults to both reports 5. Adds "Total" row generation logic to transactions reports - This was a previously overlooked requirement. 6. Adds "MANIFEST.txt" generation and upload logic. - The MANIFEST lists out which files need to be uploaded in the subdirectory. 7. Increases urlfetch timeout from 5s to 10s in backend tasks. - Backend tasks should be more latency tolerant anyway, and this reduces the number of incorrect timeouts we see for services like Bigquery which might take some time to respond. TESTED=Extensive testing in alpha, and ran FOSS test. TODO: send out an e-mail for report generation and upload, and add reporting to cron.xml ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=172738344
This commit is contained in:
larryruili
jianglai
parent
06f0ec4f2f
commit
f1c76d035f
39 changed files with 1092 additions and 589 deletions
|
|
@ -16,10 +16,6 @@ package google.registry.reporting;
|
|||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static com.google.common.truth.Truth.assertWithMessage;
|
||||
import static com.google.common.truth.Truth8.assertThat;
|
||||
import static google.registry.reporting.IcannReportingModule.ReportType.ACTIVITY;
|
||||
import static google.registry.reporting.IcannReportingModule.ReportType.TRANSACTIONS;
|
||||
import static google.registry.testing.DatastoreHelper.createTld;
|
||||
import static google.registry.testing.GcsTestingUtils.writeGcsFile;
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
import static org.mockito.Mockito.doThrow;
|
||||
|
|
@ -38,7 +34,6 @@ import google.registry.testing.FakeResponse;
|
|||
import google.registry.testing.FakeSleeper;
|
||||
import google.registry.util.Retrier;
|
||||
import java.io.IOException;
|
||||
import java.util.Optional;
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
|
|
@ -52,37 +47,37 @@ public class IcannReportingUploadActionTest {
|
|||
@Rule public final AppEngineRule appEngine = AppEngineRule.builder().withDatastore().build();
|
||||
|
||||
private static final byte[] FAKE_PAYLOAD = "test,csv\n13,37".getBytes(UTF_8);
|
||||
private static final byte[] MANIFEST_PAYLOAD = "test-transactions-201706.csv\n".getBytes(UTF_8);
|
||||
private final IcannHttpReporter mockReporter = mock(IcannHttpReporter.class);
|
||||
private final FakeResponse response = new FakeResponse();
|
||||
private final GcsService gcsService = GcsServiceFactory.createGcsService();
|
||||
private final GcsFilename reportFile =
|
||||
new GcsFilename("basin/icann/monthly/2017-06", "test-transactions-201706.csv");
|
||||
private final GcsFilename manifestFile =
|
||||
new GcsFilename("basin/icann/monthly/2017-06", "MANIFEST.txt");
|
||||
|
||||
private IcannReportingUploadAction createAction() {
|
||||
IcannReportingUploadAction action = new IcannReportingUploadAction();
|
||||
action.icannReporter = mockReporter;
|
||||
action.gcsUtils = new GcsUtils(gcsService, 1024);
|
||||
action.retrier = new Retrier(new FakeSleeper(new FakeClock()), 3);
|
||||
action.yearMonth = "2017-06";
|
||||
action.reportType = TRANSACTIONS;
|
||||
action.subdir = Optional.empty();
|
||||
action.tld = "test";
|
||||
action.icannReportingBucket = "basin";
|
||||
action.subdir = "icann/monthly/2017-06";
|
||||
action.reportingBucket = "basin";
|
||||
action.response = response;
|
||||
return action;
|
||||
}
|
||||
|
||||
@Before
|
||||
public void before() throws Exception {
|
||||
createTld("test");
|
||||
writeGcsFile(gcsService, reportFile, FAKE_PAYLOAD);
|
||||
writeGcsFile(gcsService, manifestFile, MANIFEST_PAYLOAD);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSuccess() throws Exception {
|
||||
IcannReportingUploadAction action = createAction();
|
||||
action.run();
|
||||
verify(mockReporter).send(FAKE_PAYLOAD, "test", "2017-06", TRANSACTIONS);
|
||||
verify(mockReporter).send(FAKE_PAYLOAD, "test-transactions-201706.csv");
|
||||
verifyNoMoreInteractions(mockReporter);
|
||||
assertThat(((FakeResponse) action.response).getPayload())
|
||||
.isEqualTo("OK, sending: test,csv\n13,37");
|
||||
|
|
@ -94,90 +89,26 @@ public class IcannReportingUploadActionTest {
|
|||
doThrow(new IOException("Expected exception."))
|
||||
.doNothing()
|
||||
.when(mockReporter)
|
||||
.send(FAKE_PAYLOAD, "test", "2017-06", TRANSACTIONS);
|
||||
.send(FAKE_PAYLOAD, "test-transactions-201706.csv");
|
||||
action.run();
|
||||
verify(mockReporter, times(2)).send(FAKE_PAYLOAD, "test", "2017-06", TRANSACTIONS);
|
||||
verify(mockReporter, times(2)).send(FAKE_PAYLOAD, "test-transactions-201706.csv");
|
||||
verifyNoMoreInteractions(mockReporter);
|
||||
assertThat(((FakeResponse) action.response).getPayload())
|
||||
.isEqualTo("OK, sending: test,csv\n13,37");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFail_NonexisistentTld() throws Exception {
|
||||
public void testFail_FileNotFound() throws Exception {
|
||||
IcannReportingUploadAction action = createAction();
|
||||
action.tld = "invalidTld";
|
||||
action.subdir = "somewhere/else";
|
||||
try {
|
||||
action.run();
|
||||
assertWithMessage("Expected IllegalArgumentException to be thrown").fail();
|
||||
assertWithMessage("Expected IllegalStateException to be thrown").fail();
|
||||
} catch (IllegalArgumentException expected) {
|
||||
assertThat(expected)
|
||||
.hasMessageThat()
|
||||
.isEqualTo("TLD invalidTld does not exist");
|
||||
.isEqualTo("Object MANIFEST.txt in bucket basin/somewhere/else not found");
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFail_InvalidYearMonth() throws Exception {
|
||||
IcannReportingUploadAction action = createAction();
|
||||
action.yearMonth = "2017-3";
|
||||
try {
|
||||
action.run();
|
||||
assertWithMessage("Expected IllegalStateException to be thrown").fail();
|
||||
} catch (IllegalStateException expected) {
|
||||
assertThat(expected)
|
||||
.hasMessageThat()
|
||||
.isEqualTo("yearMonth must be in YYYY-MM format, got 2017-3 instead.");
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFail_InvalidSubdir() throws Exception {
|
||||
IcannReportingUploadAction action = createAction();
|
||||
action.subdir = Optional.of("/subdir/with/slash");
|
||||
try {
|
||||
action.run();
|
||||
assertWithMessage("Expected IllegalStateException to be thrown").fail();
|
||||
} catch (IllegalStateException expected) {
|
||||
assertThat(expected)
|
||||
.hasMessageThat()
|
||||
.isEqualTo(
|
||||
"subdir must not start or end with a \"/\", got /subdir/with/slash instead.");
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFail_FileNotFound() throws Exception {
|
||||
IcannReportingUploadAction action = createAction();
|
||||
action.yearMonth = "1234-56";
|
||||
try {
|
||||
action.run();
|
||||
assertWithMessage("Expected IllegalStateException to be thrown").fail();
|
||||
} catch (IllegalStateException expected) {
|
||||
assertThat(expected)
|
||||
.hasMessageThat()
|
||||
.isEqualTo(
|
||||
"ICANN report object test-transactions-123456.csv "
|
||||
+ "in bucket basin/icann/monthly/1234-56 not found");
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSuccess_CreateFilename() throws Exception{
|
||||
assertThat(IcannReportingUploadAction.createFilename("test", "2017-06", ACTIVITY))
|
||||
.isEqualTo("test-activity-201706.csv");
|
||||
assertThat(IcannReportingUploadAction.createFilename("foo", "1234-56", TRANSACTIONS))
|
||||
.isEqualTo("foo-transactions-123456.csv");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSuccess_CreateBucketname() throws Exception{
|
||||
assertThat(
|
||||
IcannReportingUploadAction
|
||||
.createReportingBucketName("gs://my-reporting", Optional.<String>empty(), "2017-06"))
|
||||
.isEqualTo("gs://my-reporting/icann/monthly/2017-06");
|
||||
assertThat(
|
||||
IcannReportingUploadAction
|
||||
.createReportingBucketName("gs://my-reporting", Optional.of("manual"), "2017-06"))
|
||||
.isEqualTo("gs://my-reporting/manual");
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue