validate Mhs Queue properties

gp2gp-translator/src/integrationTest/resources/application.yml

@@ -30,8 +30,8 @@ amqp:
   mhs:
     queueName: ${MHS_QUEUE_NAME:mhsQueue}
     broker: ${MHS_AMQP_BROKER:amqp://localhost:5672}
-    username: ${MHS_AMQP_USERNAME:}
-    password: ${MHS_AMQP_PASSWORD:}
+    username: ${MHS_AMQP_USERNAME:admin}
+    password: ${MHS_AMQP_PASSWORD:admin}
     maxRedeliveries: ${MHS_AMQP_MAX_REDELIVERIES:3}
     dlqPrefix: ${MHS_DLQ_PREFIX:DLQ.}
   gp2gp:

gp2gp-translator/src/main/java/uk/nhs/adaptors/pss/translator/config/MhsQueueProperties.java

@@ -5,11 +5,15 @@
 
 import lombok.Getter;
 import lombok.Setter;
+import org.springframework.validation.annotation.Validated;
+import uk.nhs.adaptors.pss.translator.validation.ValidMhsQueueProperties;
 
 @Component
 @ConfigurationProperties(prefix = "amqp.mhs")
 @Getter
 @Setter
+@Validated
+@ValidMhsQueueProperties
 public class MhsQueueProperties {
     private String queueName;
     private String broker;

gp2gp-translator/src/main/java/uk/nhs/adaptors/pss/translator/validation/MhsQueuePropertyValidator.java

@@ -0,0 +1,59 @@
+package uk.nhs.adaptors.pss.translator.validation;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import uk.nhs.adaptors.pss.translator.config.MhsQueueProperties;
+
+import java.util.ArrayList;
+import java.util.TreeMap;
+
+@Slf4j
+public class MhsQueuePropertyValidator
+        implements ConstraintValidator<ValidMhsQueueProperties, MhsQueueProperties> {
+    private static final String MISSING_ENV_VARIABLE_MESSAGE = "Env variable not provided: %s";
+
+    @Override
+    public boolean isValid(MhsQueueProperties config, ConstraintValidatorContext context) {
+        TreeMap<String, String> environmentVariables = getEnvironmentVariables(config);
+
+        ArrayList<String> validationMessages = validateAgainstRuleset(environmentVariables);
+
+        if (!validationMessages.isEmpty()) {
+            for (var message : validationMessages) {
+                setConstraintViolation(context, message);
+            }
+            return false;
+        }
+        return true;
+    }
+
+    private TreeMap<String, String> getEnvironmentVariables(MhsQueueProperties configuration) {
+        TreeMap<String, String> environmentVariables =  new TreeMap<>();
+
+        environmentVariables.put("MHS_AMQP_BROKER", configuration.getBroker());
+        environmentVariables.put("MHS_AMQP_USERNAME", configuration.getUsername());
+        environmentVariables.put("MHS_AMQP_PASSWORD", configuration.getPassword());
+
+        return environmentVariables;
+    }
+
+    private ArrayList<String> validateAgainstRuleset(TreeMap<String, String> environmentVariables) {
+        ArrayList<String> messages = new ArrayList<>();
+
+        for (var variable : environmentVariables.entrySet()) {
+            if (StringUtils.isBlank(variable.getValue())) {
+                messages.add(String.format(MISSING_ENV_VARIABLE_MESSAGE, variable.getKey()));
+            }
+        }
+
+        return messages;
+    }
+
+    private static void setConstraintViolation(ConstraintValidatorContext context, String message) {
+        LOGGER.error(message);
+        context.buildConstraintViolationWithTemplate(message).addConstraintViolation();
+    }
+
+}

gp2gp-translator/src/main/java/uk/nhs/adaptors/pss/translator/validation/ValidMhsQueueProperties.java

@@ -0,0 +1,20 @@
+package uk.nhs.adaptors.pss.translator.validation;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Documented
+@Constraint(validatedBy = MhsQueuePropertyValidator.class)
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ValidMhsQueueProperties {
+    String message() default "Invalid MHS Queue Configuration";
+    Class<?>[] groups() default {};
+    Class<? extends Payload>[] payload() default {};
+}

gp2gp-translator/src/test/java/validation/MhsQueuePropertyValidatorTest.java

@@ -0,0 +1,106 @@
+package validation;
+
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Configuration;
+import uk.nhs.adaptors.pss.translator.config.MhsQueueProperties;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertAll;
+
+public class MhsQueuePropertyValidatorTest {
+
+    // Valid configurations
+    private static final String VALID_MHS_AMQP_BROKER = "amqp://localhost:1234";
+    private static final String VALID_MHS_AMQP_USERNAME = "some-username";
+    private static final String VALID_MHS_AMQP_PASSWORD = "some-password";
+
+    // Configuration fields
+    private static final String MHS_AMQP_BROKER = "broker";
+    private static final String MHS_AMQP_USERNAME = "username";
+    private static final String MHS_AMQP_PASSWORD = "password";
+
+    private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+            .withUserConfiguration(TestMhsQueueProperties.class);
+
+    @Test
+    void When_ConfigurationContainsAllProperties_Expect_IsContextIsCreated() {
+        contextRunner
+                .withPropertyValues(
+                        buildPropertyValue(MHS_AMQP_BROKER, VALID_MHS_AMQP_BROKER),
+                        buildPropertyValue(MHS_AMQP_USERNAME, VALID_MHS_AMQP_USERNAME),
+                        buildPropertyValue(MHS_AMQP_PASSWORD, VALID_MHS_AMQP_PASSWORD)
+                )
+                .run(context -> {
+                    assertThat(context)
+                            .hasNotFailed()
+                            .hasSingleBean(MhsQueueProperties.class);
+
+                    var storageConnectorConfiguration = context.getBean(MhsQueueProperties.class);
+
+                    assertAll(
+                            () -> assertThat(storageConnectorConfiguration.getBroker())
+                                    .isEqualTo(VALID_MHS_AMQP_BROKER),
+                            () -> assertThat(storageConnectorConfiguration.getUsername())
+                                    .isEqualTo(VALID_MHS_AMQP_USERNAME),
+                            () -> assertThat(storageConnectorConfiguration.getPassword())
+                                    .isEqualTo(VALID_MHS_AMQP_PASSWORD)
+                    );
+                });
+    }
+
+    @Test
+    void When_ConfigurationPropertiesNotProvided_Expect_ContextNotCreated() {
+        contextRunner
+                .withPropertyValues(
+                        buildPropertyValue(MHS_AMQP_BROKER, ""),
+                        buildPropertyValue(MHS_AMQP_USERNAME, ""),
+                        buildPropertyValue(MHS_AMQP_PASSWORD, "")
+                )
+                .run(context -> {
+                    assertThat(context).hasFailed();
+                    var startupFailure = context.getStartupFailure();
+
+                    assertThat(startupFailure)
+                            .rootCause()
+                            .hasMessageContaining("Env variable not provided: MHS_AMQP_BROKER")
+                            .hasMessageContaining("Env variable not provided: MHS_AMQP_USERNAME")
+                            .hasMessageContaining("Env variable not provided: MHS_AMQP_PASSWORD");
+                });
+    }
+
+    @Test
+    void When_SingleConfigurationPropertyNotProvided_Expect_ContextNotCreated() {
+        contextRunner
+                .withPropertyValues(
+                        buildPropertyValue(MHS_AMQP_BROKER, VALID_MHS_AMQP_BROKER),
+                        buildPropertyValue(MHS_AMQP_USERNAME, VALID_MHS_AMQP_USERNAME),
+                        buildPropertyValue(MHS_AMQP_PASSWORD, "")
+                )
+                .run(context -> {
+                    assertThat(context).hasFailed();
+                    var startupFailure = context.getStartupFailure();
+
+                    assertThat(startupFailure)
+                            .rootCause()
+                            .hasMessageContaining("Env variable not provided: MHS_AMQP_PASSWORD");
+                });
+    }
+
+
+    @Contract(pure = true)
+    private static @NotNull String buildPropertyValue(String propertyName, String value) {
+        return String.format("amqp.mhs.%s=%s", propertyName, value);
+    }
+
+    @Configuration
+    @EnableConfigurationProperties(MhsQueueProperties.class)
+    static class TestMhsQueueProperties {
+    }
+}
+
+
+