Bug/epiclink not set #51 (#53)

Fixes issue where incorrect epic parent field mapping would cause the tool to err out.

Author: MOlausson

docs/Samples/config-scrum.json

@@ -5,6 +5,7 @@
   "workspace": "C:\\Temp\\JiraExport\\",
   "epic-link-field": "Epic Link",
   "sprint-field": "Sprint",
+  "download-options": 7,
   "batch-size": 20,
   "log-level": "Info",
   "attachment-folder": "Attachments",

docs/config.md

@@ -24,6 +24,7 @@ The migration configuration file is defined in a json file with the properties d
 |**epic-link-field**|False|string|Jira name of epic link field. Default = "Epic Link". **Note:** requires customization per account and sometimes project|
 |**sprint-field**|False|string|Jira name of sprint field. Default = "Sprint". **Note:** requires customization per account and sometimes project|
 |**batch-size**|False|integer|Number of items to retrieve with one call. Default = 20.|
+|**download-options**|False|integer|Type of related issues to migrate, see **Download options** below|
 |**log-level**|False|string|Debug, Info, Warning, Error or Critical. Default = "Debug".|
 |**attachment-folder**|True|string|Location to store attachments.|
 |**user-mapping-file**|False|string|Name of user mapping file. If no specific path is set the program expects it to be located in the "workspace" folder.|
@@ -35,6 +36,18 @@ The migration configuration file is defined in a json file with the properties d
 |**type-map**|True|json|List of the work item **types** you want to migrate from Jira to Azure DevOps/TFS.|
 |**field-map**|True|json|List of **fields** you want to migrate from a Jira item to a Azure DevOps/TFS work item.|
 
+## Download options
+This option allows the tool to download related issues to cover cases where these are not included in the section query (like a parent issue).
+
+Default value: 7 (=all)
+
+|Option|Value|
+|---|---|
+|None|0|
+|IncludeParentEpics|1|
+|IncludeParents|2|
+|IncludeSubItems|4|
+
 ## Link properties
 Name-value pairs of work item link types to map in the migration.
 
@@ -81,6 +94,7 @@ Name-value pairs of field values to map in the migration.
   "workspace": "C:\\Temp\\JiraExport\\",
   "epic-link-field": "Epic Link",
   "sprint-field": "Sprint",
+  "download-options": 7,
   "batch-size": 20,
   "log-level": "Debug",
   "attachment-folder": "Attachments",

src/WorkItemMigrator/JiraExport/App.config

@@ -16,6 +16,6 @@
     </assemblyBinding>
   </runtime>
   <appSettings>
-    <add key="applicationInsightsKey" value="__APP_INSIGHTS_KEY__" />
+    <add key="applicationInsightsKey" value="584b887e-5d80-41c3-8303-9f421d46c421" />
   </appSettings>
 </configuration>

src/WorkItemMigrator/JiraExport/ApplicationInsights.config

@@ -1,26 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
 	<TelemetryInitializers>
-		<Add Type="Microsoft.ApplicationInsights.DependencyCollector.HttpDependenciesParsingTelemetryInitializer, Microsoft.AI.DependencyCollector"/>
 	</TelemetryInitializers>
 	<TelemetryModules>
-		<Add Type="Microsoft.ApplicationInsights.DependencyCollector.DependencyTrackingTelemetryModule, Microsoft.AI.DependencyCollector">
-			<ExcludeComponentCorrelationHttpHeadersOnDomains>
-				<!-- 
-        Requests to the following hostnames will not be modified by adding correlation headers.         
-        Add entries here to exclude additional hostnames.
-        NOTE: this configuration will be lost upon NuGet upgrade.
-        -->
-				<Add>core.windows.net</Add>
-				<Add>core.chinacloudapi.cn</Add>
-				<Add>core.cloudapi.de</Add>
-				<Add>core.usgovcloudapi.net</Add>
-			</ExcludeComponentCorrelationHttpHeadersOnDomains>
-			<IncludeDiagnosticSourceActivities>
-				<Add>Microsoft.Azure.EventHubs</Add>
-				<Add>Microsoft.Azure.ServiceBus</Add>
-			</IncludeDiagnosticSourceActivities>
-		</Add>
 	</TelemetryModules>
 	<ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights"/>
 </ApplicationInsights>

src/WorkItemMigrator/JiraExport/JiraCommandLine.cs

@@ -13,6 +13,7 @@
 using Newtonsoft.Json;
 using Migration.Common.Log;
 using System.Diagnostics;
