Skip to content

tests: resolve sam init menu positions dynamically in schemas tests #9151

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

Open
roger-zhangg wants to merge 1 commit into
base: develop
Choose a base branch
from
+69 −35
Open

tests: resolve sam init menu positions dynamically in schemas tests #9151

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
104 changes: 69 additions & 35 deletions tests/integration/init/schemas/test_init_with_schemas_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@
from click.testing import CliRunner

from samcli.commands.init import cli as init_cmd
from samcli.commands.init.init_templates import InitTemplates
from samcli.commands.init.interactive_init_flow import get_sorted_runtimes
from tests.integration.init.schemas.schemas_test_data_setup import SchemaTestDataSetup
from tests.testing_utils import RUNNING_ON_CI, RUNNING_TEST_FOR_MASTER_ON_CI, RUN_BY_CANARY

# Schemas tests require credentials. This is to skip running the test where credentials are not available.
SKIP_SCHEMA_TESTS = RUNNING_ON_CI and RUNNING_TEST_FOR_MASTER_ON_CI and not RUN_BY_CANARY

EVENT_BRIDGE_USE_CASE = "Infrastructure event management"


def _get_registry_position(registry_name):
"""Query EventBridge Schema registries and return the 1-based menu position for the given registry name.
Expand All @@ -34,15 +38,45 @@ def _get_registry_position(registry_name):
raise ValueError(f"Registry '{registry_name}' not found. Available: {registries}")


def _get_runtime_position(runtime_name):
"""Return the 1-based menu position of a runtime in the `sam init` runtime prompt.

The prompt lists the runtimes the app-templates manifest offers for
EVENT_BRIDGE_USE_CASE, ordered by `get_sorted_runtimes`. That ordering shifts
whenever a runtime is added or removed, so hardcoding a position silently
starts selecting a different runtime -- every answer after it then lands on
the wrong question. Resolve it the same way `_get_registry_position` does.
"""
runtime_options = InitTemplates().get_preprocessed_manifest(None, None, None, None)[EVENT_BRIDGE_USE_CASE]
runtimes = get_sorted_runtimes(list(runtime_options.keys()))
for i, name in enumerate(runtimes, 1):
if name == runtime_name:
return i
raise ValueError(f"Runtime '{runtime_name}' not found. Available: {runtimes}")


def _get_use_case_position(use_case_name):
"""Return the 1-based menu position of a use case in the `sam init` template prompt.

