Add user-defined infrastructure creation behavior

Author: simonkurtz-MSFT

.env-example

@@ -0,0 +1,35 @@
+<!-- markdownlint-disable -->
+# Auto-generated environment configuration example for VS Code and local tooling
+# Copy this file to .env and customize values, or run:
+#   python setup/local_setup.py --generate-env
+#
+# Good to set console width to 220, 221 - whatever it takes to see the full output
+
+# Console output width in characters (default: 180)
+APIM_SAMPLES_CONSOLE_WIDTH=180
+
+# Log level for Python logging (default: INFO)
+# Valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL
+APIM_SAMPLES_LOG_LEVEL=INFO
+
+# Infrastructure creation behavior when desired infrastructure doesn't exist (default: ask-always)
+#
+# This controls what happens when a sample is executed and the desired infrastructure
+# (specified by deployment type and index) does not exist.
+#
+# Valid values:
+#   ask-always         - Always prompt the user to choose: create new or select existing (default)
+#   create-new-always  - Automatically create a new infrastructure without prompting
+#
+APIM_SAMPLES_INFRA_CREATION_BEHAVIOR=ask-always
+
+# Project root directory (auto-set by local_setup.py)
+# PROJECT_ROOT=
+
+# Python path for shared modules (auto-set by local_setup.py)
+# PYTHONPATH=
+
+# OAuth 3rd-party sample: Spotify Client ID and Secret (optional)
+# See: samples/oauth-3rd-party/README.md
+# SPOTIFY_CLIENT_ID=
+# SPOTIFY_CLIENT_SECRET=

.gitignore

@@ -26,8 +26,9 @@ labs-in-progress/
 # Misc
 *.log
 
-# Exclude sensitive or generated files
+# Exclude sensitive or generated files (except for the benign example)
 .env*
+!.env-example
 
 # Coverage data and reports
 .coverage

setup/local_setup.py

