Fix Solana CLI path in GitHub Actions workflows

devloai[bot] · devloai[bot] · commit 365ed41c15af · 2025-03-30T09:18:45.000Z
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -26,6 +26,23 @@
 - **Rust:** Primary language for the Solana program
 - **Solana CLI:** For building and testing Solana programs
 
+### Solana CLI Installation
+
+The workflow automatically installs the Solana CLI using the following process:
+
+```bash
+# Install Solana CLI tools
+sh -c "$(curl -sSfL https://release.solana.com/v1.16.0/install)"
+
+# Add to GitHub Actions PATH
+echo "$HOME/.local/share/solana/install/active_release/bin" >> $GITHUB_PATH
+
+# Also add to current shell session
+export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+```
+
+This ensures that the Solana binaries are available for all steps in the workflow that require them.
+
 ## Testnet Transaction Metrics Workflow
 
 This workflow automates the process of running Tornado-SVM privacy solution transactions on Solana testnet and generating comprehensive metrics reports.
@@ -92,3 +109,18 @@ To manually trigger the workflow with custom parameters:
 4. Enter your desired parameters (denomination, Merkle tree height, RPC URL)
 5. Click "Run workflow"
 6. Once completed, download the artifacts from the workflow run
+
+### Troubleshooting
+
+#### Solana CLI Not Found
+
+If you encounter the error `solana: command not found`, check the following:
+
+1. Verify that the Solana CLI installation step completed successfully
+2. Check that the PATH is correctly set in each step that uses Solana commands
+3. The workflow now explicitly adds the Solana binaries to PATH in each step using:
+   ```bash
+   export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+   ```
+4. The transaction script has been enhanced to provide detailed diagnostic information when Solana is not found
+5. If problems persist, try using the `SOLANA_PATH` environment variable in the workflow step
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,17 +27,38 @@ jobs:
         with:
           components: rustfmt, clippy
 
-      - name: Install Solana tools
+      - name: Install Solana CLI
         run: |
+          # Install Solana CLI tools
           sh -c "$(curl -sSfL https://release.solana.com/v1.16.0/install)"
+          # Add Solana to PATH for this job
           echo "$HOME/.local/share/solana/install/active_release/bin" >> $GITHUB_PATH
+          # Also add to PATH for current shell session
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+          # Verify installation
           solana --version
 
       - name: Build Solana program
-        run: cargo build-bpf
+        run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+          # Try the newer cargo build-sbf command first, fall back to cargo build-bpf if not available
+          if command -v cargo build-sbf &> /dev/null; then
+            cargo build-sbf
+          else
+            cargo build-bpf
+          fi
 
       - name: Run Solana tests
-        run: cargo test-bpf
+        run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+          # Try the newer cargo test-sbf command first, fall back to cargo test-bpf if not available
+          if command -v cargo test-sbf &> /dev/null; then
+            cargo test-sbf
+          else
+            cargo test-bpf
+          fi
 
       - name: Run Cargo Clippy
         run: cargo clippy -- -D warnings
diff --git a/.github/workflows/tornado_testnet_transaction.yml b/.github/workflows/tornado_testnet_transaction.yml
@@ -50,10 +50,15 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y libudev-dev libusb-1.0-0-dev pkg-config
       
-      - name: Install Solana Tool Suite
+      - name: Install Solana CLI
         run: |
+          # Install Solana CLI tools
           sh -c "$(curl -sSfL https://release.solana.com/v1.16.0/install)"
+          # Add Solana to PATH for this job
           echo "$HOME/.local/share/solana/install/active_release/bin" >> $GITHUB_PATH
+          # Also add to PATH for current shell session
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+          # Verify installation
           solana --version
       
       - name: Install Rust
@@ -70,6 +75,8 @@ jobs:
       
       - name: Generate keypair for testing
         run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
           solana-keygen new --no-bip39-passphrase -o ~/.config/solana/id.json
           solana config set --url ${{ github.event.inputs.rpc_url || 'https://api.testnet.solana.com' }}
           echo "# Tornado SVM Testnet Transaction Report" > reports/transaction_report.md
