BatchSettings, LaunchSettings, Command, CommandList and LaunchCommand Refactor (#587)

Author: amandarichardsonn

conftest.py

@@ -58,16 +58,15 @@
 from smartsim.entity import Application
 from smartsim.error import SSConfigError, SSInternalError
 from smartsim.log import get_logger
-from smartsim.settings import (
-    AprunSettings,
-    DragonRunSettings,
-    JsrunSettings,
-    MpiexecSettings,
-    MpirunSettings,
-    PalsMpiexecSettings,
-    RunSettings,
-    SrunSettings,
-)
+# Mock imports
+class AprunSettings: pass
+class DragonRunSettings: pass
+class JsrunSettings: pass
+class MpiexecSettings: pass
+class MpirunSettings: pass
+class PalsMpiexecSettings: pass
+class RunSettings: pass
+class SrunSettings: pass
 
 logger = get_logger(__name__)
 

smartsim/_core/commands/__init__.py

@@ -0,0 +1,29 @@
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2024, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from .command import Command
+from .commandList import CommandList
+from .launchCommands import LaunchCommands

smartsim/_core/commands/command.py

@@ -0,0 +1,78 @@
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2024, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import typing as t
+from collections.abc import MutableSequence
+
+from ...settings.launchCommand import LauncherType
+
+
+class Command(MutableSequence[str]):
+    """Basic container for command information"""
+
+    def __init__(self, launcher: LauncherType, command: t.List[str]) -> None:
+        """Command constructor"""
+        self._launcher = launcher
+        self._command = command
+
+    @property
+    def launcher(self) -> LauncherType:
+        """Get the launcher type.
+        Return a reference to the LauncherType.
+        """
+        return self._launcher
+
+    @property
+    def command(self) -> t.List[str]:
+        """Get the command list.
+        Return a reference to the command list.
+        """
+        return self._command
+
+    def __getitem__(self, idx: int) -> str:
+        """Get the command at the specified index."""
+        return self._command[idx]
+
+    def __setitem__(self, idx: int, value: str) -> None:
+        """Set the command at the specified index."""
+        self._command[idx] = value
+
+    def __delitem__(self, idx: int) -> None:
+        """Delete the command at the specified index."""
+        del self._command[idx]
+
+    def __len__(self) -> int:
+        """Get the length of the command list."""
+        return len(self._command)
+
+    def insert(self, idx: int, value: str) -> None:
+        """Insert a command at the specified index."""
+        self._command.insert(idx, value)
+
+    def __str__(self) -> str:  # pragma: no cover
+        string = f"\nLauncher: {self.launcher.value}\n"
+        string += f"Command: {' '.join(str(cmd) for cmd in self.command)}"
+        return string

smartsim/_core/commands/commandList.py

@@ -0,0 +1,74 @@
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2024, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import typing as t
+from collections.abc import MutableSequence
+
+from .command import Command
+
+
+class CommandList(MutableSequence[Command]):
+    """Container for a Sequence of Command objects"""
+
+    def __init__(self, commands: t.Union[Command, t.List[Command]]):
+        """CommandList constructor"""
+        if isinstance(commands, Command):
+            commands = [commands]
+        self._commands: t.List[Command] = list(commands)
+
+    @property
+    def commands(self) -> t.List[Command]:
+        """Get the Command list.
+        Return a reference to the Command list.
+        """
+        return self._commands
+
+    def __getitem__(self, idx: int) -> Command:
+        """Get the Command at the specified index."""
+        return self._commands[idx]
+
+    def __setitem__(self, idx: int, value: Command) -> None:
+        """Set the Command at the specified index."""
+        self._commands[idx] = value
+
+    def __delitem__(self, idx: int) -> None:
+        """Delete the Command at the specified index."""
+        del self._commands[idx]
+
+    def __len__(self) -> int:
+        """Get the length of the Command list."""
+        return len(self._commands)
+
+    def insert(self, idx: int, value: Command) -> None:
+        """Insert a Command at the specified index."""
+        self._commands.insert(idx, value)
+
+    def __str__(self) -> str:  # pragma: no cover
+        string = "\n\nCommand List:\n\n"
+        for counter, cmd in enumerate(self.commands):
+            string += f"CommandList index {counter} value:"
+            string += f"{cmd}\n\n"
+        return string

smartsim/_core/commands/launchCommands.py

@@ -0,0 +1,51 @@
+from .commandList import CommandList
+
+
+class LaunchCommands:
+    """Container for aggregating prelaunch commands (e.g. file
+    system operations), launch commands, and postlaunch commands
+    """
+
+    def __init__(
+        self,
+        prelaunch_commands: CommandList,
+        launch_commands: CommandList,
+        postlaunch_commands: CommandList,
+    ) -> None:
+        """LaunchCommand constructor"""
+        self._prelaunch_commands = prelaunch_commands
+        self._launch_commands = launch_commands
+        self._postlaunch_commands = postlaunch_commands
+
+    @property
+    def prelaunch_command(self) -> CommandList:
+        """Get the prelaunch command list.
+        Return a reference to the command list.
+        """
+        return self._prelaunch_commands
+
+    @property
+    def launch_command(self) -> CommandList:
+        """Get the launch command list.
+        Return a reference to the command list.
+        """
+        return self._launch_commands
+
+    @property
+    def postlaunch_command(self) -> CommandList:
+        """Get the postlaunch command list.
+        Return a reference to the command list.
+        """
+        return self._postlaunch_commands
+
+    def __str__(self) -> str:  # pragma: no cover
+        string = "\n\nPrelaunch Command List:\n"
+        for pre_cmd in self.prelaunch_command:
+            string += f"{pre_cmd}\n"
+        string += "\n\nLaunch Command List:\n"
+        for launch_cmd in self.launch_command:
+            string += f"{launch_cmd}\n"
+        string += "\n\nPostlaunch Command List:\n"
+        for post_cmd in self.postlaunch_command:
+            string += f"{post_cmd}\n"
+        return string

smartsim/_core/launcher/step/localStep.py

@@ -29,8 +29,7 @@
 import typing as t
 
 from ....entity import Application, FSNode
-from ....settings import Singularity
-from ....settings.base import RunSettings
+from ....settings import RunSettings, Singularity
 from .step import Step, proxyable_launch_cmd
 
 

smartsim/_core/launcher/step/lsfStep.py

@@ -31,8 +31,7 @@
 from ....entity import Application, FSNode
 from ....error import AllocationError
 from ....log import get_logger
-from ....settings import BsubBatchSettings, JsrunSettings
-from ....settings.base import RunSettings
+from ....settings import BsubBatchSettings, JsrunSettings, RunSettings
 from .step import Step
 
 logger = get_logger(__name__)

smartsim/_core/launcher/step/mpiStep.py

@@ -32,8 +32,7 @@
 from ....entity import Application, FSNode
 from ....error import AllocationError, SmartSimError
 from ....log import get_logger
-from ....settings import MpiexecSettings, MpirunSettings, OrterunSettings
-from ....settings.base import RunSettings
+from ....settings import MpiexecSettings, MpirunSettings, OrterunSettings, RunSettings
 from .step import Step, proxyable_launch_cmd
 
 logger = get_logger(__name__)

smartsim/_core/launcher/step/step.py

@@ -39,7 +39,7 @@
 
 from ....entity import Application, Ensemble, FSNode
 from ....log import get_logger
-from ....settings.base import RunSettings, SettingsBase
+from ....settings import RunSettings, SettingsBase
 from ...utils.helpers import encode_cmd, get_base_36_repr
 from ..colocated import write_colocated_launch_script
 

smartsim/_core/utils/helpers.py

@@ -87,7 +87,7 @@ def check_dev_log_level() -> bool:
     return lvl == "developer"
 
 
-def fmt_dict(value: t.Dict[str, t.Any]) -> str:
+def fmt_dict(value: t.Mapping[str, t.Any]) -> str:
     fmt_str = ""
     for k, v in value.items():
         fmt_str += "\t" + str(k) + " = " + str(v)