# BST-TIMEOUT: 300
#
# dlt-daemon 2.18.10 (meta-oe recipes-extended/dlt-daemon): the AUTOSAR 4.0
# Diagnostic Log and Trace daemon, its user library libdlt, and the dlt-*
# console and adaptor tools. Plain C over CMake; DEPENDS zlib and json-c.
#
# THE PACKAGE HAS TWO INDEPENDENT ARMS AND THIS SUITE COVERS BOTH, because on
# this substrate they do not stand or fall together:
#
#   FILE MODE      dlt_init_file() -> libdlt writes .dlt records straight to a
#                  file. No daemon, no socket, and -- the reason it is here --
#                  NO THREAD: dlt_init_file() is the one constructor that does
#                  not call dlt_start_threads(). So this arm exercises libdlt's
#                  message construction and the DLT wire format even on a day
#                  when thread-mode clone is refused
#                  (linux-in-the-browser#85).
#   DAEMON MODE    dlt-daemon on a loopback TCP port, an application attaching
#                  over the /tmp FIFO IPC, and dlt-receive capturing from the
#                  daemon into a second .dlt file.
#
# BOTH ARMS ARE ASSERTED BYTE-EXACTLY, not by substring. `dlt-convert -a'
# renders each record as
#
#   <idx> <date> <time> <uptime> <counter> <ECU> <APP> <CTX> log warn V 2 [n TEXT]
#
# of which only the first four columns are volatile. Everything from the
# per-context message counter onward is fixed by what the emitter was told to
# send, so each message gets its own case comparing that whole tail against a
# string built here. A substring test for the app id would pass against a
# truncated capture, a duplicated record, or a payload with the arguments
# swapped; this does not.
#
# TWO NEGATIVE CONTROLS, because the assertions above would otherwise pass
# vacuously against a parser that says yes to everything: dlt-convert is asked
# for a message index the file does not have, and is handed a file that is not
# DLT at all. Both have to come back empty.
#
# NOTHING HERE SLEEPS FOR A DURATION. `sleep N' does not sleep on this image --
# 1, 2, 3 and 5 all return in ~0.29 s (linux-in-the-browser#120) -- so every
# bound below is an ITERATION COUNT and each sleep is a yield that lets the
# daemon be scheduled. For the same reason nothing waits on a process:
# signal delivery is unreliable here (brintos/linux#21).
#
# WHAT THE DAEMON ARM CAN AND CANNOT DO ON THIS SUBSTRATE, measured rather than
# assumed. The daemon itself runs: it binds its loopback port, creates its FIFO,
# accepts a client, narrates itself over DLT, and shuts down cleanly -- and
# dlt-daemon/daemon-trace-roundtrip asserts that whole path end to end, from the
# daemon's own record through TCP to dlt-receive's file and back out of
# dlt-convert. What cannot run is a DLT *application*: libdlt's dlt_init()
# starts a housekeeper thread unconditionally, and thread-mode clone is refused
# here with EAGAIN --
#
#   [k] wasm32: REFUSING thread-mode clone (CLONE_VM, ...) with EAGAIN
#   dlt_user.c: Can't create housekeeper thread!  ->  dlt_user_log_init failed
#
# -- so dlt-daemon/app-registered and the four received-record cases are RED and
# stay red until linux-in-the-browser#85 lands. The kernel's refusal names an
# opt-in, HWJS_EXPERIMENTAL_THREAD_CLONE=1; it was measured here on 2026-08-20
# and does NOT change the outcome (identical refusal, same message), so the
# suite does not set it. The FILE arm above is what keeps libdlt covered
# meanwhile, and it needs no thread at all.
#
# `kill -0' IS NOT USED TO ASK WHETHER THE DAEMON IS ALIVE. It succeeds on a
# zombie, so a daemon that died at startup reads as running -- which is exactly
# what happened on the first run of this port, before -DWITH_DLT_USE_IPv6=OFF,
# and it turned a hard failure into a green case. Read /proc/<pid>/status.
. "$BST_LIB"
require dlt-daemon dlt-daemon/present

D=${TMPDIR:-/tmp}/bst-dlt-daemon.$$
rm -rf "$D"; mkdir -p "$D" || { bst_notok dlt-daemon/workdir "cannot create $D"; exit 0; }

