Update to check for missing pat! (#1731)

* Update to check for missing pat!

* prevent executution against ADO if not providing a PAT

* Update to funcation

* Update to fix defaults

Author: MrHinsh

docs/Reference/Generated/MigrationTools.Host.xml

@@ -2,15 +2,15 @@
   "profiles": {
     "execute": {
       "commandName": "Project",
-      "commandLineArgs": "execute -c configuration.json"
+      "commandLineArgs": "execute -c \"C:\\temp\\configuration.json\""
     },
     "executepipe": {
       "commandName": "Project",
       "commandLineArgs": "execute -c configuration2-pipeline.json"
     },
     "init": {
       "commandName": "Project",
-      "commandLineArgs": "init --options Full"
+      "commandLineArgs": "init --options Basic"
     },
     "execute2": {
       "commandName": "Project",

src/MigrationTools.ConsoleFull/Properties/launchSettings.json

@@ -8,7 +8,7 @@ public class InitOptions
         [Option('c', "config", Required = false, HelpText = "Configuration file to be processed.")]
         public string ConfigFile { get; set; }
 
-        [Option('o', "options", Required = false, Default = OptionsMode.WorkItemTracking, HelpText = "Configuration file to be processed.")]
+        [Option('o', "options", Required = false, Default = OptionsMode.Basic, HelpText = "Configuration file to be generated: Basic, Reference, WorkItemTracking, Fullv2, WorkItemTrackingv2")]
         public OptionsMode Options { get; set; }
     }
 }

src/MigrationTools.Host/CommandLine/InitOptions.cs

@@ -2,9 +2,10 @@
 {
     public enum OptionsMode
     {
-        Full = 0,
+        Reference = 0,
         WorkItemTracking = 1,
         Fullv2 = 2,
-        WorkItemTrackingv2 = 3
+        WorkItemTrackingv2 = 3,
+        Basic = 4
     }
 }

src/MigrationTools.Host/CommandLine/OptionsMode.cs

@@ -63,8 +63,11 @@ public Task StartAsync(CancellationToken cancellationToken)
                             EngineConfiguration config;
                             switch (_initOptions.Options)
                             {
-                                case OptionsMode.Full:
-                                    config = _configurationBuilder.BuildDefault();
+                                case OptionsMode.Reference:
+                                    config = _configurationBuilder.BuildReference();
+                                    break;
+                                case OptionsMode.Basic:
+                                    config = _configurationBuilder.BuildGettingStarted();
                                     break;
 
                                 case OptionsMode.WorkItemTracking:
@@ -80,7 +83,7 @@ public Task StartAsync(CancellationToken cancellationToken)
                                     break;
 
                                 default:
-                                    config = _configurationBuilder.BuildDefault();
+                                    config = _configurationBuilder.BuildGettingStarted();
                                     break;
                             }
                             _settingWriter.WriteSettings(config, configFile);

src/MigrationTools.Host/InitHostedService.cs

@@ -106,6 +106,30 @@ public EngineConfiguration BuildDefault()
             return ec;
         }
 
+        public EngineConfiguration BuildReference()
+        {
+            EngineConfiguration ec = CreateEmptyConfig();
+            AddExampleFieldMapps(ec);
+            AddWorkItemMigrationDefault(ec);
+            AddTestPlansMigrationDefault(ec);
+            ec.Processors.Add(new ImportProfilePictureConfig());
+            ec.Processors.Add(new ExportProfilePictureFromADConfig());
+            ec.Processors.Add(new FixGitCommitLinksConfig() { TargetRepository = "targetProjectName" });
+            ec.Processors.Add(new WorkItemUpdateConfig());
+            ec.Processors.Add(new WorkItemPostProcessingConfig() { WorkItemIDs = new List<int> { 1, 2, 3 } });
+            ec.Processors.Add(new WorkItemDeleteConfig());
+            ec.Processors.Add(new WorkItemQueryMigrationConfig() { SourceToTargetFieldMappings = new Dictionary<string, string>() { { "SourceFieldRef", "TargetFieldRef" } } });
+            ec.Processors.Add(new TeamMigrationConfig());
+            return ec;
+        }
+
+        public EngineConfiguration BuildGettingStarted()
+        {
+            EngineConfiguration ec = CreateEmptyConfig();
+            AddWorkItemMigrationDefault(ec);
+            return ec;
+        }
+
         public EngineConfiguration BuildWorkItemMigration()
         {
             EngineConfiguration ec = CreateEmptyConfig();
@@ -116,10 +140,7 @@ public EngineConfiguration BuildWorkItemMigration()
 
         private void AddWorkItemMigrationDefault(EngineConfiguration ec)
         {
-            var config = new WorkItemMigrationConfig
-            {
-                NodeBasePaths = new[] { "Product\\Area\\Path1", "Product\\Area\\Path2" }
-            };
+            var config = new WorkItemMigrationConfig();
             ec.Processors.Add(config);
         }
 
@@ -337,5 +358,7 @@ public void WriteSettings(EngineConfiguration engineConfiguration, string settin
 
             File.WriteAllText(settingsFileName, json);
         }
+
+   
     }
 }

