# 61-ipcalc.test -- ipcalc 1.0.3 (meta-openembedded/meta-networking,
# recipes-support; upstream gitlab.com/ipcalc/ipcalc @ c341e55be386).
#
# The Red Hat / GitLab ipcalc: an IPv4 and IPv6 network and netmask calculator.
# Almost the whole tool is pure computation over inet_pton(3)/inet_ntop(3) and
# integer arithmetic -- no fork, no threads, no mmap, no VLA, no setjmp -- which
# makes it an unusually clean instrument. It measures two things this image's
# other ports do not:
#
#   1. 128-bit network arithmetic. The IPv6 paths carry a /56 host count as
#      2^(72) = 4722366482869645213696 and a /48 address count as
#      1208925819614629174706176 -- decimal strings far past 64 bits, produced by
#      the tool's own multi-word arithmetic, so a wasm32 lowering bug in that
#      arithmetic shows up as a wrong digit rather than a crash.
#   2. The RESOLVER, in isolation. -h (reverse, getnameinfo) and -o (forward,
#      getaddrinfo) are the only two calls in the program that leave libc, so a
#      red there localises to NSS and cannot be confused with a calculation
#      fault. Every other case here is deterministic and network-free.
#
# Calibrated against a NATIVE x86_64 build of the SAME upstream commit, which
# scores all-green on every case below -- so a red here is a target-only
# divergence, not a miscalibrated assertion.

. "$BST_LIB"
require ipcalc ipcalc/present

# field <label> <output> : value of a decorated "<label>:<TAB><value>" line.
# The label column is padded to a tab stop, so "Total:" arrives as "Total:  " --
# strip the colon and any padding before comparing, or that one field reads empty.
field() {
  printf '%s\n' "$2" |
    awk -F'\t' -v k="$1" '{ f=$1; sub(/:[ \t]*$/, "", f); if (f == k) { print $2; exit } }'
}

# has <id> <needle> <haystack> : ok iff <haystack> contains the literal <needle>.
has() {
  case "$3" in
    *"$2"*) bst_ok "$1" ;;
    *)      bst_notok "$1" "want:'$2' got:'$(_bst_1line "$3")'" ;;
  esac
}

# ---------------------------------------------------------------- identity ---
check_out ipcalc/version "ipcalc 1.0.3" ipcalc --version
check_out ipcalc/help    "--split"      ipcalc --help

# ------------------------------------------------ IPv4, decorated default ----
# One invocation, eight fields: the default --info report on a /24.
O=$(ipcalc 192.168.1.5/24 2>&1)
check_eq ipcalc/v4-address   "192.168.1.5"        "$(field Address   "$O")"
check_eq ipcalc/v4-network   "192.168.1.0/24"     "$(field Network   "$O")"
check_eq ipcalc/v4-netmask   "255.255.255.0 = 24" "$(field Netmask   "$O")"
check_eq ipcalc/v4-broadcast "192.168.1.255"      "$(field Broadcast "$O")"
check_eq ipcalc/v4-hostmin   "192.168.1.1"        "$(field HostMin   "$O")"
check_eq ipcalc/v4-hostmax   "192.168.1.254"      "$(field HostMax   "$O")"
check_eq ipcalc/v4-hosts     "254"                "$(field Hosts/Net "$O")"

# --all-info adds the reverse-DNS zone and the classful class. Both are computed
# from the address, NOT resolved -- no network involved.
A=$(ipcalc --all-info 192.168.2.7/24 2>&1)
check_eq ipcalc/allinfo-reverse-dns "2.168.192.in-addr.arpa." "$(field 'Reverse DNS' "$A")"
check_eq ipcalc/allinfo-class       "Class C"                 "$(field 'Address class' "$A")"

