Merge pull request #765 from linode/dev

Release v5.57.0

Author: yec-akamai

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

@@ -20,7 +20,7 @@ on:
         description: 'The number of the PR.'
         required: false
 
-name: PR E2E Tests
+name: Integration Tests on Windows
 
 jobs:
   integration-fork-windows:
@@ -65,9 +65,6 @@ jobs:
         with:
           python-version: '3.x'
 
-      - name: Install Python deps
-        run: pip install .[obj,dev]
-
       - name: Install the CLI
         run: make install
         env:

.github/workflows/e2e-suite.yml

@@ -1,4 +1,4 @@
-name: Integration Tests
+name: Integration Tests on Linux
 
 on:
   workflow_dispatch:
@@ -97,9 +97,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Update system packages
-        run: sudo apt-get update -y
-
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
@@ -235,6 +232,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: [integration_tests]
     if: always() && github.repository == 'linode/linode-cli' # Run even if integration tests fail and only on main repository
+    outputs:
+      summary: ${{ steps.set-test-summary.outputs.summary }}
 
     steps:
       - name: Checkout code
@@ -275,14 +274,26 @@ jobs:
           LINODE_CLI_OBJ_ACCESS_KEY: ${{ secrets.LINODE_CLI_OBJ_ACCESS_KEY }}
           LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}
 
+      - name: Generate test summary and save to output
+        id: set-test-summary
+        run: |
+          filename=$(ls | grep -E '^[0-9]{12}_cli_test_report\.xml$')
+          test_output=$(python3 e2e_scripts/tod_scripts/generate_test_summary.py "${filename}")
+          {
+            echo 'summary<<EOF'
+            echo "$test_output"
+            echo EOF
+          } >> "$GITHUB_OUTPUT"
+
 
   notify-slack:
     runs-on: ubuntu-latest
-    needs: [integration_tests]
+    needs: [integration_tests, process-upload-report]
     if: ${{ (success() || failure()) && github.repository == 'linode/linode-cli' }} # Run even if integration tests fail and only on main repository
 
     steps:
       - name: Notify Slack
+        id: main_message
         uses: slackapi/slack-github-action@v2.0.0
         with:
           method: chat.postMessage
@@ -293,7 +304,7 @@ jobs:
               - type: section
                 text:
                   type: mrkdwn
-                  text: ":rocket: *${{ github.workflow }} Completed in: ${{ github.repository }}* :white_check_mark:"
+                  text: ":rocket: *${{ github.workflow }} Completed in: ${{ github.repository }}* ${{ needs.integration_tests.result == 'success' && ':white_check_mark:' || ':failed:' }}"
               - type: divider
               - type: section
                 fields:
@@ -312,3 +323,14 @@ jobs:
                 elements:
                   - type: mrkdwn
                     text: "Triggered by: :bust_in_silhouette: `${{ github.actor }}`"
+
+      - name: Test summary thread
+        if: success()
+        uses: slackapi/slack-github-action@v2.0.0
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            thread_ts: "${{ steps.main_message.outputs.ts }}"
+            text: "${{ needs.process-upload-report.outputs.summary }}"

.github/workflows/labeler.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@b54af0c25861143e7c8813d7cbbf46d2c341680c
+        uses: crazy-max/ghaction-github-labeler@24d110aa46a59976b8a7f35518cb7f14f434c916
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml

.github/workflows/release.yml

@@ -39,13 +39,13 @@ jobs:
         run: make requirements
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@53851d14592bedcffcf25ea515637cff71ef929a # pin@v3.3.0
+        uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # pin@v3.6.0
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # pin@v3.8.0
+        uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # pin@v3.10.0
 
       - name: Login to Docker Hub
-        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pin@v3.3.0
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # pin@v3.4.0
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -67,7 +67,7 @@ jobs:
           result-encoding: string
 
       - name: Build and push to DockerHub
-        uses: docker/build-push-action@ca877d9245402d1537745e0e356eab47c3520991 # pin@v6.13.0
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # pin@v6.15.0
         with:
           context: .
           file: Dockerfile
@@ -79,7 +79,11 @@ jobs:
             github_token=${{ secrets.GITHUB_TOKEN }}
 
   pypi-release:
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     runs-on: ubuntu-latest
+    environment: pypi-release
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -103,5 +107,3 @@ jobs:
 
       - name: Publish the release artifacts to PyPI
         uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # pin@release/v1.12.4
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -14,3 +14,4 @@ test/.env
 MANIFEST
 venv
 openapi*.yaml
+openapi*.json

Makefile

@@ -12,6 +12,8 @@ VERSION_FILE := ./linodecli/version.py
 VERSION_MODULE_DOCSTRING ?= \"\"\"\nThe version of the Linode CLI.\n\"\"\"\n\n
 LINODE_CLI_VERSION ?= "0.0.0.dev"
 
