Implement default exclude list for work item type validation (#2971)

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

PR is only a draft for now. What needs to be changed is the place of
default excluded WITs. I have it directly in source now, but it is not
good. This list should be somewhere in configuration file. But I do not
know where to write it, to make this list default in configuration. So I
need your help here @MrHinsh.

Also check the list itself, of you are happy with these WITs to be
excluded by default.

I kept in configuration `IncludeWorkItemtypes` list, but both lists can
not be set at the same time. I do not want to remove this list, because
it means to make some configuration upgrade. But if you think that it
will be better, just navigate me how to do it.

In longer run, I believe, that only the `ExcludeWorkItemtypes` will be
used, mailny because I expect it to be defined by default in
configuration, so people will just use this and not include list.

## Other changes

I made a small change in `ExecuteMigrationCommand`. The value of
`ex.OptionsName` in log was always empty. `OptionsName` is used only,
whe we use _named options_ – which we are not. We use just simple
options pattern, where the options have default name of empty string.

Author: MrHinsh

appsettings.json

@@ -180,7 +180,17 @@
                 }
             },
             "TfsWorkItemTypeValidatorTool": {
-                "Enabled": true
+                "Enabled": true,
+                "ExcludeWorkItemtypes": [
+                    "Code Review Request",
+                    "Code Review Response",
+                    "Feedback Request",
+                    "Feedback Response",
+                    "Shared Parameter",
+                    "Shared Steps"
+                ],
+                "SourceFieldMappings": [],
+                "FixedTargetFields": []
             }
         },
         "CommonToolSamples": {
@@ -192,14 +202,7 @@
             },
             "TfsWorkItemTypeValidatorTool": {
                 "Enabled": true,
-                "IncludeWorkItemtypes": [
-                    "Bug",
-                    "Task",
-                    "User Story",
-                    "Product Backlog Item",
-                    "Feature",
-                    "Epic",
-                    "Risk"
+                "ExcludeWorkItemtypes": [
                 ],
                 "SourceFieldMappings": {
                     "User Story": {

docs/data/classes/reference.tools.tfsworkitemtypevalidatortool.yaml

@@ -10,7 +10,17 @@ configurationSamples:
         "Version": "16.0",
         "CommonTools": {
           "TfsWorkItemTypeValidatorTool": {
-            "Enabled": "True"
+            "Enabled": "True",
+            "ExcludeWorkItemtypes": [
+              "Code Review Request",
+              "Code Review Response",
+              "Feedback Request",
+              "Feedback Response",
+              "Shared Parameter",
+              "Shared Steps"
+            ],
+            "FixedTargetFields": null,
+            "SourceFieldMappings": null
           }
         }
       }
@@ -26,20 +36,12 @@ configurationSamples:
         "CommonTools": {
           "TfsWorkItemTypeValidatorTool": {
             "Enabled": "True",
+            "ExcludeWorkItemtypes": null,
             "FixedTargetFields": {
               "User Story": [
                 "Custom.Prirucka"
               ]
             },
-            "IncludeWorkItemtypes": [
-              "Bug",
-              "Task",
-              "User Story",
-              "Product Backlog Item",
-              "Feature",
-              "Epic",
-              "Risk"
-            ],
             "SourceFieldMappings": {
               "User Story": {
                 "Microsoft.VSTS.Common.Prirucka": "Custom.Prirucka"
@@ -57,14 +59,14 @@ configurationSamples:
     {
       "$type": "TfsWorkItemTypeValidatorToolOptions",
       "Enabled": true,
-      "IncludeWorkItemtypes": [
-        "Bug",
-        "Task",
-        "User Story",
-        "Product Backlog Item",
-        "Feature",
-        "Epic",
-        "Risk"
+      "IncludeWorkItemtypes": [],
+      "ExcludeWorkItemtypes": [
+        "Code Review Request",
+        "Code Review Response",
+        "Feedback Request",
+        "Feedback Response",
+        "Shared Parameter",
+        "Shared Steps"
       ],
       "SourceFieldMappings": {
         "User Story": {
@@ -90,17 +92,23 @@ options:
   defaultValue: true
   isRequired: false
   dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+- parameterName: ExcludeWorkItemtypes
+  type: List
+  description: List of work item types which will be excluded from validation.
+  defaultValue: missing XML code comments
+  isRequired: false
+  dotNetType: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
 - parameterName: FixedTargetFields
   type: Dictionary
   description: >-
-    List of target fields that are considered as `fixed`. 
-     A field marked as fixed will not stop the migration if differences are found. 
-     Instead of a warning, only an informational message will be logged. 
+    List of target fields that are considered as `fixed`.
+     A field marked as fixed will not stop the migration if differences are found.
+     Instead of a warning, only an informational message will be logged.
 
-     Use this list when you already know about the differences and have resolved them, 
-     for example by using `FieldMappingTool`. 
+     Use this list when you already know about the differences and have resolved them,
+     for example by using `FieldMappingTool`.
 
-     The key is the target work item type name. 
+     The key is the target work item type name.
      You can also use `*` to define fixed fields that apply to all work item types.
   defaultValue: null
   isRequired: false

docs/static/schema/configuration.schema.json

@@ -2468,8 +2468,17 @@
                   "type": "boolean",
                   "default": "true"
                 },
+                "ExcludeWorkItemtypes": {
+                  "description": "List of work item types which will be excluded from validation.",
+                  "type": "array",
+                  "prefixItems": [
+                    {
+                      "type": "string"
+                    }
+                  ]
+                },
                 "FixedTargetFields": {
-                  "description": "List of target fields that are considered as `fixed`. \r\n A field marked as fixed will not stop the migration if differences are found. \r\n Instead of a warning, only an informational message will be logged. \r\n\n Use this list when you already know about the differences and have resolved them, \r\n for example by using `FieldMappingTool`. \r\n\n The key is the target work item type name. \r\n You can also use `*` to define fixed fields that apply to all work item types.",
+                  "description": "List of target fields that are considered as `fixed`.\r\n A field marked as fixed will not stop the migration if differences are found.\r\n Instead of a warning, only an informational message will be logged.\r\n\n Use this list when you already know about the differences and have resolved them,\r\n for example by using `FieldMappingTool`.\r\n\n The key is the target work item type name.\r\n You can also use `*` to define fixed fields that apply to all work item types.",
                   "type": "object",
                   "default": "null",
                   "additionalProperties": {

docs/static/schema/schema.tools.tfsworkitemtypevalidatortool.json

@@ -10,8 +10,12 @@
       "type": "boolean",
       "default": "true"
     },
+    "ExcludeWorkItemtypes": {
+      "description": "List of work item types which will be excluded from validation.",
+      "type": "array"
+    },
     "FixedTargetFields": {
-      "description": "List of target fields that are considered as `fixed`. \r\n A field marked as fixed will not stop the migration if differences are found. \r\n Instead of a warning, only an informational message will be logged. \r\n\n Use this list when you already know about the differences and have resolved them, \r\n for example by using `FieldMappingTool`. \r\n\n The key is the target work item type name. \r\n You can also use `*` to define fixed fields that apply to all work item types.",
+      "description": "List of target fields that are considered as `fixed`.\r\n A field marked as fixed will not stop the migration if differences are found.\r\n Instead of a warning, only an informational message will be logged.\r\n\n Use this list when you already know about the differences and have resolved them,\r\n for example by using `FieldMappingTool`.\r\n\n The key is the target work item type name.\r\n You can also use `*` to define fixed fields that apply to all work item types.",
       "type": "object",
       "default": "null"
     },

src/MigrationTools.Clients.TfsObjectModel/ServiceCollectionExtensions.cs

@@ -26,7 +26,7 @@ public static void AddMigrationToolServicesForClientTfs_Tools(this IServiceColle
             context.AddSingleton<TfsRevisionManagerTool>().AddMigrationToolsOptions<TfsRevisionManagerToolOptions>(configuration);
             context.AddSingleton<TfsTeamSettingsTool>().AddMigrationToolsOptions<TfsTeamSettingsToolOptions>(configuration);
             context.AddSingleton<TfsChangeSetMappingTool>().AddMigrationToolsOptions<TfsChangeSetMappingToolOptions>(configuration);
-            context.AddSingleton<TfsWorkItemTypeValidatorTool>().AddMigrationToolsOptions<TfsWorkItemTypeValidatorToolOptions>(configuration);
+            context.AddSingleton<TfsWorkItemTypeValidatorTool>().AddMigrationToolsOptions<TfsWorkItemTypeValidatorToolOptions, TfsWorkItemTypeValidatorToolOptionsValidator>(configuration);
         }
 
         public static void AddMigrationToolServicesForClientTfs_Processors(this IServiceCollection context)

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

@@ -254,6 +254,14 @@ private bool ShouldValidateWorkItemType(string workItemTypeName)
                     workItemTypeName);
                 return false;
             }
+            else if ((Options.ExcludeWorkItemtypes.Count > 0)
+                && Options.ExcludeWorkItemtypes.Contains(workItemTypeName, StringComparer.OrdinalIgnoreCase))
+            {
+                Log.LogInformation(
+                    "Skipping validation of work item type '{sourceWit}' because it is excluded from validation list.",
+                    workItemTypeName);
+                return false;
+            }
             return true;
         }
 

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

@@ -21,6 +21,11 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
         /// <default>null</default>
         public List<string> IncludeWorkItemtypes { get; set; } = [];
 
+        /// <summary>
+        /// List of work item types which will be excluded from validation.
+        /// </summary>
+        public List<string> ExcludeWorkItemtypes { get; set; } = [];
+
         /// <summary>
         /// 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.
@@ -31,17 +36,17 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
 
         /// <summary>
         /// <para>
-        /// List of target fields that are considered as <c>fixed</c>.  
-        /// A field marked as fixed will not stop the migration if differences are found.  
-        /// Instead of a warning, only an informational message will be logged.  
+        /// List of target fields that are considered as <c>fixed</c>.
+        /// A field marked as fixed will not stop the migration if differences are found.
+        /// Instead of a warning, only an informational message will be logged.
         /// </para>
         /// <para>
-        /// Use this list when you already know about the differences and have resolved them,  
-        /// for example by using <see cref="FieldMappingTool"/>.  
+        /// Use this list when you already know about the differences and have resolved them,
+        /// for example by using <see cref="FieldMappingTool"/>.
         /// </para>
         /// <para>
-        /// The key is the target work item type name.  
-        /// You can also use <c>*</c> to define fixed fields that apply to all work item types.  
+        /// The key is the target work item type name.
+        /// You can also use <c>*</c> to define fixed fields that apply to all work item types.
         /// </para>
         /// </summary>
         /// <default>null</default>
@@ -84,6 +89,7 @@ public void Normalize()
             }
 
             IncludeWorkItemtypes ??= [];
+            ExcludeWorkItemtypes ??= [];
             FixedTargetFields = newFixedFields;
             SourceFieldMappings = newMappings;
             _isNormalized = true;

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

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.Options;
+
+namespace MigrationTools.Tools
+{
+    public class TfsWorkItemTypeValidatorToolOptionsValidator : IValidateOptions<TfsWorkItemTypeValidatorToolOptions>
+    {
+        public ValidateOptionsResult Validate(string name, TfsWorkItemTypeValidatorToolOptions options)
+        {
+            int includedCount = options.IncludeWorkItemtypes?.Count ?? 0;
+            int excludedCount = options.ExcludeWorkItemtypes?.Count ?? 0;
+
+            if ((includedCount > 0) && (excludedCount > 0))
+            {
+                const string msg = $"'{nameof(options.IncludeWorkItemtypes)}' and '{nameof(options.ExcludeWorkItemtypes)}'"
+                    + $" cannot be set both at the same time.";
+                return ValidateOptionsResult.Fail(msg);
+            }
+            return ValidateOptionsResult.Success;
+        }
+    }
+}

src/MigrationTools.Host/Commands/ExecuteMigrationCommand.cs

@@ -65,7 +65,7 @@ internal override Task<int> ExecuteInternalAsync(CommandContext context, Execute
                 CommandActivity.RecordException(ex);
                 _logger.LogCritical("The config contains some invalid options. Please check the list below and refer to https://devopsmigration.io/ for the specific configration options.");
                 _logger.LogCritical("------------");
-                _logger.LogCritical("OptionName: {OptionsName}", ex.OptionsName);
+                _logger.LogCritical("OptionName: {OptionsName}", GetOptionsName(ex));
                 _logger.LogCritical("The following options are invalid:");
                 foreach (var failure in ex.Failures)
                 {
@@ -89,6 +89,16 @@ internal override Task<int> ExecuteInternalAsync(CommandContext context, Execute
             }
             return Task.FromResult(_exitCode);
         }
+
+        private string GetOptionsName(OptionsValidationException ex)
+        {
+            IOptions options = Activator.CreateInstance(ex.OptionsType) as IOptions;
+            if (options is not null)
+            {
+                return options.ConfigurationMetadata.OptionFor;
+            }
+            return string.Empty;
+        }
     }
 }