Implemented skipping of queue management (#89)

Issue:
#69

Author: t-bonk

CHANGELOG.md

@@ -5,10 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Version 0.2.0 - tbd
+## Version 1.0.0 - tbd
 
 ### Added
 
+- Configuration option `cds.messaging.services.<key>.connection.properties.skipManagement` to skip creation of queue and subscription.
+
 ### Changed
 
 ### Fixed

README.md

@@ -97,6 +97,14 @@ Your app must be bound to an instance of service `SAP Integration Suite, advance
 Please see [Validation of VMR Provisioning](https://help.sap.com/docs/sap-integration-suite/advanced-event-mesh/validation-of-vmr-provisioning) for more information.
 
 
+### Additional Configuration Options
+
+Additional configuration options for the messaging service are:
+
+Property | Type | Description |
+ | --- | --- | --- |
+| `cds.messaging.services.<key>.connection.properties.skipManagement` | `boolean` | If set to `true`, the plugin will not create a queue or subscription. This is useful if you want to manage these resources manually, default: `false` |
+
 
 ## Support, Feedback, Contributing
 

cds-feature-advanced-event-mesh/src/main/java/com/sap/cds/feature/messaging/aem/service/AemMessagingService.java

@@ -2,6 +2,7 @@
 
 import static com.sap.cds.feature.messaging.aem.client.AemManagementClient.ATTR_DEAD_MSG_QUEUE;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.sap.cds.feature.messaging.aem.client.AemManagementClient;
 import com.sap.cds.feature.messaging.aem.client.AemValidationClient;
 import com.sap.cds.feature.messaging.aem.jms.AemMessagingConnectionProvider;
@@ -36,6 +37,7 @@ public class AemMessagingService extends AbstractMessagingService {
 
   private volatile BrokerConnection connection;
   private volatile Boolean aemBrokerValidated = false;
+  private volatile Boolean skipManagement = false;
 
   @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
   protected AemMessagingService(
@@ -50,6 +52,16 @@ protected AemMessagingService(
     this.connectionProvider = connectionProvider;
     this.managementClient = new AemManagementClient(binding);
     this.validationBinding = validationBinding;
+
+    Map<String, String> properties = serviceConfig.getConnection().getProperties();
+    String skipManagementProperty = properties.get("skipManagement");
+    String skip_ManagementProperty = properties.get("skip-management");
+    this.skipManagement = Boolean.parseBoolean(skipManagementProperty) || Boolean.parseBoolean(skip_ManagementProperty);
+  }
+
+  @VisibleForTesting
+  boolean getSkipManagement() {
+    return this.skipManagement;
   }
 
   @Override
@@ -83,11 +95,21 @@ public void stop() {
 
   @Override
   protected void removeQueue(String name) throws IOException {
+    if (this.skipManagement) {
+      logger.debug("Skipping deletion of queue '{}', skipManagement = {}", name, this.skipManagement);
+      return;
+    }
+
     managementClient.removeQueue(name);
   }
 
   @Override
   protected void createQueue(String name, Map<String, Object> properties) throws IOException {
+    if (this.skipManagement) {
+      logger.debug("Skipping creation of queue '{}', skipManagement = {}", name, this.skipManagement);
+      return;
+    }
+
     if (properties.containsKey(ATTR_DEAD_MSG_QUEUE)) {
       String dmQueue = (String) properties.get(ATTR_DEAD_MSG_QUEUE);
       if (managementClient.getQueue(dmQueue) == null) {
@@ -99,6 +121,12 @@ protected void createQueue(String name, Map<String, Object> properties) throws I
 
   @Override
   protected void createQueueSubscription(String queue, String topic) throws IOException {
+    if (this.skipManagement) {
+      logger.debug("Skipping creation of queue subscription for queue '{}' and topic '{}', skipManagement = {}",
+          queue, topic, this.skipManagement);
+      return;
+    }
+
     managementClient.createQueueSubscription(queue, topic);
   }
 

cds-feature-advanced-event-mesh/src/test/java/com/sap/cds/feature/messaging/aem/service/AemMessagingServiceConfigurationTest.java

@@ -2,12 +2,14 @@
 
 import static com.sap.cds.services.outbox.OutboxService.unboxed;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import com.sap.cds.services.Service;
 import com.sap.cds.services.environment.CdsProperties;
 import com.sap.cds.services.environment.CdsProperties.Messaging.MessagingServiceConfig;
 import com.sap.cds.services.impl.environment.SimplePropertiesProvider;
+import com.sap.cds.services.outbox.OutboxService;
 import com.sap.cds.services.runtime.CdsRuntimeConfigurer;
 import java.util.List;
 import java.util.stream.Collectors;
@@ -140,4 +142,87 @@ void testServiceConfigurationWithInvalidBinding() {
 
     assertTrue(services.isEmpty(), "Expected no services to be configured with invalid binding");
   }
+
+  @Test
+  void testServiceConfigurationWithoutSkipManagementConfigured() {
+    CdsProperties properties = new CdsProperties();
+    MessagingServiceConfig config = new MessagingServiceConfig("cfg");
+    config.setBinding("my-aem-instance");
+    config.getOutbox().setEnabled(false);
+    properties.getMessaging().getServices().put(config.getName(), config);
+
+    CdsRuntimeConfigurer configurer =
+      CdsRuntimeConfigurer.create(new SimplePropertiesProvider(properties));
+
+    configurer.serviceConfigurations();
+    configurer.eventHandlerConfigurations();
+
+    List<AemMessagingService> services =
+      configurer
+        .getCdsRuntime()
+        .getServiceCatalog()
+        .getServices()
+        .map(OutboxService::unboxed)
+        .filter(srv -> srv.getClass().equals(AemMessagingService.class))
+        .map(srv -> (AemMessagingService) srv)
+        .toList();
+
+    assertFalse(services.stream().findFirst().get().getSkipManagement());
+  }
+
+  @Test
+  void testServiceConfigurationWithDisabledSkipManagement() {
+    CdsProperties properties = new CdsProperties();
+    MessagingServiceConfig config = new MessagingServiceConfig("cfg");
+    config.setBinding("my-aem-instance");
+    config.getOutbox().setEnabled(false);
+    config.getConnection().getProperties().put("skip-management", "false");
+    properties.getMessaging().getServices().put(config.getName(), config);
+
+    CdsRuntimeConfigurer configurer =
+      CdsRuntimeConfigurer.create(new SimplePropertiesProvider(properties));
+
+    configurer.serviceConfigurations();
+    configurer.eventHandlerConfigurations();
+
+    List<AemMessagingService> services =
+      configurer
+        .getCdsRuntime()
+        .getServiceCatalog()
+        .getServices()
+        .map(OutboxService::unboxed)
+        .filter(srv -> srv.getClass().equals(AemMessagingService.class))
+        .map(srv -> (AemMessagingService) srv)
+        .toList();
+
+    assertFalse(services.stream().findFirst().get().getSkipManagement());
+  }
+
+  @Test
+  void testServiceConfigurationWithEnabledSkipManagement() {
+    CdsProperties properties = new CdsProperties();
+    MessagingServiceConfig config = new MessagingServiceConfig("cfg");
+    config.setBinding("my-aem-instance");
+    config.getOutbox().setEnabled(false);
+    config.getConnection().getProperties().put("skipManagement", "true");
+    properties.getMessaging().getServices().put(config.getName(), config);
+
+    CdsRuntimeConfigurer configurer =
+      CdsRuntimeConfigurer.create(new SimplePropertiesProvider(properties));
+
+    configurer.serviceConfigurations();
+    configurer.eventHandlerConfigurations();
+
+    List<AemMessagingService> services =
+      configurer
+        .getCdsRuntime()
+        .getServiceCatalog()
+        .getServices()
+        .map(OutboxService::unboxed)
+        .filter(srv -> srv.getClass().equals(AemMessagingService.class))
+        .map(srv -> (AemMessagingService) srv)
+        .toList();
+
+    assertTrue(services.stream().findFirst().get().getSkipManagement());
+  }
 }