Skip to content

Commit

Permalink
Merge pull request #47 from stefano-p/feature/ignore-tests
Browse files Browse the repository at this point in the history 
Add IGNORE_TEST and IGNORE_TEST_F macros
  • Loading branch information
@jasmcaus
jasmcaus authored Nov 12, 2024
2 parents a9a377f + 9c36232 commit 909b422
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions tau/tau.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ typedef void (*tau_testsuite_t)();
typedef struct tauTestSuiteStruct {
tau_testsuite_t func;
char* name;
int ignored; // Flag to mark tests that should be skipped
} tauTestSuiteStruct;

typedef struct tauTestStateStruct {
Expand Down Expand Up @@ -184,6 +185,8 @@ static void incrementWarnings() {
#ifndef TAU_NO_TESTING
// extern to the global state tau needs to execute
TAU_EXTERN tauTestStateStruct tauTestContext;
// External declaration for the ignored state of the current test
TAU_EXTERN volatile int isCurrentTestIgnored;

#if defined(_MSC_VER)
#ifndef TAU_USE_OLD_QPC
Expand Down Expand Up @@ -905,6 +908,7 @@ static void tauPrintHexBufCmp(const void* const buff, const void* const ref, con
tauTestContext.numTestSuites)); \
tauTestContext.tests[index].func = &_TAU_TEST_FUNC_##TESTSUITE##_##TESTNAME; \
tauTestContext.tests[index].name = name; \
tauTestContext.tests[index].ignored = 0; \
TAU_SNPRINTF(name, nameSize, "%s", namePart); \
} \
void _TAU_TEST_FUNC_##TESTSUITE##_##TESTNAME(void)
Expand Down Expand Up @@ -946,10 +950,74 @@ static void tauPrintHexBufCmp(const void* const buff, const void* const ref, con
tauTestContext.numTestSuites)); \
tauTestContext.tests[index].func = &__TAU_TEST_FIXTURE_##FIXTURE##_##NAME; \
tauTestContext.tests[index].name = name; \
tauTestContext.tests[index].ignored = 0; \
TAU_SNPRINTF(name, nameSize, "%s", namePart); \
} \
static void __TAU_TEST_FIXTURE_RUN_##FIXTURE##_##NAME(struct FIXTURE* const tau)

/**
Similar to the TEST() macro but marks the test to be ignored during execution.
This allows for temporarily disabling tests without removing them from the codebase.
*/
#define IGNORE_TEST(TESTSUITE, TESTNAME) \
TAU_EXTERN tauTestStateStruct tauTestContext; \
static void _TAU_TEST_FUNC_##TESTSUITE##_##TESTNAME(void); \
TAU_TEST_INITIALIZER(tau_register_##TESTSUITE##_##TESTNAME) { \
const tau_ull index = tauTestContext.numTestSuites++; \
const char* const namePart = #TESTSUITE "." #TESTNAME; \
const tau_ull nameSize = strlen(namePart) + 1; \
char* const name = TAU_PTRCAST(char* , malloc(nameSize)); \
tauTestContext.tests = TAU_PTRCAST( \
tauTestSuiteStruct*, \
tau_realloc(TAU_PTRCAST(void* , tauTestContext.tests), \
sizeof(tauTestSuiteStruct) * \
tauTestContext.numTestSuites)); \
tauTestContext.tests[index].func = &_TAU_TEST_FUNC_##TESTSUITE##_##TESTNAME; \
tauTestContext.tests[index].name = name; \
tauTestContext.tests[index].ignored = 1; /* Mark test as ignored */ \
TAU_SNPRINTF(name, nameSize, "%s", namePart); \
} \
void _TAU_TEST_FUNC_##TESTSUITE##_##TESTNAME(void)