# ------------------------------------------- IPv4, --no-decorate selectors ---
# Each selector alone, so a value is asserted exactly rather than by substring.
check_eq ipcalc/nd-address   "10.10.10.5"      "$(ipcalc --no-decorate -a 10.10.10.5/24 2>&1)"
check_eq ipcalc/nd-network   "192.168.2.0"     "$(ipcalc --no-decorate -n 192.168.2.7/24 2>&1)"
check_eq ipcalc/nd-netmask   "255.255.255.0"   "$(ipcalc --no-decorate -m 192.168.2.7/24 2>&1)"
check_eq ipcalc/nd-prefix    "24"              "$(ipcalc --no-decorate -p 192.168.2.7/24 2>&1)"
check_eq ipcalc/nd-broadcast "192.168.2.255"   "$(ipcalc --no-decorate -b 192.168.2.7/24 2>&1)"
check_eq ipcalc/nd-minaddr   "172.16.0.1"      "$(ipcalc --no-decorate --minaddr 172.16.5.9/20 2>&1)"
check_eq ipcalc/nd-maxaddr   "172.16.15.254"   "$(ipcalc --no-decorate --maxaddr 172.16.5.9/20 2>&1)"
check_eq ipcalc/nd-addresses "14"              "$(ipcalc --no-decorate --addresses 192.168.1.0/28 2>&1)"

# Several selectors at once emit ONE line each in the tool's own fixed order
# (netmask, prefix, broadcast) -- not the order they were typed in.
check_eq ipcalc/nd-multi-order "255.255.255.0 24 192.168.2.255" \
  "$(ipcalc --no-decorate -b -m -p 192.168.2.7/24 2>&1 | tr '\n' ' ' | sed 's/ *$//')"

# --addrspace classifies the address, and quotes ONLY a value containing a space.
check_eq ipcalc/addrspace-internet "Internet"       "$(ipcalc --no-decorate --addrspace 8.8.8.8/32 2>&1)"
check_eq ipcalc/addrspace-private  '"Private Use"'  "$(ipcalc --no-decorate --addrspace 10.0.0.1/8 2>&1)"
check_eq ipcalc/addrspace-loopback "Loopback"       "$(ipcalc --no-decorate --addrspace 127.0.0.1/8 2>&1)"

# --class-prefix takes the default prefix from the IPv4 class: 10.x is class A.
check_eq ipcalc/class-prefix "8" "$(ipcalc --class-prefix --no-decorate -p 10.1.2.3 2>&1)"

# ------------------------------------------------------------- validation ----
check_rc ipcalc/check-valid-v4   0 ipcalc -c 10.0.0.1
check_rc ipcalc/check-invalid-v4 1 ipcalc -c 10.0.0.256
check_rc ipcalc/check-valid-v6   0 ipcalc -c ::1
check_rc ipcalc/check-invalid-v6 1 ipcalc -c 2001:xyz::1

# ------------------------------------------------------------------ split ----
S=$(ipcalc -S 26 192.168.5.0/24 2>&1)
check_eq ipcalc/split-v4-count "4"  "$(field Total "$S")"
check_eq ipcalc/split-v4-hosts "62" "$(field Hosts/Net "$S")"
has ipcalc/split-v4-first "192.168.5.0/26"   "$S"
has ipcalc/split-v4-last  "192.168.5.192/26" "$S"
has ipcalc/split-v6-first "2a03:2880:20:4f00::/64" \
  "$(ipcalc -S 64 2a03:2880:20:4f06:face::/56 2>&1)"

# ------------------------------------------------------------ deaggregate ----
# A range that is not on a power-of-two boundary must decompose into exactly the
# three prefixes /32 + /30 + /31 -- an all-arithmetic result.
D=$(ipcalc -d 192.168.2.7-192.168.2.13 2>&1)
has ipcalc/deagg-v4-first "192.168.2.7/32"  "$D"
has ipcalc/deagg-v4-mid   "192.168.2.8/30"  "$D"
has ipcalc/deagg-v4-last  "192.168.2.12/31" "$D"
has ipcalc/deagg-v6 "fcd3:57d1:733:c18f:b498:25e1:788:0/112" \
  "$(ipcalc -d fcd3:57d1:733:c18f:b498:25e1:788:0-fcd3:57d1:733:c18f:b498:25e1:788:ffff 2>&1)"

# ------------------------------------------------------------------- JSON ----
J=$(ipcalc -j --no-decorate -a -n 10.10.10.5/24 2>&1)
has ipcalc/json-address '"ADDRESS":"10.10.10.5"'    "$J"
has ipcalc/json-netmask '"NETMASK":"255.255.255.0"' "$J"
has ipcalc/json-prefix  '"PREFIX":"24"'             "$J"

