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 <https://www.eyrie.org/~eagle/software/rra-c-util/>.
   6  *
   7  * Written by Russ Allbery <eagle@eyrie.org>
   8  * Copyright 2009-2010, 2013
   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  * SPDX-License-Identifier: MIT
  30  */
  31
  32 #ifndef TAP_PROCESS_H
  33 #define TAP_PROCESS_H 1
  34
  35 #include <config.h>
  36 #include <tests/tap/macros.h>
  37
  38 /* Opaque data type for process_start and friends. */
  39 struct process;
  40
  41 BEGIN_DECLS
  42
  43 /*
  44  * Run a function in a subprocess and check the exit status and expected
  45  * output (stdout and stderr combined) against the provided values.  Expects
  46  * the function to always exit (not die from a signal).  data is optional data
  47  * that's passed into the function as its only argument.
  48  *
  49  * This reports as three separate tests: whether the function exited rather
  50  * than was killed, whether the exit status was correct, and whether the
  51  * output was correct.
  52  */
  53 typedef void (*test_function_type)(void *);
  54 void is_function_output(test_function_type, void *data, int status,
  55                         const char *output, const char *format, ...)
  56     __attribute__((__format__(printf, 5, 6), __nonnull__(1)));
  57
  58 /*
  59  * Run a setup program.  Takes the program to run and its arguments as an argv
  60  * vector, where argv[0] must be either the full path to the program or the
  61  * program name if the PATH should be searched.  If the program does not exit
  62  * successfully, call bail, with the error message being the output from the
  63  * program.
  64  */
  65 void run_setup(const char *const argv[]) __attribute__((__nonnull__));
  66
  67 /*
  68  * process_start starts a process in the background, returning an opaque data
  69  * struct that can be used to stop the process later.  The standard output and
  70  * standard error of the process will be sent to a log file registered with
  71  * diag_file_add, so its output will be properly interleaved with the test
  72  * case output.
  73  *
  74  * The process should create a PID file in the path given as the second
  75  * argument when it's finished initialization.
  76  *
  77  * process_start_fakeroot is the same but starts the process under fakeroot.
  78  * PATH_FAKEROOT must be defined (generally by Autoconf).  If fakeroot is not
  79  * found, process_start_fakeroot will call skip_all, so be sure to call this
  80  * function before plan.
  81  *
  82  * process_stop can be called to explicitly stop the process.  If it isn't
  83  * called by the test program, it will be called automatically when the
  84  * program exits.
  85  */
  86 struct process *process_start(const char *const argv[], const char *pidfile)
  87     __attribute__((__nonnull__));
  88 struct process *process_start_fakeroot(const char *const argv[],
  89                                        const char *pidfile)
  90     __attribute__((__nonnull__));
  91 void process_stop(struct process *);
  92
  93 END_DECLS
  94
  95 #endif /* TAP_PROCESS_H */