Ojdbc provider hashicorp (#142)

* Dedicated Vault centralized config

* Fix compilation failure for dedicated Vault

* restructure HashiCorp package to support dedicated and other types of vault

* restructure HashiCorp package to support dedicated and other types of vault

* Enhance Vault Secrets Manager Implementation with KEY Feature

* Refactor DedicatedVault Implementation

* Add unit test

* Rename hashicorpvault to hcpdedicatedvault

* HCP vault secrets centralized config

* Add unit tests for HCP Vault Configuration Provider

* Add javadocs and copyright for dedicated vault

* Add javadocs and copyright for dedicated vault

* Cleanup and Update authentication parsing to use switch-case logic

* Optimize HCP Vault integration and enhance Javadocs for HCP Vault Secret

* Fix Javadoc formatting in HcpVaultSecretsManagerFactory

* Add error handling for missing secrets in configuration

* Add example-test.properties file

* Add Readme.md file

* Update Readme

* Add support for optional 'key' parameter in VaultDedicated and VaultSecrets to extract specific fields from JSON secrets.

* Update targeted version in Readme.md

* Enhance unit tests

* Add samples for centralized configuration

* rename HCP Vault providers and switch secret-name usage in hcpvaultsecret instead of application name

* Implement caching mechanism for HCP Vault Secrets bearer token

* Add userpass authentication method for hcp vault dedicated && update Readme and javadocs

* Add new unit Tests for userpass authentication method && update the example-test.properties file

* Added AppRole authentication, updated token caching to use the driver cache, and enhanced README with documentation. Included example properties and unit tests for validation.

* Fix readme file and rename some classes

* Add GitHub authentication to hcpvaultdedicated, refactor utils, update hcpvault secrets parameters, and fix README

* Fix Javadoc formatting

* Add Credentials File Authentication for HCP Vault Secret & Improve Field Extraction Logic in HCP Vault Dedicated

* Add AUTO-DETECT authentication method for both hcp vault secret and hcp vault dedicated a long with unit tests

* make 'admin' as VAULT_NAMESPACE parameter default value

* Update unit tests for both hcp vault dedicated and vault secrets && fix a typo in auto_detect auth method

* Integrate Hashicorp into GitHub Actions pipeline

* debugging

* debugging

* debugging

* debugging

* integrate HashiCorp and clean up secrets handling in Github Action Pipeline

* Improve the error messages and do some refactoring for both hcp vault dedicated and hcp vault secrets providers

* set the HCP_ORG_ID, HCP_PROJECT_ID and HCP_APP_NAME as environment variables in github actions pipeline

* remove the extra character '\n'

* fix tests

* Update Readme.md && update copyrights && update javadocs

* Fix Javadoc issue

* Address Review Comment

* Fix javadocs

* cleanup

* Update GitHub Actions workflow to use actions/cache@v4

* Refactor parameter constants and enhance attribute methods and improve caching

* cleanup

* Update the auto-detect auth method && passe default values at parsing stage

* cleanup

* Address review comments

* Address review comment

Author: MouhsinElmajdouby

Diff for: .github/workflows/run-tests.yaml

@@ -13,6 +13,10 @@ jobs:
       AWS_REGION: ${{ secrets.TEST_AWS_REGION }}
       AWS_ACCESS_KEY_ID: ${{ secrets.TEST_AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.TEST_AWS_SECRET_ACCESS_KEY }}
+      VAULT_ADDR: ${{ secrets.TEST_VAULT_ADDR }}
+      HCP_ORG_ID: ${{ secrets.TEST_HCP_ORG_ID }}
+      HCP_PROJECT_ID: ${{ secrets.TEST_HCP_PROJECT_ID }}
+      HCP_APP_NAME: ${{ secrets.TEST_HCP_APP_NAME }}
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v4
@@ -127,6 +131,27 @@ jobs:
           AWS_SECRETS_MANAGER_URL=${{ secrets.TEST_AWS_SECRETS_MANAGER_URL }}\n
           " >> ojdbc-provider-aws/test.properties
           
+          
+          # Generate ojdbc-provider-hashicorp/test.properties
+          echo -e "VAULT_ADDR=${{ secrets.TEST_VAULT_ADDR }}\n
+          DEDICATED_VAULT_SECRET_PATH=${{ secrets.TEST_DEDICATED_VAULT_SECRET_PATH }}\n
+          DEDICATED_VAULT_SECRET_PATH_WITH_MULTIPLE_KEYS=${{ secrets.TEST_DEDICATED_VAULT_SECRET_PATH_WITH_MULTIPLE_KEYS }}\n
+          VAULT_USERNAME=${{ secrets.TEST_VAULT_USERNAME }}\n
+          VAULT_PASSWORD=${{ secrets.TEST_VAULT_PASSWORD }}\n
+          VAULT_NAMESPACE=${{ secrets.TEST_VAULT_NAMESPACE }}\n
+          ROLE_ID=${{ secrets.TEST_ROLE_ID }}\n
+          SECRET_ID=${{ secrets.TEST_SECRET_ID }}\n
+          GITHUB_TOKEN=${{ secrets.TEST_GITHUB_TOKEN }}\n
+          KEY=${{ secrets.TEST_KEY }}\n
+          HCP_ORG_ID=${{ secrets.TEST_HCP_ORG_ID }}\n
+          HCP_PROJECT_ID=${{ secrets.TEST_HCP_PROJECT_ID }}\n
+          HCP_APP_NAME=${{ secrets.TEST_HCP_APP_NAME }}\n
+          HCP_CLIENT_ID=${{ secrets.TEST_HCP_CLIENT_ID }}\n
+          HCP_CLIENT_SECRET=${{ secrets.TEST_HCP_CLIENT_SECRET }}\n
+          SECRET_NAME=${{ secrets.TEST_SECRET_NAME }}\n
+          SECRET_NAME_WITH_MULTIPLE_KEYS=${{ secrets.TEST_SECRET_NAME_WITH_MULTIPLE_KEYS }}\n
+          " >> ojdbc-provider-hashicorp/test.properties
+
       - name: Run tests with Maven
         run: mvn -B test --file pom.xml
 
@@ -143,3 +168,4 @@ jobs:
           rm ojdbc-provider-jackson-oson/test.properties
           
           rm ojdbc-provider-aws/test.properties
+          rm ojdbc-provider-hashicorp/test.properties

Diff for: README.md

@@ -13,6 +13,8 @@ Each module of this project contains a set of providers.
 <dd>Providers for integration with Oracle Cloud Infrastructure (OCI).</dd>
 <dt><a href="ojdbc-provider-azure/README.md">Oracle JDBC Azure Providers</a></dt>
 <dd>Providers for integration with Microsoft Azure</dd>
+<dt><a href="ojdbc-provider-hashicorp/README.md">Oracle JDBC HashiCorp Providers</a></dt>
+<dd>Providers for integration with Hashicorp</dd>
 </dl>
 <u>The next one contains a provider for Open Telemetry:</u>
 <dl>

Diff for: ojdbc-provider-common/src/main/java/oracle/jdbc/provider/parameter/ParameterSet.java

@@ -40,6 +40,10 @@
 
 import oracle.jdbc.provider.factory.ResourceFactory;
 
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
 import static java.lang.String.format;
 import static java.util.Collections.emptyMap;
 
@@ -137,11 +141,10 @@ default <T> T getRequired(Parameter<T> parameter)
 
     if (value != null)
       return value;
-
     String name = getName(parameter);
     throw new IllegalStateException(format(
-      "No value defined for parameter \"%s\"",
-      name != null ? name : parameter.toString()));
+            "No value defined for parameter \"%s\"",
+            name != null ? name : parameter.toString()));
   }
 
   /**
@@ -159,4 +162,17 @@ default <T> T getRequired(Parameter<T> parameter)
    */
   ParameterSetBuilder copyBuilder();
 
