Add script to toggle E2E test backend between sandboxed and non-sandboxed modes (#2588)

Implements bash script `scripts/switch-e2e-backend.sh` that allows developers to easily
switch between sandboxed and non-sandboxed E2E test backends for contracts.

Features:
- Accepts `--manifest-path` argument pointing to contract's Cargo.toml
- Automatically detects current mode and switches to opposite
- Converts test attributes between `#[ink_e2e::test]` and `#[ink_sandbox::test(backend(runtime_only(...)))]`
- Manages sandbox feature flag in Cargo.toml dependencies
- Handles tests with additional parameters (environment, replace_test_attr)
- Provides simple output and error handling consistent with other ink scripts

Author: grandima

scripts/switch-e2e-backend.sh

@@ -0,0 +1,228 @@
+#!/usr/bin/env bash
+
+# switch-e2e-backend - Toggle E2E test backend between sandboxed and non-sandboxed modes
+# Usage: switch-e2e-backend --manifest-path <PATH_TO_CONTRACT_CARGO_TOML>
+
+set -euo pipefail
+
+MANIFEST_PATH=""
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+usage() {
+    cat << EOF
+Usage: $0 --manifest-path <PATH>
+
+Toggle E2E test backend between sandboxed and non-sandboxed modes for a contract.
+
+Arguments:
+    --manifest-path PATH    Path to the contract's Cargo.toml file
+
+Examples:
+    $0 --manifest-path ./integration-tests/my_contract/Cargo.toml
+    $0 --manifest-path /path/to/contract/Cargo.toml
+
+EOF
+}
+
+error() {
+    >&2 echo "Error: $1"
+    exit 1
+}
+
+info() {
+    echo "Info: $1"
+}
+
+warn() {
+    >&2 echo "Warning: $1"
+}
+
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        --manifest-path)
+            MANIFEST_PATH="$2"
+            shift 2
+            ;;
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        *)
+            error "Unknown option: $1. Use --help for usage information."
+            ;;
+    esac
+done
+
+if [[ -z "$MANIFEST_PATH" ]]; then
+    error "--manifest-path is required"
+fi
+
+if [[ ! -f "$MANIFEST_PATH" ]]; then
+    error "Manifest file not found: $MANIFEST_PATH"
+fi
+
+MANIFEST_PATH="$(realpath "$MANIFEST_PATH")"
+CONTRACT_DIR="$(dirname "$MANIFEST_PATH")"
+
+info "Processing contract at: $CONTRACT_DIR"
+
+is_sandboxed() {
+    local cargo_toml="$1"
+
+    # Primary check: look for ink_sandbox::test attributes or backend(runtime_only) in test files
+    local test_files
+    test_files=$(find "$CONTRACT_DIR" -name "*.rs" -type f)
+
+    while IFS= read -r file; do
+        if grep -q '#\[ink_sandbox::test\]' "$file"; then
+            return 0
+        fi
+        if grep -q '#\[.*::test.*backend.*runtime_only\]' "$file"; then
+            return 0
+        fi
+    done <<< "$test_files"
+
+    # Secondary check: look for sandbox feature in Cargo.toml
+    if grep -q 'ink_e2e.*features.*sandbox' "$cargo_toml"; then
+        return 0
+    fi
+
+    return 1
+}
+
+add_sandbox_feature() {
+    local cargo_toml="$1"
+
+    info "Adding sandbox feature to Cargo.toml"
+
+    # Check if ink_e2e dependency exists and add/modify sandbox feature
+    if grep -q 'ink_e2e\s*=' "$cargo_toml"; then
+        # Use Perl for better TOML handling
+        perl -i.bak -pe '
+            if (/ink_e2e\s*=\s*\{[^}]*\}/) {
+                # If ink_e2e already has features, add sandbox to them
+                if (/features\s*=\s*\[/) {
+                    s/(features\s*=\s*\[[^]]*)/\1, "sandbox"/;
+                } else {
+                    # Add features array with sandbox
+                    s/(ink_e2e\s*=\s*\{[^}]*)/\1, features = ["sandbox"]/;
+                }
+            }
+        ' "$cargo_toml"
+    else
+        warn "ink_e2e dependency not found in Cargo.toml"
+    fi
+}
+
+remove_sandbox_feature() {
+    local cargo_toml="$1"
+
+    info "Removing sandbox feature from Cargo.toml"
+
+    # Use Perl for better TOML handling
+    perl -i.bak -pe '
+        # Remove sandbox feature from ink_e2e dependency
+        s/,\s*"sandbox"//g;
+        s/"sandbox",\s*//g;
+
+        # Clean up empty features arrays
+        s/features\s*=\s*\[\s*\]/features = []/g;
+
+        # Remove empty features array entirely
+        s/,\s*features\s*=\s*\[\]//g;
+    ' "$cargo_toml"
+}
+
+make_tests_sandboxed() {
+    local test_files
+    test_files=$(find "$CONTRACT_DIR" -name "*.rs" -type f)
+
+    info "Converting tests to sandboxed mode"
+
+    while IFS= read -r file; do
+        if [[ ! -f "$file" ]]; then
+            continue
+        fi
+
+        # Create backup
+        cp "$file" "$file.bak"
+
+        # Convert #[ink_e2e::test] to #[ink_sandbox::test(backend(runtime_only(...)))]
+        # First handle simple tests
+        sed -i.bak -E 's/#\[ink_e2e::test\]/#[ink_sandbox::test(backend(runtime_only(sandbox = ink_sandbox::DefaultSandbox, client = ink_sandbox::SandboxClient)))]/g' "$file"
+
+        # Handle tests with other attributes
+        sed -i.bak -E 's/#\[ink_e2e::test\(([^)]+)\)\]/#[ink_sandbox::test(\1, backend(runtime_only(sandbox = ink_sandbox::DefaultSandbox, client = ink_sandbox::SandboxClient)))]/g' "$file"
+
+        # Remove backup if changes were made
+        if ! diff -q "$file" "$file.bak" > /dev/null; then
+            rm "$file.bak"
+            info "Modified: $file"
+        else
+            rm "$file.bak"
+        fi
+    done <<< "$test_files"
+}
+
+make_tests_non_sandboxed() {
+    local test_files
+    test_files=$(find "$CONTRACT_DIR" -name "*.rs" -type f)
+
+    info "Converting tests to non-sandboxed mode"
+
+    while IFS= read -r file; do
+        if [[ ! -f "$file" ]]; then
+            continue
+        fi
+
+        # Create backup
+        cp "$file" "$file.bak"
+
+        # Use a more robust approach with Perl for complex regex
+        perl -i.bak -pe '
+            # Remove backend(runtime_only(...)) from test attributes
+            s/backend\s*\(\s*runtime_only\s*\([^)]*\)\)//g;
+
+            # Remove trailing commas and spaces
+            s/,\s*\)/)/g;
+
+            # Convert ink_sandbox::test to ink_e2e::test
+            s/#\[ink_sandbox::test/#\[ink_e2e::test/g;
+
+            # Remove empty parentheses from test attributes
+            s/#\[ink_e2e::test\(\s*\)\]/#[ink_e2e::test]/g;
+        ' "$file"
+
+        # Remove backup if changes were made
+        if ! diff -q "$file" "$file.bak" > /dev/null; then
+            rm "$file.bak"
+            info "Modified: $file"
+        else
+            rm "$file.bak"
+        fi
+    done <<< "$test_files"
+}
+
+# Main logic
+if is_sandboxed "$MANIFEST_PATH"; then
+    info "Current mode: SANDBOXED"
+    info "Switching to non-sandboxed mode..."
+
+    remove_sandbox_feature "$MANIFEST_PATH"
+    make_tests_non_sandboxed
+
+    info "Successfully switched to non-sandboxed mode"
+else
+    info "Current mode: NON-SANDBOXED"
+    info "Switching to sandboxed mode..."
+
+    add_sandbox_feature "$MANIFEST_PATH"
+    make_tests_sandboxed
+
+    info "Successfully switched to sandboxed mode"
+fi
+
+# Clean up backup files
+find "$CONTRACT_DIR" -name "*.bak" -delete 2>/dev/null || true
+
+info "E2E backend switching completed!"