cppcheck/testconstructors.cpp

/*
 * c++check - c/c++ syntax checking
 * Copyright (C) 2007 Daniel Marjamäki
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/
 */



#define UNIT_TESTING
#include "tokenize.h"
#include "CheckClass.h"
#include "testsuite.h"
#include <sstream>

extern std::ostringstream errout;

class TestConstructors : public TestFixture
{
public:
    TestConstructors() : TestFixture("TestConstructors")
    { }

private:


    void check( const char code[] )
    {
        // Tokenize..
        Tokenizer tokenizer;
        std::istringstream istr(code);
        tokenizer.tokenize( istr, "test.cpp" );
        tokenizer.simplifyTokenList();

        // Clear the error buffer..
        errout.str("");

        // Check class constructors..
        Settings settings;
        settings._checkCodingStyle = true;
        CheckClass checkClass( &tokenizer, settings, this );
        checkClass.CheckConstructors();
    }

    void run()
    {
        TEST_CASE( simple1 );
        TEST_CASE( simple2 );
        TEST_CASE( simple3 );
        TEST_CASE( simple4 );

        TEST_CASE( initvar_with_this );     // BUG 2190300
        TEST_CASE( initvar_if );            // BUG 2190290
        TEST_CASE( initvar_operator_eq1 );   // BUG 2190376
        TEST_CASE( initvar_operator_eq2 );   // BUG 2190376
		TEST_CASE( initvar_operator_eq3 );
        TEST_CASE( initvar_same_classname );    // BUG 2208157
        TEST_CASE( initvar_chained_assign );    // BUG 2270433
        TEST_CASE( initvar_2constructors );     // BUG 2270353

        TEST_CASE( initvar_private_constructor );   // BUG 2354171 - private constructor

		TEST_CASE( initvar_destructor );    // No variables need to be initialized in a destructor
    }


    void simple1()
    {
        check( "class Fred\n"
           "{\n"
           "public:\n"
           "    int i;\n"
           "};\n" );
        std::string actual( errout.str() );
        std::string expected( "[test.cpp:1] The class 'Fred' has no constructor\n" );
        ASSERT_EQUALS( expected, actual );
    }


    void simple2()
    {
        check( "class Fred\n"
           "{\n"
           "public:\n"
           "    Fred() { }\n"
           "    int i;\n"
           "};\n" );
        ASSERT_EQUALS( std::string("[test.cpp:4] Uninitialized member variable 'Fred::i'\n"), errout.str() );
    }


    void simple3()
    {
        check( "class Fred\n"
           "{\n"
           "public:\n"
           "    Fred();\n"
           "    int i;\n"
           "};\n"
           "Fred::Fred()\n"
           "{ }\n" );
        ASSERT_EQUALS( std::string("[test.cpp:7] Uninitialized member variable 'Fred::i'\n"), errout.str() );
    }


    void simple4()
    {
        check( "class Fred\n"
           "{\n"
           "public:\n"
           "    Fred();\n"
           "    Fred(int _i);\n"
           "    int i;\n"
           "};\n"
           "Fred::Fred()\n"
           "{ }\n"
           "Fred::Fred(int _i)\n"
           "{\n"
           "    i = _i;\n"
           "}\n" );
        ASSERT_EQUALS( std::string("[test.cpp:8] Uninitialized member variable 'Fred::i'\n"), errout.str() );
    }


    void initvar_with_this()
    {
        check( "class Fred\n"
               "{\n"
               "public:\n"
               "    Fred()\n"
               "    { this->i = 0; }\n"
               "    int i;\n"
               "};\n" );
        ASSERT_EQUALS( std::string(""), errout.str() );
    }

    void initvar_if()
    {
        check( "class Fred\n"
               "{\n"
               "public:\n"
               "    Fred()\n"
               "    {\n"
               "        if (true)\n"
               "            i = 0;\n"
               "        else\n"
               "            i = 1;\n"
               "    }\n"
               "    int i;\n"
               "};\n" );
        ASSERT_EQUALS( std::string(""), errout.str() );
    }

