Rust: Move upgrade test to separate upgrade-tests directory

Avoids issues with nested qlpack.yml breaking `codeql pack create` for the lib pack.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: redsun82

codeql-workspace.yml

@@ -2,6 +2,7 @@ provide:
   - "*/ql/src/qlpack.yml"
   - "*/ql/lib/qlpack.yml"
   - "*/ql/test*/qlpack.yml"
+  - "*/ql/upgrade-tests/qlpack.yml"
   - "*/ql/examples/qlpack.yml"
   - "*/ql/consistency-queries/qlpack.yml"
   - "*/ql/automodel/src/qlpack.yml"

rust/ql/upgrade-tests/.gitignore

@@ -0,0 +1,9 @@
+target/
+
+# these are all generated, see `rust/extractor/src/qltest.rs` for details
+Cargo.toml
+/*/**/rust-toolchain.toml
+lib.rs
+.proc_macro/
+.lib/
+

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/.gitignore

@@ -0,0 +1,3 @@
+*.testproj/
+*.actual
+*.log

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/README.md

@@ -0,0 +1,25 @@
+# Upgrade Regression Test for rust-analyzer 0.0.301 → 0.0.328
+
+This test verifies that the dbscheme upgrade script correctly preserves data when migrating databases from the old schema to the new schema.
+
+## Running the test
+
+```bash
+./run-test.sh
+```
+
+This will:
+1. Stash any uncommitted changes
+2. Check out the old commit (491c373e076)
+3. Build the old extractor
+4. Create a database with the old schema from `upgrade_shapes.rs`
+5. Restore your branch
+6. Upgrade the database to the new schema
+7. Verify that the old properties are still accessible via the new schema
+
+## Files
+
+- `old.ql` / `old.expected`: Query for the old schema (validates extraction)
+- `new.ql` / `new.expected`: Query for the new schema (validates upgrade preserved data)
+- `upgrade_shapes.rs`: Rust source containing test shapes for all affected schema elements
+- `run-test.sh`: Test runner script

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/new.expected

@@ -0,0 +1,20 @@
+formatArgNamePreserved
+| upgrade_shapes.rs:22:37:22:41 | FormatArgsArg | upgrade_shapes.rs:22:37:22:37 | FormatArgsArgName | upgrade_shapes.rs:22:41:22:41 | 1 | 37 | 1 |
+| upgrade_shapes.rs:22:44:22:48 | FormatArgsArg | upgrade_shapes.rs:22:44:22:44 | FormatArgsArgName | upgrade_shapes.rs:22:48:22:48 | 2 | 44 | 2 |
+tryBlockModifierPreserved
+| upgrade_shapes.rs:21:13:21:21 | { ... } | upgrade_shapes.rs:21:13:21:21 | TryBlockModifier |
+structFieldDefaultPreserved
+| upgrade_shapes.rs:9:5:9:17 | field: u8 | upgrade_shapes.rs:9:17:9:17 | ConstArg | upgrade_shapes.rs:9:17:9:17 | 1 |
+variantDiscriminantPreserved
+| upgrade_shapes.rs:13:5:13:9 | V | upgrade_shapes.rs:13:9:13:9 | ConstArg | upgrade_shapes.rs:13:9:13:9 | 2 |
+pathMetaPreserved
+| upgrade_shapes.rs:4:3:4:11 | PathMeta | path_meta |
+| upgrade_shapes.rs:7:3:7:19 | PathMeta | path_meta |
+keyValueMetaPreserved
+| upgrade_shapes.rs:5:3:5:15 | KeyValueMeta | key_value | upgrade_shapes.rs:5:15:5:15 | 1 |
+tokenTreeMetaPreserved
+| upgrade_shapes.rs:6:3:6:18 | TokenTreeMeta | token_tree | upgrade_shapes.rs:6:13:6:18 | TokenTree |
+unsafeMetaPreserved
+| upgrade_shapes.rs:7:3:7:19 | UnsafeMeta | upgrade_shapes.rs:7:3:7:19 | PathMeta | path_meta |
+traitAliasPreserved
+| upgrade_shapes.rs:16:1:18:12 | trait Alias | upgrade_shapes.rs:16:7:16:11 | Alias | upgrade_shapes.rs:16:18:16:22 | ... | upgrade_shapes.rs:17:1:18:11 | WhereClause |

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/new.ql

