Merge pull request #830 from solidify/feature/git-artifact-linking-su…

…pport

Feature/git artifact linking support

src/WorkItemMigrator/JiraExport/IJiraProvider.cs

@@ -32,5 +32,6 @@ public interface IJiraProvider
         string GetCustomId(string propertyName);
         Task<List<RevisionAction<JiraAttachment>>> DownloadAttachments(JiraRevision rev);
 
+        IEnumerable<JObject> GetCommitRepositories(string issueId);
     }
 }

src/WorkItemMigrator/JiraExport/JiraCommandLine.cs

@@ -89,7 +89,9 @@ private void ExecuteMigration(CommandOption user, CommandOption password, Comman
                     UserMappingFile = config.UserMappingFile != null ? Path.Combine(migrationWorkspace, config.UserMappingFile) : string.Empty,
                     AttachmentsDir = Path.Combine(migrationWorkspace, config.AttachmentsFolder),
                     JQL = config.Query,
-                    UsingJiraCloud = config.UsingJiraCloud
+                    UsingJiraCloud = config.UsingJiraCloud,
+                    IncludeCommits = config.IncludeCommits,
+                    RepositoryMap = config.RepositoryMap
                 };
 
                 var jiraServiceWrapper = new JiraServiceWrapper(jiraSettings);

src/WorkItemMigrator/JiraExport/JiraCommit.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace JiraExport
+{
+    public class JiraCommit
+    {
+        public string Repository { get; set; }
+        public string Id { get; set; }
+        public DateTime AuthorTimestamp { get; set; }
+    }
+}

src/WorkItemMigrator/JiraExport/JiraItem.cs

@@ -116,6 +116,38 @@ private static List<JiraRevision> BuildRevisions(JiraItem jiraItem, IJiraProvide
 
             List<JiraRevision> commentRevisions = BuildCommentRevisions(jiraItem, jiraProvider);
             listOfRevisions.AddRange(commentRevisions);
+
+            var settings = jiraProvider.GetSettings();
+            if (settings.IncludeCommits)
+            {
+                var commitRepositories = jiraProvider.GetCommitRepositories(jiraItem.Id);
+                foreach (var respository in commitRepositories)
+                {
+                    var commits = respository.SelectTokens(".commits[*]");
+                    foreach (JToken commit in commits)
+                    {
+                        var commitCreatedOn = commit.ExValue<DateTime>("$.authorTimestamp");
+                        var commitAuthor = GetAuthor(commit as JObject);
+                        var jiraCommit = commit.ToObject<JiraCommit>();
+                        var repositoryName = respository.SelectToken("$.name").Value<string>();
+                        if (string.IsNullOrEmpty(repositoryName))
+                        {
+                            continue;
+                        }
+
+                        var hasRespositoryTarget = settings.RepositoryMap.Repositories.Exists(r => r.Source == repositoryName && !string.IsNullOrEmpty(r.Target));
+                        if (!hasRespositoryTarget)
+                        {
+                            continue;
+                        }
+
+                        jiraCommit.Repository = repositoryName;
+                        var commitRevision = new JiraRevision(jiraItem) { Time = commitCreatedOn, Author = commitAuthor, Fields = new Dictionary<string, object>(), Commit = new RevisionAction<JiraCommit>() { ChangeType = RevisionChangeType.Added, Value = jiraCommit } };
+                        listOfRevisions.Add(commitRevision);
+                    }
+                }
+            }
+
             listOfRevisions.Sort();
 
             foreach (var revAndI in listOfRevisions.Select((r, i) => (r, i)))
@@ -524,6 +556,7 @@ private static string[] ParseCustomField(string fieldName, JToken value, IJiraPr
 
         public string Key { get { return RemoteIssue.ExValue<string>("$.key"); } }
         public string Type { get { return RemoteIssue.ExValue<string>("$.fields.issuetype.name")?.Trim(); } }
+        public string Id { get { return RemoteIssue.ExValue<string>("$.id"); } }
         public string EpicParent
         {
             get

src/WorkItemMigrator/JiraExport/JiraMapper.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-
 using Common.Config;
 
 using Migration.Common;
@@ -55,6 +54,7 @@ internal WiItem Map(JiraItem issue)
                     return null;
                 }
             }
+
             return wiItem;
         }
 
@@ -180,6 +180,39 @@ internal Dictionary<string, FieldMapping<JiraRevision>> InitializeFieldMappings(
             return mappingPerWiType;
         }
 
