Skip to content

Commit 29c87eb

Browse files
ClaudenwClaudenw
committed
fixes sonarqube issues
1 parent a9cffac commit 29c87eb

8 files changed

Lines changed: 88 additions & 66 deletions

File tree

‎apache-rat-core/src/main/java/org/apache/rat/Reporter.java‎

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -118,23 +118,6 @@ public Output getOutput() {
118118
return output;
119119
}
120120

121-
/**
122-
* Lists the licenses on the configured output stream.
123-
*
124-
* @param configuration The configuration for the system
125-
* @param filter the license filter that specifies which licenses to output.
126-
* @throws IOException if PrintWriter can not be retrieved from configuration.
127-
*/
128-
public static void listLicenses(final ReportConfiguration configuration, final LicenseFilter filter) throws IOException {
129-
try (PrintWriter pw = configuration.getWriter().get()) {
130-
pw.format("Licenses (%s):%n", filter);
131-
configuration.getLicenses(filter)
132-
.forEach(lic -> pw.format(LICENSE_FORMAT, lic.getLicenseFamily().getFamilyCategory(),
133-
lic.getLicenseFamily().getFamilyName(), lic.getNote()));
134-
pw.println();
135-
}
136-
}
137-
138121
/**
139122
* The output from a report run.
140123
*/
@@ -220,19 +203,28 @@ public void format(final IOSupplier<InputStream> stylesheet, final IOSupplier<Ou
220203
}
221204

