hcs-core 0.1.307__py3-none-any.whl → 0.1.309__py3-none-any.whl

hcs_core/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.307"
+__version__ = "0.1.309"

hcs_core/ctxp/cli_options.py

@@ -13,6 +13,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+import os
+
 import click
 
 verbose = click.option(
@@ -27,7 +29,7 @@ verbose = click.option(
 output = click.option(
     "--output",
     "-o",
-    type=click.Choice(["json", "json-compact", "yaml", "yml", "text", "table"], case_sensitive=False),
+    type=click.Choice(["json", "json-compact", "yaml", "yml", "table", "t", "text"], case_sensitive=False),
     default=None,
     hidden=True,
     help="Specify output format",
@@ -101,10 +103,24 @@ force = click.option("--force/--grace", type=bool, default=True, help="Specify d
 
 confirm = click.option("--confirm/--prompt", "-y", type=bool, default=False, help="Confirm the operation without prompt.")
 
+env = click.option(
+    "--env",
+    multiple=True,
+    type=str,
+    required=False,
+    help="Alternative explicit in-line environment variable override in KEY=VALUE format.",
+)
+
+
+def apply_env(envs):
+    for kv in envs:
+        k, v = kv.split("=", 1)
+        os.environ[k.strip()] = v.strip()
+
 
-def formatter(custom_fn):
+def formatter(formatter=None, columns=None):
     def decorator(f):
-        f.formatter = custom_fn
+        f.formatter = formatter if formatter else columns
         return f
 
     return decorator

hcs_core/ctxp/cli_processor.py

@@ -24,7 +24,7 @@ from pathlib import Path
 import click
 from click.core import Group
 
-from .util import avoid_trace_for_ctrl_c, print_error, print_output, validate_error_return
+from .util import avoid_trace_for_ctrl_c, default_table_formatter, print_error, print_output, validate_error_return
 
 _eager_loading = os.environ.get("_CTXP_EAGER_LOAD")
 if _eager_loading:
@@ -192,15 +192,17 @@ def _default_io(cmd: click.Command):
 
         telemetry_update(ctx.command_path, ctx.params)
 
-        if io_args["output"] == "table":
+        if io_args["output"] == "table" or io_args["output"] == "t":
 
             def _format(data):
-                if not hasattr(callback, "formatter"):
-                    from .util import CtxpException
-
-                    raise CtxpException("Table output is specified, but no custom formatter specified on the command.")
-                formatter = callback.__getattribute__("formatter")
-                return formatter(data)
+                if hasattr(callback, "formatter"):
+                    formatter = callback.__getattribute__("formatter")
+                else:
+                    formatter = default_table_formatter
+                if isinstance(formatter, dict):
+                    return default_table_formatter(data, formatter)
+                else:
+                    return formatter(data)
 
             io_args["format"] = _format
         ret = callback(*args, **kwargs)

hcs_core/ctxp/util.py

@@ -13,6 +13,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+import datetime
 import json
 import os
 import re
@@ -26,6 +27,7 @@ import click
 import httpx
 import questionary
 import yaml
+import yumako
 
 
 class CtxpException(Exception):
@@ -112,7 +114,7 @@ def print_output(data: Any, args: dict, file=sys.stdout):
                     text = data
                 else:
                     text = json.dumps(data, indent=4)
-            elif output == "table":
+            elif output == "table" or output == "t":
                 formatter = args["format"]
                 text = formatter(data)
             else:
@@ -411,3 +413,48 @@ def colorize(data: dict, name: str, mapping: dict):
             data[name] = click.style(s, fg=c)
     else:
         raise Exception(f"Unexpected mapping type: {type(mapping)} {mapping}")
+
+
+def default_table_formatter(data: Any, mapping: dict = None):
+    if not isinstance(data, list):
+        return data
+
+    def _restrict_readable_length(data: dict, name: str, length: int):
+        text = data.get(name)
+        if not text:
+            return
+        if len(text) > length:
+            data[name] = text[: length - 3] + "..."
+
+    field_mapping = {}
+    for d in data:
+        if "id" in d:
+            field_mapping["id"] = "Id"
+        if "name" in d:
+            field_mapping["name"] = "Name"
+        if "location" in d:
+            field_mapping["location"] = "Location"
+        if "type" in d:
+            field_mapping["type"] = "Type"
+        if "status" in d:
+            field_mapping["status"] = "Status"
+        if "createdAt" in d:
+            d["_createdStale"] = yumako.time.stale(d["createdAt"], datetime.timezone.utc)
+            field_mapping["_createdStale"] = "Created At"
+        if "updatedAt" in d:
+            d["_updatedStale"] = yumako.time.stale(d["updatedAt"], datetime.timezone.utc)
+            field_mapping["_updatedStale"] = "Updated At"
+
+        colorize(
+            d,
+            "status",
+            {
+                "READY": "green",
+                "SUCCESS": "green",
+                "ERROR": "red",
+            },
+        )
+        _restrict_readable_length(d, "name", 60)
+    if mapping:
+        field_mapping.update(mapping)
+    return format_table(data, fields_mapping=field_mapping)

hcs_core/sglib/cli_options.py

@@ -18,7 +18,9 @@ import os
 import click
 
 from hcs_core.ctxp import CtxpException, recent
+from hcs_core.ctxp.cli_options import apply_env as apply_env
 from hcs_core.ctxp.cli_options import confirm as confirm
+from hcs_core.ctxp.cli_options import env as env
 from hcs_core.ctxp.cli_options import exclude_field as exclude_field
 from hcs_core.ctxp.cli_options import field as field
 from hcs_core.ctxp.cli_options import first as first

hcs_core/sglib/client_util.py

@@ -288,10 +288,13 @@ def wait_for_res_deleted(
     resource_name: str,
     fn_get: Callable,
     timeout: str,
-    polling_interval_seconds: int = 10,
+    polling_interval: int = 10,
     fn_is_error: Callable = None,
 ):
     timeout_seconds = _parse_timeout(timeout)
+    polling_interval_seconds = _parse_timeout(polling_interval)
+    if polling_interval_seconds < 3:
+        polling_interval_seconds = 3
     start = time.time()
     while True:
         t = fn_get()
@@ -310,7 +313,7 @@ def wait_for_res_deleted(
         sleep_seconds = remaining_seconds
         if sleep_seconds > polling_interval_seconds:
             sleep_seconds = polling_interval_seconds
-        exit.sleep(sleep_seconds)
+        time.sleep(sleep_seconds)
 
 
 # flake8: noqa=E731
@@ -337,21 +340,25 @@ def wait_for_res_status(
         field_name = get_status
         get_status = lambda t: t[field_name]
     if status_map:
-        if isinstance(status_map["ready"], str):
-            status_map["ready"] = [status_map["ready"]]
-        if isinstance(status_map["transition"], str):
-            status_map["transition"] = [status_map["transition"]]
-        if isinstance(status_map["error"], str):
-            status_map["error"] = [status_map["error"]]
         if is_ready:
             raise CtxpException("Can not specify is_ready when status_map is provided.")
         if is_error:
             raise CtxpException("Can not specify is_error when status_map is provided.")
         if is_transition:
             raise CtxpException("Can not specify is_transition when status_map is provided.")
-        is_ready = lambda s: s in status_map["ready"]
-        is_error = lambda s: s in status_map["error"]
-        is_transition = lambda s: s in status_map["transition"]
+
+        ready_status = status_map["ready"]
+        error_status = status_map["error"]
+        transition_status = status_map["transition"]
+        if isinstance(ready_status, str):
+            ready_status = [ready_status]
+        if isinstance(error_status, str):
+            error_status = [error_status]
+        if isinstance(transition_status, str):
+            transition_status = [transition_status]
+        is_ready = lambda s: s in ready_status
+        is_error = lambda s: error_status is None or s in error_status
+        is_transition = lambda s: transition_status is None or s in transition_status
     else:
         if not is_ready:
             raise CtxpException("Either status_map or is_ready must be specified.")
@@ -359,6 +366,9 @@ def wait_for_res_status(
             raise CtxpException("Either status_map or is_error must be specified.")
         if not is_transition:
             raise CtxpException("Either status_map or is_transition must be specified.")
+        ready_status = None
+        error_status = None
+        transition_status = None
 
     while True:
         t = fn_get()
@@ -368,9 +378,9 @@ def wait_for_res_status(
             raise CtxpException(prefix + "Not found.")
         status = get_status(t)
         if is_error(status):
-            msg = prefix + f"Status error. Actual={status}"
-            if status_map:
-                msg += f", expected={status_map['ready']}"
+            msg = prefix + f"Unexpected terminal state. Actual={status}"
+            if ready_status:
+                msg += f", expected={ready_status}"
             print("-- DUMP START --", file=sys.stderr)
             print(json.dumps(t, indent=4), file=sys.stderr)
             print("-- DUMP END --", file=sys.stderr)
@@ -383,7 +393,10 @@ def wait_for_res_status(
         now = time.time()
         remaining_seconds = timeout_seconds - (now - start)
         if remaining_seconds < 1:
-            raise TimeoutError(prefix + "Timeout.")
+            msg = prefix + f"Timeout. Current: {status}."
+            if ready_status:
+                msg += f" Expected: {ready_status}."
+            raise TimeoutError(msg)
         sleep_seconds = remaining_seconds
         if sleep_seconds > polling_interval_seconds:
             sleep_seconds = polling_interval_seconds

hcs_core/sglib/login_support.py

@@ -61,7 +61,7 @@ _auth_success_html = """
     </style>
 </head>
 <body>
-    <h3>You have successfully logged into VMware Horizon Cloud Service.</h3>
+    <h3>You have successfully logged into Omnissa Horizon Cloud Service.</h3>
     <p>You can close this window, and return to the terminal.</p>
     <br/>
     <p><a href="https://github.com/euc-eng/hcs-cli/blob/dev/README.md">HCS CLI</a> is in beta. <a href="https://github.com/euc-eng/hcs-cli/blob/main/doc/hcs-cli-cheatsheet.md">Cheatsheet</a>:</p>

{hcs_core-0.1.307.dist-info → hcs_core-0.1.309.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hcs-core
-Version: 0.1.307
+Version: 0.1.309
 Summary: Horizon Cloud Service CLI module.
 Project-URL: Homepage, https://github.com/euc-eng/hcs-cli
 Project-URL: Bug Tracker, https://github.com/euc-eng/hcs-cli/issues
@@ -36,7 +36,7 @@ Requires-Dist: schedule>=1.1.0
 Requires-Dist: setuptools>=70.0.0
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: websocket-client>=1.2.3
-Requires-Dist: yumako>=0.1.31
+Requires-Dist: yumako>=0.1.36
 Provides-Extra: dev
 Requires-Dist: bandit; extra == 'dev'
 Requires-Dist: black; extra == 'dev'

{hcs_core-0.1.307.dist-info → hcs_core-0.1.309.dist-info}/RECORD

@@ -1,8 +1,8 @@
-hcs_core/__init__.py,sha256=9sprnQqz1lHdoyWLm22hd6tw00Xxqc6c6rGUzffep-k,24
+hcs_core/__init__.py,sha256=VUKQ0_TMXT6yqCtvomTkg0PwNyCwosoVnBBfIM5i3vc,24
 hcs_core/ctxp/__init__.py,sha256=bHVHhJP10Luz1a3Kk3zFx14dAO4SY6Q20Lrv8rNWWGc,1075
 hcs_core/ctxp/_init.py,sha256=fMcRMPfJx-N0c-u0Zj2sFVKQL1-lWQd28gooAZETGUA,2933
-hcs_core/ctxp/cli_options.py,sha256=cwlUgYXzIie9eRcu8fkBo_iFvC8LhflKGblWYtM2Hto,2739
-hcs_core/ctxp/cli_processor.py,sha256=X4Qg5fXsg1HuDcdFCDZg7bdnxszGMJGdT3MhnP8LmUY,7656
+hcs_core/ctxp/cli_options.py,sha256=KFu9_cRB1OyXaZJFLDCb3PpuQ0_5-ou2cdaL_q0_Lns,3098
+hcs_core/ctxp/cli_processor.py,sha256=thxNqGIztWTdhDWgzs5NopCSk8yDy1FzG-weqfmIUbE,7756
 hcs_core/ctxp/cmd_util.py,sha256=_-VwQSmkfi52qWC3uHQI06mSiIPfsZroDruTDYHXiMA,3119
 hcs_core/ctxp/config.py,sha256=vRdzPxi3Yrt04cnR6b5mJwEOtYBh21qvmlSSsgyGoI4,931
 hcs_core/ctxp/context.py,sha256=LafhucyGRGYLmnXoZLZOKRWXUwJ1KzP-6vjDTTrC8j4,3451
@@ -22,7 +22,7 @@ hcs_core/ctxp/task_schd.py,sha256=mvZMeKDSSo2p7VidSoZY1XZj433TQn_YF9SGJEzl9lg,45
 hcs_core/ctxp/telemetry.py,sha256=tSjI_8OE2Ix3n--YHAO9sPmzi8ETbFHEPxzS52-usmM,3476
 hcs_core/ctxp/template_util.py,sha256=XslvIuRBlTVsUW0Y9M_D8gUPc1jWq6X2p4At2VAe1KU,731
 hcs_core/ctxp/timeutil.py,sha256=RyRrIRdFHbIghdB8wbC8VdABvc7hki2v51b1x2JvHgo,445
-hcs_core/ctxp/util.py,sha256=mzNG99NV_MPIz7TLNCRf3ADOyW680LC4IYIYgvZ4rsM,12730
+hcs_core/ctxp/util.py,sha256=UTTtP-jjt3r5N-CTf0We64yLPWfFIl9dNSHkfsbFvLY,14225
 hcs_core/ctxp/var_template.py,sha256=cTjj1UJ58ac6s5z4Oh5hSDQwKixq-rdbCF1D8akjAo0,3219
 hcs_core/ctxp/built_in_cmds/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hcs_core/ctxp/built_in_cmds/_ut.py,sha256=e50XBmPim2qRe0RYk_XAuRz1HWYyLJuMu-6dVxWR_fQ,3356
@@ -43,13 +43,13 @@ hcs_core/plan/provider/dev/dummy.py,sha256=zKEr9J4WHhlN5gFdmrFyEfCF0xlQlCJg0CC1d
 hcs_core/plan/provider/dev/fibonacci.py,sha256=8WhDr5c9harNAlVPZomQJEqbWe0hUqbppO6ZkwEUcJ0,1104
 hcs_core/sglib/__init__.py,sha256=oT0etW7vsEbHlXiGL5x23ZXyyFqeLi81RxQQ5lfKSV0,654
 hcs_core/sglib/auth.py,sha256=r9zgLdnybuHsf3_j6nTP4SGoS2dD3keYZ-c25o2Mx64,6766
-hcs_core/sglib/cli_options.py,sha256=dEoUllUs_N97jGtc3mccNgbkVJILfuJR4FHSuVGmSf0,2438
-hcs_core/sglib/client_util.py,sha256=ia4krU7xrMH4G_enOu5xFXIHY8I2besKn6ubayPxi58,14157
+hcs_core/sglib/cli_options.py,sha256=GBJ59u9iWiCfJt-5F8qw_JGfMRfB-LcLeiKAQkmMh_c,2548
+hcs_core/sglib/client_util.py,sha256=4YH-QoqkpF2DtXhemYx4vM19YBzUWk4iNL2BvYLTDmg,14617
 hcs_core/sglib/csp.py,sha256=UcO68YtLOPDQWiTjPVIPwQ2Z-Mywc-154aoIkLdyzwE,10991
 hcs_core/sglib/ez_client.py,sha256=dWQx-EMTrySz1EVzsSu4ZezORR3_iEOAcZigtbuvIQ8,8404
 hcs_core/sglib/hcs_client.py,sha256=pjrAVQDEy2tiQMypMpOzODFntT6aNHXjje8or_mkL2U,804
 hcs_core/sglib/init.py,sha256=w_0ZU70Q1TGbSZsqSi7ewKQqpExFlepOT7mIqH0wnho,310
-hcs_core/sglib/login_support.py,sha256=rHKZDAZXlo62IsjETyXxCSPxg1L4nV6ffZM_tulfe0A,7574
+hcs_core/sglib/login_support.py,sha256=unwzx8_W8knWqSm-jN9wFzkQGpw4U5z4kfzKb_Sjlvw,7575
 hcs_core/sglib/payload_util.py,sha256=Hnj7rjzrQ1j5gpbrwZX34biN8MIZjy6dOJZ63ulmzdw,685
 hcs_core/sglib/requtil.py,sha256=O37DrD4VVBmmRkkHJLbDtPfFq8l6fLZwYZggt2FTEFc,920
 hcs_core/sglib/utils.py,sha256=8a-e-nUhAbulZtV05CB5loov6Kgq8_Q0TxYwfvu7Bj8,3178
@@ -64,6 +64,6 @@ hcs_core/util/query_util.py,sha256=uYfcEF_00eUs_S5OK64zpH0cnb6dwy91_J1OY5ZrFVs,3
 hcs_core/util/scheduler.py,sha256=bPpCmGUL1UctJMfLPAg-h4Hl2YZr96FiI78-G_Usn08,2958
 hcs_core/util/ssl_util.py,sha256=MvU102fGwWWh9hhSmLnn1qQIWuD6TjZnN0iH0MXUtW0,1239
 hcs_core/util/versions.py,sha256=6nyyZzi3P69WQfioPc2_YWZQcUc13mC1eKoK58b3WUQ,1709
-hcs_core-0.1.307.dist-info/METADATA,sha256=pl1V2YgwatBffVXYiGRc4WLpFPuJdLVoapz-nSE474Y,1951
-hcs_core-0.1.307.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hcs_core-0.1.307.dist-info/RECORD,,
+hcs_core-0.1.309.dist-info/METADATA,sha256=Ay1v0mInJ51bxqir-k1pxvjNEPBEuegwAo68GdQUn8g,1951
+hcs_core-0.1.309.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hcs_core-0.1.309.dist-info/RECORD,,