use resource for DeadlineExceeded message text

Author: alai8

operator/src/main/java/oracle/kubernetes/operator/JobWatcher.java

@@ -312,29 +312,19 @@ public DeadlineExceededException(V1Job job) {
     }
 
     public String toString() {
-      StringBuilder sb = new StringBuilder("Job ")
-          .append(job.getMetadata().getName()).append(" failed due to reason: DeadlineExceeded.")
-          .append(" ActiveDeadlineSeconds of the job is configured with "
-              + job.getSpec().getActiveDeadlineSeconds()
-              + " seconds.")
-          .append(getJobStartedSecondsMessage())
-          .append(" Ensure all domain dependencies have been deployed")
-          .append(" (any secrets, config-maps, PVs, and PVCs that the domain resource references).")
-          .append(" Use kubectl describe the job and its pod for more job failure information.")
-          .append(" The job may be retried by the operator up to "
-              + DomainPresence.getDomainPresenceFailureRetryMaxCount()
-              + " times with longer ActiveDeadlineSeconds value in each subsequent retry.")
-          .append(" Use tuning parameter \"domainPresenceFailureRetryMaxCount\" to configure max retries.");
-      return sb.toString();
+      return LOGGER.getFormattedMessage(
+          MessageKeys.JOB_DEADLINE_EXCEEDED_MESSAGE,
+          job.getMetadata().getName(),
+          job.getSpec().getActiveDeadlineSeconds(),
+          getJobStartedSeconds(),
+          DomainPresence.getDomainPresenceFailureRetryMaxCount());
     }
 
-    private String getJobStartedSecondsMessage() {
+    private long getJobStartedSeconds() {
       if (job.getStatus() != null && job.getStatus().getStartTime() != null) {
-        return " The job was started "
-            + ((System.currentTimeMillis() - job.getStatus().getStartTime().getMillis()) / 1000)
-            + " seconds ago.";
+        return (System.currentTimeMillis() - job.getStatus().getStartTime().getMillis()) / 1000;
       }
-      return null;
+      return -1;
     }
   }
 }

operator/src/main/java/oracle/kubernetes/operator/logging/LoggingFacade.java

@@ -4,6 +4,7 @@
 
 package oracle.kubernetes.operator.logging;
 
+import java.text.MessageFormat;
 import java.util.Arrays;
 import java.util.logging.ConsoleHandler;
 import java.util.logging.Handler;
@@ -632,6 +633,21 @@ public void trace(String msg, Object... args) {
     finer(TRACE + msg, args);
   }
 
+  /**
+   * Returns a formatted message.
+   *
+   * @param msg the message to be formatted, which is key to the resource bundle
+   * @param args parameters to the message
+   * @return A formatted message
+   */
+  public String getFormattedMessage(String msg, Object... args) {
+    try {
+      return MessageFormat.format(logger.getResourceBundle().getString(msg), args);
+    } catch (Exception ex) {
+      return msg;
+    }
+  }
+
   /**
    * Obtains caller details, class name and method, to be provided to the actual Logger. This code
    * is adapted from ODLLogRecord, which should yield consistency in reporting using PlatformLogger

operator/src/main/java/oracle/kubernetes/operator/logging/MessageKeys.java

@@ -153,6 +153,7 @@ public class MessageKeys {
   public static final String EXTERNAL_CHANNEL_SERVICE_REPLACED = "WLSKO-0151";
   public static final String EXTERNAL_CHANNEL_SERVICE_EXISTS = "WLSKO-0152";
   public static final String WLS_HEALTH_READ_FAILED_NO_HTTPCLIENT = "WLSKO-0153";
+  public static final String JOB_DEADLINE_EXCEEDED_MESSAGE = "WLSKO-0154";
 
   private MessageKeys() {
   }

operator/src/main/resources/Operator.properties

@@ -151,3 +151,13 @@ WLSKO-0150=Creating external channel service for WebLogic domain with UID: {0}.
 WLSKO-0151=Replacing external channel service for WebLogic domain with UID: {0}.
 WLSKO-0152=Existing external channel service is correct for WebLogic domain with UID: {0}.
 WLSKO-0153=Failed to read health information from server {0}. Unable to connect to server.
+WLSKO-0154=Job {0} failed due to reason: DeadlineExceeded. \
+  ActiveDeadlineSeconds of the job is configured with {1} seconds. \
+  The job was started {2} seconds ago. \
+  Ensure all domain dependencies have been deployed \
+  (any secrets, config-maps, PVs, and PVCs that the domain resource references). \
+  Use kubectl describe for the job and its pod for more job failure information. \
+  The job may be retried by the operator up to {3} \
+  times with longer ActiveDeadlineSeconds value in each subsequent retry. \
+  Use tuning parameter 'domainPresenceFailureRetryMaxCount' to configure max retries.
+

operator/src/test/java/oracle/kubernetes/operator/logging/LoggingFacadeTest.java

@@ -122,6 +122,24 @@ public void verifySevereMessageWithThrowableNotLoggedIfLoggingFilterDenies() {
     assertThat(mockLogger.isLogpCalled(), is(false));
   }
 
+  @Test
+  public void verifyGetFormattedMessage_withArgs_returnsFormattedMessage() {
+    assertThat(loggingFacade.getFormattedMessage(MessageKeys.CYCLING_SERVERS, "domain1", "list1"),
+    is("Cycling of servers for Domain with UID domain1 in the list list1 now"));
+  }
+
+  @Test
+  public void verifyGetFormattedMessage_withNoArgs_returnsFormattedMessage() {
+    assertThat(loggingFacade.getFormattedMessage(MessageKeys.RESOURCE_BUNDLE_NOT_FOUND),
+        is("Could not find the resource bundle"));
+  }
+
+  @Test
+  public void verifyGetFormattedMessage_withNonExistingKey_returnsOriginalMessage() {
+    assertThat(loggingFacade.getFormattedMessage("Not a key"),
+        is("Not a key"));
+  }
+
   static class MockLogger extends Logger {
 
     boolean logpCalled;