Add plugin information for Verbose mode #18051

gmoskovicz · 2016-04-28T19:56:52Z

With this Pull Request, we will show extra information about plugins running the bin/elasticsearch-plugin command under verbose mode.

gmoskovicz · 2016-04-28T19:57:44Z

@jasontedor @nik9000 Can you please verify this PR?

jasontedor · 2016-04-28T20:01:02Z

Sure, I would be happy to give it a review.

rjernst · 2016-04-28T20:14:25Z

core/src/main/java/org/elasticsearch/plugins/ListPluginsCommand.java

+                catch(IOException ex) {
+                    terminal.println(Terminal.Verbosity.VERBOSE, "Plugin properties file missing for plugin");
+                }
+                catch (Exception ex){


I dont think we should add leniency here. This will only hide the actual problem. Let the exception propagate.

This exception should immediately bubble up to the user. Catch it, add which plugin it died on with this as the cause and throw.

gmoskovicz · 2016-04-29T17:28:08Z

@rjernst @jasontedor

Fixed code review comments. Please note that now, if the .description file is missing OR it is not supported (wrong JVM/ES version), we will raise an exception when running the bin/elasticsearch-plugin list command, no matter if using -v or not.

gmoskovicz · 2016-04-29T18:16:10Z

The new format looks like

➜  elasticsearch-5.0.0-alpha2-SNAPSHOT bin/elasticsearch-plugin list -v
Plugins directory: /Users/Gabriel/Documents/ElasticSearch/elasticsearch-5.0.0-alpha2-SNAPSHOT/plugins
license
- Plugin information:
Name: license
Description: Internal Elasticsearch Licensing Plugin
Version: 2.2.0
 * Classname: org.elasticsearch.license.plugin.LicensePlugin
marvel-agent
- Plugin information:
Name: marvel-agent
Description: Elasticsearch Marvel Agent
Version: 2.2.0
 * Classname: org.elasticsearch.marvel.MarvelPlugin

gmoskovicz · 2016-05-02T16:26:29Z

@rjernst @jasontedor does it looks better now? Ready to merge?

jasontedor · 2016-05-02T16:34:07Z

qa/evil-tests/src/test/java/org/elasticsearch/plugins/ListPluginsCommandTests.java

+        String output = terminal.getOutput();
+
+        //Should be 3 plugins, so if i split by plugin informations i should get 4 strings
+        assertTrue(output, output.split("Plugin information").length == 4);


I don't like assertTrue style assertions as the message when the assertion fails is useless. The matchers give much more useful information when an assertion fails. For example:

assertThat(output.split("Plugin information"), arrayWithSize(4));

That comment applies to all uses of assertTrue and assertFalse here.

I disagree with this comment. I think using assertTrue and assertFalse is just fine. The message is not useless when you add eg the output like is done here. No matter what the message says, someone looking into a test failure needs to look at the test.

Maybe i can change all the messages from the class?

I was actually trying to follow the convention on the existing tests in this class. Although it seems that this class was using old/wrong formats?

The message is not useless when you add eg the output like is done here.

This I disagree with. The output is just the contents of output, that doesn't say what failed. You get that for free using the matchers and I find it valuable.

No matter what the message says, someone looking into a test failure needs to look at the test.

This I agree with.

I will change some of the assertions to use assertEquals. The message is actually much better than assert True.

jasontedor · 2016-05-02T16:37:52Z

does it looks better now? Ready to merge?

I left more feedback.

gmoskovicz · 2016-05-02T18:16:56Z

Added more fixes @jasontedor

jasontedor · 2016-05-06T14:24:01Z

qa/evil-tests/src/test/java/org/elasticsearch/plugins/ListPluginsCommandTests.java

+        IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> {
+        	listPlugins(env);
+        });
+        assertTrue(e.getMessage(), e.getMessage().contains("Property [name] is missing in"));


Can we convert this off of assertTrue, the error message is useless?

jasontedor · 2016-05-06T14:26:06Z

Added more fixes @jasontedor

Left some comments.

gmoskovicz · 2016-05-06T14:42:01Z

Thanks @jasontedor . Fixed those as well.

Ready to ? 😄

jasontedor · 2016-05-06T15:09:00Z

qa/evil-tests/src/test/java/org/elasticsearch/plugins/ListPluginsCommandTests.java

