Merge pull request Azure#4707 from maddieclayton/Default

Add Get/Set/Clear-AzureRmDefault Cmdlets

Author: maddieclayton

src/ResourceManager/Profile/AzureRM.Profile.Netcore.psd1

@@ -77,7 +77,8 @@ CmdletsToExport = 'Disable-AzureRmDataCollection', 'Enable-AzureRmDataCollection
                'Set-AzureRmEnvironment', 'Add-AzureRmEnvironment', 
                'Get-AzureRmSubscription', 'Add-AzureRmAccount', 'Get-AzureRmContext', 
                'Set-AzureRmContext', 'Import-AzureRmContext', 'Save-AzureRmContext', 
-               'Get-AzureRmTenant', 'Send-Feedback', 'Resolve-AzureRmError'
+               'Get-AzureRmTenant', 'Send-Feedback', 'Resolve-AzureRmError', 
+               'Set-AzureRmDefault', 'Get-AzureRmDefault', 'Clear-AzureRmDefault'
 
 # Variables to export from this module
 # VariablesToExport = @()

src/ResourceManager/Profile/AzureRM.Profile.psd1

@@ -82,7 +82,8 @@ CmdletsToExport = 'Disable-AzureRmDataCollection', 'Disable-AzureRmContextAutosa
                'Get-AzureRmTenant', 'Send-Feedback', 'Resolve-AzureRmError', 
                'Select-AzureRmContext', 'Rename-AzureRmContext', 
                'Remove-AzureRmContext', 'Clear-AzureRmContext', 
-               'Remove-AzureRmAccount', 'Get-AzureRmContextAutosaveSetting'
+               'Remove-AzureRmAccount', 'Get-AzureRmContextAutosaveSetting',
+               'Set-AzureRmDefault', 'Get-AzureRmDefault', 'Clear-AzureRmDefault'
 
 # Variables to export from this module
 # VariablesToExport = @()

src/ResourceManager/Profile/ChangeLog.md

@@ -18,6 +18,16 @@
         - Additional information about change #1
 -->
 ## Current Release
+- Set-AzureRmDefault
+    - Use this cmdlet to set a default resource group.  This will make the -ResourceGroup parameter optional for some cmdlets, and will use the default when a resource group is not specified
+    - ```Set-AzureRmDefault -ResourceGroupName "ExampleResourceGroup"```
+    - If resource group specified exists in the subscription, this resource group will be set to default.  Otherwise, the resource group will be created and then set to default.
+- Get-AzureRmDefault
+    - Use this cmdlet to get the current default resource group (and other defaults in the future).
+    - ```Get-AzureRmDefault -ResourceGroup```
+- Clear-AzureRmDefault
+    - Use this cmdlet to remove the current default resource group
+    - ```Clear-AzureRmDefault -ResourceGroup```
 
 ## Version 3.4.1
 * LocationCompleterAttribute added and available for cmdlets which use the -Location parameter

src/ResourceManager/Profile/Commands.Profile.Test/Commands.Profile.Test.csproj

@@ -64,6 +64,10 @@
       <HintPath>..\..\..\packages\Microsoft.Azure.KeyVault.Core.1.0.0\lib\net40\Microsoft.Azure.KeyVault.Core.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="Microsoft.Azure.Management.ResourceManager, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Management.ResourceManager.1.6.0-preview\lib\net452\Microsoft.Azure.Management.ResourceManager.dll</HintPath>
+    </Reference>
     <Reference Include="Microsoft.Azure.Test.Framework">
       <HintPath>..\..\..\packages\Microsoft.Azure.Test.Framework.1.0.6179.26854-prerelease\lib\net45\Microsoft.Azure.Test.Framework.dll</HintPath>
       <Private>True</Private>
@@ -188,6 +192,7 @@
     <Compile Include="ClientFactoryTests.cs" />
     <Compile Include="CommonDataCmdletTests.cs" />
     <Compile Include="ContextModelTests.cs" />
+    <Compile Include="DefaultCmdletTests.cs" />
     <Compile Include="EnvironmentCmdletTests.cs" />
     <Compile Include="ErrorResolutionTests.cs" />
     <Compile Include="LocationCompleterUnitTests.cs" />
