Merge pull request #409 from linode/dev

Release 5.34.0

Author: ezilber-akamai-zz

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

@@ -0,0 +1,29 @@
+name: AccTest Command
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  acctest-command:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.issue.pull_request }}
+    steps:
+      - name: Generate App Installation Token
+        id: generate_token
+        uses: tibdex/github-app-token@v1
+        with:
+          app_id: ${{ secrets.DX_ACCTEST_APP_ID }}
+          private_key: ${{ secrets.DX_ACCTEST_PRIV_KEY }}
+
+      - name: Slash Command Dispatch
+        uses: peter-evans/slash-command-dispatch@v1
+        env:
+          TOKEN: ${{ steps.generate_token.outputs.token }}
+        with:
+          token: ${{ env.TOKEN }}
+          reaction-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-type: pull-request
+          commands: acctest
+          named-args: true
+          permission: write

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

@@ -0,0 +1,81 @@
+on:
+  pull_request:
+  repository_dispatch:
+    types: [acctest-command]
+
+name: PR E2E Tests
+
+jobs:
+  # Maintainer has commented /acctest on a pull request
+  integration-fork:
+    runs-on: ubuntu-latest
+    if:
+      github.event_name == 'repository_dispatch' &&
+      github.event.client_payload.slash_command.sha != '' &&
+      github.event.client_payload.pull_request.head.sha == github.event.client_payload.slash_command.sha
+
+    steps:
+      - uses: actions-ecosystem/action-regex-match@v2
+        id: validate-tests
+        with:
+          text: ${{ github.event.client_payload.slash_command.tests }}
+          regex: '[^a-z0-9-:.\/_]'  # Tests validation
+          flags: gi
+
+      # Check out merge commit
+      - name: Checkout PR
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.client_payload.slash_command.sha }}
+
+      - 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:
+          python-version: '3.x'
+
+      - name: Install Python deps
+        run: pip install -r requirements.txt -r requirements-dev.txt wheel boto
+
+      - name: Install the CLI
+        run: make install
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - run: make INTEGRATION_TEST_PATH="${{ github.event.client_payload.slash_command.tests }}" testint
+        if: ${{ steps.validate-tests.outputs.match == '' }}
+        env:
+          LINODE_CLI_TOKEN: ${{ secrets.LINODE_TOKEN }}
+
+      - uses: actions/github-script@v5
+        id: update-check-run
+        if: ${{ always() }}
+        env:
+          number: ${{ github.event.client_payload.pull_request.number }}
+          job: ${{ github.job }}
+          conclusion: ${{ job.status }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { data: pull } = await github.rest.pulls.get({
+              ...context.repo,
+              pull_number: process.env.number
+            });
+            const ref = pull.head.sha;
+            const { data: checks } = await github.rest.checks.listForRef({
+              ...context.repo,
+              ref
+            });
+            const check = checks.check_runs.filter(c => c.name === process.env.job);
+            const { data: result } = await github.rest.checks.update({
+              ...context.repo,
+              check_run_id: check[0].id,
+              status: 'completed',
+              conclusion: process.env.conclusion
+            });
+            return result;

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

@@ -0,0 +1,44 @@
+name: Remote Release Trigger
+on:
+  repository_dispatch:
+    types: [ cli-release ]
+jobs:
+  remote-release-trigger:
+    runs-on: ubuntu-22.04
+    environment: CLI Automated Release
+    steps:
+      - name: Generate App Installation Token
+        id: generate_token
+        uses: tibdex/github-app-token@b62528385c34dbc9f38e5f4225ac829252d1ea92 # pin@v1
+        with:
+          app_id: ${{ secrets.CLI_RELEASE_APP_ID }}
+          private_key: ${{ secrets.CLI_RELEASE_PRIVATE_KEY }}
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get previous tag
+        id: previoustag
+        uses: WyriHaximus/github-action-get-previous-tag@385a2a0b6abf6c2efeb95adfac83d96d6f968e0c # pin@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get the next minor version
+        id: semvers
+        uses: WyriHaximus/github-action-next-semvers@d079934efaf011a4cf8912d4637097fe35d32b93 # pin@v1
+        with:
+          version: ${{ steps.previoustag.outputs.tag }}
+
+      - uses: rickstaa/action-create-tag@84c90e6ba79b47b5147dcb11ff25d6a0e06238ba # pin@v1
+        with:
+          tag: ${{ steps.semvers.outputs.v_minor }}
+
+      - name: Release
+        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # pin@v1
+        with:
+          token: ${{ steps.generate_token.outputs.token }}
+          body: Built from Linode OpenAPI spec ${{
+            github.event.client_payload.spec_version }}
+          tag_name: ${{ steps.semvers.outputs.v_minor }}

.github/workflows/unit-tests.yml

@@ -27,6 +27,8 @@ jobs:
 
       - name: Install Package
         run: make install
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run the unit test suite
         run: make test

Makefile

@@ -2,6 +2,8 @@
 # Makefile for more convenient building of the Linode CLI and its baked content
 #
 
+INTEGRATION_TEST_PATH :=
+
 SPEC_VERSION ?= latest
 ifndef SPEC
 override SPEC = $(shell ./resolve_spec_url ${SPEC_VERSION})
@@ -38,7 +40,7 @@ clean:
 	rm -f linodecli/data-*
 	rm -f linode-cli.sh baked_version
 	rm -f data-*
-	rm -rf dist
+	rm -rf dist linode_cli.egg-info build
 
 .PHONY: testunit
 testunit: export LINODE_CLI_TEST_MODE = 1
@@ -48,7 +50,7 @@ testunit:
 
 .PHONY: testint
 testint:
-	pytest tests/integration
+	pytest tests/integration/${INTEGRATION_TEST_PATH}
 
 
 # Alias for unit; integration tests should be explicit

linodecli/api_request.py

@@ -4,14 +4,11 @@
 
 import json
 import sys
-from distutils.version import (  # pylint: disable=deprecated-module
-    LooseVersion,
-    StrictVersion,
-)
 from sys import version_info
 from typing import Optional
 
 import requests
+from packaging import version
 
 
 def do_request(
@@ -160,26 +157,24 @@ def _attempt_warn_old_version(ctx, result):
 
         try:
             # Parse the spec versions from the API and local CLI.
-            StrictVersion(spec_version)
-            StrictVersion(ctx.spec_version)
+            spec_version_parsed = version.parse(spec_version)
+            current_version_parsed = version.parse(ctx.spec_version)
 
             # Get only the Major/Minor version of the API Spec and CLI Spec,
             # ignore patch version differences
             spec_major_minor_version = (
-                spec_version.split(".")[0] + "." + spec_version.split(".")[1]
+                f"{spec_version_parsed.major}.{spec_version_parsed.minor}"
             )
             current_major_minor_version = (
-                ctx.spec_version.split(".")[0]
-                + "."
-                + ctx.spec_version.split(".")[1]
+                f"{current_version_parsed.major}.{current_version_parsed.minor}"
             )
         except ValueError:
             # If versions are non-standard like, "DEVELOPMENT" use them and don't complain.
             spec_major_minor_version = spec_version
             current_major_minor_version = ctx.spec_version
 
         try:
-            if LooseVersion(spec_major_minor_version) > LooseVersion(
+            if version.parse(spec_major_minor_version) > version.parse(
                 current_major_minor_version
             ):
                 api_version_higher = True
@@ -209,7 +204,7 @@ def _attempt_warn_old_version(ctx, result):
                 pypi_version = pypi_response.json()["info"]["version"]
 
                 # no need to be fancy; these should always be valid versions
-                if LooseVersion(pypi_version) > LooseVersion(ctx.version):
+                if version.parse(pypi_version) > version.parse(ctx.version):
                     new_version_exists = True
         except:
             # I know, but if anything happens here the end user should still

linodecli/arg_helpers.py

@@ -14,6 +14,7 @@
 from linodecli import plugins
 
 from .completion import bake_completions
+from .helpers import register_args_shared
 
 
 def register_args(parser):
@@ -102,13 +103,6 @@ def register_args(parser):
         help="Suppress default values for arguments.  Default values "
         "are configured on initial setup or with linode-cli configure",
     )
-    parser.add_argument(
-        "--as-user",
-        metavar="USERNAME",
-        type=str,
-        help="The username to execute this command as.  This user must "
-        "be configured.",
-    )
     parser.add_argument(
         "--suppress-warnings",
         action="store_true",
@@ -131,6 +125,8 @@ def register_args(parser):
         "--debug", action="store_true", help="Enable verbose HTTP debug output."
     )
 
+    register_args_shared(parser)
+
     return parser
 
 

linodecli/configuration/__init__.py

@@ -342,16 +342,19 @@ def configure(
         auth_users = []
 
         if is_full_access:
-            auth_users = [
-                u["username"]
-                for u in _do_get_request(
-                    self.base_url,
-                    "/account/users",
-                    exit_on_error=False,
-                    token=token,
-                )["data"]
-                if "ssh_keys" in u
-            ]
+            users = _do_get_request(
+                self.base_url,
+                "/account/users",
+                token=token,
+                # Allow 401 responses so tokens without
+                # account perms can be configured
+                status_validator=lambda status: status == 401,
+            )
+
+            if "data" in users:
+                auth_users = [
+                    u["username"] for u in users["data"] if "ssh_keys" in u
+                ]
 
         # get the preferred things
         config["region"] = _default_thing_input(

linodecli/configuration/auth.py

@@ -27,7 +27,12 @@
 """
 
 
-def _handle_response_status(response, exit_on_error=None):
+def _handle_response_status(
+    response, exit_on_error=None, status_validator=None
+):
+    if status_validator is not None and status_validator(response.status_code):
+        return
+
     if 199 < response.status_code < 300:
         return
 
@@ -37,17 +42,30 @@ def _handle_response_status(response, exit_on_error=None):
 
 
 # TODO: merge config do_request and cli do_request
-def _do_get_request(base_url, url, token=None, exit_on_error=True):
+def _do_get_request(
+    base_url, url, token=None, exit_on_error=True, status_validator=None
+):
     """
     Does helper get requests during configuration
     """
     return _do_request(
-        base_url, requests.get, url, token=token, exit_on_error=exit_on_error
+        base_url,
+        requests.get,
+        url,
+        token=token,
+        exit_on_error=exit_on_error,
+        status_validator=status_validator,
     )
 
 
 def _do_request(
-    base_url, method, url, token=None, exit_on_error=None, body=None
+    base_url,
+    method,
+    url,
+    token=None,
+    exit_on_error=None,
+    body=None,
+    status_validator=None,
 ):  # pylint: disable=too-many-arguments
     """
     Does helper requests during configuration
@@ -60,7 +78,9 @@ def _do_request(
 
     result = method(base_url + url, headers=headers, json=body)
 
-    _handle_response_status(result, exit_on_error=exit_on_error)
+    _handle_response_status(
+        result, exit_on_error=exit_on_error, status_validator=status_validator
+    )
 
     return result.json()
 

linodecli/helpers.py

@@ -51,3 +51,23 @@ def filter_markdown_links(text):
         result = result.replace(match.group(), f"{match.group('text')} ({url})")
 
     return result
+
+
+def register_args_shared(parser):
+    """
+    Adds certain arguments to the given ArgumentParser that may be shared across
+    the CLI and plugins.
+    This function is wrapped in linodecli.plugins.
+
+    NOTE: This file is not located in arg_helpers.py to prevent a cyclic dependency.
+    """
+
+    parser.add_argument(
+        "--as-user",
+        metavar="USERNAME",
+        type=str,
+        help="The username to execute this command as.  This user must "
+        "be configured.",
+    )
+
+    return parser