ec2-cargo-fixes

Author: Lucas Kent

Cargo.lock

@@ -8,11 +8,13 @@ description = "A tool for running cargo commands in an EC2 instance"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow.workspace = true
 tokio.workspace = true
 clap.workspace = true
 tracing-subscriber.workspace = true
 aws-throwaway.workspace = true
 tracing-appender.workspace = true
-shellfish = { version = "0.10.0", features = ["async"] }
+serde.workspace = true
+serde_json.workspace = true
 cargo_metadata = "0.23.0"
 shell-quote.workspace = true

ec2-cargo/Cargo.toml

@@ -2,6 +2,8 @@
 
 ec2-cargo is a small tool for running shotover tests on an EC2 instance.
 
+Instance state is persisted to disk between invocations, so each command is a short-lived process that connects, does its work, and exits.
+
 ## AWS credentials
 
 Refer to the [aws-sdk docs](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/credentials.html) for full information on credentials.
@@ -24,22 +26,30 @@ Replace `TODO` with your credentials.
 
 Then invoke like `ec2-cargo.sh your-flags-here`
 
-## Running
-
-ec2-cargo has reasonable default configurations so you can just:
-
-* `cargo run` the project to use default credentials
-* `ec2-cargo.sh` to use specific env vars as described above.
-
-You can also specify the instance type e.g. `ec2-cargo.sh --instance-type c7g.2xlarge`
-
 ## Usage
 
-While the tool is running it will present you with a shell in which to enter commands.
-
-Some possible commands are:
+```bash
+# Create and provision an EC2 instance (one-time setup)
+# Before creating the new instance, any existing ec2 instances created by ec2-cargo will be destroyed
+cargo run -- create
+# Or,
+# cargo run -- create --instance-type c7g.2xlarge
+
+# Run tests (can be called repeatedly against the same instance)
+cargo run -- test my_test_name
+cargo run -- test --test-threads=1
+
+# Run windsock benchmarks
+cargo run -- windsock $args
+cargo run -- windsock-kafka $args
+cargo run -- windsock-cassandra $args
+cargo run -- windsock-valkey $args
+
+# Print SSH connection instructions
+cargo run -- ssh-instructions
+
+# Tear down all AWS resources and delete the persisted state
+cargo run -- cleanup
+```
 
-* `test $args` - Uploads shotover project source code and runs `cargo nextest run $args`
-* `ssh-instructions` - Print a bash snippet that can be used to ssh into the machine
-* `exit` - Exits the shell and terminates the EC2 instance.
-* `help` - Display all possible commands
+Or using the script setup: `ec2-cargo.sh create`, `ec2-cargo.sh test my_test_name`, etc.

ec2-cargo/readme.md

@@ -0,0 +1,60 @@
+use clap::{Parser, Subcommand};
+
+/// A tool for running cargo commands on an EC2 instance.
+///
+/// Create an instance with `create`, run commands against it with `test`/`windsock`/etc,
+/// and tear it down with `cleanup`. Instance state is persisted to disk between invocations.
+#[derive(Parser)]
+#[clap()]
+pub struct Args {
+    #[command(subcommand)]
+    pub command: Cmd,
+}
+
+#[derive(Subcommand)]
+pub enum Cmd {
+    /// Create and provision an EC2 instance, persisting node address+credentials to disk for other commands to use.
+    Create {
+        /// Specify the instance type to provision.
+        #[clap(long, default_value = "c7g.2xlarge")]
+        instance_type: String,
+    },
+
+    /// Upload changes and run `cargo nextest run <args>`.
+    Test {
+        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+        args: Vec<String>,
+    },
+
+    /// Upload changes and run `cargo windsock <args>`. Windsock results are downloaded to target/windsock_data.
+    Windsock {
+        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+        args: Vec<String>,
+    },
+
+    /// Upload changes and run `cargo windsock-kafka <args>`. Windsock results are downloaded to target/windsock_data.
+    WindsockKafka {
+        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+        args: Vec<String>,
+    },
+
+    /// Upload changes and run `cargo windsock-cassandra <args>`. Windsock results are downloaded to target/windsock_data.
+    WindsockCassandra {
+        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+        args: Vec<String>,
+    },
+
+    /// Upload changes and run `cargo windsock-valkey <args>`. Windsock results are downloaded to target/windsock_data.
+    WindsockValkey {
+        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+        args: Vec<String>,
+    },
+
+    /// Print a bash snippet that can be used to ssh into the machine.
+    SshInstructions,
+
+    /// Cleanup all AWS resources and delete the persisted state file.
+    /// This includes resources created by ec2-cargo and resources created by windsock, as they both use the same aws-throwaway library.
+    /// But note that windsock's cleanup logic avoids cleaning up ec2-cargo resources.
+    Cleanup,
+}