+        internal WiCommit MapCommit(JiraRevision jiraRevision)
+        {
+            if (jiraRevision == null)
+                throw new ArgumentNullException(nameof(jiraRevision));
+
+            if (jiraRevision.Commit == null)
+            {
+                return null;
+            }
+
+            var jiraCommit = jiraRevision.Commit.Value;
+            var respositoryTarget = jiraCommit.Repository;
+
+            var respositoryOverride = _config
+                .RepositoryMap
+                .Repositories?
+                .Find(r => r.Source == respositoryTarget)?
+                .Target;
+
+            if (!string.IsNullOrEmpty(respositoryOverride))
+            {
+                respositoryTarget = respositoryOverride;
+            }
+
+            var commit = new WiCommit()
+            {
+                Id = jiraCommit.Id,
+                Repository = respositoryTarget,
+            };
+
+            return commit;
+        }
+
         internal List<WiLink> MapLinks(JiraRevision r)
         {
             if (r == null)
@@ -303,6 +336,7 @@ internal WiRevision MapRevision(JiraRevision r)
             List<WiAttachment> attachments = MapAttachments(r);
             List<WiField> fields = MapFields(r);
             List<WiLink> links = MapLinks(r);
+            var commit = MapCommit(r);
 
             return new WiRevision()
             {
@@ -313,7 +347,8 @@ internal WiRevision MapRevision(JiraRevision r)
                 Attachments = attachments,
                 Fields = fields,
                 Links = links,
-                AttachmentReferences = attachments.Any()
+                AttachmentReferences = attachments.Any(),
+                Commit = commit
             };
         }
 

src/WorkItemMigrator/JiraExport/JiraProvider.cs

@@ -441,5 +441,11 @@ private string GetItemFromFieldCache(string propertyName, ILookup<string, string
             }
             return customId;
         }
+
+        public IEnumerable<JObject> GetCommitRepositories(string issueId)
+        {
+            var response = (JObject)_jiraServiceWrapper.RestClient.ExecuteRequestAsync(Method.GET, $"/rest/dev-status/latest/issue/detail?issueId={issueId}&applicationType=stash&dataType=repository").Result;
+            return response.SelectTokens("$.detail[*].repositories[*]").Cast<JObject>();
+        }
     }
 }

src/WorkItemMigrator/JiraExport/JiraRevision.cs

@@ -32,6 +32,7 @@ public class JiraRevision : ISourceRevision, IComparable<JiraRevision>
         public List<RevisionAction<JiraLink>> LinkActions { get; set; }
 
         public List<RevisionAction<JiraAttachment>> AttachmentActions { get; set; }
+        public RevisionAction<JiraCommit> Commit { get; set; }
         public JiraItem ParentItem { get; private set; }
         public int Index { get; set; }
 

src/WorkItemMigrator/JiraExport/JiraSettings.cs

@@ -1,4 +1,6 @@
 
+using Migration.Common.Config;
+
 namespace JiraExport
 {
     public class JiraSettings
@@ -14,6 +16,8 @@ public class JiraSettings
         public string AttachmentsDir { get; set; }
         public string JQL { get; set; }
         public bool UsingJiraCloud { get; set; }
+        public bool IncludeCommits { get; set; }
+        public RepositoryMap RepositoryMap { get; set; }
 
         public JiraSettings(string userID, string pass, string url, string project)
         {

src/WorkItemMigrator/JiraExport/jira-export.csproj

@@ -115,6 +115,7 @@
     <Compile Include="IJiraProvider.cs" />
     <Compile Include="IJiraServiceWrapper.cs" />
     <Compile Include="JiraCommandLine.cs" />
+    <Compile Include="JiraCommit.cs" />
     <Compile Include="JiraServiceWrapper.cs" />
     <Compile Include="JiraMapper.cs" />
     <Compile Include="JiraAttachment.cs" />

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

@@ -54,6 +54,9 @@ public class ConfigJson
         [JsonProperty(PropertyName = "process-template")]
         public string ProcessTemplate { get; set; } = "Scrum";
 
+        [JsonProperty(PropertyName = "repository-map")]
+        public RepositoryMap RepositoryMap { get; set; }
+
         [JsonProperty(PropertyName = "type-map", Required = Required.Always)]
         public TypeMap TypeMap { get; set; }
 
@@ -63,13 +66,16 @@ public class ConfigJson
         [JsonProperty(PropertyName = "rendered-fields")]
         public string[] RenderedFields { get; set; } = new string[] { "description", "comment" };
 
-
         [JsonProperty(PropertyName = "using-jira-cloud")]
         public bool UsingJiraCloud { get; set; } = true;
 
         [JsonProperty(PropertyName = "include-link-comments")]
         public bool IncludeLinkComments { get; set; } = true;
+
         [JsonProperty(PropertyName = "sleep-time-between-revision-import-milliseconds")]
         public int SleepTimeBetweenRevisionImportMilliseconds { get; set; } = 0;
+
+        [JsonProperty(PropertyName = "include-commits")]
+        public bool IncludeCommits { get; set; } = true;
     }
 }

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

@@ -87,6 +87,15 @@ public ConfigJson DeserializeText(string input)
                 }
                 result.TypeMap.Types.AddRange(types);
 
