Automating azd pipeline config tests

eng/pipelines/templates/steps/template-test-run-job.yml

@@ -47,6 +47,10 @@ steps:
           Write-Host "SynchronousCleanup: $SynchronousCleanup"
           Write-Host "##vso[task.setvariable variable=SynchronousCleanup]$SynchronousCleanup"
 
+          $randomNum = Get-Random
+          $EnvName = "env-name-$randomNum"
+          Write-Host "##vso[task.setvariable variable=EnvName]$EnvName"
+
           $CleanupImmediate = 'true'
           if ('$(CleanupHoursDelay)' -ne '0') {
             $CleanupImmediate = 'false'
@@ -66,6 +70,88 @@ steps:
           TargetFolder: "$(Build.SourcesDirectory)/temp"
       displayName: Copy test-templates.sh
 
+    - task: Bash@3
+      displayName: Azd Init
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/azd-init.sh
+        arguments: >
+          -s '$(SubscriptionId)'
+          -t '$(TemplateName)'
+          -e '$(EnvName)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Azd Pipeline Config Provider Github
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/azd-pipeline-config-provider-github.sh
+        arguments: >
+          -e '$(EnvName)'
+          -t '$(TemplateName)'
+          -p '$(azuresdk-github-pat)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Tracking Github Child Pipeline
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/tracking-github-child-pipeline.sh
+        arguments: >
+          -e '$(EnvName)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Azd Pipeline Config Provider Azdo
+      env:
+        AZURE_DEVOPS_EXT_PAT: $(AZURE_DEVOPS_EXT_PAT)
+        AZURE_DEVOPS_ORG_NAME: $(AZURE_DEVOPS_ORG_NAME)
+        SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+        GIT_TERMINAL_PROMPT: 1
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/azd-pipeline-config-provider-azdo.sh
+        arguments: >
+          -p '$(AZURE_DEVOPS_EXT_PAT)'
+          -o '$(AZURE_DEVOPS_ORG_NAME)'
+          -t '$(TemplateName)'
+          -e '$(EnvName)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Tracking Azdo Child Pipeline
+      env:
+        AZURE_DEVOPS_EXT_PAT: $(AZURE_DEVOPS_EXT_PAT)
+        AZURE_DEVOPS_ORG_NAME: $(AZURE_DEVOPS_ORG_NAME)
+        SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+        GIT_TERMINAL_PROMPT: 1
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/tracking-azdo-child-pipeline.sh
+        arguments: >
+          -e '$(EnvName)'
+          -p '$(AZURE_DEVOPS_EXT_PAT)'
+          -o '$(AZURE_DEVOPS_ORG_NAME)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Azd Provision
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/azd-provision.sh
+        arguments: >
+          -e '$(EnvName)'
+        workingDirectory: templates/tests
+
+    - task: Bash@3
+      displayName: Cleanup Resource
+      inputs:
+        targetType: filePath
+        filePath: templates/tests/cleanupResource.sh
+        arguments: >
+          -e '$(EnvName)'
+        workingDirectory: templates/tests
+
     - task: DevcontainersCI@0
       inputs:
           env: |

templates/tests/azd-init.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Default to user HOME directory if not specified
+FOLDER_PATH=$HOME
+SUBSCRIPTION=""
+TEMPLATE_NAME=""
+ENV_NAME=""
+
+function usage {
+    echo "Tests azd template init, provision & deploy"
+    echo ""
+    echo "Usage: test-templates -t <template> -b <branch> -s <subscription_id> -u <env_prefix>" 2>&1
+    echo ""
+    echo "  -s    Sets the subscription"
+    echo "  -t    Sets template name"
+    echo ""
+
+    exit 1
+}
+
+while getopts "s:t:e:h" arg; do
+    case ${arg} in
+    s) SUBSCRIPTION=$OPTARG ;;
+    t) TEMPLATE_NAME=$OPTARG ;;
+    e) ENV_NAME=$OPTARG ;;
+    h)
+        usage
+        ;;
+    :)
+        echo "$0: Must supply an argument to -$arg." >&2
+        exit 1
+        ;;
+    ?)
+        echo "Invalid option -$arg."
+        exit 2
+        ;;
+    *) usage ;;
+    esac
+done
+
+function initTemplate {
+    echo "Creating new project folder ..."
+    cd "$FOLDER_PATH"
+    mkdir "$1"
+    cd "$1"
+
+    echo "Initializing template with branch staging"
+    azd init -t "$3" -b "staging" -e "$1" --subscription "$2" --location "eastus2" --no-prompt
+
+    echo "Initializing template successfully"
+}
+
+initTemplate "$ENV_NAME" "$SUBSCRIPTION" "$TEMPLATE_NAME"