/**
Similar to the TEST_F() macro but marks the fixture test to be ignored during execution.
Maintains all the fixture functionality (setup/teardown) while allowing the test to be skipped.
*/
#define IGNORE_TEST_F(FIXTURE, NAME) \
TAU_EXTERN tauTestStateStruct tauTestContext; \
static void __TAU_TEST_FIXTURE_SETUP_##FIXTURE(struct FIXTURE* const); \
static void __TAU_TEST_FIXTURE_TEARDOWN_##FIXTURE(struct FIXTURE* const); \
static void __TAU_TEST_FIXTURE_RUN_##FIXTURE##_##NAME(struct FIXTURE* const); \
\
static void __TAU_TEST_FIXTURE_##FIXTURE##_##NAME() { \
struct FIXTURE fixture; \
memset(&fixture, 0, sizeof(fixture)); \
__TAU_TEST_FIXTURE_SETUP_##FIXTURE(&fixture); \
if(hasCurrentTestFailed == 1) { \
return; \
} \
\
__TAU_TEST_FIXTURE_RUN_##FIXTURE##_##NAME(&fixture); \
__TAU_TEST_FIXTURE_TEARDOWN_##FIXTURE(&fixture); \
} \
\
TAU_TEST_INITIALIZER(tau_register_##FIXTURE##_##NAME) { \
const tau_ull index = tauTestContext.numTestSuites++; \
const char* const namePart = #FIXTURE "." #NAME; \
const tau_ull nameSize = strlen(namePart) + 1; \
char* name = TAU_PTRCAST(char* , malloc(nameSize)); \
tauTestContext.tests = TAU_PTRCAST( \
tauTestSuiteStruct*, \
tau_realloc(TAU_PTRCAST(void*, tauTestContext.tests), \
sizeof(tauTestSuiteStruct) * \
tauTestContext.numTestSuites)); \
tauTestContext.tests[index].func = &__TAU_TEST_FIXTURE_##FIXTURE##_##NAME; \
tauTestContext.tests[index].name = name; \
tauTestContext.tests[index].ignored = 1; /* Mark test as ignored */ \
TAU_SNPRINTF(name, nameSize, "%s", namePart); \
} \
static void __TAU_TEST_FIXTURE_RUN_##FIXTURE##_##NAME(struct FIXTURE* const tau)


static int tauShouldFilterTest(const char* const filter, const char* const testcase);
static int tauShouldFilterTest(const char* const filter, const char* const testcase) {
Expand Down Expand Up @@ -1142,10 +1210,19 @@ static void tauRunTests() {
for(tau_ull i = 0; i < tauTestContext.numTestSuites; i++) {
checkIsInsideTestSuite = 1;
hasCurrentTestFailed = 0;
isCurrentTestIgnored = tauTestContext.tests[i].ignored;

if(tauShouldFilterTest(cmd_filter, tauTestContext.tests[i].name))
continue;

// Skip ignored tests
if(isCurrentTestIgnored) {
tauColouredPrintf(TAU_COLOUR_BRIGHTYELLOW_, "[ IGNORED ] ");
tauColouredPrintf(TAU_COLOUR_DEFAULT_, "%s\n", tauTestContext.tests[i].name);
tauStatsSkippedTests++;
continue;
}

if(!tauDisplayOnlyFailedOutput) {
tauColouredPrintf(TAU_COLOUR_BRIGHTGREEN_, "[ RUN ] ");
tauColouredPrintf(TAU_COLOUR_DEFAULT_, "%s\n", tauTestContext.tests[i].name);
Expand Down Expand Up @@ -1302,6 +1379,7 @@ inline int tau_main(const int argc, const char* const * const argv) {
volatile int hasCurrentTestFailed = 0; \
volatile int shouldFailTest = 0; \
volatile int shouldAbortTest = 0; \
volatile int isCurrentTestIgnored = 0; \
tau_u64 tauStatsNumWarnings = 0;

// If a user wants to define their own `main()` function, this _must_ be at the very end of the functtion
Expand Down

0 comments on commit 909b422

Please sign in to comment.