running() {
  case "$(sed -n 's/^State:[ \t]*//p' "/proc/$1/status" 2>/dev/null)" in
    "") return 1 ;;   # gone entirely
    Z*) return 1 ;;   # exited, awaiting reap -- dead for every purpose here
    *)  return 0 ;;
  esac
}

# body <file> <appid> <ctxid> -- the volatile-free tail of every log record this
# suite's emitter produced, one per line. Columns 1-4 (index, date, time,
# uptime) are dropped; the daemon's own DLTD/DA1- records are filtered out by
# the app id, which is why each arm uses one of its own.
body() {
  dlt-convert -a "$1" 2>/dev/null \
    | grep " $2 $3 log warn " \
    | awk '{ s=""; for (i = 5; i <= NF; i++) s = s (i > 5 ? " " : "") $i; print s }'
}
# expected <n> <appid> <ctxid> <text> -- what dlt-example-user -n <n> emits.
# ECU1 is libdlt's compiled-in default ECU id and is what both arms carry: the
# file arm reads no configuration at all, and the daemon arm's config names no
# ECUId either, so the same constant is correct for both and a change to it
# would be a real change in what the port produces.
expected() {
  printf '%03d ECU1 %s %s log warn V 2 [%d %s]\n' "$1" "$2" "$3" "$1" "$4"
}
nth() { printf '%s\n' "$1" | sed -n "$(($2 + 1))p"; }

# --------------------------------------------------------------- the tool set
for t in dlt-daemon dlt-receive dlt-convert dlt-example-user dlt-control \
         dlt-sortbytimestamp dlt-adaptor-stdin dlt-adaptor-udp \
         dlt-logstorage-ctrl dlt-passive-node-ctrl dlt-example-user-func \
         dlt-example-user-common-api dlt-example-filetransfer \
         dlt-example-multicast-clientmsg-view; do
  if command -v "$t" >/dev/null 2>&1; then bst_ok "dlt-daemon/have-$t"
  else bst_notok "dlt-daemon/have-$t" "not on PATH"; fi
done
# The two configuration files the package ships; the daemon reads dlt.conf by
# default and 83-dlt-daemon drives it with one of its own instead.
for f in /etc/dlt.conf /etc/dlt_gateway.conf; do
  if [ -f "$f" ]; then bst_ok "dlt-daemon/have-$(basename "$f")"
  else bst_notok "dlt-daemon/have-$(basename "$f")" "absent"; fi
done
# `dlt-convert -h' prints the banner and returns -1, so the exit status is not
# part of the question -- ask the output only.
vout=$(dlt-convert -h 2>&1)
case "$vout" in
  *2.18.10*) bst_ok dlt-daemon/version ;;
  *) bst_notok dlt-daemon/version "$(_bst_1line "$vout")" ;;
esac

# ------------------------------------------------------- ARM 1: file mode
FN=5
FOFF=$D/offline.dlt
fout=$(dlt-example-user -f "$FOFF" -n "$FN" -d 1 -A OFFL -C CTX1 BRINTOS-DLT-OFFLINE 2>&1); frc=$?
if [ -s "$FOFF" ]; then bst_ok dlt-daemon/file-written
else bst_notok dlt-daemon/file-written "rc=$frc $(_bst_1line "$fout")"; fi

check_out dlt-daemon/file-count "Total number of messages: $FN" dlt-convert -c "$FOFF"

fbody=$(body "$FOFF" OFFL CTX1)
fn=$(printf '%s\n' "$fbody" | grep -c 'BRINTOS-DLT-OFFLINE')
check_eq dlt-daemon/file-record-count "$FN" "$fn"
i=0
while [ "$i" -lt "$FN" ]; do
  check_eq "dlt-daemon/file-record-$i" \
           "$(expected "$i" OFFL CTX1 BRINTOS-DLT-OFFLINE)" "$(nth "$fbody" "$i")"
  i=$((i + 1))
done

# dlt-convert -o rewrites the records it read; converting the copy has to render
# identically, which is the only case here that exercises the WRITER.
FCOPY=$D/offline-copy.dlt
if dlt-convert -o "$FCOPY" "$FOFF" >/dev/null 2>&1 && [ -s "$FCOPY" ]; then
  check_eq dlt-daemon/file-rewrite-identical "$fbody" "$(body "$FCOPY" OFFL CTX1)"
else
  bst_notok dlt-daemon/file-rewrite-identical "dlt-convert -o produced nothing"
fi

