CXXTESTGEN(1)

✨ CXXTESTGEN(1) ✨

okay bestie, pull up a chair because we're talking about cxxtestgen, and it's literally the manual page for it (section 1 of the manual, if you're keeping score 🎀). she does test discovery. she builds you a test runner. she's iconic. let's get into it 💅

---

🦋 NAME 🦋

cxxtestgen — performs test discovery to create a CxxTest test runner

---

🌸 SYNOPSIS 🌸

cxxtestgen [options] [<filename> ...]

---

💖 DESCRIPTION 💖

so the cxxtestgen command is out here processing your C++ header files to do test discovery (yes, she goes looking for the tests herself, main character energy fr), and then she creates files for the CxxTest test runner. that's the whole vibe. 🫶

---

✨ OPTIONS ✨

• -h, --help — shows this help message and dips. classic.
• --version — writes out the CxxTest version. 🏷️
• -o, --output=NAME — writes the output to the file NAME.
• -w, --world — the label of the tests, used to name the XML results.
• --include=HEADER — includes the file HEADER in the test runner before all the other headers. she goes first, always. 👑
• --abort-on-fail — aborts tests on failed asserts, like xUnit does.
• --main — specifies an alternative name for the main() function.
• --headers — specifies a filename that contains a list of header files, and those get processed to generate a test runner.
• --runner=CLASS — creates a test runner that processes test events using the class CxxTest::CLASS.
• --gui=CLASS — creates a GUI test runner that processes test events using the class CxxTest::CLASS. deprecated ngl, so don't get too attached 💀
• --error-printer — creates a test runner using the ErrorPrinter class, and allows the use of the standard library.
• --xunit-printer — creates a test runner using the XUnitPrinter class.
• --xunit-file — the file to which the XML summary gets written, for test runners that use the XUnitPrinter class. the default XML filename is TEST-<world>.xml, where <world> is the value of the --world option. (default: cxxtest)
• --have-std — uses the standard library, even if it wasn't found in the tests.
• --no-std — does not use the standard library, even if it was found in the tests.
• --have-eh — uses exception handling, even if it wasn't found in the tests.
• --no-eh — does not use exception handling, even if it was found in the tests.
• --longlong=TYPE — uses TYPE for long long integers. (default: not supported)
• --no-static-init — does not rely on static initialization in the test runner.
• --template=TEMPLATE — generates the test runner using the file TEMPLATE to define a template.
• --root — writes the main() function and the global data for a test runner.
• --part — writes the tester classes for a test runner.
• -f, --fog-parser — uses the new FOG C++ parser. disabled 🚫 (she's sitting in the corner, not invited to the function)

---

💀 EXIT STATUS 💀

1. 0 — success. we ate. 🎉
2. 1 — failure. and by failure I mean: syntax or usage error; configuration error; document processing failure; unexpected error. it's giving rough day at the office 😭

---

🙈 BUGS 🙈

go check the CxxTest Home Page for the link to the CxxTest ticket repository. that's where the drama lives.

---

👑 AUTHOR 👑

CxxTest was originally written by Erez Volk. Many people have contributed to it. shoutout to the whole squad fr fr 🫶

---

🌈 RESOURCES 🌈

• Home page: http://cxxtest.com/
• CxxTest User Guide: http://cxxtest.com/cxxtest/doc/guide.html

---

💜 COPYING 💜

Copyright (c) 2008 Sandia Corporation. This software is distributed under the Lesser GNU General Public License (LGPL) v3.

---

bestie this was page CXXTESTGEN(1), dated 01/21/2012 — go forth and generate those test runners, you absolute legend ⭐💅✨