+        IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> {
+        	listPlugins(env);
+        });
+        assertEquals(e.getMessage(), "Property [name] is missing in [" + env.pluginsFile().resolve("fake1").resolve(PluginInfo.ES_PLUGIN_PROPERTIES).toString() + "]");


This looks like it might be too long for the line-length limit?

jasontedor · 2016-05-06T15:10:51Z

qa/evil-tests/src/test/java/org/elasticsearch/plugins/ListPluginsCommandTests.java

+        Environment env = createEnv();        
+        PluginTestUtil.writeProperties(env.pluginsFile().resolve("fake1"),
+                "description", "fake desc");
+        IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> {


This lambda does not need to be a statement block.

jasontedor · 2016-05-06T15:14:18Z

Ready to ? 😄

I left more comments. Can you run gradle check?

gmoskovicz · 2016-05-09T19:07:36Z

@jasontedor Gradle check was successful .

jasontedor · 2016-05-10T15:23:20Z

LGTM. Thanks @gmoskovicz!

gmoskovicz · 2016-05-10T15:32:50Z

Sweet! Thanks for all the help @jasontedor !

Add plugin information for Verbose mode

397c9f1

rjernst reviewed Apr 28, 2016
View reviewed changes

clintongormley added >enhancement :Core/Infra/Plugins Plugin API and infrastructure labels Apr 29, 2016

gmoskovicz added 3 commits April 29, 2016 14:22

Fixed code review comments and added tests.

8307a05

Added helper on another test.

f94a749

Added stronger assertions.

fb2c1b7

jasontedor reviewed May 2, 2016
View reviewed changes

Fixed and simplify tests

234bc68

jasontedor reviewed May 6, 2016
View reviewed changes

Fixed tests with latest comments

ffe41ec

jasontedor reviewed May 6, 2016
View reviewed changes

gmoskovicz added 2 commits May 6, 2016 13:02

Fixed no-needed brackets and long line

206d2f9

Fix indentation.

9f87f9f

jasontedor merged commit 0660386 into elastic:master May 10, 2016

gmoskovicz mentioned this pull request May 10, 2016

Output version when running bin/plugin list #16375

Closed

jasontedor mentioned this pull request May 11, 2016

Sort plugins in list plugins command #18260

Merged

clintongormley added the v5.0.0-alpha3 label May 11, 2016

rjernst mentioned this pull request Jun 1, 2016

Display plugins versions #18683

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add plugin information for Verbose mode #18051

Add plugin information for Verbose mode #18051

gmoskovicz commented Apr 28, 2016

gmoskovicz commented Apr 28, 2016

jasontedor commented Apr 28, 2016

rjernst Apr 28, 2016

jasontedor Apr 28, 2016

gmoskovicz commented Apr 29, 2016

gmoskovicz commented Apr 29, 2016

gmoskovicz commented May 2, 2016

jasontedor May 2, 2016

rjernst May 2, 2016

gmoskovicz May 2, 2016

jasontedor May 2, 2016 •

edited

Loading

gmoskovicz May 2, 2016

jasontedor commented May 2, 2016

gmoskovicz commented May 2, 2016

jasontedor May 6, 2016

jasontedor commented May 6, 2016

gmoskovicz commented May 6, 2016

jasontedor May 6, 2016

jasontedor May 6, 2016

jasontedor commented May 6, 2016

gmoskovicz commented May 9, 2016

jasontedor commented May 10, 2016

gmoskovicz commented May 10, 2016

Add plugin information for Verbose mode #18051

Add plugin information for Verbose mode #18051

Conversation

gmoskovicz commented Apr 28, 2016

gmoskovicz commented Apr 28, 2016

jasontedor commented Apr 28, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gmoskovicz commented Apr 29, 2016

gmoskovicz commented Apr 29, 2016

gmoskovicz commented May 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasontedor May 2, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasontedor commented May 2, 2016

gmoskovicz commented May 2, 2016

Choose a reason for hiding this comment

jasontedor commented May 6, 2016

gmoskovicz commented May 6, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasontedor commented May 6, 2016

gmoskovicz commented May 9, 2016

jasontedor commented May 10, 2016

gmoskovicz commented May 10, 2016

jasontedor May 2, 2016 •

edited

Loading