com.puppycrawl.tools.checkstyle.checks.TranslationCheckTest.java Source code

Introduction

Here is the source code for com.puppycrawl.tools.checkstyle.checks.TranslationCheckTest.java

Source

////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks;

import static com.puppycrawl.tools.checkstyle.checks.TranslationCheck.MSG_KEY;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Method;

import org.apache.commons.lang3.ArrayUtils;
import org.junit.Test;

import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.Configuration;

public class TranslationCheckTest extends BaseCheckTestSupport {
    @Override
    protected DefaultConfiguration createCheckerConfig(Configuration config) {
        final DefaultConfiguration dc = new DefaultConfiguration("root");
        dc.addChild(config);
        return dc;
    }

    @Override
    protected String getPath(String filename) throws IOException {
        return super.getPath("checks" + File.separator + filename);
    }

    @Test
    public void testTranslation() throws Exception {
        final Configuration checkConfig = createCheckConfig(TranslationCheck.class);
        final String[] expected = { "0: " + getCheckMessage(MSG_KEY, "only.english"), };
        final File[] propertyFiles = { new File(getPath("messages_test_de.properties")),
                new File(getPath("messages_test.properties")), };
        verify(createChecker(checkConfig), propertyFiles, getPath("messages_test_de.properties"), expected);
    }

    @Test
    public void testBaseNameSeparator() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("basenameSeparator", "-");
        final String[] expected = { "0: " + getCheckMessage(MSG_KEY, "only.english"), };
        final File[] propertyFiles = { new File(getPath("app-dev.properties")),
                new File(getPath("app-stage.properties")), };
        verify(createChecker(checkConfig), propertyFiles, getPath("app-dev.properties"), expected);
    }

    @Test
    public void testOnePropertyFileSet() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
        final File[] propertyFiles = { new File(getPath("app-dev.properties")), };
        verify(createChecker(checkConfig), propertyFiles, getPath("app-dev.properties"), expected);
    }

    @Test
    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.
        TranslationCheck check = new TranslationCheck();
        DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        check.configure(checkConfig);
        Checker checker = createChecker(checkConfig);
        check.setMessageDispatcher(checker);

        Method loadKeys = check.getClass().getDeclaredMethod("loadKeys", File.class);
        loadKeys.setAccessible(true);
        loadKeys.invoke(check, new File(""));

    }

    @Test
    public void testLogIOException() 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.
        TranslationCheck check = new TranslationCheck();
        DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        check.configure(checkConfig);
        check.setMessageDispatcher(createChecker(checkConfig));

        Method logIOException = check.getClass().getDeclaredMethod("logIOException", IOException.class, File.class);
        logIOException.setAccessible(true);
        logIOException.invoke(check, new IOException("test exception"), new File(""));
    }

    @Test
    public void testDefaultTranslationFileIsMissing() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("requiredTranslations", "ja,,, de, ja");

        final File[] propertyFiles = { new File(getPath("messages_translation_de.properties")),
                new File(getPath("messages_translation_ja.properties")), };

        final String[] expected = { "0: Properties file 'messages_translation.properties' is missing.", };
        verify(createChecker(checkConfig), propertyFiles, getPath(""), expected);
    }

    @Test
    public void testTranslationFilesAreMissing() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("requiredTranslations", "ja, de");

        final File[] propertyFiles = { new File(getPath("messages_translation.properties")),
                new File(getPath("messages_translation_ja.properties")), };

        final String[] expected = { "0: Properties file 'messages_translation_de.properties' is missing.", };
        verify(createChecker(checkConfig), propertyFiles, getPath(""), expected);
    }

    @Test
    public void testBaseNameSeparatorDefaultTranslationIsMissing() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("requiredTranslations", "fr");
        checkConfig.addAttribute("basenameSeparator", "-");

        final File[] propertyFiles = { new File(getPath("messages-translation_fr.properties")), };

        final String[] expected = { "0: Properties file 'messages-translation.properties' is missing.", };
        verify(createChecker(checkConfig), propertyFiles, getPath(""), expected);
    }

    @Test
    public void testBaseNameSeparatorTranslationsAreMissing() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("requiredTranslations", "fr, tr");
        checkConfig.addAttribute("basenameSeparator", "-");

        final File[] propertyFiles = { new File(getPath("messages-translation.properties")),
                new File(getPath("messages-translation_fr.properties")), };

        final String[] expected = { "0: Properties file 'messages-translation_tr.properties' is missing.", };
        verify(createChecker(checkConfig), propertyFiles, getPath(""), expected);
    }

    @Test
    public void testIsNotMessagesBundle() throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(TranslationCheck.class);
        checkConfig.addAttribute("requiredTranslations", "de");

        final File[] propertyFiles = { new File(getPath("app-dev.properties")),
                new File(getPath("app-stage.properties")), };

        final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
        verify(createChecker(checkConfig), propertyFiles, getPath("app-dev.properties"), expected);
    }
}