# ------------------------------------------- negative controls for the parser
# One past the last message: dlt-convert must render nothing rather than
# inventing a record. Its exit status is 0 either way, so the output is the
# assertion.
oob=$(dlt-convert -a -b "$FN" -e "$FN" "$FOFF" 2>&1)
case "$oob" in
  *BRINTOS-DLT-OFFLINE*) bst_notok dlt-daemon/parser-refuses-oob "rendered a record past the end: $(_bst_1line "$oob")" ;;
  *) bst_ok dlt-daemon/parser-refuses-oob ;;
esac
GARB=$D/not-a-dlt-file
printf 'this is not a DLT storage file, not even close\n' > "$GARB"
check_out dlt-daemon/parser-refuses-garbage "Total number of messages: 0" dlt-convert -c "$GARB"

# ------------------------------------------------------- ARM 2: daemon mode
CFG=$D/dlt.conf
PORT=34900
{ echo "Daemonize = 0"
  echo "SendSerialHeader = 0"
  echo "SendContextRegistration = 1"
  echo "LoggingMode = 0"
  echo "LoggingLevel = 6"
  echo "RingbufferMinSize = 500000"
  echo "RingbufferMaxSize = 10000000"
  echo "RingbufferStepSize = 500000"
} > "$CFG"

DLT_PIPE_DIR=$D; export DLT_PIPE_DIR
dlt-daemon -c "$CFG" -t "$D" -p "$PORT" > "$D/daemon.log" 2>&1 &
DPID=$!

# Readiness is the FIFO appearing, not a number of seconds: the daemon creates
# ${-t}/dlt once its connections are up and unlinks it again on exit, so it is
# both the readiness signal and the liveness one. Bounded by iterations.
i=0
while [ "$i" -lt 40 ]; do
  [ -p "$D/dlt" ] && break
  running "$DPID" || break
  i=$((i + 1)); sleep 1
done

if running "$DPID"; then bst_ok dlt-daemon/daemon-alive
else bst_notok dlt-daemon/daemon-alive "$(_bst_1line "$(cat "$D/daemon.log" 2>/dev/null)")"; fi
if [ -p "$D/dlt" ]; then bst_ok dlt-daemon/fifo-created
else bst_notok dlt-daemon/fifo-created "no fifo at $D/dlt: $(_bst_1line "$(cat "$D/daemon.log" 2>/dev/null)")"; fi

