azure / ctest Goto Github PK

A simple portable C test runner

License: Other

CMake 6.21% C 90.52% C++ 1.81% Shell 1.46%

c test-runner testing testing-tools tests

ctest's Introduction

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

ctest

ctest is a simple portable C test runner.

Setup

Clone ctest by:

git clone https://github.com/Azure/ctest

Create a folder called cmake (or any name of your choice).
Switch to the cmake folder and run

cmake ..

Build

Switch to the cmake folder and run:

cmake --build .

Installation and Use

Optionally, you may choose to install ctest on your machine:

Switch to the cmake folder and run

cmake --build . --target install

Linux:

sudo make install

Windows:

msbuild /m INSTALL.vcxproj

Use it in your project (if installed)

find_package(ctest REQUIRED CONFIG)
target_link_library(yourlib ctest)

Building the tests

In order to build the tests use the run_unittests cmake option:

cmake .. -Drun_unittests:bool=ON

Example

#include "ctest.h"
#include "SomeUnitUnderTest.h"

CTEST_BEGIN_TEST_SUITE(SimpleTestSuiteOneTest)

CTEST_FUNCTION(Test1)
{
    // arrange

    // act
    int x = SomeFunction();

    // assert
    CTEST_ASSERT_ARE_EQUAL(int, 42, x);
}

CTEST_END_TEST_SUITE(SimpleTestSuiteOneTest)

ctest's People

Contributors

Stargazers

Watchers

Forkers

andrew-buckley huqikai anporumb isabella232 kevcadieux avranju zhangtiantians mdavis777 nextleo longervisionusa

ctest's Issues

wchar_t support should be added

WTB rich(-er) ASSERTS

At the moment the following is possible

CTEST_ASSERT_IS_TRUE_WITH_MSG(3==3, "someMessage").

I would like to have the MSG part extended, to behave printf-ish like, as in:
CTEST_ASSERT_IS_TRUE_WITH_MSG(3==3, "here is my integer = %d", i);

CTEST_ASSERT_ARE_EQUAL doesn't work with array type

Example:

typedef unsigned char my_type[32];

// … test code
ASSERT_ARE_EQUAL(my_type, a, b);

Fails to compile in CTEST_ASSERT_ARE_EQUAL because the code tries to cast/assign an array type:

#define CTEST_ASSERT_ARE_EQUAL(type, A, B, ...) \
do { \
    const type A_value = (const type)(A); \
    const type B_value = (const type)(B); \

error C2067: cast to array type is illegal

Instead, this does work:

typedef unsigned char my_type[32];
typedef my_type* my_type_ptr;

// … test code
ASSERT_ARE_EQUAL(my_type_ptr, &a, &b);

inconsistent vsnprintf behavior

When using the clang compiler and a test fails with a non-NULL log parameter, ctest fails with the following printf statement: inconsistent vsnprintf behavior. The failure is happening due to a va_list failure that needs to be looked at.

readme does not mention the need for git submodule update

Due to the rather recent addition of the macro utils dependency, a git submodule update --init is needed to be added to the build instructions.

RUN_TEST_SUITE improvements

Would be awesome if the RUN_TEST_SUITE macro would:

either be a rvalue (and return failedTestCount)
either take a size_t*, because it is immediately un-obvious that failedTestCount is actually written by the macro.

x86 relwithdebinfo doesn't run tests in gate

##[warning]No test sources found matching the given filter '**\*test*.dll,!**\obj\**'

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

WTB test fixtures!

at the moment, there's a (1x) global TEST_SUITE_INITIALIZE and a (1x) global TEST_FUNCTION_INITIALIZE. This does not leave much flexibility in setting up the initial conditions for a test.

A test fixture feature would allow reuse of pre-existing conditions easier and would (likely) reduce the amount of code in ///arrange sections.