Merge branch 'main' into add-project-name-validatin

MrHinsh · web-flow · commit 3dbd4e1aec20 · 2025-12-04T12:34:02.000-05:00
diff --git a/docs/data/classes/reference.tools.exportworkitemmappingtool.yaml b/docs/data/classes/reference.tools.exportworkitemmappingtool.yaml
@@ -0,0 +1,55 @@
+optionsClassName: ExportWorkItemMappingToolOptions
+optionsClassFullName: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+configurationSamples:
+- name: defaults
+  order: 2
+  description: 
+  code: There are no defaults! Check the sample for options!
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+- name: sample
+  order: 1
+  description: 
+  code: There is no sample, but you can check the classic below for a general feel.
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+- name: classic
+  order: 3
+  description: 
+  code: >-
+    {
+      "$type": "ExportWorkItemMappingToolOptions",
+      "Enabled": false,
+      "TargetFile": "",
+      "PreserveExisting": true
+    }
+  sampleFor: MigrationTools.Tools.ExportWorkItemMappingToolOptions
+description: >-
+  Tool for exporting mappings of work item IDs from source to target.
+   Work item migration processor uses this tool to record work item ID mappings.
+   The mappings will be saved to file defined in options at the end of the migration.
+className: ExportWorkItemMappingTool
+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: true
+  isRequired: false
+  dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+- parameterName: PreserveExisting
+  type: Boolean
+  description: >-
+    Indicates whether existing mappings in the target file should be preserved when saving new mappings.
+     Default value is `true`.
+  defaultValue: true
+  isRequired: false
+  dotNetType: System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+- parameterName: TargetFile
+  type: String
+  description: Path to file, where work item mapping will be saved.
+  defaultValue: ''
+  isRequired: false
+  dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
+status: missing XML code comments
+processingTarget: missing XML code comments
+classFile: src/MigrationTools/Tools/ExportWorkItemMappingTool.cs
+optionsClassFile: src/MigrationTools/Tools/ExportWorkItemMappingToolOptions.cs
diff --git a/docs/data/classes/reference.tools.tfschangesetmappingtool.yaml b/docs/data/classes/reference.tools.tfschangesetmappingtool.yaml
@@ -49,8 +49,8 @@ typeName: Tools
 options:
 - parameterName: ChangeSetMappingFile
   type: String
-  description: missing XML code comments
-  defaultValue: missing XML code comments
+  description: Path to changeset mapping file.
+  defaultValue: null
   isRequired: false
   dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
 - parameterName: Enabled
diff --git a/docs/static/schema/configuration.schema.json b/docs/static/schema/configuration.schema.json
@@ -1731,6 +1731,27 @@
         "CommonTools": {
           "type": "object",
           "properties": {
+            "ExportWorkItemMappingTool": {
+              "title": "ExportWorkItemMappingTool",
+              "description": "Tool for exporting mappings of work item IDs from source to target.\r\n Work item migration processor uses this tool to record work item ID mappings.\r\n The mappings will be saved to file defined in options at the end of the migration.",
+              "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",
+                  "default": "true"
+                },
+                "PreserveExisting": {
+                  "description": "Indicates whether existing mappings in the target file should be preserved when saving new mappings.\r\n Default value is `true`.",
+                  "type": "boolean",
+                  "default": "true"
+                },
+                "TargetFile": {
+                  "description": "Path to file, where work item mapping will be saved.",
+                  "type": "string"
+                }
+              }
+            },
             "FieldMappingTool": {
               "title": "FieldMappingTool",
               "description": "Tool for applying field mapping transformations to work items during migration, supporting various field mapping strategies like direct mapping, regex transformations, and value lookups.",
@@ -2229,8 +2250,9 @@
                   "default": "true"
                 },
                 "ChangeSetMappingFile": {
-                  "description": "missing XML code comments",
-                  "type": "string"
+                  "description": "Path to changeset mapping file.",
+                  "type": "string",
+                  "default": "null"
                 }
               }
             },
