Merge pull request #932 from oracle/sitconfigtests2

Sitconfigtests2

Author: rjeberhard

integration-tests/README.md

@@ -86,7 +86,14 @@ Basic Use Cases described above are verified in all the domain configurations. A
 | Server pods restarted by changing includeServerOutInPodLog | Verify admin and managed server pods being restarted by property change: includeServerOutInPodLog: true --> includeServerOutInPodLog: false |
 | Server pods restarted by changing logHomeEnable | Verify admin and managed server pods being restarted by property change: logHomeEnabled: true --> logHomeEnabled: false |
 
+Configuration Overrides Usecases
 
+| Override | Usecase |
+| --- | --- |
+| Configuration override | Override the administration server properties `connect-timeout`, `max-message-size`, `restart-max`, `debug-server-life-cycle` and `debug-jmx-core` debug flags. Also T3Channel public address using Kubernetes secret. The override is verified by JMX client connecting to the serverConfig MBean tree and the values are checked against the expected values. The test client connects to the overridden T3 public address and port to connect to the MBean servers |
+| JDBC Resource Override | Override JDBC connection pool properties; `initialCapacity`, `maxCapacity`, `test-connections-on-reserve`, `connection-harvest-max-count`, `inactive-connection-timeout-seconds`. Override the JDBC driver parameters like data source `URL`, `DB` `user` and `password` using kubernetes secret. The test verifies the overridden functionality datasource `URL`, `user`, `password` by getting the data source connection and running DDL statement it is connected to. |
+| JMS Resource Override | Override UniformDistributedTopic Delivery Failure Parameters, `redelivery-limit` and `expiration-policy`. The JMX test client verifies the serverConfig MBean tree for the expected delivery failure parameters, `redelivery-limit` and `expiration-policy`. |
+| WLDF Resource Override | Override `wldf-instrumentation-monitor` and `harvester` in a diagnostics module. The test client verifies the new instrumentation monitors/harvesters set by getting the WLDF resource from serverConfig tree with expected values.  |
 
 # Directory Configuration and Structure
 

integration-tests/src/test/java/oracle/kubernetes/operator/BaseTest.java

@@ -1,7 +1,6 @@
-// Copyright 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Copyright 2018, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
 // Licensed under the Universal Permissive License v 1.0 as shown at
 // http://oss.oracle.com/licenses/upl.
-
 package oracle.kubernetes.operator;
 
 import java.nio.file.Files;

integration-tests/src/test/java/oracle/kubernetes/operator/ITOperator.java

@@ -358,7 +358,8 @@ public void testAutoAndCustomSitConfigOverrides() throws Exception {
       domainMap.put("configOverrides", "sitconfigcm");
       domainMap.put(
           "configOverridesFile",
-          "/integration-tests/src/test/resources/domain-home-on-pv/customsitconfig");
+          BaseTest.getProjectRoot()
+              + "/integration-tests/src/test/resources/domain-home-on-pv/customsitconfig");
       domainMap.put("domainUID", "customsitdomain");
       domainMap.put("adminNodePort", new Integer("30704"));
       domainMap.put("t3ChannelPort", new Integer("30051"));

integration-tests/src/test/java/oracle/kubernetes/operator/ITSitConfig.java

