Add CDash, refactor code, and fix memory check leaks.

Author: MangaD

.gitignore

@@ -1,3 +1,4 @@
+/Testing/
 /CMakeUserPresets.json
 /CMakeLists.txt.user
 /vcpkg/

CTestConfig.cmake

@@ -0,0 +1,15 @@
+## This file should be placed in the root directory of your project.
+## Then modify the CMakeLists.txt file in the root directory of your
+## project to incorporate the testing dashboard.
+##
+## # The following are required to submit to the CDash dashboard:
+##   ENABLE_TESTING()
+##   INCLUDE(CTest)
+
+set(CTEST_PROJECT_NAME "cpp-project-template")
+set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC")
+
+set(CTEST_DROP_METHOD "https")
+set(CTEST_DROP_SITE "my.cdash.org")
+set(CTEST_DROP_LOCATION "/submit.php?project=cpp-project-template")
+set(CTEST_DROP_SITE_CDASH TRUE)

README.md

@@ -8,7 +8,7 @@ This repository aims to provide a modern C++ cross-platform codebase template, f
 
 ### Status
 
-![CMake](https://img.shields.io/badge/CMake-done-green) ![CTest](https://img.shields.io/badge/CTest-done-green) ![CPack](https://img.shields.io/badge/CPack-done-green)![CDash](https://img.shields.io/badge/CDash-todo-red) ![Code coverage](https://img.shields.io/badge/code%20coverage-todo-red) ![consoleApp](https://img.shields.io/badge/console%20app-done-green) ![staticLib](https://img.shields.io/badge/static%20library-done-green) ![dynamicLib](https://img.shields.io/badge/dynamic%20library-todo-red) ![wxWidgets](https://img.shields.io/badge/wxWidgets-done-green) ![Qt](https://img.shields.io/badge/Qt-todo-red) ![windowsIco](https://img.shields.io/badge/windows%20icon-done-green)
+![CMake](https://img.shields.io/badge/CMake-done-green) ![CTest](https://img.shields.io/badge/CTest-done-green) ![CPack](https://img.shields.io/badge/CPack-done-green)![CDash](https://img.shields.io/badge/CDash-done-green) ![Code coverage](https://img.shields.io/badge/code%20coverage-todo-red) ![consoleApp](https://img.shields.io/badge/console%20app-done-green) ![staticLib](https://img.shields.io/badge/static%20library-done-green) ![dynamicLib](https://img.shields.io/badge/dynamic%20library-todo-red) ![wxWidgets](https://img.shields.io/badge/wxWidgets-done-green) ![Qt](https://img.shields.io/badge/Qt-todo-red) ![windowsIco](https://img.shields.io/badge/windows%20icon-done-green)
 ![windowsVer](https://img.shields.io/badge/windows%20version-done-green) ![i18nL10n](https://img.shields.io/badge/i18n%20and%20L10n-todo-red) ![Boost](https://img.shields.io/badge/boost-todo-red) ![GoogleTest](https://img.shields.io/badge/GoogleTest-done-green) ![BoostTest](https://img.shields.io/badge/Boost.Test-todo-red) ![Catch2](https://img.shields.io/badge/catch2-todo-red) ![Doctest](https://img.shields.io/badge/doctest-todo-red) ![vcpkg](https://img.shields.io/badge/vcpkg-done-green) ![conan](https://img.shields.io/badge/conan-todo-red) ![cppcheck](https://img.shields.io/badge/cppcheck-done-green) ![CSA](https://img.shields.io/badge/clang%20static%20analyzer-done-green) ![clangtidy](https://img.shields.io/badge/clang%20tidy-done-green) ![lcov](https://img.shields.io/badge/lcov-done-green) ![gcovr](https://img.shields.io/badge/gcovr-done-green) ![valgrind](https://img.shields.io/badge/valgrind-done-green) ![sanitizers](https://img.shields.io/badge/sanitizers-done-green) ![gprof](https://img.shields.io/badge/gprof-todo-red) ![IntelVTuneProfiler](https://img.shields.io/badge/Intel%20VTune%20Profiler-todo-red) ![perf](https://img.shields.io/badge/perf-todo-red) ![doxygen](https://img.shields.io/badge/doxygen-done-green) ![sphinx](https://img.shields.io/badge/sphinx-needs%20work-yellow) ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-done-green) ![GitLab CI/CD](https://img.shields.io/badge/GitLab%20CI/CD-todo-red) ![nsis](https://img.shields.io/badge/nsis-done-green) ![wix toolset](https://img.shields.io/badge/wix%20toolset-done-green) ![deb](https://img.shields.io/badge/deb-done-green) ![rpm](https://img.shields.io/badge/rpm-done-green) ![DragNDrop](https://img.shields.io/badge/DragNDrop-needs%20work-yellow) ![productbuild](https://img.shields.io/badge/productbuild-todo-red) ![raspbian](https://img.shields.io/badge/raspbian-todo-red) ![SignTool](https://img.shields.io/badge/SignTool-todo-red) 
 
 ## Download

TODO.md

@@ -26,7 +26,7 @@
   - [x] CTest
   - [x] CPack
     - [ ] Sign the executables (see: https://stackoverflow.com/a/252245/3049315)
-  - [ ] CDash
+  - [x] CDash
 - [x] Package manager
   - [x] vcpkg
   - [ ] conan
@@ -70,4 +70,7 @@
       - [ ] [Install wxWidgets on RPI](https://yasriady.blogspot.com/2015/10/how-to-build-wxwidgets-for-raspberry-pi.html)
   - [ ] GitLab CI/CD
   - [ ] Travis CI
-  - [ ] Appveyor
+  - [ ] Appveyor
+  - [ ] Azure Pipelines
+  - [ ] [GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-a-predefined-dev-container-configuration)
+  - [ ] Docker

docs/GUIDE.md

@@ -7,6 +7,7 @@
   - [Dynamic analysis](#dynamic-analysis)
     - [Valgrind](#valgrind)
     - [Sanitizers](#sanitizers)
+  - [CDash](#cdash)
 - [CMake tips](#cmake-tips)
 - [Doxygen tips](#doxygen-tips)
 - [GitHub Actions tips](#github-actions-tips)
@@ -149,6 +150,16 @@ More about sanitizers:
 - https://hpc-wiki.info/hpc/Compiler_Sanitizers
 - https://developers.redhat.com/blog/2021/05/05/memory-error-checking-in-c-and-c-comparing-sanitizers-and-valgrind
 
+### CDash
+
+CDash Dashboard: https://my.cdash.org/index.php?project=cpp-project-template
+
+```sh
+cmake -S . -B build -G "Ninja" -DCMAKE_BUILD_TYPE=Coverage
+cmake --build build
+ctest --test-dir build -D Experimental -T Test -T Coverage -T memcheck
+```
+
 ## CMake tips
 
 1. Check the available targets with:
@@ -198,6 +209,7 @@ A release is created when creating and pushing a tag that starts with `v`.
 
 - [GoogleTest User's Guide](https://google.github.io/googletest/)
 - [CMake GoogleTest](https://cmake.org/cmake/help/latest/module/GoogleTest.html)
+- [CDash](https://cmake.org/cmake/help/book/mastering-cmake/chapter/CDash.html)
 
 ### Coverage
 

src/projectcli/UserOpt.cpp

@@ -1,10 +1,10 @@
 #include "UserOpt.hpp"
 
 #include <iostream>
+#include <span>
 #include <stdexcept>  // std::runtime_error
 #include <string>
 #include <string_view>
-#include <vector>
 
 #include "config.h"
 
@@ -40,32 +40,30 @@ void printVersionAndExit()
 	exit(EXIT_SUCCESS);
 }
 
-void parseUserOptions(int argc, char *argv[])  // NOLINT
+void parseUserOptions(const std::span<char*>& args)
 {
-	// First argument is the program's name. Next argument *must* be a flag.
-	if (argc < 2)
+	if (args.size() == 0)
 	{
 		return;
 	}
 
-	std::vector<std::string_view> args(argv + 1, argv + argc);
-
 	// May have more than one flag enabled in the future.
 	// NOLINTNEXTLINE
-	for (auto i = args.begin(); i != args.end(); ++i)
+	for (std::string_view arg : args)
 	{
-		if (*i == "-h" || *i == "--help")
+		if (arg == "-h" || arg == "--help")
 		{
 			printHelpAndExit();
 		}
-		else if (*i == "-v" || *i == "--version")
+		else if (arg == "-v" || arg == "--version")
 		{
 			printVersionAndExit();
 		}
 		else
 		{
-			throw std::runtime_error(std::string("Option not recognized: ") +
-			                         std::string(*i));
+			using namespace std::string_literals;
+			throw std::runtime_error("Option not recognized: "s +
+			                         std::string(arg));
 		}
 	}
 }

src/projectcli/UserOpt.hpp

@@ -7,6 +7,7 @@
 #ifndef CPP_PROJ_USEROPT_HPP
 #define CPP_PROJ_USEROPT_HPP
 
+#include <span>
 #include <string_view>
 
 /**
@@ -27,13 +28,11 @@ inline std::string_view
 /**
  * Gets the user options from the command line.
  *
- * @param argc The command line argument count.
- * @param argv An array of C-style strings containing the command line
- * arguments.
+ * @param args The command line arguments.
  *
  * @return void
  */
-void parseUserOptions(int argc, char *argv[]);  // NOLINT
+void parseUserOptions(const std::span<char*>& args);
 
 /**
  * Print the usage of the application.
@@ -44,11 +43,11 @@ void printHelp();
  */
 void printVersion();
 /**
- * Calls DG_Tickingbot::printHelp and exits with success.
+ * Calls cpp_proj::printHelp and exits with success.
  */
 [[noreturn]] void printHelpAndExit();
 /**
- * Calls DG_Tickingbot::printVersion and exits with success.
+ * Calls cpp_proj::printVersion and exits with success.
  */
 [[noreturn]] void printVersionAndExit();
 

src/projectcli/main.cpp

@@ -9,8 +9,10 @@
  */
 
 #include <cassert>  // std::assert
+#include <cstddef>  // std::size_t
 #include <cstdlib>  // std::EXIT_SUCCESS, std::EXIT_FAILURE
 #include <iostream>
+#include <span>
 
 #include "UserOpt.hpp"
 #include "tutorial_1.hpp"
@@ -19,20 +21,25 @@ using namespace cpp_proj;
 
 int main(int argc, char *argv[])
 {
-	assert(argc > 0);    // NOLINT https://stackoverflow.com/q/2050961/3049315
+	assert(argc > 0);    // https://stackoverflow.com/q/2050961/3049315
 	                     // https://stackoverflow.com/q/68878728/3049315
-	progName = argv[0];  // NOLINT: Pointer arithmetic is inevitable here.
+	progName = argv[0];  // NOLINT
+	auto args = std::span(argv+1,  // NOLINT
+	                      static_cast<std::size_t>(argc - 1));
 
 	constexpr int i = 5;
 
 	try
 	{
-		parseUserOptions(argc, argv);
+		parseUserOptions(args);
 	}
 	catch (const std::exception &e)
 	{
 		std::cerr << e.what() << std::endl;
-		exit(EXIT_FAILURE);
+		// Do not call `exit` directly, so that the destructor
+		// of the exception may be called.
+		// https://stackoverflow.com/a/28931492/3049315
+		return EXIT_FAILURE;
 	}
 
 	std::cout << "TESTING TUTORIAL 1:" << std::endl;

src/projectlib/test/tutorial_1_gtest.cpp

@@ -1,20 +1,20 @@
-#include "tutorial_1.hpp"
-
 #include <gtest/gtest.h>
 
+#include "tutorial_1.hpp"
+
 // Demonstrate some basic assertions.
-TEST(HelloTest, BasicAssertions) {
-  // Expect two strings not to be equal.
-  EXPECT_STRNE("hello", "world");
-  // Expect equality.
-  EXPECT_EQ(7 * 6, 42);
+TEST(HelloTest, BasicAssertions)
+{
+	// Expect two strings not to be equal.
+	EXPECT_STRNE("hello", "world");
+	// Expect equality.
+	EXPECT_EQ(7 * 6, 42);
 }
 
-TEST(Tutorial1, Factorial) {
-  EXPECT_EQ(tut1::factorial(4), 24);
-}
+TEST(Tutorial1, Factorial) { EXPECT_EQ(tut1::factorial(4), 24); }
 
-int main(int argc, char **argv) {
-    testing::InitGoogleTest(&argc, argv);
-    return RUN_ALL_TESTS();
+int main(int argc, char **argv)
+{
+	testing::InitGoogleTest(&argc, argv);
+	return RUN_ALL_TESTS();
 }

src/projectwx/splashscreen.cpp

@@ -46,8 +46,8 @@ void showSplashScreen(const wxImage& splashImg, const unsigned long durationMs)
 
 	// yield main loop so splash screen can show
 	wxYield();
-	// Sleep for `durationMs/1000` seconds before destroying the splash screen and showing
-	// main frame
+	// Sleep for `durationMs/1000` seconds before destroying the splash screen
+	// and showing main frame
 	wxMilliSleep(durationMs);
 }