Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Convert default value

Browse Source 
- Change parser to user conversion service to attempt
  conversion from a default value to an expected type.
- Make more use of shellConversionService bean so that
  we use the one which can be customized.
This commit is contained in:
Janne Valkealahti
2022-05-18 08:00:49 +01:00
parent 6a1158dc12
commit 57f6cff7c6
7 changed files with 91 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/SpringShellAutoConfiguration.java
View File

@@ -20,6 +20,7 @@ import java.util.Set;
import org.jline.terminal.Terminal;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.convert.ApplicationConversionService;
import org.springframework.context.ApplicationContext;
@@ -44,7 +45,7 @@ import org.springframework.shell.result.ResultHandlerConfig;
public class SpringShellAutoConfiguration {
@Bean
@ConditionalOnMissingBean(ConversionService.class)
@ConditionalOnMissingBean(value = ConversionService.class, name = { "shellConversionService" })
public ConversionService shellConversionService(ApplicationContext applicationContext) {
FormattingConversionService service = new FormattingConversionService();
DefaultConversionService.addDefaultConverters(service);
@@ -63,7 +64,10 @@ public class SpringShellAutoConfiguration {
}
@Bean
public Shell shell(ResultHandlerService resultHandlerService, CommandCatalog commandRegistry, Terminal terminal) {
return new Shell(resultHandlerService, commandRegistry, terminal);
public Shell shell(ResultHandlerService resultHandlerService, CommandCatalog commandRegistry, Terminal terminal,
@Qualifier("shellConversionService") ConversionService shellConversionService) {
Shell shell = new Shell(resultHandlerService, commandRegistry, terminal);
shell.setConversionService(shellConversionService);
return shell;
}
}

9
spring-shell-core/src/main/java/org/springframework/shell/Shell.java
View File

@@ -33,6 +33,8 @@ import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.shell.command.CommandCatalog;
import org.springframework.shell.command.CommandExecution;
import org.springframework.shell.command.CommandExecution.CommandExecutionException;
@@ -61,6 +63,7 @@ public class Shell {
private final CommandCatalog commandRegistry;
protected List<CompletionResolver> completionResolvers = new ArrayList<>();
private CommandExecutionHandlerMethodArgumentResolvers argumentResolvers;
private ConversionService conversionService = new DefaultConversionService();
/**
* Marker object to distinguish unresolved arguments from {@code null}, which is a valid
@@ -87,6 +90,10 @@ public class Shell {
this.argumentResolvers = argumentResolvers;
}
public void setConversionService(ConversionService shellConversionService) {
this.conversionService = shellConversionService;
}
@Autowired(required = false)
public void setValidatorFactory(ValidatorFactory validatorFactory) {
this.validator = validatorFactory.getValidator();
@@ -159,7 +166,7 @@ public class Shell {
Object sh = Signals.register("INT", () -> commandThread.interrupt());
try {
CommandExecution execution = CommandExecution
.of(argumentResolvers != null ? argumentResolvers.getResolvers() : null, validator, terminal);
.of(argumentResolvers != null ? argumentResolvers.getResolvers() : null, validator, terminal, conversionService);
return execution.evaluate(commandRegistration.get(), wordsForArgs.toArray(new String[0]));
}
catch (UndeclaredThrowableException e) {

22
spring-shell-core/src/main/java/org/springframework/shell/command/CommandExecution.java
View File

@@ -26,7 +26,6 @@ import org.jline.terminal.Terminal;
import org.springframework.core.MethodParameter;
import org.springframework.core.annotation.Order;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.messaging.Message;
import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
import org.springframework.messaging.support.MessageBuilder;
@@ -60,7 +59,7 @@ public interface CommandExecution {
* @return default command execution
*/
public static CommandExecution of(List<? extends HandlerMethodArgumentResolver> resolvers) {
return new DefaultCommandExecution(resolvers, null, null);
return new DefaultCommandExecution(resolvers, null, null, null);
}
/**
@@ -69,11 +68,12 @@ public interface CommandExecution {
* @param resolvers the handler method argument resolvers
* @param validator the validator
* @param terminal the terminal
* @param conversionService the conversion services
* @return default command execution
*/
public static CommandExecution of(List<? extends HandlerMethodArgumentResolver> resolvers, Validator validator,
Terminal terminal) {
return new DefaultCommandExecution(resolvers, validator, terminal);
Terminal terminal, ConversionService conversionService) {
return new DefaultCommandExecution(resolvers, validator, terminal, conversionService);
}
/**
@@ -84,18 +84,20 @@ public interface CommandExecution {
private List<? extends HandlerMethodArgumentResolver> resolvers;
private Validator validator;
private Terminal terminal;
private ConversionService conversionService;
public DefaultCommandExecution(List<? extends HandlerMethodArgumentResolver> resolvers, Validator validator,
Terminal terminal) {
Terminal terminal, ConversionService conversionService) {
this.resolvers = resolvers;
this.validator = validator;
this.terminal = terminal;
this.conversionService = conversionService;
}
public Object evaluate(CommandRegistration registration, String[] args) {
List<CommandOption> options = registration.getOptions();
CommandParser parser = CommandParser.of();
CommandParser parser = CommandParser.of(conversionService);
CommandParserResults results = parser.parse(options, args);
if (!results.errors().isEmpty()) {
@@ -135,13 +137,14 @@ public interface CommandExecution {
messageBuilder.setHeader(CommandContextMethodArgumentResolver.HEADER_COMMAND_CONTEXT, ctx);
InvocableShellMethod invocableShellMethod = new InvocableShellMethod(targetInfo.getBean(), targetInfo.getMethod());
invocableShellMethod.setConversionService(conversionService);
invocableShellMethod.setValidator(validator);
ShellMethodArgumentResolverComposite argumentResolvers = new ShellMethodArgumentResolverComposite();
if (resolvers != null) {
argumentResolvers.addResolvers(resolvers);
}
if (!paramValues.isEmpty()) {
argumentResolvers.addResolver(new ParamNameHandlerMethodArgumentResolver(paramValues));
argumentResolvers.addResolver(new ParamNameHandlerMethodArgumentResolver(paramValues, conversionService));
}
invocableShellMethod.setMessageMethodArgumentResolvers(argumentResolvers);
@@ -160,10 +163,11 @@ public interface CommandExecution {
static class ParamNameHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
private final Map<String, Object> paramValues = new HashMap<>();
ConversionService conversionService = new DefaultConversionService();
private final ConversionService conversionService;
ParamNameHandlerMethodArgumentResolver(Map<String, Object> paramValues) {
ParamNameHandlerMethodArgumentResolver(Map<String, Object> paramValues, ConversionService conversionService) {
this.paramValues.putAll(paramValues);
this.conversionService = conversionService;
}
@Override

37
spring-shell-core/src/main/java/org/springframework/shell/command/CommandParser.java
View File

@@ -26,6 +26,7 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.springframework.core.ResolvableType;
import org.springframework.core.convert.ConversionService;
import org.springframework.shell.Utils;
import org.springframework.util.StringUtils;
@@ -127,7 +128,17 @@ public interface CommandParser {
* @return instance of a default command parser
*/
static CommandParser of() {
return new DefaultCommandParser();
return of(null);
}
/**
* Gets an instance of a default command parser.
*
* @param conversionService the conversion service
* @return instance of a default command parser
*/
static CommandParser of(ConversionService conversionService) {
return new DefaultCommandParser(conversionService);
}
/**
@@ -190,6 +201,12 @@ public interface CommandParser {
*/
static class DefaultCommandParser implements CommandParser {
private final ConversionService conversionService;
DefaultCommandParser(ConversionService conversionService) {
this.conversionService = conversionService;
}
@Override
public CommandParserResults parse(List<CommandOption> options, String[] args) {
List<CommandOption> requiredOptions = options.stream()
@@ -293,7 +310,7 @@ public interface CommandParser {
* Parser works on a results from a lexer. It looks for given options
* and builds parsing results.
*/
private static class Parser {
private class Parser {
ParserResults visit(List<List<String>> lexerResults, List<CommandOption> options) {
List<ParserResult> results = lexerResults.stream()
.flatMap(lr -> {
@@ -327,7 +344,13 @@ public interface CommandParser {
defaultValueOptionsToCheck.stream()
.filter(co -> co.getDefaultValue() != null)
.forEach(co -> {
results.add(ParserResult.of(co, Collections.emptyList(), co.getDefaultValue(), null));
Object value = co.getDefaultValue();
if (conversionService != null && co.getType() != null) {
if (conversionService.canConvert(co.getDefaultValue().getClass(), co.getType().getRawClass())) {
value = conversionService.convert(co.getDefaultValue(), co.getType().getRawClass());
}
}
results.add(ParserResult.of(co, Collections.emptyList(), value, null));
});
return ParserResults.of(results);
}
@@ -425,10 +448,10 @@ public interface CommandParser {
}
}
return ConvertArgumentsHolder.of(value, unmapped);
return new ConvertArgumentsHolder(value, unmapped);
}
private static class ConvertArgumentsHolder {
private class ConvertArgumentsHolder {
Object value;
final List<String> unmapped = new ArrayList<>();
@@ -438,10 +461,6 @@ public interface CommandParser {
this.unmapped.addAll(unmapped);
}
}
static ConvertArgumentsHolder of(Object value, List<String> unmapped) {
return new ConvertArgumentsHolder(value, unmapped);
}
}
}

14
spring-shell-core/src/main/java/org/springframework/shell/command/invocation/InvocableShellMethod.java
View File

@@ -93,6 +93,8 @@ public class InvocableShellMethod {
private Validator validator;
private ConversionService conversionService = new DefaultConversionService();
/**
* Create an instance from a bean instance and a method.
*/
@@ -146,6 +148,17 @@ public class InvocableShellMethod {
this.parameters = initMethodParameters();
}
/**
* Sets a conversion service
*
* @param conversionService the conversion service
*/
public void setConversionService(ConversionService conversionService) {
if (conversionService != null) {
this.conversionService = conversionService;
}
}
/**
* Copy constructor for use in subclasses.
*/
@@ -226,7 +239,6 @@ public class InvocableShellMethod {
* <p>The resulting array will be passed into {@link #doInvoke}.
*/
protected Object[] getMethodArgumentValues(Message<?> message, Object... providedArgs) throws Exception {
ConversionService conversionService = new DefaultConversionService();
MethodParameter[] parameters = getMethodParameters();
if (ObjectUtils.isEmpty(parameters)) {
return EMPTY_ARGS;

6
spring-shell-core/src/test/java/org/springframework/shell/command/CommandExecutionTests.java
View File

@@ -23,6 +23,7 @@ import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
import org.springframework.shell.command.CommandExecution.CommandParserExceptionsException;
@@ -37,10 +38,11 @@ public class CommandExecutionTests extends AbstractCommandTests {
@BeforeEach
public void setupCommandExecutionTests() {
ConversionService conversionService = new DefaultConversionService();
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();
resolvers.add(new ArgumentHeaderMethodArgumentResolver(new DefaultConversionService(), null));
resolvers.add(new ArgumentHeaderMethodArgumentResolver(conversionService, null));
resolvers.add(new CommandContextMethodArgumentResolver());
execution = CommandExecution.of(resolvers);
execution = CommandExecution.of(resolvers, null, null, conversionService);
}
@Test

19
spring-shell-core/src/test/java/org/springframework/shell/command/CommandParserTests.java
View File

@@ -23,6 +23,8 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.core.ResolvableType;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.shell.command.CommandParser.CommandParserResults;
import static org.assertj.core.api.Assertions.assertThat;
@@ -33,7 +35,8 @@ public class CommandParserTests extends AbstractCommandTests {
@BeforeEach
public void setupCommandParserTests() {
parser = CommandParser.of();
ConversionService conversionService = new DefaultConversionService();
parser = CommandParser.of(conversionService);
}
@Test
@@ -320,6 +323,20 @@ public class CommandParserTests extends AbstractCommandTests {
assertThat(results.results().get(1).value()).isEqualTo("2");
}
@Test
public void testBooleanWithDefault() {
ResolvableType type = ResolvableType.forType(boolean.class);
CommandOption option1 = CommandOption.of(new String[] { "arg1" }, new Character[0], "description", type, false,
"true", null, null, null);
List<CommandOption> options = Arrays.asList(option1);
String[] args = new String[]{};
CommandParserResults results = parser.parse(options, args);
assertThat(results.results()).hasSize(1);
assertThat(results.results().get(0).option()).isSameAs(option1);
assertThat(results.results().get(0).value()).isEqualTo(true);
}
private static CommandOption longOption(String name) {
return longOption(name, null);
}