xcat-core/xCAT-test/bats/check_provisioning_source.bats

#!/usr/bin/env bats
#
# Drive check_provisioning_source.sh, which is what tells a hierarchical provision from a flat
# one. The management node, the service node and the compute node share one subnet and both
# dhcpd instances answer for the compute node, so the management node can win the xNBA exchange
# and serve the boot payload itself. The httpd access logs are the only record of that.
#
# lsdef, xdsh and hostname are stubbed. XCAT_HTTPD_ACCESS_LOG is the management node's log.

load 'helpers/shell_source'

CN=cn01
SN=sn01
CN_IP=192.0.2.10

setup()
{
    SCRIPT="$(require_repo_file 'xCAT-test/autotest/testcase/commoncmd/check_provisioning_source.sh')"
    BIN="${BATS_TEST_TMPDIR}/bin"
    MN_LOG="${BATS_TEST_TMPDIR}/mn-access_log"
    SN_LOG="${BATS_TEST_TMPDIR}/sn-access_log"
    mkdir -p "$BIN"

    printf '#!/bin/sh\nprintf "Object name: %s\\n    ip=%s\\n" "$3" "%s"\n' "%s" "%s" "$CN_IP" >"$BIN/lsdef"
    printf '#!/bin/sh\necho mn01\n' >"$BIN/hostname"
    # A test that reaches the network measures the lab, not this script.
    printf '#!/bin/sh\necho "unexpected getent $*" >&2\nexit 1\n' >"$BIN/getent"
    # xdsh -e copies the script to the service node and runs it there. Run it here instead, with
    # the service node log in place of the management node one, and prefix the node name as xdsh
    # does.
    printf '#!/bin/sh\nnode=$1\nshift\n[ "$1" = "-e" ] && shift\nscript=$1\nshift\nXCAT_HTTPD_ACCESS_LOG=%s "$script" "$@" | sed "s/^/$node: /"\n' \
        "$SN_LOG" >"$BIN/xdsh"
    chmod 0755 "$BIN"/*

    export PATH="$BIN:$PATH"
}

# One access-log line in the combined format, from $1, for $2 bytes.
access_line()
{
    printf '%s - - [01/Jan/2026:00:00:00 +0000] "GET %s HTTP/1.1" 200 %s "-" "iPXE"\n' "$1" "$3" "$2"
}

run_check()
{
    run env XCAT_HTTPD_ACCESS_LOG="$MN_LOG" "$SCRIPT" "$CN" "$SN"
}

@test "a service node that served the compute node and a silent management node pass" {
    access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    access_line 192.0.2.21 4096 /install/rh/x86_64/ >"$MN_LOG"

    run_check
    [ "$status" -eq 0 ]
    [[ "$output" == *"provisioning source ok"* ]]
}

@test "the management node answering for the compute node fails the check" {
    access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    {
        access_line 192.0.2.21 4096 /install/rh/x86_64/
        access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel
    } >"$MN_LOG"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"this provision was flat"* ]]
    [[ "$output" != *"provisioning source ok"* ]]
}

@test "a management node answering only a bodyless request still fails the check" {
    access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    {
        access_line 192.0.2.21 4096 /install/rh/x86_64/
        printf '%s - - [01/Jan/2026:00:00:00 +0000] "HEAD %s HTTP/1.1" 304 - "-" "iPXE"\n' \
            "$CN_IP" /tftpboot/xcat/genesis.kernel
    } >"$MN_LOG"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"this provision was flat"* ]]
}

@test "a service node that served the compute node nothing fails the check" {
    access_line 192.0.2.22 4096 /install/rh/x86_64/ >"$SN_LOG"
    access_line 192.0.2.21 4096 /install/rh/x86_64/ >"$MN_LOG"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"served $CN nothing"* ]]
}

@test "an unreadable service node log fails the check instead of passing it" {
    access_line 192.0.2.21 4096 /install/rh/x86_64/ >"$MN_LOG"
    printf '#!/bin/sh\nexit 1\n' >"$BIN/xdsh"
    chmod 0755 "$BIN/xdsh"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"no httpd access log could be read on $SN"* ]]
}

@test "an empty management node log fails the check instead of reading as silence" {
    access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    : >"$MN_LOG"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"no httpd access log with entries could be read on mn01"* ]]
}

@test "the Debian per-vhost log format is read as the client address" {
    printf 'xcat:80 %s - - [01/Jan/2026:00:00:00 +0000] "GET %s HTTP/1.1" 200 12345678\n' \
        "$CN_IP" /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    printf 'xcat:80 %s - - [01/Jan/2026:00:00:00 +0000] "GET %s HTTP/1.1" 200 4096\n' \
        192.0.2.21 /install/ubuntu/x86_64/ >"$MN_LOG"

    run_check
    [ "$status" -eq 0 ]
    [[ "$output" == *"provisioning source ok"* ]]
}

@test "a compute node with no address fails the check" {
    printf '#!/bin/sh\nexit 1\n' >"$BIN/lsdef"
    printf '#!/bin/sh\nexit 2\n' >"$BIN/getent"
    chmod 0755 "$BIN/lsdef" "$BIN/getent"
    access_line "$CN_IP" 12345678 /tftpboot/xcat/genesis.kernel >"$SN_LOG"
    access_line 192.0.2.21 4096 /install/rh/x86_64/ >"$MN_LOG"

    run_check
    [ "$status" -ne 0 ]
    [[ "$output" == *"has no address"* ]]
}