Rest HL client: Add put license action #32214

imotov · 2018-07-19T21:25:42Z

elasticmachine · 2018-07-19T21:25:44Z

Pinging @elastic/es-core-infra

nik9000

I like using a String rather than porting License.java. It is huge and has stuff that doesn't belong in a client and folks usually get the license as as string anyway.

nik9000 · 2018-07-20T15:49:56Z

...igh-level/src/test/java/org/elasticsearch/client/documentation/LicensingDocumentationIT.java

+        RestHighLevelClient client = highLevelClient();
+        String license = "{\"license\": {\"uid\":\"893361dc-9749-4997-93cb-802e3d7fa4a8\",\"type\":\"gold\"," +
+            "\"issue_date_in_millis\":1411948800000,\"expiry_date_in_millis\":1914278399999,\"max_nodes\":1,\"issued_to\":\"issued_to\"," +
+            "\"issuer\":\"issuer\",\"signature\":\"AAAAAgAAAA3U8+YmnvwC+CWsV/mRAAABmC9ZN0hjZDBGYnVyRXpCOW5Bb3FjZDAxOWpSbTVoMVZwUzRxVk1PSm" +


Is this generated by the test key?

Yes, it's is exactly the same license that is used in the put license REST test.

nik9000 · 2018-07-20T15:50:29Z

...igh-level/src/test/java/org/elasticsearch/client/documentation/LicensingDocumentationIT.java

+            //tag::put-license-execute
+            PutLicenseRequest request = new PutLicenseRequest();
+            request.setLicenseDefinition(license);  // <1>
+            request.setAcknowledge(false);           // <2>


Do you want to line these up?

nik9000 · 2018-07-20T15:50:41Z

docs/java-rest/high-level/licensing/put-license.asciidoc

+<1> Set the categories of information to retrieve. The the default is to
+return no information which is useful for checking if {xpack} is installed
+but not much else.
+<2> A  JSON document containing the license information.


Extra space.

nik9000 · 2018-07-20T15:52:06Z

docs/java-rest/high-level/licensing/put-license.asciidoc

+`acknowledged` flag and possible acknowledge messages. The acknowledge messages
+are present if you previously had a license with more features than one you
+are trying to update and you didn't set the `acknowledge` flag to `true`. In this case
+you need to display the messages to the end user and if they agree, resubmit the


I think it might be worth a note that the request will still return a 200 even if it fails because it requires an acknowledgement. So you can't just "fire and forget" the request like you can with most other things in the high level rest client.

nik9000 · 2018-07-20T15:52:56Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/common/ProtocolUtils.java