Same rationale as `_get_runtime_position`: the manifest grows over time, so
the position of a use case is not stable.
"""
use_cases = list(InitTemplates().get_preprocessed_manifest(None, None, None, None).keys())
for i, name in enumerate(use_cases, 1):
if name == use_case_name:
return i
raise ValueError(f"Use case '{use_case_name}' not found. Available: {use_cases}")


@skipIf(SKIP_SCHEMA_TESTS, "Skip schema test")
@pytest.mark.xdist_group(name="sam_init")
class TestBasicInitWithEventBridgeCommand(SchemaTestDataSetup):
@pytest.mark.timeout(300)
def test_init_interactive_with_event_bridge_app_aws_registry(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 4: Java Runtime
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {java_runtime_pos}: java17.al2023 (dynamic position)
# 2: Maven
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
Expand All @@ -56,8 +90,8 @@ def test_init_interactive_with_event_bridge_app_aws_registry(self):
aws_registry_pos = _get_registry_position("aws.events")
user_input = f"""
1
8
4
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("java17.al2023")}
2
2
N
Expand Down Expand Up @@ -85,8 +119,8 @@ def test_init_interactive_with_event_bridge_app_aws_registry(self):
def test_init_interactive_with_event_bridge_app_partner_registry(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 4: Java Runtime
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {java_runtime_pos}: java17.al2023 (dynamic position)
# 2: Maven
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
Expand All @@ -99,8 +133,8 @@ def test_init_interactive_with_event_bridge_app_partner_registry(self):
partner_registry_pos = _get_registry_position("partner-registry")
user_input = f"""
1
8
4
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("java17.al2023")}
2
2
N
Expand Down Expand Up @@ -139,8 +173,8 @@ def test_init_interactive_with_event_bridge_app_partner_registry(self):
def test_init_interactive_with_event_bridge_app_pagination(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 4: Java Runtime
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {java_runtime_pos}: java17.al2023 (dynamic position)
# 2: Maven
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
Expand All @@ -155,8 +189,8 @@ def test_init_interactive_with_event_bridge_app_pagination(self):
pagination_registry_pos = _get_registry_position("test-pagination")
user_input = f"""
1
8
4
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("java17.al2023")}
2
2
N
Expand Down Expand Up @@ -186,8 +220,8 @@ def test_init_interactive_with_event_bridge_app_pagination(self):
def test_init_interactive_with_event_bridge_app_customer_registry(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 4: Java Runtime
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {java_runtime_pos}: java17.al2023 (dynamic position)
# 2: Maven
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
Expand All @@ -200,8 +234,8 @@ def test_init_interactive_with_event_bridge_app_customer_registry(self):
other_schema_pos = _get_registry_position("other-schema")
user_input = f"""
1
8
4
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("java17.al2023")}
2
2
N
Expand Down Expand Up @@ -240,8 +274,8 @@ def test_init_interactive_with_event_bridge_app_customer_registry(self):
def test_init_interactive_with_event_bridge_app_aws_schemas_python(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 8: Python 3.9
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {python_runtime_pos}: python3.9 (dynamic position)
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
# N: disable cloudwatch insights
Expand All @@ -254,8 +288,8 @@ def test_init_interactive_with_event_bridge_app_aws_schemas_python(self):
aws_registry_pos = _get_registry_position("aws.events")
user_input = f"""
1
8
8
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("python3.9")}
2
N
N
Expand All @@ -280,8 +314,8 @@ def test_init_interactive_with_event_bridge_app_aws_schemas_python(self):
def test_init_interactive_with_event_bridge_app_aws_schemas_go(self):
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 1: Go 1.x
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {go_runtime_pos}: go (provided.al2) (dynamic position)
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
# N: disable cloudwatch insights
Expand All @@ -291,10 +325,10 @@ def test_init_interactive_with_event_bridge_app_aws_schemas_go(self):
# 4: select aws.events as registries
# 1: select aws schema

user_input = """
1
8
user_input = f"""
1
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("go (provided.al2)")}
2
N
N
Expand All @@ -319,8 +353,8 @@ def test_init_interactive_with_event_bridge_app_non_default_profile_selection(se
self._init_custom_config("mynewprofile", "us-west-2")
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 8: Python 3.9
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {python_runtime_pos}: python3.9 (dynamic position)
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
# N: disable cloudwatch insights
Expand All @@ -332,10 +366,10 @@ def test_init_interactive_with_event_bridge_app_non_default_profile_selection(se
# 1: select aws.events as registries
# 1: select aws schema

user_input = """
user_input = f"""
1
8
8
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("python3.9")}
2
N
N
Expand Down Expand Up @@ -363,8 +397,8 @@ def test_init_interactive_with_event_bridge_app_non_supported_schemas_region(sel
self._init_custom_config("default", "cn-north-1")
# WHEN the user follows interactive init prompts
# 1: AWS Quick Start Templates
# 8: Infrastructure event management - Use case
# 7: Python 3.9
# {use_case_pos}: Infrastructure event management - Use case (dynamic position)
# {python_runtime_pos}: python3.9 (dynamic position)
# 2: select event-bridge app from scratch
# N: disable adding xray tracing
# N: disable cloudwatch insights
Expand All @@ -374,10 +408,10 @@ def test_init_interactive_with_event_bridge_app_non_supported_schemas_region(sel
# 1: select aws.events as registries
# 1: select aws schema

user_input = """
user_input = f"""
1
8
8
{_get_use_case_position(EVENT_BRIDGE_USE_CASE)}
{_get_runtime_position("python3.9")}
2
N
N
Expand Down
Loading