Add a nomulus renew_domain command

This may come in handy when dealing with URS requests.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=199332085
This commit is contained in:
mcilwain 2018-06-05 11:39:16 -07:00 committed by Ben McIlwain
parent 643b30d31f
commit 897690119e
7 changed files with 273 additions and 0 deletions

View file

@ -104,6 +104,7 @@ public final class RegistryTool {
.put("registrar_activity_report", RegistrarActivityReportCommand.class) .put("registrar_activity_report", RegistrarActivityReportCommand.class)
.put("registrar_contact", RegistrarContactCommand.class) .put("registrar_contact", RegistrarContactCommand.class)
.put("remove_ip_address", RemoveIpAddressCommand.class) .put("remove_ip_address", RemoveIpAddressCommand.class)
.put("renew_domain", RenewDomainCommand.class)
.put("resave_entities", ResaveEntitiesCommand.class) .put("resave_entities", ResaveEntitiesCommand.class)
.put("resave_environment_entities", ResaveEnvironmentEntitiesCommand.class) .put("resave_environment_entities", ResaveEnvironmentEntitiesCommand.class)
.put("resave_epp_resource", ResaveEppResourceCommand.class) .put("resave_epp_resource", ResaveEppResourceCommand.class)

View file

@ -94,6 +94,7 @@ interface RegistryToolComponent {
void inject(LoginCommand command); void inject(LoginCommand command);
void inject(LogoutCommand command); void inject(LogoutCommand command);
void inject(PendingEscrowCommand command); void inject(PendingEscrowCommand command);
void inject(RenewDomainCommand command);
void inject(SendEscrowReportToIcannCommand command); void inject(SendEscrowReportToIcannCommand command);
void inject(SetupOteCommand command); void inject(SetupOteCommand command);
void inject(UpdateCursorsCommand command); void inject(UpdateCursorsCommand command);

View file

@ -0,0 +1,70 @@
// Copyright 2018 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.base.Preconditions.checkArgument;
import static google.registry.model.EppResourceUtils.loadByForeignKey;
import static google.registry.util.CollectionUtils.findDuplicates;
import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.google.common.base.Joiner;
import com.google.template.soy.data.SoyMapData;
import google.registry.model.domain.DomainResource;
import google.registry.tools.soy.RenewDomainSoyInfo;
import google.registry.util.Clock;
import java.util.List;
import javax.inject.Inject;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
/** A command to renew domain(s) via EPP. */
@Parameters(separators = " =", commandDescription = "Renew domain(s) via EPP.")
final class RenewDomainCommand extends MutatingEppToolCommand {
@Parameter(
names = "--period",
description = "Number of years to renew the registration for (defaults to 1).")
private int period = 1;
@Parameter(description = "Names of the domains to renew.", required = true)
private List<String> mainParameters;
@Inject
Clock clock;
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormat.forPattern("YYYY-MM-dd");
@Override
protected void initMutatingEppToolCommand() {
String duplicates = Joiner.on(", ").join(findDuplicates(mainParameters));
checkArgument(duplicates.isEmpty(), "Duplicate domain arguments found: '%s'", duplicates);
checkArgument(period < 10, "Cannot renew domains for 10 or more years");
DateTime now = clock.nowUtc();
for (String domainName : mainParameters) {
DomainResource domain = loadByForeignKey(DomainResource.class, domainName, now);
checkArgumentNotNull(domain, "Domain '%s' does not exist or is deleted", domainName);
setSoyTemplate(RenewDomainSoyInfo.getInstance(), RenewDomainSoyInfo.RENEWDOMAIN);
addSoyRecord(
domain.getCurrentSponsorClientId(),
new SoyMapData(
"domainName", domain.getFullyQualifiedDomainName(),
"expirationDate", domain.getRegistrationExpirationTime().toString(DATE_FORMATTER),
"period", String.valueOf(period)));
}
}
}

View file

@ -0,0 +1,38 @@
// Copyright 2018 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.
{namespace domain.registry.tools}
/**
* Renew domain request
*/
{template .renewdomain stricthtml="false"}
{@param domainName: string}
{@param expirationDate: string}
{@param period: string}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<renew>
<domain:renew
xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
<domain:name>{$domainName}</domain:name>
<domain:curExpDate>{$expirationDate}</domain:curExpDate>
<domain:period unit="y">{$period}</domain:period>
</domain:renew>
</renew>
<clTRID>RegistryTool</clTRID>
</command>
</epp>
{/template}

View file

@ -316,6 +316,16 @@ public class DatastoreHelper {
newDomainResource(domainName).asBuilder().setCreationTimeForTest(creationTime).build()); newDomainResource(domainName).asBuilder().setCreationTimeForTest(creationTime).build());
} }
public static DomainResource persistActiveDomain(
String domainName, DateTime creationTime, DateTime expirationTime) {
return persistResource(
newDomainResource(domainName)
.asBuilder()
.setCreationTimeForTest(creationTime)
.setRegistrationExpirationTime(expirationTime)
.build());
}
public static DomainApplication persistActiveDomainApplication(String domainName) { public static DomainApplication persistActiveDomainApplication(String domainName) {
return persistResource(newDomainApplication(domainName)); return persistResource(newDomainApplication(domainName));
} }

