Merge pull request #5156 from chu11/issue5119_job_list_cwd

job-list: support retrieving current working directory for jobs

Author: mergify[bot]

doc/man1/flux-jobs.rst

@@ -302,6 +302,9 @@ The field names that can be specified are:
 **name**
    job name
 
+**cwd**
+   job current working directory
+
 **queue**
    job queue
 

src/bindings/python/flux/job/info.py

@@ -281,6 +281,7 @@ class JobInfo:
         "duration": 0.0,
         "expiration": 0.0,
         "name": "",
+        "cwd": "",
         "queue": "",
         "ntasks": "",
         "ncores": "",
@@ -559,6 +560,7 @@ def job_fields_to_attrs(fields):
         "state_single": ("state",),
         "state_emoji": ("state",),
         "name": ("name",),
+        "cwd": ("cwd",),
         "queue": ("queue",),
         "ntasks": ("ntasks",),
         "ncores": ("ncores",),
@@ -641,6 +643,7 @@ class JobInfoFormat(flux.util.OutputFormat):
         "state_single": "S",
         "state_emoji": "STATE",
         "name": "NAME",
+        "cwd": "CWD",
         "queue": "QUEUE",
         "ntasks": "NTASKS",
         "ncores": "NCORES",

src/modules/job-list/Makefile.am

@@ -94,6 +94,8 @@ EXTRA_DIST = \
 	test/jobspec/4slot.jobspec \
 	test/jobspec/4slot_perresourcecore4.jobspec \
 	test/jobspec/duration_alt.jobspec \
+	test/jobspec/queue_specified.jobspec \
+	test/jobspec/cwd_not_specified.jobspec \
 	test/jobspec/invalid_attributes_system_job.jobspec \
 	test/jobspec/invalid_command_array.jobspec \
 	test/jobspec/invalid_command_string.jobspec \

src/modules/job-list/job-list.c