@@ -87,6 +94,8 @@ jobs:
       
       - name: Request airdrop
         run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
           echo "## Solana Testnet Airdrop" >> reports/transaction_report.md
           echo "Requesting airdrop..." | tee -a reports/transaction_report.md
           solana airdrop 1 $(solana address) || true
@@ -122,12 +131,15 @@ jobs:
       
       - name: Run Tornado transaction script with metrics
         run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
           echo "## Transaction Log" >> reports/transaction_report.md
           echo "\`\`\`" >> reports/transaction_report.md
           cd scripts
           # Explicitly disabling telegram-related environment variables before running script
           export TELEGRAM_BOT_TOKEN=disabled TELEGRAM_CHAT_ID=disabled SKIP_TELEGRAM_NOTIFICATIONS=true
-          ./run_tornado_transaction_metrics.sh 2>&1 | tee -a ../reports/transaction_log.txt
+          # Pass the Solana PATH to the script
+          SOLANA_PATH="$HOME/.local/share/solana/install/active_release/bin" ./run_tornado_transaction_metrics.sh 2>&1 | tee -a ../reports/transaction_log.txt
           cat ../reports/transaction_log.txt >> ../reports/transaction_report.md
           echo "\`\`\`" >> reports/transaction_report.md
         env:
@@ -243,6 +255,8 @@ jobs:
           TELEGRAM_CHAT_ID: 'disabled'
           SKIP_TELEGRAM_NOTIFICATIONS: 'true'
         run: |
+          # Ensure Solana binaries are in PATH
+          export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
           echo "## Solana Network Metrics" >> reports/transaction_report.md
           echo "### Transaction Count" >> reports/transaction_report.md
           echo "\`\`\`" >> reports/transaction_report.md
diff --git a/docs/github_actions.md b/docs/github_actions.md
@@ -29,6 +29,12 @@ This workflow handles the building, testing, and validation of the Tornado-SVM c
 - Uses the latest Rust toolchain for Solana program development
 - Uses Solana CLI tools for program building and testing
 
+**Solana Environment Setup:**
+- The workflow automatically installs the Solana CLI tools version 1.16.0
+- Adds the Solana binary path to GitHub's PATH environment variable
+- Ensures each step that requires Solana commands has the proper PATH setting
+- Provides enhanced error reporting when Solana tools are not found
+
 ### Tornado Testnet Transaction Test
 
 **File:** `.github/workflows/tornado_testnet_transaction.yml`
@@ -114,3 +120,43 @@ The workflow uses several custom scripts for capturing and analyzing metrics, ex
 - `format_report.js`: Formats metrics into a readable report
 
 Developers can modify these scripts to capture additional metrics or change how they're presented in the report.
+
+## Troubleshooting
+
+### Common Issues
+
+#### Solana CLI Not Found
+
+If your workflow fails with the error `solana: command not found`, check the following:
+
+1. **Verify installation:** Make sure the Solana CLI installation step completed successfully in the logs
+
+2. **Check PATH configuration:** Each step that uses Solana commands should include:
+   ```bash
+   export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"
+   ```
+
+3. **Installation log:** Look for output from the Solana installation command:
+   ```
+   sh -c "$(curl -sSfL https://release.solana.com/v1.16.0/install)"
+   ```
+
+4. **Enhanced diagnostics:** The `run_tornado_transaction.sh` script now includes enhanced diagnostics when Solana is not found, including checking common installation locations
+
+5. **Fix:** If needed, you can pass the `SOLANA_PATH` environment variable to the script execution step
+
+#### Solana Build Command Not Found
+
+If you encounter issues with Solana build commands (either `cargo build-bpf` or `cargo build-sbf`), check that:
+
+1. The workflow tries both the newer `build-sbf` and older `build-bpf` commands
+2. The Rust toolchain is properly installed
+3. Solana build tools are in the PATH
+
+#### Transaction Failures
+
+If transactions on testnet fail, common causes include:
+
+1. **Airdrop limits:** Testnet has airdrop limits; check if the airdrop succeeded
+2. **Testnet stability:** Testnet can occasionally be unstable; try re-running the workflow
+3. **RPC errors:** If using a custom RPC URL, verify it's working correctly
diff --git a/scripts/run_tornado_transaction.sh b/scripts/run_tornado_transaction.sh
@@ -1,6 +1,12 @@
 #!/bin/bash
 set -e
 
