summaryrefslogtreecommitdiff
path: root/unittest/mytap/tap.h
diff options
context:
space:
mode:
authorunknown <mats@mysql.com>2006-04-10 17:06:12 +0200
committerunknown <mats@mysql.com>2006-04-10 17:06:12 +0200
commit4f99f11e9c798225fd5906c23dc26da01ae4f20e (patch)
treea0aa9d8a9cbbeb9f6e3b36fb64e93e0cf337725b /unittest/mytap/tap.h
parent3f9e35d3f350768a8d237bfd369adf63f565f81c (diff)
downloadmariadb-git-4f99f11e9c798225fd5906c23dc26da01ae4f20e.tar.gz
WL#3206 (Adding unit tests):
Added 'test' target to build and run tests. Added documentation. Added README.txt files. Fixing problem with initialization of the Test::Harness::Straps replacement. Added code to filter out non- test directories. unittest/Makefile.am: Adding 'test' target to build and run tests. unittest/examples/skip.t.c: Changing text for skip reason. unittest/examples/skip_all.t.c: Changing text for skip reason. unittest/mytap/tap.c: Adding copyright. Adding documentation. Minor code changes. unittest/mytap/tap.h: Adding copyright. Adding documentation. unittest/unit.pl: Initializing replacement Test::Harness::Straps properly. Adding code to filter non-test directories from default directories to use. unittest/README.txt: New BitKeeper file ``unittest/README.txt''
Diffstat (limited to 'unittest/mytap/tap.h')
-rw-r--r--unittest/mytap/tap.h36
1 files changed, 28 insertions, 8 deletions
diff --git a/unittest/mytap/tap.h b/unittest/mytap/tap.h
index 3e9bd4d6e5d..bfd7764ce17 100644
--- a/unittest/mytap/tap.h
+++ b/unittest/mytap/tap.h
@@ -1,12 +1,32 @@
+/* Copyright (C) 2006 MySQL AB
+
+ 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; either version 2 of the License, or
+ (at your option) any later version.
+
+ 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
/*
-
- */
+ @defgroup MyTAP MySQL support for performing unit tests according to TAP.
+
+*/
#define NO_PLAN (0)
-#define SKIP_ALL (-1)
/**
Data about test plan.
@@ -40,12 +60,12 @@ extern "C" {
/**
Set number of tests that is planned to execute.
- The function also accepts the predefined constants SKIP_ALL and
- NO_PLAN.
+ The function also accepts the predefined constant
+ <code>NO_PLAN</code>. If the function is not called, it is as if
+ it was called with <code>NO_PLAN</code>, i.e., the test plan will
+ be printed after all the test lines.
- @param count
- The planned number of tests to run. Alternatively, the SKIP_ALL
- and NO_PLAN can be supplied.
+ @param count The planned number of tests to run.
*/
void plan(int count);