+     *
+     * The map of string arrays does't work with hashCode.
+     */
+    public static int hashCode(Map<String, String[]> a) {


It is! I was looking into replacing it with Map<String, List<String>> but it doesn't seem practical at the moment since it will cause breaking changes in 6.x. Not sure what else to do here. We can also switch to manual testing of serialization that doesn't require implementation of equals and hashCode, but I am not sure which one is greater evil.

I think what you've got is right for 6.x and master. I think maybe a master-only breaking change to List<String> is a good idea to be honest.

nik9000 · 2018-07-20T15:55:41Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/license/PutLicenseResponse.java

+                        currentFieldName = parser.currentName();
+                    } else {
+                        if (currentFieldName == null) {
+                            throw new XContentParseException(parser.getTokenLocation(), "expected message header or acknowledgement");


This is only used by acknowledgement, right?

Not headers?

Both, the serialization for this class is tricky since you get the message header and all acknowledgement mushed together on the same level.

nik9000 · 2018-07-20T15:57:17Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/license/PutLicenseResponse.java

+                                if (token != XContentParser.Token.VALUE_STRING) {
+                                    throw new XContentParseException(parser.getTokenLocation(), "unexpected acknowledgement text");
+                                }
+                                acknowledgeMessagesList.add(parser.text());


What if this contains an object? I think calling nextToken in that case will move into the object which isn't quite what you want. I think we want to handle that kind of evil stuff in these responses because it gives us the flexibility to make those changes eventually.

Not sure I follow. If it contains an object, it will fail 8 lines above this one.

seems like this should be sorted before merge, one way or the other. cc @nik9000

oh, nm, it seems like this was answered by @imotov

nik9000 · 2018-07-20T15:58:29Z

...protocol/src/test/java/org/elasticsearch/protocol/xpack/license/PutLicenseResponseTests.java

+    protected boolean supportsUnknownFields() {
+        // The structure of the response is such that unknown fields cannot be supported since they are treated as messages from
+        // new services
+        return false;


I think you can add unknown fields so long as you don't stick it in the acknowledge object, right? We have a path filter thingy for that. Does that apply here?

nik9000 · 2018-07-23T16:37:31Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/common/ProtocolUtils.java

+     *
+     * The map of string arrays does't work with hashCode.
+     */
+    public static int hashCode(Map<String, String[]> a) {


I think what you've got is right for 6.x and master. I think maybe a master-only breaking change to List<String> is a good idea to be honest.

hub-cap

Minor stuff, one question on the parsing logic and whether its needed in OSS, and just want to get a clarification on what @nik9000 mentioned.

hub-cap · 2018-07-20T15:11:45Z

client/rest-high-level/src/main/java/org/elasticsearch/client/LicenseClient.java

+    }
+
+    /**
+     * Asynchronously updates license for the cluster cluster.


cluster cluster :)

hub-cap · 2018-07-20T15:13:06Z

client/rest-high-level/src/main/java/org/elasticsearch/client/RequestConverters.java

@@ -1124,6 +1125,18 @@ static Request xpackUsage(XPackUsageRequest usageRequest) {
        return request;
    }

+    static Request putLicense(PutLicenseRequest putLicenseRequest) {
+        Request request = new Request(HttpPut.METHOD_NAME, "/_xpack/license");


Please use the EndpointBuilder here

hub-cap · 2018-07-20T15:17:41Z

client/rest-high-level/src/main/java/org/elasticsearch/client/RequestConverters.java

+        if (putLicenseRequest.isAcknowledge()) {
+            parameters.putParam("acknowledge", "true");
+        }
+        request.setJsonEntity(putLicenseRequest.getLicenseDefinition());


any reason u went with setJsonEntity vs the existing which sets a ByteArrayEntity?

Edit: Im falling down a rabbit hole now on blocking vs nonblocking entity use on our HLRC :)

double edit. setJsonEntity i think is fine here.

hub-cap · 2018-07-24T15:21:19Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/license/PutLicenseResponse.java

+                                if (token != XContentParser.Token.VALUE_STRING) {
+                                    throw new XContentParseException(parser.getTokenLocation(), "unexpected acknowledgement text");
+                                }
+                                acknowledgeMessagesList.add(parser.text());


seems like this should be sorted before merge, one way or the other. cc @nik9000

hub-cap · 2018-07-24T15:22:18Z

x-pack/protocol/src/main/java/org/elasticsearch/protocol/xpack/license/PutLicenseResponse.java

+import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
+import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg;
+
+public class PutLicenseResponse extends AcknowledgedResponse {


How much of this is actually needed in the OSS protocol lib? Do we need the parsing logic here?

hub-cap · 2018-07-24T15:34:10Z

Chatted w @imotov and approved instead of -1'ing

* master: Security: revert to old way of merging automata (#32254) Networking: Fix test leaking buffer (#32296) Undo a debugging change that snuck in during the field aliases merge. Painless: Update More Methods to New Naming Scheme (#32305) [TEST] Fix assumeFalse -> assumeTrue in SSLReloadIntegTests Ingest: Support integer and long hex values in convert (#32213) Introduce fips_mode setting and associated checks (#32326) Add V_6_3_3 version constant [DOCS] Removed extraneous callout number. Rest HL client: Add put license action (#32214) Add ERR to ranking evaluation documentation (#32314) Introduce Application Privileges with support for Kibana RBAC (#32309) Build: Shadow x-pack:protocol into x-pack:plugin:core (#32240) [Kerberos] Add Kerberos authentication support (#32263) [ML] Extract persistent task methods from MlMetadata (#32319) Add Restore Snapshot High Level REST API Register ERR metric with NamedXContentRegistry (#32320) fixes broken build for third-party-tests (#32315) Allow Integ Tests to run in a FIPS-140 JVM (#31989) [DOCS] Rollup Caps API incorrectly mentions GET Jobs API (#32280) awaitsfix testRandomClusterStateUpdates [TEST] add version skip to weighted_avg tests Consistent encoder names (#29492) Add WeightedAvg metric aggregation (#31037) Switch monitoring to new style Requests (#32255) Rename ranking evaluation `quality_level` to `metric_score` (#32168) Fix a test bug around nested aggregations and field aliases. (#32287) Add new permission for JDK11 to load JAAS libraries (#32132) Silence SSL reload test that fails on JDK 11 [test] package pre-install java check (#32259) specify subdirs of lib, bin, modules in package (#32253) Switch x-pack:core to new style Requests (#32252) awaitsfix SSLConfigurationReloaderTests Painless: Clean up add methods in PainlessLookup (#32258) Fail shard if IndexShard#storeStats runs into an IOException (#32241) AwaitsFix RecoveryIT#testHistoryUUIDIsGenerated Remove unnecessary warning supressions (#32250) CCE when re-throwing "shard not available" exception in TransportShardMultiGetAction (#32185) Add new fields to monitoring template for Beats state (#32085)

In the HL REST client we replace the License object with a string, because of complexity of this class. It is also not really needed on the client side since end-users are not interacting with the license besides passing it as a string to the server. Relates #29827

@throws

* 6.x: Fix scriptdocvalues tests with dates Correct minor typo in explain.asciidoc for HLRC Fix painless whitelist and warnings from backporting #31441 Build: Add elastic maven to repos used by BuildPlugin (#32549) Scripting: Conditionally use java time api in scripting (#31441) [ML] Improve error when no available field exists for rule scope (#32550) [ML] Improve error for functions with limited rule condition support (#32548) [ML] Remove multiple_bucket_spans [ML] Fix thread leak when waiting for job flush (#32196) (#32541) Painless: Clean Up PainlessField (#32525) Add @AwaitsFix for #32554 Remove broken @link in Javadoc Add AwaitsFix to failing test - see #32546 SQL: Added support for string manipulating functions with more than one parameter (#32356) [DOCS] Reloadable Secure Settings (#31713) Fix compilation error introduced by #32339 [Rollup] Remove builders from TermsGroupConfig (#32507) Use hostname instead of IP with SPNEGO test (#32514) Switch x-pack rolling restart to new style Requests (#32339) [DOCS] Small fixes in rule configuration page (#32516) Painless: Clean up PainlessMethod (#32476) SQL: Add test for handling of partial results (#32474) Docs: Add missing migration doc for logging change Build: Remove shadowing from benchmarks (#32475) Docs: Add all JDKs to CONTRIBUTING.md Logging: Make node name consistent in logger (#31588) High-level client: fix clusterAlias parsing in SearchHit (#32465) REST high-level client: parse back _ignored meta field (#32362) backport fix of reduceRandom fix (#32508) Add licensing enforcement for FIPS mode (#32437) INGEST: Clean up Java8 Stream Usage (#32059) (#32485) Improve the error message when an index is incompatible with field aliases. (#32482) Mute testFilterCacheStats Scripting: Fix painless compiler loader to know about context classes (#32385) [ML][DOCS] Fix typo applied_to => applies_to Mute SSLTrustRestrictionsTests on JDK 11 Changed ReindexRequest to use Writeable.Reader (#32401) Increase max chunk size to 256Mb for repo-azure (#32101) Mute KerberosAuthenticationIT fix no=>not typo (#32463) HLRC: Add delete watch action (#32337) Fix calculation of orientation of polygons (#27967) [Kerberos] Add missing javadocs (#32469) Fix missing JavaDoc for @throws in several places in KerberosTicketValidator. Make get all app privs requires "*" permission (#32460) Ensure KeyStoreWrapper decryption exceptions are handled (#32472) update rollover to leverage write-alias semantics (#32216) [Kerberos] Remove Kerberos bootstrap checks (#32451) Switch security to new style Requests (#32290) Switch security spi example to new style Requests (#32341) Painless: Add PainlessConstructor (#32447) Update Fuzzy Query docs to clarify default behavior re max_expansions (#30819) Remove > from Javadoc (fatal with Java 11) Tests: Fix convert error tests to use fixed value (#32415) IndicesClusterStateService should replace an init. replica with an init. primary with the same aId (#32374) auto-interval date histogram - 6.x backport (#32107) [CI] Mute DocumentSubsetReaderTests testSearch [TEST] Mute failing InternalEngineTests#testSeqNoAndCheckpoints TEST: testDocStats should always use forceMerge (#32450) TEST: Avoid deletion in FlushIT AwaitsFix IndexShardTests#testDocStats Painless: Add method type to method. (#32441) Remove reference to non-existent store type (#32418) [TEST] Mute failing FlushIT test Fix ordering of bootstrap checks in docs (#32417) Wrong discovery.type for azure in breaking changes (#32432) Mute ConvertProcessorTests failing tests TESTS: Move netty leak detection to paranoid level (#32354) (#32425) Upgrade to Lucene-7.5.0-snapshot-608f0277b0 (#32390) [Kerberos] Avoid vagrant update on precommit (#32416) TEST: Avoid triggering merges in FlushIT [DOCS] Fixes formatting of scope object in job resource Switch x-pack/plugin to new style Requests (#32327) Release requests in cors handle (#32410) Remove BouncyCastle dependency from runtime (#32402) Copy missing segment attributes in getSegmentInfo (#32396) Rest HL client: Add put license action (#32214) Docs: Correcting a typo in tophits (#32359) Build: Stop double generating buildSrc pom (#32408) Switch x-pack full restart to new style Requests (#32294) Painless: Clean Up PainlessClass Variables (#32380) [ML] Consistent pattern for strict/lenient parser names (#32399) Add Restore Snapshot High Level REST API Update update-settings.asciidoc (#31378) Introduce index store plugins (#32375) Rank-Eval: Reduce scope of an unchecked supression Make sure _forcemerge respects `max_num_segments`. (#32291)

javanna · 2018-08-27T15:27:01Z

...igh-level/src/test/java/org/elasticsearch/client/documentation/LicensingDocumentationIT.java

+
+            //tag::put-license-response
+            LicensesStatus status = response.status();                  // <1>
+            assertEquals(status, LicensesStatus.VALID);                 // <2>


I am not sure that we should have asserts as part of snippets that get published in our docs. We should do the least assertions in these docs tests actually, as their goal is to show users how to use the API. And we should have separate integ tests to properly test the api support. I see that we don't have any integ test for the licensing method, besides these docs tests. I think we should address that.

Rest HL client: Add put license action

da77fc5

Relates elastic#29827

imotov added review v7.0.0 v6.4.0 labels Jul 19, 2018

imotov requested a review from hub-cap July 20, 2018 14:09

nik9000 reviewed Jul 20, 2018

View reviewed changes

Address @nik9000 review comments

df3db54

nik9000 approved these changes Jul 23, 2018

View reviewed changes

elasticmachine mentioned this pull request Jul 24, 2018

Java high-level REST client completeness for xpack APIs #29827

Closed

98 tasks

hub-cap suggested changes Jul 24, 2018

View reviewed changes

hub-cap approved these changes Jul 24, 2018

View reviewed changes

imotov merged commit 29c802f into elastic:master Jul 24, 2018

imotov added the backport pending label Jul 24, 2018

imotov added v6.5.0 and removed v6.4.0 labels Jul 25, 2018

imotov removed the backport pending label Jul 26, 2018

javanna reviewed Aug 27, 2018

View reviewed changes

colings86 added the >enhancement label Oct 25, 2018

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

imotov deleted the issue-29827-add-license-hl-rest branch May 1, 2020 22:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rest HL client: Add put license action #32214

Rest HL client: Add put license action #32214

imotov commented Jul 19, 2018

elasticmachine commented Jul 19, 2018

nik9000 left a comment

nik9000 Jul 20, 2018

imotov Jul 23, 2018

nik9000 Jul 20, 2018

nik9000 Jul 20, 2018

nik9000 Jul 20, 2018

nik9000 Jul 20, 2018

imotov Jul 23, 2018

nik9000 Jul 23, 2018

nik9000 Jul 20, 2018

nik9000 Jul 20, 2018

imotov Jul 23, 2018

nik9000 Jul 20, 2018

imotov Jul 23, 2018

hub-cap Jul 24, 2018

hub-cap Jul 24, 2018

nik9000 Jul 20, 2018

nik9000 Jul 23, 2018

hub-cap left a comment

hub-cap Jul 20, 2018

hub-cap Jul 20, 2018

hub-cap Jul 20, 2018

hub-cap Jul 24, 2018

hub-cap Jul 24, 2018

hub-cap Jul 24, 2018

hub-cap commented Jul 24, 2018

javanna Aug 27, 2018

Rest HL client: Add put license action #32214

Rest HL client: Add put license action #32214

Conversation

imotov commented Jul 19, 2018

elasticmachine commented Jul 19, 2018

nik9000 left a 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

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

Choose a reason for hiding this comment

hub-cap left a 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

hub-cap commented Jul 24, 2018

Choose a reason for hiding this comment