feature(EXEC-892): add session schedule_at to the exec command (#196)

Summary:
Use the exec command to test the session in display only mcx and absolute time constraints. Associated lab PR: strateos/lab#1237

If the user uses the exec command, upon success, they will receive a session id. Then can then reuse this session id, to interleave another run on the created worldstate.

The user has also access to the flag --schedule-delay to provide a relative starting time in minutes,
or --schedule-at to provide an absolute starting time ("14:13" meaning today at 2:13pm, "2021-02-20T12:34" meaning at that exact time).

Test Plan:
Add unit testing for the new flags.
Manual local testing and on the test workcell in production

Author: GregoryEssertel

CHANGELOG.rst

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+Unreleased
+----------
+
+Added
+~~~~~
+
+Fixed
+~~~~~
+
+Updated
+~~~~~~~
+
+- Added support for sessions and absolute time constraint in `exec` CLI command.
+  Added "--sessionId", "--schedule-at", and "--schedule-delay" flags.
+
 
 v9.2.0
 ----------

test/commands/exec_test.py

@@ -9,8 +9,8 @@
 
 
 # Structure of the response object from SCLE
-def bool_success_res():
-    return {"success": True}
+def queue_test_success_res(sessionId="testSessionId"):
+    return {"success": True, "sessionId": sessionId}
 
 
 def mock_api_endpoint():
@@ -34,15 +34,17 @@ def test_unspecified_api(cli_test_runner, ap_file):
 
 def test_good_autoprotocol(cli_test_runner, monkeypatch, ap_file):
     def mockpost(*args, **kwargs):
-        return MockResponse(0, bool_success_res(), json.dumps(bool_success_res()))
+        return MockResponse(
+            0, queue_test_success_res(), json.dumps(queue_test_success_res())
+        )
 
     monkeypatch.setattr(requests, "post", mockpost)
     result = cli_test_runner.invoke(
         cli, ["exec", str(ap_file), "-a", mock_api_endpoint()]
     )
     assert result.exit_code == 0
     assert (
-        f"Success. View {mock_api_endpoint()} to see the scheduling outcome."
+        f"Success. View {mock_api_endpoint()}/dashboard?sessionId=testSessionId to see the scheduling outcome."
         in result.output
     )
 
@@ -88,15 +90,17 @@ def mockpost(*args, **kwargs):
 
 def test_good_workcell(cli_test_runner, monkeypatch, ap_file):
     def mockpost(*args, **kwargs):
-        return MockResponse(0, bool_success_res(), json.dumps(bool_success_res()))
+        return MockResponse(
+            0, queue_test_success_res(), json.dumps(queue_test_success_res())
+        )
 
     monkeypatch.setattr(requests, "post", mockpost)
     result = cli_test_runner.invoke(
         cli, ["exec", str(ap_file), "-a", mock_api_endpoint(), "-w", "wc3"]
     )
     assert result.exit_code == 0
     assert (
-        f"Success. View {mock_api_endpoint()} to see the scheduling outcome."
+        f"Success. View {mock_api_endpoint()}/dashboard?sessionId=testSessionId to see the scheduling outcome."
         in result.output
     )
 
@@ -107,3 +111,42 @@ def test_bad_workcell(cli_test_runner, ap_file):
     )
     assert result.exit_code != 0
     assert "Workcell id must be like wcN but was bad-workcell-id" in result.stderr
+
+
+def test_session_id(cli_test_runner, monkeypatch, ap_file):
+    sessionId = "hi_there"
+
+    def mockpost(*args, **kwargs):
+        return MockResponse(
+            0,
+            queue_test_success_res(sessionId),
+            json.dumps(queue_test_success_res(sessionId)),
+        )
+
+    monkeypatch.setattr(requests, "post", mockpost)
+    result = cli_test_runner.invoke(
+        cli,
+        [
+            "exec",
+            str(ap_file),
+            "-a",
+            mock_api_endpoint(),
+            "-s",
+            sessionId,
+        ],
+    )
+    assert result.exit_code == 0
+    assert (
+        f"Success. View {mock_api_endpoint()}/dashboard?sessionId={sessionId} to see the scheduling outcome."
+        in result.output
+    )
+
+
+def test_too_many_workcell_definition_arguments(cli_test_runner, monkeypatch, ap_file):
+
+    result = cli_test_runner.invoke(
+        cli,
+        ["exec", str(ap_file), "-a", mock_api_endpoint(), "-s", "anthing", "-w", "wc0"],
+    )
+    assert result.exit_code == 0
+    assert "Error: --workcell-id, --session-id are mutually exclusive." in result.stderr

transcriptic/cli.py

