hpcflow 0.1.9__py3-none-any.whl → 0.2.0a271__py3-none-any.whl

hpcflow/tests/unit/test_schema_input.py

@@ -0,0 +1,372 @@
+from __future__ import annotations
+from pathlib import Path
+from typing import TYPE_CHECKING
+import pytest
+
+from hpcflow.app import app as hf
+from hpcflow.sdk.core.parameters import NullDefault
+from hpcflow.sdk.core.test_utils import P1_parameter_cls as P1
+
+if TYPE_CHECKING:
+    from hpcflow.sdk.core.json_like import JSONDocument
+
+
+@pytest.fixture
+def null_config(tmp_path):
+    if not hf.is_config_loaded:
+        hf.load_config(config_dir=tmp_path)
+
+
+def test_null_default_value(null_config) -> None:
+    p1 = hf.Parameter("p1")
+    p1_inp = hf.SchemaInput(parameter=p1)
+    assert "default_value" not in p1_inp.labels[""]
+
+
+def test_null_default_value_property(null_config) -> None:
+    p1 = hf.Parameter("p1")
+    p1_inp = hf.SchemaInput(parameter=p1)
+    assert p1_inp.default_value is NullDefault.NULL
+
+
+def test_none_default_value(null_config) -> None:
+    """A `None` default value is set with a value of `None`"""
+    p1 = hf.Parameter("p1")
+    p1_inp = hf.SchemaInput(parameter=p1, default_value=None)
+    def_val_exp = hf.InputValue(parameter=p1, label="", value=None)
+    def_val_exp._schema_input = p1_inp
+    assert p1_inp.labels[""]["default_value"].value == def_val_exp.value
+
+
+def test_from_json_like_labels_and_default(null_config) -> None:
+    json_like: JSONDocument = {
+        "parameter": "p1",
+        "labels": {"0": {}},
+        "default_value": None,
+    }
+    inp = hf.SchemaInput.from_json_like(
+        json_like=json_like,
+        shared_data=hf.template_components,
+    )
+    assert inp.labels["0"]["default_value"].value == None
+
+
+def test_element_get_removes_schema_param_trivial_label(null_config, tmp_path: Path):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1", inputs=[hf.SchemaInput(parameter="p1", labels={label: {}})]
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    assert f"inputs.p1[{label}]" in wk.tasks[0].elements[0].get_data_idx("inputs")
+    assert wk.tasks[0].elements[0].get("inputs") == {"p1": p1_val}
+
+
+def test_element_inputs_removes_schema_param_trivial_label(null_config, tmp_path: Path):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[hf.SchemaInput(parameter="p1", labels={label: {}})],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[hf.Command(command=f"echo <<parameter:p1[{label}]>>")],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    element = wk.tasks[0].elements[0]
+    # element inputs:
+    assert element.inputs._get_prefixed_names() == ["p1"]
+
+    # element iteration inputs:
+    assert element.iterations[0].inputs._get_prefixed_names() == ["p1"]
+
+    # run inputs:
+    assert element.iterations[0].action_runs[0].inputs._get_prefixed_names() == ["p1"]
+
+
+def test_element_get_does_not_removes_multiple_schema_param_label(
+    null_config, tmp_path: Path
+):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[hf.SchemaInput(parameter="p1", labels={label: {}}, multiple=True)],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    assert f"inputs.p1[{label}]" in wk.tasks[0].elements[0].get_data_idx("inputs")
+    assert wk.tasks[0].elements[0].get("inputs") == {f"p1[{label}]": p1_val}
+
+
+def test_element_inputs_does_not_remove_multiple_schema_param_label(
+    null_config, tmp_path: Path
+):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[hf.SchemaInput(parameter="p1", labels={label: {}}, multiple=True)],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[hf.Command(command=f"echo <<parameter:p1[{label}]>>")],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    element = wk.tasks[0].elements[0]
+    # element inputs:
+    assert element.inputs._get_prefixed_names() == [f"p1[{label}]"]
+
+    # element iteration inputs:
+    assert element.iterations[0].inputs._get_prefixed_names() == [f"p1[{label}]"]
+
+    # run inputs:
+    assert element.iterations[0].action_runs[0].inputs._get_prefixed_names() == [
+        f"p1[{label}]"
+    ]
+
+
+def test_get_input_values_for_multiple_schema_input_single_label(
+    null_config, tmp_path: Path
+):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1", labels={label: {}}, multiple=False),
+            hf.SchemaInput(parameter="p2", default_value=201),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[
+                    hf.Command(command=f"echo <<parameter:p1[{label}]>> <<parameter:p2>>")
+                ],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values() == {"p2": 201, "p1": 101}
+
+
+def test_get_input_values_subset(null_config, tmp_path: Path):
+    p1_val = 101
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1"),
+            hf.SchemaInput(parameter="p2", default_value=201),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[hf.Command(command=f"echo <<parameter:p1>> <<parameter:p2>>")],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values(data_in_keys=("inputs.p1",)) == {"p1": 101}
+
+
+def test_get_input_values_subset_labelled_label_dict_False(null_config, tmp_path: Path):
+    p1_val = 101
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1", labels={"one": {}}, multiple=True),
+            hf.SchemaInput(
+                parameter="p2",
+                labels={"two": {}},
+                multiple=False,
+                default_value=201,
+            ),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[
+                    hf.Command(
+                        command=f"echo <<parameter:p1[one]>> <<parameter:p2[two]>>"
+                    )
+                ],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label="one")])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values(data_in_keys=("inputs.p1[one]",), label_dict=False) == {
+        "p1[one]": 101
+    }
+
+
+def test_get_input_values_subset_labelled_label_dict_True(null_config, tmp_path: Path):
+    p1_val = 101
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1", labels={"one": {}}, multiple=True),
+            hf.SchemaInput(
+                parameter="p2",
+                labels={"two": {}},
+                multiple=False,
+                default_value=201,
+            ),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[
+                    hf.Command(
+                        command=f"echo <<parameter:p1[one]>> <<parameter:p2[two]>>"
+                    )
+                ],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label="one")])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values(data_in_keys=("inputs.p1[one]",), label_dict=True) == {
+        "p1": {"one": 101}
+    }
+
+
+def test_get_input_values_for_multiple_schema_input(null_config, tmp_path: Path):
+    p1_val = 101
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1", labels={label: {}}, multiple=True),
+            hf.SchemaInput(parameter="p2", default_value=201),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[
+                    hf.Command(command=f"echo <<parameter:p1[{label}]>> <<parameter:p2>>")
+                ],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values() == {"p2": 201, "p1": {label: 101}}
+
+
+def test_get_input_values_for_multiple_schema_input_with_object(
+    null_config, tmp_path: Path
+):
+    p1_val = P1(a=101)
+    label = "my_label"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[
+            hf.SchemaInput(parameter="p1c", labels={label: {}}, multiple=True),
+            hf.SchemaInput(parameter="p2", default_value=201),
+        ],
+        actions=[
+            hf.Action(
+                environments=[hf.ActionEnvironment("null_env")],
+                commands=[
+                    hf.Command(
+                        command=f"echo <<parameter:p1c[{label}]>> <<parameter:p2>>"
+                    )
+                ],
+            ),
+        ],
+    )
+    t1 = hf.Task(schema=[s1], inputs=[hf.InputValue("p1c", p1_val, label=label)])
+    wk = hf.Workflow.from_template_data(
+        tasks=[t1],
+        path=tmp_path,
+        template_name="temp",
+    )
+    run = wk.tasks[0].elements[0].iterations[0].action_runs[0]
+    assert run.get_data_in_values() == {"p2": 201, "p1c": {label: p1_val}}
+
+
+@pytest.mark.integration
+def test_get_input_values_all_iterations(null_config, tmp_path: Path):
+    s1 = hf.TaskSchema(
+        objective="t1",
+        inputs=[hf.SchemaInput(parameter=hf.Parameter("p1"))],
+        outputs=[hf.SchemaOutput(parameter=hf.Parameter("p1"))],
+        actions=[
+            hf.Action(
+                script="<<script:main_script_test_direct_in_direct_out_all_iters_test.py>>",
+                script_data_in={"p1": {"format": "direct", "all_iterations": True}},
+                script_data_out="direct",
+                script_exe="python_script",
+                environments=[hf.ActionEnvironment(environment="python_env")],
+            )
+        ],
+    )
+    p1_val = 101
+    t1 = hf.Task(schema=s1, inputs={"p1": p1_val})
+    wk = hf.Workflow.from_template_data(
+        template_name="main_script_test",
+        path=tmp_path,
+        tasks=[t1],
+        loops=[hf.Loop(tasks=[0], num_iterations=3)],
+    )
+    wk.submit(wait=True, add_to_known=False)
+    run = wk.tasks[0].elements[0].iterations[-1].actions[0].runs[-1]
+    assert run.get_data_in_values({"inputs.p1": {"all_iterations": True}}) == {
+        "p1": {
+            "iteration_0": {"loop_idx": {"loop_0": 0}, "value": 101},
+            "iteration_1": {"loop_idx": {"loop_0": 1}, "value": 102},
+            "iteration_2": {"loop_idx": {"loop_0": 2}, "value": 204},
+        }
+    }