diff --git a/docs/static/schema/schema.tools.exportworkitemmappingtool.json b/docs/static/schema/schema.tools.exportworkitemmappingtool.json
@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://devopsmigration.io/schema/schema.tools.exportworkitemmappingtool.json",
+  "title": "ExportWorkItemMappingTool",
+  "description": "Tool for exporting mappings of work item IDs from source to target.\r\n Work item migration processor uses this tool to record work item ID mappings.\r\n The mappings will be saved to file defined in options at the end of the migration.",
+  "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",
+      "default": "true"
+    },
+    "PreserveExisting": {
+      "description": "Indicates whether existing mappings in the target file should be preserved when saving new mappings.\r\n Default value is `true`.",
+      "type": "boolean",
+      "default": "true"
+    },
+    "TargetFile": {
+      "description": "Path to file, where work item mapping will be saved.",
+      "type": "string"
+    }
+  }
+}
diff --git a/docs/static/schema/schema.tools.tfschangesetmappingtool.json b/docs/static/schema/schema.tools.tfschangesetmappingtool.json
@@ -6,8 +6,9 @@
   "type": "object",
   "properties": {
     "ChangeSetMappingFile": {
-      "description": "missing XML code comments",
-      "type": "string"
+      "description": "Path to changeset mapping file.",
+      "type": "string",
+      "default": "null"
     },
     "Enabled": {
       "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
diff --git a/src/MigrationTools.Clients.AzureDevops.Rest.Tests/Processors/AzureDevOpsProcessorTests.cs b/src/MigrationTools.Clients.AzureDevops.Rest.Tests/Processors/AzureDevOpsProcessorTests.cs
@@ -25,6 +25,7 @@ protected AzureDevOpsPipelineProcessor GetAzureDevOpsPipelineProcessor(AzureDevO
             services.AddSingleton<CommonTools>();
             services.AddSingleton<IFieldMappingTool, MockFieldMappingTool>();
             services.AddSingleton<IWorkItemTypeMappingTool, MockWorkItemTypeMappingTool>();
+            services.AddSingleton<IExportWorkItemMappingTool, MockExportWorkItemMappingTool>();
             services.AddSingleton<IStringManipulatorTool, StringManipulatorTool>();
 
             services.AddSingleton<AzureDevOpsPipelineProcessor>();
diff --git a/src/MigrationTools.Clients.TfsObjectModel.Tests/Processors/TfsProcessorTests.cs b/src/MigrationTools.Clients.TfsObjectModel.Tests/Processors/TfsProcessorTests.cs
@@ -38,6 +38,7 @@ protected TfsTeamSettingsProcessor GetTfsTeamSettingsProcessor(TfsTeamSettingsPr
             services.AddSingleton<CommonTools>();
             services.AddSingleton<IFieldMappingTool, MockFieldMappingTool>();
             services.AddSingleton<IWorkItemTypeMappingTool, MockWorkItemTypeMappingTool>();
+            services.AddSingleton<IExportWorkItemMappingTool, MockExportWorkItemMappingTool>();
             services.AddSingleton<IStringManipulatorTool, StringManipulatorTool>();
             services.AddSingleton<IWorkItemQueryBuilderFactory, WorkItemQueryBuilderFactory>();
             services.AddSingleton<IWorkItemQueryBuilder, WorkItemQueryBuilder>();
@@ -107,6 +108,7 @@ protected TfsSharedQueryProcessor GetTfsSharedQueryProcessor(TfsSharedQueryProce
             services.AddSingleton<CommonTools>();
             services.AddSingleton<IFieldMappingTool, MockFieldMappingTool>();
             services.AddSingleton<IWorkItemTypeMappingTool, MockWorkItemTypeMappingTool>();
+            services.AddSingleton<IExportWorkItemMappingTool, MockExportWorkItemMappingTool>();
             services.AddSingleton<IStringManipulatorTool, StringManipulatorTool>();
             services.TryAddScoped<IWorkItemQueryBuilderFactory, WorkItemQueryBuilderFactory>();
 
diff --git a/src/MigrationTools.Clients.TfsObjectModel.Tests/Tools/TfsRevisionManagerTests.cs b/src/MigrationTools.Clients.TfsObjectModel.Tests/Tools/TfsRevisionManagerTests.cs
@@ -19,7 +19,7 @@ private static List<RevisionItem> GetWorkItemWithRevisions(DateTime currentDateT
             for (int i = startHours; i < endHours + startHours; i++)
             {
                 DateTime dateTime = dateIncreasing ? currentDateTime.AddHours(i) : currentDateTime;
-                revisions.Add(i, new RevisionItem() { Index = i, Number = i, ChangedDate = dateTime, OriginalChangedDate = dateTime });
+                revisions.Add(i, new RevisionItem() { Index = i, Number = i, ChangedDate = dateTime, OriginalChangedDate = dateTime, CreatedDate = dateTime, OriginalCreatedDate = dateTime });
             }
 
             return revisions.Values.ToList();
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemConvertor.cs b/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemConvertor.cs
@@ -49,6 +49,8 @@ private SortedDictionary<int, RevisionItem> GetRevisionItems(RevisionCollection
                 Number = (int)x.Fields["System.Rev"].Value,
                 ChangedDate = (DateTime)x.Fields["System.ChangedDate"].Value,
                 OriginalChangedDate = (DateTime)x.Fields["System.ChangedDate"].Value,
+                CreatedDate = (DateTime)x.Fields["System.CreatedDate"].Value,
+                OriginalCreatedDate = (DateTime)x.Fields["System.CreatedDate"].Value,
                 Type = x.Fields["System.WorkItemType"].Value as string,
                 Fields = GetFieldItems(x.Fields)
             }).ToList();
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs b/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs
@@ -235,6 +235,7 @@ protected override void InternalExecute()
             }
             finally
             {
+                CommonTools.ExportWorkItemMapping.SaveMappings();
                 if (Options.FixHtmlAttachmentLinks)
                 {
                     CommonTools.EmbededImages?.ProcessorExecutionEnd(null);
@@ -642,6 +643,7 @@ private async Task ProcessWorkItemAsync(WorkItemData sourceWorkItem, ProgressTim
                         }
                         if (targetWorkItem != null)
                         {
+                            CommonTools.ExportWorkItemMapping.AddMapping(sourceWorkItem.Id, targetWorkItem.Id);
                             targetWorkItem.ToWorkItem().Close();
                         }
                         if (sourceWorkItem != null)
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsChangeSetMappingToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsChangeSetMappingToolOptions.cs
@@ -1,13 +1,13 @@
-﻿using System;
-using MigrationTools.Enrichers;
-using MigrationTools.Tools.Infrastructure;
+﻿using MigrationTools.Tools.Infrastructure;
 
 namespace MigrationTools.Tools
 {
     public class TfsChangeSetMappingToolOptions : ToolOptions
     {
-
+        /// <summary>
+        /// Path to changeset mapping file.
+        /// </summary>
+        /// <default>null</default>
         public string ChangeSetMappingFile { get; set; }
-
     }
-}
+}
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsRevisionManagerTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsRevisionManagerTool.cs
@@ -77,15 +77,23 @@ public List<RevisionItem> GetRevisionsToMigrate(List<RevisionItem> sourceRevisio
         public void EnforceDatesMustBeIncreasing(List<RevisionItem> sortedRevisions)
         {
             Log.LogDebug("TfsRevisionManagerTool::EnforceDatesMustBeIncreasing");
-            DateTime lastDateTime = DateTime.MinValue;
+            DateTime lastChangedDateTime = DateTime.MinValue;
+            DateTime lastCreatedDateTime = DateTime.MinValue;
             foreach (var revision in sortedRevisions)
             {
-                if (revision.ChangedDate == lastDateTime || revision.OriginalChangedDate < lastDateTime)
+                if (revision.ChangedDate == lastChangedDateTime || revision.OriginalChangedDate < lastChangedDateTime)
                 {
-                    revision.ChangedDate = lastDateTime.AddSeconds(1);
-                    Log.LogDebug("TfsRevisionManagerTool::EnforceDatesMustBeIncreasing[{revision}]::Fix", revision.Number);
+                    revision.ChangedDate = lastChangedDateTime.AddSeconds(1);
+                    Log.LogDebug($"TfsRevisionManagerTool::EnforceDatesMustBeIncreasing[{revision.Number}]::Fix ChangedDate");
                 }
-                lastDateTime = revision.ChangedDate;
+                lastChangedDateTime = revision.ChangedDate;
+
+                if (revision.CreatedDate == lastCreatedDateTime || revision.OriginalCreatedDate < lastCreatedDateTime)
+                {
+                    revision.CreatedDate = lastCreatedDateTime.AddSeconds(1);
+                    Log.LogDebug($"TfsRevisionManagerTool::EnforceDatesMustBeIncreasing[{revision.Number}]::Fix CreatedDate");
+                }
+                lastCreatedDateTime = revision.CreatedDate;
             }
         }
 
@@ -171,4 +179,4 @@ public void AttachSourceRevisionHistoryJsonToTarget(WorkItemData sourceWorkItem,
                 });
         }
     }
-}
+}
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsStaticTools.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsStaticTools.cs
@@ -22,6 +22,7 @@ public class TfsCommonTools : CommonTools
         /// <param name="TfsGitRepositoryTool">Tool for git repository operations</param>
         /// <param name="StringManipulatorTool">Tool for string field manipulation</param>
         /// <param name="workItemTypeMapping">Tool for work item type mapping</param>
+        /// <param name="exportWorkItemMapping">Tool for exporting work item mapping.</param>
         /// <param name="workItemTypeValidatorTool">Tool for work item type validation.</param>
         /// <param name="fieldMappingTool">Tool for field mapping operations</param>
         public TfsCommonTools(
@@ -37,9 +38,10 @@ public TfsCommonTools(
             TfsGitRepositoryTool TfsGitRepositoryTool,
             IStringManipulatorTool StringManipulatorTool,
             IWorkItemTypeMappingTool workItemTypeMapping,
+            IExportWorkItemMappingTool exportWorkItemMapping,
             TfsWorkItemTypeValidatorTool workItemTypeValidatorTool,
             IFieldMappingTool fieldMappingTool
-            ) : base(StringManipulatorTool, workItemTypeMapping,fieldMappingTool)
+            ) : base(StringManipulatorTool, workItemTypeMapping, exportWorkItemMapping, fieldMappingTool)
         {
             UserMapping = userMappingEnricher;
             Attachment = attachmentEnricher;
diff --git a/src/MigrationTools.Shadows/Tools/MockExportWorkItemMappingTool.cs b/src/MigrationTools.Shadows/Tools/MockExportWorkItemMappingTool.cs
@@ -0,0 +1,15 @@
+﻿using MigrationTools.Tools.Interfaces;
+
+namespace MigrationTools.Tools.Shadows
+{
+    public class MockExportWorkItemMappingTool : IExportWorkItemMappingTool
+    {
+        public void AddMapping(string sourceId, string targetId)
+        {
+        }
+
+        public void SaveMappings()
+        {
+        }
+    }
+}
diff --git a/src/MigrationTools/DataContracts/RevisionItem.cs b/src/MigrationTools/DataContracts/RevisionItem.cs
@@ -9,10 +9,12 @@ public class RevisionItem
         public int Index { get; set; }
         public int Number { get; set; }
         public DateTime ChangedDate { get; set; }
-
         public DateTime OriginalChangedDate { get; set; }
+
+        public DateTime CreatedDate { get; set; }
+        public DateTime OriginalCreatedDate { get; set; }
         public string Type { get; set; }
         public Dictionary<string, FieldItem> Fields { get; set; }
         public Dictionary<string, EnricherData> EnricherData { get; set; }
     }
-}
+}
diff --git a/src/MigrationTools/ServiceCollectionExtensions.cs b/src/MigrationTools/ServiceCollectionExtensions.cs
@@ -46,6 +46,7 @@ public static void AddMigrationToolServices(this IServiceCollection context, ICo
 
             context.AddSingleton<IStringManipulatorTool, StringManipulatorTool>().AddMigrationToolsOptions<StringManipulatorToolOptions>(configuration);
             context.AddSingleton<IWorkItemTypeMappingTool, WorkItemTypeMappingTool>().AddMigrationToolsOptions<WorkItemTypeMappingToolOptions>(configuration);
+            context.AddSingleton<IExportWorkItemMappingTool, ExportWorkItemMappingTool>().AddMigrationToolsOptions<ExportWorkItemMappingToolOptions, ExportWorkItemMappingToolOptionsValidator>(configuration);
 
             // context.AddSingleton<GitRepoMappingTool>().AddMigrationToolsOptions<GitRepoMappingToolOptions>(configuration);
 
diff --git a/src/MigrationTools/Tools/ExportWorkItemMappingTool.cs b/src/MigrationTools/Tools/ExportWorkItemMappingTool.cs
diff --git a/src/MigrationTools/Tools/ExportWorkItemMappingToolOptions.cs b/src/MigrationTools/Tools/ExportWorkItemMappingToolOptions.cs
diff --git a/src/MigrationTools/Tools/ExportWorkItemMappingToolOptionsValidator.cs b/src/MigrationTools/Tools/ExportWorkItemMappingToolOptionsValidator.cs
diff --git a/src/MigrationTools/Tools/Interfaces/IExportWorkItemMappingTool.cs b/src/MigrationTools/Tools/Interfaces/IExportWorkItemMappingTool.cs
diff --git a/src/MigrationTools/Tools/StaticTools.cs b/src/MigrationTools/Tools/StaticTools.cs

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ private static List<RevisionItem> GetWorkItemWithRevisions(DateTime currentDateT`
`19`	`19`	`for (int i = startHours; i < endHours + startHours; i++)`
`20`	`20`	`{`
`21`	`21`	`DateTime dateTime = dateIncreasing ? currentDateTime.AddHours(i) : currentDateTime;`
`22`		`- revisions.Add(i, new RevisionItem() { Index = i, Number = i, ChangedDate = dateTime, OriginalChangedDate = dateTime });`
	`22`	`+ revisions.Add(i, new RevisionItem() { Index = i, Number = i, ChangedDate = dateTime, OriginalChangedDate = dateTime, CreatedDate = dateTime, OriginalCreatedDate = dateTime });`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`return revisions.Values.ToList();`
Original file line number	Diff line number	Diff line change
`@@ -235,6 +235,7 @@ protected override void InternalExecute()`
`235`	`235`	`}`
`236`	`236`	`finally`
`237`	`237`	`{`
	`238`	`+ CommonTools.ExportWorkItemMapping.SaveMappings();`
`238`	`239`	`if (Options.FixHtmlAttachmentLinks)`
`239`	`240`	`{`
`240`	`241`	`CommonTools.EmbededImages?.ProcessorExecutionEnd(null);`
`@@ -642,6 +643,7 @@ private async Task ProcessWorkItemAsync(WorkItemData sourceWorkItem, ProgressTim`
`642`	`643`	`}`
`643`	`644`	`if (targetWorkItem != null)`
`644`	`645`	`{`
	`646`	`+ CommonTools.ExportWorkItemMapping.AddMapping(sourceWorkItem.Id, targetWorkItem.Id);`
`645`	`647`	`targetWorkItem.ToWorkItem().Close();`
`646`	`648`	`}`
`647`	`649`	`if (sourceWorkItem != null)`