Match users by email

Author: satano

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs

@@ -134,12 +134,40 @@ public List<IdentityMapData> GetUsersInSourceMappedToTarget(TfsProcessor process
                 var sourceUsers = GetUsersListFromServer(processor.Source.GetService<IGroupSecurityService>());
                 Log.LogInformation($"TfsUserMappingTool::GetUsersInSourceMappedToTarget Loading identities from target server");
                 var targetUsers = GetUsersListFromServer(processor.Target.GetService<IGroupSecurityService>());
-                return sourceUsers.Select(sUser => new IdentityMapData { Source = sUser, Target = targetUsers.SingleOrDefault(tUser => tUser.FriendlyName == sUser.FriendlyName) }).ToList();
+
+                if (Options.MatchUsersByEmail)
+                {
+                    Log.LogInformation("TfsUserMappingTool::GetUsersInSourceMappedToTarget "
+                        + "Matching users between source and target by email is enabled. In no match by email is found, "
+                        + "matching by display name will be used.");
+                }
+
+                List<IdentityMapData> identityMap = [];
+                foreach (var sourceUser in sourceUsers)
+                {
+                    IdentityItemData targetUser = null;
+                    if (Options.MatchUsersByEmail && !string.IsNullOrEmpty(sourceUser.MailAddress))
+                    {
+                        var candidates = targetUsers
+                            .Where(tu => tu.MailAddress.Equals(sourceUser.MailAddress, StringComparison.OrdinalIgnoreCase))
+                            .ToList();
+                        if (candidates.Count == 1)
+                        {
+                            // If there are more than one user with the same email address, we can't be sure which one is
+                            // the correct one, so mapping will match either by display name, or will be skipped and
+                            // exported for manual mapping.
+                            targetUser = candidates[0];
+                        }
+                    }
+                    targetUser ??= targetUsers.SingleOrDefault(x => x.DisplayName == sourceUser.DisplayName);
+                    identityMap.Add(new IdentityMapData { Source = sourceUser, Target = targetUser });
+                }
+                return identityMap;
             }
             else
             {
                 Log.LogWarning("TfsUserMappingTool is disabled in settings. You may have users in the source that are not mapped to the target. ");
-                return null;
+                return [];
             }
         }
 

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingToolOptions.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using Microsoft.TeamFoundation.Build.Client;
-using MigrationTools.Enrichers;
+using System.Collections.Generic;
 using MigrationTools.Tools.Infrastructure;
 
 namespace MigrationTools.Tools
@@ -10,7 +7,7 @@ public class TfsUserMappingToolOptions : ToolOptions, ITfsUserMappingToolOptions
     {
 
         /// <summary>
-        /// This is a list of the Identiy fields in the Source to check for user mapping purposes. You should list all identiy fields that you wan to map.
+        /// This is a list of the Identiy fields in the Source to check for user mapping purposes. You should list all identiy fields that you want to map.
         /// </summary>
         public List<string> IdentityFieldsToCheck { get; set; }
 
@@ -19,11 +16,17 @@ public class TfsUserMappingToolOptions : ToolOptions, ITfsUserMappingToolOptions
         /// </summary>
         public string UserMappingFile { get; set; }
 
+        /// <summary>
+        /// By default, users in source are mapped to target users by their display name. If this is set to true, then the
+        /// users will be mapped by their email address first. If no match is found, then the display name will be used.
+        /// </summary>
+        public bool MatchUsersByEmail { get; set; }
     }
 
     public interface ITfsUserMappingToolOptions
     {
         List<string> IdentityFieldsToCheck { get; set; }
         string UserMappingFile { get; set; }
+        bool MatchUsersByEmail { get; set; }
     }
-}
+}