hpcflow/tests/unit/test_shell.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+from pathlib import Path
+import sys
+
+import pytest
+
+import hpcflow.app as hf
+from hpcflow.sdk.submission.shells import ALL_SHELLS
+
+
+def test_process_JS_header_args_app_invoc_windows_powershell() -> None:
+    """
+    Three types of invocation commands exist:
+      1. the frozen app executable
+      2. a python executable calling the hpcflow package CLI module
+      3. a python executable calling the hpcflow entry point command
+
+    For the purposes of this test, 2. and 3. are equivalent. We test the expected output
+    of `WindowsPowerShell.process_JS_header_args` on the `app_invoc` key for all
+    variations. If there is a space in the executable, we expect the call operator (`&`)
+    to be used, followed by a single-quoted executable path. We expect executable
+    arguments (e.g. the hpcflow package CLI module path) to be double-quoted, regardless
+    of whether they include spaces.
+
+    """
+
+    app_invocs = [
+        ("C:\\path\to\frozen\app.exe",),
+        ("C:\\path\\to\\frozen\\app with spaces.exe",),
+        ("C:\\path\\to\\python.exe", "C:\\path\\to\\hpcflow\\cli.py"),
+        ("C:\\path\\to\\python with spaces.exe", "C:\\path\\to\\hpcflow\\cli.py"),
+        (
+            "C:\\path\\to\\python with spaces.exe",
+            "C:\\path\\to\\hpcflow\\cli with spaces.py",
+        ),
+    ]
+    expected = [
+        "C:\\path\to\frozen\app.exe",
+        "& 'C:\\path\\to\\frozen\\app with spaces.exe'",
+        'C:\\path\\to\\python.exe "C:\\path\\to\\hpcflow\\cli.py"',
+        "& 'C:\\path\\to\\python with spaces.exe' \"C:\\path\\to\\hpcflow\\cli.py\"",
+        "& 'C:\\path\\to\\python with spaces.exe' \"C:\\path\\to\\hpcflow\\cli with spaces.py\"",
+    ]
+    shell = ALL_SHELLS["powershell"]["nt"]()
+    for i, j in zip(app_invocs, expected):
+        processed = shell.process_JS_header_args({"app_invoc": i})
+        assert processed["app_invoc"] == j
+
+
+def test_process_JS_header_args_app_invoc_bash() -> None:
+    """
+    Three types of invocation commands exist:
+      1. the frozen app executable
+      2. a python executable calling the hpcflow package CLI module
+      3. a python executable calling the hpcflow entry point command
+
+    For the purposes of this test, 2. and 3. are equivalent. We test the expected output
+    of `Bash.process_JS_header_args` on the `app_invoc` key for all
+    variations. If there is a space in the executable, we expect spaces to be escaped
+    using the backslash. We expect executable arguments (e.g. the hpcflow package CLI
+    module path) to be double-quoted, regardless of whether they include spaces.
+
+    """
+
+    app_invocs = [
+        ("/mnt/path/to/frozen/app.exe",),
+        ("/mnt/path/to/frozen/app with spaces.exe",),
+        ("/mnt/path/to/python.exe", "/mnt/path/to/hpcflow/cli.py"),
+        ("/mnt/path/to/python with spaces.exe", "/mnt/path/to/hpcflow/cli.py"),
+        (
+            "/mnt/path/to/python with spaces.exe",
+            "/mnt/path/to/hpcflow/cli with spaces.py",
+        ),
+    ]
+    expected = [
+        "/mnt/path/to/frozen/app.exe",
+        "/mnt/path/to/frozen/app\\ with\\ spaces.exe",
+        '/mnt/path/to/python.exe "/mnt/path/to/hpcflow/cli.py"',
+        '/mnt/path/to/python\\ with\\ spaces.exe "/mnt/path/to/hpcflow/cli.py"',
+        '/mnt/path/to/python\\ with\\ spaces.exe "/mnt/path/to/hpcflow/cli with spaces.py"',
+    ]
+    shell = ALL_SHELLS["bash"]["posix"]()
+    for i, j in zip(app_invocs, expected):
+        processed = shell.process_JS_header_args({"app_invoc": i})
+        assert processed["app_invoc"] == j
+
+
+def test_format_array_powershell():
+    shell = ALL_SHELLS["powershell"]["nt"]()
+    assert shell.format_array([1, 2, 3]) == "@(1, 2, 3)"
+
+
+def test_format_array_get_item_powershell():
+    shell = ALL_SHELLS["powershell"]["nt"]()
+    assert shell.format_array_get_item("my_arr", 3) == "$my_arr[3]"
+
+
+def test_format_array_bash():
+    shell = ALL_SHELLS["bash"]["posix"]()
+    assert shell.format_array([1, 2, 3]) == "(1 2 3)"
+
+
+def test_format_array_get_item_bash():
+    shell = ALL_SHELLS["bash"]["posix"]()
+    assert shell.format_array_get_item("my_arr", 3) == r"${my_arr[3]}"
+
+
+@pytest.mark.integration
+@pytest.mark.skipif(condition=sys.platform == "win32", reason="This is a bash-only test.")
+def test_executable_args_bash_login(null_config, tmp_path: Path):
+    """Check if we provide a `--login` argument to the shell `executable_args`, we end up
+    in a login shell on bash."""
+
+    cmd = "shopt -q login_shell && echo 'Login shell' || echo 'Not login shell'"
+    s1 = hf.TaskSchema(
+        objective="t1",
+        actions=[hf.Action(commands=[hf.Command(command=cmd)])],
+    )
+    t1 = hf.Task(
+        schema=s1,
+        resources={"any": {"shell_args": {"executable_args": ["--login"]}}},
+    )
+    wkt = hf.WorkflowTemplate(name="test_bash_login", tasks=[t1])
+    wk = hf.Workflow.from_template(
+        template=wkt,
+        path=tmp_path,
+    )
+    wk.submit(wait=True, status=False, add_to_known=False)
+    assert wk.submissions[0].jobscripts[0].get_stdout().strip() == "Login shell"

