run.h

Go to the documentation of this file.

#pragma once

#include <stdbool.h>
#include <sys/types.h>

#include "definitions.h"

typedef size_t scrGroup;

typedef void
scrTestFn(void);

typedef struct scrTestOptions {
    unsigned int timeout; 
    unsigned int flags;   
} scrTestOptions;

typedef void *
scrCtxCreateFn(void *);

typedef void
scrCtxCleanupFn(void *);

typedef struct scrGroupOptions {
    scrCtxCreateFn *create_fn;
    scrCtxCleanupFn *cleanup_fn;
} scrGroupOptions;

typedef struct scrOptions {
    void *global_ctx;   
    unsigned int flags; 
} scrOptions;

typedef struct scrStats {
    unsigned int num_passed;  
    unsigned int num_skipped; 
    unsigned int num_failed;  
    unsigned int
        num_errored; 
} scrStats;

#define SCR_TF_XFAIL 0x00000001

#define SCR_RF_FAIL_FAST 0x00000001

#define SCR_RF_VERBOSE 0x00000002

scrGroup
scrGroupCreate(const scrGroupOptions *options) SCR_EXPORT;

void
scrAddTest(scrGroup group, const char *name, scrTestFn test_fn, const scrTestOptions *options) SCR_EXPORT
    SCR_NONNULL(2, 3);

void
scrGroupAddTest(scrGroup group, const char *name, scrTestFn test_fn, const scrTestOptions *options) SCR_EXPORT
    SCR_NONNULL(2, 3) __attribute__((deprecated("scrGroupAddTest is deprecated.  Use scrAddTest.")));

bool
scrPatchFunction(scrGroup group, const char *func_name, const char *file_substring, void *new_func) SCR_EXPORT
    SCR_NONNULL(2, 4);

bool
scrGroupPatchFunction(scrGroup group, const char *func_name, const char *file_substring,
                      void *new_func) SCR_EXPORT SCR_NONNULL(2, 4)
    __attribute__((deprecated("scrGroupPatchFunction is deprecated.  Use scrPatchFunction.")));

int
scrRun(const scrOptions *options, scrStats *stats) SCR_EXPORT;