View file

@ -0,0 +1,140 @@
// Copyright 2018 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.DatastoreHelper.persistActiveDomain;
import static google.registry.testing.DatastoreHelper.persistDeletedDomain;
import static google.registry.testing.DatastoreHelper.persistResource;
import static google.registry.testing.JUnitBackports.assertThrows;
import com.beust.jcommander.ParameterException;
import com.google.common.collect.ImmutableMap;
import google.registry.model.ofy.Ofy;
import google.registry.testing.FakeClock;
import google.registry.testing.InjectRule;
import google.registry.util.Clock;
import org.joda.time.DateTime;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
/** Unit tests for {@link RenewDomainCommand}. */
public class RenewDomainCommandTest extends EppToolCommandTestCase<RenewDomainCommand> {
@Rule public final InjectRule inject = new InjectRule();
private final Clock clock = new FakeClock(DateTime.parse("2015-04-05T05:05:05Z"));
@Before
public void before() {
inject.setStaticField(Ofy.class, "clock", clock);
command.clock = clock;
}
@Test
public void testSuccess() throws Exception {
persistResource(
persistActiveDomain(
"domain.tld",
DateTime.parse("2014-09-05T05:05:05Z"),
DateTime.parse("2015-09-05T05:05:05Z"))
.asBuilder()
.setPersistedCurrentSponsorClientId("NewRegistrar")
.build());
runCommandForced("domain.tld");
eppVerifier
.expectClientId("NewRegistrar")
.verifySent(
"domain_renew.xml",
ImmutableMap.of("DOMAIN", "domain.tld", "EXPDATE", "2015-09-05", "YEARS", "1"))
.verifyNoMoreSent();
}
@Test
public void testSuccess_multipleDomains() throws Exception {
persistActiveDomain(
"domain1.tld",
DateTime.parse("2014-09-05T05:05:05Z"),
DateTime.parse("2015-09-05T05:05:05Z"));
persistActiveDomain(
"domain2.tld",
DateTime.parse("2014-11-05T05:05:05Z"),
DateTime.parse("2015-11-05T05:05:05Z"));
persistActiveDomain(
"domain3.tld",
DateTime.parse("2015-01-05T05:05:05Z"),
DateTime.parse("2016-01-05T05:05:05Z"));
runCommandForced("--period 3", "domain1.tld", "domain2.tld", "domain3.tld");
eppVerifier
.expectClientId("TheRegistrar")
.verifySent(
"domain_renew.xml",
ImmutableMap.of("DOMAIN", "domain1.tld", "EXPDATE", "2015-09-05", "YEARS", "3"))
.verifySent(
"domain_renew.xml",
ImmutableMap.of("DOMAIN", "domain2.tld", "EXPDATE", "2015-11-05", "YEARS", "3"))
.verifySent(
"domain_renew.xml",
ImmutableMap.of("DOMAIN", "domain3.tld", "EXPDATE", "2016-01-05", "YEARS", "3"))
.verifyNoMoreSent();
}
@Test
public void testFailure_domainDoesntExist() {
IllegalArgumentException e =
assertThrows(IllegalArgumentException.class, () -> runCommandForced("nonexistent.tld"));
assertThat(e)
.hasMessageThat()
.isEqualTo("Domain 'nonexistent.tld' does not exist or is deleted");
}
@Test
public void testFailure_domainIsDeleted() {
persistDeletedDomain("deleted.tld", DateTime.parse("2012-10-05T05:05:05Z"));
IllegalArgumentException e =
assertThrows(IllegalArgumentException.class, () -> runCommandForced("deleted.tld"));
assertThat(e)
.hasMessageThat()
.isEqualTo("Domain 'deleted.tld' does not exist or is deleted");
}
@Test
public void testFailure_duplicateDomainSpecified() {
IllegalArgumentException e =
assertThrows(
IllegalArgumentException.class, () -> runCommandForced("dupe.tld", "dupe.tld"));
assertThat(e).hasMessageThat().isEqualTo("Duplicate domain arguments found: 'dupe.tld'");
}
@Test
public void testFailure_cantRenewForTenYears() {
persistActiveDomain(
"domain.tld",
DateTime.parse("2014-09-05T05:05:05Z"),
DateTime.parse("2015-09-05T05:05:05Z"));
IllegalArgumentException e =
assertThrows(
IllegalArgumentException.class, () -> runCommandForced("domain.tld", "--period 10"));
assertThat(e)
.hasMessageThat()
.isEqualTo("Cannot renew domains for 10 or more years");
}
@Test
public void testFailure_missingDomainNames() {
assertThrows(ParameterException.class, () -> runCommand("--period 4"));
}
}

View file

@ -0,0 +1,13 @@
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<renew>
<domain:renew
xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
<domain:name>%DOMAIN%</domain:name>
<domain:curExpDate>%EXPDATE%</domain:curExpDate>
<domain:period unit="y">%YEARS%</domain:period>
</domain:renew>
</renew>
<clTRID>RegistryTool</clTRID>
</command>
</epp>