Merge pull request #548 from linode/dev

Release v5.45.2

Author: lgarber-akamai

.github/workflows/e2e-suite-pr-command.yml

@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
     inputs:
       test_path:
-        description: 'Test path to be tested: e.g. integration/cli'
+        description: "The path from 'test/integration' to the target to be tested, e.g. 'cli'"
         required: false
       sha:
         description: 'The hash value of the commit.'
@@ -30,7 +30,7 @@ jobs:
 
       # Check out merge commit
       - name: Checkout PR
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ inputs.sha }}
 
@@ -56,13 +56,12 @@ jobs:
           owner: ${{ github.event.repository.owner.login }}
           repo: ${{ github.event.repository.name }}
           pr_num: ${{ fromJSON(inputs.pull_request_number) }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Update system packages
         run: sudo apt-get update -y
 
-      - name: Install system deps
-        run: sudo apt-get install -y build-essential
-
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -124,7 +123,7 @@ jobs:
 
       # Check out merge commit
       - name: Checkout PR
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ inputs.sha }}
 
@@ -196,4 +195,4 @@ jobs:
               status: 'completed',
               conclusion: process.env.conclusion
             });
-            return result;
+            return result;

.github/workflows/e2e-suite-pr.yml

@@ -9,6 +9,8 @@ jobs:
   integration-tests:
     name: Run integration tests
     runs-on: ubuntu-latest
+    env:
+      EXIT_STATUS: 0
     steps:
       - name: Clone Repository
         uses: actions/checkout@v3
@@ -39,9 +41,8 @@ jobs:
         run: |
           timestamp=$(date +'%Y%m%d%H%M')
           report_filename="${timestamp}_cli_test_report.xml"
-          status=0
           if ! pytest tests/integration --disable-warnings --junitxml="${report_filename}"; then
-            echo "Tests failed, but attempting to upload results anyway"
+            echo "EXIT_STATUS=1" >> $GITHUB_ENV
           fi
         env:
           LINODE_CLI_TOKEN: ${{ secrets.LINODE_TOKEN }}
@@ -67,4 +68,13 @@ jobs:
         env:
           LINODE_CLI_TOKEN: ${{ secrets.SHARED_DX_TOKEN }}
           LINODE_CLI_OBJ_ACCESS_KEY: ${{ secrets.LINODE_CLI_OBJ_ACCESS_KEY }}
-          LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}
+          LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}
+
+      - name: Test Execution Status Handler
+        run: |
+          if [[ "$EXIT_STATUS" != 0 ]]; then
+            echo "Test execution contains failure(s)"
+            exit $EXIT_STATUS 
+          else
+            echo "Tests passed!"
+          fi

.github/workflows/e2e-suite.yml

@@ -56,9 +56,14 @@ jobs:
             
             return "v" + cli_version_segments.join(".")
 
+      - name: Calculate the SHA of HEAD on the main branch
+        id: calculate_head_sha
+        run: echo "commit_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
       - uses: rickstaa/action-create-tag@84c90e6ba79b47b5147dcb11ff25d6a0e06238ba # pin@v1
         with:
           tag: ${{ steps.calculate_version.outputs.result }}
+          commit_sha: ${{ steps.calculate_head_sha.outputs.commit_sha }}
 
       - name: Release
         uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # pin@v1

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

@@ -307,8 +307,8 @@ min-public-methods=2
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when caught.
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception
 
 
 [FORMAT]

.pylintrc

