Skip to content

Commit

Permalink
Fix variables with standard names. #1555
Browse files Browse the repository at this point in the history 
Fixes `StandardVariableNames` inspection violations in test code.

Description:
>Reports on any variables with 'standard' names which are of unexpected types. Such names may be confusing. Standard names and types are as follows:
- i, j, k, m, n - int
- f - float
- d - double
- b - byte
- c, ch - char
- l - long
- s, str - String
  • Loading branch information
@mkordas @romani
mkordas authored and romani committed Aug 22, 2015
1 parent a13ebd4 commit dad4fa5
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 73 deletions.
4 changes: 2 additions & 2 deletions src/it/java/com/google/checkstyle/test/base/ConfigurationBuilder.java
View file
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ private static void listFiles(final List<File> files, final File folder,
final String extension) { final String extension) {
if (folder.canRead()) { if (folder.canRead()) {
if (folder.isDirectory()) { if (folder.isDirectory()) {
for (final File f : folder.listFiles()) { for (final File file : folder.listFiles()) {
listFiles(files, f, extension); listFiles(files, file, extension);
} }
} else if (folder.toString().endsWith("." + extension)) { } else if (folder.toString().endsWith("." + extension)) {
files.add(folder); files.add(folder);
Expand Down
142 changes: 71 additions & 71 deletions src/test/java/com/puppycrawl/tools/checkstyle/CheckerTest.java
View file
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -41,165 +41,165 @@
public class CheckerTest { public class CheckerTest {
@Test @Test
public void testDestroy() throws Exception { public void testDestroy() throws Exception {
final DebugChecker c = new DebugChecker(); final DebugChecker checker = new DebugChecker();
final DebugAuditAdapter auditAdapter = new DebugAuditAdapter(); final DebugAuditAdapter auditAdapter = new DebugAuditAdapter();
c.addListener(auditAdapter); checker.addListener(auditAdapter);
final DebugFilter f = new DebugFilter(); final DebugFilter filter = new DebugFilter();
c.addFilter(f); checker.addFilter(filter);


c.destroy(); // should remove al listeners and filters checker.destroy(); // should remove al listeners and filters


// Let's try fire some events // Let's try fire some events
c.fireAuditStarted(); checker.fireAuditStarted();
c.fireAuditFinished(); checker.fireAuditFinished();
c.fireFileStarted("Some File Name"); checker.fireFileStarted("Some File Name");
c.fireFileFinished("Some File Name"); checker.fireFileFinished("Some File Name");


final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet(); final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet();
msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key", msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key",
new Object[] {"arg"}, null, getClass(), null)); new Object[] {"arg"}, null, getClass(), null));
c.fireErrors("Some File Name", msgs); checker.fireErrors("Some File Name", msgs);


assertFalse("Checker.destroy() doesn't remove listeners.", auditAdapter.wasCalled()); assertFalse("Checker.destroy() doesn't remove listeners.", auditAdapter.wasCalled());
assertFalse("Checker.destroy() doesn't remove filters.", f.wasCalled()); assertFalse("Checker.destroy() doesn't remove filters.", filter.wasCalled());
} }


@Test @Test
public void testAddListener() throws Exception { public void testAddListener() throws Exception {
final DebugChecker c = new DebugChecker(); final DebugChecker checker = new DebugChecker();
final DebugAuditAdapter auditAdapter = new DebugAuditAdapter(); final DebugAuditAdapter auditAdapter = new DebugAuditAdapter();
c.addListener(auditAdapter); checker.addListener(auditAdapter);


// Let's try fire some events // Let's try fire some events
c.fireAuditStarted(); checker.fireAuditStarted();
assertTrue("Checker.fireAuditStarted() doesn't call listener", auditAdapter.wasCalled()); assertTrue("Checker.fireAuditStarted() doesn't call listener", auditAdapter.wasCalled());


auditAdapter.resetListener(); auditAdapter.resetListener();
c.fireAuditFinished(); checker.fireAuditFinished();
assertTrue("Checker.fireAuditFinished() doesn't call listener", auditAdapter.wasCalled()); assertTrue("Checker.fireAuditFinished() doesn't call listener", auditAdapter.wasCalled());


auditAdapter.resetListener(); auditAdapter.resetListener();
c.fireFileStarted("Some File Name"); checker.fireFileStarted("Some File Name");
assertTrue("Checker.fireFileStarted() doesn't call listener", auditAdapter.wasCalled()); assertTrue("Checker.fireFileStarted() doesn't call listener", auditAdapter.wasCalled());


auditAdapter.resetListener(); auditAdapter.resetListener();
c.fireFileFinished("Some File Name"); checker.fireFileFinished("Some File Name");
assertTrue("Checker.fireFileFinished() doesn't call listener", auditAdapter.wasCalled()); assertTrue("Checker.fireFileFinished() doesn't call listener", auditAdapter.wasCalled());


auditAdapter.resetListener(); auditAdapter.resetListener();
final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet(); final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet();
msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key", msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key",
new Object[] {"arg"}, null, getClass(), null)); new Object[] {"arg"}, null, getClass(), null));
c.fireErrors("Some File Name", msgs); checker.fireErrors("Some File Name", msgs);
assertTrue("Checker.fireErrors() doesn't call listener", auditAdapter.wasCalled()); assertTrue("Checker.fireErrors() doesn't call listener", auditAdapter.wasCalled());
} }


