Merge pull request #94 from huangpf/clu

Clu

Author: huangpf

build.proj

@@ -317,7 +317,7 @@
     <Message Importance="high" Text="Running check in tests..." />
     <ItemGroup>
       <!--Exclude 1 test projects still in progress with build failures-->
-      <_CLUTestProjects Include="$(CLURootDir)\*.Test\project.json">
+      <_CLUTestProjects Include="$(CLURootDir)\*.Test\project.json" Exclude="$(CLURootDir)\Microsoft.CLU.Test\project.json">
       </_CLUTestProjects>
     </ItemGroup>
     <Exec Command="dnu build" WorkingDirectory="%(_CLUTestProjects.RootDir)%(_CLUTestProjects.Directory)" />

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

src/CLU/CLUCoreCLR.sln

@@ -37,6 +37,8 @@ Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.CLU.Run", "Micros
 EndProject
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.CLU", "Microsoft.CLU\Microsoft.CLU.xproj", "{D0A59671-088D-463B-B060-2ADAFFB9C3F6}"
 EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.CLU.Test", "Microsoft.CLU.Test\Microsoft.CLU.Test.xproj", "{91422B55-28A5-48DE-BCA0-30C3E30FFB1C}"
+EndProject
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.Azure.Commands.Compute", "Microsoft.Azure.Commands.Compute\Microsoft.Azure.Commands.Compute.xproj", "{04F9968A-5662-4508-BEE2-31F56848FCBA}"
 	ProjectSection(ProjectDependencies) = postProject
 		{99B1290D-A073-4907-8018-51C714431778} = {99B1290D-A073-4907-8018-51C714431778}