+BAKE_FLAGS := --debug
+
 .PHONY: install
 install: check-prerequisites requirements build
 	pip3 install --force dist/*.whl
@@ -21,7 +23,7 @@ bake: clean
 ifeq ($(SKIP_BAKE), 1)
 	@echo Skipping bake stage
 else
-	python3 -m linodecli bake ${SPEC} --skip-config
+	python3 -m linodecli bake ${SPEC} --skip-config $(BAKE_FLAGS)
 	cp data-3 linodecli/
 endif
 

e2e_scripts

@@ -4,6 +4,7 @@
 """
 
 import argparse
+import logging
 import os
 import sys
 from importlib.metadata import version
@@ -38,12 +39,14 @@
 
 TEST_MODE = os.getenv("LINODE_CLI_TEST_MODE") == "1"
 
+# Configure the `logging` package log level depending on the --debug flag.
+logging.basicConfig(
+    level=logging.DEBUG if "--debug" in argv else logging.WARNING,
+)
+
 # if any of these arguments are given, we don't need to prompt for configuration
 skip_config = (
-    any(
-        c in argv
-        for c in ["--skip-config", "--help", "--version", "completion"]
-    )
+    any(c in argv for c in ["--skip-config", "--version", "completion"])
     or TEST_MODE
 )
 
@@ -104,6 +107,43 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
         # if not spec was found and we weren't baking, we're doomed
         sys.exit(ExitCodes.ARGUMENT_ERROR)
 
+    if parsed.command in ("set-custom-alias", "remove-custom-alias"):
+        if not parsed.alias_command or not parsed.alias:
+            print(
+                "Both --alias-command and --alias must be provided.",
+                file=sys.stderr,
+            )
+            sys.exit(ExitCodes.ARGUMENT_ERROR)
+
+        command = parsed.alias_command
+        alias = parsed.alias
+
+        if command not in cli.ops:
+            print(
+                f"Error: '{command}' is not a valid command.", file=sys.stderr
+            )
+            sys.exit(ExitCodes.ARGUMENT_ERROR)
+
+        if parsed.command == "set-custom-alias":
+            if (alias, command) not in cli.config.get_custom_aliases().items():
+                cli.config.set_custom_alias(alias, command)
+                print(f"Custom alias '{alias}' set for command '{command}'")
+            else:
+                print(
+                    f"Custom alias '{alias}' already set for command '{command}'"
+                )
+
+        if parsed.command == "remove-custom-alias":
+            if (alias, command) in cli.config.get_custom_aliases().items():
+                cli.config.remove_custom_alias(alias, command)
+                print(f"Custom alias '{alias}' removed for command '{command}'")
+            else:
+                print(
+                    f"Custom alias '{alias}' does not exist for command '{command}'"
+                )
+
+        sys.exit(ExitCodes.SUCCESS)
+
     if parsed.command == "register-plugin":
         if parsed.action is None:
             print("register-plugin requires a module name!", file=sys.stderr)
@@ -207,28 +247,36 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
         plugin_args.remove(parsed.command)  # don't include the plugin name
         plugins.invoke(parsed.command, plugin_args, context)
         sys.exit(ExitCodes.SUCCESS)
-
     # unknown commands
     if (
         parsed.command not in cli.ops
         and parsed.command not in plugins.available(cli.config)
         and parsed.command not in HELP_TOPICS
+        and parsed.command not in cli.config.get_custom_aliases().keys()
     ):
         print(f"Unrecognized command {parsed.command}", file=sys.stderr)
         sys.exit(ExitCodes.UNRECOGNIZED_COMMAND)
 
     # handle a help for a command - either --help or no action triggers this
-    if (
-        parsed.command is not None
-        and parsed.action is None
-        and parsed.command in cli.ops
-    ):
-        print_help_command_actions(cli.ops, parsed.command)
-        sys.exit(ExitCodes.SUCCESS)
+    if parsed.command is not None and parsed.action is None:
+        if parsed.command in cli.ops:
+            print_help_command_actions(cli.ops, parsed.command)
+            sys.exit(ExitCodes.SUCCESS)
+        if parsed.command in cli.config.get_custom_aliases().keys():
+            print_help_command_actions(
+                cli.ops, cli.config.get_custom_aliases()[parsed.command]
+            )
 
     if parsed.command is not None and parsed.action is not None:
         if parsed.help:
-            print_help_action(cli, parsed.command, parsed.action)
+            if parsed.command in cli.config.get_custom_aliases().keys():
+                print_help_action(
+                    cli,
+                    cli.config.get_custom_aliases()[parsed.command],
+                    parsed.action,
+                )
+            else:
+                print_help_action(cli, parsed.command, parsed.action)
             sys.exit(ExitCodes.SUCCESS)
 
         cli.handle_command(parsed.command, parsed.action, args)