Refactor get certificate contents to be shared between REST and Admin pod configuration

lennyphan · lennyphan · commit 941f27f0b5a9 · 2019-03-06T17:58:13.000-08:00
diff --git a/operator/src/main/java/oracle/kubernetes/operator/OperatorConstants.java b/operator/src/main/java/oracle/kubernetes/operator/OperatorConstants.java
@@ -0,0 +1,7 @@
+package oracle.kubernetes.operator;
+
+public interface OperatorConstants {
+  static final String OPERATOR_DIR = "/operator/";
+  static final String INTERNAL_REST_IDENTITY_DIR = OPERATOR_DIR + "internal-identity/";
+  static final String INTERNAL_CERTIFICATE = INTERNAL_REST_IDENTITY_DIR + "internalOperatorCert";
+}
diff --git a/operator/src/main/java/oracle/kubernetes/operator/TuningParameters.java b/operator/src/main/java/oracle/kubernetes/operator/TuningParameters.java
@@ -261,4 +261,6 @@ public boolean equals(Object o) {
   public PodTuning getPodTuning();
 
   public String getFileContents(String path);
+
+  public boolean checkFileExists(String path);
 }
diff --git a/operator/src/main/java/oracle/kubernetes/operator/TuningParametersImpl.java b/operator/src/main/java/oracle/kubernetes/operator/TuningParametersImpl.java
@@ -140,25 +140,35 @@ public PodTuning getPodTuning() {
 
   // path - a file containing a base64 encoded string containing the operator's cert in pem format
   public String getFileContents(String path) {
+    LOGGER.entering(path);
     // in pem format
     String result = null;
     if (checkFileExists(path)) {
       try {
         result = new String(Files.readAllBytes(Paths.get(path)));
       } catch (Throwable t) {
+        LOGGER.warning("Can't read " + path, t);
       }
     }
     // do not include the certificate data in the log message
+    LOGGER.exiting();
     return result;
   }
 
-  private boolean checkFileExists(String path) {
+  public boolean checkFileExists(String path) {
+    LOGGER.entering(path);
     File f = new File(path);
     boolean result = false;
-    if (f.exists() && f.isFile()) {
-      result = true;
+    if (f.exists()) {
+      if (f.isFile()) {
+        result = true;
+      } else {
+        LOGGER.warning(path + " is not a file");
+      }
+    } else {
+      LOGGER.warning(path + " does not exist");
     }
-
+    LOGGER.exiting(result);
     return result;
   }
 }
diff --git a/operator/src/main/java/oracle/kubernetes/operator/helpers/PodHelper.java b/operator/src/main/java/oracle/kubernetes/operator/helpers/PodHelper.java
@@ -17,6 +17,7 @@
 import oracle.kubernetes.operator.DomainStatusUpdater;
 import oracle.kubernetes.operator.KubernetesConstants;
 import oracle.kubernetes.operator.LabelConstants;
+import oracle.kubernetes.operator.OperatorConstants;
 import oracle.kubernetes.operator.PodAwaiterStepFactory;
 import oracle.kubernetes.operator.ProcessingConstants;
 import oracle.kubernetes.operator.TuningParameters;
@@ -33,10 +34,6 @@ public class PodHelper {
   private PodHelper() {}
 
   static class AdminPodStepContext extends PodStepContext {
-    private static final String OPERATOR_DIR = "/operator/";
-    private static final String INTERNAL_REST_IDENTITY_DIR = OPERATOR_DIR + "internal-identity/";
-    private static final String INTERNAL_OPERATOR_CERTIFICATE =
-        INTERNAL_REST_IDENTITY_DIR + "internalOperatorCert";
     static final String INTERNAL_OPERATOR_CERT_ENV = "INTERNAL_OPERATOR_CERT";
 
     AdminPodStepContext(Step conflictStep, Packet packet) {
@@ -135,7 +132,7 @@ protected Map<String, String> getPodAnnotations() {
     }
 
     private String getInternalOperatorCertFile(TuningParameters tuningParameters) {
-      return tuningParameters.getFileContents(INTERNAL_OPERATOR_CERTIFICATE);
+      return tuningParameters.getFileContents(OperatorConstants.INTERNAL_CERTIFICATE);
     }
   }
 
diff --git a/operator/src/main/java/oracle/kubernetes/operator/rest/RestConfigImpl.java b/operator/src/main/java/oracle/kubernetes/operator/rest/RestConfigImpl.java
@@ -4,26 +4,21 @@
 
 package oracle.kubernetes.operator.rest;
 
-import java.io.File;
-import java.nio.file.Files;
-import java.nio.file.Paths;
 import java.util.Collection;
+import oracle.kubernetes.operator.OperatorConstants;
+import oracle.kubernetes.operator.TuningParameters;
 import oracle.kubernetes.operator.logging.LoggingFacade;
 import oracle.kubernetes.operator.logging.LoggingFactory;
 import oracle.kubernetes.operator.rest.backend.RestBackend;
 
 /** RestConfigImpl provides the WebLogic Operator REST api configuration. */
-public class RestConfigImpl implements RestConfig {
+public class RestConfigImpl implements RestConfig, OperatorConstants {
 
   private static LoggingFacade LOGGER = LoggingFactory.getLogger("Operator", "Operator");
 
   private final String principal;
   private final Collection<String> targetNamespaces;
 
-  private static final String OPERATOR_DIR = "/operator/";
-  private static final String INTERNAL_REST_IDENTITY_DIR = OPERATOR_DIR + "internal-identity/";
-  private static final String INTERNAL_CERTIFICATE =
-      INTERNAL_REST_IDENTITY_DIR + "internalOperatorCert";
   private static final String INTERNAL_CERTIFICATE_KEY =
       INTERNAL_REST_IDENTITY_DIR + "internalOperatorKey";
   private static final String EXTERNAL_REST_IDENTITY_DIR = OPERATOR_DIR + "external-identity/";
@@ -63,12 +58,12 @@ public int getInternalHttpsPort() {
 
   @Override
   public String getOperatorExternalCertificateData() {
-    return getCertificate(EXTERNAL_CERTIFICATE);
+    return TuningParameters.getInstance().getFileContents(EXTERNAL_CERTIFICATE);
   }
 
   @Override
   public String getOperatorInternalCertificateData() {
-    return getCertificate(INTERNAL_CERTIFICATE);
+    return TuningParameters.getInstance().getFileContents(INTERNAL_CERTIFICATE);
   }
 
   @Override
@@ -109,47 +104,13 @@ public RestBackend getBackend(String accessToken) {
     return result;
   }
 
-  // path - a file containing a base64 encoded string containing the operator's cert in pem format
-  private String getCertificate(String path) {
-    LOGGER.entering(path);
-    // in pem format
-    String result = null;
-    if (checkFileExists(path)) {
-      try {
-        result = new String(Files.readAllBytes(Paths.get(path)));
-      } catch (Throwable t) {
-        LOGGER.warning("Can't read " + path, t);
-      }
-    }
-    // do not include the certificate data in the log message
-    LOGGER.exiting();
-    return result;
-  }
-
   // path - a file containing the operator's private key in pem format (cleartext)
   private String getKey(String path) {
     LOGGER.entering(path);
-    if (!checkFileExists(path)) {
+    if (!TuningParameters.getInstance().checkFileExists(path)) {
       path = null;
     }
     LOGGER.exiting(path);
     return path;
   }
-
-  private boolean checkFileExists(String path) {
-    LOGGER.entering(path);
-    File f = new File(path);
-    boolean result = false;
-    if (f.exists()) {
-      if (f.isFile()) {
-        result = true;
-      } else {
-        LOGGER.warning(path + " is not a file");
-      }
-    } else {
-      LOGGER.warning(path + " does not exist");
-    }
-    LOGGER.exiting(result);
-    return result;
-  }
 }
diff --git a/operator/src/test/java/oracle/kubernetes/operator/helpers/AdminPodHelperTest.java b/operator/src/test/java/oracle/kubernetes/operator/helpers/AdminPodHelperTest.java
@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.Map;
 import oracle.kubernetes.operator.LabelConstants;
+import oracle.kubernetes.operator.OperatorConstants;
 import oracle.kubernetes.operator.PodAwaiterStepFactory;
 import oracle.kubernetes.operator.ProcessingConstants;
 import oracle.kubernetes.operator.VersionConstants;
@@ -41,8 +42,6 @@
 
 @SuppressWarnings("SameParameterValue")
 public class AdminPodHelperTest extends PodHelperTestBase {
-  private static final String INTERNAL_OPERATOR_CERT_FILE_PARAM =
-      "/operator/internal-identity/internalOperatorCert";
   private static final String INTERNAL_OPERATOR_CERT_ENV_NAME = "INTERNAL_OPERATOR_CERT";
   private static final String CERTFILE = "certfile";
 
@@ -210,7 +209,7 @@ public void whenAdminPodCreated_containerHasStartServerCommand() {
 
   @Test
   public void whenAdminPodCreated_hasOperatorCertEnvVariable() {
-    putTuningParameter(INTERNAL_OPERATOR_CERT_FILE_PARAM, CERTFILE);
+    putTuningParameter(OperatorConstants.INTERNAL_CERTIFICATE, CERTFILE);
     assertThat(
         getCreatedPodSpecContainer().getEnv(),
         hasEnvVar(INTERNAL_OPERATOR_CERT_ENV_NAME, CERTFILE));

Original file line number	Diff line number	Diff line change
`@@ -261,4 +261,6 @@ public boolean equals(Object o) {`
`261`	`261`	`public PodTuning getPodTuning();`
`262`	`262`
`263`	`263`	`public String getFileContents(String path);`
	`264`	`+`
	`265`	`+ public boolean checkFileExists(String path);`
`264`	`266`	`}`