@@ -127,6 +129,10 @@ Global
 		{D0A59671-088D-463B-B060-2ADAFFB9C3F6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D0A59671-088D-463B-B060-2ADAFFB9C3F6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D0A59671-088D-463B-B060-2ADAFFB9C3F6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{91422B55-28A5-48DE-BCA0-30C3E30FFB1C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91422B55-28A5-48DE-BCA0-30C3E30FFB1C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{91422B55-28A5-48DE-BCA0-30C3E30FFB1C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{91422B55-28A5-48DE-BCA0-30C3E30FFB1C}.Release|Any CPU.Build.0 = Release|Any CPU
 		{04F9968A-5662-4508-BEE2-31F56848FCBA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{04F9968A-5662-4508-BEE2-31F56848FCBA}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{04F9968A-5662-4508-BEE2-31F56848FCBA}.Release|Any CPU.ActiveCfg = Release|Any CPU

src/CLU/Commands.Common.Authentication/Authentication/AdalTokenProvider.cs

@@ -12,9 +12,9 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using Microsoft.Azure.Commands.Common.Authentication.Models;
 using System;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {

src/CLU/Commands.Common.Authentication/Authentication/ServicePrincipalTokenProvider.cs

@@ -12,14 +12,11 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using Microsoft.Azure.Commands.Common.Authentication.Models;
 using Microsoft.IdentityModel.Clients.ActiveDirectory;
 using Microsoft.Rest;
 using System;
-using System.Collections.Generic;
-using System.Security;
-using System.Security.Cryptography.X509Certificates;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {

src/CLU/Commands.Common.Authentication/Authentication/UserTokenProvider.cs

@@ -17,9 +17,9 @@
 using Microsoft.Rest;
 using System;
 using System.Runtime.InteropServices;
-using Commands.Common.Authentication.Properties;
 using Microsoft.Rest.Azure.Authentication;
 using System.Management.Automation;
+using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {

src/CLU/Commands.Common.Authentication/AuthenticationFactory.cs

@@ -1,4 +1,4 @@
-// ----------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------------
 //
 // Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,11 +16,10 @@
 using System;
 using System.Linq;
 using System.Management.Automation;
-using System.Security;
-using Commands.Common.Authentication.Properties;
 using Microsoft.IdentityModel.Clients.ActiveDirectory;
 using Microsoft.Rest;
 using Microsoft.Rest.Azure.Authentication;
+using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Factories
 {

src/CLU/Commands.Common.Authentication/ClientFactory.cs

@@ -12,18 +12,17 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using Microsoft.Azure.Commands.Common.Authentication.Models;
 using Microsoft.Rest;
 using System;
 using System.Collections.Generic;
 using System.Collections.Specialized;
-using System.Linq;
 using System.Management.Automation;
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Reflection;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Factories
 {

src/CLU/Commands.Common.Authentication/JsonUtilities.cs

@@ -12,12 +12,12 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {

src/CLU/Commands.Common.Authentication/Models/AzureEnvironment.Methods.cs

@@ -12,9 +12,9 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using System;
 using System.Collections.Generic;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Models
 {
@@ -372,7 +372,7 @@ public static class AzureEnvironmentConstants
 
         public const string USGovernmentSqlDatabaseDnsSuffix = ".database.usgovcloudapi.net";
 
-        public const string AzureActiveDirectoryEndpoint = "https://login.windows.net/";
+        public const string AzureActiveDirectoryEndpoint = "https://login.microsoftonline.com/";
 
         public const string ChinaActiveDirectoryEndpoint = "https://login.chinacloudapi.cn/";
 

src/CLU/Commands.Common.Authentication/Models/AzureSMProfile.cs

@@ -12,12 +12,12 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using Microsoft.Rest;
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Models
 {

src/CLU/Commands.Common.Authentication/Models/DiskDataStore.cs

@@ -12,11 +12,11 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using System;
 using System.IO;
 using System.Security.Cryptography.X509Certificates;
 using System.Text;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Models
 {

src/CLU/Commands.Common.Authentication/Properties/Resources.Designer.cs

@@ -120,9 +120,6 @@
   <data name="AccountNeedsToBeSpecified" xml:space="preserve">
     <value>Account needs to be specified</value>
   </data>
-  <data name="AzureDirectoryName" xml:space="preserve">
-    <value>Windows Azure Powershell</value>
-  </data>
   <data name="CertificateNotFoundInStore" xml:space="preserve">
     <value>No certificate was found in the certificate store with thumbprint {0}</value>
   </data>

src/CLU/Commands.Common.Authentication/Properties/Resources.resx

@@ -12,10 +12,10 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Commands.Common.Authentication.Properties;
 using System;
 using System.IO;
 using System.Linq;
-using Commands.Common.Authentication.Properties;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {

src/CLU/Commands.Common.Authentication/Validate.cs

@@ -436,17 +436,11 @@ protected virtual void WriteExceptionError(Exception ex)
             WriteError(new ErrorRecord(ex, string.Empty, ErrorCategory.CloseError, null));
         }
 
-        protected PSObject ConstructPSObject(string typeName, params object[] args)
+        protected PSObject ConstructPSObject(params object[] args)
         {
-            return PowerShellUtilities.ConstructPSObject(typeName, args);
+            return PowerShellUtilities.ConstructPSObject(args);
         }
-
-        protected void SafeWriteOutputPSObject(string typeName, params object[] args)
-        {
-            PSObject customObject = this.ConstructPSObject(typeName, args);
-            WriteObject(customObject);
-        }
-
+        
         private void FlushDebugMessages(bool record = false)
         {
             if (record)

src/CLU/Commands.Common/AzurePSCmdlet.cs

@@ -86,5 +86,14 @@ public static implicit operator AzureContext(PSAzureContext context)
         public PSAzureTenant Tenant { get; set; }
 
         public byte[] TokenCache { get; set; }
+
+        public override string ToString()
+        {
+            var account = Account != null ? Account.Id : string.Empty;
+            var subscription = Subscription != null ? Subscription.SubscriptionId : string.Empty;
+            var tenant = Tenant != null ? Tenant.TenantId : string.Empty;
+            var environment = Environment != null ? Environment.Name : EnvironmentName.AzureCloud;
+            return $"{{Account: {account}, Subscription: {subscription}, Tenant: {tenant}, Environment: {environment}}}";
+        }
     }
 }

src/CLU/Commands.Common/Models/PSAzureContext.cs

@@ -64,6 +64,11 @@ public IDictionary<string, PSAzureEnvironment> Environments
             get { return _env; }
         }
 
+        public string EnvironmentNames
+        {
+            get { return _env == null? null : $"{string.Join(", ", _env.Keys.ToArray())}"; }
+        }
+
         /// <summary>
         /// The current credentials and metadata for connecting with the current Azure cloud instance.
         /// </summary>

src/CLU/Commands.Common/Models/PSAzureProfile.cs

@@ -50,17 +50,12 @@ private static void ChangeForTargetEnvironment(Func<IEnumerable<string>, IEnumer
             }
         }
 
-        public static PSObject ConstructPSObject(string typeName, params object[] args)
+        public static PSObject ConstructPSObject(params object[] args)
         {
             Debug.Assert(args.Length % 2 == 0, "The parameter args length must be even number");
 
             PSObject outputObject = new PSObject();
-
-            if (!string.IsNullOrEmpty(typeName))
-            {
-                outputObject.TypeNames.Add(typeName);
-            }
-
+            
             for (int i = 0, j = 0; i < args.Length / 2; i++, j += 2)
             {
                 outputObject.Properties.Add(new PSNoteProperty(args[j].ToString(), args[j + 1]));