@Test @Test
public void testRemoveListener() throws Exception { public void testRemoveListener() throws Exception {
final DebugChecker c = new DebugChecker(); final DebugChecker checker = new DebugChecker();
final DebugAuditAdapter auditAdapter = new DebugAuditAdapter(); final DebugAuditAdapter auditAdapter = new DebugAuditAdapter();
final DebugAuditAdapter aa2 = new DebugAuditAdapter(); final DebugAuditAdapter aa2 = new DebugAuditAdapter();
c.addListener(auditAdapter); checker.addListener(auditAdapter);
c.addListener(aa2); checker.addListener(aa2);
c.removeListener(auditAdapter); checker.removeListener(auditAdapter);


// Let's try fire some events // Let's try fire some events
c.fireAuditStarted(); checker.fireAuditStarted();
assertTrue("Checker.fireAuditStarted() doesn't call listener", aa2.wasCalled()); assertTrue("Checker.fireAuditStarted() doesn't call listener", aa2.wasCalled());
assertFalse("Checker.fireAuditStarted() does call removed listener", auditAdapter.wasCalled()); assertFalse("Checker.fireAuditStarted() does call removed listener", auditAdapter.wasCalled());


aa2.resetListener(); aa2.resetListener();
c.fireAuditFinished(); checker.fireAuditFinished();
assertTrue("Checker.fireAuditFinished() doesn't call listener", aa2.wasCalled()); assertTrue("Checker.fireAuditFinished() doesn't call listener", aa2.wasCalled());
assertFalse("Checker.fireAuditFinished() does call removed listener", auditAdapter.wasCalled()); assertFalse("Checker.fireAuditFinished() does call removed listener", auditAdapter.wasCalled());


aa2.resetListener(); aa2.resetListener();
c.fireFileStarted("Some File Name"); checker.fireFileStarted("Some File Name");
assertTrue("Checker.fireFileStarted() doesn't call listener", aa2.wasCalled()); assertTrue("Checker.fireFileStarted() doesn't call listener", aa2.wasCalled());
assertFalse("Checker.fireFileStarted() does call removed listener", auditAdapter.wasCalled()); assertFalse("Checker.fireFileStarted() does call removed listener", auditAdapter.wasCalled());


aa2.resetListener(); aa2.resetListener();
c.fireFileFinished("Some File Name"); checker.fireFileFinished("Some File Name");
assertTrue("Checker.fireFileFinished() doesn't call listener", aa2.wasCalled()); assertTrue("Checker.fireFileFinished() doesn't call listener", aa2.wasCalled());
assertFalse("Checker.fireFileFinished() does call removed listener", auditAdapter.wasCalled()); assertFalse("Checker.fireFileFinished() does call removed listener", auditAdapter.wasCalled());


aa2.resetListener(); aa2.resetListener();
final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet(); final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet();
msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key", msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key",
new Object[] {"arg"}, null, getClass(), null)); new Object[] {"arg"}, null, getClass(), null));
c.fireErrors("Some File Name", msgs); checker.fireErrors("Some File Name", msgs);
assertTrue("Checker.fireErrors() doesn't call listener", aa2.wasCalled()); assertTrue("Checker.fireErrors() doesn't call listener", aa2.wasCalled());
assertFalse("Checker.fireErrors() does call removed listener", auditAdapter.wasCalled()); assertFalse("Checker.fireErrors() does call removed listener", auditAdapter.wasCalled());


} }


