Merge pull request #208 from CatalystCode/enhancement/azure-pipelines

Enhancement/Integrate with Azure Pipelines

.gitignore

@@ -74,6 +74,7 @@ nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
+junitxml/
 
 # Translations
 *.mo

app/app/settings.py

@@ -185,6 +185,8 @@ USE_L10N = True
 
 USE_TZ = True
 
+TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
+TEST_OUTPUT_DIR = path.join(BASE_DIR, 'junitxml')
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/2.0/howto/static-files/

azure-pipelines.yaml

@@ -0,0 +1,54 @@
+trigger:
+- master
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- script: docker build --tag=doccano --target=builder .
+  displayName: 'Run tests'
+
+- script: docker run doccano tar Ccf /doccano/app - junitxml | tar Cxf "$(Build.ArtifactStagingDirectory)" -
+  displayName: 'Export test results'
+
+- task: PublishTestResults@2
+  inputs:
+    testResultsFormat: 'JUnit'
+    testResultsFiles: 'TEST-*.xml'
+    searchFolder: '$(Build.ArtifactStagingDirectory)/junitxml'
+    mergeTestResults: true
+    testRunTitle: 'server.tests'
+  displayName: 'Publish test results'
+
+# To publish docker images to a container registry, set the following pipeline variables:
+# - docker_password
+# - docker_username
+# - docker_registry (optional, set this to publish to a registry other than Docker Hub)
+#
+- script: DOCKER_PASSWORD="$(docker_password)" tools/cd.sh "azdo-$(Build.BuildId)"
+  displayName: 'Push docker image'
+  condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['docker_password'], ''))
+
+# To automatically deploy to Azure, create a service principal and set the following pipeline variables:
+# - auth_username (app ID)
+# - auth_tenant (tenant ID
+# - auth_password (secret)
+#
+# Additionally, to configure the deployment, set the following pipeline variables:
+# - doccano_admin_username
+# - doccano_admin_password
+# - doccano_admin_contact_email
+# - doccano_app_name (globally unique name for the app)
+# - doccano_secret_key (pass-through secret for Django)
+# - doccano_resource_group (group for all resources, will be created if it doesn't yet exist)
+# - doccano_location (name of the Azure region to which to deploy all resources)
+#
+- script: |
+    az login --service-principal --password "$(auth_password)" --tenant "$(auth_tenant)" --username "$(auth_username)"
+
+    DOCCANO_ADMIN_PASSWORD="$(doccano_admin_password)" \
+    DOCCANO_SECRET_KEY="$(doccano_secret_key)" \
+    DOCKER_PASSWORD="$(docker_password)" \
+    tools/azure.sh "azdo-$(Build.BuildId)"
+  displayName: 'Deploy to Azure'
+  condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['auth_password'], ''))

azuredeploy.json

@@ -90,6 +90,27 @@
       "metadata": {
         "description": "The Docker image to deploy."
       }
