changes for review comments

Author: vanajamukkara

integration-tests/README.md

@@ -98,7 +98,7 @@ externalRestEnabled: true
 javaLoggingLevel: FINE
 ```
 
-src/integration-tests/resources/domainonpvwlst.yaml - See "Input Yaml to the test". For all the properties that are not defined here, the default values in the sample inputs are used while generating inputs yaml.
+src/integration-tests/resources/domainonpvwlst.yaml - See [Input Yaml to the test](#input-yaml-to-the-test). For all the properties that are not defined here, the default values in the sample inputs are used while generating inputs yaml.
 
 ```
 adminServerName: admin-server
@@ -126,7 +126,7 @@ The input yaml file(for example, domainonpvwlst.yaml) to the java test is used t
 - custom attributes that are used to provide more flexibility for creating the domain.
 
 Below are the load balancer attributes:
-- loadBalancer: value can be TRAEFIK or VOYAGER, default is TRAEFIK
+- loadBalancer: value can be `TRAEFIK` or `VOYAGER`, default is `TRAEFIK`
 - loadBalancerWebPort: web port for the load balancer
 - ingressPerDomain: create ingress per domain or one ingress for all domains in multiple domain configuration, default is true. 
 

integration-tests/USECASES.MD

@@ -2,22 +2,22 @@
 
 Java integration tests cover the below use cases:
 
-Quick test Configuration & Use Cases - 
+## Quick test Configuration & Use Cases - 
 
 |  |  |
 | --- | --- |
 | Operator Configuration | operator1 deployed in `weblogic-operator1` namespace and manages domains in `default` and `test1` namespaces |
 | Domain Configuration | Domain on PV using WLST, Traefik load balancer |
 
-Basic Use Cases
+**Basic Use Cases**
 
 1. Create operator `operator1` which manages `default` and `test1` namespaces, verify it's deployed successfully, pods created, operator ready and verify external REST service, if configured.
 2. Create domain `domain1` in `default` namespace and verify the pods, services are created and servers are in ready state.
 3. Verify the admin external service by accessing the admin REST endpoint with `nodeport` in URL.
 4. Verify admin t3 channel port by exec into the admin pod and deploying webapp using the channel port for WLST.
 5. Verify web app load balancing by accessing the webapp using `loadBalancerWebPort`.
 
-Advanced Use Cases
+**Advanced Use Cases**
 
 6. Verify domain life cycle (destroy and create) should not have any impact on operator managing the domain and web app load balancing and admin external service.
 7. Cluster scale up/down using operator REST endpoint, webapp load balancing should adjust accordingly.
@@ -29,7 +29,7 @@ Also the below use cases are covered for Quick test:
 10. Shutdown the domain by changing domain `serverStartPolicy` to `NEVER`.
 
 
-Full test Configuration & Use Cases - Runs Quick test Configuration & Use cases and the below
+## Full test Configuration & Use Cases - Runs Quick test Configuration & Use cases and the below
 
 |  |  |
 | --- | --- |
@@ -74,9 +74,7 @@ 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 |
+| Overrides | 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. |

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

@@ -764,10 +764,13 @@ private int getAdminSericeLBNodePort() throws Exception {
   }
 
   /**
-   * Create a map with attributes required to create PV and create PV dir by calling
+   * Create a map with attributes required to create PV/PVC and create PV dir by calling
    * PersistentVolume
    *
-   * @throws Exception
+   * @throws Exception If the file create-pv-pvc-inputs.yaml does not exist, is a directory rather
+   *     than a regular file, or for some other reason cannot be opened for reading. or if an I/O
+   *     error occurs or any errors while creating PV dir or generating PV/PVC input file or any  
+   *     errors while executing sample create-pv-pvc.sh script
    */
   private void createPV() throws Exception {
 
@@ -912,9 +915,10 @@ public void verifyManagedServersRestarted() throws Exception {
   }
 
   /**
-   * create secret
+   * create a Kubernetes secret and labels the secret with domainUid. This secret is used for
+   * weblogicCredentialsSecretName in the domain inputs
    *
-   * @throws Exception
+   * @throws Exception when the kubectl create secret command fails or label secret fails
    */
   private void createSecret() throws Exception {
     Secret secret =
@@ -932,9 +936,10 @@ private void createSecret() throws Exception {
   }
 
   /**
-   * Generate domain values yaml using the doamin map
+   * Creates a directory using domainUid under userProjects weblogic-domains location. Creates
+   * weblogic-domain-values.yaml files using the domain map inputs at this new location.
    *
-   * @throws Exception
+   * @throws Exception if the dir/file can not be created
    */
   private void generateInputYaml() throws Exception {
     Path parentDir =
@@ -944,11 +949,14 @@ private void generateInputYaml() throws Exception {
   }
 
   /**
-   * copy create-domain.py if domain Map contains, git clone docker-images for domain in image and
-   * call create-domain.sh script based on the domain type. Append configOverrides to domain.yaml.
+   * copy create-domain.py if domain Map contains createDomainPyScript, git clone docker-images for
+   * domain in image and call create-domain.sh script based on the domain type. Append
+   * configOverrides to domain.yaml.
    *
-   * @param outputDir
-   * @throws Exception
+   * @param outputDir directory for the generated Kubernetes YAML files for the domain when
+   *     create-domain.sh is called
+   * @throws Exception if git clone fails or if createDomainPyScript can not be copied or if the
+   *     cluster topology file can not be copied or if create-domain.sh fails
    */
   private void callCreateDomainScript(String outputDir) throws Exception {
 
@@ -1171,8 +1179,9 @@ private void callWebAppAndCheckForServerNameInResponse(
    * Reads the create-domain-inputs.yaml from samples and overrides with attribute in input domain
    * map. Initializes the variables for the attributes in the map to be used later.
    *
-   * @param inputDomainMap
-   * @throws Exception
+   * @param inputDomainMap domain, LB, PV and custom input attributes for the domain
+   * @throws Exception if removing the results dir fails or if create-domain-inputs.yaml cannot be
+   *     accessed to read or if creating config map or secret fails for configoverrides
    */
   private void initialize(Map<String, Object> inputDomainMap) throws Exception {
     domainMap = inputDomainMap;
@@ -1253,16 +1262,6 @@ private void initialize(Map<String, Object> inputDomainMap) throws Exception {
     }
     if (System.getenv("IMAGE_PULL_SECRET_WEBLOGIC") != null) {
       domainMap.put("imagePullSecretName", System.getenv("IMAGE_PULL_SECRET_WEBLOGIC"));
-      if (System.getenv("WERCKER") != null) {
-        // create docker registry secrets
-        TestUtils.createDockerRegistrySecret(
-            System.getenv("IMAGE_PULL_SECRET_WEBLOGIC"),
-            System.getenv("REPO_SERVER"),
-            System.getenv("REPO_USERNAME"),
-            System.getenv("REPO_PASSWORD"),
-            System.getenv("REPO_EMAIL"),
-            domainNS);
-      }
     } else {
       domainMap.put("imagePullSecretName", "docker-store");
     }