. "$BST_LIB"

# BST-TIMEOUT: 300   # ~50 execs of one 616 216 B wasm module, no loops and no
                     # corpus; nothing here waits, every invocation either fails
                     # in argv parsing or is refused by libusb_init and returns
                     # at once. NOT MEASURED -- this port's suite has never run;
                     # 300 is the 60s default scaled for a module ~7x the size of
                     # evtest's, which declares none. Trim it against the first
                     # ==BST-SUITE uhubctl elapsed=..== line rather than leaving
                     # a bound nobody has checked.

# uhubctl 2.5.0 (meta-openembedded/meta-oe recipes-support/uhubctl at SRCREV
# 20276ad5, with a meta-brintos bbappend carrying one LDFLAGS line) -- per-port
# USB power control for smart hubs. ONE binary, /usr/sbin/uhubctl, 616 216 B,
# out of one 1245-line uhubctl.c. The -dev and -dbg packages are empty and are
# not on the image.
#
# THE ANSWER THIS MACHINE GIVES IS NOT THE ONE THE PORT TICKET EXPECTED, and the
# difference is measured rather than argued. BRINTOS-1890 was written against
# "no compatible devices found" -- the empty-enumeration path at uhubctl.c:1149.
# That path is UNREACHABLE here, because libusb_init fails first:
#
#   poky's libusb1 is built --disable-udev on this arm (eudev's do_compile is
#   refused by the toolchain, BRINTOS-1576). find_usbfs_path() looks for
#   /dev/bus/usb, then /dev/usbdev*.*, and its last line is
#
#       #if defined(HAVE_LIBUDEV) || defined(__ANDROID__)
#               return USB_DEVTMPFS_PATH;   /* assume /dev/bus/usb */
#       #else
#               return NULL;
#       #endif
#
#   so WITHOUT udev op_init() finds no usbfs and libusb_init returns
#   LIBUSB_ERROR_OTHER (-99). BRINTOS-1576 built both arms natively from the
#   identical 1.0.27 source with /dev/bus and /sys/bus/usb bind-mounted empty --
#   exactly this guest's state -- and measured --enable-udev rc=0 with an empty
#   device list against --disable-udev rc=-99. 99-libusb1.test pins that choice
#   from three independent places in the shipped archive.
#
# uhubctl checks that return (uhubctl.c:1130) and stops at
#
#     Error initializing USB!
#
# on stderr with exit 1. So on THIS image every USB-touching invocation ends
# there, one call earlier than the ticket predicted, and the empty-enumeration
# message is a string the binary contains and never prints.
#
# NEITHER ARM IS HARDCODED BELOW. The usbfs state is read at runtime, exactly as
# 99-libusb1.test reads it, and each USB-dependent case asserts the arm the probe
# is in -- so the day this image grows a host controller these cases assert the
# enumeration answer instead of skipping, on their own evidence rather than on
# this comment. Both arms are rc 1 with a diagnostic on stderr, which is the
# invariant the port is really being held to.
#
# WHAT IS THEREFORE ASSERTED FOR REAL, and it is most of the program's
# scriptable surface: ARGUMENT VALIDATION PRECEDES libusb_init. main() runs the
# whole getopt_long loop -- including ports2bitmap(), which exit(1)s on a bad
# port spec -- before the first libusb call at uhubctl.c:1130. That ordering is
# not assumed here: parse-precedes-init makes it a case, by handing a bad port
# spec together with a location filter and requiring the port-spec diagnostic
# rather than the USB one. Everything in that half is arithmetic on argv and
# calls to fprintf; a wasm32 build that got it wrong has no environmental excuse.
#
# THE ONE THING A SUITE MUST NOT DO WITH THIS PROGRAM IS LET IT BLOCK. uhubctl
# has no interactive mode, but sleep_ms() and the cycle action can hold it for
# seconds, and a hub scan on a machine whose USB layer misbehaves is exactly the
# shape of hang the runner's suite bound exists for. The no-argument run -- the
# ticket's headline case -- goes through bst_probe with its own 20s bound, so an
# overrun is reported as one case naming the last line printed, rather than
# killing the suite and taking every sibling's result with it.
#
# THE SYSFS OPTION IS ASSERTED AGAINST THE BINARY'S OWN USAGE TEXT, not against
# a guess about the triple. -S/--nosysfs is compiled in only under
# __gnu_linux__, and so is its usage line; the case below requires the two to
# agree, so it stays correct whichever way this toolchain defines the macro.

