Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
CR: Clean up naming within MergeMessage class
  • Loading branch information
Kieranties committed May 11, 2019
commit 629efffabb41f378f253bc253d86ba9c564e6fdb
20 changes: 10 additions & 10 deletions src/GitVersionCore.Tests/MergeMessageTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public void ParsesMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe("Default");
sut.FormatName.ShouldBe("Default");
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeFalse();
Expand Down Expand Up @@ -106,7 +106,7 @@ public void ParsesGitHubPullMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe("GitHubPull");
sut.FormatName.ShouldBe("GitHubPull");
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeTrue();
Expand Down Expand Up @@ -140,7 +140,7 @@ public void ParsesBitBucketPullMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe("BitBucketPull");
sut.FormatName.ShouldBe("BitBucketPull");
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeTrue();
Expand Down Expand Up @@ -171,7 +171,7 @@ public void ParsesSmartGitMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe("SmartGit");
sut.FormatName.ShouldBe("SmartGit");
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeFalse();
Expand Down Expand Up @@ -201,7 +201,7 @@ public void ParsesRemoteTrackingMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe("RemoteTracking");
sut.FormatName.ShouldBe("RemoteTracking");
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeFalse();
Expand All @@ -228,7 +228,7 @@ public void ParsesInvalidMergeMessage(
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBeNull();
sut.FormatName.ShouldBeNull();
sut.TargetBranch.ShouldBe(expectedTargetBranch);
sut.MergedBranch.ShouldBe(expectedMergedBranch);
sut.IsMergedPullRequest.ShouldBeFalse();
Expand All @@ -251,7 +251,7 @@ public void MatchesSingleCustomMessage()
var sut = new MergeMessage(message, _config);

// Assert
sut.MatchDefinition.ShouldBe(definition);
sut.FormatName.ShouldBe(definition);
sut.TargetBranch.ShouldBeNull();
sut.MergedBranch.ShouldBeEmpty();
sut.IsMergedPullRequest.ShouldBeFalse();
Expand All @@ -276,7 +276,7 @@ public void MatchesMultipleCustomMessages()
var sut = new MergeMessage(format, _config);

// Assert
sut.MatchDefinition.ShouldBe(definition);
sut.FormatName.ShouldBe(definition);
sut.TargetBranch.ShouldBeNull();
sut.MergedBranch.ShouldBeEmpty();
sut.IsMergedPullRequest.ShouldBeFalse();
Expand All @@ -303,7 +303,7 @@ public void MatchesCaptureGroupsFromCustomMessages()
var sut = new MergeMessage($"Merged PR #{pr} into {target} from {source}", _config);

// Assert
sut.MatchDefinition.ShouldBe(definition);
sut.FormatName.ShouldBe(definition);
sut.TargetBranch.ShouldBe(target);
sut.MergedBranch.ShouldBe(source);
sut.IsMergedPullRequest.ShouldBeTrue();
Expand All @@ -328,7 +328,7 @@ public void ReturnsAfterFirstMatchingPattern()
var sut = new MergeMessage("Merge branch 'this'", _config);

// Assert
sut.MatchDefinition.ShouldBe(definition);
sut.FormatName.ShouldBe(definition);
sut.TargetBranch.ShouldBeNull();
sut.MergedBranch.ShouldBe("this");
sut.IsMergedPullRequest.ShouldBeFalse();
Expand Down
44 changes: 22 additions & 22 deletions src/GitVersionCore/MergeMessage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,32 @@ namespace GitVersion
{
public class MergeMessage
{
private static readonly IList<MergeMessagePattern> DefaultPatterns = new List<MergeMessagePattern>
private static readonly IList<MergeMessageFormat> DefaultFormats = new List<MergeMessageFormat>
{
new MergeMessagePattern("Default", @"^Merge (branch|tag) '(?<SourceBranch>[^']*)'(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessagePattern("SmartGit", @"^Finish (?<SourceBranch>[^\s]*)(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessagePattern("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?<Source>.*) from (?<SourceBranch>[^\s]*) to (?<TargetBranch>[^\s]*)"),
new MergeMessagePattern("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?:(?<SourceBranch>[^\s]*))(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessagePattern("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s]*)'(?: into (?<TargetBranch>[^\s]*))*")
new MergeMessageFormat("Default", @"^Merge (branch|tag) '(?<SourceBranch>[^']*)'(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessageFormat("SmartGit", @"^Finish (?<SourceBranch>[^\s]*)(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessageFormat("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?<Source>.*) from (?<SourceBranch>[^\s]*) to (?<TargetBranch>[^\s]*)"),
new MergeMessageFormat("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?:(?<SourceBranch>[^\s]*))(?: into (?<TargetBranch>[^\s]*))*"),
new MergeMessageFormat("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s]*)'(?: into (?<TargetBranch>[^\s]*))*")
};

public MergeMessage(string mergeMessage, Config config)
{
if (mergeMessage == null)
throw new NullReferenceException();

// Concat config messages with the defaults.
// Concat config formats with the defaults.
// Ensure configs are processed first.
var allPatterns = config.MergeMessageFormats
.Select(x => new MergeMessagePattern(x.Key, x.Value))
.Concat(DefaultPatterns);
var allFormats = config.MergeMessageFormats
.Select(x => new MergeMessageFormat(x.Key, x.Value))
.Concat(DefaultFormats);

foreach (var pattern in allPatterns)
foreach (var format in allFormats)
{
var match = pattern.Format.Match(mergeMessage);
var match = format.Pattern.Match(mergeMessage);
if (match.Success)
{
MatchDefinition = pattern.DefinitionName;
FormatName = format.Name;
MergedBranch = match.Groups["SourceBranch"].Value;

if (match.Groups["TargetBranch"].Success)
Expand All @@ -45,21 +45,21 @@ public MergeMessage(string mergeMessage, Config config)
PullRequestNumber = pullNumber;
}

Version = ParseVersion(MergedBranch, config.TagPrefix);
Version = ParseVersion(config.TagPrefix);

break;
}
}
}

public string MatchDefinition { get; }
public string FormatName { get; }
public string TargetBranch { get; }
public string MergedBranch { get; } = "";
public bool IsMergedPullRequest => PullRequestNumber != null;
public int? PullRequestNumber { get; }
public SemanticVersion Version { get; }

private SemanticVersion ParseVersion(string branchName, string tagPrefix)
private SemanticVersion ParseVersion(string tagPrefix)
{
// Remove remotes and branch prefixes like release/ feature/ hotfix/ etc
var toMatch = Regex.Replace(MergedBranch, @"^(\w+[-/])*", "", RegexOptions.IgnoreCase);
Expand All @@ -76,17 +76,17 @@ private SemanticVersion ParseVersion(string branchName, string tagPrefix)
return null;
}

private class MergeMessagePattern
private class MergeMessageFormat
{
public MergeMessagePattern(string name, string format)
public MergeMessageFormat(string name, string pattern)
{
DefinitionName = name;
Format = new Regex(format, RegexOptions.IgnoreCase | RegexOptions.Compiled);
Name = name;
Pattern = new Regex(pattern, RegexOptions.IgnoreCase | RegexOptions.Compiled);
}

public string DefinitionName { get; }
public string Name { get; }

public Regex Format { get; }
public Regex Pattern { get; }
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public override IEnumerable<BaseVersion> GetVersions(GitVersionContext context)
mergeMessage.Version != null &&
context.FullConfiguration.IsReleaseBranch(TrimRemote(mergeMessage.MergedBranch)))
{
Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.MatchDefinition}");
Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.FormatName}");
var shouldIncrement = !context.Configuration.PreventIncrementForMergedBranchVersion;
return new[]
{
Expand Down