@@ -0,0 +1,73 @@
+import codeql.rust.elements
+
+private predicate inUpgradeShapesFile(Locatable loc) {
+  loc.getFile().getBaseName() = "upgrade_shapes.rs"
+}
+
+query predicate formatArgNamePreserved(
+  FormatArgsArg arg, FormatArgsArgName argName, Expr expr, int argNameColumn, string exprText
+) {
+  inUpgradeShapesFile(arg) and
+  argName = arg.getArgName() and
+  expr = arg.getExpr() and
+  argNameColumn = argName.getLocation().getStartColumn() and
+  exprText = expr.toString()
+}
+
+query predicate tryBlockModifierPreserved(BlockExpr block, TryBlockModifier modifier) {
+  inUpgradeShapesFile(block) and
+  modifier = block.getTryBlockModifier() and
+  modifier.isTry() and
+  not modifier.hasTypeRepr()
+}
+
+query predicate structFieldDefaultPreserved(StructField field, ConstArg defaultVal, Expr expr) {
+  inUpgradeShapesFile(field) and
+  defaultVal = field.getDefaultVal() and
+  expr = defaultVal.getExpr()
+}
+
+query predicate variantDiscriminantPreserved(Variant variant, ConstArg constArg, Expr expr) {
+  inUpgradeShapesFile(variant) and
+  constArg = variant.getConstArg() and
+  expr = constArg.getExpr()
+}
+
+query predicate pathMetaPreserved(PathMeta meta, string pathText) {
+  inUpgradeShapesFile(meta) and
+  pathText = meta.getPath().getText() and
+  pathText = "path_meta"
+}
+
+query predicate keyValueMetaPreserved(KeyValueMeta meta, string pathText, Expr expr) {
+  inUpgradeShapesFile(meta) and
+  pathText = meta.getPath().getText() and
+  pathText = "key_value" and
+  expr = meta.getExpr()
+}
+
+query predicate tokenTreeMetaPreserved(TokenTreeMeta meta, string pathText, TokenTree tokenTree) {
+  inUpgradeShapesFile(meta) and
+  pathText = meta.getPath().getText() and
+  pathText = "token_tree" and
+  tokenTree = meta.getTokenTree()
+}
+
+query predicate unsafeMetaPreserved(UnsafeMeta meta, PathMeta inner, string pathText) {
+  inUpgradeShapesFile(meta) and
+  meta.isUnsafe() and
+  inner = meta.getMeta() and
+  pathText = inner.getPath().getText() and
+  pathText = "path_meta"
+}
+
+query predicate traitAliasPreserved(
+  Trait trait, Name name, TypeBoundList bounds, WhereClause whereClause
+) {
+  inUpgradeShapesFile(trait) and
+  name = trait.getName() and
+  name.getText() = "Alias" and
+  bounds = trait.getTypeBoundList() and
+  whereClause = trait.getWhereClause() and
+  not trait.hasAssocItemList()
+}

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/old.expected

@@ -0,0 +1,26 @@
+formatArgsArgName
+| upgrade_shapes.rs:22:37:22:41 | FormatArgsArg | upgrade_shapes.rs:22:37:22:37 | a | upgrade_shapes.rs:22:41:22:41 | 1 | a |
+| upgrade_shapes.rs:22:44:22:48 | FormatArgsArg | upgrade_shapes.rs:22:44:22:44 | b | upgrade_shapes.rs:22:48:22:48 | 2 | b |
+tryBlock
+| upgrade_shapes.rs:21:13:21:21 | { ... } |
+structFieldDefault
+| upgrade_shapes.rs:9:5:9:17 | field: u8 | upgrade_shapes.rs:9:17:9:17 | 1 |
+variantDiscriminant
+| upgrade_shapes.rs:13:5:13:9 | V | upgrade_shapes.rs:13:9:13:9 | 2 |
+metaPath
+| upgrade_shapes.rs:1:4:1:19 | Meta | allow |
+| upgrade_shapes.rs:2:4:2:32 | Meta | feature |
+| upgrade_shapes.rs:4:3:4:11 | Meta | path_meta |
+| upgrade_shapes.rs:5:3:5:15 | Meta | key_value |
+| upgrade_shapes.rs:6:3:6:18 | Meta | token_tree |
+| upgrade_shapes.rs:7:3:7:19 | Meta | path_meta |
+metaExpr
+| upgrade_shapes.rs:5:3:5:15 | Meta | upgrade_shapes.rs:5:15:5:15 | 1 |
+metaTokenTree
+| upgrade_shapes.rs:1:4:1:19 | Meta | upgrade_shapes.rs:1:9:1:19 | TokenTree |
+| upgrade_shapes.rs:2:4:2:32 | Meta | upgrade_shapes.rs:2:11:2:32 | TokenTree |
+| upgrade_shapes.rs:6:3:6:18 | Meta | upgrade_shapes.rs:6:13:6:18 | TokenTree |
+metaIsUnsafe
+| upgrade_shapes.rs:7:3:7:19 | Meta |
+traitAlias
+| upgrade_shapes.rs:16:1:18:12 | TraitAlias | upgrade_shapes.rs:16:7:16:11 | Alias | upgrade_shapes.rs:16:18:16:22 | ... | upgrade_shapes.rs:17:1:18:11 | WhereClause |

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/old.ql