bst_ok uhubctl/suite-canary   # first line: absorbs brintos/linux#96, which drops it

UH=/usr/sbin/uhubctl

# The absolute path, not the PATH name: /usr/sbin is not on every login's PATH
# here, and a `require uhubctl` that missed it would SKIP this whole file rather
# than red -- an absent suite that reads as a legitimate one. Whether the name
# also resolves through PATH is asserted below as its own case.
require "$UH" uhubctl/present

# uh <id> <want-rc> <needle> -- <argv...>
#   Run inside a command substitution with stdin on /dev/null. The fork is what
#   keeps any invocation that reads stdin away from the suite's own shell, and
#   /dev/null is devtmpfs -- not the virtiofs root the top-level-redirect rule is
#   about (brintos/linux#73).
uh() {
  _id=$1; _want=$2; _needle=$3; shift 3
  _o=$("$UH" "$@" 2>&1 </dev/null); _r=$?
  if bst_execfail "$_o"; then bst_unrun "$_id" "$_o"; return; fi
  if [ "$_r" -ne "$_want" ]; then
    bst_notok "$_id" "rc=$_r want=$_want out:'$(_bst_1line "$_o")'"; return
  fi
  case "$_o" in
    *"$_needle"*) bst_ok "$_id" ;;
    *) bst_notok "$_id" "rc=$_r as wanted, but output lacks '$_needle': $(_bst_1line "$_o")" ;;
  esac
}

# uh_absent <id> <want-rc> <needle-that-must-NOT-appear> -- <argv...>
uh_absent() {
  _id=$1; _want=$2; _needle=$3; shift 3
  _o=$("$UH" "$@" 2>&1 </dev/null); _r=$?
  if bst_execfail "$_o"; then bst_unrun "$_id" "$_o"; return; fi
  if [ "$_r" -ne "$_want" ]; then
    bst_notok "$_id" "rc=$_r want=$_want out:'$(_bst_1line "$_o")'"; return
  fi
  case "$_o" in
    *"$_needle"*) bst_notok "$_id" "output carries '$_needle', which must not be there: $(_bst_1line "$_o")" ;;
    *) bst_ok "$_id" ;;
  esac
}

# --- identity and inventory ---------------------------------------------------
#
# The Makefile installs to $(prefix)/sbin and the recipe overrides neither, so
# ${sbindir} is where the packaging puts it. That is asserted rather than assumed
# because a package whose one program moved would still install, still package
# and still pass every case below through $PATH.
check_eq uhubctl/on-path      "$UH" "$(command -v uhubctl)"
check    uhubctl/is-executable    test -x "$UH"

# The recipe builds ONE program out of one .c. A second name here would mean the
# recipe grew a target the image has not been asked about.
check_eq uhubctl/one-binary "1" "$(ls /usr/sbin/uhubctl* 2>/dev/null | wc -l | tr -d ' ')"

# --- --version ----------------------------------------------------------------
#
# `case 'v'` is printf("%s\n", PROGRAM_VERSION) then exit(0): the ONLY path in
# this program that exits 0 without touching libusb. PROGRAM_VERSION is a -D on
# the compile line, and it is there only because the recipe's do_configure:append
# seds out the Makefile's `GIT_VERSION := $(shell git describe ...)` -- an OE
# build has no tags to describe, so without that sed the banner would read empty.
# Pinning the exact string is therefore pinning that sed, not just a constant.
uh       uhubctl/version-rc         0 "2.5.0" -v
uh       uhubctl/version-long-rc    0 "2.5.0" --version
check_eq uhubctl/version-exact      "2.5.0" "$("$UH" -v 2>/dev/null </dev/null)"
check_eq uhubctl/version-one-line   "1"     "$("$UH" -v 2>/dev/null </dev/null | wc -l | tr -d ' ')"

