Allow square bracket expansion when specifying nameservers

I'm finally fed up enough with all the nameserver changes we've had to make on our
self-allocated domains to improve the command.  Now you can simply run:

$ nomulus ... update_domain ... -n ns[1-4].foo.bar

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=205282317
This commit is contained in:
mcilwain 2018-07-19 12:27:07 -07:00 committed by jianglai
parent 4b99fae1dd
commit a2fe058865
9 changed files with 305 additions and 32 deletions

View file

@ -47,6 +47,22 @@ public class CreateDomainCommandTest extends EppToolCommandTestCase<CreateDomain
eppVerifier.verifySent("domain_create_complete.xml");
}
@Test
public void testSuccess_completeWithSquareBrackets() throws Exception {
runCommandForced(
"--client=NewRegistrar",
"--period=1",
"--nameservers=ns[1-4].zdns.google",
"--registrant=crr-admin",
"--admins=crr-admin",
"--techs=crr-tech",
"--password=2fooBAR",
"--ds_records=1 2 3 abcd,4 5 6 EF01",
"--ds_records=60485 5 2 D4B7D520E7BB5F0F67674A0CCEB1E3E0614B93C4F9E99B8383F6A1E4469DA50A",
"example.tld");
eppVerifier.verifySent("domain_create_complete.xml");
}
@Test
public void testSuccess_minimal() throws Exception {
// Test that each optional field can be omitted. Also tests the auto-gen password.
@ -216,6 +232,22 @@ public class CreateDomainCommandTest extends EppToolCommandTestCase<CreateDomain
assertThat(thrown).hasMessageThat().contains("There can be at most 13 nameservers");
}
@Test
public void testFailure_tooManyNameServers_usingSquareBracketRange() {
IllegalArgumentException thrown =
assertThrows(
IllegalArgumentException.class,
() ->
runCommandForced(
"--client=NewRegistrar",
"--registrant=crr-admin",
"--admins=crr-admin",
"--techs=crr-tech",
"--nameservers=ns[1-14].zdns.google",
"example.tld"));
assertThat(thrown).hasMessageThat().contains("There can be at most 13 nameservers");
}
@Test
public void testFailure_badPeriod() {
ParameterException thrown =

View file

@ -40,12 +40,32 @@ public class UpdateDomainCommandTest extends EppToolCommandTestCase<UpdateDomain
public void testSuccess_complete() throws Exception {
runCommandForced(
"--client=NewRegistrar",
"--add_nameservers=ns2.zdns.google,ns3.zdns.google",
"--add_nameservers=ns1.zdns.google,ns2.zdns.google",
"--add_admins=crr-admin2",
"--add_techs=crr-tech2",
"--add_statuses=serverDeleteProhibited",
"--add_ds_records=1 2 3 abcd,4 5 6 EF01",
"--remove_nameservers=ns4.zdns.google",
"--remove_nameservers=ns3.zdns.google,ns4.zdns.google",
"--remove_admins=crr-admin1",
"--remove_techs=crr-tech1",
"--remove_statuses=serverHold",
"--remove_ds_records=7 8 9 12ab,6 5 4 34CD",
"--registrant=crr-admin",
"--password=2fooBAR",
"example.tld");
eppVerifier.verifySent("domain_update_complete.xml");
}
@Test
public void testSuccess_completeWithSquareBrackets() throws Exception {
runCommandForced(
"--client=NewRegistrar",
"--add_nameservers=ns[1-2].zdns.google",
"--add_admins=crr-admin2",
"--add_techs=crr-tech2",
"--add_statuses=serverDeleteProhibited",
"--add_ds_records=1 2 3 abcd,4 5 6 EF01",
"--remove_nameservers=ns[3-4].zdns.google",
"--remove_admins=crr-admin1",
"--remove_techs=crr-tech1",
"--remove_statuses=serverHold",
@ -60,12 +80,12 @@ public class UpdateDomainCommandTest extends EppToolCommandTestCase<UpdateDomain
public void testSuccess_multipleDomains() throws Exception {
runCommandForced(
"--client=NewRegistrar",
"--add_nameservers=ns2.zdns.google,ns3.zdns.google",
"--add_nameservers=ns1.zdns.google,ns2.zdns.google",
"--add_admins=crr-admin2",
"--add_techs=crr-tech2",
"--add_statuses=serverDeleteProhibited",
"--add_ds_records=1 2 3 abcd,4 5 6 EF01",
"--remove_nameservers=ns4.zdns.google",
"--remove_nameservers=ns[3-4].zdns.google",
"--remove_admins=crr-admin1",
"--remove_techs=crr-tech1",
"--remove_statuses=serverHold",
@ -81,6 +101,15 @@ public class UpdateDomainCommandTest extends EppToolCommandTestCase<UpdateDomain
@Test
public void testSuccess_multipleDomains_setNameservers() throws Exception {
runTest_multipleDomains_setNameservers("-n ns1.foo.fake,ns2.foo.fake");
}
@Test
public void testSuccess_multipleDomains_setNameserversWithSquareBrackets() throws Exception {
runTest_multipleDomains_setNameservers("-n ns[1-2].foo.fake");
}
private void runTest_multipleDomains_setNameservers(String nsParam) throws Exception {
createTlds("abc", "tld");
HostResource host1 = persistActiveHost("foo.bar.tld");
HostResource host2 = persistActiveHost("baz.bar.tld");
@ -95,7 +124,7 @@ public class UpdateDomainCommandTest extends EppToolCommandTestCase<UpdateDomain
.setNameservers(ImmutableSet.of(Key.create(host2)))
.build());
runCommandForced(
"--client=NewRegistrar", "-n ns1.foo.fake,ns2.foo.fake", "example.abc", "example.tld");
"--client=NewRegistrar", nsParam, "example.abc", "example.tld");
eppVerifier
.verifySent(
"domain_update_add_two_hosts_remove_one.xml",

View file

@ -0,0 +1,122 @@
// 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.params;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth8.assertThat;
import static google.registry.testing.JUnitBackports.assertThrows;
import static google.registry.tools.params.NameserversParameter.splitNameservers;
import com.beust.jcommander.ParameterException;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/** Unit tests for {@link NameserversParameter}. */
@RunWith(JUnit4.class)
public class NameserversParameterTest {
private final NameserversParameter instance = new NameserversParameter();
@Test
public void testConvert_singleBasicNameserver() {
assertThat(instance.convert("ns11.goes.to")).containsExactly("ns11.goes.to");
}
@Test
public void testConvert_multipleBasicNameservers() {
assertThat(instance.convert("ns1.tim.buktu, ns2.tim.buktu, ns3.tim.buktu"))
.containsExactly("ns1.tim.buktu", "ns2.tim.buktu", "ns3.tim.buktu");
}
@Test
public void testConvert_kitchenSink() {
assertThat(instance.convert(" ns1.foo.bar, ,ns2.foo.bar,, ns[1-3].range.baz "))
.containsExactly(
"ns1.foo.bar", "ns2.foo.bar", "ns1.range.baz", "ns2.range.baz", "ns3.range.baz");
}
@Test
public void testConvert_invalid() {
assertThat(instance.convert("ns1.foo.bar,ns2.foo.baz,ns3.foo.bar"))
.containsExactly("ns1.foo.bar", "ns3.foo.bar", "ns2.foo.baz");
}
@Test
public void testValidate_sillyString_throws() {
ParameterException thrown =
assertThrows(ParameterException.class, () -> instance.validate("nameservers", "[[ns]]"));
assertThat(thrown).hasMessageThat().contains("Must be a comma-delimited list of nameservers");
assertThat(thrown).hasCauseThat().hasMessageThat().contains("Could not parse square brackets");
}
@Test
public void testConvert_empty_returnsEmpty() {
assertThat(instance.convert("")).isEmpty();
}
@Test
public void testConvert_nullString_returnsNull() {
assertThat(instance.convert(null)).isEmpty();
}
@Test
public void testSplitNameservers_noopWithNoBrackets() {
assertThat(splitNameservers("ns9.fake.example")).containsExactly("ns9.fake.example");
}
@Test
public void testSplitNameservers_worksWithBrackets() {
assertThat(splitNameservers("ns[1-4].zan.zibar"))
.containsExactly("ns1.zan.zibar", "ns2.zan.zibar", "ns3.zan.zibar", "ns4.zan.zibar");
}
@Test
public void testSplitNameservers_worksWithBrackets_soloRange() {
assertThat(splitNameservers("ns[1-1].zan.zibar")).containsExactly("ns1.zan.zibar");
}
@Test
public void testSplitNameservers_throwsOnInvalidRange() {
IllegalArgumentException thrown =
assertThrows(IllegalArgumentException.class, () -> splitNameservers("ns[9-2].foo.bar"));
assertThat(thrown).hasMessageThat().isEqualTo("Number range [9-2] is invalid");
}
@Test
public void testSplitNameservers_throwsOnInvalidHostname_missingPrefix() {
IllegalArgumentException thrown =
assertThrows(IllegalArgumentException.class, () -> splitNameservers("[1-4].foo.bar"));
assertThat(thrown)
.hasMessageThat()
.isEqualTo("Could not parse square brackets in [1-4].foo.bar");
}
@Test
public void testSplitNameservers_throwsOnInvalidHostname_missingDomainName() {
IllegalArgumentException thrown =
assertThrows(IllegalArgumentException.class, () -> splitNameservers("this.is.ns[1-5]"));
assertThat(thrown)
.hasMessageThat()
.isEqualTo("Could not parse square brackets in this.is.ns[1-5]");
}
@Test
public void testSplitNameservers_throwsOnInvalidRangeSyntax() {
IllegalArgumentException thrown =
assertThrows(IllegalArgumentException.class, () -> splitNameservers("ns[1-4[.foo.bar"));
assertThat(thrown).hasMessageThat().contains("Could not parse square brackets");
}
}

View file

@ -7,8 +7,8 @@
<domain:name>example.tld</domain:name>
<domain:add>
<domain:ns>
<domain:hostObj>ns1.zdns.google</domain:hostObj>
<domain:hostObj>ns2.zdns.google</domain:hostObj>
<domain:hostObj>ns3.zdns.google</domain:hostObj>
</domain:ns>
<domain:contact type="admin">crr-admin2</domain:contact>
<domain:contact type="tech">crr-tech2</domain:contact>
@ -16,6 +16,7 @@
</domain:add>
<domain:rem>
<domain:ns>
<domain:hostObj>ns3.zdns.google</domain:hostObj>
<domain:hostObj>ns4.zdns.google</domain:hostObj>
</domain:ns>
<domain:contact type="admin">crr-admin1</domain:contact>

View file

@ -7,8 +7,8 @@
<domain:name>example.abc</domain:name>
<domain:add>
<domain:ns>
<domain:hostObj>ns1.zdns.google</domain:hostObj>
<domain:hostObj>ns2.zdns.google</domain:hostObj>
<domain:hostObj>ns3.zdns.google</domain:hostObj>
</domain:ns>
<domain:contact type="admin">crr-admin2</domain:contact>
<domain:contact type="tech">crr-tech2</domain:contact>
@ -16,6 +16,7 @@
</domain:add>
<domain:rem>
<domain:ns>
<domain:hostObj>ns3.zdns.google</domain:hostObj>
<domain:hostObj>ns4.zdns.google</domain:hostObj>
</domain:ns>
<domain:contact type="admin">crr-admin1</domain:contact>