Added more javadocs and copyright texts

Author: sankarpn

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/ITSitConfig.java

@@ -234,6 +234,14 @@ public void testCustomSitConfigOverridesForWldf() throws Exception {
     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 = TESTSCRIPTDIR + "/domain-home-on-pv/create-domain.py";
     // load input yaml to map and add configOverrides
@@ -254,12 +262,23 @@ private static Domain createSitConfigDomain() throws Exception {
     return domain;
   }
 
+  /**
+   * Destroys the domain
+   *
+   * @throws Exception
+   */
   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
+   */
   private static void copySitConfigFiles() throws IOException {
     String src_dir = TESTSCRIPTDIR + "/sitconfig/configoverrides";
     String dst_dir = sitconfigDir;
@@ -282,6 +301,11 @@ private static void copySitConfigFiles() throws IOException {
     }
   }
 
+  /**
+   * 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"));

integration-tests/src/test/resources/sitconfig/java/SitConfigTests.java

@@ -38,10 +38,7 @@
 import weblogic.management.configuration.WLDFSystemResourceMBean;
 import weblogic.management.jmx.MBeanServerInvocationHandler;
 import weblogic.management.mbeanservers.domainruntime.DomainRuntimeServiceMBean;
-import weblogic.management.mbeanservers.edit.ConfigurationManagerMBean;
-import weblogic.management.mbeanservers.edit.EditServiceMBean;
 import weblogic.management.mbeanservers.runtime.RuntimeServiceMBean;
-import weblogic.management.runtime.DomainRuntimeMBean;
 import weblogic.management.runtime.ServerRuntimeMBean;
 
 /**
@@ -64,17 +61,11 @@
  */
 public class SitConfigTests {
 
-  private MBeanServerConnection domainRuntimeMbs, editMbs, runtimeMbs;
+  private MBeanServerConnection runtimeMbs;
   private JMXConnector jmxConnector;
   private static ObjectName service;
-  private DomainRuntimeMBean domainRuntimeMBean;
-  private DomainRuntimeServiceMBean domainServiceMBean;
   private RuntimeServiceMBean runtimeServiceMBean;
   private ServerRuntimeMBean serverRuntime;
-  private EditServiceMBean editServiceMBean;
-
-  private DomainMBean editdomain, editTree;
-  private ConfigurationManagerMBean cfgMgr;
   private static final String JNDI = "/jndi/";
 
   private final String adminHost;
@@ -129,12 +120,12 @@ public static void main(String args[]) throws Exception {
   }
 
   /**
-   * Constructor
+   * Create connections to the MBean servers when the class is instantiated.
    *
-   * @param adminHost
-   * @param adminPort
-   * @param adminUser
-   * @param adminPassword
+   * @param adminHost - administration server t3 public address
+   * @param adminPort - administration server t3 public port
+   * @param adminUser - administration server user name
+   * @param adminPassword - - administration server password
    * @throws Exception
    */
   public SitConfigTests(String adminHost, String adminPort, String adminUser, String adminPassword)
@@ -146,6 +137,12 @@ public SitConfigTests(String adminHost, String adminPort, String adminUser, Stri
     createConnections();
   }
 
+  /**
+   * This method creates connection to the RuntimeMBean server Looks up the RuntimeService,
+   * DomainRuntimeService and EditService MBeans needed by the tests.
+   *
+   * @throws Exception
+   */
   private void createConnections() throws Exception {
     runtimeMbs =
         lookupMBeanServerConnection(
@@ -154,40 +151,31 @@ private void createConnections() throws Exception {
             adminUser,
             adminPassword,
             RuntimeServiceMBean.MBEANSERVER_JNDI_NAME);
-    domainRuntimeMbs =
-        lookupMBeanServerConnection(
-            adminHost,
-            adminPort,
-            adminUser,
-            adminPassword,
-            DomainRuntimeServiceMBean.MBEANSERVER_JNDI_NAME);
-    editMbs =
-        lookupMBeanServerConnection(
-            adminHost, adminPort, adminUser, adminPassword, EditServiceMBean.MBEANSERVER_JNDI_NAME);
-
     ObjectName runtimeserviceObjectName = new ObjectName(RuntimeServiceMBean.OBJECT_NAME);
     runtimeServiceMBean =
         (RuntimeServiceMBean)
             MBeanServerInvocationHandler.newProxyInstance(runtimeMbs, runtimeserviceObjectName);
-
     ObjectName domainServiceObjectName = new ObjectName(DomainRuntimeServiceMBean.OBJECT_NAME);
-    domainServiceMBean =
-        (DomainRuntimeServiceMBean)
-            MBeanServerInvocationHandler.newProxyInstance(
-                domainRuntimeMbs, domainServiceObjectName);
-
-    ObjectName editserviceObjectName = new ObjectName(EditServiceMBean.OBJECT_NAME);
-    editServiceMBean =
-        (EditServiceMBean)
-            MBeanServerInvocationHandler.newProxyInstance(editMbs, editserviceObjectName);
   }
 
+  /**
+   * Method for creating a connection to a specific Mbean Server Accepts the following parameters
+   *
+   * @param host - Administration server hostname
+   * @param adminPort - Administration server T3 channel port
+   * @param user - - Administration server user name
+   * @param adminPassword - - Administration server password
+   * @param jndiName - jndi name of the MBean server
+   * @return MBeanServerConnection - MBean server connection created
+   * @throws MalformedURLException - throws MalformedURLException when URL is wrong
+   * @throws IOException - throws IOException when it cannot connect the MBean server
+   * @throws Exception - throws Exceptioni when created MBeanserver connection is null.
+   */
   private MBeanServerConnection lookupMBeanServerConnection(
       String host, String adminPort, String user, String adminPassword, String jndiName)
       throws MalformedURLException, IOException, Exception {
     JMXServiceURL serviceURL;
     MBeanServerConnection mBeanServerConnection;
-
     println(
         "Host: "
             + adminHost
@@ -331,6 +319,11 @@ protected void verifyT3ChannelMaxMessageSize(int expectedValue) {
     }
   }
 
+  /**
+   * Looks up the ServerMBean from RuntimeServiceMBean
+   *
+   * @return
+   */
   private ServerMBean getServerMBean() {
     ServerMBean serverMBean = runtimeServiceMBean.getServerConfiguration();
     println("ServerMBean: " + serverMBean);
@@ -555,6 +548,11 @@ protected WLDFSystemResourceMBean getWLDFSystemModule(String resourceName) {
     return wldfResource;
   }
 
+  /**
+   * prints messages
+   *
+   * @param msg - message to print
+   */
   protected static void println(String msg) {
     System.out.println("> " + msg);
   }

integration-tests/src/test/resources/sitconfig/mysql/mysql-dbservices.yml

@@ -1,3 +1,6 @@
+# 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.
+
 apiVersion: v1
 kind: Namespace
 metadata:

integration-tests/src/test/resources/sitconfig/scripts/runSitConfigTests.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+# 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.
 
 ## The script is copied to the administration server weblogic server
 ## pod along with the SitConfigTests.java source file by the JUnit test