liquibase.command.CommandArgumentDefinition Maven / Gradle / Ivy
Show all versions of liquibase-core Show documentation
package liquibase.command;
import liquibase.Scope;
import liquibase.configuration.ConfigurationValueConverter;
import liquibase.configuration.ConfigurationValueObfuscator;
import liquibase.exception.CommandValidationException;
import liquibase.exception.MissingRequiredArgumentException;
import liquibase.integration.commandline.LiquibaseCommandLineConfiguration;
import liquibase.util.ObjectUtil;
import java.util.Objects;
import java.util.regex.Pattern;
/**
* Defines a known, type-safe argument for a specific {@link CommandStep}.
* Includes metadata about the argument such as a description, if it is required, a default value, etc.
*
* Because this definition is tied to a specific step, multiple steps in a pipeline can define arguments of the same name.
*
* @see CommandBuilder#argument(String, Class) for constructing new instances.
*/
public class CommandArgumentDefinition implements Comparable> {
private static final Pattern ALLOWED_ARGUMENT_PATTERN = Pattern.compile("[a-zA-Z0-9]+");
private final String name;
private final Class dataType;
private String description;
private boolean required;
private boolean hidden;
private DataType defaultValue;
private String defaultValueDescription;
private ConfigurationValueConverter valueConverter;
private ConfigurationValueObfuscator valueObfuscator;
protected CommandArgumentDefinition(String name, Class type) {
this.name = name;
this.dataType = type;
this.valueConverter = value -> ObjectUtil.convert(value, type);
}
/**
* The name of the argument. Must be camelCase alphanumeric.
*/
public String getName() {
return name;
}
/**
* The description of the argument. Used in generated help documentation.
*/
public String getDescription() {
return description;
}
/**
* The datatype this argument will return.
*/
public Class getDataType() {
return dataType;
}
/**
* Whether this argument is required. Exposed as a separate setting for help doc purposes.
* {@link #validate(CommandScope)} will ensure required values are set.
*/
public boolean isRequired() {
return required;
}
/**
* Hidden arguments are ones that can be called via integrations, but should not be normally shown in help to users.
*/
public boolean getHidden() {
return hidden;
}
/**
* The default value to use for this argument
*/
public DataType getDefaultValue() {
return defaultValue;
}
/**
* A description of the default value. Defaults to {@link String#valueOf(Object)} of {@link #getDefaultValue()} but
* can be explicitly with {@link Building#defaultValue(Object, String)}.
*/
public String getDefaultValueDescription() {
return defaultValueDescription;
}
/**
* Function for converting values set in underlying {@link liquibase.configuration.ConfigurationValueProvider}s into the
* type needed for this command.
*/
public ConfigurationValueConverter getValueConverter() {
return valueConverter;
}
/**
* Used when sending the value to user output to protect secure values.
*/
public ConfigurationValueObfuscator getValueObfuscator() {
return valueObfuscator;
}
/**
* Validates that the value stored in the given {@link CommandScope} is valid.
*
* @throws CommandValidationException if the stored value is not valid.
*/
public void validate(CommandScope commandScope) throws CommandValidationException {
final DataType currentValue = commandScope.getArgumentValue(this);
if (this.isRequired() && currentValue == null) {
throw new CommandValidationException(LiquibaseCommandLineConfiguration.ARGUMENT_CONVERTER.getCurrentValue().convert(this.getName()), "missing required argument", new MissingRequiredArgumentException(this.getName()));
}
}
@Override
public int compareTo(CommandArgumentDefinition o) {
return this.getName().compareTo(o.getName());
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CommandArgumentDefinition that = (CommandArgumentDefinition) o;
return Objects.equals(name, that.name);
}
@Override
public int hashCode() {
return Objects.hash(name);
}
@Override
public String toString() {
String returnString = getName();
if (required) {
returnString += " (required)";
}
return returnString;
}
/**
* A new {@link CommandArgumentDefinition} under construction from {@link CommandBuilder}
*/
public static class Building {
private final String[][] commandNames;
private final CommandArgumentDefinition newCommandArgument;
Building(String[][] commandNames, CommandArgumentDefinition newCommandArgument) {
this.commandNames = commandNames;
this.newCommandArgument = newCommandArgument;
//
// If the argument name is "url", then we set up an obfuscator to avoid bleeding credentials
// via the logging framework
//
if (newCommandArgument.getName().equalsIgnoreCase(CommonArgumentNames.URL.getArgumentName())) {
this.setValueObfuscator((ConfigurationValueObfuscator) ConfigurationValueObfuscator.URL_OBFUSCATOR);
}
}
/**
* Mark argument as required.
* @see #optional()
*/
public Building required() {
this.newCommandArgument.required = true;
return this;
}
/**
* Mark argument as optional.
* @see #required()
*/
public Building optional() {
this.newCommandArgument.required = false;
return this;
}
/**
* Mark argument as hidden.
*/
public Building hidden() {
this.newCommandArgument.hidden = true;
return this;
}
/**
* Add a description
*/
public Building description(String description) {
this.newCommandArgument.description = description;
return this;
}
/**
* Set the default value for this argument as well as the description of the default value.
*/
public Building defaultValue(DataType defaultValue, String description) {
newCommandArgument.defaultValue = defaultValue;
newCommandArgument.defaultValueDescription = description;
return this;
}
/**
* Convenience version of {@link #defaultValue(Object, String)} but using {@link String#valueOf(Object)} for the description.
*/
public Building defaultValue(DataType defaultValue) {
String description = null;
if (defaultValue != null) {
description = String.valueOf(defaultValue);
}
return this.defaultValue(defaultValue, description);
}
/**
* Set the {@link #getValueConverter()} to use.
*/
public Building setValueHandler(ConfigurationValueConverter valueHandler) {
newCommandArgument.valueConverter = valueHandler;
return this;
}
/**
* Set the {@link #getValueObfuscator()} to use.
*/
public Building setValueObfuscator(ConfigurationValueObfuscator valueObfuscator) {
newCommandArgument.valueObfuscator = valueObfuscator;
return this;
}
/**
* Complete construction and register the definition with the rest of the system.
*
* @throws IllegalArgumentException is an invalid configuration was specified
*/
public CommandArgumentDefinition build() throws IllegalArgumentException {
if (!ALLOWED_ARGUMENT_PATTERN.matcher(newCommandArgument.name).matches()) {
throw new IllegalArgumentException("Invalid argument format: " + newCommandArgument.name);
}
for (String[] commandName : commandNames) {
try {
Scope.getCurrentScope().getSingleton(CommandFactory.class).register(commandName, newCommandArgument);
} catch (IllegalArgumentException iae) {
Scope.getCurrentScope().getLog(CommandArgumentDefinition.class).warning(
"Unable to register command '" + commandName + "' argument '" + newCommandArgument.getName() + "': " + iae.getMessage());
throw iae;
}
}
return newCommandArgument;
}
}
}