CODEWITHSUNDEEP
c++googletest
gino
gino

Reputation: 165

Can I pass parameters to googletest test function

After building my testfile, xxxxtest, with gtest can I pass a parameter when running the test, e.g. ./xxxxtest 100. I want to control my test function using the parameter, but I do not know how to use the para in my test, can you show me a sample in test?

Upvotes: 10

Views: 23799

Answers (4)

kuga
kuga

Reputation: 1775

I have played around with the solutions here.

  • Using a custom testing::Environment is not easy to understand.
  • Using value-parameterized tests does not work, because the parameters are not known when INSTANTIATE_TEST_CASE_P() is evaluated.

So I used a simpler solution. The key part is that InitGoogleTest() removes all --gtest_* args. So we make the remaining ones globally available to all test cases:

#include <gtest/gtest.h>
#include <string>
#include <string_view>
#include <vector>

namespace
{
std::vector<std::string> commandLineArgs;
}

int main(int argc, char** argv)
{
   ::testing::InitGoogleTest(&argc, argv);
   // Save remaining argv into a global vector of strings
   for (int i = 1; i < argc; ++i)
   {
      commandLineArgs.push_back(argv[i]);
   }
   return RUN_ALL_TESTS();
}

TEST(foo, bar)
{
   const std::vector<std::string_view> expectedArgs = {"a", "b", "c", "1", "2", "3"};

   EXPECT_EQ(expectedArgs.size(), commandLineArgs.size());

   for (size_t i{0}; i < commandLineArgs.size(); ++i)
   {
      EXPECT_EQ(expectedArgs[i], commandLineArgs[i]);
   }
}

Upvotes: 1

Basanta
Basanta

Reputation: 339

You should be using Type-Parameterized Tests. https://github.com/google/googletest/blob/main/docs/advanced.md#type-parameterized-tests

Type-parameterized tests are like typed tests, except that they don't require you to know the list of types ahead of time. Instead, you can define the test logic first and instantiate it with different type lists later. You can even instantiate it more than once in the same program.

If you are designing an interface or concept, you can define a suite of type-parameterized tests to verify properties that any valid implementation of the interface/concept should have. Then, the author of each implementation can just instantiate the test suite with his type to verify that it conforms to the requirements, without having to write similar tests repeatedly.

Example

class FooTest: public ::testing::TestWithParam < int >{....};
    TEST_P(FooTest, DoesBar){
        ASSERT_TRUE(foo.DoesBar(GetParam());
    }

INSTANTIATE_TEST_CASE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));

Upvotes: 7

jav
jav

Reputation: 674

If you don't want to make your own main() function. You can also consider passing information via environment variables.

In my case I just wanted a flag to show debug information or not, so I used getenv().

Another option would be to put any needed information in a text file and read it from the test.

Upvotes: 1

Fraser
Fraser

Reputation: 78508

You could do something like the following:

main.cc

#include <string>
#include "gtest/gtest.h"
#include "my_test.h"

int main(int argc, char **argv) {
  std::string command_line_arg(argc == 2 ? argv[1] : "");
  testing::InitGoogleTest(&argc, argv);
  testing::AddGlobalTestEnvironment(new MyTestEnvironment(command_line_arg));
  return RUN_ALL_TESTS();
}


my_test.h

#include <string>
#include "gtest/gtest.h"

namespace {
std::string g_command_line_arg;
}

class MyTestEnvironment : public testing::Environment {
 public:
  explicit MyTestEnvironment(const std::string &command_line_arg) {
    g_command_line_arg = command_line_arg;
  }
};

TEST(MyTest, command_line_arg_test) {
  ASSERT_FALSE(g_command_line_arg.empty());
}

Upvotes: 12

Related Questions