Skip to content

skip class names in summary if passing is filtered #72

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
wakingrufus merged 1 commit into from
Mar 26, 2026
Merged

skip class names in summary if passing is filtered #72

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
46 changes: 25 additions & 21 deletions ...rules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtil.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ class ViolationsUtil {
}

@JvmStatic
fun writeDetails(dataFile: File, violationList : List<RuleResult>) {
fun writeDetails(dataFile: File, violationList: List<RuleResult>) {
ObjectOutputStream(FileOutputStream(dataFile)).use { out ->
out.writeInt(violationList.size)
violationList.forEach {
out.writeObject(it);
out.writeObject(it)
}
}
}
Expand Down Expand Up @@ -88,30 +88,34 @@ class ViolationsUtil {
val maxRuleNameLength = resultMap.keys.maxOfOrNull { it.ruleName().length } ?: 1
resultMap.entries.groupBy { entry -> entry.key.ruleClass() }
.forEach { (ruleClass, classMap) ->
output.style(StyledTextOutput.Style.Header).println(ruleClass)
classMap.forEach { (rule, results) ->
val failures = results.filter { it.status() != RuleResultStatus.PASS }
if (failures.isEmpty()) {
if (!skipPassing || infoLogging) {
output.style(StyledTextOutput.Style.Success)
val classHasFailures = classMap.flatMap { it.value }.any { it.status != RuleResultStatus.PASS }
val shouldClassPrint = !skipPassing || infoLogging || classHasFailures
if (shouldClassPrint) {
output.style(StyledTextOutput.Style.Header).println(ruleClass)
classMap.forEach { (rule, results) ->
val failures = results.filter { it.status() != RuleResultStatus.PASS }
if (failures.isEmpty()) {
if (!skipPassing || infoLogging) {
output.style(StyledTextOutput.Style.Success)
.text(" ".repeat(indent))
.text(rule.ruleName().padEnd(maxRuleNameLength + 1))
.text(" ")
.text(rule.priority().asString().padEnd(10))
.println(" (No failures)")
}
} else {
val style = when (rule.priority()) {
Priority.LOW -> StyledTextOutput.Style.Normal
Priority.MEDIUM -> StyledTextOutput.Style.Info
Priority.HIGH -> StyledTextOutput.Style.Failure
}
output.style(style)
.text(" ".repeat(indent))
.text(rule.ruleName().padEnd(maxRuleNameLength + 1))
.text(" ")
.text(rule.priority().asString().padEnd(10))
.println(" (No failures)")
.println(" (" + failures.size + " failures)")
}
} else {
val style = when (rule.priority()) {
Priority.LOW -> StyledTextOutput.Style.Normal
Priority.MEDIUM -> StyledTextOutput.Style.Info
Priority.HIGH -> StyledTextOutput.Style.Failure
}
output.style(style)
.text(" ".repeat(indent))
.text(rule.ruleName().padEnd(maxRuleNameLength + 1))
.text(" ")
.text(rule.priority().asString().padEnd(10))
.println(" (" + failures.size + " failures)")
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...e-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPluginTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ archRules {
.hasNoDeprecationWarnings()

assertThat(result.output)
.contains("com.netflix.nebula.archrules.deprecation.DeprecationRule")
.doesNotContain("com.netflix.nebula.archrules.deprecation.DeprecationRule")
.doesNotContain(LOW_PASSING_SUMMARY)
}

Expand Down
17 changes: 14 additions & 3 deletions ...s-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtilTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,29 @@ internal class ViolationsUtilTest {
}

@Test
fun `test printSummary skipPassing`() {
fun `test printSummary skipPassing with failures`() {
val output = MockStyledTextOutput()
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
val results = listOf(RuleResult(rule, "message", RuleResultStatus.FAIL))
ViolationsUtil.printSummary(mapOf(rule to results), output, true, false)
assertThat(output.getOutput())
.contains("RuleClass")
.contains("RuleName")
}

@Test
fun `test printSummary skipPassing no failures`() {
val output = MockStyledTextOutput()
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
ViolationsUtil.printSummary(mapOf(rule to results), output, true, false)
assertThat(output.getOutput())
.doesNotContain("RuleClass")
.doesNotContain("RuleName")
}

@Test
fun `test printSummary skipPassing but infoLogging on`() {
fun `test printSummary skipPassing no failures but infoLogging on`() {
val output = MockStyledTextOutput()
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
Expand Down
Loading