This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push: new 6b1e9c66ac1 CAMEL-21805 - Camel-IBM-Secrets-manager: Add ListSecrets operation (#17283) 6b1e9c66ac1 is described below commit 6b1e9c66ac1b27d5e9b16c80caecec2ddcc0cde5 Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Wed Feb 26 18:37:03 2025 +0100 CAMEL-21805 - Camel-IBM-Secrets-manager: Add ListSecrets operation (#17283) Signed-off-by: Andrea Cosentino <anco...@gmail.com> --- .../catalog/components/ibm-secrets-manager.json | 2 +- .../ibm/secrets/manager/ibm-secrets-manager.json | 2 +- .../manager/IBMSecretsManagerOperation.java | 3 +- .../secrets/manager/IBMSecretsManagerProducer.java | 8 ++ .../operations/IBMSecretsManagerListSecretsIT.java | 106 +++++++++++++++++++++ 5 files changed, 118 insertions(+), 3 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-secrets-manager.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-secrets-manager.json index 22d88cdb6d6..5fcebaa9967 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-secrets-manager.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/ibm-secrets-manager.json @@ -35,7 +35,7 @@ }, "properties": { "label": { "index": 0, "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "Logical name" }, - "operation": { "index": 1, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerOperation", "enum": [ "createArbitrarySecret", "createKVSecret", "getSecret", "deleteSecret" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", [...] + "operation": { "index": 1, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerOperation", "enum": [ "createArbitrarySecret", "createKVSecret", "getSecret", "deleteSecret", "listSecrets" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManager [...] "serviceUrl": { "index": 2, "kind": "parameter", "displayName": "Service Url", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "Service URL for IBM Secrets Manager" }, "lazyStartProducer": { "index": 3, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a produc [...] "token": { "index": 4, "kind": "parameter", "displayName": "Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "IBM Cloud API Token for IBM Secrets Manager" } diff --git a/components/camel-ibm-secrets-manager/src/generated/resources/META-INF/org/apache/camel/component/ibm/secrets/manager/ibm-secrets-manager.json b/components/camel-ibm-secrets-manager/src/generated/resources/META-INF/org/apache/camel/component/ibm/secrets/manager/ibm-secrets-manager.json index 22d88cdb6d6..5fcebaa9967 100644 --- a/components/camel-ibm-secrets-manager/src/generated/resources/META-INF/org/apache/camel/component/ibm/secrets/manager/ibm-secrets-manager.json +++ b/components/camel-ibm-secrets-manager/src/generated/resources/META-INF/org/apache/camel/component/ibm/secrets/manager/ibm-secrets-manager.json @@ -35,7 +35,7 @@ }, "properties": { "label": { "index": 0, "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "Logical name" }, - "operation": { "index": 1, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerOperation", "enum": [ "createArbitrarySecret", "createKVSecret", "getSecret", "deleteSecret" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", [...] + "operation": { "index": 1, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerOperation", "enum": [ "createArbitrarySecret", "createKVSecret", "getSecret", "deleteSecret", "listSecrets" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManager [...] "serviceUrl": { "index": 2, "kind": "parameter", "displayName": "Service Url", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "Service URL for IBM Secrets Manager" }, "lazyStartProducer": { "index": 3, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a produc [...] "token": { "index": 4, "kind": "parameter", "displayName": "Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConfiguration", "configurationField": "configuration", "description": "IBM Cloud API Token for IBM Secrets Manager" } diff --git a/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerOperation.java b/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerOperation.java index 546daaee3f3..eb8b75ca1e1 100644 --- a/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerOperation.java +++ b/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerOperation.java @@ -20,5 +20,6 @@ public enum IBMSecretsManagerOperation { createArbitrarySecret, createKVSecret, getSecret, - deleteSecret + deleteSecret, + listSecrets } diff --git a/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerProducer.java b/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerProducer.java index 526e0430ab8..dceef0044d5 100644 --- a/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerProducer.java +++ b/components/camel-ibm-secrets-manager/src/main/java/org/apache/camel/component/ibm/secrets/manager/IBMSecretsManagerProducer.java @@ -46,6 +46,9 @@ public class IBMSecretsManagerProducer extends DefaultProducer { case deleteSecret: deleteSecret(exchange); break; + case listSecrets: + listSecrets(exchange); + break; default: throw new IllegalArgumentException("Unsupported operation"); } @@ -123,6 +126,11 @@ public class IBMSecretsManagerProducer extends DefaultProducer { getEndpoint().getSecretManager().deleteSecret(deleteSecretOptionsBuilder.build()).execute(); } + private void listSecrets(Exchange exchange) { + Response<SecretMetadataPaginatedCollection> result = getEndpoint().getSecretManager().listSecrets().execute(); + exchange.getMessage().setBody(result.getResult()); + } + @Override public IBMSecretsManagerEndpoint getEndpoint() { return (IBMSecretsManagerEndpoint) super.getEndpoint(); diff --git a/components/camel-ibm-secrets-manager/src/test/java/org/apache/camel/component/ibm/secrets/manager/integration/operations/IBMSecretsManagerListSecretsIT.java b/components/camel-ibm-secrets-manager/src/test/java/org/apache/camel/component/ibm/secrets/manager/integration/operations/IBMSecretsManagerListSecretsIT.java new file mode 100644 index 00000000000..ba6f0d59369 --- /dev/null +++ b/components/camel-ibm-secrets-manager/src/test/java/org/apache/camel/component/ibm/secrets/manager/integration/operations/IBMSecretsManagerListSecretsIT.java @@ -0,0 +1,106 @@ +/* + * 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.camel.component.ibm.secrets.manager.integration.operations; + +import com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model.SecretMetadataPaginatedCollection; +import org.apache.camel.EndpointInject; +import org.apache.camel.Exchange; +import org.apache.camel.Processor; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.ibm.secrets.manager.IBMSecretsManagerConstants; +import org.apache.camel.component.mock.MockEndpoint; +import org.apache.camel.test.junit5.CamelTestSupport; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.EnabledIfSystemProperties; +import org.junit.jupiter.api.condition.EnabledIfSystemProperty; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +// Must be manually tested. Provide your own accessKey and secretKey using -Dsecrets-manager and -Dcamel.ibm.sm.serviceurl +@EnabledIfSystemProperties({ + @EnabledIfSystemProperty(named = "camel.ibm.sm.token", matches = ".*", + disabledReason = "Secrets Manager Token not provided"), + @EnabledIfSystemProperty(named = "camel.ibm.sm.serviceurl", matches = ".*", + disabledReason = "Secrets Manager Service URL not provided") +}) +public class IBMSecretsManagerListSecretsIT extends CamelTestSupport { + + @EndpointInject("mock:result-write") + private MockEndpoint mockWrite; + + @EndpointInject("mock:result-list") + private MockEndpoint mockList; + + @EndpointInject("mock:result-delete") + private MockEndpoint mockDelete; + + @Test + public void createSecretTest() throws InterruptedException { + mockWrite.expectedMessageCount(1); + mockList.expectedMessageCount(1); + mockDelete.expectedMessageCount(1); + Exchange createdSec = template.request("direct:createSecret", new Processor() { + @Override + public void process(Exchange exchange) { + exchange.getIn().setBody("test"); + + exchange.getMessage().setHeader(IBMSecretsManagerConstants.SECRET_NAME, "secret1"); + } + }); + Exchange listSec = template.request("direct:listSecrets", new Processor() { + @Override + public void process(Exchange exchange) { + exchange.getMessage().setHeader(IBMSecretsManagerConstants.SECRET_ID, createdSec.getMessage().getBody()); + } + }); + template.request("direct:deleteSecret", new Processor() { + @Override + public void process(Exchange exchange) { + exchange.getMessage().setHeader(IBMSecretsManagerConstants.SECRET_ID, createdSec.getMessage().getBody()); + } + }); + + MockEndpoint.assertIsSatisfied(context); + Exchange ret = mockList.getExchanges().get(0); + assertNotNull(ret); + SecretMetadataPaginatedCollection collection = ret.getMessage().getBody(SecretMetadataPaginatedCollection.class); + assertEquals("secret1", collection.getSecrets().get(0).getName()); + } + + @Override + protected RouteBuilder createRouteBuilder() { + return new RouteBuilder() { + @Override + public void configure() { + from("direct:createSecret") + .toF("ibm-secrets-manager://secret?operation=createArbitrarySecret&token=RAW(%s)&serviceUrl=%s", + System.getProperty("camel.ibm.sm.token"), System.getProperty("camel.ibm.sm.serviceurl")) + .to("mock:result-write"); + from("direct:listSecrets") + .toF("ibm-secrets-manager://secret?operation=listSecrets&token=RAW(%s)&serviceUrl=%s", + System.getProperty("camel.ibm.sm.token"), System.getProperty("camel.ibm.sm.serviceurl")) + .to("mock:result-list"); + from("direct:deleteSecret") + .toF("ibm-secrets-manager://secret?operation=deleteSecret&token=RAW(%s)&serviceUrl=%s", + System.getProperty("camel.ibm.sm.token"), System.getProperty("camel.ibm.sm.serviceurl")) + .to("mock:result-delete"); + } + }; + } +}