Add exclusions for work item types in validation (#2898)

MrHinsh · rpollick · web-flow · commit 8238730bf43d · 2025-07-23T08:38:38.000+01:00
- Implemented a check in TfsValidateRequiredFieldTool.cs to skip validation for excluded work item types, with debug logging. - Added an `Exclusions` property in TfsValidateRequiredFieldToolOptions.cs to allow users to specify work item types to exclude from validation, including documentation on its usage. - Removed deprecated commented-out code related to configuration validation in TfsValidateRequiredFieldTool.cs. Resolves: #2897 Co-authored-by: rpollick <rpollick@users.noreply.github.com>
diff --git a/appsettings.json b/appsettings.json
diff --git a/docs/data/classes/reference.endpoints.tfsendpoint.yaml b/docs/data/classes/reference.endpoints.tfsendpoint.yaml
@@ -116,5 +116,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpoint.cs
-optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs
diff --git a/docs/data/classes/reference.endpoints.tfsteamprojectendpoint.yaml b/docs/data/classes/reference.endpoints.tfsteamprojectendpoint.yaml
@@ -112,5 +112,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamProjectEndpoint.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
 optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs
diff --git a/docs/data/classes/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/data/classes/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -53,5 +53,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamSettingsEndpoint.cs
-optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamSettingsEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs
diff --git a/docs/data/classes/reference.endpoints.tfsworkitemendpoint.yaml b/docs/data/classes/reference.endpoints.tfsworkitemendpoint.yaml
@@ -58,5 +58,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpoint.cs
-optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs
diff --git a/docs/data/classes/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/data/classes/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -20,7 +20,7 @@ configurationSamples:
       "Enabled": false,
       "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
       "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
-      "TargetLinksToKeepProject": "c0eff8c5-0c42-4f6a-9b7d-f892eeaf7ad5",
+      "TargetLinksToKeepProject": "10464ecf-816d-4fca-a547-81f230b9069a",
       "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
       "PrependCommand": "start",
       "DryRun": true,
diff --git a/docs/data/classes/reference.tools.tfsvalidaterequiredfieldtool.yaml b/docs/data/classes/reference.tools.tfsvalidaterequiredfieldtool.yaml
@@ -9,15 +9,35 @@ configurationSamples:
 - name: sample
   order: 1
   description: 
-  code: There is no sample, but you can check the classic below for a general feel.
+  code: >-
+    {
+      "MigrationTools": {
+        "Version": "16.0",
+        "CommonTools": {
+          "TfsValidateRequiredFieldTool": {
+            "Enabled": "True",
+            "Exclusions": [
+              "Work Request",
+              "Opertunity",
+              "Assumption"
+            ]
+          }
+        }
+      }
+    }
   sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
 - name: classic
   order: 3
   description: 
   code: >-
     {
       "$type": "TfsValidateRequiredFieldToolOptions",
-      "Enabled": false
+      "Enabled": true,
+      "Exclusions": [
+        "Work Request",
+        "Opertunity",
+        "Assumption"
+      ]
     }
   sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
 description: Tool for validating that required fields exist in target work item types before migration, preventing migration failures due to missing required fields.
@@ -28,6 +48,10 @@ options:
   type: Boolean
   description: If set to `true` then the tool will run. Set to `false` and the processor will not run.
   defaultValue: missing XML code comments
+- parameterName: Exclusions
+  type: List
+  description: 'Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.'
+  defaultValue: '[]'
 status: missing XML code comments
 processingTarget: missing XML code comments
 classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldTool.cs
diff --git a/docs/data/classes/reference.tools.tfsworkitemtypevalidatortool.yaml b/docs/data/classes/reference.tools.tfsworkitemtypevalidatortool.yaml
@@ -0,0 +1,44 @@
+optionsClassName: TfsWorkItemTypeValidatorToolOptions
+optionsClassFullName: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
+configurationSamples:
+- name: defaults
+  order: 2
+  description: 
+  code: There are no defaults! Check the sample for options!
+  sampleFor: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
+- name: sample
+  order: 1
+  description: 
+  code: There is no sample, but you can check the classic below for a general feel.
+  sampleFor: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
+- name: classic
+  order: 3
+  description: 
+  code: >-
+    {
+      "$type": "TfsWorkItemTypeValidatorToolOptions",
+      "Enabled": true,
+      "IncludeWorkItemtypes": [],
+      "FieldMappings": {}
+    }
+  sampleFor: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
+description: missing XML code comments
+className: TfsWorkItemTypeValidatorTool
+typeName: Tools
+options:
+- parameterName: Enabled
+  type: Boolean
+  description: If set to `true` then the tool will run. Set to `false` and the processor will not run.
+  defaultValue: missing XML code comments
+- parameterName: FieldMappings
+  type: Dictionary
+  description: Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.
+  defaultValue: missing XML code comments
+- parameterName: IncludeWorkItemtypes
+  type: List
+  description: List of work item types which will be validated. If this list is empty, all work item types will be validated.
+  defaultValue: missing XML code comments
+status: missing XML code comments
+processingTarget: missing XML code comments
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorTool.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorToolOptions.cs
diff --git a/docs/static/schema/configuration.schema.json b/docs/static/schema/configuration.schema.json
@@ -1429,6 +1429,11 @@
                 "enabled": {
                   "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
                   "type": "boolean"
+                },
+                "exclusions": {
+                  "description": "Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.",
+                  "type": "array",
+                  "default": "[]"
                 }
               }
             },