+                if(obj.ContainsKey("repository-map"))
+                {
+                    var repositories = obj.SelectToken("repository-map.repository").Select(li => li.ToObject<Repository>()).ToList();
+                    if (result.RepositoryMap.Repositories == null)
+                    {
+                        result.RepositoryMap.Repositories = new List<Repository>();
+                    }
+                    result.RepositoryMap.Repositories.AddRange(repositories);
+                }
             }
             catch (Exception)
             {

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

@@ -0,0 +1,13 @@
+using Newtonsoft.Json;
+
+namespace Migration.Common.Config
+{
+    public class Repository
+    {
+        [JsonProperty("target", Required = Required.Always)]
+        public string Target { get; set; }
+
+        [JsonProperty("source", Required = Required.Always)]
+        public string Source { get; set; }
+    }
+}

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

@@ -0,0 +1,9 @@
+using System.Collections.Generic;
+
+namespace Migration.Common.Config
+{
+    public class RepositoryMap
+    {
+        public List<Repository> Repositories { get; set; }
+    }
+}

src/WorkItemMigrator/Migration.Common/Migration.Common.csproj

@@ -64,6 +64,8 @@
     <Compile Include="Config\Link.cs" />
     <Compile Include="Config\LinkMap.cs" />
     <Compile Include="Config\Mapping.cs" />
+    <Compile Include="Config\RepositoryMap.cs" />
+    <Compile Include="Config\Repository.cs" />
     <Compile Include="Config\Value.cs" />
     <Compile Include="Config\Type.cs" />
     <Compile Include="Config\TypeMap.cs" />

src/WorkItemMigrator/Migration.WIContract/Migration.WIContract.csproj

@@ -46,6 +46,7 @@
   <ItemGroup>
     <Compile Include="WiAttachment.cs" />
     <Compile Include="WiField.cs" />
+    <Compile Include="WiCommit.cs" />
     <Compile Include="WiItem.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="WiItemProvider.cs" />

src/WorkItemMigrator/Migration.WIContract/WiCommit.cs

@@ -0,0 +1,13 @@
+namespace Migration.WIContract
+{
+    public class WiCommit
+    {
+        public string Id { get; set; }
+        public string Repository { get; set; }
+
+        public override string ToString()
+        {
+            return $"[{Repository}]{Id}";
+        }
+    }
+}

src/WorkItemMigrator/Migration.WIContract/WiRevision.cs

@@ -28,6 +28,7 @@ public WiRevision()
         public List<WiField> Fields { get; set; }
         public List<WiLink> Links { get; set; }
         public List<WiAttachment> Attachments { get; set; }
+        public WiCommit Commit { get; set; }
 
         [DefaultValue(false)]
         public bool AttachmentReferences { get; set; } = false;

src/WorkItemMigrator/WorkItemImport/Agent.cs

@@ -120,7 +120,18 @@ public bool ImportRevision(WiRevision rev, WorkItem wi, Settings settings)
                     }
                 }
 
-                _witClientUtils.SaveWorkItemFields(wi);
+                // rev with a commit won't have meaningful information, skip saving fields
+                if (rev.Commit != null)
+                {
+                    if (settings.IncludeCommits)
+                    {
+                        _witClientUtils.SaveWorkItemArtifacts(rev, wi, settings);
+                    }
+                }
+                else
+                {
+                    _witClientUtils.SaveWorkItemFields(wi);
+                }
 
                 if (wi.Id.HasValue)
                 {
@@ -579,7 +590,6 @@ private bool ApplyAndSaveLinks(WiRevision rev, WorkItem wi, bool addLinkComments
 
             return success;
         }
-
         #endregion
     }
 }

src/WorkItemMigrator/WorkItemImport/ImportCommandLine.cs

@@ -91,7 +91,8 @@ private void ExecuteMigration(CommandOption token, CommandOption url, CommandOpt
                     BaseIterationPath = config.BaseIterationPath ?? string.Empty, // Root iteration path that will prefix each iteration
                     IgnoreFailedLinks = config.IgnoreFailedLinks,
                     ProcessTemplate = config.ProcessTemplate,
-                    IncludeLinkComments = config.IncludeLinkComments
+                    IncludeLinkComments = config.IncludeLinkComments,
+                    IncludeCommits = config.IncludeCommits
                 };
 
                 // initialize Azure DevOps/TFS connection. Creates/fetches project, fills area and iteration caches.

src/WorkItemMigrator/WorkItemImport/Settings.cs

@@ -17,5 +17,6 @@ public Settings(string account, string project, string pat)
         public bool IgnoreFailedLinks { get; internal set; }
         public string ProcessTemplate { get; internal set; }
         public bool IncludeLinkComments { get; internal set; }
+        public bool IncludeCommits { get; internal set; }
     }
 }