Add new liveness and readiness probes (Python 3)

Since we started using UBI8 as the base image, Python 2 is not easily
available anymore. We chose to port the liveness and readiness probes
to use Python 3.

References: IBMZP-28, JDG-3368

NOTE: the image should be in a buildable state starting from this commit,
  after the preparatory changes to introduce UBI8 as base image and the
  commits in between.

Author: Osni Oliveira

image.yaml

@@ -195,7 +195,10 @@ modules:
     - name: jolokia
     - name: datagrid.module-overrides
     - name: os-eap7-ping
+    - name: os-eap-python
+      version: "3.6"
     - name: os-eap-probes
+      version: "3.0"
     - name: os-eap-db-drivers
     - name: os-partition
     - name: openshift-layer

modules/common/os-eap-probes/added/livenessProbe.sh renamed to modules/common/os-eap-probes/1.0/added/livenessProbe.sh

@@ -50,4 +50,3 @@ if [ "$DEBUG_SCRIPT" == "true" ]; then
 fi
 
 exit 1
-

modules/common/os-eap-probes/added/probe_common.sh renamed to modules/common/os-eap-probes/1.0/added/probe_common.sh

@@ -13,7 +13,7 @@ run_cli_cmd() {
 
     #Default for EAP7
     cli_port=9990
-    
+
     if [ -f "$JBOSS_HOME/bin/run.sh" ]; then
       version=$($JBOSS_HOME/bin/run.sh -V)
       if [[ "$version" == *"JBoss Enterprise Application Platform 6"* ]]; then

modules/common/os-eap-probes/added/probes/probe/__init__.py renamed to modules/common/os-eap-probes/1.0/added/probes/probe/__init__.py

@@ -43,7 +43,7 @@ class Status(Enum):
     FAILURE = 2
     NOT_READY = 4
     READY = 8
-    
+
     def __str__(self):
         return self.name
 
@@ -81,19 +81,19 @@ class Test(object):
 
     def __init__(self, query):
         self.query = query
-        
+
     def getQuery(self):
         """
         Returns the query used by this test.  The return value is Probe
         specific.  Many Probe implementations use JSON for submitting queries,
         which means this function would return a dict.
         """
         return self.query
-        
+
     def evaluate(self, results):
         """
         Evaluate the response from the server, returning Status and messages.
-        messages should be returned as an object, list or dict. 
+        messages should be returned as an object, list or dict.
         """
         raise NotImplementedError("Implement evaluate() for Test: " + qualifiedClassName(self))
 
@@ -113,23 +113,23 @@ def addTest(self, test):
         as JSON).  The Test must be capable of understanding the results
         returned by the Probe (e.g. a JSON response from DMR).
         """
-        
+
         self.tests.append(test)
 
     def execute(self):
         """
         Executes the queries and evaluates the tests and returns a set of Status
         and messages collected for each test.
         """
-        
+
         raise NotImplementedError("Implement execute() for Probe: " + qualifiedClassName(self))
 
 class BatchingProbe(Probe):
     """
     Base class which supports batching queries to be sent to a server and
     splitting the results to correspond with the individual tests.
     """
-    
+
     def __init__(self, tests = []):
         super(BatchingProbe, self).__init__(tests)
         self.logger = logging.getLogger(qualifiedClassName(self))
@@ -166,7 +166,7 @@ def createRequest(self):
         Create the request to send to the server.  Subclasses should include the
         queries from all tests in the request.
         """
-        
+
         raise NotImplementedError("Implement createRequest() for BatchingProbe: " + qualifiedClassName(self))
 
     def sendRequest(self, request):
@@ -180,5 +180,5 @@ def getTestInput(self, results, testIndex):
         """
         Return the results specific to the indexed test.
         """
-        
+
         raise NotImplementedError("Implement getTestInput() for BatchingProbe: " + qualifiedClassName(self))

modules/common/os-eap-probes/added/probes/probe/api.py renamed to modules/common/os-eap-probes/1.0/added/probes/probe/api.py