@@ -0,0 +1,341 @@
+// Copyright 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at
+// http://oss.oracle.com/licenses/upl.
+package oracle.kubernetes.operator;
+
+import static oracle.kubernetes.operator.BaseTest.initialize;
+import static oracle.kubernetes.operator.BaseTest.logger;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Map;
+import java.util.logging.Level;
+import oracle.kubernetes.operator.utils.Domain;
+import oracle.kubernetes.operator.utils.ExecResult;
+import oracle.kubernetes.operator.utils.Operator;
+import oracle.kubernetes.operator.utils.TestUtils;
+import org.junit.AfterClass;
+import org.junit.Assert;
+import org.junit.Assume;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+/** JUnit test class used for testing configuration override use cases. */
+public class ITSitConfig extends BaseTest {
+
+  private static String TEST_RES_DIR;
+  private static String ADMINPODNAME;
+  private static final String DOMAINUID = "customsitconfigdomain";
+  private static final String ADMINPORT = "30710";
+  private static final int T3CHANNELPORT = 30091;
+  private static final String MYSQL_DB_PORT = "31306";
+  private static String fqdn;
+  private static String JDBC_URL;
+  private static String KUBE_EXEC_CMD;
+  private static Domain domain;
+  private static Operator operator1;
+  private static String sitconfigTmpDir = "";
+  private static String mysqltmpDir = "";
+  private static String configOverrideDir = "";
+  private static String mysqlYamlFile = "";
+
+  /**
+   * This method gets called only once before any of the test methods are executed. It does the
+   * initialization of the integration test properties defined in OperatorIT.properties and setting
+   * the resultRoot, pvRoot and projectRoot attributes.
+   *
+   * @throws Exception when the initialization, creating directories , copying files and domain
+   *     creation fails.
+   */
+  @BeforeClass
+  public static void staticPrepare() throws Exception {
+    // initialize test properties and create the directories
+    if (!QUICKTEST) {
+      // initialize test properties and create the directories
+      initialize(APP_PROPS_FILE);
+      if (operator1 == null) {
+        operator1 = TestUtils.createOperator(OPERATOR1_YAML);
+      }
+      TEST_RES_DIR = BaseTest.getProjectRoot() + "/integration-tests/src/test/resources/";
+      sitconfigTmpDir = BaseTest.getResultDir() + "/sitconfigtemp";
+      mysqltmpDir = sitconfigTmpDir + "/mysql";
+      configOverrideDir = sitconfigTmpDir + "/configoverridefiles";
+      mysqlYamlFile = mysqltmpDir + "/mysql-dbservices.yml";
+      Files.createDirectories(Paths.get(sitconfigTmpDir));
+      Files.createDirectories(Paths.get(configOverrideDir));
+      Files.createDirectories(Paths.get(mysqltmpDir));
+      // Create the MySql db container
+      copyMySqlFile();
+      ExecResult result = TestUtils.exec("kubectl create -f " + mysqlYamlFile);
+      Assert.assertEquals(0, result.exitValue());
+
+      fqdn = TestUtils.getHostName();
+      JDBC_URL = "jdbc:mysql://" + fqdn + ":" + MYSQL_DB_PORT + "/";
+      // copy the configuration override files to replacing the JDBC_URL token
+      copySitConfigFiles();
+      // create weblogic domain with configOverrides
+      domain = createSitConfigDomain();
+      Assert.assertNotNull(domain);
+      // copy the jmx test client file the administratioin server weblogic server pod
+      ADMINPODNAME = domain.getDomainUid() + "-" + domain.getAdminServerName();
+      TestUtils.copyFileViaCat(
+          TEST_RES_DIR + "sitconfig/java/SitConfigTests.java",
+          "SitConfigTests.java",
+          ADMINPODNAME,
+          domain.getDomainNS());
+      TestUtils.copyFileViaCat(
+          TEST_RES_DIR + "sitconfig/scripts/runSitConfigTests.sh",
+          "runSitConfigTests.sh",
+          ADMINPODNAME,
+          domain.getDomainNS());
+      KUBE_EXEC_CMD =
+          "kubectl -n " + domain.getDomainNS() + "  exec -it " + ADMINPODNAME + "  -- bash -c";
+    }
+  }
+
+  /**
+   * Destroy domain, delete the MySQL DB container and teardown.
+   *
+   * @throws Exception when domain destruction or MySQL container destruction fails
+   */
+  @AfterClass
+  public static void staticUnPrepare() throws Exception {
+    if (!QUICKTEST) {
+      ExecResult result = TestUtils.exec("kubectl delete -f " + mysqlYamlFile);
+      destroySitConfigDomain();
+      tearDown();
+    }
+  }
+
+  /**
+   * This test covers custom configuration override use cases for config.xml.
+   *
+   * <p>The test checks the overridden config.xml attributes connect-timeout, max-message-size,
+   * restart-max, JMXCore and ServerLifeCycle debug flags, the T3Channel public address. The
+   * overridden are verified against the ServerConfig MBean tree. It does not verifies whether the
+   * overridden values are applied to the runtime.
+   *
+   * @throws Exception when the assertion fails due to unmatched values
+   */
+  @Test
+  public void testCustomSitConfigOverridesForDomain() throws Exception {
+    Assume.assumeFalse(QUICKTEST);
+    boolean testCompletedSuccessfully = false;
+    String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
+    logTestBegin(testMethod);
+    ExecResult result =
+        TestUtils.exec(
+            KUBE_EXEC_CMD
+                + " 'sh runSitConfigTests.sh "
+                + fqdn
+                + " "
+                + T3CHANNELPORT
+                + " weblogic welcome1 "
+                + testMethod
+                + "'");
+    assertResult(result);
+    testCompletedSuccessfully = true;
+    logger.log(Level.INFO, "SUCCESS - {0}", testMethod);
+  }
+
+  /**
+   * This test covers custom resource override use cases for JDBC resource.
+   *
+   * <p>The resource override sets the following connection pool properties. initialCapacity,
+   * maxCapacity, test-connections-on-reserve, connection-harvest-max-count,
+   * inactive-connection-timeout-seconds in the JDBC resource override file. It also overrides the
+   * jdbc driver parameters like data source url, db user and password using kubernetes secret.
+   *
+   * <p>The overridden values are verified against the ServerConfig MBean tree. It does not verifies
+   * whether the overridden values are applied to the runtime except the JDBC URL which is verified
+   * at runtime by making a connection to the MySql database and executing a DDL statement.
+   *
+   * @throws Exception when the assertion fails due to unmatched values
+   */
+  @Test
+  public void testCustomSitConfigOverridesForJdbc() throws Exception {
+    Assume.assumeFalse(QUICKTEST);
+    boolean testCompletedSuccessfully = false;
+    String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
+    logTestBegin(testMethod);
+    ExecResult result =
+        TestUtils.exec(
+            KUBE_EXEC_CMD
+                + " 'sh runSitConfigTests.sh "
+                + fqdn
+                + " "
+                + T3CHANNELPORT
+                + " weblogic welcome1 "
+                + testMethod
+                + " "
+                + JDBC_URL
+                + "'");
+    assertResult(result);
+    testCompletedSuccessfully = true;
+    logger.log(Level.INFO, "SUCCESS - {0}", testMethod);
+  }
+
+  /**
+   * This test covers custom resource use cases for JMS resource. The JMS resource override file
+   * sets the following Delivery Failure Parameters re delivery limit and expiration policy for a
+   * uniform-distributed-topic JMS resource.
+   *
+   * <p>The overridden values are verified against the ServerConfig MBean tree. It does not verifies
+   * whether the overridden values are applied to the runtime.
+   *
+   * @throws Exception when the assertion fails due to unmatched values
+   */
+  @Test
+  public void testCustomSitConfigOverridesForJms() throws Exception {
+    Assume.assumeFalse(QUICKTEST);
+    boolean testCompletedSuccessfully = false;
+    String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
+    logTestBegin(testMethod);
+    ExecResult result =
+        TestUtils.exec(
+            KUBE_EXEC_CMD
+                + " 'sh runSitConfigTests.sh "
+                + fqdn
+                + " "
+                + T3CHANNELPORT
+                + " weblogic welcome1 "
+                + testMethod
+                + "'");
+    assertResult(result);
+    testCompletedSuccessfully = true;
+    logger.log(Level.INFO, "SUCCESS - {0}", testMethod);
+  }
+
+  /**
+   * This test covers custom resource override use cases for diagnostics resource. It adds the
+   * following instrumentation monitors. Connector_After_Inbound, Connector_Around_Outbound,
+   * Connector_Around_Tx, Connector_Around_Work, Connector_Before_Inbound, and harvesters for
+   * weblogic.management.runtime.JDBCServiceRuntimeMBean,
+   * weblogic.management.runtime.ServerRuntimeMBean.
+   *
+   * <p>The overridden values are verified against the ServerConfig MBean tree. It does not verifies
+   * whether the overridden values are applied to the runtime.
+   *
+   * @throws Exception when the assertion fails due to unmatched values
+   */
+  @Test
+  public void testCustomSitConfigOverridesForWldf() throws Exception {
+    Assume.assumeFalse(QUICKTEST);
+    boolean testCompletedSuccessfully = false;
+    String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
+    logTestBegin(testMethod);
+    ExecResult result =
+        TestUtils.exec(
+            KUBE_EXEC_CMD
+                + " 'sh runSitConfigTests.sh "
+                + fqdn
+                + " "
+                + T3CHANNELPORT
+                + " weblogic welcome1 "
+                + testMethod
+                + "'");
+    assertResult(result);
+    testCompletedSuccessfully = true;
+    logger.log(Level.INFO, "SUCCESS - {0}", testMethod);
+  }
+
+  /**
+   * Create Domain using the custom domain script create-domain-auto-custom-sit-config20.py
+   * Customizes the following attributes of the domain map configOverrides, configOverridesFile
+   * domain uid , admin node port and t3 channel port.
+   *
+   * @return - created domain
+   * @throws Exception - if it cannot create the domain
+   */
+  private static Domain createSitConfigDomain() throws Exception {
+    String createDomainScript = TEST_RES_DIR + "/domain-home-on-pv/create-domain.py";
+    // load input yaml to map and add configOverrides
+    Map<String, Object> domainMap = TestUtils.loadYaml(DOMAINONPV_WLST_YAML);
+    domainMap.put("configOverrides", "sitconfigcm");
+    domainMap.put("configOverridesFile", configOverrideDir);
+    domainMap.put("domainUID", DOMAINUID);
+    domainMap.put("adminNodePort", new Integer(ADMINPORT));
+    domainMap.put("t3ChannelPort", new Integer(T3CHANNELPORT));
+    domainMap.put(
+        "createDomainPyScript",
+        "integration-tests/src/test/resources/sitconfig/scripts/create-domain-auto-custom-sit-config20.py");
+    domainMap.put(
+        "javaOptions",
+        "-Dweblogic.debug.DebugSituationalConfig=true -Dweblogic.debug.DebugSituationalConfigDumpXml=true");
+    domain = TestUtils.createDomain(domainMap);
+    domain.verifyDomainCreated();
+    return domain;
+  }
+
+  /**
+   * Destroys the domain.
+   *
+   * @throws Exception when domain destruction fails
+   */
+  private static void destroySitConfigDomain() throws Exception {
+    if (domain != null) {
+      domain.destroy();
+    }
+  }
+
+  /**
+   * Copy the configuration override files to a staging area after replacing the JDBC_URL token in
+   * jdbc-JdbcTestDataSource-0.xml.
+   *
+   * @throws IOException when copying files from source location to staging area fails
+   */
+  private static void copySitConfigFiles() throws IOException {
+    String src_dir = TEST_RES_DIR + "/sitconfig/configoverrides";
+    String dst_dir = configOverrideDir;
+    String files[] = {
+      "config.xml",
+      "jdbc-JdbcTestDataSource-0.xml",
+      "diagnostics-WLDF-MODULE-0.xml",
+      "jms-ClusterJmsSystemResource.xml",
+      "version.txt"
+    };
+    for (String file : files) {
+      Path path = Paths.get(src_dir, file);
+      logger.log(Level.INFO, "Copying {0}", path.toString());
+      Charset charset = StandardCharsets.UTF_8;
+      String content = new String(Files.readAllBytes(path), charset);
+      content = content.replaceAll("JDBC_URL", JDBC_URL);
+      path = Paths.get(dst_dir, file);
+      logger.log(Level.INFO, "to {0}", path.toString());
+      Files.write(path, content.getBytes(charset));
+    }
+  }
+
+  /**
+   * A utility method to copy MySQL yaml template file replacing the NAMESPACE and DOMAINUID.
+   *
+   * @throws IOException when copying files from source location to staging area fails
+   */
+  private static void copyMySqlFile() throws IOException {
+    Path src = Paths.get(TEST_RES_DIR + "/mysql/mysql-dbservices.ymlt");
+    Path dst = Paths.get(mysqlYamlFile);
+    logger.log(Level.INFO, "Copying {0}", src.toString());
+    Charset charset = StandardCharsets.UTF_8;
+    String content = new String(Files.readAllBytes(src), charset);
+    content = content.replaceAll("@NAMESPACE@", "default");
+    content = content.replaceAll("@DOMAIN_UID@", DOMAINUID);
+    logger.log(Level.INFO, "to {0}", dst.toString());
+    Files.write(dst, content.getBytes(charset));
+  }
+
+  /**
+   * Verifies the test run result doesn't contain any errors and exit status is 0.
+   *
+   * @param result - ExecResult object containing result of the test run
+   */
+  private void assertResult(ExecResult result) {
+    logger.log(Level.INFO, result.stdout().trim());
+    Assert.assertFalse(result.stdout().toLowerCase().contains("error"));
+    Assert.assertFalse(result.stderr().toLowerCase().contains("error"));
+    Assert.assertEquals(0, result.exitValue());
+  }
+}