mirror of
https://github.com/google/nomulus.git
synced 2025-05-05 06:27:51 +02:00
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
97 lines
3.2 KiB
Java
97 lines
3.2 KiB
Java
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package google.registry.reporting;
|
|
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static org.mockito.Mockito.mock;
|
|
|
|
import google.registry.reporting.IcannReportingModule.ReportType;
|
|
import google.registry.request.HttpException.BadRequestException;
|
|
import google.registry.testing.ExceptionRule;
|
|
import google.registry.testing.FakeClock;
|
|
import google.registry.util.Clock;
|
|
import java.util.Optional;
|
|
import javax.servlet.http.HttpServletRequest;
|
|
import org.joda.time.DateTime;
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
/** Unit tests for {@link google.registry.reporting.IcannReportingModule}. */
|
|
@RunWith(JUnit4.class)
|
|
public class IcannReportingModuleTest {
|
|
|
|
HttpServletRequest req = mock(HttpServletRequest.class);
|
|
Clock clock;
|
|
|
|
@Rule public final ExceptionRule thrown = new ExceptionRule();
|
|
|
|
@Before
|
|
public void setUp() {
|
|
clock = new FakeClock(DateTime.parse("2017-07-01TZ"));
|
|
}
|
|
|
|
@Test
|
|
public void testEmptyYearMonth_returnsCurrentDate() {
|
|
assertThat(IcannReportingModule.provideYearMonth(Optional.empty(), clock)).isEqualTo("2017-06");
|
|
}
|
|
|
|
@Test
|
|
public void testGivenYearMonth_returnsThatMonth() {
|
|
assertThat(IcannReportingModule.provideYearMonth(Optional.of("2017-05"), clock))
|
|
.isEqualTo("2017-05");
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidYearMonth_throwsException() {
|
|
thrown.expect(
|
|
BadRequestException.class, "yearMonth must be in yyyy-MM format, got 201705 instead");
|
|
IcannReportingModule.provideYearMonth(Optional.of("201705"), clock);
|
|
}
|
|
|
|
@Test
|
|
public void testEmptySubDir_returnsDefaultSubdir() {
|
|
assertThat(IcannReportingModule.provideSubdir(Optional.empty(), "2017-06"))
|
|
.isEqualTo("icann/monthly/2017-06");
|
|
}
|
|
|
|
@Test
|
|
public void testGivenSubdir_returnsManualSubdir() {
|
|
assertThat(IcannReportingModule.provideSubdir(Optional.of("manual/dir"), "2017-06"))
|
|
.isEqualTo("manual/dir");
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidSubdir_throwsException() {
|
|
thrown.expect(
|
|
BadRequestException.class,
|
|
"subdir must not start or end with a \"/\", got /whoops instead.");
|
|
IcannReportingModule.provideSubdir(Optional.of("/whoops"), "2017-06");
|
|
}
|
|
|
|
@Test
|
|
public void testGivenReportType_returnsReportType() {
|
|
assertThat(IcannReportingModule.provideReportTypes(Optional.of(ReportType.ACTIVITY)))
|
|
.containsExactly(ReportType.ACTIVITY);
|
|
}
|
|
|
|
@Test
|
|
public void testNoReportType_returnsBothReportTypes() {
|
|
assertThat(IcannReportingModule.provideReportTypes(Optional.empty()))
|
|
.containsExactly(ReportType.ACTIVITY, ReportType.TRANSACTIONS);
|
|
}
|
|
}
|