Don't prompt to confirm non-mutating nomulus EPP tool commands

This is accomplished by making all non-mutating commands function with dry run set
to true, which also has the pleasurable side effect of not prompting for dry-run
mutating commands either, which also do nothing different/special on the second
run.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=192149150
This commit is contained in:
mcilwain 2018-04-09 10:40:20 -07:00 committed by Ben McIlwain
parent 013558c814
commit 3bbaf585e5
15 changed files with 248 additions and 48 deletions

View file

@ -32,7 +32,11 @@ public abstract class ConfirmingCommand implements Command {
if (checkExecutionState()) {
init();
printLineIfNotEmpty(prompt());
if (force || promptForYes("Perform this command?")) {
if (dontRunCommand()) {
// This typically happens when all of the work is accomplished inside of prompt(), so do
// nothing further.
return;
} else if (force || promptForYes("Perform this command?")) {
System.out.println(execute());
printLineIfNotEmpty(postExecute());
} else {
@ -49,6 +53,11 @@ public abstract class ConfirmingCommand implements Command {
/** Initializes the command. */
protected void init() throws Exception {}
/** Whether to NOT run the command. Override to true for dry-run commands. */
protected boolean dontRunCommand() {
return false;
}
/** Returns the optional extra confirmation prompt for the command. */
protected String prompt() throws Exception {
return "";

View file

@ -25,7 +25,7 @@ import google.registry.tools.soy.DomainApplicationInfoSoyInfo;
/** A command to execute a domain application info EPP command. */
@Parameters(separators = " =", commandDescription = "Get domain application EPP info")
final class DomainApplicationInfoCommand extends EppToolCommand {
final class DomainApplicationInfoCommand extends NonMutatingEppToolCommand {
@Parameter(
names = {"-c", "--client"},

View file

@ -24,7 +24,7 @@ import java.util.List;
/** A command to execute a domain check claims epp command. */
@Parameters(separators = " =", commandDescription = "Check claims on domain(s)")
final class DomainCheckClaimsCommand extends EppToolCommand {
final class DomainCheckClaimsCommand extends NonMutatingEppToolCommand {
@Parameter(
names = {"-c", "--client"},

View file

@ -24,7 +24,7 @@ import java.util.List;
/** A command to execute a domain check epp command. */
@Parameters(separators = " =", commandDescription = "Check domain availability")
final class DomainCheckCommand extends EppToolCommand {
final class DomainCheckCommand extends NonMutatingEppToolCommand {
@Parameter(
names = {"-c", "--client"},

View file

@ -24,7 +24,7 @@ import java.util.List;
/** A command to execute a domain check fees epp command. */
@Parameters(separators = " =", commandDescription = "Check domain fees (for a 1-year create)")
final class DomainCheckFeeCommand extends EppToolCommand {
final class DomainCheckFeeCommand extends NonMutatingEppToolCommand {
@Parameter(
names = {"-c", "--client"},

View file

@ -14,7 +14,6 @@
package google.registry.tools;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Strings.nullToEmpty;
import static com.google.common.collect.Maps.filterValues;
@ -123,9 +122,8 @@ abstract class EppToolCommand extends ConfirmingCommand implements ServerSideCom
}
@Override
protected boolean checkExecutionState() throws Exception {
checkArgument(!(force && isDryRun()), "--force and --dry_run are incompatible");
return true;
protected boolean dontRunCommand() {
return isDryRun();
}
@Override

View file

@ -14,6 +14,8 @@
package google.registry.tools;
import static com.google.common.base.Preconditions.checkArgument;
import com.beust.jcommander.Parameter;
/**
@ -27,6 +29,12 @@ public abstract class MutatingEppToolCommand extends EppToolCommand {
description = "Do not actually commit any mutations")
boolean dryRun;
@Override
protected boolean checkExecutionState() throws Exception {
checkArgument(!(force && isDryRun()), "--force and --dry_run are incompatible");
return true;
}
@Override
protected boolean isDryRun() {
return dryRun;

View file

@ -0,0 +1,32 @@
// 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;
/** A non-mutating EPP command (that does not prompt for confirmation). */
abstract class NonMutatingEppToolCommand extends EppToolCommand {
@Override
protected boolean isDryRun() {
return true;
}
@Override
protected boolean checkExecutionState() {
checkArgument(!force, "--force is unnecessary with non-mutating EPP tool commands");
return true;
}
}