+    },
+    "dockerRegistry": {
+      "type": "string",
+      "defaultValue": "",
+      "metadata": {
+        "description": "The registry of the Docker image."
+      }
+    },
+    "dockerRegistryUserName": {
+      "type": "string",
+      "defaultValue": "",
+      "metadata": {
+        "description": "The user name for the Docker registry."
+      }
+    },
+    "dockerRegistryPassword": {
+      "type": "securestring",
+      "defaultValue": "",
+      "metadata": {
+        "description": "The password for the Docker registry."
+      }
     }
   },
   "variables": {
@@ -105,8 +126,13 @@
     "databaseConnectionString": "[concat('pgsql://', variables('databaseUserCredentials'), '@', variables('databaseFqdn'), '/', parameters('databaseName'))]",
     "setupScriptName": "[concat(parameters('appName'),'-setup')]",
     "appServicePlanName": "[concat(parameters('appName'),'-hosting')]",
-    "appFqdn": "[concat(parameters('appName'),'.azurewebsites.net')]",
-    "analyticsName": "[concat(parameters('appName'),'-analytics')]"
+    "analyticsName": "[concat(parameters('appName'),'-analytics')]",
+    "dockerRegistryCredential": {
+      "password": "[parameters('dockerRegistryPassword')]",
+      "username": "[parameters('dockerRegistryUserName')]",
+      "server": "[parameters('dockerRegistry')]"
+    },
+    "appFqdn": "[concat(parameters('appName'),'.azurewebsites.net')]"
   },
   "resources": [
     {
@@ -186,6 +212,7 @@
       "apiVersion": "2018-10-01",
       "location": "[variables('location')]",
       "properties": {
+        "imageRegistryCredentials": "[if(equals(parameters('dockerRegistry'), ''), json('null'), array(variables('dockerRegistryCredential')))]",
         "containers": [
           {
             "name": "createadmin",
@@ -248,6 +275,18 @@
               "name": "WEBSITES_ENABLE_APP_SERVICE_STORAGE",
               "value": "false"
             },
+            {
+              "name": "DOCKER_REGISTRY_SERVER_URL",
+              "value": "[parameters('dockerRegistry')]"
+            },
+            {
+              "name": "DOCKER_REGISTRY_SERVER_USERNAME",
+              "value": "[parameters('dockerRegistryUserName')]"
+            },
+            {
+              "name": "DOCKER_REGISTRY_SERVER_PASSWORD",
+              "value": "[parameters('dockerRegistryPassword')]"
+            },
             {
               "name": "AZURE_APPINSIGHTS_IKEY",
               "value": "[reference(resourceId('Microsoft.Insights/components', variables('analyticsName')), '2014-04-01').InstrumentationKey]"

requirements.txt

@@ -27,4 +27,5 @@ social-auth-app-django==3.1.0
 social-auth-core[azuread]==3.0.0
 text-unidecode==1.2
 tornado==5.0.2
+unittest-xml-reporting==2.5.1
 whitenoise[brotli]==4.1.2

tools/azure.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -o errexit
+
+if [[ -z "${DOCCANO_LOCATION}" ]]; then echo "Missing DOCCANO_LOCATION environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_RESOURCE_GROUP}" ]]; then echo "Missing DOCCANO_LOCATION environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_APP_NAME}" ]]; then echo "Missing DOCCANO_APP_NAME environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_SECRET_KEY}" ]]; then echo "Missing DOCCANO_SECRET_KEY environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_ADMIN_USERNAME}" ]]; then echo "Missing DOCCANO_ADMIN_USERNAME environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_ADMIN_CONTACT_EMAIL}" ]]; then echo "Missing DOCCANO_ADMIN_CONTACT_EMAIL environment variable" >&2; exit 1; fi
+if [[ -z "${DOCCANO_ADMIN_PASSWORD}" ]]; then echo "Missing DOCCANO_ADMIN_PASSWORD environment variable" >&2; exit 1; fi
+if ! az account show >/dev/null; then echo "Must be logged into Azure" >&2; exit 2; fi
+
+az group create \
+  --location "${DOCCANO_LOCATION}" \
+  --name "${DOCCANO_RESOURCE_GROUP}"
+
+az group deployment create \
+  --resource-group "${DOCCANO_RESOURCE_GROUP}" \
+  --name "azuredeploy$1" \
+  --parameters \
+      appName="${DOCCANO_APP_NAME}" \
+      secretKey="${DOCCANO_SECRET_KEY}" \
+      adminUserName="${DOCCANO_ADMIN_USERNAME}" \
+      adminContactEmail="${DOCCANO_ADMIN_CONTACT_EMAIL}" \
+      adminPassword="${DOCCANO_ADMIN_PASSWORD}" \
+      dockerImageName="${DOCKER_REGISTRY:-${DOCKER_USERNAME:-chakkiworks}}/doccano:${1:-latest}" \
+      dockerRegistry="${DOCKER_REGISTRY}" \
+      dockerRegistryUserName="${DOCKER_USERNAME}" \
+      dockerRegistryPassword="${DOCKER_PASSWORD}" \
+  --template-file azuredeploy.json

tools/cd.sh

@@ -6,10 +6,15 @@ if [[ -z "$1" ]]; then echo "Usage: $0 <tag>" >&2; exit 1; fi
 
 set -o errexit
 
+if [[ -z "${DOCKER_REGISTRY}" ]]; then
+  echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
+else
+  echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin "${DOCKER_REGISTRY}"
+  DOCKER_USERNAME="${DOCKER_REGISTRY}"
+fi
+
 docker build -t "${DOCKER_USERNAME}/doccano:latest" .
 docker build -t "${DOCKER_USERNAME}/doccano:$1" .
 
-echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
-
 docker push "${DOCKER_USERNAME}/doccano:latest"
 docker push "${DOCKER_USERNAME}/doccano:$1"