Skip to content

Commit 339a9c7

Browse files
jamilljamill
committed
Rebase: Handle case where patch has already been applied
1 parent b05a2ea commit 339a9c7

File tree

6 files changed

+177
-18
lines changed

6 files changed

+177
-18
lines changed

‎LibGit2Sharp.Tests/RebaseFixture.cs‎

Lines changed: 103 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ public class RebaseFixture : BaseFixture
1717
const string topicBranch1Name = "T1";
1818
const string topicBranch2Name = "T2";
1919
const string conflictBranch1Name = "C1";
20+
const string topicBranch1PrimeName = "T1Prime";
2021

2122
[Theory]
2223
[InlineData(topicBranch2Name, topicBranch2Name, topicBranch1Name, masterBranch1Name, 3)]
@@ -50,7 +51,7 @@ public void CanRebase(string initialBranchName,
5051
int afterStepCallCount = 0;
5152

5253
List<ObjectId> PreRebaseCommits = new List<ObjectId>();
53-
List<ObjectId> PostRebaseCommits = new List<ObjectId>();
54+
List<CompletedRebaseStepInfo> PostRebaseResults = new List<CompletedRebaseStepInfo>();
5455
ObjectId expectedParentId = upstream.Tip.Id;
5556

5657
RebaseOptions options = new RebaseOptions()
@@ -63,7 +64,7 @@ public void CanRebase(string initialBranchName,
6364
RebaseStepCompleted = x =>
6465
{
6566
afterStepCallCount++;
66-
PostRebaseCommits.Add(x.CommitId);
67+
PostRebaseResults.Add(new CompletedRebaseStepInfo(x.CommitId, x.WasPatchAlreadyApplied));
6768
},
6869
};
6970

@@ -91,19 +92,61 @@ public void CanRebase(string initialBranchName,
9192

9293
// Verify the chain of commits that resulted from the rebase.
9394
Commit expectedParent = expectedOntoCommit;
94-
foreach(Commit rebasedCommit in PostRebaseCommits.Select(id => repo.Lookup<Commit>(id)))
95+
foreach(CompletedRebaseStepInfo stepInfo in PostRebaseResults)
9596
{
97+
Commit rebasedCommit = repo.Lookup<Commit>(stepInfo.ObjectId);
9698
Assert.Equal(expectedParent.Id, rebasedCommit.Parents.First().Id);
99+
Assert.False(stepInfo.WasPatchAlreadyApplied);
97100
expectedParent = rebasedCommit;
98101
}
99102

100-
Assert.Equal(repo.Head.Tip.Id, PostRebaseCommits.Last());
103+
Assert.Equal(repo.Head.Tip.Id, PostRebaseResults.Last().ObjectId);
101104
}
102105
}
103106

104-
private class rebaseStepInfo
107+
private class CompletedRebaseStepInfo
105108
{
106-
public Commit Commit { get; set; }
109+
public CompletedRebaseStepInfo(ObjectId objectId, bool wasPatchAlreadyApplied)
110+
{
111+
ObjectId = objectId;
112+
WasPatchAlreadyApplied = wasPatchAlreadyApplied;
113+
}
114+
115+
public ObjectId ObjectId { get; set; }
116+
117+
public bool WasPatchAlreadyApplied { get; set; }
118+
}
119+
120+
private class CompletedRebaseStepInfoEqualityComparer : IEqualityComparer<CompletedRebaseStepInfo>
121+
{
122+
bool IEqualityComparer<CompletedRebaseStepInfo>.Equals(CompletedRebaseStepInfo x, CompletedRebaseStepInfo y)
123+
{
124+
if (x == null && y == null)
125+
{
126+
return true;
127+
}
128+
129+
if ((x == null && y != null ) ||
130+
(x != null && y == null ))
131+
{
132+
return false;
133+
}
134+
135+
return x.WasPatchAlreadyApplied == y.WasPatchAlreadyApplied &&
136+
ObjectId.Equals(x.ObjectId, y.ObjectId);
137+
}
138+
139+
int IEqualityComparer<CompletedRebaseStepInfo>.GetHashCode(CompletedRebaseStepInfo obj)
140+
{
141+
int hashCode = obj.WasPatchAlreadyApplied.GetHashCode();
142+
143+
if (obj.ObjectId != null)
144+
{
145+
hashCode += obj.ObjectId.GetHashCode();
146+
}
147+
148+
return hashCode;
149+
}
107150
}
108151

109152
/// <summary>
@@ -335,7 +378,7 @@ public void RebaseWhileAlreadyRebasingThrows()
335378

336379
Assert.Throws<LibGit2SharpException>(() =>
337380
repo.Rebase.Start(branch, upstream, onto, Constants.Signature, null));
338-
}
381+
}
339382
}
340383

341384
[Fact]
@@ -371,6 +414,57 @@ public void CurrentStepInfoIsNullWhenNotRebasing()
371414
}
372415
}
373416

