Merge pull request #1501 from stankovski/clu

Added documentation for bash testing and created basic BASH test infrastructure

Author: markcowl

clu-getstart.md

@@ -78,3 +78,36 @@ To test on osx/linux boxes, do #1, open `<repo-root>\drop\clurun`, you should se
 
     ```set CmdletSessionId=1010 ```
 
+### Testing Cmdlets
+
+#### Environment setup (Windows)
+- Install latest version of [Git for Windows](https://git-scm.com/download/win) that has `bash 4.x` available.
+- Install `jq` using chocolatey `choco install jq` (chocolatey can be installed from [here](https://chocolatey.org/)).
+
+#### Test Infrastructure
+Testing will consist of scenario tests and unit tests. Scenario tests should be written in a form of an example and be available in `.ps1` and `.sh` formats.
+
+#### Scenario Tests
+- Scenario tests should be saved under `./examples` directory and grouped by the package or service area. Each scenario tests should consist of both `.ps1` and `.sh` files and should cover "P0" scenarios.
+
+##### Bash Tests
+- Bash tests should be runnable from bash shell in windows/linux/mac environments.
+- To manually run the tests; please set the following envt. variables for authentication and run `./examples/lib/testrunner.sh`
+   ```bash
+   export azureuser=<[email protected]>
+   export azurepassword=<your_password>
+   export PATH=$PATH:/<path-to-drop>/clurun/win7-x64/
+   . /examples/lib/testrunner.sh
+   ```
+- All the parameters to the cmdlets should be passed in as envt. variables
+- The current test runners will provide a unique resource group name via `$groupName` but may not remove it at the end if the test fails.
+- The location for ARM will be provided via variable `$location`.
+- "jq" package and BASH assert (e.g. `[ "foo" == "bar" ]`) should be used to validate the responses.
+
+##### PowerShell Tests
+TODO: Add section on PowerShell testing
+
+#### Unit Tests
+TODO: Add section on unit testing
+
+

examples/lib/helper.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 randomName() {
     echo "$1$RANDOM"
 }

examples/lib/setup.sh

@@ -1,6 +1,17 @@
 #!/bin/bash
-
 # Login
-echo "Executing Login..."
-export CmdletSessionId=1010
-azure account add --username $azureuser --password $azurepassword
+login() {
+    echo "Executing Login..."
+    export CmdletSessionId=1010
+    azure account add --username $azureuser --password $azurepassword
+}
+
+cleanup() {
+    set +e
+    printf "\nCleanup: removing resource group: %s\n" $groupName
+    azure group remove --name "$groupName" --force
+    set -e
+}
+
+export -f login 
+export -f cleanup 

examples/lib/testrunner.sh

@@ -1,12 +1,18 @@
 #!/bin/bash
-. setup.sh
-. helper.sh
-export resourceGroupName=`randomName testrg`
-export resourceGroupLocation="westus"
+export BASEDIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+. $BASEDIR/assert.sh
+. $BASEDIR/helper.sh
+. $BASEDIR/setup.sh
+export groupName=`randomName testrg`
+export location="westus"
 
-for d in $( ls .. --ignore=lib ); do
-    for f in $( ls ../$d/*.sh ); do
+login
+
+for d in $( ls $BASEDIR/.. --ignore=lib ); do
+    for f in $( ls $BASEDIR/../$d/*.sh ); do
         echo "running: $f"
         . $f
+        cleanup
+        echo "success: $f"
     done
 done

examples/resource-management/01-ResourceGroups.sh

@@ -1,19 +1,21 @@
 #!/bin/bash
-
+set -e
 printf "\n=== Managing Resource Groups in Azure ===\n"
 
-printf "\n1. Creating a new resource group: %s and location: %s.\n" "$resourceGroupName" "$resourceGroupLocation"
-azure resource group new --name "$resourceGroupName" --location "$resourceGroupLocation"
+printf "\n1. Creating a new resource group: %s and location: %s.\n" "$groupName" "$location"
+azure group create --name "$groupName" --location "$location"
+
+printf "\n2. Updating the group %s with tags.\n" "$groupName"
+azure group set --name "$groupName" --tags "[{\"Value\":\"testval\",\"Name\":\"testtag\"}]"
 
-printf "\n2. Updating the group %s with tags.\n" "$resourceGroupName"
-azure resource group set --name "$resourceGroupName" --tags "[{\"Value\":\"testval\",\"Name\":\"testtag\"}]"
+printf "\n3. Get information about resource group : %s.\n" "$groupName"
+resourceGroupInfo=`azure group get --name $groupName`
 
-printf "\n3. Get information about resource group : %s.\n" "$resourceGroupName"
-resourceGroupInfo=`azure resource group get --name $resourceGroupName`
-printf "\nThe resource group info is: \n %s\n" "$resourceGroupInfo"
+printf "\nValidating resource group name is: %s\n" "$groupName"
+[ $(echo $resourceGroupInfo | jq '.ResourceGroupName' --raw-output) == "$groupName" ]
 
 printf "\n4. Listing all resource groups in the subscription.\n"
-azure resource group get
+azure group get
 
-printf "\n5. Removing resource group: %s.\n" "$resourceGroupName"
-azure resource group remove --name "$resourceGroupName" --force
+printf "\n5. Removing resource group: %s.\n" "$groupName"
+azure group remove --name "$groupName" --force

tools/CLU/BuildAndInstallClu.bat

@@ -33,4 +33,6 @@ copy /Y %~dp0\azure.sh %root%\drop\clurun\osx.10.10-x64
 xcopy %root%\drop\clurun\win7-x64\pkgs %root%\drop\clurun\ubuntu.14.04-x64\pkgs /S /Q /I /Y
 copy /Y %root%\drop\clurun\win7-x64\azure.lx %root%\drop\clurun\ubuntu.14.04-x64
 copy /Y %root%\drop\clurun\win7-x64\msclu.cfg %root%\drop\clurun\ubuntu.14.04-x64
-copy /Y %~dp0\azure.sh %root%\drop\clurun\ubuntu.14.04-x64
+copy /Y %~dp0\azure.sh %root%\drop\clurun\ubuntu.14.04-x64
+
+copy /Y %~dp0\azure %root%\drop\clurun\win7-x64

tools/CLU/azure

@@ -0,0 +1,4 @@
+#!/bin/bash
+BASEDIR=$(dirname $0)
+
+clurun.exe -s azure -r $BASEDIR/azure.lx $*