Skip to content

Ruler now only complains about unused exception rules. #24

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

Merged
Boško Stupar (boskicthebrain) merged 2 commits into from
Mar 31, 2026
Merged

Ruler now only complains about unused exception rules. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7654b3c
Ruler now only complains about unused exception rules.
boskicthebrain Mar 31, 2026
2cc443b
Updated nuspec version.
boskicthebrain Mar 31, 2026
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
200 changes: 160 additions & 40 deletions ProjectReferencesRuler.Tests/Rules/References/ReferencesRulerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@ public void GiveMeComplaints_NoRules_NoComplaints()
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new List<ReferenceRule>());
rules: new List<ReferenceRule>()
);

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.True(string.IsNullOrEmpty(complaints));
}
Expand All @@ -22,9 +25,15 @@ public void GiveMeComplaints_ForbiddenExplicitRule_ReturnsComplaints()
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []{ new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no") });
rules: new[]
{
new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no"),
}
);

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.False(string.IsNullOrEmpty(complaints));
Assert.Equal("Reference from a to b broke:\nno no", complaints);
Expand All @@ -35,9 +44,15 @@ public void GiveMeComplaints_ForbiddenGeneralRule_ReturnsComplaints()
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []{ new ReferenceRule(".*", "b", RuleKind.Forbidden, description: "no no") });
rules: new[]
{
new ReferenceRule(".*", "b", RuleKind.Forbidden, description: "no no"),
}
);

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.False(string.IsNullOrEmpty(complaints));
Assert.Equal("Reference from a to b broke:\nno no", complaints);
Expand All @@ -48,13 +63,16 @@ public void GiveMeComplaints_ForbiddenExplicitRuleWithExplicitOverridingRule_NoC
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []
rules: new[]
{
new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no"),
new ReferenceRule("a", "b", RuleKind.Allowed, description: "yes yes")
});
new ReferenceRule("a", "b", RuleKind.Allowed, description: "yes yes"),
}
);

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.True(string.IsNullOrEmpty(complaints));
}
Expand All @@ -64,13 +82,16 @@ public void GiveMeComplaints_ForbiddenGeneralRuleWithExplicitOverridingRule_NoCo
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []
rules: new[]
{
new ReferenceRule("*", "b", RuleKind.Forbidden, description: "no no"),
new ReferenceRule("a", "b", RuleKind.Allowed, description: "yes yes")
});
new ReferenceRule("a", "b", RuleKind.Allowed, description: "yes yes"),
}
);

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.True(string.IsNullOrEmpty(complaints));
}
Expand All @@ -79,13 +100,28 @@ public void GiveMeComplaints_ForbiddenGeneralRuleWithExplicitOverridingRule_NoCo
[InlineData(true, true)]
[InlineData(false, false)]
[InlineData(null, true)]
public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssets_MatchesPrivateAssetsToo(bool? isPrivateAssetsAllSet, bool hasComplaints)
public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssets_MatchesPrivateAssetsToo(
bool? isPrivateAssetsAllSet,
bool hasComplaints
)
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []{ new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no", isPrivateAssetsAllSet: isPrivateAssetsAllSet) });

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
rules: new[]
{
new ReferenceRule(
"a",
"b",
RuleKind.Forbidden,
description: "no no",
isPrivateAssetsAllSet: isPrivateAssetsAllSet
),
}
);

var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.Equal(hasComplaints, !string.IsNullOrEmpty(complaints));
}
Expand All @@ -94,13 +130,28 @@ public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssets_MatchesPriva
[InlineData(true, true)]
[InlineData(false, false)]
[InlineData(null, true)]
public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssetsAndGenericRule_MatchesPrivateAssetsToo(bool? isPrivateAssetsAllSet, bool hasComplaints)
public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssetsAndGenericRule_MatchesPrivateAssetsToo(
bool? isPrivateAssetsAllSet,
bool hasComplaints
)
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []{ new ReferenceRule(".*", ".*", RuleKind.Forbidden, description: "no no", isPrivateAssetsAllSet: isPrivateAssetsAllSet) });

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
rules: new[]
{
new ReferenceRule(
".*",
".*",
RuleKind.Forbidden,
description: "no no",
isPrivateAssetsAllSet: isPrivateAssetsAllSet
),
}
);

var complaints = ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);