templates/tests/azd-pipeline-config-provider-azdo.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Default to user HOME directory if not specified
+FOLDER_PATH=$HOME
+TEMPLATE_NAME=""
+ENV_NAME=""
+
+function usage {
+    echo "Tests azd template init, provision & deploy"
+    echo ""
+    echo "Usage: test-templates -t <template> -b <branch> -s <subscription_id> -u <env_prefix>" 2>&1
+    echo ""
+    echo "  -o    Sets the organization name"
+    echo "  -p    Sets the personal access token"
+    echo "  -t    Sets the template name"
+    echo "  -e    Sets the env name"
+    echo ""
+
+    exit 1
+}
+
+while getopts "p:o:t:e:h" arg; do
+    case ${arg} in
+    p) AZURE_DEVOPS_EXT_PAT=$OPTARG ;;
+    o) AZURE_DEVOPS_ORG_NAME=$OPTARG ;;
+    t) TEMPLATE_NAME=$OPTARG ;;
+    e) ENV_NAME=$OPTARG ;;
+    h)
+        usage
+        ;;
+    :)
+        echo "$0: Must supply an argument to -$arg." >&2
+        exit 1
+        ;;
+    ?)
+        echo "Invalid option -$arg."
+        exit 2
+        ;;
+    *) usage ;;
+    esac
+done
+
+function configAzdo {
+    echo "Cd into the project folder ..."
+    cd "$FOLDER_PATH"
+    cd "$1"
+
+    # If there is a .git folder here, delete it.
+    if [ -d ".git" ]; then
+        rm -rf .git
+    fi
+
+    # Set git credential
+    echo "https://${AZURE_DEVOPS_ORG_NAME}:${AZURE_DEVOPS_EXT_PAT}@dev.azure.com" > ~/.git-credentials
+    git config --global credential.helper store
+
+    echo "Set git credential successfully"
+
+    # Azd pipeline config steps:
+    echo "Azd pipeline config --provider azdo for $2..."
+    azd pipeline config --provider azdo --no-prompt
+    if [[ $? -ne 0 ]];then
+        echo "Some error message..."
+        exit 1
+    fi
+
+    echo "Pipeline is being prepared"
+    sleep 20
+}
+
+configAzdo "$ENV_NAME" "$TEMPLATE_NAME"

templates/tests/azd-pipeline-config-provider-github.sh

@@ -0,0 +1,69 @@
+#!/bin/bash
+
+# Default to user HOME directory if not specified
+ENV_NAME=""
+FOLDER_PATH=$HOME
+GITHUB_PAT=""
+TEMPLATE_NAME=""
+
+function usage {
+    echo "Tests azd template init, provision & deploy"
+    echo ""
+    echo "Usage: test-templates -t <template> -b <branch> -s <subscription_id> -u <env_prefix>" 2>&1
+    echo ""
+    echo "  -e    Sets the env name"
+    echo "  -t    Sets the template name"
+    echo "  -p    Sets the github-pat"
+    echo ""
+
+    exit 1
+}
+
+while getopts "e:t:p:h" arg; do
+    case ${arg} in
+    e) ENV_NAME=$OPTARG ;;
+    t) TEMPLATE_NAME=$OPTARG ;;
+    p) GITHUB_PAT=$OPTARG ;;
+    h)
+        usage
+        ;;
+    :)
+        echo "$0: Must supply an argument to -$arg." >&2
+        exit 1
+        ;;
+    ?)
+        echo "Invalid option -$arg."
+        exit 2
+        ;;
+    *) usage ;;
+    esac
+done
+
+function configGithub {
+    echo "cd into the project folder ..."
+    cd "$FOLDER_PATH"
+    cd "$1"
+
+    # If there is a .git folder here, delete it.
+    if [ -d ".git" ]; then
+        rm -rf .git
+    fi
+
+    # github auth login
+    echo "$3" > my-token.txt
+    gh auth login --with-token < my-token.txt
+    rm -rf my-token.txt
+
+    # Azd pipeline config steps:
+    echo "Azd pipeline config for $2..."
+    azd pipeline config --no-prompt
+    if [[ $? -ne 0 ]];then
+        echo "Some error message..."
+        exit 1
+    fi
+
+    echo "Pipeline is being prepared"
+    sleep 10
+}
+
+configGithub "$ENV_NAME" "$TEMPLATE_NAME" "${GITHUB_PAT}"

templates/tests/azd-provision.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+# Default to user HOME directory if not specified
+FOLDER_PATH=$HOME
+ENV_NAME=""
+
+function usage {
+    echo "Tests azd template init, provision & deploy"
+    echo ""
+    echo "Usage: test-templates -t <template> -b <branch> -s <subscription_id> -u <env_prefix>" 2>&1
+    echo ""
+    echo "  -e    Sets the env name"
+    echo ""
+
+    exit 1
+}
+
+while getopts "e:h" arg; do
+    case ${arg} in
+    e) ENV_NAME=$OPTARG ;;
+    h)
+        usage
+        ;;
+    :)
+        echo "$0: Must supply an argument to -$arg." >&2
+        exit 1
+        ;;
+    ?)
+        echo "Invalid option -$arg."
+        exit 2
+        ;;
+    *) usage ;;
+    esac
+done
+
+function provision {
+    cd "$FOLDER_PATH/$1"
+    echo "Sync environment for $1..."
+    azd provision -e "$1"
+}
+
+provision "$ENV_NAME"

templates/tests/cleanupResource.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# Default to user HOME directory if not specified
+FOLDER_PATH=$HOME
+ENV_NAME=""
+
+function usage {
+    echo "Tests azd template init, provision & deploy"
+    echo ""
+    echo "Usage: test-templates -t <template> -b <branch> -s <subscription_id> -u <env_prefix>" 2>&1
+    echo ""
+    echo "  -e    Sets the env name"
+    echo ""
+
+    exit 1
+}
+
+while getopts "e:h" arg; do
+    case ${arg} in
+    e) ENV_NAME=$OPTARG ;;
+    h)
+        usage
+        ;;
+    :)
+        echo "$0: Must supply an argument to -$arg." >&2
+        exit 1
+        ;;
+    ?)
+        echo "Invalid option -$arg."
+        exit 2
+        ;;
+    *) usage ;;
+    esac
+done
+
+function cleanupResource {
+    cd "$FOLDER_PATH/$1"
+
+    echo "Deprovisioning infrastructure for $1..."
+    azd down -e "$1" --force --purge
+}
+
+cleanupResource "$ENV_NAME"