# --- usage --------------------------------------------------------------------
#
# print_usage() is one printf to STDOUT, and `case 'h'` then exit(1). The stream
# and the status are asserted separately: usage-on-stdout captures without 2>&1,
# so if the block ever moved to stderr it comes back empty and the case reds.
usage_out=$("$UH" -h 2>/dev/null </dev/null); usage_rc=$?
check_eq uhubctl/usage-rc "1" "$usage_rc"
case "$usage_out" in
  *"uhubctl: utility to control USB port power for smart hubs."*)
      bst_ok uhubctl/usage-on-stdout ;;
  *)  bst_notok uhubctl/usage-on-stdout "usage block is not on stdout: '$(_bst_1line "$usage_out")'" ;;
esac
uh uhubctl/usage-long-rc    1 "Usage: uhubctl [options]"     --help
uh uhubctl/usage-no-options 1 "Without options, show status for all smart hubs." -h

# The defaults print_usage() interpolates are the initialisers at uhubctl.c:216.
# They are asserted because they are the values every unqualified run below is
# actually operating with, and because a %g/%d that came out wrong on this arm
# would show here and nowhere else.
uh uhubctl/usage-default-vendor 1 "limit hub by vendor id [any] (partial ok)."   -h
uh uhubctl/usage-default-delay  1 "delay for cycle action [2 sec]."              -h
uh uhubctl/usage-default-repeat 1 "repeat power off count [1]"                   -h
uh uhubctl/usage-default-wait   1 "wait before repeat power off [20 ms]."        -h
uh uhubctl/usage-version-footer 1 "version: 2.5.0"                               -h
uh uhubctl/usage-bugtracker     1 "https://github.com/mvp/uhubctl"               -h

# -S/--nosysfs and its usage line are behind the same #ifdef __gnu_linux__. This
# case requires them to AGREE rather than asserting either -- so it is a real
# statement about the build whichever way clang defines the macro for
# wasm32-hwjs-linux-gnu, and it catches the one combination that would be a
# defect: an option the parser accepts and the help text does not mention, or
# the reverse.
sysfs_help=no
case "$usage_out" in *"--nosysfs,  -S"*) sysfs_help=yes ;; esac
sysfs_opt=no
sysfs_out=$("$UH" -S -p 0 2>&1 </dev/null)
case "$sysfs_out" in *"Bad port spec"*) sysfs_opt=yes ;; esac
printf '#diag: uhubctl __gnu_linux__ sysfs arm: help=%s parser=%s\n' "$sysfs_help" "$sysfs_opt"
check_eq uhubctl/sysfs-option-matches-help "$sysfs_help" "$sysfs_opt"

# --- the argument parser, which runs entirely before libusb --------------------
#
# getopt_long prints its own diagnostic for an unknown option and `case '?'`
# adds one line of its own; both go to stderr, and the exit is 1.
uh uhubctl/bad-option        1 "Run with -h to get usage info." --bst-no-such-option
uh uhubctl/bad-short-option  1 "Run with -h to get usage info." -Z
# A required_argument option with nothing after it is getopt_long's error too.
uh uhubctl/missing-optarg    1 "Run with -h to get usage info." -p

# optind < argc after the loop: a stray non-option word.
uh uhubctl/positional-arg    1 "Invalid command line syntax!"   stray

