ARTEMIS-4372 Implement Pico-cli and script auto-complete #4565

clebertsuconic · 2023-07-24T17:42:11Z

No description provided.

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/AutoCompletion.java

gemmellr · 2023-07-28T10:37:58Z

I have added one more review from myself. When using user/password the system would ask me for the user/password all the time. I'm now saving the last successful user/password between executions, adding a connect and disconnect that's only available through the shell (what makes the shell more useful since it won't ask for user/password every time when using security)

I think the ability to set and clear the URI + credentials used for subsequent commands in the shell is good. I'm less clear on it doing it silently in the background based on every previous command.

At least one of the additions you made was around it handling the URIs crossing between the different clients, presumably as the URI is saved but the protocol value is not, probably how you hit that, the client used will change between commands in some cases, whilst the URI + credentials etc do not even though the URIs are client-specific.

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/Artemis.java

artemis-distribution/src/main/resources/licenses/bin/LICENSE

docs/user-manual/en/using-server.md

clebertsuconic · 2023-07-28T15:11:01Z

for my future reference. I opened an issue and Pull Request on Pico: remkop/picocli#2075

the jshell auto completion is showing hidden values. the PR sent would fix it but I'm waiting for a best way to merge this upstream in Pico. hidden is the way to go to "deprecate" stuff.

clebertsuconic · 2023-07-28T16:30:48Z

Only thing left on my todo is the JDK parameters and testing with a newer version. will do it before the end of today.

gnodet

You need to add jansi library, which is an optional dependency of JLine for better support.

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/Shell.java

artemis-cli/pom.xml

artemis-cli/src/main/resources/org/apache/activemq/artemis/cli/commands/bin/artemis

gnodet · 2023-07-31T12:38:35Z

artemis-distribution/src/main/resources/bin/artemis

+    --add-opens java.base/java.lang=ALL-UNNAMED \
+    --add-opens java.base/java.io=ALL-UNNAMED \
+    --add-opens java.base/java.util=ALL-UNNAMED \


See above, adding jansi will remove the need for those options.

I did the change manually.. thank you so much

ARTEMIS-4375 Implement artemis shell using JLine3 integrated with auto-completion from picocli This commit involves two JIRAs. One is adding PicoCLI and the next is Using JLine3 and implement a shell. I have tried to keep these commits separate but these changes became interdependent hence the two JIRAs are squashed in this commit.

clebertsuconic · 2023-07-31T14:39:36Z

@gemmellr I am merging this... further changes can be sent into main after this.

Thanks for your help on this

gemmellr · 2023-07-31T14:25:45Z

...-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionAbstract.java

+         } catch (Exception e2) {
+         }


This one does nothing, the earlier ones for Qpid JMS print the stack. Seems like they should be the same one way or the other.

gemmellr · 2023-07-31T14:27:07Z

...-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionAbstract.java

+         } catch (Exception e2) {
+         }


not really in both cases.. This is the exception of the exception. IN case the input user/password does not succeed, if this does not work this will simply not save the password here.

I see what you mean now.

gemmellr · 2023-07-31T16:30:21Z

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/DestAbstract.java

+         context.out.println("--txt-size is deprecated, please use --commit-interval");
+         txBatchSize = oldBatchSize;


If both were somehow set, I would expect the new one to always win...here the old one will win.

gemmellr · 2023-07-31T16:30:46Z

...is-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/perf/PerfCommand.java

+      if (txSize > 0) {
+         System.out.println("--tx-size is deprecated, please use --commit-interval");
+         commitInterval = txSize;
+      }


If both were somehow set, I would expect the new one to always win...here the old one will win.

gemmellr · 2023-07-31T16:35:46Z

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/Artemis.java

+
+      // Pico shouldn't allow generating a commandLine without an userObject.
+      // the following assert "should" never happen
+      assert userObject != null;


Good chance the assert also wont happen unless people turn on assertions. Seems like a null check would have been simpler. Though it will at least still NPE later, when failing to throw the IAE.