+# If SOLANA_PATH is set, add it to PATH
+if [ -n "$SOLANA_PATH" ]; then
+    echo "Adding Solana binaries to PATH: $SOLANA_PATH"
+    export PATH="$SOLANA_PATH:$PATH"
+fi
+
 # Colors for output
 GREEN='\033[0;32m'
 YELLOW='\033[1;33m'
@@ -9,12 +15,25 @@ NC='\033[0m' # No Color
 
 echo -e "${GREEN}Starting Tornado Cash Privacy Solution Transaction Script${NC}"
 
-# Check if solana is installed
+# Check if solana is installed and print more debugging information if not found
 if ! command -v solana &> /dev/null; then
-    echo "Error: Solana CLI is not installed. Please install it first."
+    echo "Error: Solana CLI is not installed or not in PATH."
+    echo "Current PATH: $PATH"
+    echo "Please install Solana CLI or ensure it's in your PATH."
+    
+    # Check for common Solana CLI locations
+    for dir in "$HOME/.local/share/solana/install/active_release/bin" "/usr/local/bin" "/usr/bin"; do
+        if [ -f "$dir/solana" ]; then
+            echo "Found solana in $dir but it's not in PATH. Try adding: export PATH=\"$dir:\$PATH\""
+        fi
+    done
+    
     exit 1
 fi
 
+# Print Solana version for debugging
+echo "Using Solana version: $(solana --version)"
+
 # Check if the tornado-cli.js exists
 if [ ! -f "../client/tornado-cli.js" ]; then
     echo "Error: tornado-cli.js not found. Make sure you're running this script from the scripts directory."
@@ -56,14 +75,30 @@ cd ../scripts
 echo -e "${YELLOW}Step 3: Building and deploying the program...${NC}"
 cd ..
 echo "Building the program..."
+
+# Print Rust and cargo info for debugging
+echo "Rust version: $(rustc --version)"
+echo "Cargo version: $(cargo --version)"
+
+# Check for Solana BPF tools
+echo "Checking for Solana BPF/SBF tools..."
+for cmd in "cargo build-sbf" "cargo build-bpf"; do
+    if command -v $cmd &> /dev/null; then
+        echo "Found $cmd"
+    fi
+done
+
 # Try the newer cargo build-sbf command first, fall back to cargo build-bpf if not available
 if command -v cargo build-sbf &> /dev/null; then
+    echo "Using cargo build-sbf..."
     cargo build-sbf || { echo -e "${RED}Error: Failed to build the program.${NC}"; exit 1; }
 else
+    echo "Using cargo build-bpf..."
     cargo build-bpf || { echo -e "${RED}Error: Failed to build the program.${NC}"; exit 1; }
 fi
 
 echo "Deploying the program..."
+echo "Using solana from: $(which solana)"
 DEPLOY_OUTPUT=$(solana program deploy target/deploy/tornado_svm.so)
 PROGRAM_ID=$(echo "$DEPLOY_OUTPUT" | grep "Program Id:" | awk '{print $3}')
 
@@ -224,4 +259,4 @@ echo "Recipient balance: $RECIPIENT_BALANCE SOL"
 echo -e "${YELLOW}Cleaning up...${NC}"
 echo "No cleanup needed for testnet"
 
-echo -e "${GREEN}Script completed!${NC}"
+echo -e "${GREEN}Script completed!${NC}"