+  /**
+   * Filters the parameters from the {@link ParameterSet} based on the provided
+   * relevant keys.
+   *
+   * This method extracts only the parameters whose names are included
+   * in the specified array.
+   *
+   * @param relevantKeys An array of parameter names to include in the filtered
+   * result.
+   * @return A map containing only the filtered parameters.
+   */
+   Map<String, Object> filterParameters(String[] relevantKeys);
+
 }

Diff for: ojdbc-provider-common/src/main/java/oracle/jdbc/provider/parameter/ParameterSetImpl.java

@@ -38,9 +38,7 @@
 
 package  oracle.jdbc.provider.parameter;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
+import java.util.*;
 import java.util.stream.Collectors;
 
 final class ParameterSetImpl implements ParameterSet {
@@ -102,7 +100,7 @@ public ParameterSetBuilder copyBuilder() {
     ParameterSetBuilder builder = ParameterSet.builder();
 
     for (Map.Entry<Parameter<?>, Object> parameterValue
-      : parameterValues.entrySet()) {
+            : parameterValues.entrySet()) {
       @SuppressWarnings("unchecked")
       Parameter<Object> parameter = (Parameter<Object>) parameterValue.getKey();
       Object value = parameterValue.getValue();
@@ -124,6 +122,28 @@ public boolean equals(Object other) {
       && ((ParameterSetImpl)other).parameterValues.equals(parameterValues);
   }
 
+  /**
+   * Retrieves the relevant parameter key-value pairs.
+   */
+  private Map<String, Object> getParameterKeyValuePairs() {
+    return parameterNames.entrySet().stream()
+            .filter(entry -> parameterValues.get(entry.getKey()) != null)
+            .collect(Collectors.toMap(
+                    Map.Entry::getValue,
+                    entry -> parameterValues.get(entry.getKey())
+            ));
+  }
+
+  @Override
+  public Map<String, Object> filterParameters(String[] relevantKeys) {
+    Map<String, Object> allParameters = getParameterKeyValuePairs();
+    List<String> relevantKeysList = Arrays.asList(relevantKeys);
+
+    return allParameters.entrySet().stream()
+            .filter(entry -> relevantKeysList.contains(entry.getKey()))
+            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+  }
+
   /**
    * Returns a key=value style text representation of this set, with parameter
    * names as keys, and the result of calling {@code toString()} on parameter

Diff for: ojdbc-provider-common/src/main/java/oracle/jdbc/provider/parameter/ParameterSetParserImpl.java

@@ -113,11 +113,11 @@ public Builder addParameter(String name, Parameter<String> parameter) {
 
     @Override
     public Builder addParameter(
-      String name, Parameter<String> parameter, String defaultValue) {
+            String name, Parameter<String> parameter, String defaultValue) {
       addParameterParser(
-          name,
-          (builder) -> builder.add(name, parameter, defaultValue),
-          (value, builder) -> builder.add(name, parameter, value));
+              name,
+              (builder) -> builder.add(name, parameter, defaultValue),
+              (value, builder) -> builder.add(name, parameter, value));
       return this;
     }