Merge pull request #4458 from cormacpayne/telemetry-test

Add tests and null checks around MAC address functionality

Author: markcowl

src/Common/Commands.Common/MetricHelper.cs

@@ -62,10 +62,13 @@ private static string HashMacAddress
             {
                 if (_hashMacAddress == string.Empty)
                 {
-                    var macAddress = NetworkInterface.GetAllNetworkInterfaces()
-                        .FirstOrDefault(nic => nic.OperationalStatus == OperationalStatus.Up)?
+                    var macAddress = NetworkInterface.GetAllNetworkInterfaces()?
+                        .FirstOrDefault(nic => nic != null && 
+                                               nic.OperationalStatus == OperationalStatus.Up &&
+                                               nic.GetPhysicalAddress() != null &&
+                                               !string.IsNullOrWhiteSpace(nic.GetPhysicalAddress().ToString()))?
                         .GetPhysicalAddress()?.ToString();
-                    _hashMacAddress = macAddress == null ? null : GenerateSha256HashString(macAddress).Replace("-", string.Empty).ToLowerInvariant();
+                    _hashMacAddress = string.IsNullOrWhiteSpace(macAddress) ? null : GenerateSha256HashString(macAddress)?.Replace("-", string.Empty)?.ToLowerInvariant();
                 }
 
                 return _hashMacAddress;
@@ -246,7 +249,7 @@ public static string GenerateSha256HashString(string originInput)
         {
             if (string.IsNullOrWhiteSpace(originInput))
             {
-                throw new ArgumentNullException("originInput");
+                return string.Empty;
             }
 
             using (var sha256 = new SHA256CryptoServiceProvider())

src/ResourceManager/Common/Commands.ResourceManager.Common/AzureRMCmdlet.cs

@@ -225,7 +225,7 @@ protected override void InitializeQosEvent()
             if (this.DefaultProfile != null &&
                 this.DefaultProfile.DefaultContext != null &&
                 this.DefaultProfile.DefaultContext.Account != null &&
-                this.DefaultProfile.DefaultContext.Account.Id != null)
+                !string.IsNullOrWhiteSpace(this.DefaultProfile.DefaultContext.Account.Id))
             {
                 _qosEvent.Uid = MetricHelper.GenerateSha256HashString(
                     this.DefaultProfile.DefaultContext.Account.Id.ToString());

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

@@ -14,7 +14,9 @@
 
 using Microsoft.WindowsAzure.Commands.Common;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
+using Moq;
 using System;
+using System.Net.NetworkInformation;
 using Xunit;
 
 namespace Microsoft.Azure.Commands.Profile.Test
@@ -23,9 +25,11 @@ public class TelemetryTests
     {
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
-        public void HashOfNullValueThrowsAppropriateException()
+        public void HashOfNullOrWhitespaceValueReturnsEmptyString()
         {
-            Assert.Throws<ArgumentNullException>(() => MetricHelper.GenerateSha256HashString(null));
+            Assert.Equal(string.Empty, MetricHelper.GenerateSha256HashString(null));
+            Assert.Equal(string.Empty, MetricHelper.GenerateSha256HashString(string.Empty));
+            Assert.Equal(string.Empty, MetricHelper.GenerateSha256HashString(" "));
         }
 
         [Fact]
@@ -38,5 +42,15 @@ public void HashOfValidValueSucceeds()
             Assert.True(hash.Length > 0);
             Assert.NotEqual<string>(inputValue, hash, StringComparer.OrdinalIgnoreCase);
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void NetworkInterfaceWithEmptyAddressReturnsEmptyString()
+        {
+            var address = new PhysicalAddress(new byte[] { } );
+            Assert.Equal(string.Empty, address.ToString());
+            var hashAddress = MetricHelper.GenerateSha256HashString(address.ToString());
+            Assert.Equal(string.Empty, hashAddress);
+        }
     }
 }

src/ServiceManagement/Common/Commands.ServiceManagement.Common/AzureSMCmdlet.cs

@@ -111,7 +111,7 @@ protected override void InitializeQosEvent()
 
             if (this.DefaultContext != null &&
                 this.DefaultContext.Account != null &&
-                this.DefaultContext.Account.Id != null)
+                !string.IsNullOrEmpty(this.DefaultContext.Account.Id))
             {
                 _qosEvent.Uid = MetricHelper.GenerateSha256HashString(
                     this.DefaultContext.Account.Id.ToString());