fix for Azure#193 - "The extension ID Default-PaaSDiagnostics-Staging-Ext-0 is already in use for this deployment" for Set-AzureServiceDiagnosticsExtension after VIP Swap.

Author: PashaPash

src/ServiceManagement/Compute/Commands.ServiceManagement.Test/FunctionalTests/PaasCmdletInfo/SetAzureServiceDiagnosticsExtensionCmdletInfo.cs

@@ -26,6 +26,7 @@ public SetAzureServiceDiagnosticsExtensionCmdletInfo(string service, AzureStorag
             this.cmdletName = Utilities.SetAzureServiceDiagnosticsExtensionCmdletName;
             this.cmdletParams.Add(new CmdletParam("ServiceName", service));
             this.cmdletParams.Add(new CmdletParam("StorageContext", storageContext));
+            this.cmdletParams.Add(new CmdletParam("Slot", slot));
             if (roles != null)
             {
                 this.cmdletParams.Add(new CmdletParam("Role", roles));

src/ServiceManagement/Compute/Commands.ServiceManagement.Test/FunctionalTests/ScenarioTest.cs

@@ -1012,7 +1012,6 @@ public void AzureServiceDiagnosticsExtensionConfigScenarioTest()
         [Ignore]
         public void AzureServiceDiagnosticsExtensionTest()
         {
-
             StartTest(MethodBase.GetCurrentMethod().Name, testStartTime);
 
             // Choose the package and config files from local machine
@@ -1064,6 +1063,77 @@ public void AzureServiceDiagnosticsExtensionTest()
             pass &= Utilities.CheckRemove(vmPowershellCmdlets.GetAzureDeployment, serviceName, DeploymentSlotType.Production);
         }
 
+        [TestMethod(), TestCategory(Category.Scenario), TestProperty("Feature", "PAAS"), Priority(1), Owner("hylee"), Description("Test the cmdlet ((Get,Set,Remove)-AzureServiceRemoteDesktopExtension)")]
+        [DataSource("Microsoft.VisualStudio.TestTools.DataSource.CSV", "|DataDirectory|\\Resources\\nodiagpackage.csv", "nodiagpackage#csv", DataAccessMethod.Sequential)]
+        [Ignore]
+        public void VipSwapWithDiagnosticsExtensionTest()
+        {
+            StartTest(MethodBase.GetCurrentMethod().Name, testStartTime);
+
+            // Choose the package and config files from local machine
+            string packageName = Convert.ToString(TestContext.DataRow["packageName"]);
+            string configName = Convert.ToString(TestContext.DataRow["configName"]);
+            var packagePath = new FileInfo(Directory.GetCurrentDirectory() + "\\" + packageName);
+            var configPath = new FileInfo(Directory.GetCurrentDirectory() + "\\" + configName);
+
+            Assert.IsTrue(File.Exists(packagePath.FullName), "Package file not exist={0}", packagePath);
+            Assert.IsTrue(File.Exists(configPath.FullName), "Config file not exist={0}", configPath);
+
+            string deploymentName = "deployment1";
+            string deploymentLabel = "label1";
+            DeploymentInfoContext result;
+
+            string storage = defaultAzureSubscription.CurrentStorageAccountName;
+            string daConfig = @"da.xml";
+
+            string storageKey = vmPowershellCmdlets.GetAzureStorageAccountKey(storage).Primary;
+            StorageCredentials creds = new StorageCredentials(storage, storageKey);
+            CloudStorageAccount csa = new WindowsAzure.Storage.CloudStorageAccount(creds, true);
+            var storageContext = new AzureStorageContext(csa);
+
+            serviceName = Utilities.GetUniqueShortName(serviceNamePrefix);
+            vmPowershellCmdlets.NewAzureService(serviceName, serviceName, locationName);
+            Console.WriteLine("service, {0}, is created.", serviceName);
+
+            // deploy staging
+            vmPowershellCmdlets.NewAzureDeployment(serviceName, packagePath.FullName, configPath.FullName, DeploymentSlotType.Staging, deploymentLabel, deploymentName, false, false);
+            result = vmPowershellCmdlets.GetAzureDeployment(serviceName, DeploymentSlotType.Staging);
+            pass = Utilities.PrintAndCompareDeployment(result, serviceName, deploymentName, deploymentLabel, DeploymentSlotType.Staging, null, 2);
+            Console.WriteLine("successfully deployed the package");
+
+            vmPowershellCmdlets.SetAzureServiceDiagnosticsExtension(serviceName, storageContext, daConfig, null, slot: DeploymentSlotType.Staging);
+            DiagnosticExtensionContext resultContext = vmPowershellCmdlets.GetAzureServiceDiagnosticsExtension(serviceName, slot: DeploymentSlotType.Staging)[0];
+            VerifyDiagExtContext(resultContext, "AllRoles", "Default-PaaSDiagnostics-Staging-Ext-0", storage, daConfig);
+
+            // swap staging -> production
+            // production will be retain diagnosting config from staging, named Default-PaaSDiagnostics-Staging-Ext-0
+            vmPowershellCmdlets.MoveAzureDeployment(serviceName);
+
+            // deploy a new staging
+            deploymentName = "deployment2";
+            deploymentLabel = "label2";
+
+            vmPowershellCmdlets.NewAzureDeployment(serviceName, packagePath.FullName, configPath.FullName, DeploymentSlotType.Staging, deploymentLabel, deploymentName, false, false);
+            result = vmPowershellCmdlets.GetAzureDeployment(serviceName, DeploymentSlotType.Staging);
+            pass = Utilities.PrintAndCompareDeployment(result, serviceName, deploymentName, deploymentLabel, DeploymentSlotType.Staging, null, 2);
+            Console.WriteLine("successfully deployed the package");
+
+            // should detect that Default-PaaSDiagnostics-Staging-Ext-0 is in use 
+            vmPowershellCmdlets.SetAzureServiceDiagnosticsExtension(serviceName, storageContext, daConfig, null, slot: DeploymentSlotType.Staging);
+            DiagnosticExtensionContext resultContext2 = vmPowershellCmdlets.GetAzureServiceDiagnosticsExtension(serviceName, slot: DeploymentSlotType.Staging)[0];
+            VerifyDiagExtContext(resultContext2, "AllRoles", "Default-PaaSDiagnostics-Staging-Ext-1", storage, daConfig);
+
+            // execute again to make sure max number of extensions will handled correctly (1 for production and 1 for staging, 1 unused)
+            // should not fail due to ExtensionIdLiveCycleCount limit
+            vmPowershellCmdlets.SetAzureServiceDiagnosticsExtension(serviceName, storageContext, daConfig, null, slot: DeploymentSlotType.Staging);
+            DiagnosticExtensionContext resultContext3 = vmPowershellCmdlets.GetAzureServiceDiagnosticsExtension(serviceName, slot: DeploymentSlotType.Staging)[0];
+
+            // azure splits config from All Roles to specific role in that case, so role name should not be validated
+            VerifyDiagExtContext(resultContext3, null, "Default-PaaSDiagnostics-Staging-Ext-2", storage, daConfig);
+            
+            vmPowershellCmdlets.RemoveAzureService(serviceName, true);
+        }
+
         #endregion
 
 
@@ -1696,10 +1766,14 @@ private void VerifyDiagExtContext(DiagnosticExtensionContext resultContext, stri
         {
             Utilities.PrintContext(resultContext);
 
-            Assert.AreEqual(role, resultContext.Role.RoleType.ToString(), "role is not same");
+            if (role != null)
+            {
+                Assert.AreEqual(role, resultContext.Role.RoleType.ToString(), "role is not same");
+            }
+
             Assert.AreEqual(Utilities.PaaSDiagnosticsExtensionName, resultContext.Extension, "extension is not Diagnostics");
+
             Assert.AreEqual(extID, resultContext.Id, "extension id is not same");
-            //Assert.AreEqual(storage, resultContext.StorageAccountName, "storage account name is not same");
 
             XmlDocument doc = new XmlDocument();
             doc.Load("da.xml");

src/ServiceManagement/Compute/Commands.ServiceManagement/Extensions/Common/ExtensionManager.cs

@@ -21,12 +21,14 @@
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using Microsoft.WindowsAzure.Management.Compute;
 using Microsoft.WindowsAzure.Management.Compute.Models;
+using DeploymentSlotType = Microsoft.WindowsAzure.Commands.ServiceManagement.Model.DeploymentSlotType;
+using System.Diagnostics;
 
 namespace Microsoft.WindowsAzure.Commands.ServiceManagement.Extensions
 {
     public class ExtensionManager
     {
-        public const int ExtensionIdLiveCycleCount = 2;
+        public const int ExtensionIdLiveCycleCount = 3;
         private const string ExtensionIdTemplate = "{0}-{1}-{2}-Ext-{3}";
         private const string DefaultAllRolesNameStr = "Default";
         private const string ExtensionCertificateSubject = "DC=Microsoft Azure Service Management for Extensions";
@@ -143,16 +145,24 @@ private void GetThumbprintAndAlgorithm(IList<HostedServiceListExtensionsResponse
             }
         }
 
-        public ExtensionConfiguration InstallExtension(ExtensionConfigurationInput context, string slot, Microsoft.WindowsAzure.Management.Compute.Models.ExtensionConfiguration extConfig)
+        public ExtensionConfiguration InstallExtension(ExtensionConfigurationInput context, string slot,
+            Microsoft.WindowsAzure.Management.Compute.Models.ExtensionConfiguration extConfig, 
+            Microsoft.WindowsAzure.Management.Compute.Models.ExtensionConfiguration secondSlotExtConfig = null)
         {
             ExtensionConfigurationBuilder builder = GetBuilder(extConfig);
+            ExtensionConfigurationBuilder secondSlotConfigBuilder = null;
+            if (secondSlotExtConfig != null)
+            {
+                secondSlotConfigBuilder = GetBuilder(secondSlotExtConfig);
+            }
+
             foreach (ExtensionRole r in context.Roles)
             {
                 var extensionIds = (from index in Enumerable.Range(0, ExtensionIdLiveCycleCount)
                                     select r.GetExtensionId(context.Type, slot, index)).ToList();
 
                 string availableId = (from extensionId in extensionIds
-                                      where !builder.ExistAny(extensionId)
+                                      where !builder.ExistAny(extensionId) && (secondSlotConfigBuilder == null || !secondSlotConfigBuilder.ExistAny(extensionId))
                                       select extensionId).FirstOrDefault();
 
                 var extensionList = (from id in extensionIds

src/ServiceManagement/Compute/Commands.ServiceManagement/Extensions/Diagnostics/SetAzureServiceDiagnosticsExtension.cs

@@ -130,7 +130,12 @@ public void ExecuteCommand()
                 PrivateConfiguration = PrivateConfiguration,
                 Roles = new ExtensionRoleList(Role != null && Role.Any() ? Role.Select(r => new ExtensionRole(r)) : Enumerable.Repeat(new ExtensionRole(), 1))
             };
-            var extConfig = ExtensionManager.InstallExtension(context, Slot, Deployment.ExtensionConfiguration);
+
+            var secondSlotDeployment = GetDeployment(this.Slot == DeploymentSlotType.Production ? DeploymentSlotType.Staging : DeploymentSlotType.Production);
+            Microsoft.WindowsAzure.Management.Compute.Models.ExtensionConfiguration secondSlotExtensionConfiguration = 
+                secondSlotDeployment != null ? secondSlotDeployment.ExtensionConfiguration : null;
+
+            var extConfig = ExtensionManager.InstallExtension(context, Slot, Deployment.ExtensionConfiguration, secondSlotExtensionConfiguration);
             ChangeDeployment(extConfig);
         }