Merge pull request #17 from MRCollective/suffix-and-delete-tentacle-config

MattDavies · MattDavies · commit 12c4c1821ebb · 2014-05-17T16:14:17.000+08:00
Suffix and delete tentacle config
diff --git a/AzureWebFarm.OctopusDeploy.Example/ServiceConfiguration.Cloud.cscfg b/AzureWebFarm.OctopusDeploy.Example/ServiceConfiguration.Cloud.cscfg
@@ -13,6 +13,7 @@
       <Setting name="OctopusApiKey" value="API-OCTOPUSAPIKEY" />
       <Setting name="TentacleEnvironment" value="ENVIRONMENT" />
       <Setting name="TentacleRole" value="ROLE" />
+      <Setting name="TentacleMachineNameSuffix" value="" />
     </ConfigurationSettings>
     <Certificates>
       <Certificate name="Microsoft.WindowsAzure.Plugins.RemoteAccess.PasswordEncryption" thumbprint="5BFCF449A37F73EF3875A1682BE5AE5CCB1B553F" thumbprintAlgorithm="sha1" />
diff --git a/AzureWebFarm.OctopusDeploy.Example/ServiceConfiguration.Local.cscfg b/AzureWebFarm.OctopusDeploy.Example/ServiceConfiguration.Local.cscfg
@@ -13,6 +13,7 @@
       <Setting name="OctopusApiKey" value="API-OCTOPUSAPIKEY" />
       <Setting name="TentacleEnvironment" value="ENVIRONMENT" />
       <Setting name="TentacleRole" value="ROLE" />
+      <Setting name="TentacleMachineNameSuffix" value="" />
     </ConfigurationSettings>
     <Certificates>
       <Certificate name="Microsoft.WindowsAzure.Plugins.RemoteAccess.PasswordEncryption" thumbprint="5BFCF449A37F73EF3875A1682BE5AE5CCB1B553F" thumbprintAlgorithm="sha1" />
diff --git a/AzureWebFarm.OctopusDeploy.Example/ServiceDefinition.csdef b/AzureWebFarm.OctopusDeploy.Example/ServiceDefinition.csdef
@@ -41,6 +41,7 @@
       <Setting name="OctopusApiKey" />
       <Setting name="TentacleEnvironment" />
       <Setting name="TentacleRole" />
+      <Setting name="TentacleMachineNameSuffix" />
     </ConfigurationSettings>
   </WebRole>
 </ServiceDefinition>
diff --git a/AzureWebFarm.OctopusDeploy.Tests/AzureWebFarm.OctopusDeploy.Tests.csproj b/AzureWebFarm.OctopusDeploy.Tests/AzureWebFarm.OctopusDeploy.Tests.csproj
@@ -90,6 +90,8 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Infrastructure\AzureEnvironmentTests.cs" />
+    <Compile Include="Infrastructure\ConfigSettingsTests.cs" />
     <Compile Include="Infrastructure\OctopusDeployTests.cs" />
     <Compile Include="Infrastructure\RegistryEditorTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/AzureEnvironmentTests.cs b/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/AzureEnvironmentTests.cs