# ports2bitmap(): MAX_HUB_PORTS is 14, and both refusals name the parsed pair
# back, so the message is evidence that the spec was parsed rather than merely
# rejected.
uh uhubctl/ports-zero        1 "Bad port spec 0-0, port numbers must be from 1 to 14"   -p 0
uh uhubctl/ports-over-max    1 "Bad port spec 15-15, port numbers must be from 1 to 14" -p 15
uh uhubctl/ports-reversed    1 "Bad port spec 5-2, first port must be less than last"   -p 5-2
# `-p -1` is not a missing optarg: getopt_long takes "-1" as the value, and
# ports2bitmap then finds the leading dash as a RANGE separator -- a=atoi("-1")
# is -1, b=atoi("1") is 1 -- so the pair it echoes back is -1-1 rather than the
# -1--1 a reader would predict. Pinned because that is the parse, not the
# arithmetic anyone would guess.
uh uhubctl/ports-negative    1 "Bad port spec -1-1, port numbers must be from 1 to 14"  -p -1
# A well-formed spec is NOT refused -- it passes the parser and goes on to the
# USB layer, so the assertion is the absence of the port-spec diagnostic.
uh_absent uhubctl/ports-single-ok  1 "Bad port spec" -p 1
uh_absent uhubctl/ports-max-ok     1 "Bad port spec" -p 14
uh_absent uhubctl/ports-range-ok   1 "Bad port spec" -p 1-14
uh_absent uhubctl/ports-list-ok    1 "Bad port spec" -p 3,5-7
uh_absent uhubctl/ports-all-ok     1 "Bad port spec" -p all
uh_absent uhubctl/ports-all-case   1 "Bad port spec" -p ALL

# THE ORDERING CASE. A bad port spec together with a location filter: if
# libusb_init ran first, this would carry the USB diagnostic instead. It is the
# one case that proves the whole parser half above is reachable on a machine
# with no USB at all, rather than merely happening to be.
uh uhubctl/parse-precedes-init 1 "Bad port spec 0-0" -l 1-2 -p 0

# The no_argument flags are accepted -- again asserted through the absence of the
# unknown-option diagnostic, since each then falls through to the USB layer.
for f in -e -f -N -R; do
  uh_absent "uhubctl/flag-accepted$f" 1 "Run with -h to get usage info." "$f"
done
# The required_argument options accept a value. -a's unrecognised values are
# handled below; these four are pure atoi/atof/snprintf sinks.
uh_absent uhubctl/optarg-level  1 "Run with -h to get usage info." -L 3
uh_absent uhubctl/optarg-vendor 1 "Run with -h to get usage info." -n 05e3
uh_absent uhubctl/optarg-search 1 "Run with -h to get usage info." -s nothing
uh_absent uhubctl/optarg-delay  1 "Run with -h to get usage info." -d 0.1
uh_absent uhubctl/optarg-repeat 1 "Run with -h to get usage info." -r 1
uh_absent uhubctl/optarg-wait   1 "Run with -h to get usage info." -w 5

