Remove deprecated convenient methods from GetApiKeyRequest #89360
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A builder class for GetApiKeyRequest is added as part of elastic#89273. As a result, the existing convenient methods got deprecated in favour of the builder. This PR removes the deprecated methods and replaces all usages with the builder.
ywangd
added
>refactoring
:Security/Security
|
Pinging @elastic/es-security (Team:Security) |
ywangd
commented
Aug 16, 2022
Comment on lines
144
to
178
| { | ||
| final GetApiKeyRequest getApiKeyRequest2 = GetApiKeyRequest.builder() | ||
| .apiKeyName(apiKeyId) | ||
| .ownedByAuthenticatedUser(true) | ||
| .withLimitedBy(true) | ||
| .build(); | ||
| ByteArrayOutputStream outBuffer = new ByteArrayOutputStream(); | ||
| OutputStreamStreamOutput out = new OutputStreamStreamOutput(outBuffer); | ||
| out.setVersion(randomVersionBetween(random(), Version.V_7_4_0, Version.V_8_4_0)); | ||
| getApiKeyRequest2.writeTo(out); | ||
|
|
||
| InputStreamStreamInput inputStreamStreamInput = new InputStreamStreamInput(new ByteArrayInputStream(outBuffer.toByteArray())); | ||
| inputStreamStreamInput.setVersion(randomVersionBetween(random(), Version.V_7_4_0, Version.V_8_4_0)); | ||
| GetApiKeyRequest requestFromInputStream = new GetApiKeyRequest(inputStreamStreamInput); | ||
|
|
||
| assertThat(requestFromInputStream.getApiKeyId(), equalTo(getApiKeyRequest2.getApiKeyId())); | ||
| assertThat(requestFromInputStream.ownedByAuthenticatedUser(), is(true)); | ||
| // old version so the default for `withLimitedBy` is false | ||
| assertThat(requestFromInputStream.withLimitedBy(), is(false)); | ||
| } | ||
| { | ||
| final GetApiKeyRequest getApiKeyRequest3 = GetApiKeyRequest.builder() | ||
| .apiKeyName(apiKeyId) | ||
| .withLimitedBy(randomBoolean()) | ||
| .build(); | ||
| ByteArrayOutputStream outBuffer = new ByteArrayOutputStream(); | ||
| OutputStreamStreamOutput out = new OutputStreamStreamOutput(outBuffer); | ||
| out.setVersion(randomVersionBetween(random(), Version.V_7_4_0, Version.CURRENT)); | ||
| getApiKeyRequest.writeTo(out); | ||
| out.setVersion(randomVersionBetween(random(), Version.V_8_5_0, Version.CURRENT)); | ||
| getApiKeyRequest3.writeTo(out); | ||
|
|
||
| InputStreamStreamInput inputStreamStreamInput = new InputStreamStreamInput(new ByteArrayInputStream(outBuffer.toByteArray())); | ||
| inputStreamStreamInput.setVersion(randomVersionBetween(random(), Version.V_7_4_0, Version.CURRENT)); | ||
| inputStreamStreamInput.setVersion(randomVersionBetween(random(), Version.V_8_5_0, Version.CURRENT)); | ||
| GetApiKeyRequest requestFromInputStream = new GetApiKeyRequest(inputStreamStreamInput); | ||
|
|
||
| assertThat(requestFromInputStream, equalTo(getApiKeyRequest)); | ||
| assertThat(requestFromInputStream, equalTo(getApiKeyRequest3)); |
There was a problem hiding this comment.
This change is actually a bug fix for test. It can fail because the new with_limited_by field is not available in version before v8.5.0.
n1v0lg
approved these changes
Aug 16, 2022
There was a problem hiding this comment.
LGTM, pending one typo fix (apiKeyName() -> apiKeyId() -- see my inline comment). Didn't want to block since it's only a very small change and everything else looks good.
| { | ||
| final GetApiKeyRequest getApiKeyRequest1 = GetApiKeyRequest.builder() |
There was a problem hiding this comment.
Nit: since this is in its own scope, getApiKeyRequest (without the numerical suffix) still works here, and further down.
| assertThat(requestFromInputStream.getApiKeyId(), equalTo(getApiKeyRequest2.getApiKeyId())); | ||
| assertThat(requestFromInputStream.ownedByAuthenticatedUser(), is(true)); | ||
| // old version so the default for `withLimitedBy` is false | ||
| assertThat(requestFromInputStream.withLimitedBy(), is(false)); |
...src/test/java/org/elasticsearch/xpack/core/security/action/apikey/GetApiKeyRequestTests.java
Outdated
Show resolved
Hide resolved
...src/test/java/org/elasticsearch/xpack/core/security/action/apikey/GetApiKeyRequestTests.java
Outdated
Show resolved
Hide resolved
…security/action/apikey/GetApiKeyRequestTests.java Co-authored-by: Nikolaj Volgushev <[email protected]>
…security/action/apikey/GetApiKeyRequestTests.java Co-authored-by: Nikolaj Volgushev <[email protected]>
ywangd
added
the
auto-merge-without-approval
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A builder class for GetApiKeyRequest is added as part of #89273. As a
result, the existing convenient methods got deprecated in favour of the
builder. This PR removes the deprecated methods and replaces all usages
with the builder.