Resolve issues

Author: lgarber-akamai

.github/workflows/e2e-suite.yml

@@ -294,7 +294,7 @@ jobs:
     steps:
       - name: Notify Slack
         id: main_message
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -326,7 +326,7 @@ jobs:
 
       - name: Test summary thread
         if: success()
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}

.github/workflows/nightly-smoke-tests.yml

@@ -46,7 +46,7 @@ jobs:
 
       - name: Notify Slack
         if: always() && github.repository == 'linode/linode-cli' # Run even if integration tests fail and only on main repository
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - name: Notify Slack - Main Message
         id: main_message
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@v2.1.0
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_BOT_TOKEN }}
@@ -42,7 +42,7 @@ jobs:
         uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # [email protected]
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # pin@v3.10.0
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # pin@v3.11.1
 
       - name: Login to Docker Hub
         uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # [email protected]
@@ -67,7 +67,7 @@ jobs:
           result-encoding: string
 
       - name: Build and push to DockerHub
-        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # pin@v6.16.0
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # pin@v6.18.0
         with:
           context: .
           file: Dockerfile

.github/workflows/remote-release-trigger.yml

@@ -66,7 +66,7 @@ jobs:
           commit_sha: ${{ steps.calculate_head_sha.outputs.commit_sha }}
 
       - name: Release
-        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # pin@v2.2.2
+        uses: softprops/action-gh-release@72f2c25fcb47643c292f7107632f7a47c1df5cd8 # pin@v2.3.2
         with:
           target_commitish: 'main'
           token: ${{ steps.generate_token.outputs.token }}

linodecli/__init__.py

@@ -80,6 +80,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
     cli.page = parsed.page
     cli.page_size = parsed.page_size
     cli.debug_request = parsed.debug
+    cli.raw_body = parsed.raw_body
 
     if parsed.as_user and not skip_config:
         cli.config.set_user(parsed.as_user)

linodecli/api_request.py

@@ -23,6 +23,7 @@
     ExplicitNullValue,
     OpenAPIOperation,
 )
+from .baked.util import get_path_segments
 from .helpers import handle_url_overrides
 
 if TYPE_CHECKING:
