Create devcontainer virtual environment during prebuild

Author: simonkurtz-MSFT

.devcontainer/devcontainer.json

@@ -38,19 +38,19 @@
         "ms-vscode.vscode-json"
       ],
       "settings": {
-        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.defaultInterpreterPath": "/opt/venv/bin/python",
         "python.linting.enabled": true,
         "python.linting.pylintEnabled": true,
-        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
-        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
-        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
-        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
-        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
-        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
-        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
-        "python.testing.pytestPath": "/usr/local/py-utils/bin/pytest",
+        "python.formatting.autopep8Path": "/opt/venv/bin/autopep8",
+        "python.formatting.blackPath": "/opt/venv/bin/black",
+        "python.formatting.yapfPath": "/opt/venv/bin/yapf",
+        "python.linting.banditPath": "/opt/venv/bin/bandit",
+        "python.linting.flake8Path": "/opt/venv/bin/flake8",
+        "python.linting.mypyPath": "/opt/venv/bin/mypy",
+        "python.linting.pycodestylePath": "/opt/venv/bin/pycodestyle",
+        "python.linting.pydocstylePath": "/opt/venv/bin/pydocestyle",
+        "python.linting.pylintPath": "/opt/venv/bin/pylint",
+        "python.testing.pytestPath": "/opt/venv/bin/pytest",
         "jupyter.askForKernelRestart": false,
         "jupyter.interactiveWindow.textEditor.executeSelection": true,
         "files.associations": {
@@ -60,9 +60,11 @@
     }
   },
   "containerEnv": {
-    "PYTHONPATH": "/workspaces/Apim-Samples/shared/python:/workspaces/Apim-Samples"
+    "PYTHONPATH": "/workspaces/Apim-Samples/shared/python:/workspaces/Apim-Samples",
+    "VIRTUAL_ENV": "/opt/venv",
+    "PATH": "/opt/venv/bin:${containerEnv:PATH}"
   },