@@ -641,13 +641,18 @@ def format_cmd(manifest):
 @click.option(
     "--workcell-id",
     "-w",
-    help="The workcell id to use for the device set. This is not permitted along with the `deviceSet` option.",
+    help="The workcell id to use for the device set. This is not permitted along with the `device-set` or `session-id` option.",
 )
 @click.option(
     "--device-set",
     "-d",
     type=click.File("r"),
-    help="A DeviceSet json file to use for scheduling. This is not permitted along with the `workcellId` option.",
+    help="A DeviceSet json file to use for scheduling. This is not permitted along with the `workcell-id` or `session-id` options.",
+)
+@click.option(
+    "--session-id",
+    "-s",
+    help="The session id of the session that should be used for scheduling this run. This is not permitted along with the `workcell-id` or `device-set` options.",
 )
 @click.option(
     "--time-limit",
@@ -656,6 +661,17 @@ def format_cmd(manifest):
     default=30,
     help="The maximum time in seconds to spend scheduling. The scheduler will use all the time until an optimal solution is found.",
 )
+@click.option(
+    "--schedule-at",
+    default=None,
+    help="The absolute time at which the given protocol should start (at the earliest). Absolute time format YYYY-MM-DDThh:mm in the local time of the target workcell (if year, month, or day is missing, it will be auto filled with the current values).",
+)
+@click.option(
+    "--schedule-delay",
+    type=click.INT,
+    default=None,
+    help="Delay in minutes at which the given protocol should start (at the earliest).",
+)
 @click.option(
     "--partition-group-size",
     type=click.INT,
@@ -678,7 +694,10 @@ def execute(
     api,
     workcell_id,
     device_set,
+    session_id,
     time_limit,
+    schedule_at,
+    schedule_delay,
     partition_group_size,
     partition_horizon,
     partitioning_swap_device_id,
@@ -689,7 +708,10 @@ def execute(
         api,
         workcell_id,
         device_set,
+        session_id,
         time_limit,
+        schedule_at,
+        schedule_delay,
         partition_group_size,
         partition_horizon,
         partitioning_swap_device_id,

transcriptic/commands.py

@@ -1481,22 +1481,41 @@ def execute(
     api,
     workcell_id,
     device_set,
+    session_id,
     time_limit,
+    schedule_at,
+    schedule_delay,
     partition_group_size,
     partition_horizon,
     partitioning_swap_device_id,
 ):
+    # Define the initial payload
+    payload = {"timeLimit": f"{time_limit}:second"}
+
+    if schedule_delay is not None and schedule_at is not None:
+        click.echo(
+            "Error: '--schedule-delay' and '--schedule-at' are mutually exclusive.",
+            err=True,
+        )
+        return
+
+    # Get the requested scheduling time
+    if schedule_delay is not None:
+        # round up to the next minute!
+        payload["delay"] = schedule_delay
+    elif schedule_at is not None:  # absolute time
+        payload["scheduleAt"] = schedule_at
+
     # Get the autoprotocol
     autoprotocol_str = autoprotocol.read()
     try:
-        autoprotocol_dict = json.loads(autoprotocol_str)
+        payload["autoprotocol"] = json.loads(autoprotocol_str)
     except json.decoder.JSONDecodeError as err:
         click.echo(f"Error decoding autoprotocol json: {err}", err=True)
         return
 
-    # Define the initial payload
-    payload = {"autoprotocol": autoprotocol_dict, "timeLimit": f"{time_limit}:second"}
-
+    # device set resolution
+    in_use = []
     if device_set:
         device_str = device_set.read()
         try:
@@ -1505,13 +1524,26 @@ def execute(
         except json.decoder.JSONDecodeError as err:
             click.echo(f"Error decoding device set json: {err}", err=True)
             return
-    elif workcell_id:
+        in_use.append("--device-set")
+
+    if workcell_id:
         if not re.search("^wc[a-z,0-9]+$", workcell_id):
             raise BadParameter(f"Workcell id must be like wcN but was {workcell_id}")
         payload["workcellIdForDeviceSet"] = f"{workcell_id}-mcx1"
-    else:
+        in_use.append("--workcell-id")
+
+    if session_id is not None:
+        payload["sessionId"] = session_id
+        in_use.append("--session-id")
+
+    if len(in_use) > 1:
+        click.echo(f"Error: {', '.join(in_use)} are mutually exclusive.", err=True)
+        return
+
+    if len(in_use) == 0:
         payload["workcellIdForDeviceSet"] = "wctest-mcx1"
 
+    # partition parameters
     if partition_group_size is not None:
         payload["partitionGroupSize"] = partition_group_size
 
@@ -1534,9 +1566,16 @@ def execute(
     try:
         res_json = json.loads(res.text)
         if res_json["success"]:
-            click.echo(f"Success. View {clean_api} to see the scheduling outcome.")
+            click.echo(
+                f"Success. View {clean_api}/dashboard?sessionId={res_json['sessionId']} to see the scheduling outcome."
+            )
         else:
             click.echo(f"Error: {res_json['message']}", err=True)
+            if "sessionId" in res_json:
+                click.echo(
+                    f"Dashboard can be seen at: {clean_api}/dashboard?sessionId={res_json['sessionId']}",
+                    err=True,
+                )
     except json.decoder.JSONDecodeError:
         click.echo(f"Error: {res.text}", err=True)