@@ -214,12 +219,20 @@
     <Content Include="SubscriptionCmdletTests.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
+    <Content Include="DefaultCmdletTests.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
     <None Include="App.config">
       <SubType>Designer</SubType>
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Include="MSSharedLibKey.snk" />
-    <None Include="packages.config" />
+    <None Include="packages.config">
+      <SubType>Designer</SubType>
+    </None>
+    <None Include="SessionRecords\Microsoft.Azure.Commands.Profile.Test.DefaultCmdletTests\DefaultResourceGroup.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.Profile.Test.ProfileModuleTests\WarningOnIncompatibleVersions.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
@@ -273,4 +286,4 @@
   <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="..\..\..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets" Condition="Exists('..\..\..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets')" />
-</Project>
+</Project>

src/ResourceManager/Profile/Commands.Profile.Test/DefaultCmdletTests.cs

@@ -0,0 +1,46 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.Azure.Commands.ResourceManager.Common;
+using Microsoft.Azure.Commands.Resources.Test.ScenarioTests;
+using Microsoft.Azure.Commands.ScenarioTest;
+using Microsoft.Azure.ServiceManagemenet.Common.Models;
+using Microsoft.WindowsAzure.Commands.ScenarioTest;
+using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;
+using System.Threading;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Microsoft.Azure.Commands.Profile.Test
+{
+    public class DefaultCmdletTests : RMTestBase
+    {
+        private XunitTracingInterceptor xunitLogger;
+
+        public DefaultCmdletTests(ITestOutputHelper output)
+        {
+            TestExecutionHelpers.SetUpSessionAndProfile();
+            ResourceManagerProfileProvider.InitializeResourceManagerProfile(true);
+
+            xunitLogger = new XunitTracingInterceptor(output);
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void DefaultResourceGroup()
+        {
+            ProfileController.NewInstance.RunPsTest(xunitLogger, "72f988bf-86f1-41af-91ab-2d7cd011db47", "Test-DefaultResourceGroup");
+        }
+    }
+}

src/ResourceManager/Profile/Commands.Profile.Test/DefaultCmdletTests.ps1

@@ -0,0 +1,96 @@
+# ----------------------------------------------------------------------------------
+#
+# Copyright Microsoft Corporation
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ----------------------------------------------------------------------------------
+
+<#
+.SYNOPSIS
+Tests cmdlets surrounding default resource group
+#>
+function Test-DefaultResourceGroup
+{
+	# Setup
+	$rgname = Get-ResourceGroupName
+	Clear-AzureRmDefault -ResourceGroup
+
+	try
+	{
+		# Test GetDefault when default not set
+		$output = Get-AzureRmDefault
+		Assert-Null($output)
+		$output = Get-AzureRmDefault -ResourceGroup
+		Assert-Null($output)
+		$storedValue = (Get-AzureRmContext).ExtendedProperties["Default Resource Group"]
+		Assert-Null($storedValue)
+
+		# Test Resoure Group created when it doesn't exist
+		$output = Set-AzureRmDefault -ResourceGroupName $rgname -Force
+		$resourcegroup = Get-AzureRmResourceGroup -Name $rgname
+		Assert-AreEqual $output.Name $resourcegroup.ResourceGroupName
+		$context = Get-AzureRmContext
+		$storedValue = $context.ExtendedProperties["Default Resource Group"]
+		Assert-AreEqual $storedValue $output.Name
+
+		# Test GetDefault when default is set
+		$output = Get-AzureRmDefault
+		Assert-AreEqual $output.Name $resourceGroup.ResourceGroupName
+		$output = Get-AzureRmDefault -ResourceGroup
+		Assert-AreEqual $output.Name $resourceGroup.ResourceGroupName
+
+		# Test Clear-AzureRmDefault (no parameters shown)
+		Clear-AzureRmDefault -Force
+		$output = Get-AzureRmDefault
+		Assert-Null($output)
+		$context = Get-AzureRmContext
+		$storedValue = $context.ExtendedProperties["Default Resource Group"]
+		Assert-Null($storedValue)
+
+		# Test SetDefault when resource group exists
+		$output = Set-AzureRmDefault -ResourceGroupName $rgname
+		Assert-AreEqual $output.Name $resourcegroup.ResourceGroupName
+		$context = Get-AzureRmContext
+		$storedValue = $context.ExtendedProperties["Default Resource Group"]
+		Assert-AreEqual $storedValue $output.Name
+
+		# Test Clear-AzureRmDefault (no parameters shown)
+		Clear-AzureRmDefault -ResourceGroup
+		$output = Get-AzureRmDefault
+		Assert-Null($output)
+		$context = Get-AzureRmContext
+		$storedValue = $context.ExtendedProperties["Default Resource Group"]
+		Assert-Null($storedValue)
+	}
+	finally
+	{
+		Clean-ResourceGroup($rgname)
+	}
+}
+
+<#
+.SYNOPSIS
+Gets valid resource group name
+#>
+function Get-ResourceGroupName
+{
+    return getAssetName
+}
+
+<#
+.SYNOPSIS
+Cleans the created resource groups
+#>
+function Clean-ResourceGroup($rgname)
+{
+    if ([Microsoft.Azure.Test.HttpRecorder.HttpMockServer]::Mode -ne [Microsoft.Azure.Test.HttpRecorder.HttpRecorderMode]::Playback) {
+        Remove-AzureRmResourceGroup -Name $rgname -Force
+    }
+}

src/ResourceManager/Profile/Commands.Profile.Test/ProfileController.cs

@@ -14,6 +14,7 @@
 
 using Microsoft.Azure.Commands.Common.Authentication;
 using Microsoft.Azure.Internal.Subscriptions;
+using Microsoft.Azure.Management.ResourceManager;
 using Microsoft.Azure.ServiceManagemenet.Common.Models;
 using Microsoft.Azure.Test.HttpRecorder;
 using Microsoft.Rest.ClientRuntime.Azure.TestFramework;
@@ -37,7 +38,11 @@ public sealed class ProfileController
         private const string SubscriptionIdKey = "SubscriptionId";
 
 
-        public SubscriptionClient SubscriptionClient { get; private set; }
+        public Internal.Subscriptions.SubscriptionClient SubscriptionClient { get; private set; }
+
+        public ResourceManagementClient ResourceManagementClient { get; private set; }
+
+        public Management.Internal.Resources.ResourceManagementClient NewResourceManagementClient { get; private set; }
 
         public string UserDomain { get; private set; }
 
@@ -133,13 +138,25 @@ private void RunPsTestWorkflow(
         private void SetupManagementClients(MockContext context)
         {
             SubscriptionClient = GetSubscriptionClient(context);
+            ResourceManagementClient = GetResourceManagementClient(context);
+            NewResourceManagementClient = GetNewResourceManagementClient(context);
+
+            helper.SetupManagementClients(SubscriptionClient, ResourceManagementClient, NewResourceManagementClient);
+        }
 
-            helper.SetupManagementClients(SubscriptionClient);
+        private Internal.Subscriptions.SubscriptionClient GetSubscriptionClient(MockContext context)
+        {
+            return context.GetServiceClient<Internal.Subscriptions.SubscriptionClient>(TestEnvironmentFactory.GetTestEnvironment());
+        }
+
+        private ResourceManagementClient GetResourceManagementClient(MockContext context)
+        {
+            return context.GetServiceClient<ResourceManagementClient>(TestEnvironmentFactory.GetTestEnvironment());
         }
 
-        private SubscriptionClient GetSubscriptionClient(MockContext context)
+        private Management.Internal.Resources.ResourceManagementClient GetNewResourceManagementClient(MockContext context)
         {
-            return context.GetServiceClient<SubscriptionClient>(TestEnvironmentFactory.GetTestEnvironment());
+            return context.GetServiceClient<Management.Internal.Resources.ResourceManagementClient>(TestEnvironmentFactory.GetTestEnvironment());
         }
     }
 }