Validation of reflected work item ID is mandatory (#2963)

This PR solves the first item in [improve work item type validation
list](#2951).

Reflected work item ID is mandatory for proper work item migration. So
validation of this field is performed always, even if the validator tool
itself is disabled. This field was validated always before my addition
to validate full work item types, so I just returned back the old
behavior.

Author: MrHinsh

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs

@@ -254,24 +254,25 @@ private void ValidateWorkItemTypes()
             Log.LogInformation("Starting Pre-Validation: Validating work item types and fields with `WorkItemTypeValidatorTool`.");
             Log.LogInformation("Refer to https://devopsmigration.io/TfsWorkItemTypeValidatorTool/ for configuration.");
             Log.LogInformation("------------------------------------");
+
+            var sourceWits = Source.WorkItems.Project
+                .ToProject()
+                .WorkItemTypes
+                .Cast<WorkItemType>()
+                .ToList();
+            var targetWits = Target.WorkItems.Project
+                .ToProject()
+                .WorkItemTypes
+                .Cast<WorkItemType>()
+                .ToList();
+
+            // Reflected work item ID field is mandatory for migration, so it is validated even if the validator tool is disabled.
+            bool containsReflectedWorkItemId = CommonTools.WorkItemTypeValidatorTool.ValidateReflectedWorkItemIdField(
+                sourceWits, targetWits, Target.Options.ReflectedWorkItemIdField);
+            bool validationResult = true;
             if (CommonTools.WorkItemTypeValidatorTool.Enabled)
             {
-                var sourceWits = Source.WorkItems.Project
-                    .ToProject()
-                    .WorkItemTypes
-                    .Cast<WorkItemType>()
-                    .ToList();
-                var targetWits = Target.WorkItems.Project
-                    .ToProject()
-                    .WorkItemTypes
-                    .Cast<WorkItemType>()
-                    .ToList();
-                if (!CommonTools.WorkItemTypeValidatorTool.ValidateWorkItemTypes(
-                    sourceWits, targetWits, Target.Options.ReflectedWorkItemIdField))
-                {
-                    Log.LogError("Validation of work item types failed.");
-                    Environment.Exit(-1);
-                }
+                validationResult = CommonTools.WorkItemTypeValidatorTool.ValidateWorkItemTypes(sourceWits, targetWits);
             }
             else
             {
@@ -281,6 +282,11 @@ private void ValidateWorkItemTypes()
                     + " or migration may not work at all.";
                 Log.LogWarning(msg);
             }
+            if (!containsReflectedWorkItemId || !validationResult)
+            {
+                Log.LogError("Validation of work item types failed.");
+                Environment.Exit(-1);
+            }
             Log.LogInformation("------------------------------------");
             Log.LogInformation("[/ValidateWorkItemTypes]");
         }

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemTypeValidatorProcessor.cs

@@ -47,11 +47,16 @@ protected override void InternalExecute()
                 .WorkItemTypes
                 .Cast<WorkItemType>()
                 .ToList();
+            bool containsReflectedWorkItemId = CommonTools.WorkItemTypeValidatorTool
+                .ValidateReflectedWorkItemIdField(sourceWits, targetWits, Target.Options.ReflectedWorkItemIdField);
             bool validationResult = CommonTools.WorkItemTypeValidatorTool
-                .ValidateWorkItemTypes(sourceWits, targetWits, Target.Options.ReflectedWorkItemIdField);
-            if (Options.StopIfValidationFails && !validationResult)
+                .ValidateWorkItemTypes(sourceWits, targetWits);
+            if ((Options.StopIfValidationFails && !validationResult) || (!containsReflectedWorkItemId))
             {
-                Log.LogInformation($"'{nameof(Options.StopIfValidationFails)}' is set to 'true', so migration process will stop now.");
+                const string message =
+                    "Either the reflected work item type ID field '{ReflectedWorkItemIdField}' is missing in some of the target work item types"
+                    + $" or '{nameof(Options.StopIfValidationFails)}' is set to 'true', so migration process will stop now.";
+                Log.LogInformation(message, Target.Options.ReflectedWorkItemIdField);
                 Environment.Exit(-1);
             }
         }

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

@@ -30,10 +30,55 @@ public TfsWorkItemTypeValidatorTool(
             Options.Normalize();
         }
 
