Merge pull request #56 from Azure-Samples/azure-ppeline

Add pipeline to deploy to Azure and smoke test the app

Author: pamelafox

.github/workflows/azure-dev.yaml

@@ -0,0 +1,125 @@
+name: Deploy to Azure
+
+on:
+  workflow_dispatch:
+  push:
+    # Run when commits are pushed to mainline branch
+    branches:
+      - main
+  pull_request:
+    # Run when a pull request is created targeting the mainline branch
+    branches:
+      - main
+
+# GitHub Actions workflow to deploy to Azure using azd
+# To configure required secrets for connecting to Azure, simply run `azd pipeline config`
+
+# Set up permissions for deploying with secretless Azure federated credentials
+# https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Clinux#set-up-azure-login-with-openid-connect-authentication
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      uri: ${{ steps.output.outputs.uri }}
+    env:
+      AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
+      AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
+      AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+      AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS }}
+      # Project-specific variables
+      AZURE_SEARCH_SERVICE_LOCATION: ${{ vars.AZURE_SEARCH_SERVICE_LOCATION }}
+      AZURE_SEARCH_SERVICE: ${{ vars.AZURE_SEARCH_SERVICE }}
+      AZURE_SEARCH_INDEX: ${{ vars.AZURE_SEARCH_INDEX }}
+      AZURE_SEARCH_SERVICE_RESOURCE_GROUP: ${{ vars.AZURE_SEARCH_SERVICE_RESOURCE_GROUP }}
+      AZURE_SEARCH_SERVICE_SKU: ${{ vars.AZURE_SEARCH_SERVICE_SKU }}
+      AZURE_SEARCH_SEMANTIC_SEARCH_SKU: ${{ vars.AZURE_SEARCH_SEMANTIC_SEARCH_SKU }}
+      AZURE_STORAGE_ACCOUNT_LOCATION: ${{ vars.AZURE_STORAGE_ACCOUNT_LOCATION }}
+      AZURE_STORAGE_ACCOUNT_RESOURCE_GROUP: ${{ vars.AZURE_STORAGE_ACCOUNT_RESOURCE_GROUP }}
+      AZURE_STORAGE_ACCOUNT: ${{ vars.AZURE_STORAGE_ACCOUNT }}
+      AZURE_API_SERVICE_LOCATION: ${{ vars.AZURE_API_SERVICE_LOCATION }}
+      AZURE_API_SERVICE_RESOURCE_GROUP: ${{ vars.AZURE_API_SERVICE_RESOURCE_GROUP }}
+      AZURE_LOG_ANALYTICS: ${{ vars.AZURE_LOG_ANALYTICS }}
+      AZURE_APPINSIGHTS: ${{ vars.AZURE_APPINSIGHTS }}
+      AZURE_COMPUTER_VISION_ACCOUNT: ${{ vars.AZURE_COMPUTER_VISION_ACCOUNT }}
+      AZURE_COMPUTER_VISION_RESOURCE_GROUP: ${{ vars.AZURE_COMPUTER_VISION_RESOURCE_GROUP }}
+      AZURE_COMPUTER_VISION_LOCATION: ${{ vars.AZURE_COMPUTER_VISION_LOCATION }}
+      AZURE_COMPUTER_VISION_SKU_NAME: ${{ vars.AZURE_COMPUTER_VISION_SKU_NAME }}
+      SERVICE_ACA_RESOURCE_EXISTS: ${{ vars.SERVICE_ACA_RESOURCE_EXISTS }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install azd
+        uses: Azure/setup-azd@v2.2.0
+
+      - name: Log in with Azure (Federated Credentials)
+        run: |
+          azd auth login `
+            --client-id "$Env:AZURE_CLIENT_ID" `
+            --federated-credential-provider "github" `
+            --tenant-id "$Env:AZURE_TENANT_ID"
+        shell: pwsh
+
+      # Workaround for https://github.com/Azure/azure-dev/issues/3920
+      - name: Create azd env
+        run: azd env new $AZURE_ENV_NAME
+        env:
+          AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+
+      - name: Prepackage Frontend
+        run: |
+          azd hooks run prepackage --no-prompt
+        env:
+          AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+
+      - name: Provision Infrastructure
+        run: |
+          azd provision --no-prompt
+        env:
+          AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+          AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
+          AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+
+      - name: Deploy Application
+        run: azd deploy --no-prompt
+        env:
+          AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+          AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
+          AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+
+      - name: Output Deployment URI
+        id: output
+        run: |
+          azd env get-values > .env
+          source .env
+          echo "uri=$SERVICE_ACA_URI" >> "$GITHUB_OUTPUT"
+
+
+  smoketests:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Set up Python (for Playwright test)
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      
+      - name: Install Playwright (Python) and Browsers
+        run: |
+          pip install --no-cache-dir playwright
+          python -m playwright install --with-deps chromium
+
+      - name: End-to-End UI Test (Playwright)
+        shell: bash
+        env:
+          URI: ${{needs.build.outputs.uri}}
+        run: |
+          python scripts/smoke_test.py "$URI"

.github/workflows/python.yaml

@@ -0,0 +1,45 @@
+name: Python check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test_package:
+    name: Test ${{ matrix.os }} Python ${{ matrix.python_version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        python_version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+        - uses: actions/checkout@v4
+        - name: Install uv
+          uses: astral-sh/setup-uv@v6
+          with:
+            enable-cache: true
+            version: "0.4.20"
+            cache-dependency-glob: "requirements**.txt"
+            python-version: ${{ matrix.python_version }}
+            activate-environment: true
+        - name: Setup node
+          uses: actions/setup-node@v4
+          with:
+            node-version: "22"
+        - name: Build frontend
+          run: |
+            cd ./app/frontend
+            npm install
+            npm run build
+        - name: Install dependencies
+          run: |
+            uv pip install -r requirements-dev.txt
+        - name: Lint with ruff
+          run: ruff check .
+        - name: Check formatting with ruff
+          run: ruff format --check .
+        - name: Run tests with pytest
+          run: pytest

app/backend/app.py

@@ -28,17 +28,23 @@
 mimetypes.add_type("application/javascript", ".js")
 mimetypes.add_type("text/css", ".css")
 
+
 @bp.route("/")
 async def index():
     return await bp.send_static_file("index.html")
 
+
 @bp.route("/favicon.ico")
 async def favicon():
     return await bp.send_static_file("favicon.ico")
 
+
 @bp.route("/assets/<path:path>")
 async def assets(path):
-    return await send_from_directory(Path(__file__).resolve().parent / "static" / "assets", path)
+    return await send_from_directory(
+        Path(__file__).resolve().parent / "static" / "assets", path
+    )
+
 
 @bp.route("/search", methods=["POST"])
 async def search():
@@ -52,40 +58,41 @@ async def search():
         search_text=None,
         top=size,
         vector_queries=[
-            VectorizableTextQuery(
-                k=size,
-                fields="embedding",
-                text=search_text
-            )
+            VectorizableTextQuery(k=size, fields="embedding", text=search_text)
         ],
-        select="metadata_storage_path"
+        select="metadata_storage_path",
     )
     response_results = []
     async for result in results:
-        response_results.append({
-            "score": result["@search.score"],
-            "url": result["metadata_storage_path"]
-        })
+        response_results.append(
+            {"score": result["@search.score"], "url": result["metadata_storage_path"]}
+        )
     return jsonify(response_results)
 
+
 @bp.before_app_serving
 def setup_clients():
     AZURE_SEARCH_SERVICE = os.environ["AZURE_SEARCH_SERVICE"]
     AZURE_SEARCH_INDEX = os.environ["AZURE_SEARCH_INDEX"]
     if os.getenv("RUNNING_IN_PRODUCTION"):
         credential = ManagedIdentityCredential(client_id=os.environ["AZURE_CLIENT_ID"])
     else:
-        credential = AzureDeveloperCliCredential(tenant_id=os.environ["AZURE_TENANT_ID"])
+        credential = AzureDeveloperCliCredential(
+            tenant_id=os.environ["AZURE_TENANT_ID"]
+        )
     search_client = SearchClient(
         endpoint=f"https://{AZURE_SEARCH_SERVICE}.search.windows.net",
         index_name=AZURE_SEARCH_INDEX,
-        credential=credential
+        credential=credential,
     )
     current_app.config[CONFIG_SEARCH_CLIENT] = search_client
 
+
 def load_azd_env():
     """Get path to current azd env file and load file using python-dotenv"""
-    result = subprocess.run("azd env list -o json", shell=True, capture_output=True, text=True)
+    result = subprocess.run(
+        "azd env list -o json", shell=True, capture_output=True, text=True
+    )
     if result.returncode != 0:
         raise Exception("Error loading azd env")
     env_json = json.loads(result.stdout)
@@ -98,6 +105,7 @@ def load_azd_env():
     logger.info(f"Loading azd env from {env_file_path}")
     load_dotenv(env_file_path, override=True)
 
+
 def create_app():
     app = Quart(__name__)
     app.register_blueprint(bp)
@@ -110,5 +118,5 @@ def create_app():
 
     if not os.getenv("RUNNING_IN_PRODUCTION"):
         load_azd_env()
-        
-    return app
+
+    return app

app/backend/gunicorn.conf.py

@@ -13,4 +13,4 @@
 workers = (num_cpus * 2) + 1
 worker_class = "uvicorn.workers.UvicornWorker"
 
-timeout = 120
+timeout = 120

app/backend/main.py

@@ -1,3 +1,3 @@
 from app import create_app
 
-app = create_app()
+app = create_app()

app/backend/requirements.txt

@@ -3,11 +3,14 @@ aiohttp==3.11.0b0
 azure-common==1.1.28
 azure-core==1.29.7
 azure-identity==1.16.1
+azure-mgmt-core==1.4.0
+azure-mgmt-web==7.2.0
+azure-mgmt-storage==21.2.1
 azure-search-documents==11.7.0b1
 azure-storage-blob==12.19.0
 blinker==1.7.0
 certifi==2024.7.4
-cffi==1.16.0
+cffi==2.0.0
 charset-normalizer==3.3.2
 click==8.1.7
 colorama==0.4.6
@@ -33,7 +36,7 @@ PyJWT==2.8.0
 Quart==0.20.0
 requests==2.32.4
 six==1.16.0
-typing_extensions==4.9.0
+typing_extensions>=4.12.2
 urllib3==2.5.0
 Werkzeug==3.0.6
 wsproto==1.2.0