external/bsd/atf/dist/atf-sh/atf.header.subr

   1 #
   2 # Automated Testing Framework (atf)
   3 #
   4 # Copyright (c) 2007, 2008 The NetBSD Foundation, Inc.
   5 # All rights reserved.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 # 1. Redistributions of source code must retain the above copyright
  11 #    notice, this list of conditions and the following disclaimer.
  12 # 2. Redistributions in binary form must reproduce the above copyright
  13 #    notice, this list of conditions and the following disclaimer in the
  14 #    documentation and/or other materials provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 # CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 # INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 # IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 # IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 # IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29
  30 #
  31 # File: atf.header.subr
  32 #
  33 #   This file provides default contents for the hooks that must be
  34 #   redefined by test programs and other stuff that has to be defined
  35 #   before the test program's code is parsed.
  36 #
  37
  38 # ------------------------------------------------------------------------
  39 # GLOBAL VARIABLES
  40 # ------------------------------------------------------------------------
  41
  42 # The list of all test cases defined by the test program.
  43 Defined_Test_Cases=
  44
  45 # ------------------------------------------------------------------------
  46 # PUBLIC INTERFACE
  47 # ------------------------------------------------------------------------
  48
  49 #
  50 # atf_init_test_cases
  51 #
  52 #   The function in charge of registering the test cases that have to
  53 #   be made available to the user.  Must be redefined.
  54 #
  55 atf_init_test_cases()
  56 {
  57     _atf_error 128 "No test cases defined"
  58 }
  59
  60 #
  61 # atf_test_case tc-name
  62 #
  63 #   Defines a new test case named tc-name.  The name provided here must be
  64 #   accompanied by two functions named after it: <tc-name>_head and
  65 #   <tc-name>_body, and may also be accompanied by a <tc-name>_cleanup
  66 #   function.
  67 #
  68 atf_test_case()
  69 {
  70     Defined_Test_Cases="${Defined_Test_Cases} ${1}"
  71
  72     eval "${1}_head() { _atf_error 128 '${1}_head not defined'; }"
  73     eval "${1}_body() { :; }"
  74     eval "${1}_cleanup() { :; }"
  75 }
  76
  77 # vim: syntax=sh:expandtab:shiftwidth=4:softtabstop=4