@Test @Test
public void testAddFilter() throws Exception { public void testAddFilter() throws Exception {
final DebugChecker c = new DebugChecker(); final DebugChecker checker = new DebugChecker();
final DebugFilter f = new DebugFilter(); final DebugFilter filter = new DebugFilter();


c.addFilter(f); checker.addFilter(filter);


f.resetFilter(); filter.resetFilter();
final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet(); final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet();
msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key", msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key",
new Object[] {"arg"}, null, getClass(), null)); new Object[] {"arg"}, null, getClass(), null));
c.fireErrors("Some File Name", msgs); checker.fireErrors("Some File Name", msgs);
assertTrue("Checker.fireErrors() doesn't call filter", f.wasCalled()); assertTrue("Checker.fireErrors() doesn't call filter", filter.wasCalled());
} }


@Test @Test
public void testRemoveFilter() throws Exception { public void testRemoveFilter() throws Exception {
final DebugChecker c = new DebugChecker(); final DebugChecker checker = new DebugChecker();
final DebugFilter f = new DebugFilter(); final DebugFilter filter = new DebugFilter();
final DebugFilter f2 = new DebugFilter(); final DebugFilter f2 = new DebugFilter();
c.addFilter(f); checker.addFilter(filter);
c.addFilter(f2); checker.addFilter(f2);
c.removeFilter(f); checker.removeFilter(filter);


f2.resetFilter(); f2.resetFilter();
final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet(); final TreeSet<LocalizedMessage> msgs = Sets.newTreeSet();
msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key", msgs.add(new LocalizedMessage(0, 0, "a Bundle", "message.key",
new Object[] {"arg"}, null, getClass(), null)); new Object[] {"arg"}, null, getClass(), null));
c.fireErrors("Some File Name", msgs); checker.fireErrors("Some File Name", msgs);
assertTrue("Checker.fireErrors() doesn't call filter", f2.wasCalled()); assertTrue("Checker.fireErrors() doesn't call filter", f2.wasCalled());
assertFalse("Checker.fireErrors() does call removed filter", f.wasCalled()); assertFalse("Checker.fireErrors() does call removed filter", filter.wasCalled());


} }


@Test @Test
public void testFileExtensions() throws Exception { public void testFileExtensions() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();
final List<File> files = new ArrayList<>(); final List<File> files = new ArrayList<>();
File f = new File("file.pdf"); File file = new File("file.pdf");
files.add(f); files.add(file);
f = new File("file.java"); file = new File("file.java");
files.add(f); files.add(file);
final String[] fileExtensions = {"java", "xml", "properties"}; final String[] fileExtensions = {"java", "xml", "properties"};
c.setFileExtensions(fileExtensions); checker.setFileExtensions(fileExtensions);
final int counter = c.process(files); final int counter = checker.process(files);
assertEquals(1, counter); // comparing to 1 as there is only one legal file in input assertEquals(1, counter); // comparing to 1 as there is only one legal file in input
} }