@@ -35,7 +35,7 @@ def __init__(self, tests = []):
         super(DmrProbe, self).__init__(tests)
         self.logger = logging.getLogger(qualifiedClassName(self))
         self.__readConfig()
-        
+
     def __readConfig(self):
         """
         Configuration consists of:
@@ -44,7 +44,7 @@ def __readConfig(self):
             user: $ADMIN_USERNAME
             password: $ADMIN_PASSWORD
         """
-        
+
         self.host = "localhost"
         self.port = 9990 + int(os.getenv('PORT_OFFSET', 0))
         self.user = os.getenv('ADMIN_USERNAME')
@@ -114,8 +114,9 @@ def failUnusableResponse(self, response):
             for index, test in enumerate(self.tests):
                 if not stepResults[index]:
                     unusable = True
-                    break;
+                    break
 
         if unusable:
+            url = "http://%s:%s/management" % (self.host, self.port)
             self.logger.error("Probe request failed.  Status code: %s", response.status_code)
-            raise Exception("Probe request failed, code: " + str(response.status_code) + str(url) + str(request) + str(response.json(object_pairs_hook = OrderedDict)))
+            raise Exception("Probe request failed, code: " + str(response.status_code) + str(url) + str(response.json(object_pairs_hook = OrderedDict)))

modules/common/os-eap-probes/added/probes/probe/dmr.py renamed to modules/common/os-eap-probes/1.0/added/probes/probe/dmr.py

@@ -53,7 +53,7 @@ def evaluate(self, results):
         Evaluates the test:
             READY for "running"
             FAILURE if the query itself failed
-            NOT_READY for all other states 
+            NOT_READY for all other states
         """
 
         if results["outcome"] != "success" and results.get("failure-description"):
@@ -196,7 +196,7 @@ def evaluate(self, results):
         """
         Evaluates the test:
             if the overall composite failed with JBAS014883 or WFLYCTL0030
-                READY as the failure means no health check extension configured on the system 
+                READY as the failure means no health check extension configured on the system
             elsif the 'read-resource' step failed:
                 READY as failure means no health check subsystem configured on the system
             elsif the 'check' step succeeded:

modules/common/os-eap-probes/added/probes/probe/eap/__init__.py renamed to modules/common/os-eap-probes/1.0/added/probes/probe/eap/__init__.py

@@ -19,8 +19,8 @@
 import os
 import requests
 import sys
-import ConfigParser
-import StringIO
+import configparser as ConfigParser
+from io import StringIO
 
 from collections import OrderedDict
 
@@ -37,7 +37,7 @@ def __init__(self, tests = []):
         super(JolokiaProbe, self).__init__(tests)
         self.logger = logging.getLogger(qualifiedClassName(self))
         self.__readConfig()
-        
+
     def __readConfig(self):
         """
         Configuration is read from /opt/jolokia/etc/jolokia.properties and
@@ -48,7 +48,7 @@ def __readConfig(self):
             user: jolokia.user
             password: jolokia.password
         """
-        
+
         jolokiaConfig = ConfigParser.ConfigParser(
             defaults = {
                 "port": 8778,
@@ -57,12 +57,12 @@ def __readConfig(self):
                 "protocol": "http"
             }
         )
-        
+
         self.logger.info("Reading jolokia properties file")
         with open("/opt/jolokia/etc/jolokia.properties") as jolokiaProperties:
             # fake a section
-            jolokiaConfig.readfp(StringIO.StringIO("[jolokia]\n" + jolokiaProperties.read()))
-        
+            jolokiaConfig.readfp(StringIO("[jolokia]\n" + jolokiaProperties.read()))
+
         self.host = "localhost"
         self.port = int(jolokiaConfig.get("jolokia", "port")) + int(os.getenv('PORT_OFFSET', 0))
         self.protocol = jolokiaConfig.get("jolokia", "protocol")