refactor: Improve cli task info variable name

opentripplanner · Nov 21, 2024 · f7f2b93 · f7f2b93
1 parent 1e02e11
commit f7f2b93
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/application/src/main/java/org/opentripplanner/standalone/OTPMain.java b/application/src/main/java/org/opentripplanner/standalone/OTPMain.java
@@ -52,7 +52,7 @@ public static void main(String[] args) {
     try {
       Thread.currentThread().setName("main");
       CommandLineParameters params = parseAndValidateCmdLine(args);
-      OtpStartupInfo.logInfo(params.logInfo());
+      OtpStartupInfo.logInfo(params.logTaskInfo());
       startOTPServer(params);
     } catch (OtpAppException ae) {
       LOG.error(ae.getMessage(), ae);

diff --git a/application/src/main/java/org/opentripplanner/standalone/OtpStartupInfo.java b/application/src/main/java/org/opentripplanner/standalone/OtpStartupInfo.java
@@ -34,18 +34,18 @@ private static String info() {
     );
   }
 
-  public static void logInfo(String runInfo) {
+  public static void logInfo(String cliTaskInfo) {
     // This is good when aggregating logs across multiple load balanced instances of OTP
     // Hint: a regexp filter like "^OTP (START|SHUTTING)" will list nodes going up/down
     LOG.info(
       "OTP STARTING UP - {} - {} - Java {}",
-      runInfo,
+      cliTaskInfo,
       projectInfo().getVersionString(),
       javaVersion()
     );
     ApplicationShutdownSupport.addShutdownHook(
       "server-shutdown-info",
-      () -> LOG.info("OTP SHUTTING DOWN - {} - {}", runInfo, projectInfo().getVersionString())
+      () -> LOG.info("OTP SHUTTING DOWN - {} - {}", cliTaskInfo, projectInfo().getVersionString())
     );
     LOG.info(NEW_LINE + "{}", info());
   }

diff --git a/application/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java b/application/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java
@@ -201,7 +201,7 @@ public boolean doServe() {
     return load || (serve && doBuildTransit());
   }
 
-  public String logInfo() {
+  public String logTaskInfo() {
     var mainCommands = new ArrayList<String>();
     if (doBuildStreet() & doBuildTransit()) {
       mainCommands.add("Build Street & Transit Graph");

diff --git a/...cation/src/test/java/org/opentripplanner/standalone/config/CommandLineParametersTest.java b/...cation/src/test/java/org/opentripplanner/standalone/config/CommandLineParametersTest.java
@@ -52,7 +52,7 @@ public void build() {
     assertTrue(subject.doBuildTransit());
     assertFalse(subject.doSaveGraph());
     assertFalse(subject.doServe());
-    assertEquals("Build Street & Transit Graph", subject.logInfo());
+    assertEquals("Build Street & Transit Graph", subject.logTaskInfo());
 
     subject.save = true;
     subject.serve = false;
@@ -61,7 +61,7 @@ public void build() {
     assertTrue(subject.doSaveGraph());
     assertFalse(subject.doServe());
     subject.inferAndValidate();
-    assertEquals("Build Street & Transit Graph", subject.logInfo());
+    assertEquals("Build Street & Transit Graph", subject.logTaskInfo());
 
     subject.save = false;
     subject.serve = true;
@@ -70,7 +70,7 @@ public void build() {
     assertFalse(subject.doSaveGraph());
     assertTrue(subject.doServe());
     subject.inferAndValidate();
-    assertEquals("Build Street & Transit Graph, Run Server", subject.logInfo());
+    assertEquals("Build Street & Transit Graph, Run Server", subject.logTaskInfo());
 
     subject.save = true;
     subject.serve = true;
@@ -79,7 +79,7 @@ public void build() {
     assertTrue(subject.doSaveGraph());
     assertTrue(subject.doServe());
     subject.inferAndValidate();
-    assertEquals("Build Street & Transit Graph, Run Server", subject.logInfo());
+    assertEquals("Build Street & Transit Graph, Run Server", subject.logTaskInfo());
   }
 
   @Test
@@ -89,15 +89,15 @@ public void buildStreet() {
     assertFalse(subject.doBuildTransit());
     assertTrue(subject.doSaveStreetGraph());
     assertFalse(subject.doSaveGraph());
-    assertEquals("Build Street Graph", subject.logInfo());
+    assertEquals("Build Street Graph", subject.logTaskInfo());
   }
 
   @Test
   public void doLoadGraph() {
     subject.load = true;
     assertTrue(subject.doLoadGraph());
     assertTrue(subject.doServe());
-    assertEquals("Run Server", subject.logInfo());
+    assertEquals("Run Server", subject.logTaskInfo());
   }
 
   @Test
@@ -107,7 +107,7 @@ public void doLoadStreetGraph() {
     assertFalse(subject.doBuildStreet());
     assertFalse(subject.doSaveStreetGraph());
     assertFalse(subject.doSaveGraph());
-    assertEquals("Build Transit Graph", subject.logInfo());
+    assertEquals("Build Transit Graph", subject.logTaskInfo());
 
     subject.save = true;
     subject.serve = true;
@@ -128,7 +128,7 @@ public void validateLoad() {
 
     // Implicit given, but should be ok to set
     subject.serve = true;
-    assertEquals("Run Server", subject.logInfo());
+    assertEquals("Run Server", subject.logTaskInfo());
 
     // No exception thrown
     subject.inferAndValidate();