Introduction to Testing Environment Setup in C++ Using Google Test

Introduction to Testing Environment Setup

Welcome to the next stage of mastering Test Driven Development (TDD) in C++, where we will focus on setting up a robust testing environment. As you have learned through the TDD process, the Red-Green-Refactor cycle involves writing a failing test, implementing just enough code to pass it, and refining the implementation. In this lesson, we will set up the necessary tools for testing with Google Test, guiding you on how to create an efficient C++ testing environment that complements the TDD cycle. Google Test is a widely used framework for writing and running C++ tests. It provides a powerful setup for TDD in C++.

Creating the Google Test Configuration

To start using Google Test with C++, you'll need to configure your development environment to include the Google Test library. This involves downloading Google Test and setting it up in your C++ project.

Setting Up Google Test

Download Google Test: Clone the Google Test repository from GitHub. Shellgit clone https://github.com/google/googletest.git Add it to Your C++ Project: Integrate Google Test into your project's build system. If you are using CMake, you can add the following lines to your CMakeLists.txt file: cmakeadd_subdirectory(googletest) include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})

Running Tests in Google Test

Running tests in Google Test is straightforward. You can compile your test files and then execute the created binary.

Compiling and Running Tests

Use CMake to configure and build your tests: Shell mkdir build cd build cmake .. make ./your_test_binary # Execute the tests

Examples of Patterns with Google Test

Now that our environment is ready, let's look at a test suite. We'll utilize a User class example to demonstrate various Google Test patterns.

Setup and Teardown with `SetUp()` and `TearDown()`

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Shell

git clone https://github.com/google/googletest.git

cmake

add_subdirectory(googletest)
include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})

C++

#include <gtest/gtest.h>

class User {
public:
    User(const std::string& name, const std::string& email)
        : name_(name), email_(email) {}
    std::string GetName() const { return name_; }
    std::string GetEmail() const { return email_; }

private:
    std::string name_;
    std::string email_;
};

class UserTests : public ::testing::Test {
protected:
    void SetUp() override {
        user_ = new User("Jane Doe", "jane@example.com");
    }

    void TearDown() override {
        delete user_;
    }

    User* user_;
};

TEST_F(UserTests, TestExample) {
    EXPECT_EQ("Jane Doe", user_->GetName());
}

#include <gtest/gtest.h>

class User {
public:
    User(const std::string& name, const std::string& email)
        : name_(name), email_(email) {}
    std::string GetName() const { return name_; }
    std::string GetEmail() const { return email_; }

private:
    std::string name_;
    std::string email_;
};

class UserTests : public ::testing::Test {
protected:
    void SetUp() override {
        user_ = new User("Jane Doe", "jane@example.com");
    }

    void TearDown() override {
        delete user_;
    }

    User* user_;
};

TEST_F(UserTests, TestExample) {
    EXPECT_EQ("Jane Doe", user_->GetName());
}

C++

EXPECT_EQ("jane@example.com", user_->GetEmail());

EXPECT_EQ("jane@example.com", user_->GetEmail());

C++

class EmailValidationTest : public ::testing::TestWithParam<std::pair<std::string, bool>> {};

TEST_P(EmailValidationTest, ValidateEmail) {
    std::pair<std::string, bool> param = GetParam();
    EXPECT_EQ(param.second, ValidateEmail(param.first));
}

INSTANTIATE_TEST_CASE_P(
    EmailTests,
    EmailValidationTest,
    ::testing::Values(
        std::make_pair("jane@example.com", true),
        std::make_pair("invalid-email", false)
    )
);

class EmailValidationTest : public ::testing::TestWithParam<std::pair<std::string, bool>> {};

TEST_P(EmailValidationTest, ValidateEmail) {
    std::pair<std::string, bool> param = GetParam();
    EXPECT_EQ(param.second, ValidateEmail(param.first));
}

INSTANTIATE_TEST_CASE_P(
    EmailTests,
    EmailValidationTest,
    ::testing::Values(
        std::make_pair("jane@example.com", true),
        std::make_pair("invalid-email", false)
    )
);

C++

TEST(UserTests, InvalidEmailThrowsException) {
    EXPECT_THROW(User("Invalid", "invalid-email"), std::invalid_argument);
}

TEST(UserTests, InvalidEmailThrowsException) {
    EXPECT_THROW(User("Invalid", "invalid-email"), std::invalid_argument);
}

C++

#include <gtest/gtest.h>

class User {
public:
    User(const std::string& name, const std::string& email)
        : name_(name), email_(email) {}
    std::string GetName() const { return name_; }
    std::string GetEmail() const { return email_; }

private:
    std::string name_;
    std::string email_;
};

class UserTests : public ::testing::Test {
protected:
    void SetUp() override {
        user_ = new User("Jane Doe", "jane@example.com");
    }

    void TearDown() override {
        delete user_;
    }

    User* user_;
};

TEST_F(UserTests, TestExample) {
    EXPECT_EQ("Jane Doe", user_->GetName());
}

C++

EXPECT_EQ("jane@example.com", user_->GetEmail());

C++

class EmailValidationTest : public ::testing::TestWithParam<std::pair<std::string, bool>> {};

TEST_P(EmailValidationTest, ValidateEmail) {
    std::pair<std::string, bool> param = GetParam();
    EXPECT_EQ(param.second, ValidateEmail(param.first));
}

INSTANTIATE_TEST_CASE_P(
    EmailTests,
    EmailValidationTest,
    ::testing::Values(
        std::make_pair("jane@example.com", true),
        std::make_pair("invalid-email", false)
    )
);

C++

TEST(UserTests, InvalidEmailThrowsException) {
    EXPECT_THROW(User("Invalid", "invalid-email"), std::invalid_argument);
}

Introduction to Testing Environment Setup

Creating the Google Test Configuration

Setting Up Google Test

Running Tests in Google Test

Compiling and Running Tests

Examples of Patterns with Google Test

Setup and Teardown with `SetUp()` and `TearDown()`

Join the 1M+ learners on CodeSignal

Using Expect Methods in Google Test

Parameterized Tests in Google Test

Testing Code with Exceptions

Summary and Next Steps