RedundantReturnCheckTest.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.RedundantReturnCheck.MSG_KEY;

import org.junit.Assert;
import org.junit.Test;

import com.github.sevntu.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public class RedundantReturnCheckTest extends BaseCheckTestSupport {
    @Test
    public void testInputWithIgnoreEmptyConstructorsTrue()
            throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(RedundantReturnCheck.class);
        checkConfig.addAttribute("allowReturnInEmptyMethodsAndConstructors",
                "false");

        final String[] expected = {
            "10: " + getCheckMessage(MSG_KEY),
            "17: " + getCheckMessage(MSG_KEY),
            "22: " + getCheckMessage(MSG_KEY),
            "32: " + getCheckMessage(MSG_KEY),
            "39: " + getCheckMessage(MSG_KEY),
            "52: " + getCheckMessage(MSG_KEY),
            "56: " + getCheckMessage(MSG_KEY),
            "60: " + getCheckMessage(MSG_KEY),
            "87: " + getCheckMessage(MSG_KEY),
            "100: " + getCheckMessage(MSG_KEY),
            "104: " + getCheckMessage(MSG_KEY),
            "117: " + getCheckMessage(MSG_KEY),
            "128: " + getCheckMessage(MSG_KEY),
            "140: " + getCheckMessage(MSG_KEY),
            "151: " + getCheckMessage(MSG_KEY),
            "181: " + getCheckMessage(MSG_KEY),
        };

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

    @Test
    public void testInputWithIgnoreEmptyConstructorsFalse()
            throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(RedundantReturnCheck.class);
        checkConfig.addAttribute("allowReturnInEmptyMethodsAndConstructors",
                "true");

        final String[] expected = {
            "17: " + getCheckMessage(MSG_KEY),
            "32: " + getCheckMessage(MSG_KEY),
            "39: " + getCheckMessage(MSG_KEY),
            "52: " + getCheckMessage(MSG_KEY),
            "56: " + getCheckMessage(MSG_KEY),
            "60: " + getCheckMessage(MSG_KEY),
            "100: " + getCheckMessage(MSG_KEY),
            "104: " + getCheckMessage(MSG_KEY),
            "117: " + getCheckMessage(MSG_KEY),
            "128: " + getCheckMessage(MSG_KEY),
            "140: " + getCheckMessage(MSG_KEY),
            "151: " + getCheckMessage(MSG_KEY),
            "181: " + getCheckMessage(MSG_KEY),
        };

        verify(checkConfig, getPath("InputRedundantReturnCheck.java"), expected);

    }

    @Test
    public void testForNullPointerExceptionsPresence()
            throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(RedundantReturnCheck.class);

        final String[] expected = {};

        verify(checkConfig, "src/test/resources-noncompilable/com/github/sevntu/checkstyle/checks/"
                + "coding/InputRedundantReturnCheckTestNPE.java", expected);

    }

    @Test
    public void testForNullPointerExceptionsInInterface()
            throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(RedundantReturnCheck.class);

        final String[] expected = {};

        verify(checkConfig, getPath("InputRedundantReturnCheckMethodInInterface.java"), expected);

    }

    @Test
    public void testSomeFalsePositiveCase()
            throws Exception {
        final DefaultConfiguration checkConfig = createCheckConfig(RedundantReturnCheck.class);

        final String[] expected = {};

        verify(checkConfig, getPath("InputRedundantReturnCheckFalsePositive.java"), expected);

    }

    @Test
    public void testUnsupportedNode() {
        final DetailAST sync = new DetailAST();
        sync.setType(TokenTypes.LITERAL_SYNCHRONIZED);

        try {
            final RedundantReturnCheck check = new RedundantReturnCheck();
            check.visitToken(sync);

            fail();
        }
        catch (IllegalArgumentException ex) {
            Assert.assertEquals("Found unsupported token: LITERAL_SYNCHRONIZED", ex.getMessage());
        }
    }

}