X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ffailtest%2Ffailtest.h;h=9cabd1a9a712d1ac2bb0c559e41a024b136f1f38;hp=ec238af0ab6f7d195de07df7e597c45c54a61145;hb=05ab011adecfe0ceb82f854a805138f4d235f15c;hpb=c96ab569e73791eabe62e8d1c88b913e89eddc49

diff --git a/ccan/failtest/failtest.h b/ccan/failtest/failtest.h
index ec238af0..9cabd1a9 100644
--- a/ccan/failtest/failtest.h
+++ b/ccan/failtest/failtest.h
@@ -1,5 +1,7 @@
+/* Licensed under LGPL - see LICENSE file for details */
 #ifndef CCAN_FAILTEST_H
 #define CCAN_FAILTEST_H
+#include "config.h"
 #include <sys/types.h>
 #include <stdbool.h>
 #include <fcntl.h>
@@ -143,30 +145,42 @@ struct failtest_call {
 	} u;
 };
 
+enum failtest_result {
+	/* Yes try failing this call. */
+	FAIL_OK,
+	/* No, don't try failing this call. */
+	FAIL_DONT_FAIL,
+	/* Try failing this call but don't go too far down that path. */
+	FAIL_PROBE,
+};
+
 /**
  * failtest_hook - whether a certain call should fail or not.
  * @history: the ordered history of all failtest calls.
  * @num: the number of elements in @history (greater than 0)
  *
  * The default value of this hook is failtest_default_hook(), which returns
- * true (ie. yes, fail the call).
+ * FAIL_OK (ie. yes, fail the call).
  *
  * You can override it, and avoid failing certain calls.  The parameters
  * of the call (but not the return value(s)) will be filled in for the last
  * call.
  *
  * Example:
- *	static bool dont_fail_allocations(struct failtest_call *history,
- *					  unsigned num)
+ *	static enum failtest_result dont_fail_alloc(struct failtest_call *hist,
+ *						    unsigned num)
  *	{
- *		return history[num-1].type != FAILTEST_MALLOC
- *			&& history[num-1].type != FAILTEST_CALLOC
- *			&& history[num-1].type != FAILTEST_REALLOC;
+ *		if (hist[num-1].type == FAILTEST_MALLOC
+ *			|| hist[num-1].type == FAILTEST_CALLOC
+ *			|| hist[num-1].type == FAILTEST_REALLOC)
+ *			return FAIL_DONT_FAIL;
+ *		return FAIL_OK;
  *	}
  *	...
- *		failtest_hook = dont_fail_allocations;
+ *		failtest_hook = dont_fail_alloc;
  */
-extern bool (*failtest_hook)(struct failtest_call *history, unsigned num);
+extern enum failtest_result
+(*failtest_hook)(struct failtest_call *history, unsigned num);
 
 /**
  * failtest_exit_check - hook for additional checks on a failed child.
@@ -183,8 +197,15 @@ extern bool (*failtest_hook)(struct failtest_call *history, unsigned num);
 extern bool (*failtest_exit_check)(struct failtest_call *history,
 				   unsigned num);
 
-/* This usually fails the call. */
-bool failtest_default_hook(struct failtest_call *history, unsigned num);
+/**
+ * failtest_has_failed - determine if a failure has occurred.
+ *
+ * Sometimes you want to exit immediately if you've experienced a failure.
+ * This is useful when you have four separate tests in your test suite,
+ * and you don't want to do the next one if you've had a failure in a
+ * previous one.
+ */
+extern bool failtest_has_failed(void);
 
 /**
  * failtest_timeout_ms - how long to wait before killing child.