Merge pull request #3 from Azure/clu

Clu

Author: BurtBiel

clu-getstart.md

@@ -63,7 +63,7 @@ To test on osx/linux boxes, do #1, open `<repo-root>\drop\clurun`, copy the flav
 (All of those are subject to change, contact yugangw or adxsdkdev for any questions)
 
 ### Quick introductions on cmdlets
-  *  Run commands using the ‘az’ prefix, cmdlet nouns, and cmdlet verbs, for example, `az environment get` maps to the cmdlet `Get-AzureRmEnvironment`
+  *  Run commands using the ‘az’ prefix, cmdlet nouns, and cmdlet verbs, for example, `az env get` maps to the cmdlet `Get-AzureRmEnvironment`
   *  Cmdlet parameters use the double dash (--) so for example, getting a subscription with a particular name would be: `az subscription get –-SubscriptionName “name of subscription"`
   * To log in, 3 options
     * login interactively using device flow, this is the only option for msa account or any org-id with 2fa enforced, example: `az account add`
@@ -73,14 +73,14 @@ To test on osx/linux boxes, do #1, open `<repo-root>\drop\clurun`, copy the flav
     ```az subscription get --SubscriptionName | az context set```
   * You can capture piped output using redirection to a file - the result will be the json serialization of the output object.
     ```az subscription get > subscriptions.json```
-  * You can use file input tu aparameter using '@' notation:
+  * You can use file input to a parameter using '@' notation:
     ```az command --param1 @file1.json```
     Reads input from file1.json and attempts to deserialize the .net object that is the Parameter type for ```param1```
     ```az command --param1 @@file1.json```
     Does the same thing, but treats the input from ```file1.json``` as if it come from the pipeline, so that multiple objects will result in multiple invocations of ```ProcessRecord()``` for the target cmdlet.
   * There are some known issues with the current approach to sessions, which can cause session variables to not be propagated when running cmdlets in a pipeline, to work around this, set the 'CmdletSessionId' environment variable to a numeric value - all cmdlets running from the shell will use that session id, and sessions will work with pipelining 
 
-    ```set CmdletSessionId=1010 ```
+    ```set AzureProfile=1010 ```
 
 ### Testing Cmdlets
 
@@ -119,7 +119,8 @@ Please set the environment variables for either Username/Password (no 2FA) or Se
 
 - To implement an xunit bash scenario test you must
   - Add a ```[Collection("SampleCollection")]``` attribute to your test class
