Add a flag to control whether credentials are printed during bootstrapping #461
+428
−135
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.polaris.core.persistence.secrets; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.Mockito.doReturn; | ||
|
|
||
| import org.apache.polaris.core.entity.PolarisPrincipalSecrets; | ||
| import org.jetbrains.annotations.Nullable; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.Mockito; | ||
|
|
||
| class PrincipalSecretsGeneratorTest { | ||
|
|
||
| @Test | ||
| void testRandomSecrets() { | ||
| RandomPrincipalSecretsGenerator rpsg = new RandomPrincipalSecretsGenerator("realm"); | ||
| PolarisPrincipalSecrets s = rpsg.produceSecrets("name1", 123); | ||
| assertThat(s).isNotNull(); | ||
| assertThat(s.getPrincipalId()).isEqualTo(123); | ||
| assertThat(s.getPrincipalClientId()).isNotNull(); | ||
| assertThat(s.getMainSecret()).isNotNull(); | ||
| assertThat(s.getSecondarySecret()).isNotNull(); | ||
| } | ||
|
|
||
| @Test | ||
| void testRandomSecretsNullRealm() { | ||
| RandomPrincipalSecretsGenerator rpsg = new RandomPrincipalSecretsGenerator(null); | ||
| PolarisPrincipalSecrets s = rpsg.produceSecrets("name1", 123); | ||
| assertThat(s).isNotNull(); | ||
| assertThat(s.getPrincipalId()).isEqualTo(123); | ||
| assertThat(s.getPrincipalClientId()).isNotNull(); | ||
| assertThat(s.getMainSecret()).isNotNull(); | ||
| assertThat(s.getSecondarySecret()).isNotNull(); | ||
| } | ||
|
|
||
| @Test | ||
| void testEnvVariableSecrets() { | ||
| EnvVariablePrincipalSecretsGenerator psg = | ||
| Mockito.spy(new EnvVariablePrincipalSecretsGenerator("REALM")); | ||
|
|
||
| String clientIdKey = "POLARIS_BOOTSTRAP_REALM_PRINCIPAL_CLIENT_ID"; | ||
| String clientSecretKey = "POLARIS_BOOTSTRAP_REALM_PRINCIPAL_CLIENT_SECRET"; | ||
|
|
||
| doReturn("test-id").when(psg).getEnvironmentVariable(clientIdKey); | ||
| doReturn("test-secret").when(psg).getEnvironmentVariable(clientSecretKey); | ||
|
|
||
| // Invoke the method | ||
| PolarisPrincipalSecrets secrets = psg.produceSecrets("PRINCIPAL", 123); | ||
|
|
||
| // Verify the result | ||
| Assertions.assertNotNull(secrets); | ||
| Assertions.assertEquals(123, secrets.getPrincipalId()); | ||
| Assertions.assertEquals("test-id", secrets.getPrincipalClientId()); | ||
| Assertions.assertEquals("test-secret", secrets.getMainSecret()); | ||
| } | ||
|
|
||
| @Test | ||
| void testBoostrapGeneratorDelegationToRandomPrincipalSecrets() { | ||
| EnvVariablePrincipalSecretsGenerator mockedEnvVariablePrincipalSecretsGenerator = | ||
| Mockito.spy(new EnvVariablePrincipalSecretsGenerator("REALM")); | ||
|
|
||
| String clientIdKey = "POLARIS_BOOTSTRAP_REALM_PRINCIPAL_CLIENT_ID"; | ||
| String clientSecretKey = "POLARIS_BOOTSTRAP_REALM_PRINCIPAL_CLIENT_SECRET"; | ||
|
|
||
| doReturn("test-id") | ||
| .when(mockedEnvVariablePrincipalSecretsGenerator) | ||
| .getEnvironmentVariable(clientIdKey); | ||
| doReturn("test-secret") | ||
| .when(mockedEnvVariablePrincipalSecretsGenerator) | ||
| .getEnvironmentVariable(clientSecretKey); | ||
|
|
||
| class ExposingPrincipalSecretsGenerator extends BootstrapPrincipalSecretsGenerator { | ||
| public ExposingPrincipalSecretsGenerator(@Nullable String realmName) { | ||
| super(realmName); | ||
| } | ||
|
|
||
| @Override | ||
| protected PrincipalSecretsGenerator buildEnvVariablePrincipalSecretsGenerator( | ||
|
There was a problem hiding this comment. same here: I think we could have a simple factory that bind to There was a problem hiding this comment. In this case what I think we really want is DI 😔 |
||
| String realmName) { | ||
| return mockedEnvVariablePrincipalSecretsGenerator; | ||
| } | ||
|
|
||
| public PrincipalSecretsGenerator seeDelegate(String principalName) { | ||
| return this.getDelegate(principalName); | ||
| } | ||
| } | ||
|
|
||
| ExposingPrincipalSecretsGenerator fallback = new ExposingPrincipalSecretsGenerator(null); | ||
| Assertions.assertInstanceOf(RandomPrincipalSecretsGenerator.class, fallback.seeDelegate("p")); | ||
|
|
||
| ExposingPrincipalSecretsGenerator hasVars = new ExposingPrincipalSecretsGenerator("REALM"); | ||
| Assertions.assertInstanceOf( | ||
| EnvVariablePrincipalSecretsGenerator.class, hasVars.seeDelegate("PRINCIPAL")); | ||
| } | ||
| } | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be nicer to allow
EnvVariablePrincipalSecretsGeneratorto take an explicitMap(or aFunction<String, String>) as a constructor argument. The the "environment" part cab be just a static factory method likeEnvVariablePrincipalSecretsGenerator.fromEnv().Testing the static method would not really be necessary because it would be a one-line redirect to
System.env(), but it would allow for nicer design that is testable withoutMockito.Just my 2 cents :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this idea, but my concern is that
EnvVariablePrincipalSecretsGeneratoressentially becomesMapPrincipalSecretsGeneratorwith that approach. I would rather not place the burden on its callers to do thefromEnv/getEnv; this seems like the exact responsibility we would likeEnvVariablePrincipalSecretsGeneratorto take on.For example: if we later add command-line options to
bootstrapthat allow you to provide credentials, would we use theEnvVariablePrincipalSecretsGeneratorfor that? If it takes a map, we could.Taking this further, we could even pass in a map with random secrets to
EnvVariablePrincipalSecretsGenerator!And so its role, as well as that of
RandomPrincipalSecretsGenerator, can quickly become quite unclearThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough. I'm fine with the current code in this PR.