+using static JiraExport.JiraProvider;
 
 namespace JiraExport
 {
@@ -81,7 +82,7 @@ private void ExecuteMigration(CommandOption user, CommandOption password, Comman
                 // where the logs and journal will be saved, logs aid debugging, journal is for recovery of interupted process
                 string migrationWorkspace = config.Workspace;
 
-                var downloadOptions = JiraProvider.DownloadOptions.IncludeParentEpics | JiraProvider.DownloadOptions.IncludeSubItems | JiraProvider.DownloadOptions.IncludeParents;
+                var downloadOptions = (DownloadOptions)config.DownloadOptions;
 
                 var jiraSettings = new JiraSettings(user.Value(), password.Value(), url.Value(), config.SourceProject)
                 {
@@ -97,9 +98,16 @@ private void ExecuteMigration(CommandOption user, CommandOption password, Comman
 
                 BeginSession(configFileName, config, forceFresh, jiraProvider, itemsCount);
 
-                // Get the custom field names for epic link field and sprint field
                 jiraSettings.EpicLinkField = jiraProvider.GetCustomId(config.EpicLinkField);
+                if(string.IsNullOrEmpty(jiraSettings.EpicLinkField))
+                {
+                    Logger.Log(LogLevel.Warning, $"Epic link field missing for config field '{config.EpicLinkField}'.");
+                }
                 jiraSettings.SprintField = jiraProvider.GetCustomId(config.SprintField);
+                if (string.IsNullOrEmpty(jiraSettings.SprintField))
+                {
+                    Logger.Log(LogLevel.Warning, $"Sprint link field missing for config field '{config.SprintField}'.");
+                }
 
                 var mapper = new JiraMapper(jiraProvider, config);
                 var localProvider = new WiItemProvider(migrationWorkspace);

src/WorkItemMigrator/JiraExport/JiraItem.cs

@@ -383,7 +383,12 @@ private static string[] ParseCustomField(string fieldName, JToken value, JiraPro
         public string Key { get { return RemoteIssue.ExValue<string>("$.key"); } }
         public string Type { get { return RemoteIssue.ExValue<string>("$.fields.issuetype.name")?.Trim(); } }
 
-        public string EpicParent { get { return RemoteIssue.ExValue<string>($"$.fields.{_provider.Settings.EpicLinkField}"); } }
+        public string EpicParent { get {
+                if (!string.IsNullOrEmpty(_provider.Settings.EpicLinkField))
+                    return RemoteIssue.ExValue<string>($"$.fields.{_provider.Settings.EpicLinkField}");
+                else
+                    return null;
+            } }
         public string Parent { get { return RemoteIssue.ExValue<string>("$.fields.parent.key"); } }
         public List<string> SubItems { get { return RemoteIssue.SelectTokens("$.fields.subtasks.[*]", false).Select(st => st.ExValue<string>("$.key")).ToList(); } }
 

src/WorkItemMigrator/JiraExport/JiraProvider.cs

@@ -18,10 +18,8 @@ public enum DownloadOptions
         {
             None = 0,
             IncludeParentEpics = 1,
-            IncludeEpicChildren = 2,
-            IncludeParents = 3,
-            IncludeSubItems = 4,
-            IncludeLinkedItems = 5
+            IncludeParents = 2,
+            IncludeSubItems = 4
         }
 
         readonly Dictionary<string, string> _userEmailCache = new Dictionary<string, string>();
@@ -57,6 +55,7 @@ private static Jira ConnectToJira(JiraSettings jiraSettings)
             try
             {
                 Logger.Log(LogLevel.Info, "Connecting to Jira...");
+
                 jira = Jira.CreateRestClient(jiraSettings.Url, jiraSettings.UserID, jiraSettings.Pass);
             }
             catch (Exception ex)

src/WorkItemMigrator/Migration.Common.Log/Logger.cs

@@ -11,11 +11,11 @@ namespace Migration.Common.Log
 {
     public enum LogLevel
     {
-        Debug,
-        Info,
-        Warning,
-        Error,
-        Critical
+        Debug = 0,
+        Info = 1,
+        Warning = 2,
+        Error = 3,
+        Critical = 4
     }
 
     public static class Logger
@@ -91,18 +91,24 @@ public static void Log(LogLevel level, string message)
 
             if (level == LogLevel.Critical)
             {
-                _errors.Add(message);
+                if(!_errors.Contains(message))
+                    _errors.Add(message);
+
                 Console.Write("Do you want to continue (y/n)? ");
                 var answer = Console.ReadKey();
                 if (answer.Key == ConsoleKey.N)
                     throw new AbortMigrationException(message);
             }
             else if (level == LogLevel.Error)
             {
-                _errors.Add(message);
+                if (!_errors.Contains(message))
+                    _errors.Add(message);
             }
-            else if (level == LogLevel.Warning)
+            else if (level == LogLevel.Warning && !_warnings.Contains(message))
+            {
                 _warnings.Add(message);
+                LogTrace(message, level);
+            }
         }
 
         private static void LogInternal(LogLevel level, string message)
@@ -122,7 +128,13 @@ public static void Log(Exception ex, string message, LogLevel logLevel = LogLeve
             Log(logLevel, $"{message + Environment.NewLine}[{ex.GetType().ToString()}] {ex.ToString()}: {Environment.NewLine + ex.StackTrace}");
         }
 
-        public static void LogEvent(string message, Dictionary<string, string> properties)
+        private static void LogTrace(string message, LogLevel level)
+        {
+            if (_telemetryClient != null)
+                _telemetryClient.TrackTrace(message, (SeverityLevel)level);
+        }
+
+        private static void LogEvent(string message, Dictionary<string, string> properties)
         {
             if (_telemetryClient != null)
                 _telemetryClient.TrackEvent(message, properties);

src/WorkItemMigrator/Migration.Common/Config/ConfigJson.cs

@@ -23,6 +23,9 @@ public class ConfigJson
         [JsonProperty(PropertyName = "sprint-field")]
         public string SprintField { get; set; } = "Sprint";
 
+        [JsonProperty(PropertyName = "download-options")]
+        public int DownloadOptions { get; set; } = 7;   // = All, see DownloadOptions
+
         [JsonProperty(PropertyName = "batch-size")]
         public int BatchSize { get; set; } = 20;
 

src/WorkItemMigrator/WorkItemImport/App.config

@@ -36,6 +36,6 @@
     </assemblyBinding>
   </runtime>
   <appSettings>
-    <add key="applicationInsightsKey" value="__APP_INSIGHTS_KEY__" />
+    <add key="applicationInsightsKey" value="584b887e-5d80-41c3-8303-9f421d46c421" />
   </appSettings>
 </configuration>