cleanup and add java doc

Author: sankarpn

integration-tests/USECASES.MD

@@ -134,3 +134,11 @@ Configuration Overrides Usecases
 | Search log level | Use Elasticsearch Count API to query logs of level=INFO and verify that total number of logs for level=INFO is not zero and failed count is zero |
 | Search Operator log | Use Elasticsearch Search APIs to query Operator log info and verify that log hits for type=weblogic-operator are not empty |
 | Search Weblogic log | Use Elasticsearch Search APIs to query Weblogic log info and verify that log hits for Weblogic servers are not empty |
+
+| Operator Upgrade | Use Case |
+| --- | --- |
+| Upgrade 2.0 operator to develop | Upgrade the 2.0 operator running a Weblogic domain to develop version of the Operator and verify apiVersion of the domain CRD shows v4 |
+| Upgrade 2.0.1 operator to develop | Upgrade the 2.0.1 operator running a Weblogic domain to develop version of the Operator and verify apiVersion of the domain CRD shows v4 |
+| Upgrade 2.1 operator to develop | Upgrade the 2.1 operator running a Weblogic domain to develop version of the Operator and verify apiVersion of the domain CRD shows v4 |
+| Upgrade 2.2.0 operator to develop | Upgrade the 2.2.0 operator running a Weblogic domain to develop version of the Operator and verify apiVersion of the domain CRD shows v4 |
+| Upgrade 2.2.1 operator to develop | Upgrade the 2.2.1 operator running a Weblogic domain to develop version of the Operator and verify apiVersion of the domain CRD shows v4 |

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

@@ -24,11 +24,7 @@
 import org.junit.Test;
 import org.junit.runners.MethodSorters;
 
