-
Notifications
You must be signed in to change notification settings - Fork 566
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduces OciSecretsMpMetaConfigProvider, which adapts OciSecretsCon…
…figSourceProvider to the MpMetaConfigProvider contract. Signed-off-by: Laird Nelson <[email protected]>
- Loading branch information
Showing
9 changed files
with
390 additions
and
1 deletion.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| Copyright (c) 2023 Oracle and/or its affiliates. | ||
| Licensed 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. | ||
| --> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>io.helidon.integrations.oci</groupId> | ||
| <artifactId>helidon-integrations-oci-project</artifactId> | ||
| <version>4.0.0-SNAPSHOT</version> | ||
| </parent> | ||
| <artifactId>helidon-integrations-oci-secrets-mp-config-source</artifactId> | ||
| <name>Helidon Integrations OCI Secrets MP Config Source</name> | ||
|
|
||
| <description> | ||
| OCI Secrets Retrieval API MPMetaConfigProvider Implementation | ||
| </description> | ||
|
|
||
| <properties> | ||
| <compartment-ocid/> | ||
| <java.util.logging.config.file>src/test/java/logging.properties</java.util.logging.config.file> | ||
| <lazy>false</lazy> | ||
| <vault-ocid/> | ||
| </properties> | ||
|
|
||
| <dependencies> | ||
|
|
||
| <!-- Compile-scoped dependencies. --> | ||
|
|
||
| <dependency> | ||
| <groupId>io.helidon.config</groupId> | ||
| <artifactId>helidon-config</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.helidon.config</groupId> | ||
| <artifactId>helidon-config-mp</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.helidon.integrations.oci</groupId> | ||
| <artifactId>helidon-integrations-oci-secrets-config-source</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.eclipse.microprofile.config</groupId> | ||
| <artifactId>microprofile-config-api</artifactId> | ||
| </dependency> | ||
|
|
||
| <!-- Test-scoped dependencies. --> | ||
|
|
||
| <dependency> | ||
| <groupId>org.hamcrest</groupId> | ||
| <artifactId>hamcrest-core</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
| <artifactId>junit-jupiter-api</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.slf4j</groupId> | ||
| <artifactId>slf4j-jdk14</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
|
|
||
| </dependencies> | ||
|
|
||
| <build> | ||
| <testResources> | ||
| <testResource> | ||
| <directory>src/test/resources</directory> | ||
| <filtering>true</filtering> | ||
| <includes> | ||
| <include>mp-meta-config.yaml</include> | ||
| </includes> | ||
| </testResource> | ||
| </testResources> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-surefire-plugin</artifactId> | ||
| <configuration> | ||
| <systemPropertyVariables> | ||
| <compartment-ocid>${compartment-ocid}</compartment-ocid> | ||
| <java.util.logging.config.file>${java.util.logging.config.file}</java.util.logging.config.file> | ||
| <lazy>${lazy}</lazy> | ||
| <vault-ocid>${vault-ocid}</vault-ocid> | ||
| </systemPropertyVariables> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> |
89 changes: 89 additions & 0 deletions
89
...a/io/helidon/integrations/oci/secrets/mp/configsource/OciSecretsMpMetaConfigProvider.java
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,89 @@ | ||
| /* | ||
| * Copyright (c) 2023 Oracle and/or its affiliates. | ||
| * | ||
| * Licensed 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 io.helidon.integrations.oci.secrets.mp.configsource; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
| import io.helidon.config.Config; | ||
| import io.helidon.config.mp.MpConfigSources; | ||
| import io.helidon.config.mp.spi.MpMetaConfigProvider; | ||
| import io.helidon.integrations.oci.secrets.configsource.OciSecretsConfigSourceProvider; | ||
|
|
||
| import org.eclipse.microprofile.config.spi.ConfigSource; | ||
|
|
||
| /** | ||
| * An {@link MpMetaConfigProvider} that uses the Oracle Cloud Infrastructure (OCI) <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/secrets/package-summary.html">Secrets | ||
| * Retrieval</a> and <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/vault/package-summary.html">Vault</a> APIs | ||
| * to provide a {@link ConfigSource} implementation. | ||
| * | ||
| * <p>This class adapts the Helidon {@link io.helidon.config.spi.ConfigSource} created by the {@link | ||
| * OciSecretsConfigSourceProvider} to the MicroProfile Config contracts. | ||
| * | ||
| * @see #create(String, Config, String) | ||
| * | ||
| * @see OciSecretsConfigSourceProvider | ||
| */ | ||
| public final class OciSecretsMpMetaConfigProvider implements MpMetaConfigProvider { | ||
|
|
||
| private final OciSecretsConfigSourceProvider p; | ||
|
|
||
| /** | ||
| * Creates a new {@link OciSecretsMpMetaConfigProvider}. | ||
| * | ||
| * @deprecated For use by the Helidon Config subsystem only. | ||
| */ | ||
| @Deprecated // For java.util.ServiceLoader use only. | ||
| @SuppressWarnings("deprecation") | ||
| public OciSecretsMpMetaConfigProvider() { | ||
| super(); | ||
| this.p = new OciSecretsConfigSourceProvider(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns an immutable {@link List} whose sole element is a {@link ConfigSource} implementation backed by the Oracle Cloud Infrastructure (OCI) <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/secrets/package-summary.html">Secrets | ||
| * Retrieval</a> and <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/vault/package-summary.html">Vault</a> APIs. | ||
| * | ||
| * @param type ignored | ||
| * | ||
| * @param metaConfig a Helidon {@link Config} representing meta-configuration | ||
| * | ||
| * @param profile a configuration profile; not currently used | ||
| * | ||
| * @return a single-element immutable {@link List} | ||
| */ | ||
| @Override | ||
| @SuppressWarnings("deprecation") | ||
| public List<? extends ConfigSource> create(String type, Config metaConfig, String profile) { | ||
| return List.of(MpConfigSources.create(this.p.create(type, metaConfig))); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the return value of an invocation of {@link OciSecretsConfigSourceProvider#supported()}. | ||
| * | ||
| * @return an immutable {@link Set} | ||
| */ | ||
| @Override | ||
| @SuppressWarnings("deprecation") | ||
| public Set<String> supportedTypes() { | ||
| return this.p.supported(); | ||
| } | ||
|
|
||
| } |
26 changes: 26 additions & 0 deletions
26
...ource/src/main/java/io/helidon/integrations/oci/secrets/mp/configsource/package-info.java
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,26 @@ | ||
| /* | ||
| * Copyright (c) 2023 Oracle and/or its affiliates. | ||
| * | ||
| * Licensed 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. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides classes and interfaces for using the Oracle Cloud Infrastructure (OCI) <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/secrets/package-summary.html">Secrets | ||
| * Retrieval</a> and <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/vault/package-summary.html">Vault</a> APIs | ||
| * as part of a {@linkplain io.helidon.config.mp.spi.MpMetaConfigProvider} implementation. | ||
| * | ||
| * @see io.helidon.integrations.oci.secrets.mp.configsource.OciSecretsMpMetaConfigProvider | ||
| */ | ||
| package io.helidon.integrations.oci.secrets.mp.configsource; |
38 changes: 38 additions & 0 deletions
38
integrations/oci/oci-secrets-mp-config-source/src/main/java/module-info.java
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,38 @@ | ||
| /* | ||
| * Copyright (c) 2023 Oracle and/or its affiliates. | ||
| * | ||
| * Licensed 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. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides packages containing classes and interfaces for Oracle Cloud Infrastructure (OCI) <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/secrets/package-summary.html">Secrets | ||
| * Retrieval</a> and <a | ||
| * href="https://docs.oracle.com/en-us/iaas/tools/java/latest/com/oracle/bmc/vault/package-summary.html">Vault</a> | ||
| * API-using {@linkplain org.eclipse.microprofile.config.spi.ConfigSource configuration sources}. | ||
| * | ||
| * @see io.helidon.integrations.oci.secrets.mp.configsource.OciSecretsMpConfigProvider | ||
| */ | ||
| @SuppressWarnings({ "requires-automatic", "requires-transitive-automatic" }) | ||
| module io.helidon.integrations.oci.secrets.mp.configsource { | ||
|
|
||
| exports io.helidon.integrations.oci.secrets.mp.configsource; | ||
|
|
||
| requires transitive io.helidon.config; | ||
| requires transitive io.helidon.config.mp; | ||
| requires io.helidon.integrations.oci.secrets.configsource; | ||
| requires microprofile.config.api; | ||
|
|
||
| provides io.helidon.config.mp.spi.MpMetaConfigProvider with io.helidon.integrations.oci.secrets.mp.configsource.OciSecretsMpMetaConfigProvider; | ||
|
|
||
| } |
79 changes: 79 additions & 0 deletions
79
...g-source/src/test/java/io/helidon/integrations/oci/secrets/mp/configsource/UsageTest.java
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,79 @@ | ||
| /* | ||
| * Copyright (c) 2023 Oracle and/or its affiliates. | ||
| * | ||
| * Licensed 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 io.helidon.integrations.oci.secrets.mp.configsource; | ||
|
|
||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
|
|
||
| import org.eclipse.microprofile.config.Config; | ||
| import org.eclipse.microprofile.config.ConfigProvider; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.hamcrest.CoreMatchers.is; | ||
| import static org.hamcrest.CoreMatchers.not; | ||
| import static org.hamcrest.CoreMatchers.nullValue; | ||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.junit.jupiter.api.Assumptions.assumeFalse; | ||
| import static org.junit.jupiter.api.Assumptions.assumeTrue; | ||
|
|
||
| class UsageTest { | ||
|
|
||
| @Test | ||
| void testUsage() { | ||
| // Get a Config object. Because src/test/resources/mp-meta-config.yaml exists, and because it will be processed | ||
| // according to the Helidon rules, an | ||
| // io.helidon.integrations.oci.secrets.mp.configsource.OciSecretsMpMetaConfigProvider will be created and any | ||
| // ConfigSources it creates will become part of the assembled Config object. | ||
| Config c = ConfigProvider.getConfig(); | ||
|
|
||
| // Make sure non-existent properties don't cause the Vault to get involved. | ||
| assertThat(c.getOptionalValue("bogus", String.class).orElse(null), nullValue()); | ||
|
|
||
| // Make sure properties that have nothing to do with the OCI Secrets Retrieval or Vault APIs are handled by some | ||
| // other (default) ConfigSource, e.g., System properties, etc. (The OCI Secrets Retrieval API should never be | ||
| // consulted for java.home, in other words.) | ||
| assertThat(c.getValue("java.home", String.class), is(System.getProperty("java.home"))); | ||
|
|
||
| // Do the rest of this test only if the following assumptions hold. To avoid skipping the rest of this test: | ||
| // | ||
| // 1. Set up a ${HOME}/.oci/config file following | ||
| // https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm or similar | ||
| // | ||
| // 2. Run Maven with all of the following properties: | ||
| // | ||
| // -Dcompartment-ocid=ocid1.compartment.oci1.iad.123xyz (a valid OCI Compartment OCID) | ||
| // -Dvault-ocid=ocid1.vault.oci1.iad.123xyz (a valid OCI Vault OCID) | ||
| // -DFrancqueSecret.expectedValue='Some Value' (some value for a secret named FrancqueSecret in that vault) | ||
| // | ||
| assumeTrue(Files.exists(Paths.get(System.getProperty("user.home"), ".oci", "config"))); // condition 1 | ||
| assumeFalse(System.getProperty("compartment-ocid", "").isBlank()); // condition 2 | ||
| assumeFalse(System.getProperty("vault-ocid", "").isBlank()); // condition 2 | ||
| String expectedValue = System.getProperty("FrancqueSecret.expectedValue", ""); | ||
| assumeFalse(expectedValue.isBlank()); // condition 2 | ||
|
|
||
| // | ||
| // (Code below this line executes only if the above JUnit assumptions passed. Otherwise control flow stops above.) | ||
| // | ||
|
|
||
| // For this test to pass, all of the following must hold: | ||
| // | ||
| // 1. The vault designated by the vault OCID must hold a secret named FrancqueSecret | ||
| // | ||
| // 2. The secret named FrancqueSecret must have a value equal to the expected value | ||
| assertThat(c.getValue("FrancqueSecret", String.class), is(expectedValue)); | ||
| } | ||
|
|
||
| } |
19 changes: 19 additions & 0 deletions
19
integrations/oci/oci-secrets-mp-config-source/src/test/java/logging.properties
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,19 @@ | ||
| # | ||
| # Copyright (c) 2023 Oracle and/or its affiliates. | ||
| # | ||
| # Licensed 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. | ||
| # | ||
| com.oracle.bmc.level = SEVERE | ||
| handlers = java.util.logging.ConsoleHandler | ||
| io.helidon.integrations.oci.secrets.mp.configsource.level = INFO | ||
| java.util.logging.ConsoleHandler.level = FINER |
Oops, something went wrong.