Assert.Equal(hasComplaints, !string.IsNullOrEmpty(complaints));
}
Expand All @@ -109,13 +160,33 @@ public void GiveMeComplaints_ForbiddenExplicitRuleWithPrivateAssetsAndGenericRul
[InlineData("1.2.3", true)]
[InlineData("3.2.1", false)]
[InlineData(null, true)]
public void GiveMeComplaints_ForbiddenExplicitRuleWithVersion_MatchesVersion(string version, bool hasComplaints)
public void GiveMeComplaints_ForbiddenExplicitRuleWithVersion_MatchesVersion(
string version,
bool hasComplaints
)
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []{ new ReferenceRule(".*", ".*", RuleKind.Forbidden, description: "no no", version: version) });

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: "1.2.3"));
rules: new[]
{
new ReferenceRule(
".*",
".*",
RuleKind.Forbidden,
description: "no no",
version: version
),
}
);

var complaints = ruler.GiveMeComplaints(
new Reference(
from: "a",
to: "b",
isPrivateAssetsAllSet: true,
versionOrNull: "1.2.3"
)
);

Assert.Equal(hasComplaints, !string.IsNullOrEmpty(complaints));
}
Expand All @@ -125,13 +196,33 @@ public void GiveMeComplaints_ForbiddenExplicitRuleWithVersionAndException_Matche
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new []
rules: new[]
{
new ReferenceRule(".*", ".*", RuleKind.Forbidden, description: "no no", version: "3.2.1"),
new ReferenceRule(".*", ".*", RuleKind.Allowed, description: "no no", version: "1.2.3")
});

var complaints = ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: "1.2.3"));
new ReferenceRule(
".*",
".*",
RuleKind.Forbidden,
description: "no no",
version: "3.2.1"
),
new ReferenceRule(
".*",
".*",
RuleKind.Allowed,
description: "no no",
version: "1.2.3"
),
}
);

var complaints = ruler.GiveMeComplaints(
new Reference(
from: "a",
to: "b",
isPrivateAssetsAllSet: true,
versionOrNull: "1.2.3"
)
);

Assert.True(string.IsNullOrEmpty(complaints));
}
Expand All @@ -141,30 +232,59 @@ public void GiveMeUnusedRulesComplaints_OptedOut_ReturnsNoComplaints()
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new[] { new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no") });
rules: new[]
{
new ReferenceRule("a", "b", RuleKind.Forbidden, description: "no no"),
}
);

ruler.GiveMeComplaints(new Reference(from: "x", to: "y", isPrivateAssetsAllSet: true, versionOrNull: null));
ruler.GiveMeComplaints(
new Reference(from: "x", to: "y", isPrivateAssetsAllSet: true, versionOrNull: null)
);
var complaints = ruler.GiveMeUnusedRulesComplaints();

Assert.True(string.IsNullOrEmpty(complaints));
}

[Fact]
public void GiveMeUnusedRulesComplaints_OptedIn_ReturnsOnlyUnusedRules()
public void GiveMeUnusedRulesComplaints_OptedIn_ReturnsOnlyUnusedExceptionRules()
{
var ruler = new ReferencesRuler(
patternParser: new RegexPatternParser(),
rules: new[]
{
new ReferenceRule("a", "b", RuleKind.Forbidden, description: "used"),
new ReferenceRule("x", "y", RuleKind.Forbidden, description: "unused")
new ReferenceRule(
"a",
"b",
RuleKind.Forbidden,
description: "unused forbidden - should not appear"
),
new ReferenceRule(
"a",
"b",
RuleKind.Allowed,
description: "used exception - should not appear"
),
new ReferenceRule("x", "y", RuleKind.Allowed, description: "unused exception"),
new ReferenceRule(
"m",
"n",
RuleKind.ExplicitlyForbidden,
description: "unused explicitly forbidden rule - should not appear"
),
},
complainAboutUnusedRules: true);
reportUnusedExceptionRules: true
);

ruler.GiveMeComplaints(new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null));
ruler.GiveMeComplaints(
new Reference(from: "a", to: "b", isPrivateAssetsAllSet: true, versionOrNull: null)
);
var complaints = ruler.GiveMeUnusedRulesComplaints();

Assert.Equal("Unused rules:\nunused", complaints);
Assert.Equal(
"Unused exception rules:\n[Allowed] from 'x' to 'y': unused exception",
complaints
);
}
}
}
Loading
Loading