add javadoc

Author: sankarpn

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

@@ -74,7 +74,7 @@ public static void staticPrepare() throws Exception {
    *
    * @throws Exception
    */
-  // @AfterClass
+  @AfterClass
   public static void staticUnPrepare() throws Exception {
     if (!QUICKTEST) {
       logger.info("+++++++++++++++++++++++++++++++++---------------------------------+");
@@ -95,7 +95,7 @@ public static void staticUnPrepare() throws Exception {
    *
    * @throws Exception
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingEnvProperty() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -118,7 +118,7 @@ public void testServerPodsRestartByChangingEnvProperty() throws Exception {
    *
    * @throws Exception
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingLogHomeEnabled() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -140,7 +140,7 @@ public void testServerPodsRestartByChangingLogHomeEnabled() throws Exception {
    *
    * @throws Exception
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingImagePullPolicy() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -163,7 +163,7 @@ public void testServerPodsRestartByChangingImagePullPolicy() throws Exception {
    *
    * @throws Exception
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingIncludeServerOutInPodLog() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -186,7 +186,7 @@ public void testServerPodsRestartByChangingIncludeServerOutInPodLog() throws Exc
    *
    * @throws Exception
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingZImage() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -217,7 +217,7 @@ public void testServerPodsRestartByChangingZImage() throws Exception {
    *     are not restarted or after restart the server yaml file doesn't include the new added
    *     property
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingContSecurityContext() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -254,7 +254,7 @@ public void testServerPodsRestartByChangingContSecurityContext() throws Exceptio
    *     are not restarted or after restart the server yaml file doesn't include the new added
    *     property
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingPodSecurityContext() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -292,7 +292,7 @@ public void testServerPodsRestartByChangingPodSecurityContext() throws Exception
    *     are not restarted or after restart the server yaml file doesn't include the new added
    *     property
    */
-  // @Test
+  @Test
   public void testServerPodsRestartByChangingResource() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     String testMethodName = new Object() {}.getClass().getEnclosingMethod().getName();
@@ -320,6 +320,13 @@ public void testServerPodsRestartByChangingResource() throws Exception {
     logger.info("SUCCESS - " + testMethodName);
   }
 
+  /**
+   * Add restartVersion:v1.1 at adminServer level and verify the admin pod is Terminated and
+   * recreated
+   *
+   * @throws Exception when domain.yaml cannot be read or modified to include the
+   *     restartVersion:v1.1
+   */
   @Test
   public void testAdminServerRestartVersion() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -362,6 +369,13 @@ public void testAdminServerRestartVersion() throws Exception {
     logger.log(Level.INFO, "SUCCESS - {0}", testMethodName);
   }
 
+  /**
+   * Add restartVersion:v1.1 at cluster level and verify the managed servers pods are Terminated and
+   * recreated
+   *
+   * @throws Exception when domain.yaml cannot be read or modified to include the
+   *     restartVersion:v1.1
+   */
   @Test
   public void testClusterRestartVersion() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -402,6 +416,13 @@ public void testClusterRestartVersion() throws Exception {
     logger.log(Level.INFO, "SUCCESS - {0}", testMethodName);
   }
 
+  /**
+   * Add restartVersion:v1.1 at managed server level and verify the managed server pod are
+   * Terminated and recreated
+   *
+   * @throws Exception when domain.yaml cannot be read or modified to include the
+   *     restartVersion:v1.1
+   */
   @Test
   public void testMSRestartVersion() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -444,6 +465,13 @@ public void testMSRestartVersion() throws Exception {
     logger.log(Level.INFO, "SUCCESS - {0}", testMethodName);
   }
 
+  /**
+   * Add restartVersion:v1.1 at doamin level and verify all of the server pods are Terminated and
+   * recreated
+   *
+   * @throws Exception when domain.yaml cannot be read or modified to include the
+   *     restartVersion:v1.1
+   */
   @Test
   public void testDomainRestartVersion() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -514,6 +542,13 @@ private static void destroyPodsRestartdomain() throws Exception {
     }
   }
 
+  /**
+   * Utility method to check if a pod is in Terminating or Running status
+   *
+   * @param podName - String name of the pod to check the status for
+   * @param podStatusExpected - String the expected status of Terminating || RUnning
+   * @throws InterruptedException when thread is interrupted
+   */
   private void verifyPodStatus(String podName, String podStatusExpected)
       throws InterruptedException {
     K8sTestUtils testUtil = new K8sTestUtils();

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

@@ -347,6 +347,13 @@ public void verifyNoClusterRoleBindings(String labelSelectors) throws Exception
     assertEquals("Number of cluster role bindings", v1ClusterRoleBindingList.getItems().size(), 0);
   }
 
+  /**
+   * Utility method to get the pods in a namespace filtered by given label
+   *
+   * @param namespace - String namespace in which to look for the pods
+   * @param labelSelectors - String selector to filter the pods in the name space
+   * @return - V1PodList List of the pods in the given name space.
+   */
   public V1PodList getPods(String namespace, String labelSelectors) {
     V1PodList v1PodList = null;
     try {
@@ -373,6 +380,14 @@ public V1PodList getPods(String namespace, String labelSelectors) {
     return v1PodList;
   }
 
+  /**
+   * Utility method to get a pod matching the given name
+   *
+   * @param namespace - String namespace in which to look for the pods
+   * @param labelSelectors - String selector to filter the pods in the name space
+   * @param podName - String name of the pod to query for
+   * @return V1Pod object matching the podName
+   */
   public V1Pod getPod(String namespace, String labelSelectors, String podName) {
     List<V1Pod> pods = getPods(namespace, labelSelectors).getItems();
     for (V1Pod pod : pods) {
@@ -384,6 +399,16 @@ public V1Pod getPod(String namespace, String labelSelectors, String podName) {
     return null;
   }
 
+  /**
+   * Utility method to determine if a pod is in Terminating status It detects the Terminating status
+   * by looking at the metadata.getDeletionTimestamp field, a non null value means the pod is
+   * terminating.
+   *
+   * @param namespace - String namespace in which to look for the pods
+   * @param labelSelectors - String selector to filter the pods in the name space
+   * @param podName - String name of the pod to query for
+   * @return boolean true if the pod is in Terminating status
+   */
   public boolean isPodTerminating(String namespace, String labelSelectors, String podName) {
     V1ObjectMeta metadata = getPod(namespace, labelSelectors, podName).getMetadata();
     if (metadata.getDeletionTimestamp() != null) {
@@ -394,6 +419,15 @@ public boolean isPodTerminating(String namespace, String labelSelectors, String
     return metadata.getDeletionTimestamp() != null;
   }
 
+  /**
+   * Utility method to determine if a pod is in Running status It detects the Running status by
+   * looking at the metadata.getDeletionTimestamp field, a null value means the pod is Running.
+   *
+   * @param namespace - String namespace in which to look for the pods
+   * @param labelSelectors - String selector to filter the pods in the name space
+   * @param podName - String name of the pod to query for
+   * @return boolean true if the pod is in Terminating status
+   */
   public boolean isPodRunning(String namespace, String labelSelectors, String podName) {
     return !isPodTerminating(namespace, labelSelectors, podName);
   }