417+
[Fact]
418+
public void CanRebaseHandlePatchAlreadyApplied()
419+
{
420+
SelfCleaningDirectory scd = BuildSelfCleaningDirectory();
421+
var path = Repository.Init(scd.DirectoryPath);
422+
using (Repository repo = new Repository(path))
423+
{
424+
ConstructRebaseTestRepository(repo);
425+
426+
repo.Checkout(topicBranch1Name);
427+
428+
Branch topicBranch1Prime = repo.CreateBranch(topicBranch1PrimeName, masterBranch1Name);
429+
430+
string newFileRelativePath = "new_file.txt";
431+
Touch(repo.Info.WorkingDirectory, newFileRelativePath, "New Content");
432+
repo.Stage(newFileRelativePath);
433+
Commit commit = repo.Commit("new commit 1", Constants.Signature, Constants.Signature, new CommitOptions());
434+
435+
repo.Checkout(topicBranch1Prime);
436+
var cherryPickResult = repo.CherryPick(commit, Constants.Signature2);
437+
Assert.Equal(CherryPickStatus.CherryPicked, cherryPickResult.Status);
438+
439+
string newFileRelativePath2 = "new_file_2.txt";
440+
Touch(repo.Info.WorkingDirectory, newFileRelativePath2, "New Content for path 2");
441+
repo.Stage(newFileRelativePath2);
442+
repo.Commit("new commit 2", Constants.Signature, Constants.Signature, new CommitOptions());
443+
444+
Branch upstreamBranch = repo.Branches[topicBranch1Name];
445+
446+
List<CompletedRebaseStepInfo> rebaseResults = new List<CompletedRebaseStepInfo>();
447+
448+
RebaseOptions options = new RebaseOptions()
449+
{
450+
RebaseStepCompleted = x =>
451+
{
452+
rebaseResults.Add(new CompletedRebaseStepInfo(x.CommitId, x.WasPatchAlreadyApplied));
453+
}
454+
};
455+
456+
repo.Rebase.Start(null, upstreamBranch, null, Constants.Signature2, options);
457+
458+
List<CompletedRebaseStepInfo> expectedRebaseResults = new List<CompletedRebaseStepInfo>()
459+
{
460+
new CompletedRebaseStepInfo(null, true),
461+
new CompletedRebaseStepInfo(new ObjectId("ebdea37ecf583fb7fa5c806a1c00b82f3987fbaa"), false),
462+
};
463+
464+
Assert.Equal<CompletedRebaseStepInfo>(expectedRebaseResults, rebaseResults, new CompletedRebaseStepInfoEqualityComparer());
465+
}
466+
}
467+
374468
private void ConstructRebaseTestRepository(Repository repo)
375469
{
376470
// Constructs a graph that looks like:
@@ -425,7 +519,7 @@ private void ConstructRebaseTestRepository(Repository repo)
425519
repo.Stage(filePathC);
426520
commit = repo.Commit("commit 3", Constants.Signature, Constants.Signature, new CommitOptions());
427521

428-
repo.CreateBranch(masterBranch1Name, commit, Constants.Signature);
522+
Branch masterBranch1 = repo.CreateBranch(masterBranch1Name, commit, Constants.Signature);
429523

430524
Touch(workdir, filePathB, string.Join(lineEnding, fileContentB1, fileContentB2));
431525
repo.Stage(filePathB);
@@ -455,7 +549,7 @@ private void ConstructRebaseTestRepository(Repository repo)
455549

456550
repo.CreateBranch(topicBranch2Name, commit, Constants.Signature);
457551

458-
repo.Checkout(masterBranch1Name);
552+
repo.Checkout(masterBranch1.Tip);
459553
Touch(workdir, filePathD, fileContentD1);
460554
repo.Stage(filePathD);
461555
commit = repo.Commit("commit 10", Constants.Signature, Constants.Signature, new CommitOptions());

‎LibGit2Sharp/AfterRebaseStepInfo.cs‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ internal AfterRebaseStepInfo(RebaseStepInfo stepInfo, ObjectId commitId)
2020
{
2121
StepInfo = stepInfo;
2222
CommitId = commitId;
23+
WasPatchAlreadyApplied = false;
24+
}
25+
26+
/// <summary>
27+
/// Constructor to call when the patch has already been applied for this step.
28+
/// </summary>
29+
/// <param name="stepInfo"></param>
30+
internal AfterRebaseStepInfo(RebaseStepInfo stepInfo)
31+
: this (stepInfo, null)
32+
{
33+
WasPatchAlreadyApplied = true;
2334
}
2435

2536
/// <summary>
@@ -31,5 +42,11 @@ internal AfterRebaseStepInfo(RebaseStepInfo stepInfo, ObjectId commitId)
3142
/// The ID of the commit generated by the step, if any.
3243
/// </summary>
3344
public virtual ObjectId CommitId { get; private set; }
45+
46+
/// <summary>
47+
/// Was the changes for this step already applied. If so,
48+
/// <see cref="AfterRebaseStepInfo.CommitId"/> will be null.
49+
/// </summary>
50+
public virtual bool WasPatchAlreadyApplied { get; private set; }
3451
}
3552
}

