openjd-cli 0.4.0__tar.gz → 0.4.1__tar.gz

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openjd-cli
-Version: 0.4.0
+Version: 0.4.1
 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
@@ -105,7 +105,7 @@ customize the Job, as parameters can have an impact on the amount of Steps and T
 |---|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
 |`path`|path|yes| A path leading to a Job template file.                                                                                                                                                                                                    |`/path/to/job.template.json`|
 |`--job-param`, `-p`|string, path|no| The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear. |`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`|
-|`--step-name`|string|no| The name of the Step to summarize.                                                                                                                                                                                                        |`--step-name Step1`|
+|`--step`|string|no| The name of the Step to summarize.                                                                                                                                                                                                        |`--step Step1`|
 |`--output`|string|no| How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.                                                                                                                             |`--output json`, `--output yaml`|
 
 #### Example
@@ -150,22 +150,24 @@ details on how Open Job Description's Jobs are run within Sessions.
 |Name|Type|Required| Description                                                                                                                                                                                                                                                                           |Example|
 |---|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
 |`path`|path|yes| A path leading to a Job template file.                                                                                                                                                                                                                                                |`/path/to/job.template.json`|
-|`--step-name`|string|yes| The name of the Step to run in a local Session.                                                                                                                                                                                                                                       |`--step-name Step1`|
+|`--step`|string|yes| The name of the Step to run in a local Session.                                                                                                                                                                                                                                       |`--step Step1`|
 |`--environment`|paths|no| Path to a file containing Environment Template definitions. Can be provided multiple times.                                                                                                                                                                                           |`--environment /path/to/env.template1.json --environment /path/to/env.template2.yaml`|
 |`--job-param`, `-p`|string, path|no| The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or as path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear.                                          |`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`|
-|`--task-params`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`|
+|`--task-param`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`|
 |`--tasks`|string, path|no| Instructs the command to run one or more tasks for the Step in a Session. The argument must be either the filename of a JSON or YAML file containing an array of maps from task parameter name to value; or an inlined JSON string of the same. Mutually exclusive with `--task-param/-tp` and `--maximum-tasks`. |`--tasks '[{"MyParam": 5}]'`, `--tasks file://parameter_set_file.json`|
-|`--maximum-tasks`|integer|no| A maximum number of Tasks to run from this Step. Unless present, the Session will run all Tasks defined in the Step's parameter space or the Task(s) selected by the `--task-params` or `--tasks` arguments. Mutually exclusive with `--task-param/-tp` and `--tasks`. |`--maximum-tasks 5`|
+|`--maximum-tasks`|integer|no| A maximum number of Tasks to run from this Step. Unless present, the Session will run all Tasks defined in the Step's parameter space or the Task(s) selected by the `--task-param` or `--tasks` arguments. Mutually exclusive with `--task-param/-tp` and `--tasks`. |`--maximum-tasks 5`|
 |`--run-dependencies`|flag|no| If present, runs all of a Step's dependencies in the Session prior to the Step itself.                                                                                                                                                                                                |`--run-dependencies`|
 |`--path-mapping-rules`|string, path|no| The path mapping rules to apply to the template. Should be a JSON-formatted list of Open Job Description path mapping rules, provided as a string or a path to a JSON/YAML document prefixed with 'file://'.                                                                          |`--path-mapping-rules [{"source_os": "Windows", "source_path": "C:\test", "destination_path": "/mnt/test"}]`, `--path-mapping-rules file://rules_file.json`|