@@ -0,0 +1,51 @@
+﻿using System;
+using AzureWebFarm.OctopusDeploy.Infrastructure;
+using Shouldly;
+using Xunit;
+
+namespace AzureWebFarm.OctopusDeploy.Tests.Infrastructure
+{
+    public class AzureEnvironmentTests
+    {
+        private readonly TestConfigSettings _config = new TestConfigSettings();
+
+        [Fact]
+        public void GivenSuffixIsEmpty_WhenGeneratingFarmName_ThenUseMachineNameAndEnvironment()
+        {
+            AzureRoleEnvironment.IsAvailable = () => false;
+            AzureRoleEnvironment.IsEmulated = () => false;
+            var machineName = Environment.MachineName;
+            _config.TentacleMachineNameSuffix = "";
+            _config.TentacleEnvironment = "Production";
+
+            var name = AzureEnvironment.GetMachineName(_config);
+
+            name.ShouldBe(machineName + "_" + _config.TentacleEnvironment);
+        }
+
+        [Fact]
+        public void GivenSuffixIsNotEmpty_WhenGeneratingFarmName_ThenUseMachineNameAndEnvironmentAndSuffix()
+        {
+            AzureRoleEnvironment.IsAvailable = () => false;
+            AzureRoleEnvironment.IsEmulated = () => false;
+            var machineName = Environment.MachineName;
+            _config.TentacleMachineNameSuffix = "Suffix";
+            _config.TentacleEnvironment = "Production";
+
+            var name = AzureEnvironment.GetMachineName(_config);
+
+            name.ShouldBe(machineName + "_" + _config.TentacleEnvironment + "_" + _config.TentacleMachineNameSuffix);
+        }
+    }
+
+    public class TestConfigSettings : IConfigSettings
+    {
+        public string OctopusServer { get; set; }
+        public string OctopusApiKey { get; set; }
+        public string TentacleEnvironment { get; set; }
+        public string TentacleRole { get; set; }
+        public string TentacleMachineNameSuffix { get; set; }
+        public string TentacleDeploymentsPath { get; set; }
+        public string TentacleInstallPath { get; set; }
+    }
+}
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/ConfigSettingsTests.cs b/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/ConfigSettingsTests.cs
@@ -0,0 +1,22 @@
+﻿using System;
+using AzureWebFarm.OctopusDeploy.Infrastructure;
+using Shouldly;
+using Xunit;
+
+namespace AzureWebFarm.OctopusDeploy.Tests.Infrastructure
+{
+    public class ConfigSettingsTests
+    {
+        [Fact]
+        public void GivenExceptionWhenGettingConfigSetting_WhenConstructingConfigSettings_ThenThrowNiceException()
+        {
+            var e = new Exception("Error");
+            Func<string, string> getter = _ => { throw e; };
+
+            var ex = Assert.Throws<UnableToGetConfigSettingException>(() => new ConfigSettings(getter, getter));
+
+            ex.Message.ShouldBe("Unable to get config setting: OctopusServer");
+            ex.InnerException.ShouldBe(e);
+        }
+    }
+}
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/OctopusDeployTests.WhenUninstallingTentacle_ThenTheCorrectCommandsShouldBeSentToTentacleExe.approved.txt b/AzureWebFarm.OctopusDeploy.Tests/Infrastructure/OctopusDeployTests.WhenUninstallingTentacle_ThenTheCorrectCommandsShouldBeSentToTentacleExe.approved.txt
@@ -1,3 +1,4 @@
 ﻿c:\Install\Tentacle\Tentacle.exe service --instance "Tentacle" --stop --uninstall --console
 c:\Install\Tentacle\Tentacle.exe delete-instance --instance "Tentacle" --console
 msiexec /uninstall "c:\InstallOctopus.Tentacle.msi" /quiet
+cmd.exe /c del "c:\InstallTentacle.config"
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Tools/ExampleFiles/ServiceConfiguration.transformed.cscfg b/AzureWebFarm.OctopusDeploy.Tests/Tools/ExampleFiles/ServiceConfiguration.transformed.cscfg
@@ -12,6 +12,7 @@
       <Setting name="OctopusApiKey" value="API-CZYCNXCPAMBWFMDUTPUQUC0O2ZY" />
       <Setting name="TentacleEnvironment" value="Production" />
       <Setting name="TentacleRole" value="webserver" />
+      <Setting name="TentacleMachineNameSuffix" value="" />
     </ConfigurationSettings>
     <Certificates>
       <Certificate name="Microsoft.WindowsAzure.Plugins.RemoteAccess.PasswordEncryption" thumbprint="5BFCF449A37F73EF3875A1682BE5AE5CCB1B553F" thumbprintAlgorithm="sha1" />
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Tools/ExampleFiles/ServiceDefinition.transformed.csdef b/AzureWebFarm.OctopusDeploy.Tests/Tools/ExampleFiles/ServiceDefinition.transformed.csdef
@@ -40,6 +40,7 @@
       <Setting name="OctopusApiKey" />
       <Setting name="TentacleEnvironment" />
       <Setting name="TentacleRole" />
+      <Setting name="TentacleMachineNameSuffix" />
     </ConfigurationSettings>
   </WebRole>
 </ServiceDefinition>
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Tools/XdtTests.WhenExecutingServiceConfigurationTransform_ThenCorrectlyTransformExampleFile.approved.xml b/AzureWebFarm.OctopusDeploy.Tests/Tools/XdtTests.WhenExecutingServiceConfigurationTransform_ThenCorrectlyTransformExampleFile.approved.xml
@@ -12,6 +12,7 @@
       <Setting name="OctopusApiKey" value="API-CZYCNXCPAMBWFMDUTPUQUC0O2ZY" />
       <Setting name="TentacleEnvironment" value="Production" />
       <Setting name="TentacleRole" value="webserver" />
