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

java/google/registry/tools/CreateOrUpdateDomainCommand.java

@@ -29,7 +29,9 @@ import com.google.common.collect.ImmutableSet;
 import com.google.common.io.BaseEncoding;
 import com.google.template.soy.data.SoyListData;
 import com.google.template.soy.data.SoyMapData;
+import google.registry.tools.params.NameserversParameter;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 
@@ -47,10 +49,11 @@ abstract class CreateOrUpdateDomainCommand extends MutatingEppToolCommand {
   private List<String> mainParameters;
 
   @Parameter(
-    names = {"-n", "--nameservers"},
-    description = "Comma-separated list of nameservers, up to 13."
-  )
-  List<String> nameservers = new ArrayList<>();
+      names = {"-n", "--nameservers"},
+      description = "Comma-delimited list of nameservers, up to 13.",
+      converter = NameserversParameter.class,
+      validateWith = NameserversParameter.class)
+  Set<String> nameservers = new HashSet<>();
 
   @Parameter(
     names = {"-r", "--registrant"},

java/google/registry/tools/UpdateDomainCommand.java

@@ -32,11 +32,13 @@ import com.google.template.soy.data.SoyMapData;
 import google.registry.model.domain.DesignatedContact;
 import google.registry.model.domain.DomainResource;
 import google.registry.model.eppcommon.StatusValue;
+import google.registry.tools.params.NameserversParameter;
 import google.registry.tools.soy.DomainUpdateSoyInfo;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.TreeSet;
 import org.joda.time.DateTime;
 
 /** A command to update a new domain via EPP. */
@@ -49,12 +51,13 @@ final class UpdateDomainCommand extends CreateOrUpdateDomainCommand {
   private List<String> statuses = new ArrayList<>();
 
   @Parameter(
-    names = "--add_nameservers",
-    description =
-        "Comma-separated list of nameservers to add, up to 13. "
-            + "Cannot be set if --nameservers is set."
-  )
-  private List<String> addNameservers = new ArrayList<>();
+      names = "--add_nameservers",
+      description =
+          "Comma-delimited list of nameservers to add, up to 13. "
+              + "Cannot be set if --nameservers is set.",
+      converter = NameserversParameter.class,
+      validateWith = NameserversParameter.class)
+  private Set<String> addNameservers = new HashSet<>();
 
   @Parameter(
     names = "--add_admins",
@@ -79,12 +82,13 @@ final class UpdateDomainCommand extends CreateOrUpdateDomainCommand {
   private List<DsRecord> addDsRecords = new ArrayList<>();
 
   @Parameter(
-    names = "--remove_nameservers",
-    description =
-        "Comma-separated list of nameservers to remove, up to 13. "
-            + "Cannot be set if --nameservers is set."
-  )
-  private List<String> removeNameservers = new ArrayList<>();
+      names = "--remove_nameservers",
+      description =
+          "Comma-delimited list of nameservers to remove, up to 13. "
+              + "Cannot be set if --nameservers is set.",
+      converter = NameserversParameter.class,
+      validateWith = NameserversParameter.class)
+  private Set<String> removeNameservers = new HashSet<>();
 
   @Parameter(
     names = "--remove_admins",
@@ -156,14 +160,15 @@ final class UpdateDomainCommand extends CreateOrUpdateDomainCommand {
     }
 
     for (String domain : domains) {
-      Set<String> addAdminsThisDomain = new HashSet<>(addAdmins);
-      Set<String> removeAdminsThisDomain = new HashSet<>(removeAdmins);
-      Set<String> addTechsThisDomain = new HashSet<>(addTechs);
-      Set<String> removeTechsThisDomain = new HashSet<>(removeTechs);
-      Set<String> addNameserversThisDomain = new HashSet<>(addNameservers);
-      Set<String> removeNameserversThisDomain = new HashSet<>(removeNameservers);
-      Set<String> addStatusesThisDomain = new HashSet<>(addStatuses);
-      Set<String> removeStatusesThisDomain = new HashSet<>(removeStatuses);
+      // Use TreeSets so that the results are always in the same order (this makes testing easier).
+      Set<String> addAdminsThisDomain = new TreeSet<>(addAdmins);
+      Set<String> removeAdminsThisDomain = new TreeSet<>(removeAdmins);
+      Set<String> addTechsThisDomain = new TreeSet<>(addTechs);
+      Set<String> removeTechsThisDomain = new TreeSet<>(removeTechs);
+      Set<String> addNameserversThisDomain = new TreeSet<>(addNameservers);
+      Set<String> removeNameserversThisDomain = new TreeSet<>(removeNameservers);
+      Set<String> addStatusesThisDomain = new TreeSet<>(addStatuses);
+      Set<String> removeStatusesThisDomain = new TreeSet<>(removeStatuses);
 
       if (!nameservers.isEmpty() || !admins.isEmpty() || !techs.isEmpty() || !statuses.isEmpty()) {
         DateTime now = DateTime.now(UTC);

java/google/registry/tools/params/InternetDomainNameParameter.java

@@ -16,7 +16,7 @@ package google.registry.tools.params;
 
 import com.google.common.net.InternetDomainName;
 
-/** Duration CLI parameter converter/validator. */
+/** InternetDomainName CLI parameter converter/validator. */
 public final class InternetDomainNameParameter
     extends ParameterConverterValidator<InternetDomainName> {
 

java/google/registry/tools/params/NameserversParameter.java

@@ -0,0 +1,80 @@
+// 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.base.Preconditions.checkArgument;
+import static com.google.common.collect.ImmutableSet.toImmutableSet;
+import static java.lang.Integer.parseInt;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Splitter;
+import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+import com.google.re2j.Matcher;
+import com.google.re2j.Pattern;
+import java.util.Set;
+import java.util.stream.Stream;
+
+/**
+ * Nameservers CLI parameter converter/validator.
+ *
+ * <p>This accepts a String containing a comma-delimited list of nameservers. Square bracket
+ * notation can be used to expand multiple nameservers, e.g. "ns[1-2].googledomains.com" will be
+ * expanded to "ns1.googledomains.com,ns2.googledomains.com".
+ */
+public final class NameserversParameter extends ParameterConverterValidator<Set<String>> {
+
+  private static final Pattern FORMAT_BRACKETS = Pattern.compile("^(.+)\\[(\\d+)-(\\d+)\\](.+)$");
+
+  public NameserversParameter() {
+    super(
+        "Must be a comma-delimited list of nameservers, "
+            + "optionally using square bracket expansion e.g. foo[1-4].bar.baz notation");
+  }
+
+  @Override
+  public Set<String> convert(String value) {
+    if (Strings.isNullOrEmpty(value)) {
+      return ImmutableSet.of();
+    }
+    return Splitter.on(',')
+        .trimResults()
+        .omitEmptyStrings()
+        .splitToList(value)
+        .stream()
+        .flatMap(NameserversParameter::splitNameservers)
+        .collect(toImmutableSet());
+  }
+
+  @VisibleForTesting
+  static Stream<String> splitNameservers(String ns) {
+    Matcher matcher = FORMAT_BRACKETS.matcher(ns);
+    if (!matcher.matches()) {
+      checkArgument(
+          !ns.contains("[") && !ns.contains("]"), "Could not parse square brackets in %s", ns);
+      return ImmutableList.of(ns).stream();
+    }
+
+    ImmutableList.Builder<String> nameservers = new ImmutableList.Builder<>();
+    int start = parseInt(matcher.group(2));
+    int end = parseInt(matcher.group(3));
+    checkArgument(start <= end, "Number range [%s-%s] is invalid", start, end);
+    for (int i = start; i <= end; i++) {
+      nameservers.add(String.format("%s%d%s", matcher.group(1), i, matcher.group(4)));
+    }
+    return nameservers.build().stream();
+  }
+}