@@ -0,0 +1,56 @@
+import codeql.rust.elements
+
+private predicate inUpgradeShapesFile(Locatable loc) {
+  loc.getFile().getBaseName() = "upgrade_shapes.rs"
+}
+
+query predicate formatArgsArgName(FormatArgsArg arg, Name argName, Expr expr, string nameText) {
+  inUpgradeShapesFile(arg) and
+  argName = arg.getName() and
+  expr = arg.getExpr() and
+  nameText = argName.getText()
+}
+
+query predicate tryBlock(BlockExpr block) {
+  inUpgradeShapesFile(block) and
+  block.isTry()
+}
+
+query predicate structFieldDefault(StructField field, Expr defaultVal) {
+  inUpgradeShapesFile(field) and
+  defaultVal = field.getDefault()
+}
+
+query predicate variantDiscriminant(Variant variant, Expr discriminant) {
+  inUpgradeShapesFile(variant) and
+  discriminant = variant.getDiscriminant()
+}
+
+query predicate metaPath(Meta meta, string pathText) {
+  inUpgradeShapesFile(meta) and
+  pathText = meta.getPath().getText()
+}
+
+query predicate metaExpr(Meta meta, Expr expr) {
+  inUpgradeShapesFile(meta) and
+  expr = meta.getExpr()
+}
+
+query predicate metaTokenTree(Meta meta, TokenTree tokenTree) {
+  inUpgradeShapesFile(meta) and
+  tokenTree = meta.getTokenTree()
+}
+
+query predicate metaIsUnsafe(Meta meta) {
+  inUpgradeShapesFile(meta) and
+  meta.isUnsafe()
+}
+
+query predicate traitAlias(
+  TraitAlias alias, Name name, TypeBoundList bounds, WhereClause whereClause
+) {
+  inUpgradeShapesFile(alias) and
+  name = alias.getName() and
+  bounds = alias.getTypeBoundList() and
+  whereClause = alias.getWhereClause()
+}

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/run-test.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+# Manual regression test for the Rust dbscheme upgrade from rust-analyzer 0.0.301 to 0.0.328.
+# See README.md for details.
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+OLD_COMMIT="${OLD_COMMIT:-491c373e076}"  # origin/main at time of this upgrade
+
+cd "$REPO_ROOT"
+
+# Require clean working directory - stash handling is too fragile
+if ! git diff --quiet HEAD || [ -n "$(git ls-files --others --exclude-standard)" ]; then
+    echo "ERROR: Working directory has uncommitted changes." >&2
+    echo "Please commit or stash your changes before running this test." >&2
+    exit 1
+fi
+
+ORIGINAL_REF="$(git rev-parse --abbrev-ref HEAD)"
+if [ "$ORIGINAL_REF" = "HEAD" ]; then
+    # Detached HEAD - save the commit instead
+    ORIGINAL_REF="$(git rev-parse HEAD)"
+fi
+
+restore_ref() {
+    echo "==> Restoring original ref ($ORIGINAL_REF)..."
+    git checkout --quiet "$ORIGINAL_REF"
+}
+trap 'restore_ref' EXIT
+
+echo "==> Checking out old commit ($OLD_COMMIT)..."
+git checkout --quiet "$OLD_COMMIT"
+
+# Restore the upgrade-tests directory from the original ref (it doesn't exist in old commit)
+git checkout --quiet "$ORIGINAL_REF" -- rust/ql/upgrade-tests codeql-workspace.yml
+
+echo "==> Building old extractor (this may take a while)..."
+bazel run //rust:install
+
+echo "==> Creating old-schema test database..."
+codeql test run \
+    --search-path . \
+    --keep-databases \
+    "$SCRIPT_DIR/old.ql" "$@"
+
+restore_ref
+trap '' EXIT
+
+echo "==> Upgrading dataset to new schema..."
+DATASET_DIR=("$SCRIPT_DIR"/*.testproj/db-rust)
+if [[ ! -d "${DATASET_DIR[0]}" ]]; then
+    echo "ERROR: No testproj found at $SCRIPT_DIR/*.testproj" >&2
+    exit 1
+fi
+codeql dataset upgrade "${DATASET_DIR[0]}" \
+    --search-path . \
+    --target-dbscheme rust/ql/lib/rust.dbscheme
+
+echo "==> Running preservation test on upgraded dataset..."
+codeql test run \
+    --search-path . \
+    --dataset "${DATASET_DIR[0]}" \
+    --check-databases \
+    "$SCRIPT_DIR/new.ql" "$@"
+
+echo "==> All tests passed!"

rust/ql/upgrade-tests/66a489863649185f4a9770f894505803059a1312/upgrade_shapes.rs

@@ -0,0 +1,23 @@
+#![allow(dead_code)]
+#![feature(more_qualified_paths)]
+
+#[path_meta]
+#[key_value = 1]
+#[token_tree(list)]
+#[unsafe(path_meta)]
+struct S {
+    field: u8 = 1,
+}
+
+enum E {
+    V = 2,
+}
+
+trait Alias<T> = Clone
+where
+    T: Copy;
+
+fn f() {
+    let _ = try { 1 };
+    let _ = format_args!("{b} {a}", a = 1, b = 2);
+}