+      <Setting name="TentacleMachineNameSuffix" value="" />
     </ConfigurationSettings>
     <Certificates>
       <Certificate name="Microsoft.WindowsAzure.Plugins.RemoteAccess.PasswordEncryption" thumbprint="5BFCF449A37F73EF3875A1682BE5AE5CCB1B553F" thumbprintAlgorithm="sha1" />
diff --git a/AzureWebFarm.OctopusDeploy.Tests/Tools/XdtTests.WhenExecutingServiceDefinitionTransform_ThenCorrectlyTransformExampleFile.approved.xml b/AzureWebFarm.OctopusDeploy.Tests/Tools/XdtTests.WhenExecutingServiceDefinitionTransform_ThenCorrectlyTransformExampleFile.approved.xml
@@ -40,6 +40,7 @@
       <Setting name="OctopusApiKey" />
       <Setting name="TentacleEnvironment" />
       <Setting name="TentacleRole" />
+      <Setting name="TentacleMachineNameSuffix" />
     </ConfigurationSettings>
   </WebRole>
 </ServiceDefinition>
diff --git a/AzureWebFarm.OctopusDeploy/AzureWebFarm.OctopusDeploy.csproj b/AzureWebFarm.OctopusDeploy/AzureWebFarm.OctopusDeploy.csproj
@@ -95,6 +95,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Infrastructure\AzureEnvironment.cs" />
+    <Compile Include="Infrastructure\AzureRoleEnvironment.cs" />
     <Compile Include="Infrastructure\ConfigSettings.cs" />
     <Compile Include="Infrastructure\IisEnvironment.cs" />
     <Compile Include="Infrastructure\OctopusDeploy.cs" />
diff --git a/AzureWebFarm.OctopusDeploy/Infrastructure/AzureEnvironment.cs b/AzureWebFarm.OctopusDeploy/Infrastructure/AzureEnvironment.cs
@@ -23,11 +23,16 @@ public static void RequestRecycleIfConfigSettingChanged(ConfigSettings config)
             };
         }
 
-        public static string GetMachineName(ConfigSettings config)
+        public static string GetMachineName(IConfigSettings config)
         {
-            return RoleEnvironment.IsEmulated
+            var name = AzureRoleEnvironment.IsEmulated()
                 ? Environment.MachineName
-                : String.Format("{0}_{1}", RoleEnvironment.CurrentRoleInstance.Id, config.TentacleEnvironment);
+                : string.Format("{0}_{1}", AzureRoleEnvironment.CurrentRoleInstanceId(), config.TentacleEnvironment);
+
+            if (!string.IsNullOrEmpty(config.TentacleMachineNameSuffix))
+                name = string.Format("{0}_{1}", name, config.TentacleMachineNameSuffix);
+
+            return name;
         }
 
         public static ConfigSettings GetConfigSettings()