    void initvar_operator_eq1()
    {
        // Bug 2190376 - False positive, Uninitialized member variable with operator=

        check( "class Fred\n"
               "{\n"
               "private:\n"
               "    int i;\n"
               "\n"
               "public:\n"
               "    Fred()\n"
               "    { i = 0; }\n"
               "\n"
               "    Fred(const Fred &fred)\n"
               "    { *this = fred; }\n"
               "\n"
               "    const Fred & operator=(const Fred &fred)\n"
               "    { i = fred.i; return *this; }\n"
               "};\n" );

        std::string err( errout.str() );
        ASSERT_EQUALS( std::string(""), err );
    }


    void initvar_operator_eq2()
    {
        check( "class Fred\n"
               "{\n"
               "public:\n"
               "    Fred() { i = 0; }\n"
               "    void operator=() { }\n"
               "    int i;\n"
               "};\n" );
        ASSERT_EQUALS( std::string("[test.cpp:5] Uninitialized member variable 'Fred::i'\n"), errout.str() );
    }

    void initvar_operator_eq3()
    {
        check( "class Fred\n"
               "{\n"
               "public:\n"
			   "    Fred() { Init(); }\n"
               "    void operator=() { Init(); }\n"
               "private:\n"
			   "    Init() { i = 0; }\n"
               "    int i;\n"
               "};\n" );
        ASSERT_EQUALS( std::string(""), errout.str() );
    }

    void initvar_same_classname()
    {
        // Bug 2208157 - False positive: Uninitialized variable, same class name

        check( "void func1()\n"
               "{\n"
               "    class Fred\n"
               "    {\n"
               "        int a;\n"
               "        Fred() { a = 0; }\n"
               "    };\n"
               "}\n"
               "\n"
               "void func2()\n"
               "{\n"
               "    class Fred\n"
               "    {\n"
               "        int b;\n"
               "        Fred() { b = 0; }\n"
               "    };\n"
               "}\n" );

        std::string err( errout.str() );
        ASSERT_EQUALS( std::string(""), err );
    }

    void initvar_chained_assign()
    {
        // Bug 2270433 - Uninitialized variable false positive on chained assigns

        check( "class c\n"
               "{\n"
               "    c();\n"
               "\n"
               "    int m_iMyInt1;\n"
               "    int m_iMyInt2;\n"
               "}\n"
               "\n"
               "c::c()\n"
               "{\n"
               "    m_iMyInt1 = m_iMyInt2 = 0;\n"
               "}\n" );

        std::string err( errout.str() );
        ASSERT_EQUALS( std::string(""), err );
    }


    void initvar_2constructors()
    {
        check( "class c\n"
               "{\n"
               "    c();\n"
               "    c(bool b);"
               "\n"
               "    void InitInt();\n"
               "\n"
               "    int m_iMyInt;\n"
               "    int m_bMyBool;\n"
               "}\n"
               "\n"
               "c::c()\n"
               "{\n"
               "    m_bMyBool = false;\n"
               "    InitInt();"
               "}\n"
               "\n"
               "c::c(bool b)\n"
               "{\n"
               "    m_bMyBool = b;\n"
               "    InitInt();\n"
               "}\n"
               "\n"
               "void c::InitInt()\n"
               "{\n"
               "    m_iMyInt = 0;\n"
               "}\n" );

        std::string err( errout.str() );
        ASSERT_EQUALS( std::string(""), err );
    }


    void initvar_private_constructor()
    {
        check( "class Fred\n"
               "{\n"
               "private:\n"
               "    int var;\n"
               "    Fred();\n"
               "};\n"
               "Fred::Fred()\n"
               "{ }" );
        ASSERT_EQUALS( std::string(""), errout.str() );
    }

	void initvar_destructor()
	{
        check( "class Fred\n"
               "{\n"
               "private:\n"
               "    int var;\n"
               "public:\n"
			   "    Fred() : var(0) {}\n"
			   "    ~Fred() {}\n"
               "};\n" );
        ASSERT_EQUALS( std::string(""), errout.str() );
	}
};

REGISTER_TEST( TestConstructors )