Convert GenerateLordnCommand to tm (#1091)

* Convert GenerateLordnCommand to tm

This makes use of QueryComposer and adds a `list()` method to it.

Since there was no test for GenerateLordnCommand, this also implements one.

* Changes requested in review

* Add test for list queries

* Stream domains instead of listing them

* Reformatted
This commit is contained in:
Michael Muller 2021-04-29 13:14:56 -04:00 committed by GitHub
parent 95fdd36c77
commit 1fdf9cb979
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 128 additions and 14 deletions

View file

@ -444,5 +444,10 @@ public class DatastoreTransactionManager implements TransactionManager {
public long count() { public long count() {
return buildQuery().count(); return buildQuery().count();
} }
@Override
public List<T> list() {
return buildQuery().list();
}
} }
} }

View file

@ -737,5 +737,10 @@ public class JpaTransactionManagerImpl implements JpaTransactionManager {
CriteriaQueryBuilder<Long> queryBuilder = CriteriaQueryBuilder.createCount(em, entityClass); CriteriaQueryBuilder<Long> queryBuilder = CriteriaQueryBuilder.createCount(em, entityClass);
return addCriteria(queryBuilder).getSingleResult(); return addCriteria(queryBuilder).getSingleResult();
} }
@Override
public List<T> list() {
return buildQuery().getResultList();
}
} }
} }

View file

@ -91,6 +91,9 @@ public abstract class QueryComposer<T> {
/** Returns the number of results of the query. */ /** Returns the number of results of the query. */
public abstract long count(); public abstract long count();
/** Returns the results of the query as a list. */
public abstract List<T> list();
// We have to wrap the CriteriaQueryBuilder predicate factories in our own functions because at // We have to wrap the CriteriaQueryBuilder predicate factories in our own functions because at
// the point where we pass them to the Comparator constructor, the compiler can't determine which // the point where we pass them to the Comparator constructor, the compiler can't determine which
// of the overloads to use since there is no "value" object for context. // of the overloads to use since there is no "value" object for context.

View file

@ -14,9 +14,10 @@
package google.registry.tools; package google.registry.tools;
import static google.registry.model.ofy.ObjectifyService.ofy; import static google.registry.persistence.transaction.QueryComposer.Comparator;
import static google.registry.persistence.transaction.TransactionManagerFactory.tm;
import static google.registry.persistence.transaction.TransactionManagerUtil.transactIfJpaTm;
import static java.nio.charset.StandardCharsets.UTF_8; import static java.nio.charset.StandardCharsets.UTF_8;
import static org.joda.time.DateTimeZone.UTC;
import com.beust.jcommander.Parameter; import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters; import com.beust.jcommander.Parameters;
@ -24,9 +25,11 @@ import com.google.common.collect.ImmutableList;
import google.registry.model.domain.DomainBase; import google.registry.model.domain.DomainBase;
import google.registry.tmch.LordnTaskUtils; import google.registry.tmch.LordnTaskUtils;
import google.registry.tools.params.PathParameter; import google.registry.tools.params.PathParameter;
import google.registry.util.Clock;
import java.io.IOException; import java.io.IOException;
import java.nio.file.Files; import java.nio.file.Files;
import java.nio.file.Path; import java.nio.file.Path;
import javax.inject.Inject;
import org.joda.time.DateTime; import org.joda.time.DateTime;
/** Command to generate a LORDN CSV file for an entire TLD. */ /** Command to generate a LORDN CSV file for an entire TLD. */
@ -53,22 +56,21 @@ final class GenerateLordnCommand implements CommandWithRemoteApi {
required = true) required = true)
private Path sunriseOutputPath; private Path sunriseOutputPath;
@Inject Clock clock;
@Override @Override
public void run() throws IOException { public void run() throws IOException {
DateTime now = DateTime.now(UTC); DateTime now = clock.nowUtc();
ImmutableList.Builder<String> claimsCsv = new ImmutableList.Builder<>(); ImmutableList.Builder<String> claimsCsv = new ImmutableList.Builder<>();
ImmutableList.Builder<String> sunriseCsv = new ImmutableList.Builder<>(); ImmutableList.Builder<String> sunriseCsv = new ImmutableList.Builder<>();
for (DomainBase domain : ofy().load().type(DomainBase.class).filter("tld", tld)) { transactIfJpaTm(
String status = " "; () ->
if (domain.getLaunchNotice() == null && domain.getSmdId() != null) { tm()
sunriseCsv.add(LordnTaskUtils.getCsvLineForSunriseDomain(domain, domain.getCreationTime())); .createQueryComposer(DomainBase.class)
status = "S"; .where("tld", Comparator.EQ, tld)
} else if (domain.getLaunchNotice() != null || domain.getSmdId() != null) { .orderBy("repoId")
claimsCsv.add(LordnTaskUtils.getCsvLineForClaimsDomain(domain, domain.getCreationTime())); .stream()
status = "C"; .forEach(domain -> processDomain(claimsCsv, sunriseCsv, domain)));
}
System.out.printf("%s[%s] ", domain.getDomainName(), status);
}
ImmutableList<String> claimsRows = claimsCsv.build(); ImmutableList<String> claimsRows = claimsCsv.build();
ImmutableList<String> claimsAll = ImmutableList<String> claimsAll =
new ImmutableList.Builder<String>() new ImmutableList.Builder<String>()
@ -86,4 +88,19 @@ final class GenerateLordnCommand implements CommandWithRemoteApi {
Files.write(claimsOutputPath, claimsAll, UTF_8); Files.write(claimsOutputPath, claimsAll, UTF_8);
Files.write(sunriseOutputPath, sunriseAll, UTF_8); Files.write(sunriseOutputPath, sunriseAll, UTF_8);
} }
private static void processDomain(
ImmutableList.Builder<String> claimsCsv,
ImmutableList.Builder<String> sunriseCsv,
DomainBase domain) {
String status = " ";
if (domain.getLaunchNotice() == null && domain.getSmdId() != null) {
sunriseCsv.add(LordnTaskUtils.getCsvLineForSunriseDomain(domain, domain.getCreationTime()));
status = "S";
} else if (domain.getLaunchNotice() != null || domain.getSmdId() != null) {
claimsCsv.add(LordnTaskUtils.getCsvLineForClaimsDomain(domain, domain.getCreationTime()));
status = "C";
}
System.out.printf("%s[%s] ", domain.getDomainName(), status);
}
} }

