Add REST high level client gradle submodule and first simple method #22371

javanna · 2016-12-29T17:20:30Z

The RestHighLevelClient class takes as as an argument a low level client instance (RestClient). The first method added is ping, which returns true if the call to HEAD / went ok and false if an IOException was thrown. Any other exception gets bubbled up.

There are two kinds of tests, a unit test (RestHighLevelClientTests) that verifies the interaction between high level and low level client, and an integration test (MainActionIT) which relies on an externally started es cluster to send requests to.

This PR essentially holds the current content of the feature/high-level-rest-client public branch. We decided to add parsing code to java api responses directly upstream. Also we can add new methods to the high level rest client as we go without the need to maintain a separate branch. The important part is that we don't release/publish any artifact until we are ready to do so.

javanna · 2016-12-30T15:04:16Z

@elasticmachine retest this please

javanna · 2016-12-30T15:05:00Z

@nik9000 can you check out if the new gradle submodule works ok with eclipse please? I suspect it doesn't, in which case, do you know what we may have forgotten in the gradle conf?

nik9000 · 2016-12-30T20:30:11Z

In Eclipse this isn't importing the "main" classes, only the test classes. this fixes it, but it isn't super clear to me why we haven't hit this before. If we have, we work around it in some way I haven't yet seen.

rjernst · 2016-12-30T22:00:26Z

client/rest-high-level/build.gradle

This is meant to be for a standalone test, not adding a rest test to an existing project. It's possible your changes to standalone test make this work, but it seems a little wonky to me. This may be the reason for the eclipse behavior Nik described.

ok I don't know anything about these gradle changes, I just took what we had in the feature branch, I thought that you and Tanguy had already worked together on it. Could you let me know what else I should be doing instead please?

Not knowing much about gradle and the build setup really, but in my initial commit in the feature branch I only used the elasticsearch.build plugin and added the integTest task manually (ecf6af8) but this very likely wasn't the best approach either.

This is the only comment I haven't addressed yet, as I am not clear on what should be done.

I think the trouble is https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/groovy/org/elasticsearch/gradle/test/StandaloneTestBasePlugin.groovy#L46-L49

I think if we want to repurpose RestTestPlugin so it can be applied to projects with a main class we should do something like:

- project.pluginManager.apply(StandaloneTestBasePlugin) + if (false == project.pluginManager.hasPlugin('elasticsearch.build')) { + project.pluginManager.apply(StandaloneTestBasePlugin) + }

Or maybe just:

- project.pluginManager.apply(StandaloneTestBasePlugin) + if (false == project.pluginManager.hasPlugin('elasticsearch.build') && false == project.pluginManager.hasPlugin('elasticsearch.standalone-test')) { + throw new InvalidUserDataException('elasticsearch.rest-test requires either elasticsearch.build or elasticsearch.standalone-test') + }

@rjernst are you ok with what Nik is proposing?

If it sounds good I'm happy to make the change and add a commit to this PR.

I'm fine with what Nik proposes. It would mean the tests we have under qa right now need to add apply plugin: 'elasticsearch.standalone-test'.

Yeah, that is the plan. I'll have a look at it soon!

I pushed a commit that does the bottom option: now elasticsearch.rest-test requires either elasticsearch.build or elasticsearch.standalone-test.

cbuescher · 2017-01-02T14:09:50Z

client/test/src/main/java/org/elasticsearch/client/RestClientTestCase.java

Nit: can this helper method get some comment about what the arguments mean? They are named appropriately I think but some short explanation would make reuse easier.

cbuescher · 2017-01-02T14:15:58Z

client/test/src/main/java/org/elasticsearch/client/RestClientTestUtil.java

Do we want to be able to specify the number as the "generate" method was able before? If not the comment should be changed.

cbuescher · 2017-01-02T14:16:35Z

client/test/src/main/java/org/elasticsearch/client/RestClientTestUtil.java

Nit: arrayName is not used here any more, not sure if we need it, if not remove from comment.

cbuescher · 2017-01-02T14:18:13Z

client/rest/src/test/java/org/elasticsearch/client/RestClientSingleHostIntegTests.java

Also mentioned below, I don't know which purpose array name ("Header-array") served here before, just curious to see why its gone (unnecessary?).

cbuescher · 2017-01-02T14:24:14Z

client/rest-high-level/build.gradle

Not knowing much about gradle and the build setup really, but in my initial commit in the feature branch I only used the elasticsearch.build plugin and added the integTest task manually (ecf6af8) but this very likely wasn't the best approach either.