@@ -1463,6 +1468,25 @@
                 }
               }
             },
+            "tfsworkitemtypevalidatortool": {
+              "title": "TfsWorkItemTypeValidatorTool",
+              "description": "missing XML code comments",
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
+                  "type": "boolean"
+                },
+                "fieldMappings": {
+                  "description": "Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.",
+                  "type": "object"
+                },
+                "includeWorkItemtypes": {
+                  "description": "List of work item types which will be validated. If this list is empty, all work item types will be validated.",
+                  "type": "array"
+                }
+              }
+            },
             "workitemtypemappingtool": {
               "title": "WorkItemTypeMappingTool",
               "description": "Provides mapping functionality for transforming work item types from source to target systems during migration, allowing different work item type names to be used in the target.",
diff --git a/docs/static/schema/schema.tools.tfsvalidaterequiredfieldtool.json b/docs/static/schema/schema.tools.tfsvalidaterequiredfieldtool.json
@@ -8,6 +8,11 @@
     "enabled": {
       "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
       "type": "boolean"
+    },
+    "exclusions": {
+      "description": "Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.",
+      "type": "array",
+      "default": "[]"
     }
   }
 }
diff --git a/docs/static/schema/schema.tools.tfsworkitemtypevalidatortool.json b/docs/static/schema/schema.tools.tfsworkitemtypevalidatortool.json
@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://devopsmigration.io/schema/schema.tools.tfsworkitemtypevalidatortool.json",
+  "title": "TfsWorkItemTypeValidatorTool",
+  "description": "missing XML code comments",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
+      "type": "boolean"
+    },
+    "fieldMappings": {
+      "description": "Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.",
+      "type": "object"
+    },
+    "includeWorkItemtypes": {
+      "description": "List of work item types which will be validated. If this list is empty, all work item types will be validated.",
+      "type": "array"
+    }
+  }
+}
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldTool.cs
@@ -54,6 +54,11 @@ public bool ValidatingRequiredField(TfsProcessor processor, string fieldToFind,
                 {
 
                     var workItemTypeName = sourceWorkItemType.Name;
+                    if (Options.Exclusions.Any(exclusion => string.Equals(exclusion, sourceWorkItemType.Name, StringComparison.OrdinalIgnoreCase)))
+                    {
+                        Log.LogDebug("ValidatingRequiredField: Skipping excluded work item type {WorkItemTypeName}", workItemTypeName);
+                        continue;
+                    }
                     if (workItemTypeMappingTool.Mappings != null && workItemTypeMappingTool.Mappings.ContainsKey(workItemTypeName))
                     {
                         workItemTypeName = workItemTypeMappingTool.Mappings[workItemTypeName];
@@ -79,22 +84,5 @@ public bool ValidatingRequiredField(TfsProcessor processor, string fieldToFind,
             return result;
         }
 
-        //private void ConfigValidation()
-        //{
-        //    //Make sure that the ReflectedWorkItemId field name specified in the config exists in the target process, preferably on each work item type
-        //    var fields = _witClient.GetFieldsAsync(Engine.Target.Config.AsTeamProjectConfig().Project).Result;
-        //    bool rwiidFieldExists = fields.Any(x => x.ReferenceName == Engine.Target.Config.AsTeamProjectConfig().ReflectedWorkItemIdField || x.Name == Engine.Target.Config.AsTeamProjectConfig().ReflectedWorkItemIdField);
-        //    contextLog.Information("Found {FieldsFoundCount} work item fields.", fields.Count.ToString("n0"));
-        //    if (rwiidFieldExists)
-        //        contextLog.Information("Found '{ReflectedWorkItemIdField}' in this project, proceeding.", Engine.Target.Config.AsTeamProjectConfig().ReflectedWorkItemIdField);
-        //    else
-        //    {
-        //        contextLog.Information("Config file specifies '{ReflectedWorkItemIdField}', which wasn't found.", Engine.Target.Config.AsTeamProjectConfig().ReflectedWorkItemIdField);
-        //        contextLog.Information("Instead, found:");
-        //        foreach (var field in fields.OrderBy(x => x.Name))
-        //            contextLog.Information("{FieldType} - {FieldName} - {FieldRefName}", field.Type.ToString().PadLeft(15), field.Name.PadRight(20), field.ReferenceName ?? "");
-        //        throw new Exception("Running a replay migration requires a ReflectedWorkItemId field to be defined in the target project's process.");
-        //    }
-        //}
     }
 }
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldToolOptions.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using MigrationTools.Enrichers;
+﻿using System.Collections.Generic;
 using MigrationTools.Tools.Infrastructure;
 
 namespace MigrationTools.Tools
@@ -9,6 +8,11 @@ namespace MigrationTools.Tools
     /// </summary>
     public class TfsValidateRequiredFieldToolOptions : ToolOptions
     {
-
+        /// <summary>
+        /// Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison.
+        /// WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.
+        /// </summary>
+        /// <default>[]</default>
+        public List<string> Exclusions { get; set; } = new List<string>();
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,11 @@`
`8`	`8`	`"enabled": {`
`9`	`9`	"description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
`10`	`10`	`"type": "boolean"`
	`11`	`+ },`
	`12`	`+ "exclusions": {`
	`13`	`+ "description": "Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.",`
	`14`	`+ "type": "array",`
	`15`	`+ "default": "[]"`
`11`	`16`	`}`
`12`	`17`	`}`
`13`	`18`	`}`