# --- the usbfs probe ----------------------------------------------------------
#
# Read the same three facts 99-libusb1.test reads, and print them, so a later
# reader can tell which arm every case below was in without re-deriving it.
devtmpfs=absent; [ -d /dev/bus/usb ] && devtmpfs=present
procusb=absent;  [ -d /proc/bus/usb ] && procusb=present
usbcore=absent;  [ -d /sys/bus/usb ] && usbcore=present
ndev=0
if [ -d /sys/bus/usb/devices ]; then
  for d in /sys/bus/usb/devices/*; do [ -e "$d" ] && ndev=$((ndev + 1)); done
fi
printf '#diag: uhubctl usbfs probe: /dev/bus/usb=%s /proc/bus/usb=%s /sys/bus/usb=%s devices=%s\n' \
  "$devtmpfs" "$procusb" "$usbcore" "$ndev"

# find_usbfs_path() succeeds on either usbfs root; --disable-udev means there is
# no assumed fallback, so this is the whole of the condition.
if [ "$devtmpfs" = present ] || [ "$procusb" = present ]; then
  usb_arm=enumerates
  usb_needle="No compatible devices detected"
else
  usb_arm=init-refused
  usb_needle="Error initializing USB!"
fi
printf '#diag: uhubctl reachable arm: %s (expect "%s")\n' "$usb_arm" "$usb_needle"

# --- the USB-touching surface -------------------------------------------------
#
# THE TICKET'S HEADLINE CASE, and the only one in this file that could hang, so
# it is the only one bounded on its own. bst_probe forks, polls /proc/uptime with
# builtins, and on overrun emits ONE red naming the last line printed instead of
# letting the runner kill the suite.
work=${TMPDIR:-/tmp}/bst-uhubctl.$$
mkdir -p "$work"
# The subject is run under `sh -c` so the WRAPPER exits 0 and bst_probe's own
# case stays green: uhubctl exits 1 here by design, and a probe case that reds on
# the expected status would be a self-inflicted red for every reader to
# re-attribute. The status is carried out of the wrapper on stdout instead, and
# asserted as its own case below.
bst_probe uhubctl/no-args-returns "$work/noargs" 20 sh -c "'$UH'; printf 'BSTRC=%s\n' \$?"
probe_rc=$?
noargs_rc=$(sed -n 's/^BSTRC=//p' "$work/noargs" 2>/dev/null | sed -n 1p)
noargs_out=$(grep -v '^BSTRC=' "$work/noargs" 2>/dev/null)
check_eq uhubctl/no-args-bounded "0"   "$probe_rc"
check_eq uhubctl/no-args-rc      "1"   "$noargs_rc"
noargs_err=$(cat "$work/noargs.err" 2>/dev/null)
case "$noargs_err" in
  *"$usb_needle"*) bst_ok uhubctl/no-args-diagnostic ;;
  *) bst_notok uhubctl/no-args-diagnostic "arm=$usb_arm want:'$usb_needle' got:'$(_bst_1line "$noargs_err")'" ;;
esac
# The diagnostic is on stderr and stdout stays empty: uhubctl prints hub status
# to stdout and it found none, so a byte there would mean it reported a hub.
check_eq uhubctl/no-args-stdout-empty "" "$noargs_out"

# The same refusal through the other entry points the ticket names. Each is a
# distinct path into the same first libusb call, and each is asserted against the
# arm the probe measured rather than against a transcribed string.
uh uhubctl/location-absent    1 "$usb_needle" -l 1-2
uh uhubctl/location-deep      1 "$usb_needle" -l 1-2.3.4
uh uhubctl/action-off         1 "$usb_needle" -a off -p 1
uh uhubctl/action-on-numeric  1 "$usb_needle" -a 1 -p 1
uh uhubctl/action-toggle      1 "$usb_needle" -a toggle -p 1
uh uhubctl/exact-location     1 "$usb_needle" -e -l 1-2

# On the enumerating arm the location is echoed back into the message; on this
# one it is not, because the run never reaches that fprintf. Asserted only where
# it is meaningful, with the probe's own reason on the skip.
if [ "$usb_arm" = enumerates ]; then
  uh uhubctl/location-echoed 1 "at location 1-2" -l 1-2
else
  bst_skip uhubctl/location-echoed "libusb_init returns -99 on this image (no usbfs: /dev/bus/usb=$devtmpfs /proc/bus/usb=$procusb), so uhubctl.c:1149 is never reached and the location is never echoed"
fi

# AN UNRECOGNISED --action VALUE IS SILENTLY IGNORED, not refused: `case 'a'` is
# four strcasecmp arms and no else, so opt_action keeps POWER_KEEP and the run
# continues exactly as an unqualified one. That is upstream's behaviour and not a
# defect of this port; it is pinned because a reader of the usage text would
# expect otherwise, and because a future upstream that started refusing it would
# change what `-a` means to every caller.
uh_absent uhubctl/action-bogus-not-syntax-error 1 "Invalid command line syntax!" -a bst-bogus
uh        uhubctl/action-bogus-falls-through  1 "$usb_needle"                    -a bst-bogus

rm -rf "$work"