@@ -25,7 +25,7 @@
 static const char *attrs[] = {
     "userid", "urgency", "priority", "t_submit",
     "t_depend", "t_run", "t_cleanup", "t_inactive",
-    "state", "name", "queue", "ntasks", "ncores", "duration", "nnodes",
+    "state", "name", "cwd", "queue", "ntasks", "ncores", "duration", "nnodes",
     "ranks", "nodelist", "success", "exception_occurred",
     "exception_type", "exception_severity",
     "exception_note", "result", "expiration",

src/modules/job-list/job_data.c

@@ -308,9 +308,10 @@ static int parse_jobspec (struct job *job, const char *s, bool allow_nonfatal)
         goto nonfatal_error;
 
     if (json_unpack_ex (job->jobspec, &error, 0,
-                        "{s:{s:{s?:s}}}",
+                        "{s:{s:{s?:s s?s}}}",
                         "attributes",
                         "system",
+                        "cwd", &job->cwd,
                         "queue", &job->queue) < 0) {
         flux_log (job->h, LOG_ERR,
                   "%s: job %ju invalid jobspec: %s",

src/modules/job-list/job_data.h

@@ -44,6 +44,7 @@ struct job {
     flux_job_state_t state;
     const char *name;
     const char *queue;
+    const char *cwd;
     int ntasks;
     int ntasks_per_core_on_node_count;  /* flag for ntasks calculation */
     int ncores;

src/modules/job-list/job_util.c

@@ -95,6 +95,12 @@ static int store_attr (struct job *job,
             return 0;
         val = json_string (job->name);
     }
+    else if (streq (attr, "cwd")) {
+        /* job->cwd potentially NULL, is optional in jobspec */
+        if (!job->cwd)
+            return 0;
+        val = json_string (job->cwd);
+    }
     else if (streq (attr, "queue")) {
         /* job->queue potentially NULL if:
          * - unspecified

src/modules/job-list/test/job_data.c

@@ -58,6 +58,24 @@ struct test_jobspec_job_name {
     { NULL, 0 },
 };
 
+struct test_jobspec_cwd {
+    const char *filename;
+    const char *cwd;
+} jobspec_cwd_tests[] = {
+    { TEST_SRCDIR "/jobspec/1slot.jobspec", "/tmp/job" },
+    { TEST_SRCDIR "/jobspec/cwd_not_specified.jobspec", NULL },
+    { NULL, 0 },
+};
+
+struct test_jobspec_queue {
+    const char *filename;
+    const char *queue;
+} jobspec_queue_tests[] = {
+    { TEST_SRCDIR "/jobspec/1slot.jobspec", NULL },
+    { TEST_SRCDIR "/jobspec/queue_specified.jobspec", "batch" },
+    { NULL, 0 },
+};
+
 struct test_jobspec_duration {
     const char *filename;
     double duration;
@@ -347,6 +365,68 @@ static void test_jobspec_job_name (void)
     }
 }
 
+static void test_jobspec_cwd (void)
+{
+    struct test_jobspec_cwd *test;
+
+    test = jobspec_cwd_tests;
+    while (test->filename) {
+        struct job *job = job_create (NULL, FLUX_JOBID_ANY);
+        const char *filename = test->filename;
+        const char *cwd = test->cwd;
+        int ret;
+
+        if (!job)
+            BAIL_OUT ("job_create failed");
+
+        ret = parse_jobspec (job, filename);
+        ok (ret == 0, "job_parse_jobspec parsed %s", filename);
+        if (cwd) {
+            ok (streq (cwd, job->cwd),
+                "job_parse_jobspec correctly parsed job cwd %s=%s",
+                cwd, job->cwd);
+        }
+        else {
+            ok (job->cwd == NULL,
+                "job_parse_jobspec correctly parsed no job cwd");
+        }
+
+        job_destroy (job);
+        test++;
+    }
+}
+
+static void test_jobspec_queue (void)
+{
+    struct test_jobspec_queue *test;
+
+    test = jobspec_queue_tests;
+    while (test->filename) {
+        struct job *job = job_create (NULL, FLUX_JOBID_ANY);
+        const char *filename = test->filename;
+        const char *queue = test->queue;
+        int ret;
+
+        if (!job)
+            BAIL_OUT ("job_create failed");
+
+        ret = parse_jobspec (job, filename);
+        ok (ret == 0, "job_parse_jobspec parsed %s", filename);
+        if (queue) {
+            ok (streq (queue, job->queue),
+                "job_parse_jobspec correctly parsed job queue %s=%s",
+                queue, job->queue);
+        }
+        else {
+            ok (job->queue == NULL,
+                "job_parse_jobspec correctly parsed no job queue");
+        }
+
+        job_destroy (job);
+        test++;
+    }
+}
+
 static void test_jobspec_duration (void)
 {
     struct test_jobspec_duration *test;
@@ -555,6 +635,8 @@ int main (int argc, char *argv[])
 
     test_jobspec_corner_case ();
     test_jobspec_job_name ();
+    test_jobspec_cwd ();
+    test_jobspec_queue ();
     test_jobspec_duration ();
     test_R_corner_case ();
     test_R_ranks ();

src/modules/job-list/test/jobspec/cwd_not_specified.jobspec

@@ -0,0 +1,32 @@
+{
+  "resources": [
+    {
+      "type": "slot",
+      "count": 1,
+      "with": [
+        {
+          "type": "core",
+          "count": 1
+        }
+      ],
+      "label": "task"
+    }
+  ],
+  "tasks": [
+    {
+      "command": [
+        "hostname"
+      ],
+      "slot": "task",
+      "count": {
+        "per_slot": 1
+      }
+    }
+  ],
+  "attributes": {
+    "system": {
+      "duration": 0
+    }
+  },
+  "version": 1
+}

src/modules/job-list/test/jobspec/queue_specified.jobspec

@@ -0,0 +1,34 @@
+{
+  "resources": [
+    {
+      "type": "slot",
+      "count": 1,
+      "with": [
+        {
+          "type": "core",
+          "count": 1
+        }
+      ],
+      "label": "task"
+    }
+  ],
+  "tasks": [
+    {
+      "command": [
+        "hostname"
+      ],
+      "slot": "task",
+      "count": {
+        "per_slot": 1
+      }
+    }
+  ],
+  "attributes": {
+    "system": {
+      "duration": 0,
+      "cwd": "/tmp/job",
+      "queue": "batch"
+    }
+  },
+  "version": 1
+}