tests/tap/process.h

   1 /*
   2  * Utility functions for tests that use subprocesses.
   3  *
   4  * The canonical version of this file is maintained in the rra-c-util package,
   5  * which can be found at <http://www.eyrie.org/~eagle/software/rra-c-util/>.
   6  *
   7  * Written by Russ Allbery <eagle@eyrie.org>
   8  * Copyright 2009, 2010
   9  *     The Board of Trustees of the Leland Stanford Junior University
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a
  12  * copy of this software and associated documentation files (the "Software"),
  13  * to deal in the Software without restriction, including without limitation
  14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15  * and/or sell copies of the Software, and to permit persons to whom the
  16  * Software is furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  27  * DEALINGS IN THE SOFTWARE.
  28  */
  29
  30 #ifndef TAP_PROCESS_H
  31 #define TAP_PROCESS_H 1
  32
  33 #include <config.h>
  34 #include <tests/tap/macros.h>
  35
  36 BEGIN_DECLS
  37
  38 /*
  39  * Run a function in a subprocess and check the exit status and expected
  40  * output (stdout and stderr combined) against the provided values.  Expects
  41  * the function to always exit (not die from a signal).  data is optional data
  42  * that's passed into the function as its only argument.
  43  *
  44  * This reports as three separate tests: whether the function exited rather
  45  * than was killed, whether the exit status was correct, and whether the
  46  * output was correct.
  47  */
  48 typedef void (*test_function_type)(void *);
  49 void is_function_output(test_function_type, void *data, int status,
  50                         const char *output, const char *format, ...)
  51     __attribute__((__format__(printf, 5, 6), __nonnull__(1)));
  52
  53 /*
  54  * Run a setup program.  Takes the program to run and its arguments as an argv
  55  * vector, where argv[0] must be either the full path to the program or the
  56  * program name if the PATH should be searched.  If the program does not exit
  57  * successfully, call bail, with the error message being the output from the
  58  * program.
  59  */
  60 void run_setup(const char *const argv[])
  61     __attribute__((__nonnull__));
  62
  63 END_DECLS
  64
  65 #endif /* TAP_PROCESS_H */