RECV=$D/received.dlt
LN=4
if running "$DPID"; then
  dlt-receive -a -o "$RECV" -p "$PORT" 127.0.0.1 > "$D/receive.log" 2>&1 &
  RPID=$!
  # The daemon narrates itself over DLT, to its clients, NOT to stdout -- so
  # `New client connection ...' is a record in the capture and never appears in
  # daemon.log. Attachment is therefore the capture becoming non-empty: the
  # daemon answers a new client with its startup trace and a control response
  # before anything else is sent.
  i=0
  while [ "$i" -lt 40 ]; do
    [ -s "$RECV" ] && break
    running "$RPID" || break
    i=$((i + 1)); sleep 1
  done
  if [ -s "$RECV" ]; then bst_ok dlt-daemon/client-attached
  else bst_notok dlt-daemon/client-attached "nothing captured: $(_bst_1line "$(cat "$D/receive.log" 2>/dev/null)")"; fi

  # The full daemon -> TCP -> dlt-receive -> file -> dlt-convert round trip, on
  # the daemon's OWN first record, compared byte-exactly on its volatile-free
  # tail. This is the case that establishes the transport the ticket asks about
  # independently of whether an application can attach -- and unlike
  # client-attached it would notice a capture that arrived corrupt.
  trace=$(dlt-convert -a "$RECV" 2>/dev/null | grep ' DLTD INTM log info ' \
          | awk '{ s=""; for (i = 5; i <= NF; i++) s = s (i > 5 ? " " : "") $i; print s }' \
          | head -1)
  check_eq dlt-daemon/daemon-trace-roundtrip \
           "000 ECU1 DLTD INTM log info V 1 [Daemon launched. Starting to output traces...]" "$trace"

  eout=$(dlt-example-user -n "$LN" -d 10 -A LOOP -C CTX2 BRINTOS-DLT-LOOPBACK 2>&1); erc=$?
  # One cause explains all five application-side cases when it fires, so name it
  # once and carry it into each of their details rather than leaving four
  # `got:'''` reds a reader has to correlate by hand.
  nothread=""
  case "$eout" in
    *"Can't create housekeeper thread"*)
      nothread="libdlt's dlt_init() could not start its housekeeper thread: thread-mode clone is refused on this substrate with EAGAIN (brintos/linux-in-the-browser#85), so no DLT application can attach to the daemon here" ;;
  esac
  # Registration is asserted from the CAPTURE for the same reason: the daemon's
  # "ApplicationID 'LOOP' registered" is a DLTD/INTM record it sends to its
  # clients. Reading it there proves three things at once -- the application
  # reached the daemon over the FIFO, the daemon accepted it, and the trace
  # travelled the TCP leg to dlt-receive.
  i=0
  while [ "$i" -lt 40 ]; do
    dlt-convert -a "$RECV" 2>/dev/null | grep -q "ApplicationID 'LOOP' registered" && break
    i=$((i + 1)); sleep 1
  done
  if dlt-convert -a "$RECV" 2>/dev/null | grep -q "ApplicationID 'LOOP' registered"; then
    bst_ok dlt-daemon/app-registered
  elif [ -n "$nothread" ]; then
    bst_notok dlt-daemon/app-registered "$nothread"
  else
    bst_notok dlt-daemon/app-registered "rc=$erc $(_bst_1line "$eout")"
  fi

  # Wait for the capture to hold all LN records rather than for a duration.
  i=0
  while [ "$i" -lt 40 ]; do
    [ "$(body "$RECV" LOOP CTX2 | grep -c 'BRINTOS-DLT-LOOPBACK')" -ge "$LN" ] && break
    i=$((i + 1)); sleep 1
  done
  kill "$RPID" 2>/dev/null

  if [ -s "$RECV" ]; then bst_ok dlt-daemon/received-file
  else bst_notok dlt-daemon/received-file "$(_bst_1line "$(cat "$D/receive.log" 2>/dev/null)")"; fi

  rbody=$(body "$RECV" LOOP CTX2)
  rn=$(printf '%s\n' "$rbody" | grep -c 'BRINTOS-DLT-LOOPBACK')
  if [ -n "$nothread" ] && [ "$rn" -eq 0 ]; then
    bst_notok dlt-daemon/received-record-count "$nothread"
    i=0
    while [ "$i" -lt "$LN" ]; do
      bst_notok "dlt-daemon/received-record-$i" "$nothread"
      i=$((i + 1))
    done
  else
    check_eq dlt-daemon/received-record-count "$LN" "$rn"
    i=0
    while [ "$i" -lt "$LN" ]; do
      check_eq "dlt-daemon/received-record-$i" \
               "$(expected "$i" LOOP CTX2 BRINTOS-DLT-LOOPBACK)" "$(nth "$rbody" "$i")"
      i=$((i + 1))
    done
  fi
else
  bst_notok dlt-daemon/client-attached "no daemon to attach to -- see dlt-daemon/daemon-alive"
  bst_notok dlt-daemon/daemon-trace-roundtrip "no daemon to capture from -- see dlt-daemon/daemon-alive"
  bst_notok dlt-daemon/app-registered  "no daemon to register with -- see dlt-daemon/daemon-alive"
  bst_notok dlt-daemon/received-file   "no daemon to receive from -- see dlt-daemon/daemon-alive"
  bst_notok dlt-daemon/received-record-count "no daemon to receive from -- see dlt-daemon/daemon-alive"
  i=0
  while [ "$i" -lt "$LN" ]; do
    bst_notok "dlt-daemon/received-record-$i" "no daemon to receive from -- see dlt-daemon/daemon-alive"
    i=$((i + 1))
  done
fi

# ------------------------------------------------------------- the clean stop
kill "$DPID" 2>/dev/null
i=0
while [ "$i" -lt 40 ]; do
  running "$DPID" || break
  i=$((i + 1)); sleep 1
done
if running "$DPID"; then
  bst_notok dlt-daemon/daemon-stopped "still running after SIGTERM"
else
  bst_ok dlt-daemon/daemon-stopped
fi
# The daemon unlinks its FIFO on the way out; a leftover is a shutdown that did
# not run its cleanup.
if [ -e "$D/dlt" ]; then bst_notok dlt-daemon/fifo-removed "$D/dlt survived shutdown"
else bst_ok dlt-daemon/fifo-removed; fi

rm -rf "$D"