Start/stop integration test server on-demand

.github/workflows/ci_cd.yml

@@ -1,16 +1,47 @@
 name: Pre-merge checks
 
-# run only on main branch.  This avoids duplicated actions on PRs
+# Run only on main branch. This avoids duplicated actions on PRs
 on:
   pull_request:
   push:
     tags:
-      - "*"
+      - '*'
     branches:
       - main
   workflow_dispatch:
 
 jobs:
+  start_vm:
+    name: Start Azure VM
+    runs-on: ubuntu-latest
+    if: ${{ !contains( github.event.pull_request.labels.*.name, 'dependencies') }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Start VM with Azure CLI
+        id: azure_cli
+        uses: azure/CLI@v1
+        with:
+          azcliversion: 2.32.0
+          inlineScript: |
+            az login --service-principal -u ${{ secrets.AZURE_APP_ID }} -p ${{ secrets.AZURE_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+            az vm start -g ${{ secrets.AZURE_RESOURCE_GROUP }} -n ${{ secrets.AZURE_VM_NAME }}
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+
+      - name: Check server is ready
+        run: |
+          pip install requests
+          python cicd/check_server.py
+        env:
+          TEST_SL_URL: ${{secrets.TEST_SERVER_URL}}
+          TEST_USER: ${{secrets.TEST_SERVER_READ_USER}}
+          TEST_PASS: ${{secrets.TEST_SERVER_READ_PASS}}
+
   style:
     name: Style check
     runs-on: ubuntu-latest
@@ -21,7 +52,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.10"
+          python-version: '3.10'
 
       - name: Create local deps folder
         run: mkdir -p deps
@@ -121,8 +152,7 @@ jobs:
   integration_tests:
     name: Integration tests
     runs-on: ${{ matrix.os }}
-    needs: [style, unit_tests]
-    if: ${{ !contains( github.event.pull_request.labels.*.name, 'dependencies') }}
+    needs: [style, unit_tests, start_vm]
 
     strategy:
       max-parallel: 1
@@ -136,10 +166,10 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: sudo apt install libkrb5-dev
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: '3.8'
+          python-version: '3.10'
 
       - name: Create local deps folder
         run: mkdir -p deps
@@ -188,7 +218,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup Python
+      - name: Setup Python 3.10
         uses: actions/setup-python@v2
         with:
           python-version: '3.10'
@@ -228,7 +258,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup Python
+      - name: Setup Python 3.10
         uses: actions/setup-python@v2
         with:
           python-version: '3.10'
@@ -303,12 +333,27 @@ jobs:
           path: doc/build/latex/*.pdf
           retention-days: 7
 
+  stop_vm:
+      name: Stop Azure VM
+      runs-on: ubuntu-latest
+      needs: [docs, start_vm]
+      if: always() && needs.start_vm.result != 'skipped'
+
+      steps:
+        - name: Stop Azure VM
+          uses: azure/CLI@v1
+          with:
+            azcliversion: 2.32.0
+            inlineScript: |
+              az login --service-principal -u ${{ secrets.AZURE_APP_ID }} -p ${{ secrets.AZURE_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
+              az vm deallocate -g ${{ secrets.AZURE_RESOURCE_GROUP }} -n ${{ secrets.AZURE_VM_NAME }} --no-wait
+
   Release:
     if: contains(github.ref, 'refs/tags') && github.event_name == 'push'
     needs: [package, integration_tests, docs]
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Python
+      - name: Set up Python 3.10
         uses: actions/setup-python@v1
         with:
           python-version: '3.10'

cicd/check_server.py

@@ -0,0 +1,56 @@
+import requests
+from requests.auth import HTTPBasicAuth
+import os
+import json
+import time
+from functools import wraps
+import logging
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger()
+
+MAX_ATTEMPTS = 30
+WAIT_TIME = 5
+
+
+def block_until_server_is_ok(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        check_count = 1
+        while True:
+            logger.info(f"Check {check_count}")
+            if func(*args, **kwargs):
+                logger.info(f"Server ready!")
+                break
+            check_count = check_count + 1
+            if check_count == MAX_ATTEMPTS:
+                logger.info(f"Failed after 30 attempts. Quitting...")
+                raise ConnectionError
+            logger.info(f"Check {check_count} failed. Waiting 5 seconds...")
+            time.sleep(WAIT_TIME)
+    return wrapper
+
+
+@block_until_server_is_ok
+def check_status(url: str, auth_header: HTTPBasicAuth) -> bool:
+    try:
+        response = requests.get(url + "/Health/v2.svc/", auth=auth_header)
+    except requests.exceptions.RequestException:
+        return False
+    if response.status_code != 200:
+        return False
+    content = json.loads(response.content)
+    for check in content['HealthChecks']:
+        if check['Name'] == 'Database Check' and check['Status'] == 'Ok':
+            return True
+    return False
+
+
+if __name__ == "__main__":
+    sl_url = os.getenv("TEST_SL_URL")
+    username = os.getenv("TEST_USER")
+    password = os.getenv("TEST_PASS")
+
+    logger.info(f"Checking if Granta MI server is ready for requests")
+    auth = HTTPBasicAuth(username, password)
+    check_status(sl_url, auth)