openjd-cli 0.4.2__tar.gz → 0.4.4__tar.gz

{openjd_cli-0.4.2 → openjd_cli-0.4.4}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: openjd-cli
-Version: 0.4.2
+Version: 0.4.4
 Summary: Provides a command-line interface for working with Open Job Description templates.
 Project-URL: Homepage, https://github.com/OpenJobDescription/openjd-cli
 Project-URL: Source, https://github.com/OpenJobDescription/openjd-cli
+Author: Amazon Web Services
 License-Expression: Apache-2.0
 License-File: LICENSE
 License-File: NOTICE
@@ -22,12 +23,14 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
 Requires-Dist: openjd-model==0.4.*
-Requires-Dist: openjd-sessions==0.7.*
+Requires-Dist: openjd-sessions==0.8.*
 Description-Content-Type: text/markdown
 
 ## Open Job Description - CLI
 
 [![pypi](https://img.shields.io/pypi/v/openjd-cli.svg)](https://pypi.python.org/pypi/openjd-cli)
+[![python](https://img.shields.io/pypi/pyversions/openjd-cli.svg?style=flat)](https://pypi.python.org/pypi/openjd-cli)
+[![license](https://img.shields.io/pypi/l/openjd-cli.svg?style=flat)](https://github.com/OpenJobDescription/openjd-cli/blob/mainline/LICENSE)
 
 Open Job Description (OpenJD) is a flexible open specification for defining render jobs which are portable
 between studios and render solutions. This package provides a command-line interface that can be used
@@ -44,13 +47,6 @@ This library requires:
 2. Linux, MacOS, or Windows operating system;
 3. On Linux/MacOS:
     * `sudo`
-4. On Windows:
-    * PowerShell 5.x
-
-**EXPERIMENTAL** Note that compatibility with the Windows operating system is currently in active development
-and should be considered to be experimental. We recommend that this application not be used in Windows-based
-production environments at this time. We will remove this notice when Windows compatibility is considered
-sufficiently stable and secure for use in Windows-based production environments.
 
 ## Versioning
 
@@ -110,7 +106,7 @@ customize the Job, as parameters can have an impact on the amount of Steps and T
 
 #### Example
 ```sh
-$ openjd-cli summary /path/to/job.template.json \
+$ openjd summary /path/to/job.template.json \
     --job-param JobName=SampleJob \
     --job-param '{"FileToRender": "sample.blend"}' \
     --job-param file://some_more_parameters.json
@@ -164,7 +160,7 @@ details on how Open Job Description's Jobs are run within Sessions.
 
 #### Example
 ```sh
-$ openjd-cli run /path/to/job.template.json --step Step1 \
+$ openjd run /path/to/job.template.json --step Step1 \
     --job-param PingServer=amazon.com \
     --task-param PingCount=20 \
     --task-param PingDelay=30
@@ -193,7 +189,7 @@ Returns the Open Job Description model as a JSON schema document body.
 
 #### Example
 ```sh
-$ openjd-cli schema --version jobtemplate-2023-09
+$ openjd schema --version jobtemplate-2023-09
 
 {
     "title": "JobTemplate",

{openjd_cli-0.4.2 → openjd_cli-0.4.4}/README.md

@@ -1,6 +1,8 @@
 ## Open Job Description - CLI
 
 [![pypi](https://img.shields.io/pypi/v/openjd-cli.svg)](https://pypi.python.org/pypi/openjd-cli)
+[![python](https://img.shields.io/pypi/pyversions/openjd-cli.svg?style=flat)](https://pypi.python.org/pypi/openjd-cli)
+[![license](https://img.shields.io/pypi/l/openjd-cli.svg?style=flat)](https://github.com/OpenJobDescription/openjd-cli/blob/mainline/LICENSE)
 
 Open Job Description (OpenJD) is a flexible open specification for defining render jobs which are portable
 between studios and render solutions. This package provides a command-line interface that can be used
@@ -17,13 +19,6 @@ This library requires:
 2. Linux, MacOS, or Windows operating system;
 3. On Linux/MacOS:
     * `sudo`
-4. On Windows:
-    * PowerShell 5.x
-
-**EXPERIMENTAL** Note that compatibility with the Windows operating system is currently in active development
-and should be considered to be experimental. We recommend that this application not be used in Windows-based
-production environments at this time. We will remove this notice when Windows compatibility is considered
-sufficiently stable and secure for use in Windows-based production environments.
 
 ## Versioning
 
@@ -83,7 +78,7 @@ customize the Job, as parameters can have an impact on the amount of Steps and T
 
 #### Example
 ```sh
-$ openjd-cli summary /path/to/job.template.json \
+$ openjd summary /path/to/job.template.json \
     --job-param JobName=SampleJob \
     --job-param '{"FileToRender": "sample.blend"}' \
     --job-param file://some_more_parameters.json
@@ -137,7 +132,7 @@ details on how Open Job Description's Jobs are run within Sessions.
 
 #### Example
 ```sh
-$ openjd-cli run /path/to/job.template.json --step Step1 \
+$ openjd run /path/to/job.template.json --step Step1 \
     --job-param PingServer=amazon.com \
     --task-param PingCount=20 \
     --task-param PingDelay=30
@@ -166,7 +161,7 @@ Returns the Open Job Description model as a JSON schema document body.
 
 #### Example
 ```sh
-$ openjd-cli schema --version jobtemplate-2023-09
+$ openjd schema --version jobtemplate-2023-09
 
 {
     "title": "JobTemplate",

{openjd_cli-0.4.2 → openjd_cli-0.4.4}/openjd/cli/_run/_local_session/_session_manager.py

@@ -46,7 +46,8 @@ class LocalSession:
     _start_seconds: float
     _end_seconds: float
     _inner_session: Session
-    _action_queue: Queue[SessionAction]
+    _enter_env_queue: Queue[EnterEnvironmentAction]
+    _action_queue: Queue[RunTaskAction]
     _current_action: Optional[SessionAction]
     _action_ended: Event
     _path_mapping_rules: Optional[list[PathMappingRule]]
@@ -90,7 +91,8 @@ class LocalSession:
         )
 
         # Initialize the action queue
-        self._action_queue: Queue[SessionAction] = Queue()
+        self._enter_env_queue: Queue[EnterEnvironmentAction] = Queue()
+        self._action_queue: Queue[RunTaskAction] = Queue()
         self._current_action = None
 
         self._should_print_logs = should_print_logs
@@ -222,25 +224,52 @@ class LocalSession:
                     RunTaskAction(self._inner_session, step=step, parameters=param_set)
                 )
 
-        # Finally, enqueue ExitEnvironment Actions in reverse order to EnterEnvironment
-        for env_id in reversed(session_environment_ids):
-            self._action_queue.put(ExitEnvironmentAction(self._inner_session, env_id))
-
     def run(self) -> None:
         if self._inner_session.state != SessionState.READY:
             raise RuntimeError("Session is not in a READY state")
 
+        environments_entered = list[str]()
+        failed_action: Optional[SessionAction] = None
+
         self._start_seconds = time.perf_counter()
+
+        # Enter all of the Environments, and keep track of which ones we've entered
+        while not self._enter_env_queue.empty() and not self.failed:
+            self._action_ended.clear()
+            action = self._enter_env_queue.get()
+            environments_entered.append(action._id)
+            self._current_action = action
+            self._current_action.run()
+            self._action_ended.wait()
+            if self.failed:
+                failed_action = self._current_action
+
+        # Run all of the Tasks that are enqueued
         while not self._action_queue.empty() and not self.failed:
             self._action_ended.clear()
             self._current_action = self._action_queue.get()
             self._current_action.run()
             self._action_ended.wait()
+            if self.failed:
+                failed_action = self._current_action
+
+        # Exit all environments that were entered. We always try to exit all failed environments; even
+        # if an environment-enter, task, or environment exit failed.
+        while environments_entered:
+            prev_action_failed = self.failed
+            self._action_ended.clear()
+            self._current_action = ExitEnvironmentAction(
+                self._inner_session, environments_entered.pop()
+            )
+            self._current_action.run()
+            self._action_ended.wait()
+            if self.failed and not prev_action_failed:
+                failed_action = self._current_action
 
         if self.failed:
             # Action encountered an error; clean up resources and end session
             LOG.info(
-                msg=f"Open Job Description CLI: ERROR executing action: '{str(self._current_action)}' (see Task logs for details)",
+                msg=f"Open Job Description CLI: ERROR executing action: '{str(failed_action)}' (see Task logs for details)",
                 extra={"session_id": self.session_id},
             )
 
@@ -347,13 +376,13 @@ class LocalSession:
             if isinstance(self._current_action, RunTaskAction):
                 self.tasks_run += 1
             self._action_ended.set()
-        if new_status.state in (ActionState.FAILED, ActionState.CANCELED):
+        if new_status.state in (ActionState.FAILED, ActionState.CANCELED, ActionState.TIMEOUT):
             self.failed = True
             self._action_ended.set()
 
     def _add_environments(self, envs: list) -> list[str]:
         ids: list[str] = []
         for env in envs:
-            self._action_queue.put(EnterEnvironmentAction(self._inner_session, env, env.name))
+            self._enter_env_queue.put(EnterEnvironmentAction(self._inner_session, env, env.name))
             ids.append(env.name)
         return ids

{openjd_cli-0.4.2 → openjd_cli-0.4.4}/openjd/cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.2'
-__version_tuple__ = version_tuple = (0, 4, 2)
+__version__ = version = '0.4.4'
+__version_tuple__ = version_tuple = (0, 4, 4)

{openjd_cli-0.4.2 → openjd_cli-0.4.4}/pyproject.toml

@@ -4,6 +4,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "openjd-cli"
+authors = [
+  {name = "Amazon Web Services"},
+]
 dynamic = ["version"]
 readme = "README.md"
 license = "Apache-2.0"
@@ -26,7 +29,7 @@ classifiers = [
   "Intended Audience :: End Users/Desktop"
 ]
 dependencies = [
-  "openjd-sessions == 0.7.*",
+  "openjd-sessions == 0.8.*",
   "openjd-model == 0.4.*"
 ]