Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #54 - Better error handling for malformed JSON #56

Merged
merged 1 commit into from
Feb 19, 2019
Merged

Fixes #54 - Better error handling for malformed JSON #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 14 additions & 3 deletions src/SimpleVersion.Core/Pipeline/ResolveConfigurationProcess.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public void Apply(VersionContext context)

using(var repo = new Repository(context.RepositoryPath)){
var config = GetConfiguration(repo.Head?.Tip)
?? throw new InvalidOperationException($"No commits found for '{Constants.VersionFileName}'");
?? throw new InvalidOperationException($"Could not read '{Constants.VersionFileName}', has it been committed?");

context.Configuration = config;

Expand Down Expand Up @@ -66,7 +66,7 @@ private bool HasVersionChange(TreeChanges diff, Commit commit, SVM.Configuration
if (diff.Any(d => d.Path == Constants.VersionFileName))
{
var commitConfig = GetConfiguration(commit);
return !_comparer.Equals(config, commitConfig);
return commitConfig != null && !_comparer.Equals(config, commitConfig);
}

return false;
Expand All @@ -93,6 +93,17 @@ private SVM.Configuration GetConfiguration(Commit commit)
return Read((gitObj as Blob).GetContentText());
}

private SVM.Configuration Read(string rawConfiguration) => JsonConvert.DeserializeObject<SVM.Configuration>(rawConfiguration);
private SVM.Configuration Read(string rawConfiguration)
{
try
{
return JsonConvert.DeserializeObject<SVM.Configuration>(rawConfiguration);
}
catch
{
//TODO handle logger of invalid parsing
return null;
}
}
}
}
93 changes: 89 additions & 4 deletions test/SimpleVersion.Core.Tests/Pipeline/ResolveConfigurationProcessFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using SimpleVersion.Model;
using SimpleVersion.Pipeline;
using System;
using System.IO;
using Xunit;

namespace SimpleVersion.Core.Tests.Pipeline
Expand Down Expand Up @@ -56,7 +57,7 @@ public void Apply_NoCommits_ShouldThrow()

// Assert
action.Should().Throw<InvalidOperationException>()
.WithMessage($"No commits found for '{Constants.VersionFileName}'");
.WithMessage($"Could not read '{Constants.VersionFileName}', has it been committed?");
}
}

Expand All @@ -77,7 +78,7 @@ public void Apply_CommitsForFile_ShouldThrow()

// Assert
action.Should().Throw<InvalidOperationException>()
.WithMessage($"No commits found for '{Constants.VersionFileName}'");
.WithMessage($"Could not read '{Constants.VersionFileName}', has it been committed?");
}
}

Expand Down Expand Up @@ -181,7 +182,7 @@ public void Apply_Feature_Branch_No_Change_Increments_Merge_Once()

// Act
_sut.Apply(context);

context.Result.Height.Should().Be(6);
}
}
Expand Down Expand Up @@ -287,13 +288,97 @@ public void Apply_Feature_Branch_Sets_BranchName()
fixture.MakeACommit(); // feature 1
fixture.MakeACommit(); // feature 2
fixture.MakeACommit(); // feature 3

// Act
_sut.Apply(context);

context.Result.BranchName.Should().Be("feature/other");
context.Result.CanonicalBranchName.Should().Be("refs/heads/feature/other");
}
}

[Fact]
public void Apply_Malformed_Json_At_Commit_Throws()
{
using (var fixture = new EmptyRepositoryFixture())
{
// Arrange
var context = new VersionContext { RepositoryPath = fixture.RepositoryPath };

// write the version file (Well formaed)
var config = new Configuration { Version = "0.1.0" };
Utils.WriteConfiguration(config, fixture); // 1

fixture.MakeACommit(); // 2
fixture.MakeACommit(); // 3
fixture.MakeACommit(); // 4


// Write the version file (with parsing errors)
var file = Path.Combine(fixture.RepositoryPath, Constants.VersionFileName);
using (var writer = File.AppendText(file))
{
writer.WriteLine("This will not parse");
writer.Flush();
}

fixture.Repository.Index.Add(Constants.VersionFileName);
fixture.Repository.Index.Write();
fixture.MakeACommit(); // 5
fixture.MakeACommit(); // 6
fixture.MakeACommit(); // 7
fixture.MakeACommit(); // 8

// Act
Action action = () => _sut.Apply(context);

// Assert
action.Should().Throw<InvalidOperationException>()
.WithMessage($"Could not read '{Constants.VersionFileName}', has it been committed?");
}
}

[Fact]
public void Apply_Malformed_Json_Committed_Counts_As_No_Change()
{
using (var fixture = new EmptyRepositoryFixture())
{
// Arrange
var context = new VersionContext { RepositoryPath = fixture.RepositoryPath };

// write the version file (Well formaed)
var config = new Configuration { Version = "0.1.0" };
Utils.WriteConfiguration(config, fixture); // 1

fixture.MakeACommit(); // 2
fixture.MakeACommit(); // 3
fixture.MakeACommit(); // 4


// Write the version file (with parsing errors)
var file = Path.Combine(fixture.RepositoryPath, Constants.VersionFileName);

using (var writer = File.AppendText(file))
{
writer.WriteLine("This will not parse");
writer.Flush();
}

fixture.Repository.Index.Add(Constants.VersionFileName);
fixture.Repository.Index.Write();
fixture.MakeACommit(); // 5
fixture.MakeACommit(); // 6
fixture.MakeACommit(); // 7
fixture.MakeACommit(); // 8

config = new Configuration { Version = "0.1.0" };
Utils.WriteConfiguration(config, fixture); // 9

// Act
_sut.Apply(context);

context.Result.Height.Should().Be(9);
}
}
}
}