+|`--preserve`|flag|no| If present, the Session's working directory will not be deleted when the run is completed.           |`--preserve`|
+|`--verbose`|flag|no| If present, then verbose logging will be enabled in the Session's log. |`--verbose`|
 |`--output`|string|no| How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.                                                                                                                                                                         |`--output json`, `--output yaml`|
 
 #### Example
 ```sh
 $ openjd-cli run /path/to/job.template.json --step Step1 \
     --job-param PingServer=amazon.com \
-    --task-params PingCount=20 \
-    --task-params PingDelay=30
+    --task-param PingCount=20 \
+    --task-param PingDelay=30
 
 # ... Task logs accompanied by timestamps ...
 

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/README.md

@@ -78,7 +78,7 @@ customize the Job, as parameters can have an impact on the amount of Steps and T
 |---|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
 |`path`|path|yes| A path leading to a Job template file.                                                                                                                                                                                                    |`/path/to/job.template.json`|
 |`--job-param`, `-p`|string, path|no| The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear. |`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`|
-|`--step-name`|string|no| The name of the Step to summarize.                                                                                                                                                                                                        |`--step-name Step1`|
+|`--step`|string|no| The name of the Step to summarize.                                                                                                                                                                                                        |`--step Step1`|
 |`--output`|string|no| How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.                                                                                                                             |`--output json`, `--output yaml`|
 
 #### Example
@@ -123,22 +123,24 @@ details on how Open Job Description's Jobs are run within Sessions.
 |Name|Type|Required| Description                                                                                                                                                                                                                                                                           |Example|
 |---|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
 |`path`|path|yes| A path leading to a Job template file.                                                                                                                                                                                                                                                |`/path/to/job.template.json`|
-|`--step-name`|string|yes| The name of the Step to run in a local Session.                                                                                                                                                                                                                                       |`--step-name Step1`|
+|`--step`|string|yes| The name of the Step to run in a local Session.                                                                                                                                                                                                                                       |`--step Step1`|
 |`--environment`|paths|no| Path to a file containing Environment Template definitions. Can be provided multiple times.                                                                                                                                                                                           |`--environment /path/to/env.template1.json --environment /path/to/env.template2.yaml`|
 |`--job-param`, `-p`|string, path|no| The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or as path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear.                                          |`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`|
-|`--task-params`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`|
+|`--task-param`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`|
 |`--tasks`|string, path|no| Instructs the command to run one or more tasks for the Step in a Session. The argument must be either the filename of a JSON or YAML file containing an array of maps from task parameter name to value; or an inlined JSON string of the same. Mutually exclusive with `--task-param/-tp` and `--maximum-tasks`. |`--tasks '[{"MyParam": 5}]'`, `--tasks file://parameter_set_file.json`|
-|`--maximum-tasks`|integer|no| A maximum number of Tasks to run from this Step. Unless present, the Session will run all Tasks defined in the Step's parameter space or the Task(s) selected by the `--task-params` or `--tasks` arguments. Mutually exclusive with `--task-param/-tp` and `--tasks`. |`--maximum-tasks 5`|
+|`--maximum-tasks`|integer|no| A maximum number of Tasks to run from this Step. Unless present, the Session will run all Tasks defined in the Step's parameter space or the Task(s) selected by the `--task-param` or `--tasks` arguments. Mutually exclusive with `--task-param/-tp` and `--tasks`. |`--maximum-tasks 5`|
 |`--run-dependencies`|flag|no| If present, runs all of a Step's dependencies in the Session prior to the Step itself.                                                                                                                                                                                                |`--run-dependencies`|
 |`--path-mapping-rules`|string, path|no| The path mapping rules to apply to the template. Should be a JSON-formatted list of Open Job Description path mapping rules, provided as a string or a path to a JSON/YAML document prefixed with 'file://'.                                                                          |`--path-mapping-rules [{"source_os": "Windows", "source_path": "C:\test", "destination_path": "/mnt/test"}]`, `--path-mapping-rules file://rules_file.json`|
