From 7165c5ce48c5a97a641c942ca02566e25c256b3e Mon Sep 17 00:00:00 2001
From: "Martin Hinshelwood nkdAgility.com" <martin@nkdagility.com>
Date: Thu, 3 Oct 2024 07:39:34 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20(configuration.json):=20add=20Tf?=
 =?UTF-8?q?sUserMappingTool=20configuration=20for=20user=20mapping?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

💡 (TfsUserMappingTool.cs): improve error handling for missing user mapping file

📝 (MigrationTools.xml): update documentation with new version details

The TfsUserMappingTool configuration is added to the configuration.json to enable user mapping functionality, specifying the file path and identity fields to check. This change allows for more flexible user identity management during migrations. In TfsUserMappingTool.cs, error handling is improved by logging an error message when the user mapping file is missing, ensuring users are informed of configuration issues. The MigrationTools.xml documentation is updated to reflect the new version, ensuring consistency and clarity in version tracking.
---
 configuration.json                                 | 12 ++++++++++++
 docs/Reference/Generated/MigrationTools.xml        | 14 +++++++-------
 .../Tools/TfsUserMappingTool.cs                    | 14 ++++++--------
 3 files changed, 25 insertions(+), 15 deletions(-)

diff --git a/configuration.json b/configuration.json
index 1189db046..065a41e21 100644
--- a/configuration.json
+++ b/configuration.json
@@ -132,6 +132,18 @@
         "UpdateTeamSettings": true,
         "MigrateTeamCapacities": true,
         "Teams": [ "Team 1", "Team 2" ]
+      },
+      "TfsUserMappingTool": {
+        "Enabled": true,
+        "UserMappingFile": "C:\\temp\\userExport.json",
+        "IdentityFieldsToCheck": [
+          "System.AssignedTo",
+          "System.ChangedBy",
+          "System.CreatedBy",
+          "Microsoft.VSTS.Common.ActivatedBy",
+          "Microsoft.VSTS.Common.ResolvedBy",
+          "Microsoft.VSTS.Common.ClosedBy"
+        ]
       }
     },
     "Processors": [
diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
index 1f71e8ec5..8b9e5a253 100644
--- a/docs/Reference/Generated/MigrationTools.xml
+++ b/docs/Reference/Generated/MigrationTools.xml
@@ -263,17 +263,17 @@
         </member>
         <member name="F:ThisAssembly.Git.Commit">
             <summary>
-            => @"cf9e4445"
+            => @"23fae28b"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.Sha">
             <summary>
-            => @"cf9e4445856c9cb732b3bcc438d2d3fc23b3fa23"
+            => @"23fae28bfbd54ac74475334e64dc733a9fd28131"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.CommitDate">
             <summary>
-            => @"2024-09-23T16:40:10+01:00"
+            => @"2024-09-24T15:02:38+01:00"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.Commits">
@@ -283,12 +283,12 @@
         </member>
         <member name="F:ThisAssembly.Git.Tag">
             <summary>
-            => @"v16.0.4-Preview.4-4-gcf9e4445"
+            => @"v16.0.4-Preview.5-4-g23fae28b"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.BaseTag">
             <summary>
-            => @"v16.0.4-Preview.4"
+            => @"v16.0.4-Preview.5"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.BaseVersion.Major">
@@ -323,12 +323,12 @@
         </member>
         <member name="F:ThisAssembly.Git.SemVer.Label">
             <summary>
-            => @"Preview.4"
+            => @"Preview.5"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.SemVer.DashLabel">
             <summary>
-            => @"-Preview.4"
+            => @"-Preview.5"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.SemVer.Source">
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
index 3570828ce..49559daad 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
@@ -86,7 +86,12 @@ public void MapUserIdentityField(TfsProcessor processor, Field field)
 
         private Dictionary<string, string> GetMappingFileData()
         {
-            if (_UserMappings == null && System.IO.File.Exists(Options.UserMappingFile))
+            if (!System.IO.File.Exists(Options.UserMappingFile))
+            {
+                Log.LogError("TfsUserMappingTool::GetMappingFileData:: The UserMappingFile '{UserMappingFile}' cant be found! Provide a valid file or disable TfsUserMappingTool!", Options.UserMappingFile);
+                _UserMappings = new Dictionary<string, string>();
+            }
+            if (_UserMappings == null)
             {
                 var fileData = System.IO.File.ReadAllText(Options.UserMappingFile);
                 try
@@ -101,14 +106,7 @@ private Dictionary<string, string> GetMappingFileData()
                 }
 
             }
-            else
-            {
-                Log.LogError($"TfsUserMappingTool::GetMappingFileData::No User Mapping file Provided! Provide file or disable TfsUserMappingTool");
-                _UserMappings = new Dictionary<string, string>();
-            }
-
             return _UserMappings;
-
         }
 
         private List<IdentityItemData> GetUsersListFromServer(IGroupSecurityService gss)