@@ -293,6 +293,7 @@ def generate_env_file() -> None:
     managed_keys = {
         'APIM_SAMPLES_CONSOLE_WIDTH': existing_vars.get('APIM_SAMPLES_CONSOLE_WIDTH', '180'),
         'APIM_SAMPLES_LOG_LEVEL': existing_vars.get('APIM_SAMPLES_LOG_LEVEL', 'INFO'),
+        'APIM_SAMPLES_INFRA_CREATION_BEHAVIOR': existing_vars.get('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'ask-always'),
         'PROJECT_ROOT': str(project_root),
         'PYTHONPATH': str(shared_python_path),
         'SPOTIFY_CLIENT_ID': existing_vars.get('SPOTIFY_CLIENT_ID', ''),
@@ -310,6 +311,7 @@ def generate_env_file() -> None:
         '',
         f'APIM_SAMPLES_CONSOLE_WIDTH={managed_keys["APIM_SAMPLES_CONSOLE_WIDTH"]}',
         f'APIM_SAMPLES_LOG_LEVEL={managed_keys["APIM_SAMPLES_LOG_LEVEL"]}',
+        f'APIM_SAMPLES_INFRA_CREATION_BEHAVIOR={managed_keys["APIM_SAMPLES_INFRA_CREATION_BEHAVIOR"]}',
         f'PROJECT_ROOT={managed_keys["PROJECT_ROOT"]}',
         f'PYTHONPATH={managed_keys["PYTHONPATH"]}',
         f'SPOTIFY_CLIENT_ID={managed_keys["SPOTIFY_CLIENT_ID"]}',

shared/python/utils.py

@@ -448,6 +448,28 @@ def _query_and_select_infrastructure(self) -> tuple[INFRASTRUCTURE | None, int |
 
         print_plain('')
 
+        # Check the infrastructure creation behavior setting
+        infra_creation_behavior = os.getenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'ask-always').lower()
+
+        # If behavior is set to always create new and there are existing options, automatically select create_new (option 1)
+        if infra_creation_behavior == 'create-new-always' and available_options:
+            # Option 1 is always the "create_new" option
+            option_type, selected_infra, selected_index = display_options[0]
+            index_suffix = f' (index: {selected_index})' if selected_index is not None else ''
+            print_info(f'APIM_SAMPLES_INFRA_CREATION_BEHAVIOR=create-new-always: Creating new infrastructure: {selected_infra.value}{index_suffix}')
+
+            # Execute the infrastructure creation
+            inb_helper = InfrastructureNotebookHelper(self.rg_location, self.deployment, selected_index, self.apim_sku)
+            success = inb_helper.create_infrastructure(True)  # Bypass infrastructure check to force creation
+
+            if success:
+                index_suffix = f' (index: {selected_index})' if selected_index is not None else ''
+                print_ok(f'Successfully created infrastructure: {selected_infra.value}{index_suffix}')
+                return selected_infra, selected_index
+
+            print_error('Failed to create infrastructure.')
+            return None, None
+
         # Get user selection
         while True:
             try:

tests/python/test_utils.py

@@ -3170,3 +3170,226 @@ def patched_query_and_select():
 
     assert selected_infra == INFRASTRUCTURE.SIMPLE_APIM
     assert selected_index == 2
+
+
+@pytest.mark.unit
+def test_query_and_select_infrastructure_create_new_always_behavior(monkeypatch, suppress_utils_console):
+    """Test APIM_SAMPLES_INFRA_CREATION_BEHAVIOR=create-new-always automatically creates new infrastructure."""
+    nb_helper = utils.NotebookHelper(
+        'test-sample',
+        'apim-infra-simple-apim-1',
+        'eastus',
+        INFRASTRUCTURE.SIMPLE_APIM,
+        [INFRASTRUCTURE.SIMPLE_APIM],
+    )
+
+    monkeypatch.setenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'create-new-always')
+
+    monkeypatch.setattr(
+        az,
+        'find_infrastructure_instances',
+        lambda infra: [(INFRASTRUCTURE.SIMPLE_APIM, 5)] if infra == INFRASTRUCTURE.SIMPLE_APIM else [],
+    )
+    monkeypatch.setattr(
+        az,
+        'get_infra_rg_name',
+        lambda infra, index=None: f'apim-infra-{infra.value}' if index is None else f'apim-infra-{infra.value}-{index}',
+    )
+
+    created_helpers = []
+
+    class DummyInfraHelper:
+        def __init__(self, rg_location, deployment, index, apim_sku):
+            self.rg_location = rg_location
+            self.deployment = deployment
+            self.index = index
+            self.apim_sku = apim_sku
+            self.calls = []
+            created_helpers.append(self)
+
+        def create_infrastructure(self, bypass):
+            self.calls.append(bypass)
+            return True
+
+    monkeypatch.setattr(utils, 'InfrastructureNotebookHelper', DummyInfraHelper)
+
+    # User input should NOT be requested
+    input_called = []
+
+    def mock_input(prompt):
+        input_called.append(prompt)
+        raise AssertionError('input() should not be called when create-new-always is set')
+
+    monkeypatch.setattr('builtins.input', mock_input)
+
+    selected_infra, selected_index = nb_helper._query_and_select_infrastructure()
+
+    assert selected_infra == INFRASTRUCTURE.SIMPLE_APIM
+    assert selected_index == 1
+    assert created_helpers
+    assert created_helpers[0].calls == [True]
+    assert len(input_called) == 0  # input() should not have been called
+
+
+@pytest.mark.unit
+def test_query_and_select_infrastructure_ask_always_behavior_default(monkeypatch, suppress_utils_console):
+    """Test APIM_SAMPLES_INFRA_CREATION_BEHAVIOR=ask-always (default) prompts user."""
+    nb_helper = utils.NotebookHelper(
+        'test-sample',
+        'apim-infra-simple-apim-1',
+        'eastus',
+        INFRASTRUCTURE.SIMPLE_APIM,
+        [INFRASTRUCTURE.SIMPLE_APIM],
+    )
+
+    # Default behavior (or explicitly set to ask-always)
+    monkeypatch.setenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'ask-always')
+
+    monkeypatch.setattr(
+        az,
+        'find_infrastructure_instances',
+        lambda infra: [(INFRASTRUCTURE.SIMPLE_APIM, 5)] if infra == INFRASTRUCTURE.SIMPLE_APIM else [],
+    )
+    monkeypatch.setattr(
+        az,
+        'get_infra_rg_name',
+        lambda infra, index=None: f'apim-infra-{infra.value}' if index is None else f'apim-infra-{infra.value}-{index}',
+    )
+
+    # User selects existing infrastructure (option 2)
+    monkeypatch.setattr('builtins.input', lambda prompt: '2')
+
+    selected_infra, selected_index = nb_helper._query_and_select_infrastructure()
+
+    assert selected_infra == INFRASTRUCTURE.SIMPLE_APIM
+    assert selected_index == 5
+
+
+@pytest.mark.unit
+def test_query_and_select_infrastructure_invalid_behavior_defaults_to_ask(monkeypatch, suppress_utils_console):
+    """Test invalid APIM_SAMPLES_INFRA_CREATION_BEHAVIOR value defaults to ask-always."""
+    nb_helper = utils.NotebookHelper(
+        'test-sample',
+        'apim-infra-simple-apim-1',
+        'eastus',
+        INFRASTRUCTURE.SIMPLE_APIM,
+        [INFRASTRUCTURE.SIMPLE_APIM],
+    )
+
+    # Set to invalid value
+    monkeypatch.setenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'invalid-value')
+
+    monkeypatch.setattr(
+        az,
+        'find_infrastructure_instances',
+        lambda infra: [(INFRASTRUCTURE.SIMPLE_APIM, 5)] if infra == INFRASTRUCTURE.SIMPLE_APIM else [],
+    )
+    monkeypatch.setattr(
+        az,
+        'get_infra_rg_name',
+        lambda infra, index=None: f'apim-infra-{infra.value}' if index is None else f'apim-infra-{infra.value}-{index}',
+    )
+
+    # User selects existing infrastructure (option 2) - should be prompted
+    monkeypatch.setattr('builtins.input', lambda prompt: '2')
+
+    selected_infra, selected_index = nb_helper._query_and_select_infrastructure()
+
+    # Should prompt user (not auto-create) because invalid value defaults to ask-always
+    assert selected_infra == INFRASTRUCTURE.SIMPLE_APIM
+    assert selected_index == 5
+
+
+@pytest.mark.unit
+def test_query_and_select_infrastructure_create_new_always_no_existing_options(monkeypatch, suppress_utils_console):
+    """Test create-new-always when no existing infrastructures found (auto-create path)."""
+    nb_helper = utils.NotebookHelper(
+        'test-sample',
+        'apim-infra-simple-apim',
+        'eastus',
+        INFRASTRUCTURE.SIMPLE_APIM,
+        [INFRASTRUCTURE.SIMPLE_APIM],
+    )
+
+    monkeypatch.setenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'create-new-always')
+
+    monkeypatch.setattr(az, 'find_infrastructure_instances', lambda infra: [])
+    monkeypatch.setattr(
+        az,
+        'get_infra_rg_name',
+        lambda infra, index=None: f'apim-infra-{infra.value}' if index is None else f'apim-infra-{infra.value}-{index}',
+    )
+
+    created_helpers = []
+
+    class DummyInfraHelper:
+        def __init__(self, rg_location, deployment, index, apim_sku):
+            self.rg_location = rg_location
+            self.deployment = deployment
+            self.index = index
+            self.apim_sku = apim_sku
+            self.calls = []
+            created_helpers.append(self)
+
+        def create_infrastructure(self, bypass):
+            self.calls.append(bypass)
+            return True
+
+    monkeypatch.setattr(utils, 'InfrastructureNotebookHelper', DummyInfraHelper)
+
+    selected_infra, selected_index = nb_helper._query_and_select_infrastructure()
+
+    # Should create infrastructure automatically
+    assert selected_infra == INFRASTRUCTURE.SIMPLE_APIM
+    assert selected_index is None
+    assert created_helpers
+    assert created_helpers[0].calls == [True]
+
+
+@pytest.mark.unit
+def test_query_and_select_infrastructure_create_new_always_failure(monkeypatch, suppress_utils_console):
+    """Test create-new-always when infrastructure creation fails."""
+    nb_helper = utils.NotebookHelper(
+        'test-sample',
+        'apim-infra-simple-apim-1',
+        'eastus',
+        INFRASTRUCTURE.SIMPLE_APIM,
+        [INFRASTRUCTURE.SIMPLE_APIM],
+    )
+
+    monkeypatch.setenv('APIM_SAMPLES_INFRA_CREATION_BEHAVIOR', 'create-new-always')
+
+    monkeypatch.setattr(
+        az,
+        'find_infrastructure_instances',
+        lambda infra: [(INFRASTRUCTURE.SIMPLE_APIM, 5)] if infra == INFRASTRUCTURE.SIMPLE_APIM else [],
+    )
+    monkeypatch.setattr(
+        az,
+        'get_infra_rg_name',
+        lambda infra, index=None: f'apim-infra-{infra.value}' if index is None else f'apim-infra-{infra.value}-{index}',
+    )
+
+    created_helpers = []
+
+    class DummyInfraHelper:
+        def __init__(self, rg_location, deployment, index, apim_sku):
+            self.rg_location = rg_location
+            self.deployment = deployment
+            self.index = index
+            self.apim_sku = apim_sku
+            self.calls = []
+            created_helpers.append(self)
+
+        def create_infrastructure(self, bypass):
+            self.calls.append(bypass)
+            return False  # Simulate failure
+
+    monkeypatch.setattr(utils, 'InfrastructureNotebookHelper', DummyInfraHelper)
+
+    selected_infra, selected_index = nb_helper._query_and_select_infrastructure()
+
+    assert selected_infra is None
+    assert selected_index is None
+    assert created_helpers
+    assert created_helpers[0].calls == [True]