-  - Add a field to your class of type ```ScenarioTestFixture``` and add a constructor that initializes it
+  - Add a field to your class of type ```ScenarioTestFixture``` and add a constructor that initializes it.
+  
     ```C#
     [Collection("SampleCollection")]
     public class SampleTestClass

examples/compute-management/01-VirtualMachineSizes.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Virtual Machine Sizes in Azure Compute ===\n"
 

examples/compute-management/02-VirtualMachineCreation.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Virtual Machine Creation in Azure Compute ===\n"
 

examples/lib/helper.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 
 randomName() {
     echo "$1$RANDOM"

examples/lib/loginService.sh

@@ -1,2 +1,2 @@
-#!/bin/bash
+#!/bin/env/bash
 az account add --spn --appid "$spn" --secret "$secret" -t "$tenant" -s "$spnSubscription"

examples/lib/loginUser.sh

@@ -1,2 +1,2 @@
-#!/bin/bash
+#!/bin/env/bash
 az account add -u "$azureUser" -p "$password" -s "$userSubscription"

examples/lib/testrunner.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 export TESTDIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 . $TESTDIR/helper.sh
 export groupName=`randomName testrg`

examples/resource-management/01-ResourceGroups.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Resource Groups in Azure ===\n"
 

examples/resource-management/02-Resource.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Resources in Azure ===\n"
 

examples/resource-management/03-Deployments.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Provisioning Deployments in Azure ===\n"
 

examples/resource-management/04-RoleAssignments.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Role Assignments in Azure ===\n"
 

examples/resource-management/05-RoleDefinitions.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Role Definitions in Azure ===\n"
 

examples/storage-management/01-Storage-Accounts.ps1

@@ -0,0 +1,33 @@
+Param(
+  [string]$rgname,
+  [string]$resourceGroupLocation
+)
+Write-Host "=== Managing Storage Accounts Resources in Azure ==="
+
+$stoname = 'sto' + $rgname;
+$stotype = 'Standard_GRS';
+$loc = 'West US';
+
+New-AzureRmResourceGroup -Name $rgname -Location $resourceGroupLocation;
+
+Write-Host "1. Create a new storage account"
+New-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype;
+
+Write-Host "2. Get info of a storage account"
+$stos = Get-AzureRmStorageAccount -ResourceGroupName $rgname;
+
+Write-Host "3. Update storage account type"
+$stotype = 'Standard_RAGRS';
+Set-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname -Type $stotype;
+
+Write-Host "4. Get account key of a storage account"
+$stokeys=Get-AzureRmStorageAccountKey -ResourceGroupName $rgname -Name $stoname;
+
+Write-Host "5. Renew key1 of a storage account"
+New-AzureRmStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key1;
+
+Write-Host "6. Renew key2 of a storage account"        
+New-AzureRmStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key2;
+
+Write-Host "7. Remove storage account"
+Remove-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname;

examples/storage-management/01-Storage-Accounts.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+printf "\n=== Managing Storage Accounts Resources in Azure ===\n"
+export BASEDIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+
+azure group get -n $groupName
+if [ $? -ne 0 ]; then
+    printf "\n Creating group %s in location %s \n" $groupName $location
+    azure group create -n "$groupName" --location "$location"
+fi
+
+set -e
+accountName=`randomName $groupName`
+accountType="Standard_GRS"
+
+printf "\n1. Creating storage account %s in resrouce group %s with type %s in location %s \n" $accountName $groupName $accountType $location
+azure storage account new -g "$groupName" -n "$accountName" -t "$accountType" -l "$location"
+
+printf "\n2. Get account info of storage account %s in group %s\n" $accountName $groupName
+azure storage account get -g $groupName -n $accountName > $BASEDIR/$accountName.json
+[ $(cat $BASEDIR/$accountName.json | jq '.ResourceGroupName' --raw-output) == "$groupName" ]
+[ $(cat $BASEDIR/$accountName.json | jq '.StorageAccountName' --raw-output) == "$accountName" ]
+[ $(cat $BASEDIR/$accountName.json | jq '.AccountType' --raw-output) == "$accountType" ]
+[ $(cat $BASEDIR/$accountName.json | jq '.Location' --raw-output) == "$location" ]
+rm -f $BASEDIR/$accountName.json
+
+accountType1="Standard_RAGRS"
+printf "\n3. Set account type from %s to %s of storage account %s in group %s\n" $accountType $accountType1 $accountName $groupName
+azure storage account set -g $groupName -n $accountName -t "$accountType1" > $BASEDIR/$accountName.json
+[ $(cat $BASEDIR/$accountName.json | jq '.AccountType' --raw-output) == "$accountType1" ]
+rm -f $BASEDIR/$accountName.json
+
+printf "\n4. Get account key of storage account %s in group %s\n" $accountName $groupName
+azure storage account key get -g $groupName -n $accountName > $BASEDIR/$accountName.json
+key1=$(cat $BASEDIR/$accountName.json | jq '.key1' --raw-output)
+key2=$(cat $BASEDIR/$accountName.json | jq '.key2' --raw-output)
+[ $key1 != $key2 ]
+rm -f $BASEDIR/$accountName.json
+
+printf "\n5. Renew account key1 of storage account %s in group %s\n" $accountName $groupName
+azure storage account key new -g $groupName -n $accountName -k "key1"
+azure storage account key get -g $groupName -n $accountName > $BASEDIR/$accountName.json
+[ $(cat $BASEDIR/$accountName.json | jq '.key1' --raw-output) != $key1 ]
+rm -f $BASEDIR/$accountName.json
+
+printf "\n6. Renew account key2 of storage account %s in group %s\n" $accountName $groupName
+azure storage account key new -g $groupName -n $accountName -k "key2"
+azure storage account key get -g $groupName -n $accountName > $BASEDIR/$accountName.json
+[ $(cat $BASEDIR/$accountName.json | jq '.key2' --raw-output) != $key2 ]
+rm -f $BASEDIR/$accountName.json
+
+printf "\n7. Removing account %s in group %s\n" $accountName $groupName
+azure storage account remove -g $groupName -n $accountName

examples/virtual-hard-disk/01-VirtualHardDisks.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Virtual Hard Disks in Azure Compute ===\n"
 

examples/webapp-management/01-AppServicePlan.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing App Service Plans in Azure ===\n"
 

examples/webapp-management/02-WebAppSlot.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 set -e
 printf "\n=== Managing Web App Slot in Azure ===\n"
 

examples/webapp-management/03-WebApp.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/env/bash
 printf "\n=== Managing Web Apps in Azure ===\n"
 
 printf "\nSetup: Creating a new resource group: %s at location: %s.\n" "$groupName" "$location"

src/CLU/Commands.ScenarioTests.ResourceManager.Common/Mocks/MockCommandRuntime.cs

@@ -20,6 +20,7 @@
 using System.Globalization;
 using System.Management.Automation;
 using System.Management.Automation.Host;
+using Microsoft.CLU;
 
 namespace Microsoft.Azure.Commands.Common.Test.Mocks
 {
@@ -285,6 +286,8 @@ public override Version Version
                 }
             }
 
+            public override OutputFormat RequestedOutputFormat { get; set;  }
+
             class MockPSHostUI : PSHostUserInterface
             {
                 public override Dictionary<string, PSObject> Prompt(string caption, string message, Collection<FieldDescription> descriptions)

src/CLU/Microsoft.Azure.Commands.Management.Storage/Models/PSStorageAccount.cs

@@ -82,10 +82,10 @@ public static PSStorageAccount Create(StorageModels.StorageAccount storageAccoun
             var credentials = StorageUtilities.GenerateStorageCredentials(client, result.ResourceGroupName, result.StorageAccountName);
             CloudStorageAccount account = new CloudStorageAccount(
                 credentials,
-                new Uri(storageAccount.PrimaryEndpoints.Blob), 
-                new Uri(storageAccount.PrimaryEndpoints.Queue), 
-                new Uri(storageAccount.PrimaryEndpoints.Table), 
-                new Uri(storageAccount.PrimaryEndpoints.File));
+                null == storageAccount.PrimaryEndpoints.Blob ? null : new Uri(storageAccount.PrimaryEndpoints.Blob),
+                null == storageAccount.PrimaryEndpoints.Queue ? null : new Uri(storageAccount.PrimaryEndpoints.Queue),
+                null == storageAccount.PrimaryEndpoints.Table ? null : new Uri(storageAccount.PrimaryEndpoints.Table),
+                null == storageAccount.PrimaryEndpoints.File ? null : new Uri(storageAccount.PrimaryEndpoints.File));
             result.Context = new AzureStorageContext(account);
             return result;
         }

src/CLU/Microsoft.Azure.Commands.Management.Storage/StorageAccount/NewAzureStorageAccount.cs

@@ -72,7 +72,6 @@ public class NewAzureStorageAccountCommand : StorageAccountBaseCmdlet
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "Storage Account Tags.")]
         [ValidateNotNull]
-        [Alias("t")]
         public Hashtable[] Tags { get; set; }
 
         protected override void ProcessRecord()

src/CLU/Microsoft.Azure.Commands.Management.Storage/StorageAccount/NewAzureStorageAccountKey.cs

@@ -50,6 +50,7 @@ public class NewAzureStorageAccountKeyCommand : StorageAccountBaseCmdlet
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "Storage Account Key StorageAccountName.")]
         [ValidateSet(Key1, Key2, IgnoreCase = true)]
+        [Alias("k")]
         public string KeyName { get; set; }
 
         protected override void ProcessRecord()

src/CLU/Microsoft.Azure.Commands.Management.Storage/StorageAccount/SetAzureStorageAccount.cs

@@ -91,7 +91,6 @@ public class SetAzureStorageAccountCommand : StorageAccountBaseCmdlet
             HelpMessage = "Storage Account Tags.")]
         [AllowEmptyCollection]
         [ValidateNotNull]
-        [Alias("t")]
         public Hashtable[] Tags { get; set; }
 
         protected override void ProcessRecord()

src/CLU/Microsoft.CLU.Test/StringGenerator.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+using System.Management.Automation;
+
+namespace Microsoft.CLU.Test
+{
+    [Cmdlet(VerbsCommon.New, "String")]
+    public class StringGenerator : PSCmdlet
+    {
+        public StringGenerator()
+        {
+            Count = 10;
+            StringFormat = "String {0}";
+        }
+
+        [Parameter()]
+        public int Count { get; set; }
+
+        [Parameter()]
+        public string StringFormat { get; set; }
+
+        protected override void ProcessRecord()
+        {
+            base.ProcessRecord();
+            for (int i = 1; i <= Count; ++i)
+            {
+                WriteObject(String.Format(StringFormat, i));
+            }
+        }
+
+    }
+}

src/CLU/Microsoft.CLU/CommandModel/CmdletCommandModel.cs

@@ -43,7 +43,7 @@ public CommandModelErrorCode Run(ConfigurationDictionary commandConfiguration, s
             // The runtime host is a Cmdlet's path to accessing system features, such as Console I/O
             // and session state. The runtime instance is created here and passed into the binder,
             // which will be creating the Cmdlet instance.
-            var runtimeHost = new System.Management.Automation.Host.CLUHost(arguments, hostStreamInfo);
+            var runtimeHost = new System.Management.Automation.Host.CLUHost(ref arguments, hostStreamInfo);
 
             // Create instance of ICommandBinder and ICommand implementation for cmdlet model
             var binderAndCommand = new CmdletBinderAndCommand(commandConfiguration, runtimeHost);

src/CLU/Microsoft.CLU/System.Management.Automation/CLUHost.cs

@@ -22,7 +22,7 @@ internal class CLUHost : PSHost, ICommandRuntime
         /// Creates an instance of CLUHost.
         /// </summary>
         /// <param name="args">The commandline arguments</param>
-        internal CLUHost(string[] args, HostStreamInfo hostStreamInfo)
+        internal CLUHost(ref string[] args, HostStreamInfo hostStreamInfo)
         {
             Debug.Assert(args != null);
             Debug.Assert(hostStreamInfo != null);
@@ -37,12 +37,29 @@ internal CLUHost(string[] args, HostStreamInfo hostStreamInfo)
             if (!string.IsNullOrEmpty(vpref))
                 _doVerbose = InterpretStreamPreference(Constants.VerbosePreference, vpref, _doVerbose);
 
+            var argList = args.ToList();
+
             // Command-line switch overrides environment variable
-            if (args.Select(arg => arg.ToLowerInvariant()).Where(arg => arg.Equals("--debug") || arg.Equals("/debug")).Any())
+            if (RemoveArgumentIfFound(argList, "debug"))
+            {
                 _doDebug = Constants.CmdletPreferencesInquire;
-                    
-            if (args.Select(arg => arg.ToLowerInvariant()).Where(arg => arg.Equals("--verbose") || arg.Equals("/verbose")).Any())
+            }
+
+            if (RemoveArgumentIfFound(argList, "verbose"))
+            {
                 _doVerbose = Constants.CmdletPreferencesContinue;
+            }
+
+            if (RemoveArgumentIfFound(argList, "json"))
+            {
+                this.RequestedOutputFormat = OutputFormat.JSON;
+            }
+            else if (RemoveArgumentIfFound(argList, "display"))
+            {
+                this.RequestedOutputFormat = OutputFormat.Display;
+            }
+
+            args = argList.ToArray();
         }
 
         internal CLUHost(string[] args, HostStreamInfo hostStreamInfo, string debugPreference, string verbosePreference)
@@ -82,6 +99,11 @@ internal HostStreamInfo StreamInfo
         /// <remarks>If this is true, your code is not doing console I/O</remarks>
         public override bool IsInputRedirected { get { return _hostStreamInfo.IsInputRedirected; } }
 
+        /// <summary>
+        /// Command line override of requested output format...
+        /// </summary>
+        public override OutputFormat RequestedOutputFormat { get; set;  }
+
         /// <summary>
         /// Tells whether the STDOUT byte stream has been redirected to a file or pipe
         /// </summary>
@@ -514,6 +536,19 @@ private string InterpretStreamPreference(string variable, string input, string c
                 new ChoiceDescription("&Halt Command", "Stop this command.")
         };
         private HostStreamInfo _hostStreamInfo;
+        private bool RemoveArgumentIfFound(List<string> args, string argName)
+        {
+            int index = args.FindIndex(arg => arg.ToLowerInvariant().Equals($"--{argName}") || arg.ToLowerInvariant().Equals($"/{argName}"));
+            if (index > -1)
+            {
+                args.RemoveAt(index);
+                return true;
+            }
+            else
+            {
+                return false;
+            }
+        }
 
         #endregion