utils.py

import re
import string

from rpdk.core.exceptions import WizardValidationError

# https://docs.oracle.com/javase/tutorial/java/nutsandbolts/_keywords.html
LANGUAGE_KEYWORDS = {
    "abstract",
    "continue",
    "for",
    "new",
    "switch",
    "assert",
    "default",
    "goto",
    "package",
    "synchronized",
    "boolean",
    "do",
    "if",
    "private",
    "this",
    "break",
    "double",
    "implements",
    "protected",
    "throw",
    "byte",
    "else",
    "import",
    "public",
    "throws",
    "case",
    "enum",
    "instanceof",
    "return",
    "transient",
    "catch",
    "extends",
    "int",
    "short",
    "try",
    "char",
    "final",
    "interface",
    "static",
    "void",
    "class",
    "finally",
    "long",
    "strictfp",
    "volatile",
    "const",
    "float",
    "native",
    "super",
    "while",
}


# Keywords used in the context of AWS CloudFormation Hooks, when
# classes are generated, by this plugin, for target resource
# types. For example, the `properties` item below is marked as a
# keyword because if a target resource type has a property called
# `Properties` (see the `AWS::ApiGateway::DocumentationPart` resource
# type as one of the examples), the generated class code for the
# target resource type will contain a getter, `getProperties()`, that
# will collide with `getProperties()` that is already defined for
# `ResourceHookTarget`. By marking `properties` as a keyword, the
# generated code for the class will still have a relevant, private
# variable for the resource type target's property, but whose name
# will contain an underscore as a suffix: the Lombok-generated getter
# (and setter) for that private variable will, in turn, contain an
# underscore suffix as well; see `safe_reserved_hook_target()` below
# for more information (`safe_reserved_hook_target()` is, in turn,
# consumed by other parts of a hook's code generation logic in this
# plugin).
HOOK_TARGET_KEYWORDS = {
    "properties",
}


def safe_reserved(token):
    if token in LANGUAGE_KEYWORDS:
        return token + "_"
    return token


# This is a specialized method for hooks only. In addition to using
# LANGUAGE_KEYWORDS (used by safe_reserved()), this function uses
# HOOK_TARGET_KEYWORDS: the reason for having such a specialized
# method is that since excluding `properties` will alter an affected
# target's getters and setters (see this specific case explained in
# comments for `HOOK_TARGET_KEYWORDS`), we do not want to have the
# same behavior for resource type extensions, that you also model with
# this plugin of the CloudFormation CLI.
def safe_reserved_hook_target(token):
    if token in LANGUAGE_KEYWORDS or token in HOOK_TARGET_KEYWORDS:
        return token + "_"
    return token


def validate_namespace(default):
    pattern = r"^[_a-z][_a-z0-9]+$"

    def _validate_namespace(value):
        if not value:
            return default

        if value.lower() != value:
            raise WizardValidationError("Package names must be all lower case")

        namespace = value.split(".")

        for name in namespace:
            if not name:
                raise WizardValidationError(f"Empty segment in '{value}'")
            if name in LANGUAGE_KEYWORDS:
                raise WizardValidationError(f"'{name}' is a reserved keyword")
            startswith = name[0]
            if startswith not in string.ascii_lowercase + "_":
                raise WizardValidationError(
                    f"Segment '{name}' must begin with a lower case letter or "
                    "an underscore"
                )

            match = re.match(pattern, name)
            if not match:
                raise WizardValidationError(
                    f"Segment '{name}' should match '{pattern}'"
                )

        return tuple(namespace)

    return _validate_namespace


def validate_codegen_model(default):
    pattern = r"^[1-2]$"

    def _validate_codegen_model(value):
        if not value:
            return default

        match = re.match(pattern, value)
        if not match:
            raise WizardValidationError("Invalid selection.")

        return value

    return _validate_codegen_model