add javadoc style method description

Author: [email protected]

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

@@ -1,4 +1,4 @@
-// Copyright 2018, Oracle Corporation and/or its affiliates.  All rights reserved.
+// 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.
 
@@ -71,8 +71,9 @@ public static void staticUnPrepare() throws Exception {
   }
 
   /**
-   * The property tested is: env: "-Dweblogic.StdoutDebugEnabled=false"-->
-   * "-Dweblogic.StdoutDebugEnabled=true"
+   * Modify the domain scope env property on the domain resource using kubectl apply -f domain.yaml
+   * Verify that all the server pods in the domain got re-started The property tested is: env:
+   * "-Dweblogic.StdoutDebugEnabled=false"--> "-Dweblogic.StdoutDebugEnabled=true"
    *
    * @throws Exception
    */
@@ -94,7 +95,9 @@ public void testServerPodsRestartByChangingEnvProperty() throws Exception {
   }
 
   /**
-   * The property tested is: logHomeEnabled: true --> logHomeEnabled: false
+   * Modify the domain scope property on the domain resource using kubectl apply -f domain.yaml
+   * Verify that all the server pods in the domain got re-started The property tested is:
+   * logHomeEnabled: true --> logHomeEnabled: false
    *
    * @throws Exception
    */
@@ -116,7 +119,9 @@ public void testServerPodsRestartByChangingLogHomeEnabled() throws Exception {
   }
 
   /**
-   * The property tested is: imagePullPolicy: IfNotPresent --> imagePullPolicy: Never
+   * Modify the domain scope property on the domain resource using kubectl apply -f domain.yaml
+   * Verify that all the server pods in the domain got re-started The property tested is:
+   * imagePullPolicy: IfNotPresent --> imagePullPolicy: Never
    *
    * @throws Exception
    */
@@ -139,7 +144,9 @@ public void testServerPodsRestartByChangingImagePullPolicy() throws Exception {
   }
 
   /**
-   * The property tested is: includeServerOutInPodLog: true --> includeServerOutInPodLog: false
+   * Modify the domain scope property on the domain resource using kubectl apply -f domain.yaml
+   * Verify that all the server pods in the domain got re-started The property tested is:
+   * includeServerOutInPodLog: true --> includeServerOutInPodLog: false
    *
    * @throws Exception
    */
@@ -162,8 +169,9 @@ public void testServerPodsRestartByChangingIncludeServerOutInPodLog() throws Exc
   }
 
   /**
-   * The property tested is: image: "store/oracle/weblogic:12.2.1.3" --> image:
-   * "store/oracle/weblogic:duplicate"
+   * Modify the domain scope property on the domain resource using kubectl apply -f domain.yaml
+   * Verify that all the server pods in the domain got re-started The property tested is: image:
+   * "store/oracle/weblogic:12.2.1.3" --> image: "store/oracle/weblogic:duplicate"
    *
    * @throws Exception
    */
@@ -193,8 +201,6 @@ private static Domain createPodsRestartdomain() throws Exception {
 
     Map<String, Object> domainMap = TestUtils.loadYaml(DOMAINONPV_WLST_YAML);
     domainMap.put("domainUID", "domainpodsrestart");
-    domainMap.put("adminNodePort", new Integer("30707"));
-    domainMap.put("t3ChannelPort", new Integer("30081"));
     domainMap.put("initialManagedServerReplicas", new Integer("1"));
 
     logger.info("Creating Domain domain& verifing the domain creation");

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

@@ -850,6 +850,13 @@ private void createPV() throws Exception {
     new PersistentVolume("/scratch/acceptance_test_pv/persistentVolume-" + domainUid, pvMap);
   }
 
+  /**
+   * verify domain server pods get restarted after a property change
+   *
+   * @param oldPropertyString
+   * @param newPropertyString
+   * @throws Exception
+   */
   public void testDomainServerPodRestart(String oldPropertyString, String newPropertyString)
       throws Exception {
     logger.info("Inside testDomainServerPodRestart");
@@ -900,6 +907,11 @@ public void testDomainServerPodRestart(String oldPropertyString, String newPrope
     logger.info("Done - testDomainServerPodRestart");
   }
 
+  /**
+   * verify that admin server pod gets restarted.
+   *
+   * @throws Exception
+   */
   public void verifyAdminServerRestarted() throws Exception {
     logger.info("Checking if admin pod(" + domainUid + "-" + adminServerName + ") is Terminating");
     TestUtils.checkPodTerminating(domainUid + "-" + adminServerName, domainNS);
@@ -909,6 +921,11 @@ public void verifyAdminServerRestarted() throws Exception {
     Thread.sleep(10 * 1000);
   }
 
+  /**
+   * verify that managed server pods get restarted.
+   *
+   * @throws Exception
+   */
   public void verifyManagedServersRestarted() throws Exception {
     if (domainMap.get("serverStartPolicy") == null
         || (domainMap.get("serverStartPolicy") != null

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

@@ -1105,14 +1105,26 @@ public static void copyFile(String fromFile, String toFile) throws Exception {
 
     Files.copy(new File(fromFile).toPath(), Paths.get(toFile), StandardCopyOption.REPLACE_EXISTING);
   }
-
+  /**
+   * tag image with docker cmd: docker tage sourceImageName targetImageName
+   *
+   * @param sourceImage
+   * @param targetImage
+   * @throws Exception
+   */
   public static void dockerTagImage(String sourceImage, String targetImage) throws Exception {
     logger.info("Tagging souceImage:  " + sourceImage + "  to " + targetImage);
     String dockerCmd = "docker tag " + sourceImage + " " + targetImage;
     logger.info("Executing cmd " + dockerCmd);
     exec(dockerCmd);
   }
 
+  /**
+   * remove image with docker cmd: docker rmi -f imageName
+   *
+   * @param imageName
+   * @throws Exception
+   */
   public static void dockerRemoveImage(String imageName) throws Exception {
     logger.info("Removing image:  " + imageName);
     String dockerCmd = "docker rmi -f  " + imageName;