javanna · 2017-01-03T13:23:59Z

@cbuescher thanks for the review, your comments were all spot-on, I addressed them with the last commit

javanna · 2017-01-04T12:55:54Z

retest this please

nik9000 · 2017-01-05T02:16:39Z

@javanna I think I fixed it.

…tTestUtil and simplify headers assertions

The RestHighLevelClient class takes as as an argument a low level client instance RestClient. The first method added is ping, which returns true if the call to HEAD / went ok and false if an IOException was thrown. Any other exception gets bubbled up. There are two kinds of tests, a unit test (RestHighLevelClientTests) that verifies the interaction between high level and low level client, and an integration test (MainActionIT) which relies on an externally started es cluster to send requests to.

…tPlugin It used to be that RestTestPlugin "came with" StandaloneTestBasePlugin but we'd like to use it with BuildPlugin for the high level rest client.

standalone-rest-test doesn't configure unit tests and for these integ test only tests, that is what we want.

javanna · 2017-01-05T09:49:50Z

@nik9000 thanks a lot, all good now, going to push.

javanna · 2017-01-05T09:58:03Z

I am wondering if we should backport the gradle changes, not the the new submodule for now, to 5.x. That will make backporting the submodule easier when ready. Thoughts @nik9000 ?

nik9000 · 2017-01-05T12:36:38Z

I'm certainly OK with it.

…

On Thu, Jan 5, 2017, 4:58 AM Luca Cavanna ***@***.***> wrote: I am wondering if we should backport the gradle changes, not the the new submodule for now, to 5.x. That will make backporting the submodule easier when ready. Thoughts @nik9000 <https://github.com/nik9000> ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#22371 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANLoqXn7mAgM_XgfA-KN7tO1Zc2_EYDks5rPL6vgaJpZM4LXuRw> .

javanna added :Java High Level REST Client >enhancement v6.0.0-alpha1 labels Dec 29, 2016

javanna requested review from cbuescher and rjernst December 29, 2016 17:24

rjernst reviewed Dec 30, 2016

View reviewed changes

cbuescher reviewed Jan 2, 2017

View reviewed changes

javanna force-pushed the enhancement/rest_high_level_client branch from 29011a0 to 7500ab9 Compare January 3, 2017 13:22

javanna force-pushed the enhancement/rest_high_level_client branch from e1cf74e to 5f5084c Compare January 4, 2017 11:30

nik9000 force-pushed the enhancement/rest_high_level_client branch from 5f5084c to 126281e Compare January 5, 2017 02:15

javanna and others added 4 commits January 5, 2017 10:48

[TEST] move randomHeaders method from RestClientTestCase to RestClien…

59ae025

…tTestUtil and simplify headers assertions

Require either BuildPlugin or StandaloneTestBasePlugin to use RestTes…

73ebf10

…tPlugin It used to be that RestTestPlugin "came with" StandaloneTestBasePlugin but we'd like to use it with BuildPlugin for the high level rest client.

Switch from standalone-test to standalone-rest-test

326f6ca

standalone-rest-test doesn't configure unit tests and for these integ test only tests, that is what we want.

javanna force-pushed the enhancement/rest_high_level_client branch from 126281e to 326f6ca Compare January 5, 2017 09:54

javanna merged commit 232af51 into elastic:master Jan 5, 2017

javanna mentioned this pull request Jan 5, 2017

Backport gradle changes made in #22371 #22445

Merged

javanna mentioned this pull request Jun 6, 2017

Backport high level REST client #25086

Merged

Add REST high level client gradle submodule and first simple method #22371

Add REST high level client gradle submodule and first simple method #22371

Uh oh!

Conversation

javanna commented Dec 29, 2016

Uh oh!

javanna commented Dec 30, 2016

Uh oh!

javanna commented Dec 30, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nik9000 commented Dec 30, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nik9000 Jan 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

javanna commented Jan 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

javanna commented Jan 4, 2017

Uh oh!

nik9000 commented Jan 5, 2017

Uh oh!

javanna commented Jan 5, 2017

Uh oh!

javanna commented Jan 5, 2017

Uh oh!

nik9000 commented Jan 5, 2017 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

javanna commented Dec 30, 2016 •

edited

Loading

nik9000 Jan 3, 2017 •

edited

Loading

javanna commented Jan 3, 2017 •

edited

Loading