-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'aws-sam-cli-public/develop-terraform-ho…
…oks' into develop # Conflicts: # samcli/commands/_utils/experimental.py
- Loading branch information
Showing
94 changed files
with
7,151 additions
and
251 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| """ | ||
| SAM CLI Default Build constants | ||
| """ | ||
| import os | ||
|
|
||
| DEFAULT_STACK_NAME = "sam-app" | ||
| DEFAULT_BUILD_DIR = os.path.join(".aws-sam", "build") | ||
| DEFAULT_BUILD_DIR_WITH_AUTO_DEPENDENCY_LAYER = os.path.join(".aws-sam", "auto-dependency-layer") | ||
| DEFAULT_CACHE_DIR = os.path.join(".aws-sam", "cache") | ||
| DEFAULT_BUILT_TEMPLATE_PATH = os.path.join(".aws-sam", "build", "template.yaml") |
118 changes: 118 additions & 0 deletions
118
samcli/commands/_utils/custom_options/hook_package_id_option.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| """ | ||
| Custom Click options for hook package id | ||
| """ | ||
|
|
||
| import logging | ||
| import os | ||
| import click | ||
|
|
||
| from samcli.commands._utils.constants import DEFAULT_BUILT_TEMPLATE_PATH | ||
| from samcli.commands._utils.experimental import prompt_experimental, ExperimentalFlag | ||
| from samcli.lib.hook.exceptions import InvalidHookWrapperException | ||
| from samcli.lib.hook.hook_wrapper import IacHookWrapper, get_available_hook_packages_ids | ||
|
|
||
| LOG = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class HookPackageIdOption(click.Option): | ||
| """ | ||
| A custom option class that allows do custom validation for the SAM CLI commands options in case if hook package | ||
| id is passed. It also calls the correct IaC prepare hook, and update the SAM CLI commands options based on the | ||
| prepare hook output. | ||
| """ | ||
|
|
||
| def __init__(self, *args, **kwargs): | ||
| self._force_prepare = kwargs.pop("force_prepare", True) | ||
| self._invalid_coexist_options = kwargs.pop("invalid_coexist_options", []) | ||
| super().__init__(*args, **kwargs) | ||
|
|
||
| def handle_parse_result(self, ctx, opts, args): | ||
| opt_name = self.name.replace("_", "-") | ||
| if self.name in opts: | ||
| command_name = ctx.command.name | ||
| if command_name in ["invoke", "start-lambda", "start-api"]: | ||
| command_name = f"local {command_name}" | ||
| # validate the hook_package_id value exists | ||
| hook_package_id = opts[self.name] | ||
| iac_hook_wrapper = None | ||
| try: | ||
| iac_hook_wrapper = IacHookWrapper(hook_package_id) | ||
| except InvalidHookWrapperException as e: | ||
| raise click.BadParameter( | ||
| f"{hook_package_id} is not a valid hook package id. This is the list of valid " | ||
| f"packages ids {get_available_hook_packages_ids()}" | ||
| ) from e | ||
|
|
||
| # validate coexist options | ||
| for invalid_opt in self._invalid_coexist_options: | ||
| invalid_opt_name = invalid_opt.replace("-", "_") | ||
| if invalid_opt_name in opts: | ||
| raise click.BadParameter( | ||
| f"Parameters {opt_name}, and {','.join(self._invalid_coexist_options)} can not be used together" | ||
| ) | ||
| # check beta-feature | ||
| beta_features = opts.get("beta_features") | ||
|
|
||
| # check if beta feature flag is required for a specific hook package | ||
| # The IaCs support experimental flag map will contain only the beta IaCs. In case we support the external | ||
| # hooks, we need to first know that the hook package is an external, and to handle the beta feature of it | ||
| # using different approach | ||
| experimental_entry = ExperimentalFlag.IaCsSupport.get(hook_package_id) | ||
| if beta_features is None and experimental_entry is not None: | ||
|
|
||
| iac_support_message = _get_iac_support_experimental_prompt_message(hook_package_id, command_name) | ||
| if not prompt_experimental(experimental_entry, iac_support_message): | ||
| LOG.debug("Experimental flag is disabled and prepare hook is not run") | ||
| return super().handle_parse_result(ctx, opts, args) | ||
| elif not beta_features: | ||
| LOG.debug("beta-feature flag is disabled and prepare hook is not run") | ||
| return super().handle_parse_result(ctx, opts, args) | ||
|
|
||
| # call prepare hook | ||
| built_template_path = DEFAULT_BUILT_TEMPLATE_PATH | ||
| if not self._force_prepare and os.path.exists(built_template_path): | ||
| LOG.info("Skip Running Prepare hook. The current application is already prepared.") | ||
| else: | ||
| LOG.info("Running Prepare Hook to prepare the current application") | ||
|
|
||
| iac_project_path = os.getcwd() | ||
| output_dir_path = os.path.join(iac_project_path, ".aws-sam", "iacs_metadata") | ||
| if not os.path.exists(output_dir_path): | ||
| os.makedirs(output_dir_path, exist_ok=True) | ||
| debug = opts.get("debug", False) | ||
| aws_profile = opts.get("profile") | ||
| aws_region = opts.get("region") | ||
| metadata_file = iac_hook_wrapper.prepare( | ||
| output_dir_path, iac_project_path, debug, aws_profile, aws_region | ||
| ) | ||
|
|
||
| LOG.info("Prepare Hook is done, and metadata file generated at %s", metadata_file) | ||
| opts["template_file"] = metadata_file | ||
| return super().handle_parse_result(ctx, opts, args) | ||
|
|
||
|
|
||
| def _get_iac_support_experimental_prompt_message(hook_package_id: str, command: str) -> str: | ||
| """ | ||
| return the customer prompt message for a specific hook package. | ||
| Parameters | ||
| ---------- | ||
| hook_package_id: str | ||
| the hook package id to determine what is the supported iac | ||
| command: str | ||
| the current sam command | ||
| Returns | ||
| ------- | ||
| str | ||
| the customer prompt message for a specific IaC. | ||
| """ | ||
|
|
||
| supported_iacs_messages = { | ||
| "terraform": ( | ||
| "Supporting Terraform applications is a beta feature.\n" | ||
| "Please confirm if you would like to proceed using SAM CLI with terraform application.\n" | ||
| f"You can also enable this beta feature with 'sam {command} --beta-features'." | ||
| ) | ||
| } | ||
| return supported_iacs_messages.get(hook_package_id, "") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| """ | ||
| Parameterized Option Class | ||
| """ | ||
|
|
||
| import types | ||
|
|
||
|
|
||
| def parameterized_option(option): | ||
| """Meta decorator for option decorators. | ||
| This adds the ability to specify optional parameters for option decorators. | ||
| Usage: | ||
| @parameterized_option | ||
| def some_option(f, required=False) | ||
| ... | ||
| @some_option | ||
| def command(...) | ||
| or | ||
| @some_option(required=True) | ||
| def command(...) | ||
| """ | ||
|
|
||
| def parameter_wrapper(*args, **kwargs): | ||
| if len(args) == 1 and isinstance(args[0], types.FunctionType): | ||
| # Case when option decorator does not have parameter | ||
| # @stack_name_option | ||
| # def command(...) | ||
| return option(args[0]) | ||
|
|
||
| # Case when option decorator does have parameter | ||
| # @stack_name_option("a", "b") | ||
| # def command(...) | ||
|
|
||
| def option_wrapper(f): | ||
| return option(f, *args, **kwargs) | ||
|
|
||
| return option_wrapper | ||
|
|
||
| return parameter_wrapper |
Oops, something went wrong.