From: Kautilya Tripathi <kautilya.tripathi@ibm.com>
Date: Tue, 27 Jan 2026 03:07:20 +0000 (+0530)
Subject: qa/standalone: Add pg_subcommands test
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=e27af4a5ea9b320fb3227e5baa62f1a1c231fa9b;p=ceph.git

qa/standalone: Add pg_subcommands test

This adds test script for pg subcommands like query, log, scrub,
deep-scrub, list-unfound. It compares the output between classic and
crimson.

Signed-off-by: Kautilya Tripathi <kautilya.tripathi@ibm.com>
---

diff --git a/qa/standalone/ceph-helpers.sh b/qa/standalone/ceph-helpers.sh
index ff0fa67e3d87..ca33abc44b8d 100755
--- a/qa/standalone/ceph-helpers.sh
+++ b/qa/standalone/ceph-helpers.sh
@@ -677,6 +677,106 @@ EOF
 
 }
 
+#######################################################################
+
+##
+# Create (prepare) and run (activate) a crimson osd by the name osd.**id**
+# with data in **dir**/**id**.
+#
+# The remaining arguments are passed verbatim to crimson-osd.
+#
+# Two mandatory arguments must be provided: --fsid and --mon-host
+# Instead of adding them to every call to run_crimson_osd, they can be
+# set in the CEPH_ARGS environment variable to be read implicitly by
+# every ceph command.
+#
+# Crimson standalone tests also require msgr2 and require setting either
+# crimson_cpu_num or crimson_cpu_set.
+#
+# @param dir path name of the environment
+# @param id osd identifier
+# @param ... can be any option valid for crimson-osd
+# @return 0 on success, 1 on error
+#
+function run_crimson_osd() {
+    local dir=$1
+    shift
+    local id=$1
+    shift
+    local osd_data=$dir/$id
+
+    local ceph_args="$CEPH_ARGS"
+    ceph_args+=" --osd-failsafe-full-ratio=.99"
+    ceph_args+=" --osd-journal-size=100"
+    ceph_args+=" --osd-scrub-load-threshold=2000"
+    ceph_args+=" --osd-data=$osd_data"
+    ceph_args+=" --osd-journal=${osd_data}/journal"
+    ceph_args+=" --chdir="
+    ceph_args+=$EXTRA_OPTS
+    ceph_args+=" --run-dir=$dir"
+    ceph_args+=" --admin-socket=$(get_asok_path)"
+    ceph_args+=" --log-file=$dir/\$name.log"
+    ceph_args+=" --pid-file=$dir/\$name.pid"
+    ceph_args+=" --osd-max-object-name-len=460"
+    ceph_args+=" --osd-max-object-namespace-len=64"
+    # Crimson requires msgr2
+    ceph_args+=" --ms-bind-msgr2=true"
+    ceph_args+=" --ms-bind-msgr1=false"
+    ceph_args+=" "
+    ceph_args+="$@"
+    mkdir -p $osd_data
+
+    # Find crimson-osd binary
+    local crimson_osd=""
+    if [ -f "./bin/crimson-osd" ]; then
+        crimson_osd="./bin/crimson-osd"
+    elif [ -f "$CEPH_ROOT/build/bin/crimson-osd" ]; then
+        crimson_osd="$CEPH_ROOT/build/bin/crimson-osd"
+    else
+        echo "ERROR: crimson-osd binary not found"
+        return 1
+    fi
+
+    # Enable crimson in the cluster
+    ceph config set global enable_experimental_unrecoverable_data_corrupting_features crimson || return 1
+    ceph osd set-allow-crimson --yes-i-really-mean-it || return 1
+
+    # Standalone tests do not set crimson_cpu_set/crimson_cpu_num (vstart.sh does).
+    # Without this, crimson-osd aborts in get_early_config.
+    ceph config set osd.$id crimson_cpu_num 1 || return 1
+
+    local uuid=`uuidgen`
+    echo "add crimson osd$id $uuid"
+    OSD_SECRET=$(ceph-authtool --gen-print-key)
+    echo "{\"cephx_secret\": \"$OSD_SECRET\"}" > $osd_data/new.json
+    ceph osd new $uuid -i $osd_data/new.json
+    rm $osd_data/new.json
+
+    # Use crimson-osd for mkfs (not ceph-osd!)
+    echo "Running crimson-osd mkfs..."
+    if ! $crimson_osd -i $id $ceph_args --mkfs --key $OSD_SECRET --osd-uuid $uuid 2>&1; then
+        echo "ERROR: crimson-osd --mkfs failed"
+        return 1
+    fi
+
+    local key_fn=$osd_data/keyring
+    cat > $key_fn<<EOF
+[osd.$id]
+key = $OSD_SECRET
+EOF
+    echo adding osd$id key to auth repository
+    ceph -i "$key_fn" auth add osd.$id osd "allow *" mon "allow profile osd" mgr "allow profile osd"
+
+    echo "start crimson osd.$id"
+    $crimson_osd -i $id $ceph_args &
+
+    # If noup is set, then can't wait for this osd
+    if ceph osd dump --format=json | jq '.flags_set[]' | grep -q '"noup"' ; then
+      return 0
+    fi
+    wait_for_osd up $id || return 1
+}
+
 function run_osd_filestore() {
     local dir=$1
     shift
diff --git a/qa/standalone/osd/pg-subcommands.sh b/qa/standalone/osd/pg-subcommands.sh
new file mode 100755
index 000000000000..688ccd637f24
--- /dev/null
+++ b/qa/standalone/osd/pg-subcommands.sh
@@ -0,0 +1,209 @@
+#!/usr/bin/env bash
+source $CEPH_ROOT/qa/standalone/ceph-helpers.sh
+
+_cmp_json_field() {
+    local a=$1
+    local b=$2
+    local field=$3
+    local name=$4
+    local av
+    local bv
+    av=$(echo "$a" | jq -c "$field") || return 1
+    bv=$(echo "$b" | jq -c "$field") || return 1
+    if [ "$av" != "$bv" ]; then
+        echo "Mismatch for $name at $field: classic=$av vs crimson=$bv"
+        return 1
+    fi
+}
+
+_assert_pg_json_sane() {
+    local pgid=$1
+    local json=$2
+    local kind=$3
+
+    echo "$json" | jq -e . >/dev/null || {
+        echo "Invalid JSON output ($kind): $json"
+        return 1
+    }
+
+    if [ "$kind" = "query" ]; then
+        echo "$json" | jq -e --arg pgid "$pgid" '(.pgid == $pgid) or (.pg.pgid == $pgid) or (.info.pgid == $pgid)' >/dev/null || {
+            echo "Query output missing pgid ($pgid): $json"
+            return 1
+        }
+    fi
+}
+
+_wait_for_pg_query_ok() {
+    local pgid=$1
+    local timeout=${2:-60}
+    local deadline=$(( $(date +%s) + timeout ))
+    local had_xtrace=0
+    case "$-" in
+      *x*) had_xtrace=1; set +x ;;
+    esac
+    while [ $(date +%s) -lt $deadline ]; do
+        local q
+        q=$(_run_pg_json "$pgid" query 2>/dev/null || true)
+        if [ -n "$q" ]; then
+          if _assert_pg_json_sane "$pgid" "$q" query >/dev/null 2>&1; then
+            if [ $had_xtrace -eq 1 ]; then
+              set -x
+            fi
+            return 0
+          fi
+        fi
+        sleep 1
+    done
+    if [ $had_xtrace -eq 1 ]; then
+      set -x
+    fi
+    echo "Timed out waiting for pg $pgid query to succeed"
+    ceph -s || true
+    return 1
+}
+
+# Run a subcommand and return JSON
+# Usage: _run_pg_json <pgid> <subcmd> [offset_json]
+_run_pg_json() {
+    local pgid=$1
+    local subcmd=$2
+    local offset_json=$3
+    if [ -n "$offset_json" ]; then
+        ceph --format json pg $pgid $subcmd "$offset_json" | awk 'BEGIN{p=0} /^[[:space:]]*[\[{]/{p=1} p{print}'
+    else
+        ceph --format json pg $pgid $subcmd | awk 'BEGIN{p=0} /^[[:space:]]*[\[{]/{p=1} p{print}'
+    fi
+}
+
+# Save JSON outputs for a given OSD type
+_save_outputs() {
+    local pgid=$1
+    local outdir=$2
+    local qjson ljson ujson ujson_offset
+    qjson=$(_run_pg_json $pgid query) || return 1
+    _assert_pg_json_sane "$pgid" "$qjson" query || return 1
+    ljson=$(_run_pg_json $pgid log) || return 1
+    _assert_pg_json_sane "$pgid" "$ljson" log || return 1
+    ujson=$(_run_pg_json $pgid list_unfound) || return 1
+    _assert_pg_json_sane "$pgid" "$ujson" list_unfound || return 1
+    # Test offset parameter with a valid json-encoded hobject_t.
+    # '{}' decodes as a default hobject_t and should behave like no offset.
+    ujson_offset=$(_run_pg_json $pgid list_unfound '{}') || return 1
+    _assert_pg_json_sane "$pgid" "$ujson_offset" list_unfound || return 1
+    echo "$qjson" > "$outdir/query.json"
+    echo "$ljson" > "$outdir/log.json"
+    echo "$ujson" > "$outdir/list_unfound.json"
+    echo "$ujson_offset" > "$outdir/list_unfound_offset.json"
+}
+
+function run() {
+    local dir=$1
+    shift
+
+    export CEPH_MON="127.0.0.1:7195" # git grep '\<7195\>' : there must be only one
+    export CEPH_ARGS
+    CEPH_ARGS+="--fsid=$(uuidgen) --auth-supported=none "
+    CEPH_ARGS+="--mon-host=$CEPH_MON "
+    CEPH_ARGS+="--crimson_cpu_num=2 "
+
+    export OUTDIR=${TMPDIR:-/tmp}/pg-subcommands-$$
+    rm -rf "$OUTDIR"
+    mkdir -p "$OUTDIR"
+    trap 'rm -rf "$OUTDIR"' EXIT
+
+    local funcs
+    if [ $# -gt 0 ]; then
+        funcs="$*"
+    elif [ -n "$PG_SUBCOMMANDS_FUNCS" ]; then
+        funcs="$PG_SUBCOMMANDS_FUNCS"
+    else
+        funcs="TEST_a_classic_save_outputs TEST_b_crimson_save_and_compare"
+    fi
+    for func in $funcs ; do
+        setup $dir || return 1
+        $func $dir || return 1
+        teardown $dir || return 1
+    done
+}
+
+function TEST_a_classic_save_outputs() {
+    local dir=$1
+
+    run_mon $dir a --osd_pool_default_size=1 --mon_allow_pool_size_one=true \
+      --osd_pool_default_crimson=false || return 1
+    run_mgr $dir x || return 1
+
+    # Run classic OSD first
+    echo "=== Running Classic OSD ==="
+    run_osd $dir 0 || return 1
+
+    local poolname=foo
+    create_pool $poolname 1 1 || return 1
+
+    local objname=obj-$$
+    local pgid
+    pgid=$(get_pg $poolname $objname) || return 1
+
+    _wait_for_pg_query_ok $pgid 60 || return 1
+
+    mkdir -p "$OUTDIR/classic"
+    _save_outputs $pgid "$OUTDIR/classic" || return 1
+
+    delete_pool $poolname
+}
+
+function TEST_b_crimson_save_and_compare() {
+    local dir=$1
+
+    run_mon $dir a --osd_pool_default_size=1 --mon_allow_pool_size_one=true \
+      --osd_pool_default_crimson=true || return 1
+    run_mgr $dir x || return 1
+
+    echo "=== Running Crimson OSD ==="
+    run_crimson_osd $dir 0 || return 1
+
+    local poolname=foo
+    create_pool $poolname 1 1 || return 1
+    ceph osd pool ls detail --format json |
+      jq -e --arg pool "$poolname" '.[] | select(.pool_name == $pool) | (.flags_names // [] | index("crimson"))' >/dev/null || return 1
+
+    local objname=obj-$$
+    local pgid
+    pgid=$(get_pg $poolname $objname) || return 1
+
+    _wait_for_pg_query_ok $pgid 60 || return 1
+
+    mkdir -p "$OUTDIR/crimson"
+    _save_outputs $pgid "$OUTDIR/crimson" || return 1
+
+    if [ -f "$OUTDIR/classic/query.json" ]; then
+        echo "=== Comparing Classic vs Crimson Outputs ==="
+        local classic_query crimson_query classic_unfound crimson_unfound
+        classic_query=$(cat "$OUTDIR/classic/query.json")
+        crimson_query=$(cat "$OUTDIR/crimson/query.json")
+        classic_unfound=$(cat "$OUTDIR/classic/list_unfound.json")
+        crimson_unfound=$(cat "$OUTDIR/crimson/list_unfound.json")
+
+        _cmp_json_field "$classic_query" "$crimson_query" '(.pgid // .pg.pgid // .info.pgid)' "query.pgid" || return 1
+        _cmp_json_field "$classic_unfound" "$crimson_unfound" '(.missing.num_missing // .num_missing // 0)' "list_unfound.num_missing" || return 1
+        _cmp_json_field "$classic_unfound" "$crimson_unfound" '(.missing.num_unfound // .num_unfound // 0)' "list_unfound.num_unfound" || return 1
+    fi
+
+    # Verify list_unfound with offset behaves same as no offset
+    local t base off
+    for t in classic crimson; do
+      if [ ! -f "$OUTDIR/$t/list_unfound.json" ]; then
+          continue
+      fi
+      base=$(cat "$OUTDIR/$t/list_unfound.json") || return 1
+      off=$(cat "$OUTDIR/$t/list_unfound_offset.json") || return 1
+      _cmp_json_field "$base" "$off" '(.missing.num_missing // .num_missing // 0)' "list_unfound offset vs no offset ($t).num_missing" || return 1
+      _cmp_json_field "$base" "$off" '(.missing.num_unfound // .num_unfound // 0)' "list_unfound offset vs no offset ($t).num_unfound" || return 1
+    done
+
+    delete_pool $poolname
+}
+
+# Run cd build && ../qa/run-standalone.sh osd/pg-subcommands.sh
+main pg-subcommands "$@"