diff --git a/AzureWebFarm.OctopusDeploy/Infrastructure/AzureRoleEnvironment.cs b/AzureWebFarm.OctopusDeploy/Infrastructure/AzureRoleEnvironment.cs
@@ -0,0 +1,12 @@
+﻿using System;
+using Microsoft.WindowsAzure.ServiceRuntime;
+
+namespace AzureWebFarm.OctopusDeploy.Infrastructure
+{
+    internal static class AzureRoleEnvironment
+    {
+        public static Func<bool> IsAvailable = () => RoleEnvironment.IsAvailable;
+        public static Func<string> CurrentRoleInstanceId = () => IsAvailable() ? RoleEnvironment.CurrentRoleInstance.Id : Environment.MachineName;
+        public static Func<bool> IsEmulated = () => RoleEnvironment.IsEmulated;
+    }
+}
diff --git a/AzureWebFarm.OctopusDeploy/Infrastructure/ConfigSettings.cs b/AzureWebFarm.OctopusDeploy/Infrastructure/ConfigSettings.cs
@@ -3,39 +3,53 @@
 
 namespace AzureWebFarm.OctopusDeploy.Infrastructure
 {
-    internal class ConfigSettings
+    internal interface IConfigSettings {
+        string OctopusServer { get; }
+        string OctopusApiKey { get; }
+        string TentacleEnvironment { get; }
+        string TentacleRole { get; }
+        string TentacleMachineNameSuffix { get; }
+        string TentacleDeploymentsPath { get; }
+        string TentacleInstallPath { get; }
+    }
+
+    internal class ConfigSettings : IConfigSettings
     {
         private const string OctopusServerConfigName = "OctopusServer";
         private const string OctopusApiKeyConfigName = "OctopusApiKey";
         private const string TentacleEnvironmentConfigName = "TentacleEnvironment";
         private const string TentacleRoleConfigName = "TentacleRole";
         private const string TentacleDeploymentsPathConfigName = "Deployments";
         private const string TentacleInstallPathConfigName = "Install";
+        private const string TentacleMachineNameSuffixConfigName = "TentacleMachineNameSuffix";
 
-        private static readonly string[] ConfigSettingsNames = new[] { OctopusServerConfigName, OctopusApiKeyConfigName, TentacleEnvironmentConfigName, TentacleRoleConfigName };
+        private static readonly string[] ConfigSettingsNames = { OctopusServerConfigName, OctopusApiKeyConfigName, TentacleEnvironmentConfigName, TentacleRoleConfigName, TentacleMachineNameSuffixConfigName };
 
         private static string _octopusServer;
         private static string _octopusApiKey;
         private static string _tentacleEnvironment;
         private static string _tentacleRole;
+        private readonly string _tentacleMachineNameSuffix;
         private readonly string _tentacleDeploymentsPath;
         private readonly string _tentacleInstallPath;
-
+        
         public ConfigSettings(Func<string, string> configSettingsGetter, Func<string, string> configPathGetter)
         {
-            _octopusServer = configSettingsGetter(OctopusServerConfigName);
-            _octopusApiKey = configSettingsGetter(OctopusApiKeyConfigName);
-            _tentacleEnvironment = configSettingsGetter(TentacleEnvironmentConfigName);
-            _tentacleRole = configSettingsGetter(TentacleRoleConfigName);
+            _octopusServer = SafeGetConfigSetting(configSettingsGetter, OctopusServerConfigName);
+            _octopusApiKey = SafeGetConfigSetting(configSettingsGetter, OctopusApiKeyConfigName);
+            _tentacleEnvironment = SafeGetConfigSetting(configSettingsGetter, TentacleEnvironmentConfigName);
+            _tentacleRole = SafeGetConfigSetting(configSettingsGetter, TentacleRoleConfigName);
+            _tentacleMachineNameSuffix = SafeGetConfigSetting(configSettingsGetter, TentacleMachineNameSuffixConfigName);
 
-            _tentacleDeploymentsPath = configPathGetter(TentacleDeploymentsPathConfigName);
-            _tentacleInstallPath = configPathGetter(TentacleInstallPathConfigName);
+            _tentacleDeploymentsPath = SafeGetConfigSetting(configPathGetter, TentacleDeploymentsPathConfigName);
+            _tentacleInstallPath = SafeGetConfigSetting(configPathGetter, TentacleInstallPathConfigName);
         }
 
         public string OctopusServer { get { return _octopusServer; } }
         public string OctopusApiKey { get { return _octopusApiKey; } }
         public string TentacleEnvironment { get { return _tentacleEnvironment; } }
         public string TentacleRole { get { return _tentacleRole; } }
+        public string TentacleMachineNameSuffix { get { return _tentacleMachineNameSuffix; } }
 
         public string TentacleDeploymentsPath { get { return _tentacleDeploymentsPath; } }
         public string TentacleInstallPath { get { return _tentacleInstallPath; } }
@@ -44,5 +58,31 @@ public bool IsConfigSettingName(string name)
         {
             return ConfigSettingsNames.Contains(name);
         }
+
+        public string SafeGetConfigSetting(Func<string, string> configSettingsGetter, string settingName)
+        {
+            try
+            {
+                return configSettingsGetter(settingName) ?? "";
+            }
+            catch (Exception e)
+            {
+                throw new UnableToGetConfigSettingException(settingName, e);
+            }
+        }
+    }
+
+    /// <summary>
+    /// Error getting a config setting.
+    /// </summary>
+    public class UnableToGetConfigSettingException : Exception
+    {
+        /// <summary>
+        /// Create the exception for the setting in question.
+        /// </summary>
+        /// <param name="settingName">The name of the setting an error was raised for</param>
+        /// <param name="exception">The exception that was raised when getting the setting</param>
+        public UnableToGetConfigSettingException(string settingName, Exception exception)
+            : base("Unable to get config setting: " + settingName, exception) {}
     }
 }