+|`--preserve`|flag|no| If present, the Session's working directory will not be deleted when the run is completed.           |`--preserve`|
+|`--verbose`|flag|no| If present, then verbose logging will be enabled in the Session's log. |`--verbose`|
 |`--output`|string|no| How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.                                                                                                                                                                         |`--output json`, `--output yaml`|
 
 #### Example
 ```sh
 $ openjd-cli run /path/to/job.template.json --step Step1 \
     --job-param PingServer=amazon.com \
-    --task-params PingCount=20 \
-    --task-params PingDelay=30
+    --task-param PingCount=20 \
+    --task-param PingDelay=30
 
 # ... Task logs accompanied by timestamps ...
 

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/openjd/cli/_common/__init__.py

@@ -157,7 +157,7 @@ def print_cli_result(command: Callable[[Namespace], OpenJDCliResult]) -> Callabl
     Used to decorate the `do_<command>` functions for each command.
     """
 
-    def format_results(args: Namespace) -> None:
+    def format_results(args: Namespace) -> OpenJDCliResult:
         response = command(args)
 
         if args.output == "human-readable":
@@ -175,4 +175,6 @@ def print_cli_result(command: Callable[[Namespace], OpenJDCliResult]) -> Callabl
         if response.status == "error":
             raise SystemExit(1)
 
+        return response
+
     return format_results

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/openjd/cli/_run/_local_session/_session_manager.py

@@ -62,6 +62,7 @@ class LocalSession:
         path_mapping_rules: Optional[list[PathMappingRule]] = None,
         environments: Optional[list[EnvironmentTemplate]] = None,
         should_print_logs: bool = True,
+        retain_working_dir: bool = False,
     ):
         self.session_id = session_id
         self.ended = Event()
@@ -85,6 +86,7 @@ class LocalSession:
             job_parameter_values=job_parameters,
             path_mapping_rules=self._path_mapping_rules,
             callback=self._action_callback,
+            retain_working_dir=retain_working_dir,
         )
 
         # Initialize the action queue

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/openjd/cli/_run/_run_command.py

@@ -6,6 +6,7 @@ from pathlib import Path
 import json
 from typing import Optional
 import re
+import logging
 
 from ._local_session._session_manager import LocalSession, LogEntry
 from .._common import (
@@ -22,7 +23,7 @@ from openjd.model import (
     Step,
     StepParameterSpaceIterator,
 )
-from openjd.sessions import PathMappingRule
+from openjd.sessions import PathMappingRule, LOG
 
 
 @dataclass
@@ -119,6 +120,20 @@ def add_run_arguments(run_parser: ArgumentParser):
         metavar="<path-to-JSON/YAML-file> [<path-to-JSON/YAML-file>] ...",
         help="Apply the given environments to the Session in the order given.",
     )
+    run_parser.add_argument(
+        "--preserve",
+        action="store_const",
+        const=True,
+        default=False,
+        help="Do not automatically delete the Session's Working Directory when complete.",
+    )
+    run_parser.add_argument(
+        "--verbose",
+        action="store_const",
+        const=True,
+        default=False,
+        help="Enable verbose logging while running the Session.",
+    )
 
 
 def _collect_required_steps(step_map: dict[str, Step], step: Step) -> list[Step]:
@@ -301,6 +316,7 @@ def _run_local_session(
     path_mapping_rules: Optional[list[PathMappingRule]],
     should_run_dependencies: bool = False,
     should_print_logs: bool = True,
+    retain_working_dir: bool = False,
 ) -> OpenJDCliResult:
     """
     Creates a Session object and listens for log messages to synchronously end the session.
@@ -320,6 +336,7 @@ def _run_local_session(
         path_mapping_rules=path_mapping_rules,
         environments=environments,
         should_print_logs=should_print_logs,
+        retain_working_dir=retain_working_dir,
     ) as session:
         session.initialize(
             dependencies=dependencies,
@@ -332,10 +349,15 @@ def _run_local_session(
         # Monitor the local Session state
         session.ended.wait()
 
+    preserved_message: str = ""
+    if retain_working_dir:
+        preserved_message = (
+            f"\nWorking directory preserved at: {str(session._inner_session.working_directory)}"
+        )
     if session.failed:
         return OpenJDRunResult(
             status="error",
-            message="Session ended with errors; see Task logs for details",
+            message="Session ended with errors; see Task logs for details" + preserved_message,
             job_name=job.name,
             step_name=step.name,
             duration=session.get_duration(),
@@ -345,7 +367,7 @@ def _run_local_session(
 
     return OpenJDRunResult(
         status="success",
-        message="Session ended successfully",
+        message="Session ended successfully" + preserved_message,
         job_name=job.name,
         step_name=step.name,
         duration=session.get_duration(),
@@ -397,6 +419,9 @@ def do_run(args: Namespace) -> OpenJDCliResult:
         rules_list = parsed_rules.get("path_mapping_rules")
         path_mapping_rules = [PathMappingRule.from_dict(rule) for rule in rules_list]
 
+    if args.verbose:
+        LOG.setLevel(logging.DEBUG)
+
     try:
         # Raises: RuntimeError
         the_job = generate_job(args)
@@ -430,4 +455,5 @@ def do_run(args: Namespace) -> OpenJDCliResult:
         path_mapping_rules=path_mapping_rules,
         should_run_dependencies=(args.run_dependencies),
         should_print_logs=(args.output == "human-readable"),
+        retain_working_dir=args.preserve,
     )

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/openjd/cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.0'
-__version_tuple__ = version_tuple = (0, 4, 0)
+__version__ = version = '0.4.1'
+__version_tuple__ = version_tuple = (0, 4, 1)

{openjd_cli-0.4.0 → openjd_cli-0.4.1}/pyproject.toml

@@ -174,6 +174,27 @@ omit= [
 major_on_zero = false
 tag_format = "{version}"
 
+[tool.semantic_release.commit_parser_options]
+allowed_tags = [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "style",
+    "refactor",
+    "test",
+]
+minor_tags = []
+patch_tags = [
+  "chore",
+  "feat",
+  "fix",
+  "refactor",
+]
+
 [tool.semantic_release.publish]
 upload_to_vcs_release = false