Skip to content

[Experimental] Improve plugin startup validation and type safety #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Experimental] Improve plugin startup validation and type safety #516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions backend/engine/plugins/lib/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import re
import subprocess
import sys
from typing import Any

import boto3
from botocore.exceptions import ClientError, NoCredentialsError
Expand Down Expand Up @@ -59,13 +60,29 @@ def validate_plugin_name(name: str) -> bool:
return name != "lib" and bool(name_rx.match(name))


def parse_args(in_args=None, extra_args=None):
# Allow the path to be overridden on the command line. This lets the
# plugin be tested against any path, not just the engine work path.
def parse_args(
in_args: list[str] | None = None,
extra_args: list[tuple[list[str], Any]] | None = None,
) -> argparse.Namespace:
"""
Load the standard plugin invocation data from the command-line.

If args is specified, then it will be used instead of the process args
from the command-line.

Additional command-like arguments may be defined by setting extra_args.
Each will be passed directly to argparse.ArgumentParser.add_argument().
"""

log = logging.getLogger(__name__)

parser = argparse.ArgumentParser()
parser.add_argument("engine_vars", type=str, nargs="?", default="{}")
parser.add_argument("images", type=str, nargs="?", default="{}")
parser.add_argument("config", type=str, nargs="?", default="{}")

# Allow the path to be overridden on the command line. This lets the
# plugin be tested against any path, not just the engine work path.
parser.add_argument("path", type=str, nargs="?", default=CODE_DIRECTORY)

for arg in extra_args or []:
Expand All @@ -80,19 +97,22 @@ def parse_args(in_args=None, extra_args=None):
# Load the engine vars
try:
args.engine_vars = json.loads(args.engine_vars)
except json.JSONDecodeError:
except json.JSONDecodeError as ex:
log.error("Invalid engine vars argument", exc_info=ex)
args.engine_vars = {}

# Load the config dict
try:
args.config = json.loads(args.config)
except json.JSONDecodeError:
except json.JSONDecodeError as ex:
log.error("Invalid plugin config argument", exc_info=ex)
args.config = {}

# Load the images dict
try:
args.images = json.loads(args.images)
except json.JSONDecodeError:
except json.JSONDecodeError as ex:
log.error("Invalid scan images argument", exc_info=ex)
args.images = {}

return args
Expand Down