[libcamera-devel] [PATCH v10 5/5] lc-compliance: Add list and filter parameters

[Nícolas F. R. A. Prado]

Add a --list parameter that lists all current tests (by mapping to
googletest's --gtest_list_tests).

Add a --filter 'filterString' parameter that filters the tests to run
(by mapping to googletest's --gtest_filter).

While at it, add to the help message that further googletest options can
be passed through the environment.

Signed-off-by: Nícolas F. R. A. Prado <nfraprado at collabora.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund at ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo at jmondi.org>
---
Changes in v10:
- Thanks to Jacopo:
  - Fixed some code style issues
  - Stopped calling CameraManager::stop() in the path it didn't start()

Changes in v9:
- Thanks to Jacopo:
  - Fixed some style issues
  - Added to --help that further Googletest options can be passed as environment
    variables
- Thanks to Paul:
  - Fixed compiling error on clang

Changes in v8:
- Thanks to Kieran:
  - Switched from malloc/free to new/delete in gtest parameter allocation

Changes in v7:
- Thanks to Niklas:
  - Removed intermediary filter string variable in Harness::initGtestParameters()

Changes in v6:
- Thanks to Niklas:
  - Changed buildGtestParameters() into initGtestParameters() and removed the
    need for Harness::gtestArgc_ and Harness::gtestArgv_

Changes in v5:
- Thanks to Niklas:
  - Moved buildGtestParameters() inside run()

No changes in v4

 src/lc-compliance/main.cpp | 78 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 74 insertions(+), 4 deletions(-)

diff --git a/src/lc-compliance/main.cpp b/src/lc-compliance/main.cpp
index ff14474c6425..7eb52ae4c094 100644
--- a/src/lc-compliance/main.cpp
+++ b/src/lc-compliance/main.cpp
@@ -21,6 +21,8 @@ using namespace libcamera;
 
 enum {
 	OptCamera = 'c',
+	OptList = 'l',
+	OptFilter = 'f',
 	OptHelp = 'h',
 };
 
@@ -77,12 +79,72 @@ static int initCamera(CameraManager *cm, OptionsParser::Options options)
 	return 0;
 }
 
+static int initGtestParameters(char *arg0, OptionsParser::Options options)
+{
+	const std::map<std::string, std::string> gtestFlags = { { "list", "--gtest_list_tests" },
+								{ "filter", "--gtest_filter" } };
+
+	int argc = 0;
+	std::string filterParam;
+
+	/*
+	 * +2 to have space for both the 0th argument that is needed but not
+	 * used and the null at the end.
+	 */
+	char **argv = new char *[(gtestFlags.size() + 2)];
+	if (!argv)
+		return -ENOMEM;
+
+	argv[0] = arg0;
+	argc++;
+
+	if (options.isSet(OptList)) {
+		argv[argc] = const_cast<char *>(gtestFlags.at("list").c_str());
+		argc++;
+	}
+
+	if (options.isSet(OptFilter)) {
+		/*
+		 * The filter flag needs to be passed as a single parameter, in
+		 * the format --gtest_filter=filterStr
+		 */
+		filterParam = gtestFlags.at("filter") + "=" +
+			      static_cast<const std::string &>(options[OptFilter]);
+
+		argv[argc] = const_cast<char *>(filterParam.c_str());
+		argc++;
+	}
+
+	argv[argc] = nullptr;
+
+	::testing::InitGoogleTest(&argc, argv);
+
+	delete[] argv;
+
+	return 0;
+}
+
+static int initGtest(char *arg0, OptionsParser::Options options)
+{
+	int ret = initGtestParameters(arg0, options);
+	if (ret)
+		return ret;
+
+	testing::UnitTest::GetInstance()->listeners().Append(new ThrowListener);
+
+	return 0;
+}
+
 static int parseOptions(int argc, char **argv, OptionsParser::Options *options)
 {
 	OptionsParser parser;
 	parser.addOption(OptCamera, OptionString,
 			 "Specify which camera to operate on, by id", "camera",
 			 ArgumentRequired, "camera");
+	parser.addOption(OptList, OptionNone, "List all tests and exit", "list");
+	parser.addOption(OptFilter, OptionString,
+			 "Specify which tests to run", "filter",
+			 ArgumentRequired, "filter");
 	parser.addOption(OptHelp, OptionNone, "Display this help message",
 			 "help");
 
@@ -92,6 +154,8 @@ static int parseOptions(int argc, char **argv, OptionsParser::Options *options)
 
 	if (options->isSet(OptHelp)) {
 		parser.usage();
+		std::cerr << "Further options from Googletest can be passed as environment variables"
+			  << std::endl;
 		return -EINTR;
 	}
 
@@ -109,15 +173,21 @@ int main(int argc, char **argv)
 
 	std::unique_ptr<CameraManager> cm = std::make_unique<CameraManager>();
 
-	ret = initCamera(cm.get(), options);
+	/* No need to initialize the camera if we'll just list tests */
+	if (!options.isSet(OptList)) {
+		ret = initCamera(cm.get(), options);
+		if (ret)
+			return ret;
+	}
+
+	ret = initGtest(argv[0], options);
 	if (ret)
 		return ret;
 
-	testing::UnitTest::GetInstance()->listeners().Append(new ThrowListener);
-
 	ret = RUN_ALL_TESTS();
 
-	cm->stop();
+	if (!options.isSet(OptList))
+		cm->stop();
 
 	return ret;
 }
-- 
2.32.0