Implemented CI/CD pipeline for automatically deploying our Function App to Azure

Author: hvalfangst

.github/workflows/deploy_to_azure.yml

@@ -0,0 +1,69 @@
+name: CI/CD
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+env:
+  AZURE_FUNCTIONAPP_PACKAGE_PATH: '.'
+  PYTHON_VERSION: '3.10'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python version
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Create and start virtual environment
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Zip artifact for deployment
+        run: cd hvalfangst_function && zip -r ../release.zip ./
+
+      - name: Upload artifact for deployment job
+        uses: actions/upload-artifact@v3
+        with:
+          name: hvalfangst-function-app
+          path: |
+            release.zip
+            !venv/
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: 'Production'
+      url: ${{ steps.deploy-to-function.outputs.webapp-url }}
+
+    steps:
+      - name: Download artifact from build job
+        uses: actions/download-artifact@v3
+        with:
+          name: hvalfangst-function-app
+
+      - name: Unzip artifact for deployment
+        run: unzip release.zip
+
+      - name: 'Deploy to Azure Functions'
+        uses: Azure/functions-action@v1
+        id: deploy-to-function
+        with:
+          app-name: 'hvalfangstlinuxfunctionapp'
+          slot-name: 'Production'
+          package: ${{ env.AZURE_FUNCTIONAPP_PACKAGE_PATH }}
+          scm-do-build-during-deployment: true
+          enable-oryx-build: true
+          publish-profile: ${{ secrets.PUBLISH_PROFILE }}

README.md

@@ -49,4 +49,16 @@ APP_INSIGHTS_NAME=hvalfangstappinsights
 
 ## Deallocate resources
 
-The shell script [deallocate_resources](infra/deallocate_resources.sh) deletes our Azure service bus queue, namespace and resource group.
+The shell script [deallocate_resources](infra/deallocate_resources.sh) deletes our Azure service bus queue, namespace and resource group.
+
+# CI/CD
+
+A CI/CD pipeline for deploying our [Function App](hvalfangst_function/function_app.py) to Azure has been set up using a GitHub Actions workflows [script](.github/workflows/deploy_to_azure.yml). The pipeline is either triggered by a push to the main branch or by manually running the workflow. 
+In order for the pipeline to work, the following secrets must be set in the repository settings:
+
+![img.png](img.png)
+
+The associated values of the aforementioned secret can be retrieved from the Azure portal, under our deployed Function App.
+Click on the **Get publish profile** button and copy/paste the file content into the secret value field.
+
+![img_1.png](img_1.png)

hvalfangst_function/function_app.py

@@ -0,0 +1,69 @@
+import logging
+import json
+import pandas as pd
+import azure.functions as func
+from io import StringIO
+from sklearn.preprocessing import LabelEncoder
+
+# Decree and declare our project as an Azure Function App subsidiary
+app = func.FunctionApp()
+
+# Configure logging
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+
+@app.blob_trigger(arg_name="inbound", path="hvalfangstcontainer/in/input.csv", connection="")
+@app.blob_output(arg_name="outbound", path="hvalfangstcontainer/out/statistics.json", connection="")
+def blob_trigger(inbound: func.InputStream, outbound: func.Out[str]):
+    try:
+        # Read CSV content from the blob
+        csv_content = inbound.read().decode("utf-8")
+
+        # Convert CSV content to a pandas DataFrame
+        df = pd.read_csv(StringIO(csv_content))
+
+        # Label encode 'Gender' and 'State' columns
+        label_encoder = LabelEncoder()
+        df['Gender'] = label_encoder.fit_transform(df['Gender'])
+        df['State'] = label_encoder.fit_transform(df['State'])
+
+        # Calculate correlations
+        gender_to_income_corr = df[['Gender', 'Income']].corr().iloc[0, 1]
+        experience_to_income_corr = df[['Experience', 'Income']].corr().iloc[0, 1]
+        state_to_income_corr = df[['State', 'Income']].corr().iloc[0, 1]
+
+        # Create statistics dictionary
+        statistics = {
+            "gender_to_income_corr": gender_to_income_corr,
+            "experience_to_income_corr": experience_to_income_corr,
+            "state_to_income_corr": state_to_income_corr
+        }
+
+        # Convert statistics to JSON format
+        statistics_json = json.dumps(statistics, indent=2)
+
+        # Upload statistics JSON file to storage account container blob
+        outbound.set(statistics_json)
+        logging.info("- - - - - |File 'statistics.json' was uploaded| - - - - - ")
+
+    except Exception as e:
+        logging.error(f"An error occurred: {str(e)}")
+        return f"Error: {str(e)}"
+
+
+@app.route(route="upload_csv", auth_level=func.AuthLevel.ANONYMOUS)
+@app.blob_output(arg_name="outbound", path="hvalfangstcontainer/in/input.csv", connection="")
+def upload_csv(req: func.HttpRequest, outbound: func.Out[str]) -> str:
+    try:
+        # Parse raw bytes derived from request body to string
+        string_body = req.get_body().decode("utf-8")
+
+        # Upload parsed string body, which conforms to CSV format
+        outbound.set(string_body)
+        logging.info("- - - - -  |Successfully uploaded CSV content| - - - - - ")
+        return "Successfully uploaded CSV content"
+
+    except Exception as e:
+        logging.error(f"An error occurred: {str(e)}")
+        return f"Error: {str(e)}"

hvalfangst_function/host.json

@@ -0,0 +1,15 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[3.*, 4.0.0)"
+  }
+}

hvalfangst_function/local.settings.json

@@ -0,0 +1,8 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "FUNCTIONS_WORKER_RUNTIME": "python",
+    "AzureWebJobsFeatureFlags": "EnableWorkerIndexing",
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true"
+  }
+}

hvalfangst_function/reqiurements.txt

@@ -0,0 +1,3 @@
+azure-functions==1.7.0
+pandas~=2.1.4
+scikit-learn~=1.3.2