‎LibGit2Sharp/Core/GitOid.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,13 @@ public static implicit operator ObjectId(GitOid? oid)
2727
{
2828
return oid == null ? null : new ObjectId(oid.Value);
2929
}
30+
31+
/// <summary>
32+
/// Static convenience property to return an id (all zeros).
33+
/// </summary>
34+
public static GitOid Empty
35+
{
36+
get { return new GitOid(); }
37+
}
3038
}
3139
}

‎LibGit2Sharp/Core/Proxy.cs‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1661,15 +1661,15 @@ public static GitRebaseOperation git_rebase_next(RebaseSafeHandle rebase,
16611661
return operation;
16621662
}
16631663

1664-
public static GitOid git_rebase_commit(
1664+
public static GitRebaseCommitResult git_rebase_commit(
16651665
RebaseSafeHandle rebase,
16661666
Signature author,
16671667
Signature committer)
16681668
{
16691669
Ensure.ArgumentNotNull(rebase, "rebase");
16701670
Ensure.ArgumentNotNull(committer, "committer");
16711671

1672-
GitOid commitId = new GitOid();
1672+
GitRebaseCommitResult commitResult = new GitRebaseCommitResult();
16731673

16741674
using (ThreadAffinity())
16751675
{
@@ -1682,8 +1682,17 @@ public static GitOid git_rebase_commit(
16821682
authorHandle = author == null ?
16831683
new SignatureSafeHandle() : author.BuildHandle();
16841684

1685-
int result = NativeMethods.git_rebase_commit(ref commitId, rebase, authorHandle, committerHandle, IntPtr.Zero, IntPtr.Zero);
1686-
Ensure.ZeroResult(result);
1685+
int result = NativeMethods.git_rebase_commit(ref commitResult.CommitId, rebase, authorHandle, committerHandle, IntPtr.Zero, IntPtr.Zero);
1686+
1687+
if (result == (int)GitErrorCode.Applied)
1688+
{
1689+
commitResult.CommitId = GitOid.Empty;
1690+
commitResult.WasPatchAlreadyApplied = true;
1691+
}
1692+
else
1693+
{
1694+
Ensure.ZeroResult(result);
1695+
}
16871696
}
16881697
finally
16891698
{
@@ -1695,7 +1704,24 @@ public static GitOid git_rebase_commit(
16951704
}
16961705
}
16971706

1698-
return commitId;
1707+
return commitResult;
1708+
}
1709+
1710+
/// <summary>
1711+
/// Struct to report the result of calling git_rebase_commit.
1712+
/// </summary>
1713+
public struct GitRebaseCommitResult
1714+
{
1715+
/// <summary>
1716+
/// The ID of the commit that was generated, if any
1717+
/// </summary>
1718+
public GitOid CommitId;
1719+
1720+
/// <summary>
1721+
/// bool to indicate if the patch was already applied.
1722+
/// If Patch was already applied, then CommitId will be empty (all zeros).
1723+
/// </summary>
1724+
public bool WasPatchAlreadyApplied;
16991725
}
17001726

17011727
public static void git_rebase_abort(

‎LibGit2Sharp/Rebase.cs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ public virtual RebaseResult Continue(Signature committer, RebaseOptions options)
173173
try
174174
{
175175
rebase = Proxy.git_rebase_open(repository.Handle);
176+
var rebaseCommitResult = Proxy.git_rebase_commit(rebase, null, committer);
176177

177178
// Report that we just completed the step
178179
if (options.RebaseStepCompleted != null)
@@ -188,8 +189,14 @@ public virtual RebaseResult Continue(Signature committer, RebaseOptions options)
188189
currentStepIndex,
189190
totalStepCount);
190191

191-
GitOid id = Proxy.git_rebase_commit(rebase, null, committer);
192-
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo, new ObjectId(id)));
192+
if (rebaseCommitResult.WasPatchAlreadyApplied)
193+
{
194+
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo));
195+
}
196+
else
197+
{
198+
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo, new ObjectId(rebaseCommitResult.CommitId)));
199+
}
193200
}
194201

195202
RebaseResult rebaseResult = RebaseOperationImpl.Run(rebase, repository, committer, options);

‎LibGit2Sharp/RebaseOperationImpl.cs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,19 @@ public static RebaseResult Run(RebaseSafeHandle rebaseOperationHandle,
7878
// commit and continue.
7979
if (repository.Index.IsFullyMerged)
8080
{
81-
GitOid id = Proxy.git_rebase_commit(rebaseOperationHandle, null, committer);
81+
Proxy.GitRebaseCommitResult rebase_commit_result = Proxy.git_rebase_commit(rebaseOperationHandle, null, committer);
8282

8383
// Report that we just completed the step
8484
if (options.RebaseStepCompleted != null)
8585
{
86-
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo, new ObjectId(id)));
86+
if (rebase_commit_result.WasPatchAlreadyApplied)
87+
{
88+
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo));
89+
}
90+
else
91+
{
92+
options.RebaseStepCompleted(new AfterRebaseStepInfo(stepInfo, new ObjectId(rebase_commit_result.CommitId)));
93+
}
8794
}
8895
}
8996
else

0 commit comments

Comments
 (0)