@@ -18,10 +18,13 @@ endif
 install: check-prerequisites requirements build
 	pip3 install --force dist/*.whl
 
-.PHONY: build
-build: clean
+.PHONY: bake
+bake: clean
 	python3 -m linodecli bake ${SPEC} --skip-config
 	cp data-3 linodecli/
+
+.PHONY: build
+build: clean bake
 	python3 -m build --wheel --sdist
 
 .PHONY: requirements

Makefile

@@ -6,9 +6,9 @@
 import argparse
 import os
 import sys
+from importlib.metadata import version
 from sys import argv
 
-import pkg_resources
 from rich import print as rprint
 from rich.table import Table
 
@@ -30,7 +30,7 @@
 
 # this might not be installed at the time of building
 try:
-    VERSION = pkg_resources.require("linode-cli")[0].version
+    VERSION = version("linode-cli")
 except:
     VERSION = "building"
 

linodecli/__init__.py

@@ -380,7 +380,10 @@ def action_help(cli, command, action):
                 if op.method in {"post", "put"} and arg.required
                 else ""
             )
-            print(f"  --{arg.path}: {is_required}{arg.description}")
+            nullable_fmt = " (nullable)" if arg.nullable else ""
+            print(
+                f"  --{arg.path}: {is_required}{arg.description}{nullable_fmt}"
+            )
 
 
 def bake_command(cli, spec_loc):

linodecli/arg_helpers.py

@@ -11,6 +11,8 @@
 from os import environ, path
 from typing import List, Tuple
 
+from openapi3.paths import Operation
+
 from linodecli.baked.request import OpenAPIFilteringRequest, OpenAPIRequest
 from linodecli.baked.response import OpenAPIResponse
 from linodecli.overrides import OUTPUT_OVERRIDES
@@ -76,6 +78,27 @@ def type_func(value):
     return type_func
 
 
+class ArrayAction(argparse.Action):
+    """
+    This action is intended to be used only with array arguments.
+    This purpose of this action is to allow users to specify explicitly
+    empty lists using a singular "[]" argument value.
+    """
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        if getattr(namespace, self.dest) is None:
+            setattr(namespace, self.dest, [])
+
+        output_list = getattr(namespace, self.dest)
+
+        # If the output list is empty and the user specifies a []
+        # argument, keep the list empty
+        if values == "[]" and len(output_list) < 1:
+            return
+
+        output_list.append(values)
+
+
 class ListArgumentAction(argparse.Action):
     """
     This action is intended to be used only with list arguments.
@@ -212,7 +235,7 @@ class OpenAPIOperation:
     This is the class that should be pickled when building the CLI.
     """
 
-    def __init__(self, command, operation, method, params):
+    def __init__(self, command, operation: Operation, method, params):
         """
         Wraps an openapi3.Operation object and handles pulling out values relevant
         to the Linode CLI.
@@ -380,7 +403,7 @@ def _add_args_post_put(self, parser) -> List[Tuple[str, str]]:
                 parser.add_argument(
                     "--" + arg.path,
                     metavar=arg.name,
-                    action="append",
+                    action=ArrayAction,
                     type=arg_type_handler,
                 )
             elif arg.list_item:

linodecli/baked/operation.py

@@ -1,6 +1,8 @@
 """
 Converting the processed OpenAPI Responses into something the CLI can work with
 """
+from openapi3.paths import MediaType
+
 from .colors import colorize_string
 
 
@@ -159,26 +161,35 @@ def _parse_response_model(schema, prefix=None, nested_list_depth=0):
     :returns: The list of parsed OpenAPIResponseAttr objects representing this schema
     :rtype: List[OpenAPIResponseAttr]
     """
-    attrs = []
 
-    if schema.properties is not None:
-        for k, v in schema.properties.items():
-            pref = prefix + "." + k if prefix else k
-
-            if v.type == "object":
-                attrs += _parse_response_model(v, prefix=pref)
-            elif v.type == "array" and v.items.type == "object":
-                attrs += _parse_response_model(
-                    v.items,
-                    prefix=pref,
-                    nested_list_depth=nested_list_depth + 1,
-                )
-            else:
-                attrs.append(
-                    OpenAPIResponseAttr(
-                        k, v, prefix=prefix, nested_list_depth=nested_list_depth
-                    )
+    if schema.type == "array":
+        return _parse_response_model(
+            schema.items,
+            prefix=prefix,
+            nested_list_depth=nested_list_depth,
+        )
+
+    attrs = []
+    if schema.properties is None:
+        return attrs
+
+    for k, v in schema.properties.items():
+        pref = prefix + "." + k if prefix else k
+
+        if v.type == "object":
+            attrs += _parse_response_model(v, prefix=pref)
+        elif v.type == "array" and v.items.type == "object":
+            attrs += _parse_response_model(
+                v.items,
+                prefix=pref,
+                nested_list_depth=nested_list_depth + 1,
+            )
+        else:
+            attrs.append(
+                OpenAPIResponseAttr(
+                    k, v, prefix=prefix, nested_list_depth=nested_list_depth
                 )
+            )
 
     return attrs
 
@@ -189,7 +200,7 @@ class OpenAPIResponse:
     responses section of an OpenAPI Operation
     """
 
-    def __init__(self, response):
+    def __init__(self, response: MediaType):
         """
         :param response: The response's MediaType object in the OpenAPI spec,
                           corresponding to the application/json response type
@@ -228,7 +239,9 @@ def fix_json(self, json):
         # Needs to go last to handle custom schemas
         if "pages" in json:
             return json["data"]
-        return [json]
+        if not isinstance(json, list):
+            json = [json]
+        return json
 
     def _fix_json_rows(self, json):
         """