@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
@Test @Test
public void testSetters() throws Exception { public void testSetters() throws Exception {
// all that is set by reflection, so just make code coverage be happy // all that is set by reflection, so just make code coverage be happy
final Checker c = new Checker(); final Checker checker = new Checker();
c.setClassLoader(getClass().getClassLoader()); checker.setClassLoader(getClass().getClassLoader());
c.setClassloader(getClass().getClassLoader()); checker.setClassloader(getClass().getClassLoader());
c.setBasedir("some"); checker.setBasedir("some");
c.setSeverity("ignore"); checker.setSeverity("ignore");


PackageObjectFactory factory = new PackageObjectFactory( PackageObjectFactory factory = new PackageObjectFactory(
new HashSet<String>(), Thread.currentThread().getContextClassLoader()); new HashSet<String>(), Thread.currentThread().getContextClassLoader());
c.setModuleFactory(factory); checker.setModuleFactory(factory);


c.setFileExtensions((String[]) null); checker.setFileExtensions((String[]) null);
c.setFileExtensions(".java", "xml"); checker.setFileExtensions(".java", "xml");


try { try {
c.setCharset("UNKNOW-CHARSET"); checker.setCharset("UNKNOW-CHARSET");
fail("Exception is expected"); fail("Exception is expected");
} }
catch (UnsupportedEncodingException ex) { catch (UnsupportedEncodingException ex) {
Expand All @@ -209,10 +209,10 @@ public void testSetters() throws Exception {


@Test @Test
public void testNoClassLoaderNoModuleFactory() throws Exception { public void testNoClassLoaderNoModuleFactory() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();


try { try {
c.finishLocalSetup(); checker.finishLocalSetup();
fail("Exception is expected"); fail("Exception is expected");
} }
catch (CheckstyleException ex) { catch (CheckstyleException ex) {
Expand All @@ -223,33 +223,33 @@ public void testNoClassLoaderNoModuleFactory() throws Exception {


@Test @Test
public void testNoModuleFactory() throws Exception { public void testNoModuleFactory() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();
c.setModuleClassLoader(Thread.currentThread().getContextClassLoader()); checker.setModuleClassLoader(Thread.currentThread().getContextClassLoader());


c.finishLocalSetup(); checker.finishLocalSetup();
} }


@Test @Test
public void testFinishLocalSetupFullyInitialized() throws Exception { public void testFinishLocalSetupFullyInitialized() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();
c.setModuleClassLoader(Thread.currentThread().getContextClassLoader()); checker.setModuleClassLoader(Thread.currentThread().getContextClassLoader());
PackageObjectFactory factory = new PackageObjectFactory( PackageObjectFactory factory = new PackageObjectFactory(
new HashSet<String>(), Thread.currentThread().getContextClassLoader()); new HashSet<String>(), Thread.currentThread().getContextClassLoader());
c.setModuleFactory(factory); checker.setModuleFactory(factory);


c.finishLocalSetup(); checker.finishLocalSetup();
} }


@Test @Test
public void testSetupChildExceptions() throws Exception { public void testSetupChildExceptions() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();
PackageObjectFactory factory = new PackageObjectFactory( PackageObjectFactory factory = new PackageObjectFactory(
new HashSet<String>(), Thread.currentThread().getContextClassLoader()); new HashSet<String>(), Thread.currentThread().getContextClassLoader());
c.setModuleFactory(factory); checker.setModuleFactory(factory);


Configuration config = new DefaultConfiguration("java.lang.String"); Configuration config = new DefaultConfiguration("java.lang.String");
try { try {
c.setupChild(config); checker.setupChild(config);
fail("Exception is expected"); fail("Exception is expected");
} }
catch (CheckstyleException ex) { catch (CheckstyleException ex) {
Expand All @@ -260,12 +260,12 @@ public void testSetupChildExceptions() throws Exception {


@Test @Test
public void testSetupChildListener() throws Exception { public void testSetupChildListener() throws Exception {
final Checker c = new Checker(); final Checker checker = new Checker();
PackageObjectFactory factory = new PackageObjectFactory( PackageObjectFactory factory = new PackageObjectFactory(
new HashSet<String>(), Thread.currentThread().getContextClassLoader()); new HashSet<String>(), Thread.currentThread().getContextClassLoader());
c.setModuleFactory(factory); checker.setModuleFactory(factory);


Configuration config = new DefaultConfiguration(DebugAuditAdapter.class.getCanonicalName()); Configuration config = new DefaultConfiguration(DebugAuditAdapter.class.getCanonicalName());
c.setupChild(config); checker.setupChild(config);
} }
} }

0 comments on commit dad4fa5

Please sign in to comment.