hpcflow/tests/unit/test_slurm.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+from hpcflow.sdk.submission.schedulers.slurm import SlurmPosix
+
+
+def test_parse_job_ID_simple() -> None:
+    assert SlurmPosix._parse_job_IDs("123") == ("123", None)
+
+
+def test_parse_job_ID_simple_array_item() -> None:
+    assert SlurmPosix._parse_job_IDs("123_10") == ("123", [9])
+
+
+def test_parse_job_ID_array_simple_range() -> None:
+    assert SlurmPosix._parse_job_IDs("3397752_[9-11]") == ("3397752", [8, 9, 10])
+
+
+def test_parse_job_ID_array_simple_multiple_range() -> None:
+    assert SlurmPosix._parse_job_IDs("49203_[3-5,9-11]") == (
+        "49203",
+        [2, 3, 4, 8, 9, 10],
+    )
+
+
+def test_parse_job_ID_array_simple_mixed_range() -> None:
+    assert SlurmPosix._parse_job_IDs("30627658_[5,8-10]") == (
+        "30627658",
+        [4, 7, 8, 9],
+    )
+
+
+def test_parse_job_ID_array_simple_range_with_max_concurrent() -> None:
+    assert SlurmPosix._parse_job_IDs("3397752_[9-11%2]") == ("3397752", [8, 9, 10])
+
+
+def test_parse_job_ID_array_simple_multiple_range_max_concurrent() -> None:
+    assert SlurmPosix._parse_job_IDs("49203_[3-5%1,9-11%2]") == (
+        "49203",
+        [2, 3, 4, 8, 9, 10],
+    )