#!/usr/bin/env bash # Fetch external DeepDoc testdata into the repo on demand. # # Usage: scripts/fetch_deepdoc_testdata.sh # = the package directory that owns the testdata, e.g. "native" # (mirrors internal/deepdoc//testdata). # # The data lives in an external asset repository # (RAGFLOW_TESTDATA_REPO, default infiniflow/ragflow-testdata — the canonical # org-owned asset repository. The data was migrated out of the xugangqiang fork # (see deepdoc_native_testdata_handoff.md S8) and is pinned by a tag recorded in # internal/deepdoc//testdata.ref. We sparse-clone only the relevant # subtree into a content-addressed cache and symlink it into the package so # existing tests (which read relative testdata/... paths) need no changes. # # Env: # RAGFLOW_TESTDATA_REPO repo "owner/name" (default infiniflow/ragflow-testdata) # RAGFLOW_TESTDATA_REF override the anchor tag/ref (else read testdata.ref) # XDG_CACHE_HOME cache base (default ~/.cache) # # Behavior: # - If testdata is already present INLINE (a real dir, pre-migration), this # script leaves it untouched and exits (nothing to fetch). # - If a correct symlink already exists, it exits. # - Only when testdata is ABSENT do we clone the pinned subtree and symlink # it in. We never delete an inline (tracked) testdata directory. # - When a GEN_* env var is set (testdata regeneration, e.g. GEN_CONTOURS=1), # the subtree is COPIED to a writable local dir instead of symlinked, so # regeneration tests can write back (handoff S4.5). set -euo pipefail if [ $# -lt 1 ]; then echo "usage: $0 " >&2 exit 2 fi PKG="$1" # Resolve repo root from this script's location (scripts/ -> repo root). SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" REF_FILE="$ROOT/internal/deepdoc/$PKG/testdata.ref" REF="${RAGFLOW_TESTDATA_REF:-}" if [ -z "$REF" ] && [ -f "$REF_FILE" ]; then REF="$(head -n1 "$REF_FILE" | tr -d '[:space:]')" fi if [ -z "$REF" ]; then echo "fetch_deepdoc_testdata: no ref set (RAGFLOW_TESTDATA_REF or $REF_FILE)" >&2 exit 1 fi REPO="${RAGFLOW_TESTDATA_REPO:-infiniflow/ragflow-testdata}" CACHE_BASE="${XDG_CACHE_HOME:-$HOME/.cache}/ragflow-testdata" CACHE="$CACHE_BASE/$REF" SRC="$CACHE/deepdoc/$PKG/testdata" TARGET="$ROOT/internal/deepdoc/$PKG/testdata" # Determine whether we need a writable copy (regeneration) or a symlink. NEED_WRITE=0 for v in "${!GEN_@}"; do if [ -n "${!v:-}" ]; then NEED_WRITE=1; break; fi done # Already a correct symlink -> done. if [ -L "$TARGET" ] && [ "$(readlink -f "$TARGET")" = "$(readlink -f "$SRC")" ] && [ -n "$(ls -A "$SRC" 2>/dev/null)" ]; then echo "fetch_deepdoc_testdata: $PKG already linked ($REF)" exit 0 fi # Inline testdata already present (real dir, pre-migration) -> nothing to do. if [ -d "$TARGET" ] && [ ! -L "$TARGET" ] && [ -n "$(ls -A "$TARGET" 2>/dev/null)" ]; then echo "fetch_deepdoc_testdata: $PKG testdata already present inline at $TARGET" exit 0 fi # Absent (or stale symlink) -> fetch. rm -f "$TARGET" 2>/dev/null || true if [ ! -e "$SRC" ] || [ -z "$(ls -A "$SRC" 2>/dev/null)" ]; then echo "fetch_deepdoc_testdata: cloning $REPO @ $REF (subtree deepdoc/$PKG/testdata)" mkdir -p "$CACHE_BASE" # Network clones are best-effort and occasionally fail with a transient TLS # reset (seen on the self-hosted runner). Retry a few times before giving up # so a CI blip does not redden the run. attempt=0 max_attempts=3 fetched=0 until [ "$attempt" -ge "$max_attempts" ]; do attempt=$((attempt + 1)) rm -rf "$CACHE" if git clone --depth 1 --filter=blob:none --branch "$REF" --sparse \ "https://github.com/$REPO.git" "$CACHE" >&2 && \ git -C "$CACHE" sparse-checkout set "deepdoc/$PKG/testdata" >&2; then fetched=1 break fi echo "fetch_deepdoc_testdata: clone attempt $attempt/$max_attempts failed, retrying in 3s" >&2 sleep 3 done if [ "$fetched" -ne 1 ]; then echo "fetch_deepdoc_testdata: clone failed after $max_attempts attempts" >&2 exit 1 fi fi if [ ! -e "$SRC" ] || [ -z "$(ls -A "$SRC" 2>/dev/null)" ]; then echo "fetch_deepdoc_testdata: cloned but subtree deepdoc/$PKG/testdata is empty" >&2 exit 1 fi if [ "$NEED_WRITE" -eq 1 ]; then echo "fetch_deepdoc_testdata: copying writable testdata for regeneration ($PKG @ $REF)" rm -rf "$TARGET" cp -r "$SRC" "$TARGET" else echo "fetch_deepdoc_testdata: linking $TARGET -> $SRC" ln -s "$SRC" "$TARGET" fi echo "fetch_deepdoc_testdata: done ($PKG @ $REF)"