forgedock 1.27.0 → 1.28.0

package/scripts/symbol-index.test.sh

@@ -0,0 +1,119 @@
+#!/usr/bin/env bash
+# symbol-index.test.sh — cases for scripts/symbol-index.{py,mjs} (forge#4208).
+# SPDX-FileCopyrightText: Copyright (c) RapierCraft Studios
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# Optional: SYMBOL_INDEX_TS_NODE_MODULES=<node_modules holding typescript@5> also runs the TS-parser cases.
+set -uo pipefail
+HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PY="$HERE/symbol-index.py"; MJS="$HERE/symbol-index.mjs"; FX="$HERE/fixtures/symbol-index"
+PASS=0; FAILN=0
+TMP="$(mktemp -d "${TMPDIR:-/tmp}/symbol-index-test.XXXXXX")"; trap 'rm -rf "$TMP"' EXIT
+ok() { PASS=$((PASS+1)); }
+bad() { FAILN=$((FAILN+1)); echo "FAIL: $1"; }
+eq() { if [ "$2" = "$3" ]; then ok; else bad "$1 (got: $2 want: $3)"; fi }
+q() { printf '%s' "$OUT" | jq -c "$1"; }
+run() { OUT="$("$@" 2>"$TMP/err")"; RC=$?; }
+
+# ---- 1. Python file: schema, symbols, spans, public flags ----
+run python3 "$PY" "$FX/py/sample.py"
+eq "py file rc" "$RC" 0
+eq "py top-level keys" "$(q 'keys')" '["cycles","edges","imports","symbols"]'
+eq "symbol keys" "$(q '[.symbols[]|keys]|unique')" '[["end","kind","lines","name","public","start"]]'
+eq "symbol names" "$(q '[.symbols[].name]')" \
+  '["__all__","LIMIT","_cache","_normalise","greet","fetch","helper","Greeter","Greeter.__init__","Greeter.text","Greeter._shout","Greeter.shout"]'
+eq "kinds" "$(q '[.symbols[]|select(.name=="LIMIT" or .name=="greet" or .name=="fetch" or .name=="Greeter" or .name=="Greeter.shout")|.kind]')" \
+  '["const","function","async_function","class","method"]'
+eq "greet span" "$(q '.symbols[]|select(.name=="greet")|[.start,.end,.lines]')" '[15,16,2]'
+eq "class span" "$(q '.symbols[]|select(.name=="Greeter")|[.start,.end,.lines]')" '[27,41,15]'
+eq "decorator in span" "$(q '.symbols[]|select(.name=="Greeter.text")|[.start,.end,.lines]')" '[33,35,3]'
+eq "public set" "$(q '[.symbols[]|select(.public)|.name]')" \
+  '["LIMIT","greet","fetch","Greeter","Greeter.__init__","Greeter.text","Greeter.shout"]'
+eq "helper not in __all__" "$(q '.symbols[]|select(.name=="helper")|.public')" 'false'
+
+# ---- 2. edges and imports ----
+eq "edges" "$(q '[.edges[]|"\(.from)>\(.to)"]')" \
+  '["Greeter._shout>Greeter.text","Greeter.shout>Greeter._shout","Greeter.text>greet","fetch>LIMIT","fetch>_cache","greet>_normalise"]'
+eq "imports" "$(q '.imports')" \
+  '[{"line":2,"module":"os","names":[]},{"line":3,"module":"collections","names":["OrderedDict"]}]'
+eq "single file has no cycles" "$(q '.cycles')" '[]'
+
+# ---- 3. never includes file bodies ----
+for needle in SECRET_DOCSTRING_MARKER SECRET_CLASS_DOC_MARKER 'hi ' 'strip()' 'getcwd' 'return'; do
+  case "$OUT" in *"$needle"*) bad "output leaks source text: $needle" ;; *) ok ;; esac
+done
+
+# ---- 4. import cycles across modules ----
+run python3 "$PY" "$FX/py/pkg"
+eq "pkg rc" "$RC" 0
+eq "pkg cycles (TYPE_CHECKING + function-local imports ignored)" "$(q '.cycles')" '[["pkg.a","pkg.b"]]'
+eq "pkg relative import resolved" "$(q '[.imports[]|select(.file|endswith("b.py"))|.module]')" '["typing","pkg","pkg.a"]'
+eq "pkg cross-module edges" "$(q '[.edges[]|"\(.from)>\(.to)"]')" '["pkg.a:run>pkg.b:step","pkg.b:step>pkg.c:value"]'
+eq "pkg symbols carry file" "$(q '[.symbols[]|has("file")]|unique')" '[true]'
+BEFORE="$(q '.cycles')"
+cp -R "$FX/py/pkg" "$TMP/pkg"
+printf 'from . import a\n' > "$TMP/pkg/d.py"
+printf 'from . import d\n' >> "$TMP/pkg/c.py"
+run python3 "$PY" "$TMP/pkg"
+AFTER="$(q '.cycles')"
+eq "after: cycle set grows" "$AFTER" '[["pkg.a","pkg.b","pkg.c","pkg.d"]]'
+eq "before/after diff finds the new cycle" \
+  "$(jq -nc --argjson b "$BEFORE" --argjson a "$AFTER" '$a - $b')" '[["pkg.a","pkg.b","pkg.c","pkg.d"]]'
+printf 'import pkg.e\n' > "$TMP/pkg/e.py"
+run python3 "$PY" "$TMP/pkg"
+eq "self-import is a cycle" "$(q '.cycles|map(select(.==["pkg.e"]))|length')" '1'
+
+# ---- 5. deterministic ----
+A1="$(python3 "$PY" "$FX/py/pkg")"; A2="$(python3 "$PY" "$FX/py/pkg")"
+eq "byte-identical reruns" "$([ "$A1" = "$A2" ] && echo same)" same
+
+# ---- 6. unsupported: exit 0, only {unsupported, reason} ----
+for t in "$FX/other/sample.rb" "$FX/ts/sample.ts"; do
+  run python3 "$PY" "$t"
+  eq "py unsupported rc $(basename "$t")" "$RC" 0
+  eq "py unsupported keys $(basename "$t")" "$(q 'keys')" '["reason","unsupported"]'
+done
+eq "py unsupported lang" "$(python3 "$PY" "$FX/other/sample.rb" | jq -r .unsupported)" ruby
+run python3 "$PY" "$FX/py/sample.py" "$FX/other/sample.rb"
+eq "mixed input: no partial output" "$(q 'keys')" '["reason","unsupported"]'
+mkdir -p "$TMP/empty"; run python3 "$PY" "$TMP/empty"
+eq "dir without .py" "$(q '.')" '{"reason":"no-python-files","unsupported":"unknown"}'
+mkdir -p "$TMP/broken"; printf 'def ok():\n    return 1\n' > "$TMP/broken/good.py"; printf 'def broken(:\n' > "$TMP/broken/bad.py"
+run python3 "$PY" "$TMP/broken"
+eq "parse error rc" "$RC" 0
+eq "parse error: no partial symbols" "$(q 'keys')" '["reason","unsupported"]'
+eq "parse error reason" "$(q '.reason|startswith("parse-error: ")')" 'true'
+
+run node "$MJS" "$FX/other/sample.rb"
+eq "mjs ruby rc" "$RC" 0
+eq "mjs ruby" "$(q '.')" '{"reason":"unknown-language","unsupported":"ruby"}'
+mkdir -p "$TMP/ts"; cp "$FX/ts/sample.ts" "$TMP/ts/"
+run node "$MJS" "$TMP/ts/sample.ts"
+eq "mjs ts without parser rc" "$RC" 0
+eq "mjs ts without parser" "$(q '.')" '{"reason":"no-parser","unsupported":"ts"}'
+run node "$MJS" "$FX/py/sample.py"
+eq "mjs delegates .py" "$(q '.symbols|length')" '12'
+
+# ---- 7. usage ----
+python3 "$PY" >/dev/null 2>&1; eq "py no args" "$?" 2
+python3 "$PY" "$TMP/missing.py" >/dev/null 2>&1; eq "py missing path" "$?" 2
+node "$MJS" >/dev/null 2>&1; eq "mjs no args" "$?" 2
+
+# ---- 8. optional: TS parser path ----
+if [ -n "${SYMBOL_INDEX_TS_NODE_MODULES:-}" ] && [ -d "$SYMBOL_INDEX_TS_NODE_MODULES/typescript" ]; then
+  ln -s "$SYMBOL_INDEX_TS_NODE_MODULES" "$TMP/ts/node_modules"
+  run node "$MJS" "$TMP/ts/sample.ts"
+  eq "ts symbols" "$(q '[.symbols[]|"\(.kind):\(.name):\(.start)-\(.end):\(.public)"]')" \
+    '["const:LIMIT:3-3:true","function:load:5-7:true","class:Loader:9-13:true","method:Loader.read:10-12:true"]'
+  eq "ts edges" "$(q '[.edges[]|"\(.from)>\(.to)"]')" '["Loader.read>load","load>LIMIT"]'
+  mkdir -p "$TMP/ts/lib"
+  printf 'import { b } from "./b";\nimport type { T } from "./c";\nexport function a(): number { return b(); }\n' > "$TMP/ts/lib/a.ts"
+  printf 'import * as A from "./a.js";\nexport const b = () => 2;\nexport function useA() { return A.a(); }\n' > "$TMP/ts/lib/b.ts"
+  printf 'import { a } from "./a";\nexport type T = number;\n' > "$TMP/ts/lib/c.ts"
+  run node "$MJS" "$TMP/ts/lib"
+  eq "ts cycles (import type ignored)" "$(q '.cycles')" '[["a","b"]]'
+else
+  echo "symbol-index.test.sh: TS-parser cases skipped (set SYMBOL_INDEX_TS_NODE_MODULES)"
+fi
+
+echo "symbol-index.test.sh: $PASS passed, $FAILN failed"
+[ "$FAILN" -eq 0 ]

