Refactored the machine suffix addition and added test coverage

Author: robdmoore

AzureWebFarm.OctopusDeploy.Tests/AzureWebFarm.OctopusDeploy.Tests.csproj

@@ -90,6 +90,7 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Infrastructure\AzureEnvironmentTests.cs" />
     <Compile Include="Infrastructure\OctopusDeployTests.cs" />
     <Compile Include="Infrastructure\RegistryEditorTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

AzureWebFarm.OctopusDeploy.Tests/Infrastructure/AzureEnvironmentTests.cs

@@ -0,0 +1,47 @@
+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()
+        {
+            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()
+        {
+            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; }
+    }
+}

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" />

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()

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 = () => IsAvailable() && RoleEnvironment.IsEmulated;
+    }
+}

AzureWebFarm.OctopusDeploy/Infrastructure/ConfigSettings.cs

@@ -3,7 +3,17 @@
 
 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";
@@ -13,7 +23,7 @@ internal class ConfigSettings
         private const string TentacleInstallPathConfigName = "Install";
         private const string TentacleMachineNameSuffixConfigName = "TentacleMachineNameSuffix";
 
-        private static readonly string[] ConfigSettingsNames = new[] { OctopusServerConfigName, OctopusApiKeyConfigName, TentacleEnvironmentConfigName, TentacleRoleConfigName, TentacleMachineNameSuffixConfigName };
+        private static readonly string[] ConfigSettingsNames = { OctopusServerConfigName, OctopusApiKeyConfigName, TentacleEnvironmentConfigName, TentacleRoleConfigName, TentacleMachineNameSuffixConfigName };
 
         private static string _octopusServer;
         private static string _octopusApiKey;

AzureWebFarm.OctopusDeploy/WebFarmRole.cs

@@ -22,7 +22,7 @@ public WebFarmRole(string machineName = null)
             Log.Logger = AzureEnvironment.GetAzureLogger();
             var config = AzureEnvironment.GetConfigSettings();
 
-            machineName = machineName ?? GetMachineName(config);
+            machineName = machineName ?? AzureEnvironment.GetMachineName(config);
             var octopusRepository = Infrastructure.OctopusDeploy.GetRepository(config);
             var processRunner = new ProcessRunner();
             var registryEditor = new RegistryEditor();
@@ -78,17 +78,5 @@ public void OnStop()
             _octopusDeploy.DeleteMachine();
             IisEnvironment.WaitForAllHttpRequestsToEnd();
         }
-
-        private static string GetMachineName(ConfigSettings config)
-        {
-            var machineName = AzureEnvironment.GetMachineName(config);
-
-            if (!string.IsNullOrEmpty(config.TentacleMachineNameSuffix))
-            {
-                machineName = machineName + "_" + config.TentacleMachineNameSuffix;
-            }
-
-            return machineName;
-        }
     }
 }