diff --git a/AzureWebFarm.OctopusDeploy/Infrastructure/OctopusDeploy.cs b/AzureWebFarm.OctopusDeploy/Infrastructure/OctopusDeploy.cs
@@ -110,6 +110,7 @@ public void UninstallTentacle()
             _processRunner.Run(_tentaclePath, string.Format("delete-instance {0} --console", InstanceArg));
             _processRunner.Run("msiexec", string.Format("/uninstall \"{0}{1}\" /quiet", _tentacleInstallPath, "Octopus.Tentacle.msi"));
             _registryEditor.DeleteLocalMachineTree("Software", "Octopus");
+            _processRunner.Run("cmd.exe", string.Format("/c del \"{0}{1}\"", _tentacleInstallPath, "Tentacle.config"));
         }
     }
 }
diff --git a/AzureWebFarm.OctopusDeploy/Infrastructure/RegistryEditor.cs b/AzureWebFarm.OctopusDeploy/Infrastructure/RegistryEditor.cs
@@ -4,8 +4,15 @@
 
 namespace AzureWebFarm.OctopusDeploy.Infrastructure
 {
+    /// <summary>
+    /// Performs edits to the machines local registry.
+    /// </summary>
     public interface IRegistryEditor
     {
+        /// <summary>
+        /// Recursively delete a sub tree from the HKLM node in local registry.
+        /// </summary>
+        /// <param name="pathToTree">The path to the sub tree to delete</param>
         void DeleteLocalMachineTree(params string[] pathToTree);
     }
 
diff --git a/AzureWebFarm.OctopusDeploy/Tools/ServiceConfiguration.cscfg.xdt.xml b/AzureWebFarm.OctopusDeploy/Tools/ServiceConfiguration.cscfg.xdt.xml
@@ -6,6 +6,7 @@
       <x:Setting name="OctopusApiKey" value="API-OCTOPUSAPIKEY" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
       <x:Setting name="TentacleEnvironment" value="ENVIRONMENT" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
       <x:Setting name="TentacleRole" value="ROLE" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
+      <x:Setting name="TentacleMachineNameSuffix" value="" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
     </x:ConfigurationSettings>
   </x:Role>
 </x:ServiceConfiguration>
diff --git a/AzureWebFarm.OctopusDeploy/Tools/ServiceDefinition.csdef.xdt.xml b/AzureWebFarm.OctopusDeploy/Tools/ServiceDefinition.csdef.xdt.xml
@@ -30,6 +30,7 @@
       <x:Setting name="OctopusApiKey" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
       <x:Setting name="TentacleEnvironment" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
       <x:Setting name="TentacleRole" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
+      <x:Setting name="TentacleMachineNameSuffix" xdt:Transform="InsertIfMissing" xdt:Locator="Match(name)" />
     </x:ConfigurationSettings>
   </x:WebRole>
 </x:ServiceDefinition>
diff --git a/AzureWebFarm.OctopusDeploy/WebFarmRole.cs b/AzureWebFarm.OctopusDeploy/WebFarmRole.cs
@@ -79,6 +79,4 @@ public void OnStop()
             IisEnvironment.WaitForAllHttpRequestsToEnd();
         }
     }
-
-    
 }
diff --git a/NextVersion.txt b/NextVersion.txt
@@ -1 +1 @@
-1.1.0
+1.2.0
diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ Pre-requisites
     * `OctopusApiKey` - [API key of a user](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki/Authentication) that has at least the following privileges in the environment you are deploying to: ("Environment manager" and "Project deployer") or ("System administrator")
     * `TentacleEnvironment` - Name of the environment that you want to deploy to
     * `TentacleRole` - Name of the role you want your web farm servers to have
+    * `TentacleMachineNameSuffix` - The suffix to append to the machine name when adding the tentacle to octopus, allows for a single package to be reused with different config for multiple roles.
 * Ensure that you open port 10943 on the Octopus Server so that Polling Tentacles can work, for more information view the documentation (http://docs.octopusdeploy.com/display/OD/Polling+Tentacles).
 * Ensure that if you are using HTTPS (and you should be) for your OctopusDeploy server that the HTTPS certificate is [valid or you include code to trust the invalid certificate](https://github.com/OctopusDeploy/Issues/issues/742)
 * You will need to [set up the website and app pool creation for your OctopusDeploy project](http://docs.octopusdeploy.com/display/OD/IIS+Websites+and+Application+Pools) (including the hostname for your site in the binding(s)) when using this library (since IIS starts off as a blank slate).
