usage
This script creates ClassName.h, ClassName.cpp, and ClassNameTest.cpp and modifies the makefile. If you have a "DOTO =" in your makefile, the script will append a backslash newline ClassName.o ClassNameTest.o backslash newline, resulting in this
If you are using MS tools you get an error about no makefile found. You have to add the created files into your build environment.
There are three template files that provide a basis for the newly created class. The template files can be found in $(CPP_TEST_TOOLS)/CppSourseTemplates
The created files look like this:
This class is a good starting point. This starting point prevents the compiler from writing a bunch of code for you. The constructor is declared explicit to prevent the complier from performing implicit conversions. This actually has no effect for a default constructor. It is tolerated by the compiler. Later you may parameterize your constructor which may result in unwanted conversions. Being that you are doing TDD you will want to test and document any intended conversion in your test cases.
The destructor is declared virtual. This is a safety precaution in case this class is used as a base class one day. The programmer can delete the virtual keyword if the presence of a vtable is terrifying.
A default constructor is declared to prevent the compiler from defining one automatically
The copy constructor and assignment operator are placed in the private area and not implemented in the cpp file. This prevents the compiler from writing those functions for itself and some unsuspecting programmer from accidentally using them. If you want a copy constructor and assignment operator, you can create then using TDD.
Empty constructor and destructor implementation are provided in the cpp file to encourage not inlining these definitions. Those empty looking curley braces actuall will bring along some compiler provided baggage. So to keep the foot print from bloating, we start with the implementations in teh cpp file. You can always remove them if you want.
An skeletal test file is created. All three files are expected to compile once the inserted compiler error is removed. If your tests are in a library, you will need to more the IMPORT_TEST_GROUP line to some file that is included by the file containing your test main.
They new test fails so that you can confirm that the test has been installed. Remove the FAIL invocation once you build successfully and get this error message
The SetUp function is called before the body of each TEST is executed. TearDown is called after the body of each TEST is executed. SetUp and TearDown are in an unnamed namespace to keep them out of the global namespace. They are only visible in this file.
The boiler plate test provides two techniques for instance creation:
You will probably want to do one way or another.
NewClass ClassName
This script creates ClassName.h, ClassName.cpp, and ClassNameTest.cpp and modifies the makefile. If you have a "DOTO =" in your makefile, the script will append a backslash newline ClassName.o ClassNameTest.o backslash newline, resulting in this
<whatever was before DOTO>DOTO =\
ClassName.o ClassNameTest.o\
<whatever was after DOTO>
If you are using MS tools you get an error about no makefile found. You have to add the created files into your build environment.
There are three template files that provide a basis for the newly created class. The template files can be found in $(CPP_TEST_TOOLS)/CppSourseTemplates
The created files look like this:
#ifndef D_ClassName_H
#define D_ClassName_H
class ClassName
{
public:
explicit ClassName();
virtual ~ClassName();
private:
ClassName(const ClassName&);
ClassName& operator=(const ClassName&);
};
#endif // D_ClassName_H
This class is a good starting point. This starting point prevents the compiler from writing a bunch of code for you. The constructor is declared explicit to prevent the complier from performing implicit conversions. This actually has no effect for a default constructor. It is tolerated by the compiler. Later you may parameterize your constructor which may result in unwanted conversions. Being that you are doing TDD you will want to test and document any intended conversion in your test cases.
The destructor is declared virtual. This is a safety precaution in case this class is used as a base class one day. The programmer can delete the virtual keyword if the presence of a vtable is terrifying.
A default constructor is declared to prevent the compiler from defining one automatically
The copy constructor and assignment operator are placed in the private area and not implemented in the cpp file. This prevents the compiler from writing those functions for itself and some unsuspecting programmer from accidentally using them. If you want a copy constructor and assignment operator, you can create then using TDD.
#include "ClassName.h"
ClassName::ClassName()
{
}
ClassName::~ClassName()
{
}
Empty constructor and destructor implementation are provided in the cpp file to encourage not inlining these definitions. Those empty looking curley braces actuall will bring along some compiler provided baggage. So to keep the foot print from bloating, we start with the implementations in teh cpp file. You can always remove them if you want.
#include "UnitTestHarness/TestHarness.h"
#include "ClassName.h"
// to make sure this file gets linked in to your test main
int i = move_the_IMPORT_TEST_GROUP_so_main_references_it_and_delete_this_line;
IMPORT_TEST_GROUP(ClassName);
EXPORT_TEST_GROUP(ClassName);
namespace
{
ClassName* aClassName;
void SetUp()
{
aClassName = new ClassName();
}
void TearDown()
{
delete aClassName;
}
}
TEST(ClassName, Create)
{
ClassName aClassName;
FAIL("Making sure ClassNameTest is hooked in");
}
An skeletal test file is created. All three files are expected to compile once the inserted compiler error is removed. If your tests are in a library, you will need to more the IMPORT_TEST_GROUP line to some file that is included by the file containing your test main.
They new test fails so that you can confirm that the test has been installed. Remove the FAIL invocation once you build successfully and get this error message
Failure in TEST(Printer, PrintConstCharStar)
PrinterTest.cpp(184)
Making sure ClassNameTest is hooked in
The SetUp function is called before the body of each TEST is executed. TearDown is called after the body of each TEST is executed. SetUp and TearDown are in an unnamed namespace to keep them out of the global namespace. They are only visible in this file.
The boiler plate test provides two techniques for instance creation:
- from the heap with new and delete using SetUp and TearDown
- and autoamtic instantiation in the TEST method
You will probably want to do one way or another.
Add Child Page to NewClassScript