Java Checker类代码示例

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
protected void verify(Checker checker, File[] processedFiles, String messageFileName, String... expectedErrorTexts)
		throws Exception {
	this.stream.flush();
	int numberOfErrors = checker.process(Arrays.asList(processedFiles));

	LineNumberReader errors = new LineNumberReader(
			new InputStreamReader(new ByteArrayInputStream(this.stream.toByteArray())));

	for (int i = 0; i < expectedErrorTexts.length; ++i) {
		String actual = errors.readLine();
		assertThat(actual).as("error message %s", i).contains(expectedErrorTexts[i]);
	}

	assertThat(numberOfErrors).as("got unexpected error count with error message: %s", errors.readLine())
			.isEqualTo(expectedErrorTexts.length);

	checker.destroy();
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/**
 * Creates {@link Checker} instance based on the given {@link Configuration} instance.
 * @param moduleConfig {@link Configuration} instance.
 * @return {@link Checker} instance based on the given {@link Configuration} instance.
 * @throws Exception if an exception occurs during checker configuration.
 */
public final Checker createChecker(Configuration moduleConfig)
        throws Exception {
    if (checkstyleModules == null) {
        checkstyleModules = CheckUtil.getCheckstyleModules();
    }

    final String name = moduleConfig.getName();
    ModuleCreationOption moduleCreationOption = ModuleCreationOption.IN_CHECKER;

    for (Class<?> moduleClass : checkstyleModules) {
        if (moduleClass.getSimpleName().equals(name)
                || moduleClass.getSimpleName().equals(name + "Check")) {
            if (ModuleReflectionUtils.isCheckstyleTreeWalkerCheck(moduleClass)
                    || ModuleReflectionUtils.isTreeWalkerFilterModule(moduleClass)) {
                moduleCreationOption = ModuleCreationOption.IN_TREEWALKER;
            }
            break;
        }
    }

    return createChecker(moduleConfig, moduleCreationOption);
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
@Test
public void testIsSuppressedWithAllArgument() throws Exception {
    createHolder("all", 100, 100, 350, 350);

    final Checker source = new Checker();
    final LocalizedMessage firstMessageForTest =
        new LocalizedMessage(100, 10, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent firstEventForTest =
        new AuditEvent(source, "fileName", firstMessageForTest);
    assertFalse("Event is suppressed",
            SuppressWarningsHolder.isSuppressed(firstEventForTest));

    final LocalizedMessage secondMessageForTest =
        new LocalizedMessage(100, 150, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent secondEventForTest =
        new AuditEvent(source, "fileName", secondMessageForTest);
    assertTrue("Event is not suppressed",
            SuppressWarningsHolder.isSuppressed(secondEventForTest));

    final LocalizedMessage thirdMessageForTest =
        new LocalizedMessage(200, 1, null, null, null, "id", MemberNameCheck.class, "msg");
    final AuditEvent thirdEventForTest =
        new AuditEvent(source, "fileName", thirdMessageForTest);
    assertTrue("Event is not suppressed",
            SuppressWarningsHolder.isSuppressed(thirdEventForTest));
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
@Test
@SuppressWarnings("unchecked")
public void testLogIoExceptionFileNotFound() throws Exception {
    //I can't put wrong file here. Checkstyle fails before check started.
    //I saw some usage of file or handling of wrong file in Checker, or somewhere
    //in checks running part. So I had to do it with reflection to improve coverage.
    final TranslationCheck check = new TranslationCheck();
    final DefaultConfiguration checkConfig = createModuleConfig(TranslationCheck.class);
    check.configure(checkConfig);
    final Checker checker = createChecker(checkConfig);
    final SeverityLevelCounter counter = new SeverityLevelCounter(SeverityLevel.ERROR);
    checker.addListener(counter);
    check.setMessageDispatcher(checker);

    final Method loadKeys =
        check.getClass().getDeclaredMethod("getTranslationKeys", File.class);
    loadKeys.setAccessible(true);
    final Set<String> keys = (Set<String>) loadKeys.invoke(check, new File(""));
    assertTrue("Translation keys should be empty when File is not found", keys.isEmpty());
    assertEquals("Invalid error count", 1, counter.getCount());
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
@Test
public void testBeginTreeClear() throws Exception {
    final DefaultConfiguration checkConfig =
        createModuleConfig(CustomImportOrderCheck.class);
    checkConfig.addAttribute("specialImportsRegExp", "com");
    checkConfig.addAttribute("separateLineBetweenGroups", "false");
    checkConfig.addAttribute("customImportOrderRules",
        "STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS");
    final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
    final Checker checker = createChecker(checkConfig);
    final String fileName1 = getPath("InputCustomImportOrderImportsContainingJava.java");
    final String fileName2 = getPath("InputCustomImportOrderNoValid.java");
    final File[] files = {
        new File(fileName1),
        new File(fileName2),
    };
    verify(checker, files, fileName1, expected);
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
@Test
public void testAllModulesWithDefaultConfiguration() throws Exception {
    final String inputFilePath = getPath("InputAllChecksDefaultConfig.java");
    final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;

    for (Class<?> module : CheckUtil.getCheckstyleModules()) {
        if (ModuleReflectionUtils.isRootModule(module)) {
            continue;
        }

        final DefaultConfiguration moduleConfig = createModuleConfig(module);
        final Checker checker;
        if (module.equals(ImportControlCheck.class)) {
            // ImportControlCheck must have the import control configuration file to avoid
            // violation.
            moduleConfig.addAttribute("file", getPath(
                    "InputAllChecksImportControl.xml"));
        }
        checker = createChecker(moduleConfig);
        verify(checker, inputFilePath, expected);
    }
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
private void verify(Checker checker, File[] processedFiles, String messageFileName,
                    String[] expected) throws Exception {
  printStream.flush();
  List<File> testInputFiles = Lists.newArrayList(processedFiles);
  int foundErrorsCount = checker.process(testInputFiles);

  // Process each output line
  ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
  BufferedReader br = new BufferedReader(new InputStreamReader(bais));

  try {
    for (int i = 0; i < expected.length; i++) {
      final String expectedResult = messageFileName + ":" + expected[i];
      final String actual = br.readLine();
      assertEquals("error message " + i, expectedResult, actual);
    }

    assertEquals("Check generated unexpected warning: " + br.readLine(), expected.length,
                 foundErrorsCount);
    checker.destroy();
  } finally {
    br.close();
    bais.close();
  }
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
protected void verify(Checker checker, File[] processedFiles, String messageFileName,
                      String[] expected) throws Exception {
    printStream.flush();
    List<File> testInputFiles = Lists.newArrayList(processedFiles);
    int foundErrorsCount = checker.process(testInputFiles);

    // Process each output line
    ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
    BufferedReader br = new BufferedReader(new InputStreamReader(bais));

    try {
        for (int i = 0; i < expected.length; i++) {
            final String expectedResult = messageFileName + ":" + expected[i];
            final String actual = br.readLine();
            assertEquals("error message " + i, expectedResult, actual);
        }

        assertEquals("Check generated unexpected warning: " + br.readLine(), expected.length, foundErrorsCount);
        checker.destroy();
    } finally {
        br.close();
        bais.close();
    }
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
protected Checker createChecker(final Configuration pCheckConfig)
    throws Exception
{
    final DefaultConfiguration dc = createCheckerConfig(pCheckConfig);
    final Checker c = new Checker();
    // make sure the tests always run with english error messages
    // so the tests don't fail in supported locales like german
    final Locale locale = Locale.ENGLISH;
    c.setLocaleCountry(locale.getCountry());
    c.setLocaleLanguage(locale.getLanguage());
    c.setModuleClassLoader(Thread.currentThread().getContextClassLoader());
    c.configure(dc);
    c.addListener(new BriefLogger(mStream));
    return c;
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/**
 * Constructor.
 * @param env Environment to use.
 */
@SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
public CheckstyleValidator(final Environment env) {
    this.checker = new Checker();
    this.checker.setClassLoader(env.classloader());
    this.checker.setModuleClassLoader(
        Thread.currentThread().getContextClassLoader()
    );
    try {
        this.checker.configure(this.configuration(env));
    } catch (final CheckstyleException ex) {
        throw new IllegalStateException("Failed to configure checker", ex);
    }
    this.listener = new CheckstyleListener(env);
    this.checker.addListener(this.listener);
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/**
 * Creates {@link Checker} instance based on the given {@link Configuration} instance.
 * @param moduleConfig {@link Configuration} instance.
 * @return {@link Checker} instance based on the given {@link Configuration} instance.
 * @throws Exception if an exception occurs during checker configuration.
 */
public final Checker createChecker(Configuration moduleConfig)
        throws Exception {
    final String name = moduleConfig.getName();
    ModuleCreationOption moduleCreationOption = ModuleCreationOption.IN_CHECKER;

    for (Class<?> moduleClass : CHECKSTYLE_MODULES) {
        if (moduleClass.getSimpleName().equals(name)
                || moduleClass.getSimpleName().equals(name + "Check")) {
            if (ModuleReflectionUtils.isCheckstyleTreeWalkerCheck(moduleClass)
                    || ModuleReflectionUtils.isTreeWalkerFilterModule(moduleClass)) {
                moduleCreationOption = ModuleCreationOption.IN_TREEWALKER;
            }
            break;
        }
    }

    return createChecker(moduleConfig, moduleCreationOption);
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
protected void verify(final Checker aC, final File[] aProcessedFiles, final String aMessageFileName, final String[] aExpected) throws Exception {
    this.mStream.flush();
    final List<File> theFiles = Lists.newArrayList();
    Collections.addAll(theFiles, aProcessedFiles);
    final int errs = aC.process(theFiles);

    // process each of the lines
    final ByteArrayInputStream bais = new ByteArrayInputStream(this.mBAOS.toByteArray());
    final LineNumberReader lnr = new LineNumberReader(new InputStreamReader(bais));

    for (int i = 0; i < aExpected.length; i++) {
        final String expected = aMessageFileName + ":" + aExpected[i];
        final String actual = lnr.readLine();
        Assert.assertEquals("error message " + i, expected, actual);
    }

    Assert.assertEquals("unexpected output: " + lnr.readLine(), aExpected.length, errs);
    aC.destroy();
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void auditStarted(AuditEvent aEvt)
{
    if (mInitialized) {
        final Log log = mLogFactory.getInstance(Checker.class);
        log.info("Audit started.");
    }
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void auditFinished(AuditEvent aEvt)
{
    if (mInitialized) {
        final Log log = mLogFactory.getInstance(Checker.class);
        log.info("Audit finished.");
    }
}
 

import com.puppycrawl.tools.checkstyle.Checker; //导入依赖的package包/类
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void fileStarted(AuditEvent aEvt)
{
    if (mInitialized) {
        final Log log = mLogFactory.getInstance(Checker.class);
        log.info("File \"" + aEvt.getFileName() + "\" started.");
    }
}