Skip to content

Commit 0048cbf

Browse files
authored
fix print summary to account for info flag (#56)
1 parent cace316 commit 0048cbf

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/PrintConsoleReportTask.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ abstract class PrintConsoleReportTask : DefaultTask() {
4646
.flatMap { ViolationsUtil.readDetails(it) }
4747
.toList()
4848
val byRule = ViolationsUtil.consolidatedFailures(list)
49-
ViolationsUtil.printSummary(byRule, consoleOutput, summaryForPassingDisabled.get())
49+
ViolationsUtil.printSummary(byRule, consoleOutput, summaryForPassingDisabled.get(), logger.isInfoEnabled)
5050
if (list.any {
5151
it.status() == RuleResultStatus.FAIL
5252
&& !it.rule().priority().meetsThreshold(detailsThreshold.orNull)

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtil.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class ViolationsUtil {
5959
}
6060

6161
@JvmStatic
62-
fun printSummary(resultMap: Map<Rule, List<RuleResult>>, output: StyledTextOutput, skipPassing: Boolean) {
62+
fun printSummary(resultMap: Map<Rule, List<RuleResult>>, output: StyledTextOutput, skipPassing: Boolean, infoLogging: Boolean) {
6363
output.style(StyledTextOutput.Style.Header).println("ArchRule Summary:")
6464
val indent = 4
6565
val maxRuleNameLength = resultMap.keys.maxOfOrNull { it.ruleName().length } ?: 1
@@ -69,7 +69,7 @@ class ViolationsUtil {
6969
classMap.forEach { (rule, results) ->
7070
val failures = results.filter { it.status() != RuleResultStatus.PASS }
7171
if (failures.isEmpty()) {
72-
if (!skipPassing) {
72+
if (!skipPassing || infoLogging) {
7373
output.style(StyledTextOutput.Style.Success)
7474
.text(" ".repeat(indent))
7575
.text(rule.ruleName().padEnd(maxRuleNameLength + 1))
@@ -107,4 +107,4 @@ class ViolationsUtil {
107107
.mapValues { it.value.filter { it.status() != RuleResultStatus.PASS } }
108108
}
109109
}
110-
}
110+
}

nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtilTest.kt

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ internal class ViolationsUtilTest {
1212
val output = MockStyledTextOutput()
1313
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
1414
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
15-
ViolationsUtil.printSummary(mapOf(rule to results), output, false)
15+
ViolationsUtil.printSummary(mapOf(rule to results), output, false, false)
1616
assertThat(output.getOutput())
1717
.contains("RuleClass")
1818
.contains("RuleName MEDIUM (No failures)")
@@ -23,16 +23,27 @@ internal class ViolationsUtilTest {
2323
val output = MockStyledTextOutput()
2424
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
2525
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
26-
ViolationsUtil.printSummary(mapOf(rule to results), output, true)
26+
ViolationsUtil.printSummary(mapOf(rule to results), output, true, false)
2727
assertThat(output.getOutput())
2828
.contains("RuleClass")
2929
.doesNotContain("RuleName")
3030
}
3131

32+
@Test
33+
fun `test printSummary skipPassing but infoLogging on`() {
34+
val output = MockStyledTextOutput()
35+
val rule = Rule("RuleClass", "RuleName", "description", Priority.MEDIUM)
36+
val results = listOf(RuleResult(rule, "message", RuleResultStatus.PASS))
37+
ViolationsUtil.printSummary(mapOf(rule to results), output, true, true)
38+
assertThat(output.getOutput())
39+
.contains("RuleClass")
40+
.contains("RuleName MEDIUM (No failures)")
41+
}
42+
3243
@Test
3344
fun `test printSummary empty results`() {
3445
val output = MockStyledTextOutput()
35-
ViolationsUtil.printSummary(mapOf(), output, false)
46+
ViolationsUtil.printSummary(mapOf(), output, false, false)
3647
assertThat(output.getOutput()).isEqualTo("ArchRule Summary:\n")
3748
}
3849
}
@@ -102,4 +113,4 @@ class MockStyledTextOutput : StyledTextOutput {
102113
TODO("Not yet implemented")
103114
}
104115

105-
}
116+
}

0 commit comments

Comments
 (0)