Merge pull request #355 from alexhsamuel/feature/run-id-env-var-procstar

Set APSIS_RUN_ID in procstar programs.

Author: alexhsamuel

.gitignore

@@ -6,7 +6,6 @@ apsis.log
 archive*.db
 *-journal
 doc
-env
 work/
 python/apsis.egg-info
 .cache/

RELEASE.md

@@ -6,6 +6,7 @@
 - Output data updates live in the web UI.
 - `apsis output --follow` and `apsis output --tail` for live output in CLUI.
 - `apsis watch` for live run changes in CLUI.
+- Apsis sets the `APSIS_RUN_ID` env var in procstar programs.
 
 
 # v0.23

jobs/test/procstar/env.yaml

@@ -0,0 +1,5 @@
+program:
+  type: procstar
+  argv:
+    - /usr/bin/env
+

python/apsis/program/procstar/agent.py

@@ -123,14 +123,16 @@ def from_jso(cls, jso):
         return cls(argv, group_id=group_id)
 
 
-    @property
-    def spec(self):
+    def get_spec(self, *, run_id):
         """
-        The procstar proc spec for the program.
+        Returns the procstar proc spec for the program.
         """
         return procstar.spec.Proc(
             self.__argv,
             env=procstar.spec.Proc.Env(
+                vars={
+                    "APSIS_RUN_ID": run_id,
+                },
                 # Inherit the entire environment from procstar, since it probably
                 # includes important configuration.
                 inherit=True,
@@ -178,7 +180,7 @@ async def run(self, run_id, cfg):
             proc, res = await server.start(
                 proc_id     =proc_id,
                 group_id    =self.__group_id,
-                spec        =self.spec,
+                spec        =self.get_spec(run_id=run_id),
                 conn_timeout=conn_timeout,
             )
 

test/int/procstar/jobs/env.yaml

@@ -0,0 +1,4 @@
+program:
+  type: procstar
+  argv: ["/usr/bin/env"]
+

test/int/procstar/test_program.py

@@ -97,6 +97,16 @@ def test_signal():
         assert res["state"] == "success"
 
 
+def test_run_id_env():
+    with ApsisService(job_dir=JOB_DIR) as svc, svc.agent():
+        run_id = svc.client.schedule("env", args={})["run_id"]
+        res = svc.wait_run(run_id)
+        assert res["state"] == "success"
+        output = svc.client.get_output(run_id, "output").decode()
+        env_vars = dict( line.split("=", 1) for line in output.splitlines() )
+        assert env_vars["APSIS_RUN_ID"] == run_id
+
+
 # FIXME: procstar connection timeout and reconnect: use SIGHUP to pause agent,
 # wait for websocket timeout, then resume agent and watch it reconnect.