lib/libbe/tests/be_create.sh

   1 #
   2 # SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 #
   4 # Copyright (c) 2019 Rob Wing
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28
  29 # The code for the following tests was copied from the
  30 # bectl tests found in src/sbin/bectl/tests, modified as needed.
  31
  32 ZPOOL_NAME_FILE=zpool_name
  33 get_zpool_name()
  34 {
  35         cat $ZPOOL_NAME_FILE
  36 }
  37 make_zpool_name()
  38 {
  39         mktemp -u libbe_test_XXXXXX > $ZPOOL_NAME_FILE
  40         get_zpool_name
  41 }
  42
  43 # Establishes a libbe zpool that can be used for some light testing; contains
  44 # a 'default' BE and not much else.
  45 libbe_create_setup()
  46 {
  47         zpool=$1
  48         disk=$2
  49         mnt=$3
  50
  51         # Sanity check to make sure `make_zpool_name` succeeded
  52         atf_check test -n "$zpool"
  53
  54         kldload -n -q zfs || atf_skip "ZFS module not loaded on the current system"
  55         atf_check mkdir -p ${mnt}
  56         atf_check truncate -s 1G ${disk}
  57         atf_check zpool create -o altroot=${mnt} ${zpool} ${disk}
  58         atf_check zfs create -o mountpoint=none ${zpool}/ROOT
  59         atf_check zfs create -o mountpoint=/ -o canmount=noauto \
  60             ${zpool}/ROOT/default
  61         atf_check zfs create -o mountpoint=/usr -o canmount=noauto \
  62             ${zpool}/ROOT/default/usr
  63         atf_check zfs create -o mountpoint=/usr/obj -o canmount=noauto \
  64             ${zpool}/ROOT/default/usr/obj
  65 }
  66
  67 libbe_cleanup()
  68 {
  69         zpool=$1
  70         cwd=$(atf_get_srcdir)
  71
  72         if [ -z "$zpool" ]; then
  73                 echo "Skipping cleanup; zpool not set up"
  74         elif zpool get health ${zpool} >/dev/null 2>&1; then
  75                 zpool destroy -f ${zpool}
  76         fi
  77
  78         if [ -f "${cwd}/disk.img" ]; then
  79                 rm ${cwd}/disk.img
  80         fi
  81 }
  82
  83 atf_test_case libbe_create cleanup
  84 libbe_create_head()
  85 {
  86         atf_set "descr" "check _be_create from libbe"
  87         atf_set "require.user" root
  88 }
  89 libbe_create_body()
  90 {
  91         if [ "$(atf_config_get ci false)" = "true" ] && \
  92                 [ "$(uname -p)" = "i386" ]; then
  93                 atf_skip "https://bugs.freebsd.org/249055"
  94         fi
  95
  96         if [ "$(atf_config_get ci false)" = "true" ] && \
  97                 [ "$(uname -p)" = "armv7" ]; then
  98                 atf_skip "https://bugs.freebsd.org/249229"
  99         fi
 100
 101         cwd=$(atf_get_srcdir)
 102         zpool=$(make_zpool_name)
 103         disk=${cwd}/disk.img
 104         mount=${cwd}/mnt
 105         prog=${cwd}/./target_prog
 106
 107         # preliminary setup/checks
 108         atf_require_prog $prog
 109         libbe_create_setup ${zpool} ${disk} ${mount}
 110
 111         # a recursive and non-recursive snapshot to test against
 112         atf_check zfs snapshot ${zpool}/ROOT/default@non-recursive
 113         atf_check zfs snapshot -r ${zpool}/ROOT/default@recursive
 114
 115         # create a dataset after snapshots were taken
 116         atf_check zfs create -o mountpoint=/usr/src -o canmount=noauto \
 117             ${zpool}/ROOT/default/usr/src
 118
 119         # test boot environment creation with depth of 0 (i.e. a non-recursive boot environment).
 120         atf_check $prog "${zpool}/ROOT" \
 121                 nonrecursive \
 122                 "${zpool}/ROOT/default@non-recursive" \
 123                 0
 124         # the dataset should exist
 125         atf_check -o not-empty \
 126                 zfs list "${zpool}/ROOT/nonrecursive"
 127         # the child dataset should not exist.
 128         atf_check -e not-empty -s not-exit:0 \
 129                 zfs list "${zpool}/ROOT/nonrecursive/usr"
 130
 131         # test boot environment creation with unlimited depth (i.e. a recursive boot environment).
 132         atf_check $prog "${zpool}/ROOT" \
 133                 recursive \
 134                 "${zpool}/ROOT/default@recursive" \
 135                 -1
 136         # the dataset should exist
 137         atf_check -o not-empty \
 138                 zfs list "${zpool}/ROOT/recursive"
 139         # the child dataset should exist
 140         atf_check -o not-empty \
 141                   zfs list "${zpool}/ROOT/recursive/usr"
 142         # the child dataset should exist
 143         atf_check -o not-empty \
 144                   zfs list "${zpool}/ROOT/recursive/usr/obj"
 145         # the child dataset should not exist.
 146         atf_check -e not-empty -s not-exit:0 \
 147                 zfs list "${zpool}/ROOT/recursive/usr/src"
 148
 149         # test boot environment creation with a depth of 1
 150         atf_check $prog "${zpool}/ROOT" \
 151                 depth \
 152                 "${zpool}/ROOT/default@recursive" \
 153                 1
 154         # the child dataset should exist
 155         atf_check -o not-empty \
 156                 zfs list "${zpool}/ROOT/depth/usr"
 157         # the child dataset should not exist.
 158         atf_check -e not-empty -s not-exit:0 \
 159                 zfs list "${zpool}/ROOT/depth/usr/obj"
 160         # the child dataset should not exist.
 161         atf_check -e not-empty -s not-exit:0 \
 162                 zfs list "${zpool}/ROOT/depth/usr/src"
 163
 164
 165         # create a recursive boot environment named 'relative-snap'.
 166         # This test is to ensure that a relative snapshot label can be used,
 167         # (i.e. the format: 'bootenvironment@snapshot')
 168         atf_check $prog "${zpool}/ROOT" \
 169                 relative-snap \
 170                 default@recursive \
 171                 -1
 172         # the dataset should exist
 173         atf_check -o not-empty \
 174                 zfs list "${zpool}/ROOT/relative-snap"
 175         # the child dataset should exist
 176         atf_check -o not-empty \
 177                   zfs list "${zpool}/ROOT/relative-snap/usr"
 178 }
 179
 180 libbe_create_cleanup()
 181 {
 182         libbe_cleanup $(get_zpool_name)
 183 }
 184
 185 atf_init_test_cases()
 186 {
 187         atf_add_test_case libbe_create
 188 }