Rohit Grover / cpputest

Unit Testing framework based on http://cpputest.github.io/

CppUTest

Where to find more information

Getting test reports on the console

You may need to tailor the file src/Platforms/mbed/UtestPlatform.cpp to your needs. In particular, if you want console output, you might want to look at the function PlatformSpecificPutchar().

Quick introduction (some code!)

To write your first test, all you need is a new cpp file with a TEST_GROUP and a TEST, like:

#include "CppUTest/TestHarness.h"

TEST_GROUP(FirstTestGroup)
{
};

TEST(FirstTestGroup, FirstTest)
{
   FAIL("Fail me!");
}

This test will fail.

You can add new tests to the test group by just writing more tests in the file, like this:

TEST(FirstTestGroup, SecondTest)
{
   STRCMP_EQUAL("hello", "world");
   LONGS_EQUAL(1, 2);
   CHECK(false);
}

You do need to trigger the tests from somewhere in your program. It could look something like:

#include "CppUTest/TestRegistry.h"
#include "CppUTest/CommandLineTestRunner.h"

int main(int ac, char** av)
{
    ....
    unsigned failureCount = 0;
    {
        ConsoleTestOutput output;
        CommandLineTestRunner runner(ac, av, &output, TestRegistry::getCurrentRegistry());
        failureCount = runner.runAllTestsMain();
    }

    if (failureCount == 0) {
        console.printf("PASSED\r\n");
    }
    ...
}

For more information, We’d recommend to read the manual or, even better, check some existing tests such as SimpleStringTest or (a bit more complicated) MemoryLeakDetectorTest or the mocking tests or just check out the Cheat Sheet.

include/CppUTest/SimpleString.h

Committer:
Rohit Grover
Date:
2014-06-19
Revision:
2:82161d9e7b36
Parent:
1:4769360130ed

File content as of revision 2:82161d9e7b36:

/*
 * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

///////////////////////////////////////////////////////////////////////////////
//
// SIMPLESTRING.H
//
// One of the design goals of CppUnitLite is to compilation with very old C++
// compilers.  For that reason, the simple string class that provides
// only the operations needed in CppUnitLite.
//
///////////////////////////////////////////////////////////////////////////////

#ifndef D_SimpleString_h
#define D_SimpleString_h

#include "StandardCLibrary.h"

class SimpleStringCollection;
class TestMemoryAllocator;

class SimpleString
{
	friend bool operator==(const SimpleString& left, const SimpleString& right);
	friend bool operator!=(const SimpleString& left, const SimpleString& right);

public:
	SimpleString(const char *value = "");
	SimpleString(const char *value, size_t repeatCount);
	SimpleString(const SimpleString& other);
	~SimpleString();

	SimpleString& operator=(const SimpleString& other);
	SimpleString operator+(const SimpleString&);
	SimpleString& operator+=(const SimpleString&);
	SimpleString& operator+=(const char*);

	char at(int pos) const;
	int find(char ch) const;
	int findFrom(size_t starting_position, char ch) const;
	bool contains(const SimpleString& other) const;
	bool containsNoCase(const SimpleString& other) const;
	bool startsWith(const SimpleString& other) const;
	bool endsWith(const SimpleString& other) const;
	void split(const SimpleString& split,
					SimpleStringCollection& outCollection) const;
	bool equalsNoCase(const SimpleString& str) const;

	size_t count(const SimpleString& str) const;

	void replace(char to, char with);
	void replace(const char* to, const char* with);

	SimpleString toLower() const;
	SimpleString subString(size_t beginPos, size_t amount) const;
	SimpleString subStringFromTill(char startChar, char lastExcludedChar) const;
	void copyToBuffer(char* buffer, size_t bufferSize) const;

	const char *asCharString() const;
	size_t size() const;
	bool isEmpty() const;

	static void padStringsToSameLength(SimpleString& str1, SimpleString& str2, char ch);

	static TestMemoryAllocator* getStringAllocator();
	static void setStringAllocator(TestMemoryAllocator* allocator);

	static char* allocStringBuffer(size_t size);
	static char* StrNCpy(char* s1, const char* s2, size_t n);
	static void deallocStringBuffer(char* str);
private:
	char *buffer_;

	static TestMemoryAllocator* stringAllocator_;

	char* getEmptyString() const; 
	static char* copyToNewBuffer(const char* bufferToCopy, size_t bufferSize=0);
};

class SimpleStringCollection
{
public:
	SimpleStringCollection();
	~SimpleStringCollection();

	void allocate(size_t size);

	size_t size() const;
	SimpleString& operator[](size_t index);

private:
	SimpleString* collection_;
	SimpleString empty_;
	size_t size_;

	void operator =(SimpleStringCollection&);
	SimpleStringCollection(SimpleStringCollection&);
};

SimpleString StringFrom(bool value);
SimpleString StringFrom(const void* value);
SimpleString StringFrom(char value);
SimpleString StringFrom(const char *value);
SimpleString StringFromOrNull(const char * value);
SimpleString StringFrom(int value);
SimpleString StringFrom(unsigned int value);
SimpleString StringFrom(long value);
SimpleString StringFrom(unsigned long value);
SimpleString HexStringFrom(long value);
SimpleString HexStringFrom(unsigned long value);
SimpleString HexStringFrom(const void* value);
SimpleString StringFrom(double value, int precision = 6);
SimpleString StringFrom(const SimpleString& other);
SimpleString StringFromFormat(const char* format, ...) __check_format__(printf, 1, 2);
SimpleString VStringFromFormat(const char* format, va_list args);

#if CPPUTEST_USE_STD_CPP_LIB

#include <string>
#include <stdint.h>

SimpleString StringFrom(const std::string& other);

#endif

#endif