222205
/**
223-
* Lists the licenses on the configured output stream.
206+
* Lists the licenses on the print writer.
207+
*
208+
* @param printWriter The print writer to write to.
209+
* @param filter the license filter that specifies which licenses to output.
210+
*/
211+
public void listLicenses(final PrintWriter printWriter, final LicenseFilter filter) {
212+
printWriter.format("Licenses (%s):%n", filter);
213+
configuration.getLicenses(filter)
214+
.forEach(lic -> printWriter.format(LICENSE_FORMAT, lic.getLicenseFamily().getFamilyCategory(),
215+
lic.getLicenseFamily().getFamilyName(), lic.getNote()));
216+
printWriter.println();
217+
}
218+
219+
/**
220+
* Lists the licenses on the output specified in the configuration.
224221
*
225-
* @param configuration The configuration for the system
226222
* @param filter the license filter that specifies which licenses to output.
227223
* @throws IOException if PrintWriter can not be retrieved from configuration.
228224
*/
229-
public static void listLicenses(final ReportConfiguration configuration, final LicenseFilter filter) throws IOException {
225+
public void listLicenses(final LicenseFilter filter) throws IOException {
230226
try (PrintWriter pw = configuration.getWriter().get()) {
231-
pw.format("Licenses (%s):%n", filter);
232-
configuration.getLicenses(filter)
233-
.forEach(lic -> pw.format(LICENSE_FORMAT, lic.getLicenseFamily().getFamilyCategory(),
234-
lic.getLicenseFamily().getFamilyName(), lic.getNote()));
235-
pw.println();
227+
listLicenses(pw, filter);
236228
}
237229
}
238230

‎apache-rat-core/src/test/java/org/apache/rat/OutputTest.java‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@
2424
import org.apache.rat.config.results.ClaimValidator;
2525
import org.apache.rat.document.DocumentName;
2626
import org.apache.rat.document.DocumentNameMatcher;
27+
import org.apache.rat.document.FileDocument;
2728
import org.apache.rat.license.LicenseSetFactory;
2829
import org.apache.rat.report.claim.ClaimStatistic;
2930
import org.apache.rat.report.claim.ClaimStatisticTest;
31+
import org.apache.rat.test.utils.Resources;
3032
import org.apache.rat.testhelpers.FileUtils;
3133
import org.apache.rat.utils.StandardXmlFactory;
34+
import org.apache.rat.walker.DirectoryWalker;
3235
import org.junit.jupiter.api.AfterAll;
3336
import org.junit.jupiter.api.BeforeAll;
3437
import org.junit.jupiter.api.Test;
@@ -37,16 +40,21 @@
3740
import org.xmlunit.assertj3.XmlAssert;
3841

3942
import javax.xml.transform.TransformerException;
43+
import java.io.ByteArrayOutputStream;
4044
import java.io.File;
4145
import java.io.FileOutputStream;
4246
import java.io.IOException;
4347
import java.io.InputStream;
48+
import java.io.PrintWriter;
4449
import java.io.StringWriter;
50+
import java.net.URISyntaxException;
4551
import java.nio.charset.StandardCharsets;
4652
import java.nio.file.Files;
4753
import java.nio.file.Path;
4854
import java.util.List;
4955

56+
import static org.assertj.core.api.Assertions.assertThat;
57+
5058
class OutputTest {
5159

5260
static Path tempPath;
@@ -157,4 +165,40 @@ void configurationReadingTest() throws IOException {
157165
Reporter.Output output = builder.build();
158166
ReportConfigurationTest.assertSame(output.getConfiguration(), underTest);
159167
}
168+
169+
private ReportConfiguration initializeConfiguration() throws URISyntaxException {
170+
Defaults defaults = Defaults.builder().build();
171+
final File elementsFile = Resources.getExampleResource("exampleData");
172+
final ReportConfiguration configuration = new ReportConfiguration();
173+
configuration.setFrom(defaults);
174+
DocumentName documentName = DocumentName.builder(elementsFile).build();
175+
configuration.addSource(new DirectoryWalker(new FileDocument(documentName, elementsFile,
176+
configuration.getDocumentExcluder(documentName))));
177+
return configuration;
178+
}
179+
180+
@Test
181+
void listLicensesReportTest() throws Exception {
182+
ByteArrayOutputStream out = new ByteArrayOutputStream();
183+
ReportConfiguration configuration = initializeConfiguration();
184+
configuration.setOut(new ReportConfiguration.IODescriptor<>("listLicensesReportTest", () -> out));
185+
configuration.setStyleSheet(StyleSheets.UNAPPROVED_LICENSES.getStyleSheet());
186+
Reporter.Output output = Reporter.Output.builder()
187+
.statistic(new ClaimStatistic())
188+
.document(null)
189+
.configuration(configuration)
190+
.build();
191+
output.listLicenses(LicenseSetFactory.LicenseFilter.NONE);
192+
193+
out.flush();
194+
String document = out.toString();
195+
assertThat(document).contains("Licenses (NONE):");
196+
StringWriter writer = new StringWriter();
197+
try (PrintWriter printWriter = new PrintWriter(writer)) {
198+
output.listLicenses(printWriter, LicenseSetFactory.LicenseFilter.ALL);
199+
}
200+
assertThat(writer.toString()).contains("Licenses (ALL):");
201+
202+
}
203+
160204
}

‎apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ public class ReportConfigurationTest {
8383
private File tempDir;
8484

8585
@BeforeEach
86-
public void setup() {
86+
void setup() {
8787
log = new TestingLog();
8888
DefaultLog.setInstance(log);
8989
underTest = new ReportConfiguration();
9090
}
9191

9292
@AfterEach
93-
public void cleanup() {
93+
void cleanup() {
9494
DefaultLog.setInstance(null);
9595
}
9696

@@ -476,7 +476,7 @@ void outputTest() throws IOException {
476476
assertThat(underTest.getWriter()).isNotNull();
477477

478478
ByteArrayOutputStream stream = new ByteArrayOutputStream();
479-
underTest.setOut(new ReportConfiguration.IODescriptor("outputTest", () -> stream));
479+
underTest.setOut(new ReportConfiguration.IODescriptor<>("outputTest", () -> stream));
480480
assertThat(underTest.getOutput().get()).isEqualTo(stream);
481481
PrintWriter writer = underTest.getWriter().get();
482482
assertThat(writer).isNotNull();
@@ -565,7 +565,7 @@ void testValidate() {
565565
void testSetOut() throws IOException {
566566
ReportConfiguration config = new ReportConfiguration();
567567
try (OutputStreamInterceptor osi = new OutputStreamInterceptor()) {
568-
config.setOut(new ReportConfiguration.IODescriptor("testSetOut",() -> osi));
568+
config.setOut(new ReportConfiguration.IODescriptor<>("testSetOut",() -> osi));
569569
assertThat(osi.closeCount).isEqualTo(0);
570570
try (OutputStream os = config.getOutput().get()) {
571571
assertThat(os).isNotNull();
@@ -633,7 +633,7 @@ void familyDuplicateOptionsTest() {
633633
void logLicenseCollisionTest() {
634634
// setup
635635
ILicenseFamily family = ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("family name").build();
636-
IHeaderMatcher matcher = Mockito.mock(IHeaderMatcher.class);
636+
IHeaderMatcher matcher = mock(IHeaderMatcher.class);
637637
when(matcher.getId()).thenReturn("Macher ID");
638638
underTest.addFamily(family);
639639
underTest.addLicense(ILicense.builder().setId("ID").setName("license name").setFamily(family.getFamilyCategory())
@@ -661,7 +661,7 @@ void logLicenseCollisionTest() {
661661
public void licenseDuplicateOptionsTest() {
662662
// setup
663663
ILicenseFamily family = ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("family name").build();
664-
IHeaderMatcher matcher = Mockito.mock(IHeaderMatcher.class);
664+
IHeaderMatcher matcher = mock(IHeaderMatcher.class);
665665
when(matcher.getId()).thenReturn("Macher ID");
666666
underTest.addFamily(family);
667667
Function<String,ILicense> makeLicense = s -> ILicense.builder().setId("ID").setName(s).setFamily(family.getFamilyCategory())

‎apache-rat-core/src/test/java/org/apache/rat/ReporterOptionsProvider.java‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ protected void inputExcludeSizeTest() {
378378
Reporter reporter = new Reporter(config);
379379
Reporter.Output output = reporter.execute();
380380
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(3);
381-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(0);
381+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isZero();
382382

383383
// filter out source
384384
config = generateConfig(ImmutablePair.of(option, args));
@@ -469,7 +469,7 @@ protected void inputExcludeParsedScmTest() {
469469
Reporter.Output output = reporter.execute();
470470
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(11);
471471
// .gitignore is ignored by default as it is hidden but not counted
472-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(0);
472+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isZero();
473473

474474
config = generateConfig(ImmutablePair.of(option, args));
475475
reporter = new Reporter(config);
@@ -591,13 +591,13 @@ protected void inputSourceTest() {
591591
Reporter reporter = new Reporter(config);
592592
Reporter.Output output = reporter.execute();
593593
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(3);
594-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(0);
594+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isZero();
595595

596596
config = generateConfig(ImmutablePair.of(option, new String[]{inputFile.getAbsolutePath()}));
597597
reporter = new Reporter(config);
598598
output = reporter.execute();
599599
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
600-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isEqualTo(0);
600+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.IGNORED)).isZero();
601601
});
602602
}
603603

@@ -622,15 +622,15 @@ private void execLicenseFamiliesApprovedTest(final Option option, final String[]
622622
Reporter.Output output = reporter.execute();
623623

624624
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
625-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
625+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
626626
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
627627

628628
config = addCatzLicense(generateConfig(arg1));
629629
reporter = new Reporter(config);
630630
output = reporter.execute();
631631
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
632632
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
633-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
633+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
634634
});
635635
}
636636

@@ -662,13 +662,13 @@ private void execLicenseFamiliesDeniedTest(final Option option, final String[] a
662662
Reporter.Output output = reporter.execute();
663663
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
664664
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
665-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
665+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
666666

667667
config = generateConfig(arg1);
668668
reporter = new Reporter(config);
669669
output = reporter.execute();
670670
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
671-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
671+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
672672
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
673673
});
674674
}
@@ -710,7 +710,7 @@ private void configTest(final Option option) {
710710
output = reporter.execute();
711711
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
712712
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(2);
713-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
713+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
714714

715715
Pair<Option, String[]> arg2 = ImmutablePair.of(Arg.CONFIGURATION_NO_DEFAULTS.find("configuration-no-defaults"), null);
716716

@@ -756,7 +756,7 @@ protected void execLicensesApprovedTest(final Option option, String[] args) {
756756
output = reporter.execute();
757757
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(2);
758758
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(2);
759-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
759+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
760760
});
761761
}
762762

@@ -793,7 +793,7 @@ protected void scanHiddenDirectoriesTest() {
793793
Reporter.Output output = reporter.execute();
794794
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
795795
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
796-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
796+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
797797

798798
config = generateConfig(arg1);
799799
reporter = new Reporter(config);
@@ -817,7 +817,7 @@ private void outTest(final Option option) {
817817
Reporter.Output output = reporter.execute();
818818
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
819819
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(1);
820-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(0);
820+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isZero();
821821
output.format(config);
822822
String actualText = TextUtils.readFile(outFile);
823823
TextUtils.assertContainsExactly(1, "Apache License 2.0: 1 ", actualText);
@@ -856,7 +856,7 @@ private void styleSheetTest(final Option option) {
856856
Reporter reporter = new Reporter(config);
857857
Reporter.Output output = reporter.execute();
858858
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
859-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
859+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
860860
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
861861
output.format(config);
862862
String actualText = baos.toString(StandardCharsets.UTF_8);
@@ -886,7 +886,7 @@ private void styleSheetTest(final Option option) {
886886
Reporter reporter = new Reporter(config);
887887
Reporter.Output output = reporter.execute();
888888
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
889-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
889+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
890890
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
891891
output.format(config);
892892
String actualText = baos.toString(StandardCharsets.UTF_8);
@@ -928,7 +928,7 @@ protected void xmlTest() {
928928
Reporter reporter = new Reporter(config);
929929
Reporter.Output output = reporter.execute();
930930
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.STANDARDS)).isEqualTo(1);
931-
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isEqualTo(0);
931+
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.APPROVED)).isZero();
932932
assertThat(output.getStatistic().getCounter(ClaimStatistic.Counter.UNAPPROVED)).isEqualTo(1);
933933
output.format(config);
934934
String actualText = baos.toString(StandardCharsets.UTF_8);

‎apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
import static org.assertj.core.api.Assertions.assertThat;
2222
import static org.assertj.core.api.Fail.fail;
2323

24-
import java.io.ByteArrayInputStream;
2524
import java.io.ByteArrayOutputStream;
2625
import java.io.File;
2726
import java.io.PrintStream;
@@ -478,19 +477,6 @@ void unapprovedLicensesReportTest() throws Exception {
478477
TextUtils.assertPatternInTarget("\\Q/sub/Empty.txt\\E", document);
479478
}
480479

481-
@Test
482-
void listLicensesReportTest() throws Exception {
483-
ByteArrayOutputStream out = new ByteArrayOutputStream();
484-
ReportConfiguration configuration = initializeConfiguration();
485-
configuration.setOut(new ReportConfiguration.IODescriptor<>("listLicensesReportTest", () -> out));
486-
configuration.setStyleSheet(StyleSheets.UNAPPROVED_LICENSES.getStyleSheet());
487-
Reporter.listLicenses(configuration, LicenseSetFactory.LicenseFilter.NONE);
488-
489-
out.flush();
490-
String document = out.toString();
491-
assertThat(document).contains("Licenses (NONE):");
492-
}
493-
494480
@Test
495481
void counterMaxTest() throws Exception {
496482
ReportConfiguration config = initializeConfiguration();

0 commit comments

Comments
 (0)