@@ -347,30 +348,60 @@ def _build_request_body(
 
     :return: A JSON string representing the request body, or None if not applicable.
     """
-    if operation.method == "get":
-        # Get operations don't have a body
+    if operation.method in ("get", "delete"):
+        # GET and DELETE operations don't have a body
+        if ctx.raw_body is not None:
+            print(
+                f"--raw-body cannot be specified for actions with method {operation.method}",
+                file=sys.stderr,
+            )
+            sys.exit(ExitCodes.ARGUMENT_ERROR)
+
         return None
 
+    param_names = {param.name for param in operation.params}
+
+    # Returns whether the given argument should be included in the request body
+    def __should_include(key: str, value: Any) -> bool:
+        return value is not None and key not in param_names
+
+    # If the user has specified the --raw-body argument,
+    # return it.
+    if ctx.raw_body is not None:
+        specified_keys = [
+            k for k, v in vars(parsed_args).items() if __should_include(k, v)
+        ]
+
+        if len(specified_keys) > 0:
+            print(
+                "--raw-body cannot be specified with action arguments: "
+                + ", ".join(sorted(f"--{key}" for key in specified_keys)),
+                file=sys.stderr,
+            )
+            sys.exit(ExitCodes.ARGUMENT_ERROR)
+
+        return ctx.raw_body
+
     # Merge defaults into body if applicable
     if ctx.defaults:
         parsed_args = ctx.config.update(parsed_args, operation.allowed_defaults)
 
-    param_names = {param.name for param in operation.params}
-
     expanded_json = {}
 
     # Expand dotted keys into nested dictionaries
     for k, v in vars(parsed_args).items():
-        if v is None or k in param_names:
+        if not __should_include(k, v):
             continue
 
+        path_segments = get_path_segments(k)
+
         cur = expanded_json
-        for part in k.split(".")[:-1]:
+        for part in path_segments[:-1]:
             if part not in cur:
                 cur[part] = {}
             cur = cur[part]
 
-        cur[k.split(".")[-1]] = v
+        cur[path_segments[-1]] = v
 
     return json.dumps(_traverse_request_body(expanded_json))
 

linodecli/arg_helpers.py

@@ -81,6 +81,14 @@ def register_args(parser: ArgumentParser) -> ArgumentParser:
         help="The alias to set or remove.",
     )
 
+    parser.add_argument(
+        "--raw-body",
+        type=str,
+        help="The raw JSON to use as the request body of an action. "
+        + "This argument cannot be used if action-specific arguments are specified. "
+        + "Additionally, this argument can only be used with POST and PUT actions.",
+    )
+
     # Register shared argument groups
     register_output_args_shared(parser)
     register_pagination_args_shared(parser)

linodecli/baked/operation.py

@@ -25,6 +25,7 @@
     OpenAPIRequestArg,
 )
 from linodecli.baked.response import OpenAPIResponse
+from linodecli.baked.util import unescape_arg_segment
 from linodecli.exit_codes import ExitCodes
 from linodecli.output.output_handler import OutputHandler
 from linodecli.overrides import OUTPUT_OVERRIDES
@@ -649,6 +650,9 @@ def _add_args_post_put(
             if arg.read_only:
                 continue
 
+            arg_name_unescaped = unescape_arg_segment(arg.name)
+            arg_path_unescaped = unescape_arg_segment(arg.path)
+
             arg_type = (
                 arg.item_type if arg.datatype == "array" else arg.datatype
             )
@@ -660,15 +664,17 @@ def _add_args_post_put(
             if arg.datatype == "array":
                 # special handling for input arrays
                 parser.add_argument(
-                    "--" + arg.path,
-                    metavar=arg.name,
+                    "--" + arg_path_unescaped,
+                    dest=arg.path,
+                    metavar=arg_name_unescaped,
                     action=ArrayAction,
                     type=arg_type_handler,
                 )
             elif arg.is_child:
                 parser.add_argument(
-                    "--" + arg.path,
-                    metavar=arg.name,
+                    "--" + arg_path_unescaped,
+                    dest=arg.path,
+                    metavar=arg_name_unescaped,
                     action=ListArgumentAction,
                     type=arg_type_handler,
                 )
@@ -677,7 +683,7 @@ def _add_args_post_put(
                 if arg.datatype == "string" and arg.format == "password":
                     # special case - password input
                     parser.add_argument(
-                        "--" + arg.path,
+                        "--" + arg_path_unescaped,
                         nargs="?",
                         action=PasswordPromptAction,
                     )
@@ -687,15 +693,17 @@ def _add_args_post_put(
                     "ssl-key",
                 ):
                     parser.add_argument(
-                        "--" + arg.path,
-                        metavar=arg.name,
+                        "--" + arg_path_unescaped,
+                        dest=arg.path,
+                        metavar=arg_name_unescaped,
                         action=OptionalFromFileAction,
                         type=arg_type_handler,
                     )
                 else:
                     parser.add_argument(
-                        "--" + arg.path,
-                        metavar=arg.name,
+                        "--" + arg_path_unescaped,
+                        dest=arg.path,
+                        metavar=arg_name_unescaped,
                         type=arg_type_handler,
                     )
 

linodecli/baked/request.py

@@ -9,7 +9,10 @@
 
 from linodecli.baked.parsing import simplify_description
 from linodecli.baked.response import OpenAPIResponse
-from linodecli.baked.util import _aggregate_schema_properties
+from linodecli.baked.util import (
+    _aggregate_schema_properties,
+    escape_arg_segment,
+)
 
 
 class OpenAPIRequestArg:
@@ -155,6 +158,8 @@ def _parse_request_model(
         return args
 
     for k, v in properties.items():
+        k = escape_arg_segment(k)
+
         # Handle nested objects which aren't read-only and have properties
         if (
             v.type == "object"

linodecli/baked/util.py

@@ -2,6 +2,7 @@
 Provides various utility functions for use in baking logic.
 """
 
+import re
 from collections import defaultdict
 from typing import Any, Dict, List, Set, Tuple
 
@@ -62,3 +63,58 @@ def __inner(
         # We only want to mark fields that are required by ALL subschema as required
         set(key for key, count in required.items() if count == schema_count),
     )
+
+
+ESCAPED_PATH_DELIMITER_PATTERN = re.compile(r"(?<!\\)\.")
+
+
+def escape_arg_segment(segment: str) -> str:
+    """
+    Escapes periods in a segment by prefixing them with a backslash.
+
+    :param segment: The input string segment to escape.
+    :return: The escaped segment with periods replaced by '\\.'.
+    """
+    return segment.replace(".", "\\.")
+
+
+def unescape_arg_segment(segment: str) -> str:
+    """
+    Reverses the escaping of periods in a segment, turning '\\.' back into '.'.
+
+    :param segment: The input string segment to unescape.
+    :return: The unescaped segment with '\\.' replaced by '.'.
+    """
+    return segment.replace("\\.", ".")
+
+
+def get_path_segments(path: str) -> List[str]:
+    """
+    Splits a path string into segments using a delimiter pattern,
+    and unescapes any escaped delimiters in the resulting segments.
+
+    :param path: The full path string to split and unescape.
+    :return: A list of unescaped path segments.
+    """
+    return [
+        unescape_arg_segment(seg)
+        for seg in ESCAPED_PATH_DELIMITER_PATTERN.split(path)
+    ]
+
+
+def get_terminal_keys(data: Dict[str, Any]) -> List[str]:
+    """
+    Recursively retrieves all terminal (non-dict) keys from a nested dictionary.
+
+    :param data: The input dictionary, possibly nested.
+    :return: A list of all terminal keys (keys whose values are not dictionaries).
+    """
+    ret = []
+
+    for k, v in data.items():
+        if isinstance(v, dict):
+            ret.extend(get_terminal_keys(v))  # recurse into nested dicts
+        else:
+            ret.append(k)  # terminal key
+
+    return ret