Skip to content

[improve][cli]Support for pulsar-shell persistent modes #22522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sandeep-mst wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[improve][cli]Support for pulsar-shell persistent modes #22522

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0ef2dcc
added functionality for admin,config,client persistent shell modes.
sandeep-mst Apr 17, 2024
55554c7
refactored code(naming conventions, method order)
sandeep-mst Apr 17, 2024
68b938a
review comments:
sandeep-mst Apr 18, 2024
6cf3f77
Changed so that switching mode is only possible from default mode.
sandeep-mst Apr 18, 2024
a7bea4e
Merge remote-tracking branch 'origin/master' into pulsar-shell-modes-…
sandeep-mst Sep 4, 2024
9603191
Updated so that shellCommander, systemRegistry changes with the shell…
sandeep-mst Sep 10, 2024
d9084e7
removed config from shell modes.
sandeep-mst Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 99 additions & 25 deletions pulsar-client-tools/src/main/java/org/apache/pulsar/shell/PulsarShell.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.Scanner;
Expand Down Expand Up @@ -130,6 +131,31 @@ enum ExecState {
IDLE,
RUNNING
}

enum ShellMode {
ADMIN("admin"),
CLIENT("client"),
DEFAULT("");

private static final Map<String, ShellMode> COMMAND_MAP = new HashMap<>();

static {
for (ShellMode shellMode : values()) {
COMMAND_MAP.put(shellMode.command, shellMode);
}
}

final String command;

ShellMode(String command) {
this.command = command;
}

public static ShellMode valueOfCommand(String command) {
return COMMAND_MAP.get(command);
}
}

private Properties properties;
@Getter
private final ConfigStore configStore;
Expand All @@ -142,6 +168,9 @@ enum ExecState {
private InteractiveLineReader reader;
private final ConfigShell configShell;
private ExecState execState = ExecState.IDLE;
private ShellMode shellMode = ShellMode.DEFAULT;
private String prompt;
private String promptMessage;

public PulsarShell(String args[]) throws IOException {
this(args, new Properties());
Expand Down Expand Up @@ -262,26 +291,28 @@ public void run() throws Exception {
configureHistory(properties, readerBuilder);
LineReader reader = readerBuilder.build();

final String welcomeMessage =
String.format("Welcome to Pulsar shell!\n %s: %s\n %s: %s\n\n"
+ "Type %s to get started or try the autocompletion (TAB button).\n"
+ "Type %s or %s to end the shell session.\n",
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("Service URL").toAnsi(),
serviceUrl,
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("Admin URL").toAnsi(),
adminUrl,
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("help").toAnsi(),
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("exit").toAnsi(),
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("quit").toAnsi());
output(welcomeMessage, terminal);
String promptMessage;
if (configShell.getCurrentConfig() != null) {
promptMessage = String.format("%s(%s)",
configShell.getCurrentConfig(), getHostFromUrl(serviceUrl));
} else {
promptMessage = getHostFromUrl(serviceUrl);
if (prompt == null) {
final String welcomeMessage =
String.format("Welcome to Pulsar shell!\n %s: %s\n %s: %s\n\n"
+ "Type %s to get started or try the autocompletion (TAB button).\n"
+ "Type %s or %s to end the shell session.\n",
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("Service URL")
.toAnsi(), serviceUrl,
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("Admin URL").toAnsi(),
adminUrl,
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("help").toAnsi(),
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("exit").toAnsi(),
new AttributedStringBuilder().style(AttributedStyle.BOLD).append("quit").toAnsi());
output(welcomeMessage, terminal);

if (configShell.getCurrentConfig() != null) {
promptMessage = String.format("%s(%s)",
configShell.getCurrentConfig(), getHostFromUrl(serviceUrl));
} else {
promptMessage = getHostFromUrl(serviceUrl);
}
prompt = createPrompt(promptMessage);
}
final String prompt = createPrompt(promptMessage);
return new InteractiveLineReader() {
@Override
public String readLine() {
Expand Down Expand Up @@ -414,23 +445,42 @@ public List<String> readCommand() {
return;
}
execState = ExecState.RUNNING;
final String line = words.stream().collect(Collectors.joining(" "));
String line = words.stream().collect(Collectors.joining(" "));
if (StringUtils.isBlank(line)) {
continue;
}
if (isQuitCommand(line)) {
if (shellMode != ShellMode.DEFAULT) {
output(String.format("Exiting from %s shell mode", shellMode.command), terminal);
prompt = createPrompt(promptMessage);
shellMode = ShellMode.DEFAULT;
reader = readerBuilder.apply(registerProviders(properties));
continue;
}
exit(0);
return;
}
if (shellMode == ShellMode.DEFAULT) {
ShellMode newShellMode = ShellMode.valueOfCommand(line.toLowerCase(Locale.ROOT));
if (newShellMode != null) {
shellMode = newShellMode;
prompt = createPrompt(promptMessage + " " + shellMode.command);
updateShellCommander(properties);
reader = readerBuilder.apply(providersMap);
continue;
}
}
if (isHelp(line)) {
shellCommander.usage(System.out);
continue;
}

final ShellCommandsProvider pulsarShellCommandsProvider = getProviderFromArgs(shellCommander, words);
if (pulsarShellCommandsProvider == null) {
shellCommander.usage(System.out);
continue;
if (shellMode == ShellMode.DEFAULT) {
final ShellCommandsProvider pulsarShellCommandsProvider = getProviderFromArgs(shellCommander, words);
if (pulsarShellCommandsProvider == null) {
shellCommander.usage(System.out);
continue;
}
}
boolean commandOk = false;
try {
Expand Down Expand Up @@ -561,13 +611,37 @@ private Map<String, ShellCommandsProvider> registerProviders(Properties properti
registerProvider(createClientShell(properties), shellCommander, providerMap);
registerProvider(configShell, shellCommander, providerMap);

updateSystemRegistry();

return providerMap;
}

private void updateShellCommander(Properties properties) throws Exception {
ShellCommandsProvider shellCommandsProvider = createShellFromMode(properties, shellMode);
shellCommander = shellCommandsProvider.getCommander();
updateSystemRegistry();
}

private void updateSystemRegistry() {
Supplier<Path> workDir = () -> Paths.get(DEFAULT_PULSAR_SHELL_ROOT_DIRECTORY);
PicocliCommands picocliCommands = new PicocliCommands(shellCommander);
systemRegistry = new SystemRegistryImpl(parser, terminal, workDir, null);
systemRegistry.setCommandRegistries(picocliCommands);
systemRegistry.register("help", picocliCommands);
}

return providerMap;
protected ShellCommandsProvider createShellFromMode(Properties properties, ShellMode shellMode) throws Exception {
switch (shellMode) {
case ADMIN -> {
return createAdminShell(properties);
}
case CLIENT -> {
return createClientShell(properties);
}
default -> {
return shellCommander.getCommand();
}
}
}

protected AdminShell createAdminShell(Properties properties) throws Exception {
Expand Down