-  "onCreateCommand": "bash .devcontainer/setup-prebuild.sh",
+  "postCreateCommand": "bash .devcontainer/setup-prebuild.sh",
   "postStartCommand": "bash .devcontainer/post-start.sh",
   "forwardPorts": [
     8000,

.devcontainer/post-start.sh

@@ -42,6 +42,7 @@ fi
 # ------------------------------
 
 echo "✅ Verifying Python environment..."
+source /opt/venv/bin/activate
 python --version
 
 echo ""
@@ -72,20 +73,23 @@ echo ""
 #    NEXT STEPS GUIDANCE
 # ------------------------------
 
+echo ""
+echo "==================================================================================================="
+echo ""
 echo "📋 Next steps:"
 echo ""
 if [ -f ".devcontainer/devcontainer.json" ] && grep -q '"mounts"' .devcontainer/devcontainer.json; then
     echo " ✅ Azure CLI config mounting detected - your authentication should be available"
     echo ""
-    echo "1. Verify Azure access and ensure correct tenant/subscription: az account show"
-    echo "2. If needed, switch tenant: az login --tenant <your-tenant-id-or-domain>"
-    echo "3. If needed, set subscription: az account set --subscription <your-subscription-id-or-name>"
+    echo "1. Verify Azure correct tenant/subscription   : az account show"
+    echo "2. If needed, switch tenant                   : az login --tenant <your-tenant-id-or-domain>"
+    echo "3. If needed, set subscription                : az account set --subscription <your-subscription-id-or-name>"
     echo "4. Execute shared/jupyter/verify-az-account.ipynb to verify your Azure setup"
 else
     echo ""
-    echo "1. Sign in to your specific Azure tenant: az login --tenant <your-tenant-id-or-domain>"
-    echo "2. Set your target subscription: az account set --subscription <your-subscription-id-or-name>"
-    echo "3. Verify your context: az account show"
+    echo "1. Sign in to your specific Azure tenant      : az login --tenant <your-tenant-id-or-domain>"
+    echo "2. Set your target subscription               : az account set --subscription <your-subscription-id-or-name>"
+    echo "3. Verify your context                        : az account show"
     echo "4. Execute shared/jupyter/verify-az-account.ipynb to verify your Azure setup"
 fi
 echo "5. Navigate to any infrastructure folder and run the create.ipynb notebook"

.devcontainer/setup-prebuild.sh

@@ -8,18 +8,46 @@ set -e
 
 echo "🔧 Running prebuild-optimized setup..."
 
+# Ensure we have proper permissions and environment
+export DEBIAN_FRONTEND=noninteractive
+
 # ------------------------------
 #    PYTHON ENVIRONMENT SETUP
 # ------------------------------
 
-echo "📦 Installing Python dependencies..."
-pip install --upgrade pip
+echo "📦 Setting up Python virtual environment..."
+# Create virtual environment with proper permissions
+sudo mkdir -p /opt/venv
+sudo chown vscode:vscode /opt/venv
+
+# Switch to vscode user for virtual environment creation
+sudo -u vscode bash << 'VENV_SETUP'
+set -e
+python -m venv /opt/venv
+source /opt/venv/bin/activate
+
+echo "📦 Installing Python dependencies in virtual environment..."
+pip install --upgrade pip setuptools wheel
 pip install -r requirements.txt
 
 # Ensure pytest and coverage tools are available
 pip install pytest pytest-cov coverage
 
+echo "✅ Virtual environment setup complete"
+VENV_SETUP
+
+# Activate virtual environment for the rest of the setup
+source /opt/venv/bin/activate
+
+# Make virtual environment available system-wide for the vscode user
+echo 'source /opt/venv/bin/activate' >> /home/vscode/.bashrc
+echo 'source /opt/venv/bin/activate' >> /home/vscode/.zshrc
+
+# Set ownership to vscode user (just to be sure)
+sudo chown -R vscode:vscode /opt/venv
+
 echo "🔧 Setting up Python path configuration..."
+source /opt/venv/bin/activate
 python setup/setup_python_path.py --generate-env
 
 # ------------------------------
@@ -40,6 +68,7 @@ az extension add --name front-door --only-show-errors 2>/dev/null || true
 # ------------------------------
 
 echo "📓 Setting up Jupyter environment..."
+source /opt/venv/bin/activate
 # Install Jupyter kernel (with error handling)
 if python -c "import ipykernel" 2>/dev/null; then
     python -m ipykernel install --user --name=apim-samples --display-name="APIM Samples Python" || echo "⚠️ Warning: Failed to install Jupyter kernel, but continuing..."
@@ -62,13 +91,13 @@ mkdir -p .vscode
 cat > .vscode/settings.json << 'EOF'
 {
   "python.terminal.activateEnvironment": true,
-  "python.defaultInterpreterPath": "/usr/local/bin/python",
+  "python.defaultInterpreterPath": "/opt/venv/bin/python",
   "python.analysis.extraPaths": [
     "/workspaces/Apim-Samples/shared/python"
   ],
   "jupyter.kernels.filter": [
     {
-      "path": "/usr/local/bin/python",
+      "path": "/opt/venv/bin/python",
       "type": "pythonEnvironment"
     }
   ],
@@ -89,9 +118,23 @@ echo "$(date): Prebuild setup completed" > .devcontainer/.prebuild-complete
 echo "🎉 Prebuild setup complete!"
 
 echo "✅ Verifying installation..."
+source /opt/venv/bin/activate
 echo "Python version: $(python --version)"
 echo "Azure CLI version: $(az --version | head -1)"
 echo "Pip packages installed:"
 pip list | grep -E "(requests|pandas|matplotlib|pytest|azure|jwt|jupyter|ipykernel)" || true
 
+echo ""
+echo "🔍 Running comprehensive verification..."
+if python .devcontainer/verify-venv.py; then
+    echo "✅ Virtual environment verification passed!"
+else
+    echo "⚠️ Virtual environment verification had issues - but continuing..."
+fi
+
 echo "📋 Prebuild optimization complete!"
+echo ""
+echo "🎯 Next container start should be significantly faster!"
+echo "   - Virtual environment: /opt/venv"
+echo "   - All packages pre-installed"
+echo "   - Ready for immediate development"

.devcontainer/verify-venv.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+"""
+Verification script to ensure virtual environment and packages are properly installed.
+"""
+import sys
+import subprocess
+import importlib
+
+# ------------------------------
+#    CONSTANTS
+# ------------------------------
+
+REQUIRED_PACKAGES = [
+    'requests',
+    'setuptools', 
+    'pandas',
+    'matplotlib',
+    'jwt',
+    'pytest',
+    'azure.storage.blob',
+    'azure.identity',
+    'jupyter',
+    'ipykernel',
+    'notebook'
+]
+
+# ------------------------------
+#    PUBLIC METHODS
+# ------------------------------
+
+def check_virtual_environment():
+    """Check if we're running in the expected virtual environment."""
+    expected_venv = '/opt/venv'
+    current_prefix = sys.prefix
+    
+    if expected_venv in current_prefix:
+        print(f"✅ Running in virtual environment: {current_prefix}")
+        return True
+    else:
+        print(f"❌ Not running in expected virtual environment. Current: {current_prefix}")
+        return False
+
+def check_package_imports():
+    """Check if all required packages can be imported."""
+    failed_imports = []
+    
+    for package in REQUIRED_PACKAGES:
+        try:
+            importlib.import_module(package)
+            print(f"✅ {package}")
+        except ImportError:
+            print(f"❌ {package}")
+            failed_imports.append(package)
+    
+    return len(failed_imports) == 0
+
+def check_executables():
+    """Check if Python executables are correctly configured."""
+    try:
+        python_path = subprocess.check_output(['which', 'python'], text=True).strip()
+        pip_path = subprocess.check_output(['which', 'pip'], text=True).strip()
+        
+        print(f"✅ Python executable: {python_path}")
+        print(f"✅ Pip executable: {pip_path}")
+        
+        expected_venv = '/opt/venv'
+        return expected_venv in python_path and expected_venv in pip_path
+    except subprocess.CalledProcessError:
+        print("❌ Failed to locate Python or pip executables")
+        return False
+
+def main():
+    """Main verification function."""
+    print("🔍 Verifying virtual environment setup...\n")
+    
+    checks = [
+        ("Virtual Environment", check_virtual_environment),
+        ("Package Imports", check_package_imports),
+        ("Executables", check_executables)
+    ]
+    
+    all_passed = True
+    
+    for check_name, check_func in checks:
+        print(f"\n📋 {check_name} Check:")
+        if not check_func():
+            all_passed = False
+    
+    print(f"\n{'✅ All checks passed!' if all_passed else '❌ Some checks failed!'}")
+    
+    return 0 if all_passed else 1
+
+if __name__ == "__main__":
+    sys.exit(main())