-        public bool ValidateWorkItemTypes(
+        public bool ValidateReflectedWorkItemIdField(
             List<WorkItemType> sourceWits,
             List<WorkItemType> targetWits,
             string reflectedWorkItemIdField)
+        {
+            Log.LogInformation("Validating presence of reflected work item ID field '{reflectedWorkItemIdField}'"
+                + " in target work item types.", reflectedWorkItemIdField);
+            bool isValid = true;
+            List<WorkItemType> wits = GetTargetWitsToValidate(sourceWits, targetWits);
+            foreach (WorkItemType targetWit in wits)
+            {
+                if (targetWit.FieldDefinitions.Contains(reflectedWorkItemIdField))
+                {
+                    Log.LogDebug("  '{targetWit}' contains reflected work item ID field '{fieldName}'.",
+                        targetWit.Name, reflectedWorkItemIdField);
+                }
+                else
+                {
+                    Log.LogError("  '{targetWit}' does not contain reflected work item ID field '{fieldName}'.",
+                        targetWit.Name, reflectedWorkItemIdField);
+                    isValid = false;
+                }
+            }
+            LogReflectedWorkItemIdValidationResult(isValid, reflectedWorkItemIdField);
+            return isValid;
+        }
+
+        private List<WorkItemType> GetTargetWitsToValidate(List<WorkItemType> sourceWits, List<WorkItemType> targetWits)
+        {
+            List<WorkItemType> targetWitsToValidate = [];
+            foreach (WorkItemType sourceWit in sourceWits)
+            {
+                string sourceWitName = sourceWit.Name;
+                if (!ShouldValidateWorkItemType(sourceWitName))
+                {
+                    continue;
+                }
+                string targetWitName = GetTargetWorkItemType(sourceWitName);
+                WorkItemType targetWit = targetWits
+                    .FirstOrDefault(wit => wit.Name.Equals(targetWitName, StringComparison.OrdinalIgnoreCase));
+                if (targetWit is not null)
+                {
+                    targetWitsToValidate.Add(targetWit);
+                }
+            }
+            return targetWitsToValidate;
+        }
+
+        public bool ValidateWorkItemTypes(List<WorkItemType> sourceWits, List<WorkItemType> targetWits)
         {
             LogWorkItemTypes(sourceWits, targetWits);
 
@@ -61,10 +106,6 @@ public bool ValidateWorkItemTypes(
                 }
                 else
                 {
-                    if (!ValidateReflectedWorkItemIdField(targetWit, reflectedWorkItemIdField))
-                    {
-                        isValid = false;
-                    }
                     if (!ValidateWorkItemTypeFields(sourceWit, targetWit))
                     {
                         isValid = false;
@@ -75,22 +116,6 @@ public bool ValidateWorkItemTypes(
             return isValid;
         }
 
-        private bool ValidateReflectedWorkItemIdField(WorkItemType targetWit, string reflectedWorkItemIdField)
-        {
-            if (targetWit.FieldDefinitions.Contains(reflectedWorkItemIdField))
-            {
-                Log.LogDebug("  '{targetWit}' contains reflected work item ID field '{fieldName}'.",
-                    targetWit.Name, reflectedWorkItemIdField);
-            }
-            else
-            {
-                Log.LogWarning("  '{targetWit}' does not contain reflected work item ID field '{fieldName}'.",
-                    targetWit.Name, reflectedWorkItemIdField);
-                return false;
-            }
-            return true;
-        }
-
         private bool ValidateWorkItemTypeFields(WorkItemType sourceWit, WorkItemType targetWit)
         {
             bool result = true;
@@ -266,6 +291,21 @@ private void LogWorkItemTypes(ICollection<WorkItemType> sourceWits, ICollection<
                 string.Join(", ", targetWits.Select(wit => wit.Name)));
         }
 
+        private void LogReflectedWorkItemIdValidationResult(bool isValid, string reflectedWorkItemIdField)
+        {
+            if (isValid)
+            {
+                Log.LogInformation("All work item types have reflected work item ID field '{reflectedWorkItemIdField}'.",
+                    reflectedWorkItemIdField);
+                return;
+            }
+
+            const string message = "Reflected work item ID field is mandatory for work item migration."
+                + " You can configure name of this field in target TFS endpoint settings as 'ReflectedWorkItemIdField' property."
+                + " Your current configured name of the field is '{reflectedWorkItemIdField}'.";
+            Log.LogError(message, reflectedWorkItemIdField);
+        }
+
         private void LogValidationResult(bool isValid)
         {
             if (isValid)