https://github.com/st4s1k/scenario-rs

Rust SSH automation tool
https://github.com/st4s1k/scenario-rs
angular automation cicd rust ssh tauri
Last synced: 3 months ago
JSON representation
Rust SSH automation tool
Host: GitHub
URL: https://github.com/st4s1k/scenario-rs
Owner: st4s1k
License: other
Created: 2024-08-14T01:07:16.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2025-05-16T20:40:08.000Z (about 1 year ago)
Last Synced: 2025-05-16T21:24:36.637Z (about 1 year ago)
Topics: angular, automation, cicd, rust, ssh, tauri
Language: Rust
Homepage:
Size: 26.1 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          # scenario-rs

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) or [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Publish

Rust Coverage

Angular Coverage

A powerful automation tool for executing remote commands and transferring files via SSH. It uses configuration files to define execution scenarios, making system administration and deployment tasks repeatable and reliable.

## Features

- **Scenario Configuration**: Define your tasks in TOML files with inheritance support

- **Remote Command Execution**: Run commands on remote servers with sudo support

- **File Transfer**: Copy files to remote servers via SFTP

- **Variable Substitution**: Use variables in your commands and file paths

- **Error Recovery**: Define fallback tasks to execute when operations fail

- **Path Handling**: Special handling for file paths with automatic basename extraction

- **Progress Tracking**: Monitor execution progress with detailed feedback

- **GUI, TUI & CLI Interfaces**: Choose between a graphical interface, terminal UI, or command-line tool

## Usage

### Configuration Files

Scenario configurations are defined in TOML files:

```toml

# Basic structure for a scenario configuration

[credentials]

username = "your-username" # will be added to the variables

password = "your-password" # optional, will use SSH agent if not provided

[server]

host = "your-server.example.com" # required

port = "22" # optional, default is 22

[execute]

# Define the execution order of tasks

steps = [

  { task = "deploy_app" },

  { task = "extract_app" },

  { task = "copy_config", on-fail = ["rollback_deployment"] }  # With error recovery

]

# Variables that must be provided by the user

[variables.required]

app_archive = { type = "Path", label = "Application Archive" }

deployment_env = { type = "String", label = "Environment" }

timestamp = { type = "Timestamp", label = "Deployment Time", format = "%Y-%m-%dT%H%M%S%:z", read_only = true }

# Define variables to be used in commands and file paths

[variables.defined]

app_name = "myapp"

app_version = "1.0.0"

remote_app_path = "/opt/{app_name}"

# Define tasks that can be referenced in execution steps

[tasks.deploy_app]

type = "RemoteSudo"

description = "Deploy application"

command = "mkdir -p {remote_app_path} && cp /tmp/{basename:app_archive} {remote_app_path}/"

error_message = "Failed to deploy application"

[tasks.extract_app]

type = "RemoteSudo"

description = "Extract application archive"

command = "tar -xzf {remote_app_path}/{basename:app_archive} -C {remote_app_path}"

error_message = "Failed to extract application"

[tasks.copy_config]

type = "SftpCopy"

description = "Copy configuration file"

source_path = "config/{deployment_env}.conf"

destination_path = "{remote_app_path}/config.conf"

error_message = "Failed to copy configuration"

[tasks.rollback_deployment]

type = "RemoteSudo"

description = "Rollback failed deployment"

command = "rm -rf {remote_app_path}/*"

error_message = "Failed to rollback deployment"

```

### Variable Types

The application supports different variable types:

- **String**: Regular text input

- **Path**: File path with special handling (automatically extracts basename)

- **Timestamp**: Automatically generated timestamp with specified format

### Inheritance

You can split your configuration across multiple files and use inheritance:

#### Parent file (base.toml)

```toml

[credentials]

username = "default-user"

[server]

host = "default-host"

port = "22"

[variables.required]

timestamp = { type = "Timestamp", label = "Deployment Time", format = "%Y-%m-%d", read_only = true }

[variables.defined]

app_name = "default-app"

```

#### Child file (specific.toml)

```toml

parent = "base.toml"  # Will inherit and override from parent

[credentials]

username = "specific-user"

[variables.required]

env_name = { type = "String", label = "Environment Name" }

[variables.defined]

app_version = "1.0.0"  # Adds new variable while keeping app_name from parent

```

## GUI

The GUI provides a modern Tauri-based interface for managing and executing scenarios:

### Features

- **Configuration Management**: Load, validate, and execute scenario configurations

- **Variable Management**: Set and update required variables with type-specific controls

- **Real-time Execution**: Monitor scenario execution with step-by-step progress

- **State Persistence**: Save and restore application state between sessions

- **Task & Step Visualization**: Visual representation of scenario tasks and steps

- **Detailed Logging**: View detailed execution logs with filtering options

- **Variable Resolution**: See how variables are resolved during execution

### Interface Components

- **Configuration Loader**: Open dialog for selecting TOML configuration files

- **Variable Editor**: Type-appropriate input fields for required variables

- **Execution Panel**: Control execution and view real-time progress

- **Log Viewer**: Structured view of execution events and messages

- **Task Explorer**: Hierarchical view of tasks and their relationships

- **Variables Inspector**: View all defined and resolved variables

## TUI

The TUI provides an interactive terminal interface for selecting configs, filling in variables, and monitoring execution — no desktop environment required.

```

scenario-rs-tui [--config-path ]

```

### Features

- **File Browser**: Browse and select TOML configuration files interactively

- **Variable Form**: Fill in required variables with type-aware input (includes file picker for Path variables)

- **Live Execution View**: Monitor step-by-step progress with output and error details

- **Keyboard-Driven**: Fully navigable with keyboard shortcuts

### Keyboard Shortcuts

| Screen | Key | Action |

|---|---|---|

| File Browser | `↑/↓` | Navigate entries |

| File Browser | `Enter` | Open directory / confirm file |

| File Browser | `Backspace` | Go to parent directory |

| File Browser | `Esc` | Cancel |

| Variables | `Tab/↑/↓` | Navigate fields |

| Variables | `Ctrl+B` | Open file picker (Path fields) |

| Variables | `Ctrl+D` | Toggle debug mode |

| Variables | `Enter` | Start execution |

| Variables | `Esc` | Quit |

| Executing | `↑/↓` | Select step |

| Executing | `PgUp/PgDn` | Scroll output |

| Done | `q/Esc` | Quit |

| Done | `r` | Re-run same scenario |

| Done | `n` | Pick new scenario |

## CLI

For automation scripts or CI/CD pipelines, use the command-line interface:

```

scenario-rs-cli --config-path  [options]

```

### Command Line Arguments:

```

Usage: scenario-rs-cli [OPTIONS] --config-path 

Options:

  -c, --config-path                 Path to the TOML file containing the scenario configuration

  -l, --log-level                   Log level for the application [default: INFO]

  -r, --required-variables   Required variables in the format KEY=VALUE

  -h, --help                                   Print help

  -V, --version                                Print version

```

#### Examples

Basic execution:

```

scenario-rs-cli -c ./example_configs/example-scenario.toml

```

With required variables:

```

scenario-rs-cli -c ./example_configs/deploy-scenario.toml -r app_version=1.2.3 -r env=production

```

With custom log level:

```

scenario-rs-cli -c ./example_configs/example-scenario.toml -l debug

```

## GUI Demo

[![demo](demo/demo_video.mp4)](https://github.com/user-attachments/assets/035dcca9-293b-41ea-a6ec-bfb94d922e63)

## Screenshots

![screenshot](demo/screenshot_0.png)

  ❗click here to view more screenshots❗

  
Variables


  ![screenshot](demo/screenshot_1.png)

  
Tasks


  ![screenshot](demo/screenshot_2.png)

  
Steps


  ![screenshot](demo/screenshot_3.png)

  
Execution progress


  ![screenshot](demo/screenshot_4.png)

  ![screenshot](demo/screenshot_5.png)

## Build with just

All build tasks can be run from the project root using [just](https://github.com/casey/just).

### Setup

```

cargo install just

```

### Available Recipes

Run `just` to list all available recipes.

| Command | Description |

|---|---|

| `just` | List all available recipes |

| `just check` | Run `cargo check` on the workspace |

| `just build` | Build the workspace (debug) |

| `just build-release` | Build the workspace (release) |

| `just test` | Run Rust tests with coverage (requires [cargo-tarpaulin](https://github.com/xd009642/tarpaulin)) |

| `just ng-test` | Run Angular unit tests with coverage |

| `just test-all` | Run all tests with coverage (Rust + Angular) |

| `just npm-install` | Install frontend dependencies |

| `just ng-build` | Build Angular frontend |

| `just tui-run` | Run TUI in development mode |

| `just tui-build` | Build TUI (release) |

| `just tauri-dev` | Run GUI in development mode |

| `just tauri-build` | Build GUI (release) |

| `just tauri-build-debug` | Build GUI (debug) |

| `just build-all` | Build everything (Rust + GUI debug) |

| `just build-all-release` | Build everything (Rust + GUI release) |

| `just verify` | Full verification: check + all tests + Angular build |

| `just version` | Show current version |

| `just bump-version x.y.z` | Set version across all packages |

## DIY

### ✨ [gui]

❗ **go to:**

```

/scenario-rs/gui/

```

### ✨ [gui.dev] 🚧

▶️ **run:**

```

npm run tauri dev

```

🛠️ **build:**

```

npm run tauri build -- --debug

```

⚡ **run executable:**

```

/scenario-rs/target/debug/scenario-rs.exe

```

### ✨ [gui.release] 🎁

🛠️ **build:**

```

npm run tauri build

```

⚡ **run executable:**

```

/scenario-rs/target/release/scenario-rs.exe

```

### �️ [tui]

▶️ **run:**

```

cargo run -p scenario-rs-tui

```

or with a config:

```

cargo run -p scenario-rs-tui -- -c ./example_configs/example-scenario.toml

```

🛠️ **build (release):**

```

cargo build -p scenario-rs-tui --release

```

⚡ **run executable:**

```

/scenario-rs/target/release/scenario-rs-tui.exe

```

### �📟 [cli]

❗ **go to:**

```

/scenario-rs/cli

```

### 📟 [cli.dev] 🚧

▶️ **run:**

```

cargo run -- -c ./example_configs/example-scenario.toml

```

🛠️ **build:**

```

cargo build

```

⚡ **run executable:**

```

/scenario-rs/target/debug/scenario-rs-cli.exe --config-path ./example_configs/example-scenario.toml

```

or

```

/scenario-rs/target/debug/scenario-rs-cli.exe -c ./example_configs/example-scenario.toml

```

### 📟 [cli.release] 🎁

🛠️ **build:**

```

cargo build --release

```

⚡ **run executable:**

```

/scenario-rs/target/release/scenario-rs-cli.exe --config-path ./example_configs/example-scenario.toml

```

or

```

/scenario-rs/target/release/scenario-rs-cli.exe -c ./example_configs/example-scenario.toml

```
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/st4s1k/scenario-rs

Awesome Lists containing this project

README

Variables

Tasks

Steps

Execution progress