package/scripts/symbol-move-ts.test.sh

@@ -0,0 +1,161 @@
+#!/usr/bin/env bash
+# symbol-move-ts.test.sh — cases for scripts/symbol-move.mjs, the ts-morph mover (forge#4212).
+# SPDX-FileCopyrightText: Copyright (c) RapierCraft Studios
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# Builds a throwaway git repo from scripts/fixtures/symbol-move-ts/gen_big.mjs (~700-line src/big.ts + node:test
+# suite), moves four symbol groups into src/big_parts/ and proves the move with scripts/refactor-verify.sh; then
+# checks the refusals, the --extend chain step and the no-ts-morph refusal (no partial edits).
+# ts-morph: SYMBOL_MOVE_TS_NODE_MODULES=<node_modules holding ts-morph> (put on NODE_PATH for the mover, the symbol
+# index and refactor-verify). Without it the ts-morph cases are skipped; SYMBOL_MOVE_REQUIRE_TS_MORPH=1 turns that
+# skip into a failure.
+set -uo pipefail
+HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+SM="$HERE/symbol-move.mjs"; RV="$HERE/refactor-verify.sh"; GEN="$HERE/fixtures/symbol-move-ts/gen_big.mjs"
+PASS=0; FAILN=0
+TMP="$(mktemp -d "${TMPDIR:-/tmp}/symbol-move-ts-test.XXXXXX")"; trap 'rm -rf "$TMP"' EXIT
+ok() { PASS=$((PASS+1)); }
+bad() { FAILN=$((FAILN+1)); echo "FAIL: $1"; }
+eq() { if [ "$2" = "$3" ]; then ok; else bad "$1 (got: $2 want: $3)"; fi }
+has() { if grep -qF -- "$2" "$3"; then ok; else bad "$1 (no '$2' in $3)"; fi }
+q() { printf '%s' "$OUT" | jq -c "$1"; }
+TSM="${SYMBOL_MOVE_TS_NODE_MODULES:-}"
+[ -n "$TSM" ] && [ -d "$TSM/ts-morph" ] || TSM=""
+# without: no NODE_PATH and a HOME holding no node_modules, so ts-morph cannot resolve from anywhere
+without() { OUT="$(cd "$R" && env -u NODE_PATH HOME="$TMP/home" node "$SM" "$@" 2>"$TMP/err")"; RC=$?; }
+mover() { OUT="$(cd "$R" && NODE_PATH="$TSM" node "$SM" "$@" 2>"$TMP/err")"; RC=$?; }
+mkdir -p "$TMP/home"
+
+R="$TMP/repo"; B="$TMP/baseline.json"; P="$TMP/plan.json"
+TEST_CMD='node --test test/big.test.ts'
+g() { git -C "$R" -c user.name=t -c user.email=t@example.invalid "$@"; }
+mkdir -p "$R"; git init -q "$R"
+node "$GEN" "$R" || bad "generator failed"
+g add -A && g commit -qm base && g tag base
+eq "fixture size >= 600 lines" "$([ "$(wc -l < "$R/src/big.ts")" -ge 600 ] && echo yes || echo no)" yes
+SHA0="$(git -C "$R" hash-object src/big.ts)"
+reset() { g reset -q --hard base; g clean -fdq; }
+
+seqp() { local f="$1" s=""; for i in $(seq -w 0 19); do s="$s\"$(printf "$f" "$i")\","; done; printf '%s' "${s%,}"; }
+plan() { printf '%s' "$1" | jq -c . > "$2" || bad "bad plan json"; }
+CONSTS="[$(seqp 'LIMIT_%s')]"
+HELPERS="[$(for i in $(seq -w 0 19); do printf '"_scale_%s","compute_%s",' "$i" "$i"; done | sed 's/,$//')]"
+MODELS="[$(seqp 'Item_%s'),$(seqp 'Store_%s')]"
+AIO="[$(seqp 'fetch_%s')]"
+FULL="{\"consts\":$CONSTS,\"helpers\":$HELPERS,\"models\":$MODELS,\"aio\":$AIO}"
+plan "$FULL" "$P"
+
+# refused <label>: rc 3, status refused, a reason, and nothing changed in the repo
+refused() {
+  eq "$1: rc" "$RC" 3
+  eq "$1: status" "$(q '.status')" '"refused"'
+  eq "$1: has reason" "$(q '.reason|length>0')" true
+  eq "$1: tree untouched" "$(git -C "$R" status --porcelain)" ""
+  eq "$1: barrel untouched" "$(git -C "$R" hash-object src/big.ts)" "$SHA0"
+}
+
+# ---- 1. no codemod tool: ts-morph unresolvable -> clean refusal before anything is read or written ----
+without --src src/big.ts --plan "$P"
+refused "no ts-morph"
+eq "no ts-morph: reason" "$(q '.reason|startswith("no codemod tool for ts: ts-morph is not resolvable")')" true
+without --probe --src src/big.ts
+eq "no ts-morph probe: rc" "$RC" 3
+eq "no ts-morph probe: reason" "$(q '.reason|startswith("no codemod tool for ts:")')" true
+eq "no ts-morph: no package dir" "$([ -e "$R/src/big_parts" ] && echo yes || echo no)" no
+
+# ---- 2. usage ----
+OUT="$(node "$SM" --plan "$P" 2>/dev/null)"; eq "usage: rc" "$?" 2
+OUT="$(node "$SM" --src "$R/src/nope.ts" --plan "$P" 2>/dev/null)"; eq "missing src: rc" "$?" 2
+
+if [ -z "$TSM" ]; then
+  if [ "${SYMBOL_MOVE_REQUIRE_TS_MORPH:-0}" = "1" ]; then bad "ts-morph required (SYMBOL_MOVE_REQUIRE_TS_MORPH=1) but SYMBOL_MOVE_TS_NODE_MODULES has no ts-morph"; fi
+  echo "symbol-move-ts.test.sh: ts-morph cases skipped (set SYMBOL_MOVE_TS_NODE_MODULES)"
+  echo "symbol-move-ts.test.sh: $PASS passed, $FAILN failed"
+  [ "$FAILN" -eq 0 ]; exit
+fi
+export NODE_PATH="$TSM"
+
+# ---- 3. probe and dry run ----
+mover --probe --src src/big.ts
+eq "probe: rc" "$RC" 0
+eq "probe: tool" "$(q '.tool')" '"ts-morph"'
+mover --src src/big.ts --plan "$P" --dry-run
+eq "dry-run: rc" "$RC" 0
+eq "dry-run: tree untouched" "$(git -C "$R" status --porcelain)" ""
+
+# ---- 4. the move: four groups into src/big_parts/, barrel at the old path, refactor-verify ok ----
+bash "$RV" baseline --root "$R" --target src/big.ts --test-cmd "$TEST_CMD" --out "$B" >/dev/null 2>"$TMP/err" || { cat "$TMP/err"; bad "baseline failed"; }
+eq "baseline counts" "$(jq -c .test "$B")" '{"exit":0,"passed":5,"skipped":1}'
+eq "baseline flags erased types" "$(jq -c '[.symbols[]|select(.type)]|length' "$B")" 20
+mover --src src/big.ts --plan "$P"
+eq "move: rc" "$RC" 0
+eq "move: status" "$(q '.status')" '"ok"'
+eq "move: package" "$(q '.package')" '"src/big_parts"'
+eq "move: modules" "$(q '.modules|keys')" '["aio","consts","helpers","models"]'
+for m in consts helpers models aio; do
+  eq "module $m exists" "$([ -f "$R/src/big_parts/$m.ts" ] && echo yes || echo no)" yes
+  has "barrel re-exports $m" "} from \"./big_parts/$m.ts\";" "$R/src/big.ts"
+done
+has "barrel re-exports types with type" 'export { type Item_00, Store_00,' "$R/src/big.ts"
+has "barrel imports names kept code uses" 'import { compute_00 } from "./big_parts/helpers.ts";' "$R/src/big.ts"
+has "barrel keeps unmoved code" 'function _shared(x: number): number {' "$R/src/big.ts"
+has "barrel keeps the header" '// SPDX-License-Identifier: MIT' "$R/src/big.ts"
+has "relative import re-based" 'import { clamp } from "../util.ts";' "$R/src/big_parts/helpers.ts"
+has "type import pruned and re-based" 'import { type Unit } from "../util.ts";' "$R/src/big_parts/models.ts"
+has "sibling import" 'import { compute_00, compute_01,' "$R/src/big_parts/models.ts"
+has "private helper moved verbatim" 'function _scale_07(x: number): number {' "$R/src/big_parts/helpers.ts"
+has "doc comment moved" '/** compute 7: scaled and clamped. */' "$R/src/big_parts/helpers.ts"
+eq "no moved declaration left" "$(grep -c '^export function compute_\|^function _scale_\|^export class Store_\|^export interface Item_' "$R/src/big.ts")" 0
+g add -A && g commit -qm move
+OUT="$(bash "$RV" verify --baseline "$B" --base base 2>"$TMP/err")"; RC=$?
+eq "verify: rc" "$RC" 0
+eq "verify: ok" "$(q '.ok')" true
+# a dropped type re-export is caught statically
+sed -i.bak 's/export { type Item_00, Store_00, /export { Store_00, /' "$R/src/big.ts"; rm -f "$R/src/big.ts.bak"
+g commit -qam drop-type
+OUT="$(bash "$RV" verify --baseline "$B" --base base 2>"$TMP/err")"; RC=$?
+eq "dropped type: rc" "$RC" 1
+eq "dropped type: missing" "$(q '[.failures[]|select(.kind=="missing-symbol")|.name]')" '["Item_00"]'
+reset
+
+# ---- 5. refusals: nothing touched ----
+plan '{"a":["nope"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "unknown symbol"
+plan '{"a":["LIMIT_00"],"b":["LIMIT_00"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "listed twice"
+plan '{"a":["Store_00.add"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "method"
+plan '{"index":["LIMIT_00"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "bad module name"
+plan '{"a":["compute_00"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "needs a kept name"
+eq "needs a kept name: reason" "$(q '.reason|test("needs \"_scale_00\", which stays")')" true
+plan '{"a":["_shared"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "private used by kept code"
+eq "private used by kept code: reason" "$(q '.reason|test("not exported but kept code uses it")')" true
+plan '{"a":["_scale_00","LIMIT_00"],"b":["compute_00"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "private used by a sibling"
+eq "private used by a sibling: reason" "$(q '.reason|test("not exported")')" true
+plan '{"a":["ping"],"b":["pong"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "cycle"
+eq "cycle: reason" "$(q '.reason|test("import cycle")')" true
+mkdir -p "$R/src/big_parts"; plan "{\"consts\":$CONSTS}" "$P"; mover --src src/big.ts --plan "$P"
+eq "existing package: rc" "$RC" 3
+eq "existing package: reason" "$(q '.reason|test("already exists")')" true
+rmdir "$R/src/big_parts"
+printf 'export default function main(): number {\n  return 1;\n}\n' >> "$R/src/big.ts"; g commit -qam default; SHA0="$(git -C "$R" hash-object src/big.ts)"
+plan '{"a":["main"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "export default"
+printf 'export const HERE = import.meta.url;\n' >> "$R/src/big.ts"; g commit -qam meta; SHA0="$(git -C "$R" hash-object src/big.ts)"
+plan '{"a":["HERE"]}' "$P"; mover --src src/big.ts --plan "$P"; refused "import.meta"
+reset; SHA0="$(git -C "$R" hash-object src/big.ts)"
+
+# ---- 6. chain: a second step adds modules to the existing package with --extend ----
+plan "{\"consts\":$CONSTS,\"helpers\":$HELPERS}" "$P"; mover --src src/big.ts --plan "$P"
+eq "chain step 1: rc" "$RC" 0
+g add -A && g commit -qm step1
+plan "{\"models\":$MODELS}" "$P"; mover --src src/big.ts --plan "$P" --package big_parts
+eq "chain without --extend: rc" "$RC" 3
+plan "{\"models\":$MODELS}" "$P"; mover --src src/big.ts --plan "$P" --package big_parts --extend
+eq "chain step 2: rc" "$RC" 0
+has "chain step 2: barrel" '} from "./big_parts/models.ts";' "$R/src/big.ts"
+has "chain step 2: earlier module imported in-package" '} from "./helpers.ts";' "$R/src/big_parts/models.ts"
+g add -A && g commit -qm step2
+OUT="$(bash "$RV" verify --baseline "$B" --base base 2>"$TMP/err")"; RC=$?
+eq "chain verify: ok" "$(q '.ok')" true
+plan "{\"models\":[\"fetch_00\"]}" "$P"; mover --src src/big.ts --plan "$P" --package big_parts --extend
+eq "chain existing module: rc" "$RC" 3
+eq "chain existing module: reason" "$(q '.reason|test("module already exists")')" true
+
+echo "symbol-move-ts.test.sh: $PASS passed, $FAILN failed"
+[ "$FAILN" -eq 0 ]