src/MigrationTools/_EngineV1/Configuration/EngineConfigurationBuilder.cs

@@ -5,7 +5,8 @@ public interface IEngineConfigurationBuilder
         EngineConfiguration BuildDefault();
 
         EngineConfiguration BuildDefault2();
-
+        EngineConfiguration BuildGettingStarted();
+        EngineConfiguration BuildReference();
         EngineConfiguration BuildWorkItemMigration();
 
         EngineConfiguration BuildWorkItemMigration2();

src/MigrationTools/_EngineV1/Configuration/IEngineConfigurationBuilder.cs

@@ -221,7 +221,7 @@ public WorkItemMigrationConfig()
             UpdateCreatedBy = true;
             PrefixProjectToNodes = false;
             UpdateCreatedDate = true;
-            SkipToFinalRevisedWorkItemType = true;
+            SkipToFinalRevisedWorkItemType = false;
             LinkMigrationSaveEachAsAdded = false;
             GenerateMigrationComment = true;
             WIQLQueryBit = @"AND  [Microsoft.VSTS.Common.ClosedDate] = '' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request')";

src/MigrationTools/_EngineV1/Configuration/Processing/WorkItemMigrationConfig.cs

@@ -12,6 +12,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
+using Microsoft.TeamFoundation.Common;
 using Microsoft.TeamFoundation.WorkItemTracking.Client;
 using Microsoft.TeamFoundation.WorkItemTracking.Proxy;
 using Microsoft.TeamFoundation.WorkItemTracking.WebApi;
@@ -29,6 +30,7 @@
 using MigrationTools.DataContracts;
 using MigrationTools.Enrichers;
 using MigrationTools.ProcessorEnrichers;
+using Newtonsoft.Json.Linq;
 using Serilog.Context;
 using Serilog.Events;
 using ILogger = Serilog.ILogger;
@@ -140,7 +142,9 @@ protected override void InternalExecute()
             {
                 throw new Exception("You must call Configure() first");
             }
-
+            //////////////////////////////////////////////////
+            ValidatePatTokenRequirement();
+            //////////////////////////////////////////////////
             var workItemServer = Engine.Source.GetService<WorkItemServer>();
             attachmentEnricher = new TfsAttachmentEnricher(workItemServer, _config.AttachmentWorkingPath, _config.AttachmentMaxSize);
             embededImagesEnricher = Services.GetRequiredService<TfsEmbededImagesEnricher>();
@@ -167,12 +171,14 @@ protected override void InternalExecute()
                 contextLog.Information("Replay all revisions of {sourceWorkItemsCount} work items?",
                     sourceWorkItems.Count);
 
+
+
                 //////////////////////////////////////////////////
                 contextLog.Information("ValidateTargetNodesExist::Checking all Nodes on Work items");
                 List<NodeStructureMissingItem> nodeStructureMissingItems = _nodeStructureEnricher.GetMissingRevisionNodes(sourceWorkItems);
                 if (_nodeStructureEnricher.ValidateTargetNodesExist(nodeStructureMissingItems))
                 {
-                        throw new Exception("Missing Iterations in Target preventing progress, check log for list. To continue you MUST configure IterationMaps or AreaMaps that matches the missing paths..");
+                    throw new Exception("Missing Iterations in Target preventing progress, check log for list. To continue you MUST configure IterationMaps or AreaMaps that matches the missing paths..");
                 }
 
                 //////////////////////////////////////////////////
@@ -271,6 +277,21 @@ protected override void InternalExecute()
             }
         }
 
+        private void ValidatePatTokenRequirement()
+        {
+            string collUrl = Engine.Target.Config.AsTeamProjectConfig().Collection.ToString();
+            if (collUrl.Contains("dev.azure.com") || collUrl.Contains(".visualstudio.com"))
+            {
+                // Test that
+                if (Engine.Target.Config.AsTeamProjectConfig().PersonalAccessToken.IsNullOrEmpty())
+                {
+                    var ex = new InvalidOperationException("Missing PersonalAccessToken from Target");
+                    Log.LogError(ex, "When you are migrating to Azure DevOps you MUST provide an PAT so that we can call the REST API for certain actions. For example we would be unable to deal with a Work item Type change.");
+                    throw ex;
+                }
+            }
+        }
+
         internal string FixAreaPathAndIterationPathForTargetQuery(string sourceWIQLQueryBit, string sourceProject, string targetProject, ILogger? contextLog)
         {
 
@@ -668,8 +689,10 @@ private WorkItemData ReplayRevisions(List<RevisionItem> revisionsToMigrate, Work
                         destType = Engine.TypeDefinitionMaps.Items[destType].Map();
                     }
                     bool typeChange = (destType != targetWorkItem.Type);
+                    
                     if (typeChange)
                     {
+                        ValidatePatTokenRequirement();
                         Uri collectionUri = Engine.Target.Config.AsTeamProjectConfig().Collection;
                         string token = Engine.Target.Config.AsTeamProjectConfig().PersonalAccessToken;
                         VssConnection connection = new VssConnection(collectionUri, new VssBasicCredential(string.Empty, token));