代码之家  ›  专栏  ›  技术社区  ›  Eugene Podskal

如何确定分支是否包含带有TFS WebAPI客户端库的提交?

  •  0
  • Eugene Podskal  · 技术社区  · 7 年前

    基本上我想找一个API替代 git branch --contains 使用TFS WebAPI client libraries :

    var commitId = "123456789abcdef";
    var branchName = "branch";
    var tpc = new TfsTeamProjectCollection(new Uri(""));
    var git = tpc.GetClient<GitHttpClient>();
    var isInBranch = git.?????(branchName, commitId);
    

    有没有办法做到?

    还是应该使用git.exe/libgit在本地克隆上操作(有问题的存储库太大了,如果可能,我更愿意避免克隆它)?

    2 回复  |  直到 7 年前
        1
  •  1
  •   PatrickLu-MSFT    7 年前

    没有对应于git branch--contains命令的任何WebAPI客户端库。

    但是作为一种解决方法,您可以直接在C代码中运行git命令。

    string gitCommand = "git";
    string gitAddArgument = @"add -A" ;
    string gitCommitArgument = @"commit ""explanations_of_changes"" "
    string gitPushArgument = @"push our_remote"
    
    Process.Start(gitCommand, gitAddArgument );
    Process.Start(gitCommand, gitCommitArgument );
    Process.Start(gitCommand, gitPushArgument );
    

    您可以包含您的证书,更多详细信息请参阅 Run git commands from a C# function

    另一种方法是使用PowerShell脚本运行git命令并调用tfs api。

        2
  •  0
  •   Eugene Podskal    6 年前

    有一种方法可以使用当前可访问的API来实现它——获取提交时间,然后检查在该时间间隔内此类提交是否在分支中,尽管它需要两个单独的调用,并且可能有一些 问题 用:

    1. Committer date vs Author date -我使用的是提交日期,但没有花足够的时间来真正检查它。

    用法是:

    GitHttpClient git = ...;
    var isInBranch = git.BranchContains(
        project: "project",
        repositoryId: "repository",
        branch: "master",
        commitId: "12345678910...")
    

    代码是:

    public static class GitHttpClientExt
    {
        /// <summary>
        /// Gets a value indicating whether a branch with name <paramref name="branch"/> (like 'master', 'dev') contains the commit with specified <paramref name="commitId"/>.
        /// Just like the <code>git branch --contains</code> it doesn't take possible reversions into account.
        /// </summary>
        public static Boolean BranchContains(this GitHttpClient git, String project, String repositoryId, String branch, String commitId)
        {
            var commitToFind = git.TryGetCommit(project: project, repositoryId: repositoryId, commitId: commitId);
            if (commitToFind == null)
            {
                return false;
            }
            var committedDate = commitToFind.Committer.Date; // TODO: It will usually be the same as the author's, but I have failed to check what date TFS actually uses in date queries.
            var criteria = new GitQueryCommitsCriteria
            {
                ItemVersion = new GitVersionDescriptor
                {
                    Version = branch,
                    VersionType = GitVersionType.Branch
                },
                FromDate = DateToString(committedDate.AddSeconds(-1)), // Zero length interval seems to work, but just in case
                ToDate = DateToString(committedDate.AddSeconds(1)),
            };
            var commitIds = git
                .GetAllCommits(
                    project: project, 
                    repositoryId: repositoryId,
                    searchCriteria: criteria)
                .Select(c => c.CommitId);
            return commitIds.Contains(commitId);
        }
    
        /// <summary>
        /// Gets the string representation of <paramref name="dateTime"/> usable in query objects for <see cref="GitHttpClient"/>.
        /// </summary>
        public static String DateToString(DateTimeOffset dateTime)
        {
            return dateTime.ToString(CultureInfo.InvariantCulture);
        }
    
        /// <summary>Tries to retrieve git commit with specified <paramref name="commitId"/> for a project.</summary>
        public static GitCommitRef TryGetCommit(this GitHttpClient git, String project, String repositoryId, String commitId)
        {
            return git
                .GetAllCommits(
                    project: project,
                    repositoryId: repositoryId,
                    searchCriteria: new GitQueryCommitsCriteria
                    {
                        Ids = new List<String>
                        {
                            commitId
                        }
                    })
                .SingleOrDefault();
        }
    
        /// <summary>Retrieve all(up to <see cref="Int32.MaxValue"/>) git (unless <paramref name="top"/> is set) commits for a project</summary>
        public static List<GitCommitRef> GetAllCommits(
            this GitHttpClient git, 
            String project,
            String repositoryId, 
            GitQueryCommitsCriteria searchCriteria, 
            Int32? skip = null, 
            Int32? top = (Int32.MaxValue - 1)) // Current API somehow fails (silently!) on Int32.MaxValue;
        {
            return git
                .GetCommitsAsync(
                    project: project,
                    repositoryId: repositoryId,
                    searchCriteria: searchCriteria,
                    skip: skip,
                    top: top)
                .GetAwaiter()
                .GetResult();
        }
    }
    

    附笔。: 还有一种方法可以做到这一点 GetBranchStatsBatchAsync 更可靠的是,在某些情况下,API在范围内找不到特定的提交,错误地声明提交不在分支中(然后,我们用getBranchStatsBatchAsync替换了逻辑,此后没有问题)。

    附笔。: 代码当前是异步方法上的同步包装器,因为这是当前项目中不幸需要的。如果适合的话,把它重新编写成适当的异步版本。