View file

@ -206,6 +206,17 @@ public class QueryComposerTest {
.isEqualTo(ImmutableList.of(alpha, bravo)); .isEqualTo(ImmutableList.of(alpha, bravo));
} }
@TestOfyAndSql
public void testListQueries() {
assertThat(
transactIfJpaTm(
() ->
tm().createQueryComposer(TestEntity.class)
.where("name", Comparator.GT, "alpha")
.list()))
.isEqualTo(ImmutableList.of(bravo, charlie));
}
@TestOfyAndSql @TestOfyAndSql
public void testNonPrimaryKey() { public void testNonPrimaryKey() {
assertThat( assertThat(

View file

@ -0,0 +1,73 @@
// Copyright 2021 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.tools;
import static com.google.common.truth.Truth.assertThat;
import static google.registry.testing.DatabaseHelper.createTld;
import static google.registry.testing.DatabaseHelper.newDomainBase;
import static google.registry.testing.DatabaseHelper.persistResource;
import static google.registry.util.DateTimeUtils.START_OF_TIME;
import static java.nio.charset.StandardCharsets.UTF_8;
import google.registry.model.domain.launch.LaunchNotice;
import google.registry.testing.DualDatabaseTest;
import google.registry.testing.TestOfyAndSql;
import java.nio.file.Files;
import java.nio.file.Path;
import org.joda.time.DateTime;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.io.TempDir;
@DualDatabaseTest
class GenerateLordnCommandTest extends CommandTestCase<GenerateLordnCommand> {
@TempDir Path outputDir;
@BeforeEach
void beforeEach() {
fakeClock.setTo(DateTime.parse("2021-04-16T10:04:00.000Z"));
command.clock = fakeClock;
}
@TestOfyAndSql
void testExample() throws Exception {
createTld("tld");
persistResource(newDomainBase("sneezy.tld").asBuilder().setSmdId("smd1").build());
persistResource(newDomainBase("wheezy.tld").asBuilder().setSmdId("smd2").build());
persistResource(
newDomainBase("fleecey.tld")
.asBuilder()
.setLaunchNotice(LaunchNotice.create("smd3", "validator", START_OF_TIME, START_OF_TIME))
.setSmdId("smd3")
.build());
Path claimsCsv = outputDir.resolve("claims.csv");
Path sunriseCsv = outputDir.resolve("sunrise.csv");
runCommand("-t tld", "-c " + claimsCsv, "-s " + sunriseCsv);
assertThat(Files.readAllBytes(claimsCsv))
.isEqualTo(
("1,2021-04-16T10:04:00.000Z,1\n"
+ "roid,domain-name,notice-id,registrar-id,registration-datetime,ack-datetime,application-datetime\n"
+ "6-TLD,fleecey.tld,smd3,1,1970-01-01T00:00:00.000Z,1970-01-01T00:00:00.000Z\n")
.getBytes(UTF_8));
assertThat(Files.readAllBytes(sunriseCsv))
.isEqualTo(
("1,2021-04-16T10:04:00.001Z,2\n"
+ "roid,domain-name,SMD-id,registrar-id,registration-datetime,"
+ "application-datetime\n"
+ "2-TLD,sneezy.tld,smd1,1,1970-01-01T00:00:00.000Z\n"
+ "4-TLD,wheezy.tld,smd2,1,1970-01-01T00:00:00.000Z\n")
.getBytes(UTF_8));
}
}