tap.h

/* Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved. 

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA

   Library for providing TAP support for testing C and C++ was written
   by Mats Kindahl <mats@mysql.com>.
*/

#ifndef TAP_H
#define TAP_H

#include "my_global.h"

/*
  @defgroup MyTAP MySQL support for performing unit tests according to
  the Test Anything Protocol (TAP).
*/

#define NO_PLAN  (0)

typedef struct TEST_DATA {
  int plan;

  int last;

  int failed;

  char todo[128];
} TEST_DATA;

#ifdef __cplusplus
extern "C" {
#endif

extern int skip_big_tests;

void plan(int const count);


void ok(int const pass, char const *fmt, ...)
  __attribute__((format(printf,2,3)));


void ok1(int const pass);


void skip(int how_many, char const *reason, ...)
    __attribute__((format(printf,2,3)));


#define SKIP_BLOCK_IF(SKIP_IF_TRUE, COUNT, REASON) \
  if (SKIP_IF_TRUE) skip((COUNT),(REASON)); else


#define SKIP_BIG_TESTS(COUNT) \
  if (skip_big_tests) skip((COUNT), "big test"); else


void diag(char const *fmt, ...)
  __attribute__((format(printf,1,2)));


void BAIL_OUT(char const *fmt, ...)
  __attribute__((noreturn, format(printf,1,2)));


int exit_status(void);


void skip_all(char const *reason, ...)
  __attribute__((noreturn, format(printf, 1, 2)));


void todo_start(char const *message, ...)
  __attribute__((format(printf, 1, 2)));


void todo_end();

#ifdef __cplusplus
}
#endif

#endif /* TAP_H */