-/**
- * Simple JUnit test file used for testing Operator.
- *
- * <p>This test is used for testing Helm install for Operator(s)
- */
+/** Operator upgrade JUnit test file testing the operator upgrade from older releases to develop. */
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class ITOperatorUpgrade extends BaseTest {
 
@@ -44,6 +40,15 @@ public class ITOperatorUpgrade extends BaseTest {
   private Domain domain = null;
   private static Operator operator;
 
+  /**
+   * Creates operator based on operatorRelease passed to it and then creates a Weblogic domain
+   * controlled by that operator
+   *
+   * @param operatorGitRelease Git branch name of the operator release version
+   * @param operatorRelease Operator release version from the
+   *     https://hub.docker.com/r/oracle/weblogic-kubernetes-operator/tags
+   * @throws Exception when operator or domain creation fails
+   */
   private void setupOperatorAndDomain(String operatorGitRelease, String operatorRelease)
       throws Exception {
     logger.log(Level.INFO, "+++++++++++++++Beginning Test Setup+++++++++++++++++++++");
@@ -62,21 +67,26 @@ private void setupOperatorAndDomain(String operatorGitRelease, String operatorRe
     List<String> dom_ns = new ArrayList<String>();
     dom_ns.add(DOM_NS);
     operatorMap.put("domainNamespaces", dom_ns);
-    operator = TestUtils.createOperator(operatorMap, Operator.RESTCertType.LEGACY);
-    TestUtils.ExecAndPrintLog("kubectl get all --all-namespaces");
+    operator = TestUtils.createOperator(operatorMap, Operator.RestCertType.LEGACY);
+    TestUtils.exec("kubectl get all --all-namespaces", true);
 
     Map<String, Object> wlstDomainMap = TestUtils.loadYaml(DOMAININIMAGE_WLST_YAML);
     wlstDomainMap.put("domainUID", DUID);
     wlstDomainMap.put("namespace", DOM_NS);
     wlstDomainMap.put("projectRoot", opUpgradeTmpDir + "/weblogic-kubernetes-operator");
     domain = TestUtils.createDomain(wlstDomainMap);
-    TestUtils.ExecAndPrintLog("kubectl get all --all-namespaces");
+    TestUtils.exec("kubectl get all --all-namespaces", true);
     domain.verifyPodsCreated();
     domain.verifyServicesCreated();
     domain.verifyServersReady();
     logger.log(Level.INFO, "+++++++++++++++Ending Test Setup+++++++++++++++++++++");
   }
 
+  /**
+   * cleanup the domain and operator after every test
+   *
+   * @throws Exception when domain and operator cleanup fails
+   */
   @After
   public void cleanupOperatorAndDomain() throws Exception {
     logger.log(Level.INFO, "+++++++++++++++Beginning AfterTest cleanup+++++++++++++++++++++");
@@ -87,23 +97,23 @@ public void cleanupOperatorAndDomain() throws Exception {
       operator.destroy();
     }
     ExecResult result = cleanup();
-    TestUtils.ExecAndPrintLog(
+    TestUtils.exec(
         "kubectl delete pods,services,deployments,replicasets,configmaps,services --all  --ignore-not-found -n "
             + OP_NS);
-    TestUtils.ExecAndPrintLog(
+    TestUtils.exec(
         "kubectl delete pods,services,deployments,replicasets,configmaps,services --all  --ignore-not-found -n "
             + DOM_NS);
-    TestUtils.ExecAndPrintLog("kubectl delete crd --all --ignore-not-found");
-    TestUtils.ExecAndPrintLog("kubectl delete ns " + OP_NS + " --ignore-not-found");
-    TestUtils.ExecAndPrintLog("kubectl delete ns " + DOM_NS + " --ignore-not-found");
-    TestUtils.ExecAndPrintLog("kubectl get all --all-namespaces");
+    TestUtils.exec("kubectl delete crd --all --ignore-not-found");
+    TestUtils.exec("kubectl delete ns " + OP_NS + " --ignore-not-found");
+    TestUtils.exec("kubectl delete ns " + DOM_NS + " --ignore-not-found");
+    TestUtils.exec("kubectl get all --all-namespaces");
     logger.log(Level.INFO, "+++++++++++++++Done AfterTest cleanup+++++++++++++++++++++");
   }
 
   /**
    * Releases k8s cluster lease, archives result, pv directories
    *
-   * @throws Exception
+   * @throws Exception when deleting pv directories or other tearDown tasks fail.
    */
   @AfterClass
   public static void staticUnPrepare() throws Exception {
@@ -116,6 +126,11 @@ public static void staticUnPrepare() throws Exception {
     }
   }
 
+  /**
+   * Test for upgrading Operator from release 2.0 to develop branch
+   *
+   * @throws Exception when upgrade fails
+   */
   @Test
   public void testOperatorUpgradeFrom2_0() throws Exception {
     String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -130,6 +145,11 @@ public void testOperatorUpgradeFrom2_0() throws Exception {
     logger.info("SUCCESS - " + testMethod);
   }
 
+  /**
+   * Test for upgrading Operator from release 2.0.1 to develop branch
+   *
+   * @throws Exception when upgrade fails
+   */
   @Test
   public void testOperatorUpgradeFrom2_0_1() throws Exception {
     String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -144,6 +164,11 @@ public void testOperatorUpgradeFrom2_0_1() throws Exception {
     logger.info("SUCCESS - " + testMethod);
   }
 
+  /**
+   * Test for upgrading Operator from release 2.1 to develop branch
+   *
+   * @throws Exception when upgrade fails
+   */
   @Test
   public void testOperatorUpgradeFrom2_1() throws Exception {
     String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -158,6 +183,11 @@ public void testOperatorUpgradeFrom2_1() throws Exception {
     logger.info("SUCCESS - " + testMethod);
   }
 
+  /**
+   * Test for upgrading Operator from release 2.2.0 to develop branch
+   *
+   * @throws Exception when upgrade fails
+   */
   @Test
   public void testOperatorUpgradeFrom2_2_0() throws Exception {
     String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -172,6 +202,11 @@ public void testOperatorUpgradeFrom2_2_0() throws Exception {
     logger.info("SUCCESS - " + testMethod);
   }
 
+  /**
+   * Test for upgrading Operator from release 2.2.1 to develop branch
+   *
+   * @throws Exception when upgrade fails
+   */
   @Test
   public void testOperatorUpgradeFrom2_2_1() throws Exception {
     String testMethod = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -186,25 +221,35 @@ public void testOperatorUpgradeFrom2_2_1() throws Exception {
     logger.info("SUCCESS - " + testMethod);
   }
 
+  /**
+   * Upgrades operator to develop branch by using the helm upgrade
+   *
+   * @param restart boolean parameter used to determine if a restart of domain is checked
+   * @throws Exception when upgrade fails or basic usecase testing or scaling fails.
+   */
   private void upgradeOperator(boolean restart) throws Exception {
     operator.callHelmUpgrade("image=" + OP_TARGET_RELEASE);
     if (restart) {
       checkDomainRollingRestarted();
     }
-    checkOperatorVersion(DOM_TARGET_RELEASE_VERSION);
+    checkOperatorVersion();
     testBasicUseCases(domain);
     testClusterScaling(operator, domain);
   }
 
-  private void checkOperatorVersion(String version) throws Exception {
+  /**
+   * checks the expected version of the upgraded operator in a loop. In Jenkins it takes nearly 8
+   * minutes to show the updated value of the domain CRD
+   *
+   * @throws Exception when version does not match
+   */
+  private void checkOperatorVersion() throws Exception {
     boolean result = false;
     logger.log(Level.INFO, "Checking for the domain apiVersion in a loop for up to 15 minutes");
     for (int i = 0; i < 900; i = i + 10) {
-      TestUtils.ExecAndPrintLog(
-          "kubectl get domain -n " + DOM_NS + "  " + DUID + " -o jsonpath={.apiVersion}");
       ExecResult exec =
           TestUtils.exec(
-              "kubectl get domain -n " + DOM_NS + "  " + DUID + " -o jsonpath={.apiVersion}");
+              "kubectl get domain -n " + DOM_NS + "  " + DUID + " -o jsonpath={.apiVersion}", true);
       if (exec.stdout().contains(DOM_TARGET_RELEASE_VERSION)) {
         logger.log(Level.INFO, "Got the expected apiVersion");
         result = true;
@@ -217,6 +262,11 @@ private void checkOperatorVersion(String version) throws Exception {
     }
   }
 
+  /**
+   * Check whether the weblogic server instances are rolling restarted
+   *
+   * @throws Exception If restart fails or not restarted
+   */
   private void checkDomainRollingRestarted() throws Exception {
     domain.verifyAdminServerRestarted();
     TestUtils.checkPodReady(DUID + "-" + domain.getAdminServerName(), DOM_NS);
@@ -228,10 +278,4 @@ private void checkDomainRollingRestarted() throws Exception {
       TestUtils.checkPodReady(DUID + "-managed-server" + i, DOM_NS);
     }
   }
-
-  private void printCompVersions() throws Exception {
-    TestUtils.ExecAndPrintLog("docker images");
-    TestUtils.ExecAndPrintLog("kubectl get pods -n " + OP_NS + " -o yaml");
-    TestUtils.ExecAndPrintLog("kubectl get domain " + DUID + " -o yaml -n " + DOM_NS);
-  }
 }

integration-tests/src/test/java/oracle/kubernetes/operator/utils/Domain.java

@@ -29,7 +29,6 @@
 import javax.jms.QueueConnectionFactory;
 import javax.naming.Context;
 import javax.naming.InitialContext;
-
 import oracle.kubernetes.operator.BaseTest;
 import org.yaml.snakeyaml.Yaml;
 
@@ -1381,20 +1380,16 @@ protected void initialize(Map<String, Object> inputDomainMap) throws Exception {
 
     // copy samples to RESULT_DIR
     if (domainMap.containsKey("projectRoot")) {
-      logger.log(
-          Level.INFO,
-          "Copying "
-              + domainMap.get("projectRoot")
-              + "/kubernetes/samples to "
-              + BaseTest.getResultDir());
       TestUtils.exec(
           "cp -rf "
               + domainMap.get("projectRoot")
               + "/kubernetes/samples "
-              + BaseTest.getResultDir());
+              + BaseTest.getResultDir(),
+          true);
     } else {
       TestUtils.exec(
-          "cp -rf " + BaseTest.getProjectRoot() + "/kubernetes/samples " + BaseTest.getResultDir());
+          "cp -rf " + BaseTest.getProjectRoot() + "/kubernetes/samples " + BaseTest.getResultDir(),
+          true);
     }
 
     this.voyager =

integration-tests/src/test/java/oracle/kubernetes/operator/utils/Operator.java

@@ -10,14 +10,13 @@
 import java.util.ArrayList;
 import java.util.Map;
 import java.util.logging.Logger;
-
 import oracle.kubernetes.operator.BaseTest;
 
 /** Operator class with all the utility methods for Operator. */
 public class Operator {
 
-  public static final String CREATE_OPERATOR_SCRIPT_MESSAGE
-      = "The Oracle WebLogic Server Kubernetes Operator is deployed";
+  public static final String CREATE_OPERATOR_SCRIPT_MESSAGE =
+      "The Oracle WebLogic Server Kubernetes Operator is deployed";
   private static final Logger logger = Logger.getLogger("OperatorIT", "OperatorIT");
   private static int maxIterationsOp = BaseTest.getMaxIterationsPod(); // 50 * 5 = 250 seconds
   private static int waitTimeOp = BaseTest.getWaitTimePod();
@@ -303,7 +302,7 @@ public void callHelmInstall() throws Exception {
     StringBuffer cmd = new StringBuffer("");
     if (operatorMap.containsKey("operatorGitVersion")
         && operatorMap.containsKey("operatorGitVersionDir")) {
-      TestUtils.ExecAndPrintLog(
+      TestUtils.exec(
           "cd "
               + operatorMap.get("operatorGitVersionDir")
               + " && git clone -b "
@@ -328,7 +327,6 @@ public void callHelmInstall() throws Exception {
         .append(imagePullPolicy)
         .append("\" --wait --timeout 60");
     logger.info("Running " + cmd);
-    TestUtils.ExecAndPrintLog("cat " + generatedInputYamlFile);
     ExecResult result = ExecCommand.exec(cmd.toString());
     if (result.exitValue() != 0) {
       reportHelmFailure(cmd.toString(), result);

integration-tests/src/test/java/oracle/kubernetes/operator/utils/TestUtils.java

@@ -28,7 +28,6 @@
 import javax.ws.rs.core.HttpHeaders;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
-
 import oracle.kubernetes.operator.BaseTest;
 import oracle.kubernetes.operator.utils.Operator.RestCertType;
 import org.glassfish.jersey.jsonp.JsonProcessingFeature;
@@ -42,6 +41,7 @@ public class TestUtils {
 
   /**
    * Checks if pod is ready.
+   *
    * @param podName pod name
    * @param domainNS namespace
    * @throws Exception exception
@@ -73,6 +73,7 @@ public static void checkPodReady(String podName, String domainNS, String contain
 
   /**
    * Checks that pod is created.
+   *
    * @param podName - pod name
    * @param domainNS - domain namespace name
    */
@@ -103,6 +104,7 @@ public static void checkPodTerminating(String podName, String domainNS) throws E
 
   /**
    * Checks that service is created.
+   *
    * @param serviceName service name
    * @param domainNS namespace
    * @throws Exception exception
@@ -144,6 +146,7 @@ public static void checkServiceCreated(String serviceName, String domainNS) thro
 
   /**
    * Creates input file.
+   *
    * @param map - map with attributes
    * @param generatedInputYamlFile - output file with replaced values
    * @throws Exception exception
@@ -742,7 +745,7 @@ public static Operator createOperator(String opYamlFile, RestCertType restCertTy
     return operator;
   }
 
-  public static Operator createOperator(Map<String, Object> inputMap, RESTCertType restCertType)
+  public static Operator createOperator(Map<String, Object> inputMap, RestCertType restCertType)
       throws Exception {
     // create op
     Operator operator = new Operator(inputMap, restCertType);
@@ -751,7 +754,7 @@ public static Operator createOperator(Map<String, Object> inputMap, RESTCertType
     logger.info("Check Operator status");
     operator.verifyPodCreated();
     operator.verifyOperatorReady();
-    operator.verifyExternalRESTService();
+    operator.verifyExternalRestService();
 
     return operator;
   }