MapIterationInForEachLoopCheckTest.java

////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 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.github.sevntu.checkstyle.checks.coding;

import static com.github.sevntu.checkstyle.checks.coding.MapIterationInForEachLoopCheck.MSG_KEY_ENTRYSET;
import static com.github.sevntu.checkstyle.checks.coding.MapIterationInForEachLoopCheck.MSG_KEY_KEYSET;
import static com.github.sevntu.checkstyle.checks.coding.MapIterationInForEachLoopCheck.MSG_KEY_VALUES;

import org.junit.Test;

import com.github.sevntu.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;

public class MapIterationInForEachLoopCheckTest extends BaseCheckTestSupport {

    /**
     * Default check configuration
     */
    private final DefaultConfiguration checkConfig =
        createCheckConfig(MapIterationInForEachLoopCheck.class);

    @Test
    public final void basicTest() throws Exception {
        checkConfig.addAttribute("proposeValuesUsage", "true");
        checkConfig.addAttribute("proposeKeySetUsage", "true");
        checkConfig.addAttribute("proposeEntrySetUsage", "true");

        final String[] expected = {
            "23:13: " + getCheckMessage(MSG_KEY_ENTRYSET),
            "46:13: " + getCheckMessage(MSG_KEY_VALUES),
            "48:17: " + getCheckMessage(MSG_KEY_KEYSET),
            "72:17: " + getCheckMessage(MSG_KEY_ENTRYSET),
            "77:13: " + getCheckMessage(MSG_KEY_KEYSET),
            "84:9: " + getCheckMessage(MSG_KEY_ENTRYSET),
            "89:9: " + getCheckMessage(MSG_KEY_VALUES),
            "107:9: " + getCheckMessage(MSG_KEY_ENTRYSET),
            "117:9: " + getCheckMessage(MSG_KEY_VALUES),
        };

        verify(checkConfig,
                getPath("InputMapIterationInForEachLoopCheck.java"), expected);
    }

    @Test
    public final void importsWithoutFullPathTest() throws Exception {
        checkConfig.addAttribute("proposeValuesUsage", "true");
        checkConfig.addAttribute("proposeKeySetUsage", "true");
        checkConfig.addAttribute("proposeEntrySetUsage", "true");

        final String[] expected = {
            "12:9: " + getCheckMessage(MSG_KEY_ENTRYSET),
        };
        verify(checkConfig,
                getPath("InputMapIterationInForEachLoopCheckImport.java"),
                expected);
    }

    @Test
    public final void skipIfConditionTest() throws Exception {
        checkConfig.addAttribute("proposeValuesUsage", "false");
        checkConfig.addAttribute("proposeKeySetUsage", "true");
        checkConfig.addAttribute("proposeEntrySetUsage", "true");

        final String supportedMapImplQualifiedNames =
                "java.util.Map, "
                + "java.util.HashMap, java.util.TreeMap, "
                + "com.myTest.InputMyMap";

        checkConfig.addAttribute("supportedMapImplQualifiedNames",
                supportedMapImplQualifiedNames);

        final String[] expected = {
            "14:9: " + getCheckMessage(MSG_KEY_ENTRYSET),
        };

        verify(checkConfig,
                getPath("InputMapIterationInForEachLoopCheckSkipIf.java"),
                expected);
    }

    @Test
    public final void testClassExtendingMap() throws Exception {
        checkConfig.addAttribute("proposeValuesUsage", "true");
        checkConfig.addAttribute("proposeKeySetUsage", "true");
        checkConfig.addAttribute("proposeEntrySetUsage", "true");

        verify(checkConfig,
                getPath("InputMapIterationInForEachLoopCheckExtendingMap.java"),
                CommonUtils.EMPTY_STRING_ARRAY);
    }

}