Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve validation of layertools input
This commit improves the validation performed on the user input provided to the layertools jarmode to provide more clear error messages when the input is not correct and reduce the chance of ambiguity. Fixes gh-22042
- Loading branch information
1 parent
a2f7ce0
commit 9a08358
Showing
9 changed files
with
176 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ | |
* {@link JarMode} providing {@code "layertools"} support. | ||
* | ||
* @author Phillip Webb | ||
* @author Scott Frederick | ||
* @since 2.3.0 | ||
*/ | ||
public class LayerToolsJarMode implements JarMode { | ||
|
@@ -63,22 +64,48 @@ static class Runner { | |
} | ||
|
||
private void run(String[] args) { | ||
run(new ArrayDeque<>(Arrays.asList(args))); | ||
run(dequeOf(args)); | ||
} | ||
|
||
private void run(Deque<String> args) { | ||
if (!args.isEmpty()) { | ||
Command command = Command.find(this.commands, args.removeFirst()); | ||
String commandName = args.removeFirst(); | ||
Command command = Command.find(this.commands, commandName); | ||
if (command != null) { | ||
command.run(args); | ||
runCommand(command, args); | ||
return; | ||
} | ||
printError("Unknown command \"" + commandName + "\""); | ||
} | ||
this.help.run(args); | ||
} | ||
|
||
private void runCommand(Command command, Deque<String> args) { | ||
try { | ||
command.run(args); | ||
} | ||
catch (UnknownOptionException ex) { | ||
printError("Unknown option \"" + ex.getMessage() + "\" for the " + command.getName() + " command"); | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
scottfrederick
Author
Contributor
|
||
this.help.run(dequeOf(command.getName())); | ||
} | ||
catch (MissingValueException ex) { | ||
printError("Option \"" + ex.getMessage() + "\" for the " + command.getName() | ||
+ " command requires a value"); | ||
this.help.run(dequeOf(command.getName())); | ||
} | ||
} | ||
|
||
private void printError(String errorMessage) { | ||
System.out.println("Error: " + errorMessage); | ||
System.out.println(); | ||
} | ||
|
||
private Deque<String> dequeOf(String... args) { | ||
return new ArrayDeque<>(Arrays.asList(args)); | ||
} | ||
|
||
static List<Command> getCommands(Context context) { | ||
List<Command> commands = new ArrayList<Command>(); | ||
List<Command> commands = new ArrayList<>(); | ||
commands.add(new ListCommand(context)); | ||
commands.add(new ExtractCommand(context)); | ||
return Collections.unmodifiableList(commands); | ||
|
37 changes: 37 additions & 0 deletions
37
...ools/src/main/java/org/springframework/boot/jarmode/layertools/MissingValueException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* 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 | ||
* | ||
* https://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 org.springframework.boot.jarmode.layertools; | ||
|
||
/** | ||
* Exception thrown when a required value is not provided for an option. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class MissingValueException extends RuntimeException { | ||
|
||
private final String optionName; | ||
|
||
MissingValueException(String optionName) { | ||
this.optionName = optionName; | ||
} | ||
|
||
@Override | ||
public String getMessage() { | ||
return "--" + this.optionName; | ||
} | ||
|
||
} |
37 changes: 37 additions & 0 deletions
37
...ols/src/main/java/org/springframework/boot/jarmode/layertools/UnknownOptionException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* 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 | ||
* | ||
* https://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 org.springframework.boot.jarmode.layertools; | ||
|
||
/** | ||
* Exception thrown when an unrecognized option is encountered. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class UnknownOptionException extends RuntimeException { | ||
|
||
private final String optionName; | ||
|
||
UnknownOptionException(String optionName) { | ||
this.optionName = optionName; | ||
} | ||
|
||
@Override | ||
public String getMessage() { | ||
return "--" + this.optionName; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
...st/resources/org/springframework/boot/jarmode/layertools/error-command-unknown-output.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Error: Unknown command "invalid" | ||
|
||
Usage: | ||
java -Djarmode=layertools -jar test.jar | ||
|
||
Available commands: | ||
list List layers from the jar that can be extracted | ||
extract Extracts layers from the jar for image creation | ||
help Help about any command |
9 changes: 9 additions & 0 deletions
9
...sources/org/springframework/boot/jarmode/layertools/error-option-missing-value-output.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Error: Option "--destination" for the extract command requires a value | ||
|
||
Extracts layers from the jar for image creation | ||
|
||
Usage: | ||
java -Djarmode=layertools -jar test.jar extract [options] [<layer>...] | ||
|
||
Options: | ||
--destination string The destination to extract files to |
9 changes: 9 additions & 0 deletions
9
...est/resources/org/springframework/boot/jarmode/layertools/error-option-unknown-output.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Error: Unknown option "--invalid" for the extract command | ||
|
||
Extracts layers from the jar for image creation | ||
|
||
Usage: | ||
java -Djarmode=layertools -jar test.jar extract [options] [<layer>...] | ||
|
||
Options: | ||
--destination string The destination to extract files to |
Wouldn't it be a little cleaner to do something like the following:
And having the messages inside the specific exceptions. Currently both exceptions have the same message, which is imho a bit confusing anyway.
What do you think, @scottfrederick ?