Skip to content

Commit

Permalink
(GH-127) Add aliases for build breaking (#627)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pascalberger
pascalberger authored May 23, 2024
1 parent 698d463 commit ad799dc
Show file tree
Hide file tree
Showing 6 changed files with 521 additions and 0 deletions.
287 changes: 287 additions & 0 deletions src/Cake.Issues.Tests/BuildBreakerTests.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
namespace Cake.Issues.Tests;

using System.Collections.Generic;

public class BuildBreakerTests
{
public sealed class TheBreakBuildOnIssuesMethod
{
[Fact]
public void Should_Throw_If_Issues_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = null;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues));

// Then
result.IsArgumentNullException("issues");
}

[Fact]
public void Should_Throw_If_Any_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues));

// Then
result.IsIssuesFoundException("Found 1 issue.");
}

[Fact]
public void Should_Not_Throw_If_No_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
var issues = new List<IIssue>();

// When
buildBreaker.BreakBuildOnIssues(issues);

// Then
}
}

public sealed class TheBreakBuildOnIssuesMethodWithPriorityParameter
{
[Fact]
public void Should_Throw_If_Issues_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = null;
var priority = IssuePriority.Error;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, priority));

// Then
result.IsArgumentNullException("issues");
}

[Fact]
public void Should_Throw_If_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.WithPriority(IssuePriority.Warning)
.Create()];
var priority = IssuePriority.Warning;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, priority));

// Then
result.IsIssuesFoundException("Found 1 issue.");
}

[Fact]
public void Should_Not_Throw_If_No_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.WithPriority(IssuePriority.Warning)
.Create()];
var priority = IssuePriority.Error;

// When
buildBreaker.BreakBuildOnIssues(issues, priority);

// Then
}
}

public sealed class TheBreakBuildOnIssuesMethodWithProviderTypeParameter
{
[Fact]
public void Should_Throw_If_Issues_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = null;
var providerType = "ProviderType Foo";

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, providerType));

// Then
result.IsArgumentNullException("issues");
}

[Fact]
public void Should_Throw_If_ProviderType_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
string providerType = null;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, providerType));

// Then
result.IsArgumentNullException("providerType");
}

[Fact]
public void Should_Throw_If_ProviderType_Is_Empty()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
var providerType = string.Empty;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, providerType));

// Then
result.IsArgumentOutOfRangeException("providerType");
}

[Fact]
public void Should_Throw_If_ProviderType_Is_Whitespace()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
var providerType = " ";

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, providerType));

// Then
result.IsArgumentOutOfRangeException("providerType");
}

[Fact]
public void Should_Throw_If_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
var providerType = "ProviderType Foo";

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, providerType));

// Then
result.IsIssuesFoundException("Found 1 issue.");
}

[Fact]
public void Should_Not_Throw_If_No_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.WithPriority(IssuePriority.Warning)
.Create()];
var providerType = "ProviderType Bar";

// When
buildBreaker.BreakBuildOnIssues(issues, providerType);

// Then
}
}

public sealed class TheBreakBuildOnIssuesMethodWithPredicateParameter
{
[Fact]
public void Should_Throw_If_Issues_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = null;
static bool predicate(IIssue x) => true;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, predicate));

// Then
result.IsArgumentNullException("issues");
}

[Fact]
public void Should_Throw_If_Predicate_Is_Null()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
Func<IIssue, bool> predicate = null;

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, predicate));

// Then
result.IsArgumentNullException("predicate");
}

[Fact]
public void Should_Throw_If_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
static bool predicate(IIssue x) => x.MessageText == "Message Foo";

// When
var result = Record.Exception(() => buildBreaker.BreakBuildOnIssues(issues, predicate));

// Then
result.IsIssuesFoundException("Found 1 issue.");
}

[Fact]
public void Should_Not_Throw_If_No_Matching_Issues()
{
// Given
var buildBreaker = new BuildBreaker();
IEnumerable<IIssue> issues = [
IssueBuilder
.NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
.Create()];
static bool predicate(IIssue x) => false;

// When
buildBreaker.BreakBuildOnIssues(issues, predicate);

// Then
}
}
}
10 changes: 10 additions & 0 deletions src/Cake.Issues.Tests/ExceptionAssertExtensions.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
namespace Cake.Issues.Tests;

public static class ExceptionAssertExtensions
{
public static void IsIssuesFoundException(this Exception exception, string message)
{
var ex = Assert.IsType<IssuesFoundException>(exception);
Assert.Equal(message, ex.Message);
}
}
Loading

0 comments on commit ad799dc

Please # to comment.