feat(cli): add surfpool config and integration (#3)

* wip

* refactor: Simplify Surfpool configuration and enhance validator argument handling

- Removed the SurfpoolConfig struct and related logic, simplifying the ValidatorType enum.
- Updated the command processing to accept additional arguments for the validator.
- Adjusted the localnet and test functions to handle Surfpool and Solana validators more effectively.
- Improved logging management for Surfpool validator.

* feat(cli): Enhance argument handling for Surfpool validator

- Added support for additional arguments to be passed to the test runner and validator.
- Updated command definitions to include `--args` and `--validator-args` options.
- Improved handling of validator arguments in the `test` and `localnet` functions.
- Ensured proper routing of arguments to Surfpool when no explicit validator arguments are provided.

* refactor(cli): Update ValidatorType enum and streamline argument handling

* feat(cli): Introduce Surfpool configuration with validator integration

* feat(cli): enable tui startup to localnet and fix some typos

* feat(cli):  add runbooks startup check to wait for the deployment of the program then run the tests against the local environment

* chore: remove debug print

* refactor(cli): change flags to be compatible with surfpool cli, add the runbooks serialization struct to make a more robust verification when waiting for runbooks

* fix(cli): Improve runbook execution handling to consider failures as completed

* clean up runbook execution checking logic

* augment surfpool config fields

* remove `SURFPOOL_RPC_URL` const

* `remote_rpc_url` -> `datasource_rpc_url`

* use `DEFAULT_RPC_PORT` const

* fix surfpool command

* add/use workflow to install surfpool

* specify surfpool cli version for CI

* disable surfpool logs by default; allow configuring in anchor.toml

* add timeout_minutes to setup surfpool

* clean up action

* allow too many arguments for localnet fn

* bump surfpool version for CI

* start surfpool instead of validator in ci

* update run-test.sh

* fix setup-surfpool cache

* add `.surfpool` folder to gitignore for `anchor init`

* fix: apply `--offline` flag by default for surfpool

* only print message about surfpool logs if logs created

* feat: add block production mode to Surfpool configuration

* bump surfpool versions in CI

* feat: add block production mode to surfpool config for ido-pool test

* feat: add sleep functionality to log tests for improved reliability

* fix: update program log messages to use dynamic identifiers for better clarity

* fix: skip mut error test until LiteSVM issue is resolved

* fix: update surfpool CLI version to 0.11.2 in workflow files

* fix: refactor testValidateAssociatedToken calls to use confirmed commitment

* fix: add surfpool block production mode configuration for errors test

* fix: start surfpool in daemon mode for client/example test

* fix: add block production mode configuration for surfpool for misc

* lint

* fix: add setup step for surfpool in reusable tests workflow

* add sleep in run-test.sh to execute runbooks

* disable check_surfpool call in run-test.sh

---------

Co-authored-by: MicaiahReid <[email protected]>

Author: BretasArthur1

.github/actions/setup-surfpool/action.yaml

@@ -0,0 +1,24 @@
+name: "Setup Surfpool"
+description: "Installs and caches the Surfpool CLI"
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/cache@v3
+      name: Cache Surfpool Binary
+      id: cache-surfpool
+      with:
+        path: /usr/local/bin/surfpool
+        key: surfpool-${{ runner.os }}-v${{ env.SURFPOOL_CLI_VERSION }}
+
+    - uses: nick-fields/retry@v2
+      if: steps.cache-surfpool.outputs.cache-hit != 'true'
+      with:
+        retry_wait_seconds: 300
+        timeout_minutes: 2
+        max_attempts: 10
+        retry_on: error
+        shell: bash
+        command: |
+          echo "Installing Surfpool version ${{ env.SURFPOOL_CLI_VERSION }}"
+          curl -sL https://run.surfpool.run/ | sudo bash
+

.github/workflows/no-caching-tests.yaml

@@ -17,3 +17,4 @@ jobs:
       node_version: 20.18.0
       cargo_profile: release
       anchor_binary_name: anchor-binary-no-caching
+      surfpool_cli_version: 0.11.2

.github/workflows/reusable-tests.yaml

@@ -18,12 +18,16 @@ on:
       anchor_binary_name:
         required: true
         type: string
+      surfpool_cli_version:
+        required: true
+        type: string
 env:
   CACHE: ${{ inputs.cache }}
   SOLANA_CLI_VERSION: ${{ inputs.solana_cli_version }}
   NODE_VERSION: ${{ inputs.node_version }}
   CARGO_PROFILE: ${{ inputs.cargo_profile }}
   ANCHOR_BINARY_NAME: ${{ inputs.anchor_binary_name }}
+  SURFPOOL_CLI_VERSION: ${{ inputs.surfpool_cli_version }}
   CARGO_CACHE_PATH: |
     ~/.cargo/bin/
     ~/.cargo/registry/index/
@@ -111,6 +115,7 @@ jobs:
       - uses: ./.github/actions/setup/
       - uses: ./.github/actions/setup-solana/
       - uses: ./.github/actions/setup-ts/
+      - uses: ./.github/actions/setup-surfpool/
 
       - uses: actions/cache@v3
         if: ${{ env.CACHE != 'false' }}
@@ -236,6 +241,7 @@ jobs:
           path: client/example/target
           key: cargo-${{ runner.os }}-client/example-${{ env.ANCHOR_VERSION }}-${{ env.SOLANA_CLI_VERSION }}-${{ hashFiles('**/Cargo.lock') }}
       - uses: ./.github/actions/setup-solana/
+      - uses: ./.github/actions/setup-surfpool/
       - run: cd client/example && ./run-test.sh
       - uses: ./.github/actions/git-diff/
 
@@ -249,6 +255,7 @@ jobs:
       - uses: ./.github/actions/setup/
       - uses: ./.github/actions/setup-ts/
       - uses: ./.github/actions/setup-solana/
+      - uses: ./.github/actions/setup-surfpool/
 
       - uses: actions/cache@v3
         if: ${{ env.CACHE != 'false' }}
@@ -272,8 +279,8 @@ jobs:
           path: tests/bpf-upgradeable-state/target
           key: cargo-${{ runner.os }}-tests/bpf-upgradeable-state-${{ env.ANCHOR_VERSION }}-${{ env.SOLANA_CLI_VERSION }}-${{ hashFiles('**/Cargo.lock') }}
 
-      - run: solana-test-validator -r --quiet &
-        name: start validator
+      - run: surfpool start --ci --offline &
+        name: start surfpool
       - run: cd tests/bpf-upgradeable-state && yarn --frozen-lockfile
       - run: cd tests/bpf-upgradeable-state
       - run: cd tests/bpf-upgradeable-state && anchor build --skip-lint
@@ -346,6 +353,7 @@ jobs:
       - uses: ./.github/actions/setup/
       - uses: ./.github/actions/setup-ts/
       - uses: ./.github/actions/setup-solana/
+      - uses: ./.github/actions/setup-surfpool/
 
       - uses: actions/cache@v3
         if: ${{ env.CACHE != 'false' }}
@@ -467,6 +475,7 @@ jobs:
       - uses: ./.github/actions/setup/
       - uses: ./.github/actions/setup-ts/
       - uses: ./.github/actions/setup-solana/
+      - uses: ./.github/actions/setup-surfpool/
 
       - uses: actions/cache@v3
         if: ${{ env.CACHE != 'false' }}

.github/workflows/tests.yaml

@@ -22,3 +22,4 @@ jobs:
       node_version: 20.18.0
       cargo_profile: debug
       anchor_binary_name: anchor-binary
+      surfpool_cli_version: 0.11.2

Cargo.lock

@@ -39,6 +39,7 @@ shellexpand = "2.1.0"
 solana-cli-config = "2"
 solana-faucet = "2"
 solana-rpc-client = "2"
+solana-rpc-client-api = "2"
 solana-sdk = "2"
 syn = { version = "1.0.60", features = ["full", "extra-traits"] }
 tar = "0.4.35"

cli/Cargo.toml

@@ -25,6 +25,8 @@ use std::str::FromStr;
 use std::{fmt, io};
 use walkdir::WalkDir;
 
+pub const SURFPOOL_HOST: &str = "127.0.0.1";
+
 pub trait Merge: Sized {
     fn merge(&mut self, _other: Self) {}
 }
@@ -295,10 +297,19 @@ pub struct Config {
     // Separate entry next to test_config because
     // "anchor localnet" only has access to the Anchor.toml,
     // not the Test.toml files
+    pub validator: Option<ValidatorType>,
     pub test_validator: Option<TestValidator>,
     pub test_config: Option<TestConfig>,
+    pub surfpool_config: Option<SurfpoolConfig>,
 }
 
+#[derive(ValueEnum, Parser, Clone, Copy, PartialEq, Eq, Debug)]
+pub enum ValidatorType {
+    /// Use Surfpool validator (default)
+    Surfpool,
+    /// Use Solana test validator
+    Legacy,
+}
 #[derive(Default, Clone, Debug, Serialize, Deserialize)]
 pub struct ToolchainConfig {
     pub anchor_version: Option<String>,
@@ -405,6 +416,7 @@ pub enum ProgramArch {
     Bpf,
     Sbf,
 }
+
 impl ProgramArch {
     pub fn build_subcommand(&self) -> &str {
         match self {
@@ -513,6 +525,7 @@ struct _Config {
     workspace: Option<WorkspaceConfig>,
     scripts: Option<ScriptsConfig>,
     test: Option<_TestValidator>,
+    surfpool: Option<_SurfpoolConfig>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
@@ -613,6 +626,7 @@ impl fmt::Display for Config {
             programs,
             workspace: (!self.workspace.members.is_empty() || !self.workspace.exclude.is_empty())
                 .then(|| self.workspace.clone()),
+            surfpool: self.surfpool_config.clone().map(Into::into),
         };
 
         let cfg = toml::to_string(&cfg).expect("Must be well formed");
@@ -635,10 +649,12 @@ impl FromStr for Config {
                 wallet: shellexpand::tilde(&cfg.provider.wallet).parse()?,
             },
             scripts: cfg.scripts.unwrap_or_default(),
+            validator: None, // Will be set based on CLI flags
             test_validator: cfg.test.map(Into::into),
             test_config: None,
             programs: cfg.programs.map_or(Ok(BTreeMap::new()), deser_programs)?,
             workspace: cfg.workspace.unwrap_or_default(),
+            surfpool_config: cfg.surfpool.map(Into::into),
         })
     }
 }
@@ -723,6 +739,23 @@ pub struct TestValidator {
     pub upgradeable: bool,
 }
 
+#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+pub struct SurfpoolConfig {
+    pub startup_wait: i32,
+    pub shutdown_wait: i32,
+    pub rpc_port: u16,
+    pub ws_port: Option<u16>,
+    pub host: String,
+    pub online: Option<bool>,
+    pub datasource_rpc_url: Option<String>,
+    pub airdrop_addresses: Option<Vec<String>>,
+    pub manifest_file_path: Option<String>,
+    pub runbooks: Option<Vec<String>>,
+    pub slot_time: Option<u16>,
+    pub log_level: Option<String>,
+    pub block_production_mode: Option<String>,
+}
+
 #[derive(Default, Debug, Clone, Serialize, Deserialize)]
 pub struct _TestValidator {
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -737,6 +770,75 @@ pub struct _TestValidator {
     pub upgradeable: Option<bool>,
 }
 
+#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+pub struct _SurfpoolConfig {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub startup_wait: Option<i32>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub shutdown_wait: Option<i32>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub rpc_port: Option<u16>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ws_port: Option<u16>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub host: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub online: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub datasource_rpc_url: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub airdrop_addresses: Option<Vec<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub manifest_file_path: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub runbooks: Option<Vec<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub slot_time: Option<u16>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub log_level: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub block_production_mode: Option<String>,
+}
+
+impl From<_SurfpoolConfig> for SurfpoolConfig {
+    fn from(_surfpool_config: _SurfpoolConfig) -> Self {
+        Self {
+            startup_wait: _surfpool_config.startup_wait.unwrap_or(STARTUP_WAIT),
+            shutdown_wait: _surfpool_config.shutdown_wait.unwrap_or(SHUTDOWN_WAIT),
+            rpc_port: _surfpool_config.rpc_port.unwrap_or(DEFAULT_RPC_PORT),
+            host: _surfpool_config.host.unwrap_or(SURFPOOL_HOST.to_string()),
+            ws_port: _surfpool_config.ws_port,
+            online: _surfpool_config.online,
+            datasource_rpc_url: _surfpool_config.datasource_rpc_url,
+            airdrop_addresses: _surfpool_config.airdrop_addresses,
+            manifest_file_path: _surfpool_config.manifest_file_path,
+            runbooks: _surfpool_config.runbooks,
+            slot_time: _surfpool_config.slot_time,
+            log_level: _surfpool_config.log_level,
+            block_production_mode: _surfpool_config.block_production_mode,
+        }
+    }
+}
+
+impl From<SurfpoolConfig> for _SurfpoolConfig {
+    fn from(surfpool_config: SurfpoolConfig) -> Self {
+        Self {
+            startup_wait: Some(surfpool_config.startup_wait),
+            shutdown_wait: Some(surfpool_config.shutdown_wait),
+            rpc_port: Some(surfpool_config.rpc_port),
+            ws_port: surfpool_config.ws_port,
+            host: Some(surfpool_config.host),
+            online: surfpool_config.online,
+            datasource_rpc_url: surfpool_config.datasource_rpc_url,
+            airdrop_addresses: surfpool_config.airdrop_addresses,
+            manifest_file_path: surfpool_config.manifest_file_path,
+            runbooks: surfpool_config.runbooks,
+            slot_time: surfpool_config.slot_time,
+            log_level: surfpool_config.log_level,
+            block_production_mode: surfpool_config.block_production_mode,
+        }
+    }
+}
 pub const STARTUP_WAIT: i32 = 5000;
 pub const SHUTDOWN_WAIT: i32 = 2000;
 
@@ -1354,6 +1456,23 @@ impl AnchorPackage {
     }
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SurfnetInfoResponse {
+    pub runbook_executions: Vec<RunbookExecution>,
+}
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RunbookExecution {
+    #[serde(rename = "startedAt")]
+    pub started_at: u32,
+    #[serde(rename = "completedAt")]
+    pub completed_at: Option<u32>,
+    #[serde(rename = "runbookId")]
+    pub runbook_id: String,
+    pub errors: Option<Vec<String>>,
+}
+
 #[macro_export]
 macro_rules! home_path {
     ($my_struct:ident, $path:literal) => {