# ------------------------------------------------------------------- IPv6 ----
V=$(ipcalc 2a03:2880:20:4f06:face::/56 2>&1)
check_eq ipcalc/v6-full-address "2a03:2880:0020:4f06:face:0000:0000:0000" "$(field 'Full Address' "$V")"
check_eq ipcalc/v6-network      "2a03:2880:20:4f00::/56"                  "$(field Network "$V")"
check_eq ipcalc/v6-netmask      "ffff:ffff:ffff:ff00:: = 56"              "$(field Netmask "$V")"
check_eq ipcalc/v6-hostmax      "2a03:2880:20:4fff:ffff:ffff:ffff:ffff"   "$(field HostMax "$V")"
# 128-bit arithmetic: a /56 holds 2^72 hosts, printed in full decimal.
check_eq ipcalc/v6-hosts-128bit "2^(72) = 4722366482869645213696"         "$(field Hosts/Net "$V")"
check_eq ipcalc/v6-addrspace    '"Global Unicast"' "$(ipcalc --no-decorate --addrspace 2a03:2880:20:4f06::/64 2>&1)"
check_eq ipcalc/v6-reverse-dns  "d.7.e.4.6.3.3.a.b.0.d.f.ip6.arpa." \
  "$(ipcalc --no-decorate --reverse-dns fd0b:a336:4e7d::/48 2>&1)"
# A /48's address count is 2^80 -- 25 decimal digits, again all own-arithmetic.
has ipcalc/v6-json-addresses-128bit '"ADDRESSES":"1208925819614629174706176"' \
  "$(ipcalc -j --no-decorate -n fd0b:a336:4e7d::/48 2>&1)"

# --------------------------------------------------------- family forcing ----
check_eq ipcalc/family-v4-flag "10.0.0.0"               "$(ipcalc -4 --no-decorate -n 10.0.0.5/8 2>&1)"
check_eq ipcalc/family-v6-flag "fd95:6be5:ae0:84a5::"   "$(ipcalc -6 --no-decorate -n fd95:6be5:ae0:84a5::/64 2>&1)"

# ----------------------------------------------------------------- random ----
# -r mints a RANDOM private network, so assert its properties, never its value:
# it must be a valid address, and it must land in private space.
R=$(ipcalc -r 24 --no-decorate -n 2>&1)
check_rc ipcalc/random-valid 0 ipcalc -c "$R"
check_eq ipcalc/random-is-private '"Private Use"' "$(ipcalc --no-decorate --addrspace "$R/24" 2>&1)"

# ------------------------------------------------------------ error paths ----
E=$(ipcalc -c -abmnp 10.100.1.1 2>&1); erc=$?
check_eq ipcalc/err-mix-rc "1" "$erc"
has ipcalc/err-mix-message "you cannot mix these options" "$E"
B=$(ipcalc -c 10.0.0.256 2>&1)
has ipcalc/err-bad-address "bad IPv4 address" "$B"
has ipcalc/err-no-address "ip address expected" "$(ipcalc 2>&1)"
# -s suppresses the diagnostic while leaving the exit status intact.
Q=$(ipcalc -s -c 10.0.0.256 2>&1); qrc=$?
check_eq ipcalc/err-silent-rc     "1" "$qrc"
check_eq ipcalc/err-silent-quiet  ""  "$Q"

# -------------------------------------------------------------- resolver -----
# The only two calls in the program that leave libc. Both are asserted against
# `localhost`, which /etc/hosts answers with no network and no DNS server, so a
# red here is the platform's name-resolution path and nothing else.
# Asserted in the DECORATED form, whose HOSTNAME=/ADDRESS= prefix distinguishes
# "resolved to nothing" from "printed nothing at all".
check_eq ipcalc/dns-reverse-localhost "HOSTNAME=localhost" "$(ipcalc -h 127.0.0.1 2>&1)"
check_eq ipcalc/dns-forward-localhost "ADDRESS=127.0.0.1"  "$(ipcalc -o localhost 2>&1)"