DHFPROD-6962: Only enable hubDhs for aws/azure spring profile

akshaysonvane · MarkLogic Builder · commit bb9685fddec8 · 2021-02-24T11:27:14.000-08:00
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -53,7 +53,7 @@ def dhfCypressE2ETests(String mlVersion, String type){
                     cd marklogic-data-hub-central/ui/e2e;
                     chmod +x setup.sh;
                     ./setup.sh dhs=false mlHost=localhost;
-                    nohup java -jar $WORKSPACE/$WAR_NAME --hubUseLocalDefaults=true >> nohup.out &
+                    nohup java -jar $WORKSPACE/$WAR_NAME >> nohup.out &
                     sleep 10s;
                     mkdir -p output;
                     docker build . -t cypresstest;
@@ -191,7 +191,6 @@ def runCypressE2e(){
             export JAVA_HOME=`eval echo "$JAVA_HOME_DIR"`;
             sudo mladmin install-hubcentral $WORKSPACE/*central*.rpm;
             sudo mladmin add-javahome-hubcentral $JAVA_HOME
-            sudo mladmin add-hubcentral-property hubUseLocalDefaults=true
             sudo mladmin start-hubcentral
         ''')
         sh(script:'''#!/bin/bash
diff --git a/marklogic-data-hub-central/build.gradle b/marklogic-data-hub-central/build.gradle
@@ -54,8 +54,6 @@ bootWar {
 // To pass Gradle properties for HubCentral to Spring Boot, copy them into the JVM environment
 bootRun.doFirst {
     environment "mlHost", mlHost
-    environment "hubUseLocalDefaults", hubUseLocalDefaults
-    environment "hubSsl", hubSsl
     environment "spring.profiles.active", springProfiles
 }
 
diff --git a/marklogic-data-hub-central/gradle.properties b/marklogic-data-hub-central/gradle.properties
@@ -11,15 +11,10 @@ springSecurityVersion=5.3.8.RELEASE
 # Passed to bootRun as the value of spring.profiles.active
 # Defaults to "dev" since it's assumed that "./gradlew bootRun" is only used during development. For production, or any
 # non-development environment, it's assumed that bootWar is first used to construct the war file, which will default to
-# "production" as the profile, per the application.properties file.
+# "default" as the spring profile.
 springProfiles=dev
 
 # For testing locally.
 # Each of these can be overridden via e.g. -PmlHost=somehost when running "./gradlew bootRun".
 # Can also override them via gradle-local.properties, which is a gitignored file.
 mlHost=localhost
-hubUseLocalDefaults=false
-
-# This is being temporarily included so it's easy to turn SSL usage off, as it's not certain yet whether HC will need
-# SSL or not when talking to ML in a DHS environment.
-hubSsl=true
diff --git a/marklogic-data-hub-central/src/main/java/com/marklogic/hub/central/HubCentral.java b/marklogic-data-hub-central/src/main/java/com/marklogic/hub/central/HubCentral.java
@@ -24,20 +24,13 @@ public class HubCentral extends LoggingObject implements InitializingBean {
     @Value("${mlHost:localhost}")
     String host;
 
-    @Value("${hubUseLocalDefaults:false}")
-    boolean useLocalDefaults;
-
     /**
      * When the application starts up, initialize a project at the configured project path. This will go away before
      * 5.3.0, once Hub Central no longer depends on a HubProject. In the meantime, we need this as a bridge.
      */
     @Override
     public void afterPropertiesSet() {
         logger.info("Will connect to MarkLogic host: " + host);
-
-        if (useLocalDefaults) {
-            logger.info("Local defaults of digest authentication and no SSL will be used when connecting to MarkLogic");
-        }
         logger.info("Hub Central is available at port: " + environment.getProperty("server.port"));
     }
 
@@ -69,11 +62,6 @@ protected PropertySource buildPropertySource(String username, String password) {
         primaryProperties.setProperty("mlUsername", username);
         primaryProperties.setProperty("mlPassword", password);
 
-        if (useLocalDefaults) {
-            primaryProperties.setProperty("hubDhs", "false");
-            primaryProperties.setProperty("hubSsl", "false");
-        }
-
         return propertyName -> {
             String value = primaryProperties.getProperty(propertyName);
             if (value != null) {
diff --git a/marklogic-data-hub-central/src/main/resources/application-aws.properties b/marklogic-data-hub-central/src/main/resources/application-aws.properties
@@ -0,0 +1,2 @@
+# Data Hub connection properties. These default to the expected values for DHS on AWS.
+hubDhs=true
diff --git a/marklogic-data-hub-central/src/main/resources/application-azure.properties b/marklogic-data-hub-central/src/main/resources/application-azure.properties
@@ -0,0 +1,2 @@
+# Data Hub connection properties. These default to the expected values for DHS on Azure.
+hubDhs=true
diff --git a/marklogic-data-hub-central/src/main/resources/application.properties b/marklogic-data-hub-central/src/main/resources/application.properties
@@ -1,8 +1,3 @@
-# Controls which Spring Profile values for enabled. This is a handy way to control which beans are active in a given
-# environment. See SwaggerConfig as an example.
-# This defaults to "production" to ensure that the "dev" profile is only used via an intentional decision.
-spring.profiles.active=production
-
 server.port=8080
 spring.thymeleaf.prefix=classpath:/static/
 
@@ -12,11 +7,8 @@ spring.thymeleaf.prefix=classpath:/static/
 server.tomcat.remote_ip_header=x-forwarded-for
 server.tomcat.protocol_header=x-forwarded-proto
 
-# Data Hub connection properties. These default to the expected values for DHS. Both properties are defined in case HC
-# needs to run behind a load balancer at some point, in which case hubDhs=true and hubSsl=false would be used.
+# Data Hub connection properties. These default to the expected values for on-prem HC.
 mlHost=localhost
-hubDhs=true
-hubSsl=true
 
 # No need for session persistence as we have no failover servers and we are using non-serializable objects in session scope
 server.servlet.session.persistent=false
diff --git a/marklogic-data-hub-central/src/test/java/com/marklogic/hub/central/HubCentralTest.java b/marklogic-data-hub-central/src/test/java/com/marklogic/hub/central/HubCentralTest.java
@@ -5,12 +5,12 @@
 import com.marklogic.hub.impl.HubConfigImpl;
 import com.marklogic.mgmt.ManageConfig;
 import com.marklogic.mgmt.util.PropertySource;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.core.env.PropertiesPropertySource;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.mock.env.MockEnvironment;
 
+import java.io.IOException;
 import java.util.Properties;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -20,44 +20,68 @@ public class HubCentralTest {
     HubCentral hubCentral;
     MockEnvironment mockEnvironment;
 
-    @BeforeEach
-    void beforeEach() throws Exception {
-        Properties defaultProps = new Properties();
-        defaultProps.load(new ClassPathResource("application.properties").getInputStream());
-        mockEnvironment = new MockEnvironment();
-        mockEnvironment.getPropertySources().addFirst(new PropertiesPropertySource("default", defaultProps));
-
-        hubCentral = new HubCentral();
-        hubCentral.environment = mockEnvironment;
+    @Test
+    void testNewDefaultHubConfig() throws IOException {
+        setupEnvironment("application.properties");
+        verifyDefaultPropertiesForSslAndAuthentication();
+        newDefaultHubConfig();
     }
 
     @Test
-    void verifyDefaultPropertiesForSslAndAuthentication() {
-        PropertySource props = hubCentral.buildPropertySource("anyone", "anyword");
-        assertEquals("anyone", props.getProperty("mlUsername"));
-        assertEquals("anyword", props.getProperty("mlPassword"));
-        assertEquals("localhost", props.getProperty("mlHost"),
-            "For convenience while doing local development, mlHost still defaults to localhost");
-        assertEquals("true", props.getProperty("hubDhs"));
-        assertEquals("true", props.getProperty("hubSsl"));
+    void testNewHubConfigForDhsOnAWS() throws IOException {
+        setupEnvironment("application-aws.properties");
+        verifyPropertiesForSslAndAuthenticationOnDhs();
+        newHubConfigForDhs();
     }
 
-    /**
-     * This is essentially tested via every HC test as well, which is using local defaults.
-     */
     @Test
-    void verifyLocalDefaults() {
-        hubCentral.useLocalDefaults = true;
-        PropertySource props = hubCentral.buildPropertySource("anyone", "anyword");
-        assertEquals("anyone", props.getProperty("mlUsername"));
-        assertEquals("anyword", props.getProperty("mlPassword"));
-        assertEquals("localhost", props.getProperty("mlHost"));
-        assertEquals("false", props.getProperty("hubDhs"));
-        assertEquals("false", props.getProperty("hubSsl"));
+    void testNewHubConfigForDhsOnAzure() throws IOException {
+        setupEnvironment("application-azure.properties");
+        verifyPropertiesForSslAndAuthenticationOnDhs();
+        newHubConfigForDhs();
     }
 
-    @Test
-    void newHubConfig() {
+    void newDefaultHubConfig() {
+        Properties customProps = new Properties();
+        customProps.setProperty("mlHost", "somehost");
+        mockEnvironment.getPropertySources().addFirst(new PropertiesPropertySource("custom", customProps));
+
+        HubConfigImpl hubConfig = hubCentral.newHubConfig("anyone", "anyword");
+
+        assertEquals("somehost", hubConfig.getAppConfig().getHost());
+        assertEquals((Integer) 8000, hubConfig.getAppConfig().getAppServicesPort());
+        assertEquals("anyone", hubConfig.getAppConfig().getAppServicesUsername(),
+                "The Versions class used appConfig.getAppServicesDatabaseClient to get the ML version");
+        assertEquals("anyword", hubConfig.getAppConfig().getAppServicesPassword());
+        assertEquals(SecurityContextType.DIGEST, hubConfig.getAppConfig().getAppServicesSecurityContextType());
+        assertNull(hubConfig.getAppConfig().getAppServicesSslContext());
+
+        assertEquals("somehost", hubConfig.getHost());
+        assertEquals("anyone", hubConfig.getMlUsername());
+        assertEquals("anyword", hubConfig.getMlPassword());
+
+        assertEquals("digest", hubConfig.getAuthMethod(DatabaseKind.STAGING));
+        assertEquals("digest", hubConfig.getAuthMethod(DatabaseKind.FINAL));
+        assertEquals("digest", hubConfig.getAuthMethod(DatabaseKind.JOB));
+
+        assertNull(hubConfig.getSslContext(DatabaseKind.STAGING));
+        assertNull(hubConfig.getSslContext(DatabaseKind.FINAL));
+        assertNull(hubConfig.getSslContext(DatabaseKind.JOB));
+
+        assertFalse(hubConfig.getIsHostLoadBalancer());
+        assertFalse(hubConfig.getIsProvisionedEnvironment());
+
+        ManageConfig manageConfig = hubConfig.getManageConfig();
+        assertEquals("anyone", manageConfig.getUsername());
+        assertEquals("anyone", manageConfig.getSecurityUsername());
+        assertEquals("somehost", manageConfig.getHost());
+        assertEquals("anyword", manageConfig.getPassword());
+        assertEquals("anyword", manageConfig.getSecurityPassword());
+        assertFalse(manageConfig.isConfigureSimpleSsl());
+        assertEquals("http", manageConfig.getScheme());
+    }
+
+    void newHubConfigForDhs() {
         Properties customProps = new Properties();
         customProps.setProperty("mlHost", "somehost");
         mockEnvironment.getPropertySources().addFirst(new PropertiesPropertySource("custom", customProps));
@@ -66,9 +90,9 @@ void newHubConfig() {
 
         assertEquals("somehost", hubConfig.getAppConfig().getHost());
         assertEquals((Integer) 8010, hubConfig.getAppConfig().getAppServicesPort(),
-            "8010 is needed by DHS, as 8000 is locked down; this should be defined in application.properties");
+                "8010 is needed by DHS, as 8000 is locked down; this should be defined in application.properties");
         assertEquals("anyone", hubConfig.getAppConfig().getAppServicesUsername(),
-            "The Versions class used appConfig.getAppServicesDatabaseClient to get the ML version");
+                "The Versions class used appConfig.getAppServicesDatabaseClient to get the ML version");
         assertEquals("anyword", hubConfig.getAppConfig().getAppServicesPassword());
         assertEquals(SecurityContextType.BASIC, hubConfig.getAppConfig().getAppServicesSecurityContextType());
         assertNotNull(hubConfig.getAppConfig().getAppServicesSslContext());
@@ -97,4 +121,31 @@ void newHubConfig() {
         assertTrue(manageConfig.isConfigureSimpleSsl());
         assertEquals("https", manageConfig.getScheme());
     }
+
+    void verifyDefaultPropertiesForSslAndAuthentication() {
+        PropertySource props = hubCentral.buildPropertySource("anyone", "anyword");
+        assertEquals("anyone", props.getProperty("mlUsername"));
+        assertEquals("anyword", props.getProperty("mlPassword"));
+        assertEquals("localhost", props.getProperty("mlHost"),
+                "For convenience while doing local development, mlHost still defaults to localhost");
+        assertNull(props.getProperty("hubDhs"));
+        assertNull(props.getProperty("hubSsl"));
+    }
+
+    void verifyPropertiesForSslAndAuthenticationOnDhs() {
+        PropertySource props = hubCentral.buildPropertySource("anyone", "anyword");
+        assertEquals("anyone", props.getProperty("mlUsername"));
+        assertEquals("anyword", props.getProperty("mlPassword"));
+        assertEquals("true", props.getProperty("hubDhs"));
+    }
+
+    private void setupEnvironment(String propertyFileName) throws IOException {
+        Properties defaultProps = new Properties();
+        defaultProps.load(new ClassPathResource(propertyFileName).getInputStream());
+        mockEnvironment = new MockEnvironment();
+        mockEnvironment.getPropertySources().addFirst(new PropertiesPropertySource("default", defaultProps));
+
+        hubCentral = new HubCentral();
+        hubCentral.environment = mockEnvironment;
+    }
 }
diff --git a/marklogic-data-hub-central/src/test/resources/application-test.properties b/marklogic-data-hub-central/src/test/resources/application-test.properties
@@ -1,7 +1,2 @@
 # Define any properties in here that are likely to change between environments where tests are run.
 # The TestConfig class should then be used to access these properties.
-
-# It's assumed that when running tests, it'll be against a non-DHS ML instance, and thus digest auth should be used
-# with no SSL.
-
-hubUseLocalDefaults=true
diff --git a/marklogic-data-hub-central/ui/e2e/README.md b/marklogic-data-hub-central/ui/e2e/README.md
@@ -20,8 +20,8 @@ Boot up HC application from `marklogic-data-hub-central` directory either via bo
         * java -jar </path/to/HC.war> --mlHost=<curationEndpoint> --spring.profiles.active=dev
         
     For local - 
-        * ./gradlew bootRun -PhubUseLocalDefaults=true
-        * java -jar </path/to/HC.war> --hubUseLocalDefaults=true --spring.profiles.active=dev
+        * ./gradlew bootRun
+        * java -jar </path/to/HC.war> --spring.profiles.active=dev
 
  
 Then run the Cypress tests. Use appropriate run scripts defined in package.json to run on different browsers:

Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,6 @@ bootWar {`
`54`	`54`	`// To pass Gradle properties for HubCentral to Spring Boot, copy them into the JVM environment`
`55`	`55`	`bootRun.doFirst {`
`56`	`56`	`environment "mlHost", mlHost`
`57`		`- environment "hubUseLocalDefaults", hubUseLocalDefaults`
`58`		`- environment "hubSsl", hubSsl`
`59`	`57`	`environment "spring.profiles.active", springProfiles`
`60`	`58`	`}`
`61`	`59`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Data Hub connection properties. These default to the expected values for DHS on AWS.`
	`2`	`+hubDhs=true`