Support different logging paths based on OS (#1133)

* Support different logging paths based on OS * Added extra documentation * Support different logging paths based on OS * Added extra documentation
AcademySoftwareFoundation · May 2, 2022 · f81070c · f81070c
1 parent 671c895
commit f81070c
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 21 deletions.
diff --git a/cuebot/src/main/java/com/imageworks/spcue/util/JobLogUtil.java b/cuebot/src/main/java/com/imageworks/spcue/util/JobLogUtil.java
@@ -38,9 +38,9 @@ public boolean createJobLogDirectory(String path) {
  return f.isDirectory();
  }
 
- public String getJobLogDir(String show, String shot) {
+ public String getJobLogDir(String show, String shot, String os) {
  StringBuilder sb = new StringBuilder(512);
- sb.append(getJobLogRootDir());
+ sb.append(getJobLogRootDir(os));
  sb.append("/");
  sb.append(show);
  sb.append("/");
@@ -51,16 +51,19 @@ public String getJobLogDir(String show, String shot) {
 
  public String getJobLogPath(JobDetail job) {
  StringBuilder sb = new StringBuilder(512);
- sb.append(getJobLogDir(job.showName, job.shot));
+ sb.append(getJobLogDir(job.showName, job.shot, job.os));
  sb.append("/");
  sb.append(job.name);
  sb.append("--");
  sb.append(job.id);
  return sb.toString();
  }
 
- public String getJobLogRootDir() {
- return env.getRequiredProperty("log.frame-log-root", String.class);
+ public String getJobLogRootDir(String os) {
+ try {
+ return env.getRequiredProperty(String.format("log.frame-log-root.%s", os), String.class);
+ } catch (IllegalStateException e) {
+ return env.getRequiredProperty("log.frame-log-root.default_os", String.class);
+ }
  }
-}
-
+}
diff --git a/cuebot/src/main/resources/opencue.properties b/cuebot/src/main/resources/opencue.properties
@@ -46,10 +46,20 @@ mailing.enabled=true
 # Set to a boolean value. See com/imageworks/spcue/services/JmsMover.java.
 messaging.enabled=false
 
-# Root directory for which logs will be stored. See com/imageworks/spcue/util/JobLogUtil.java.
+# Default root directory for which logs will be stored if no other OS is defined.
+# See com/imageworks/spcue/util/JobLogUtil.java.
 # Override this via environment variable (CUE_FRAME_LOG_DIR) or command line flag
-# (--log.frame-log-root). Command line flag will be preferred if both are provided.
-log.frame-log-root=${CUE_FRAME_LOG_DIR:/shots}
+# (--log.frame-log-root.default_os). Command line flag will be preferred if both are provided.
+log.frame-log-root.default_os=${CUE_FRAME_LOG_DIR:/shots}
+# To set up root directories for other OS create new environment
+# variable as `log.frame-log-root.[OS] where OS relates to str_os on the job table
+# For example:
+# - log.frame-log-root.linux=${CUE_FRAME_LOG_DIR:/shots}
+# - log.frame-log-root.Windows=${CUE_FRAME_LOG_DIR:/S:}
+# Note that for Windows, either forward or back slashes will work. However if CUE_FRAME_LOG_DIR is empty
+# and S directory is in the root, the path will be broken due to the slash in front of S. Hence, if you
+# are planning to use a folder in the root, use:
+# - log.frame-log-root.Windows=${S:}
 
 # Maximum number of jobs to query.
 dispatcher.job_query_max=20

diff --git a/cuebot/src/test/java/com/imageworks/spcue/test/util/JobLogUtilTests.java b/cuebot/src/test/java/com/imageworks/spcue/test/util/JobLogUtilTests.java
@@ -36,32 +36,55 @@ public class JobLogUtilTests extends AbstractTransactionalJUnit4SpringContextTes
  @Resource
  private JobLogUtil jobLogUtil;
 
- private String logRoot;
+ private String logRootDefault;
+ private String logRootSomeOs;
 
  @Before
  public void setUp() {
- // This value should match what's defined in test/resources/opencue.properties.
- logRoot = "/arbitraryLogDirectory";
+ // The values should match what's defined in test/resources/opencue.properties.
+ logRootDefault = "/arbitraryLogDirectory";
+ logRootSomeOs = "/arbitrarySomeOsLogDirectory";
  }
 
  @Test
- public void testGetJobLogRootDir() {
- assertEquals(logRoot, jobLogUtil.getJobLogRootDir());
+ public void testGetJobLogRootDirDefault() {
+ assertEquals(logRootDefault, jobLogUtil.getJobLogRootDir("someUndefinedOs"));
  }
 
  @Test
- public void testGetJobLogDir() {
- assertEquals(logRoot + "/show/shot/logs", jobLogUtil.getJobLogDir("show", "shot"));
+ public void testGetJobLogRootSomeOs() {
+ assertEquals(logRootSomeOs, jobLogUtil.getJobLogRootDir("some_os"));
  }
 
  @Test
- public void testGetJobLogPath() {
+ public void testGetJobLogDirDefault() {
+ assertEquals(logRootDefault + "/show/shot/logs", jobLogUtil.getJobLogDir("show", "shot", "someUndefinedOs"));
+ }
+
+ @Test
+ public void testGetJobLogDirSomeOs() {
+ assertEquals(logRootSomeOs + "/show/shot/logs", jobLogUtil.getJobLogDir("show", "shot", "some_os"));
+ }
+
+ @Test
+ public void testGetJobLogPathDefault() {
  JobDetail jobDetail = new JobDetail();
  jobDetail.id = "id";
  jobDetail.name = "name";
  jobDetail.showName = "show";
  jobDetail.shot = "shot";
- assertEquals(logRoot + "/show/shot/logs/name--id", jobLogUtil.getJobLogPath(jobDetail));
+ jobDetail.os = "someUndefinedOs";
+ assertEquals(logRootDefault + "/show/shot/logs/name--id", jobLogUtil.getJobLogPath(jobDetail));
  }
-}
 
+ @Test
+ public void testGetJobLogPathSomeOs() {
+ JobDetail jobDetail = new JobDetail();
+ jobDetail.id = "id";
+ jobDetail.name = "name";
+ jobDetail.showName = "show";
+ jobDetail.shot = "shot";
+ jobDetail.os = "some_os";
+ assertEquals(logRootSomeOs + "/show/shot/logs/name--id", jobLogUtil.getJobLogPath(jobDetail));
+ }
+}
diff --git a/cuebot/src/test/resources/opencue.properties b/cuebot/src/test/resources/opencue.properties
@@ -31,7 +31,8 @@ kill_queue.threadPoolSizeInitial=2
 kill_queue.threadPoolSizeMax=6
 kill_queue.queueSize=1000
 
-log.frame-log-root=/arbitraryLogDirectory
+log.frame-log-root.default_os=/arbitraryLogDirectory
+log.frame-log-root.some_os=/arbitrarySomeOsLogDirectory
 
 dispatcher.job_query_max=20
 dispatcher.job_lock_expire_seconds=2