this is never supposed to happen.
Only chance userObject is null is if you set the userObject wrongly during development. and picocli actually validate that already.

Fair enough. You didnt note the last bit before, just that 'we shouldnt add things that arent Runnable or Action', then you added the fallback check which would NPE if it was null, which I then noted. I'd still have just added a simple Objects.nonNull("oh-dear developer-error", userObject) rather than the multi line assert+comment that quite posibly still wont do anything and allow the raw NPE to occur.

clebertsuconic marked this pull request as draft July 24, 2023 17:43

clebertsuconic force-pushed the pico branch 2 times, most recently from ba030cb to 35e9c6c Compare July 24, 2023 17:45

jbertram reviewed Jul 24, 2023

View reviewed changes

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/AutoCompletion.java Outdated Show resolved Hide resolved

clebertsuconic force-pushed the pico branch 17 times, most recently from 4e47aee to d032d26 Compare July 26, 2023 15:25

clebertsuconic marked this pull request as ready for review July 26, 2023 15:25

clebertsuconic force-pushed the pico branch 8 times, most recently from dcde5cb to 469bf63 Compare July 26, 2023 22:01

clebertsuconic force-pushed the pico branch 2 times, most recently from 5f93a97 to 0ab4a7f Compare July 28, 2023 13:22

gemmellr reviewed Jul 28, 2023

View reviewed changes

artemis-cli/src/main/java/org/apache/activemq/artemis/cli/Artemis.java Outdated Show resolved Hide resolved

artemis-distribution/src/main/resources/licenses/bin/LICENSE Show resolved Hide resolved

docs/user-manual/en/using-server.md Outdated Show resolved Hide resolved

clebertsuconic force-pushed the pico branch 8 times, most recently from eb5a4ae to d3da085 Compare July 28, 2023 16:30

clebertsuconic force-pushed the pico branch 4 times, most recently from c525d25 to 1e4e8fc Compare July 29, 2023 15:35

gnodet previously requested changes Jul 31, 2023

View reviewed changes

clebertsuconic force-pushed the pico branch 2 times, most recently from bb2a7e1 to 7a63e40 Compare July 31, 2023 12:57

clebertsuconic force-pushed the pico branch 2 times, most recently from 36910d2 to 7a992ae Compare July 31, 2023 13:07

clebertsuconic force-pushed the pico branch from 7a992ae to 6b546cb Compare July 31, 2023 13:52

clebertsuconic merged commit 93ee61e into apache:main Jul 31, 2023
3 of 6 checks passed

gemmellr reviewed Jul 31, 2023

View reviewed changes

clebertsuconic deleted the pico branch August 14, 2023 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ARTEMIS-4372 Implement Pico-cli and script auto-complete #4565

ARTEMIS-4372 Implement Pico-cli and script auto-complete #4565

clebertsuconic commented Jul 24, 2023

gemmellr commented Jul 28, 2023

clebertsuconic commented Jul 28, 2023

clebertsuconic commented Jul 28, 2023

gnodet left a comment

gnodet Jul 31, 2023

clebertsuconic commented Jul 31, 2023

gemmellr Jul 31, 2023

gemmellr Jul 31, 2023

clebertsuconic Jul 31, 2023

clebertsuconic Aug 1, 2023

gemmellr Jul 31, 2023

gemmellr Jul 31, 2023

gemmellr Jul 31, 2023

clebertsuconic Jul 31, 2023

gemmellr Aug 1, 2023

		context.out.println("--txt-size is deprecated, please use --commit-interval");
		txBatchSize = oldBatchSize;

ARTEMIS-4372 Implement Pico-cli and script auto-complete #4565

ARTEMIS-4372 Implement Pico-cli and script auto-complete #4565

Conversation

clebertsuconic commented Jul 24, 2023

gemmellr commented Jul 28, 2023

clebertsuconic commented Jul 28, 2023

clebertsuconic commented Jul 28, 2023

gnodet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clebertsuconic commented Jul 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment