https://github.com/zhiburt/expectrl

A rust library for controlling interactive programs in a pseudo-terminal
https://github.com/zhiburt/expectrl

console expect hacktoberfest pexpect process processes pty rexpect rust terminal tty unix

Last synced: about 2 months ago
JSON representation

A rust library for controlling interactive programs in a pseudo-terminal

• Host: GitHub
• URL: https://github.com/zhiburt/expectrl
• Owner: zhiburt
• License: mit
• Created: 2021-06-25T17:21:43.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-03T22:30:33.000Z (4 months ago)
• Last Synced: 2024-04-03T20:09:58.553Z (3 months ago)
• Topics: console, expect, hacktoberfest, pexpect, process, processes, pty, rexpect, rust, terminal, tty, unix
• Language: Rust
• Homepage:
• Size: 698 KB
• Stars: 160
• Watchers: 4
• Forks: 13
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-rust - zhiburt/expectrl - terminal [](https://github.com/zhiburt/expectrl/actions/workflows/ci.yml) (Libraries / Command-line)
• awesome-stars - zhiburt/expectrl - A rust library for controlling interactive programs in a pseudo-terminal (Rust)
• awesome-rust-cn - zhiburt/expectrl

README

        
[![Build](https://github.com/zhiburt/expectrl/actions/workflows/ci.yml/badge.svg)](https://github.com/zhiburt/expectrl/actions/workflows/ci.yml)

[![coverage status](https://coveralls.io/repos/github/zhiburt/expectrl/badge.svg?branch=main)](https://coveralls.io/github/zhiburt/expectrl?branch=main)

[![crate](https://img.shields.io/crates/v/expectrl)](https://crates.io/crates/expectrl)

[![docs.rs](https://img.shields.io/docsrs/expectrl?color=blue)](https://docs.rs/expectrl/*/expectrl/)

# expectrl

Expectrl is a tool for automating terminal applications.

Expectrl is a rust module for spawning child applications and controlling them and responding to expected patterns in process's output. Expectrl works like Don Libes' Expect. Expectrl allows your script to spawn a child application and control it as if a human were typing commands.

Using the library you can:

- Spawn process

- Control process

- Interact with process's IO(input/output).

`expectrl` like original `expect` may shine when you're working with interactive applications.

If your application is not interactive you may not find the library the best choise.

## Usage

Add `expectrl` to your Cargo.toml.

```toml

# Cargo.toml

[dependencies]

expectrl = "0.7"

```

An example where the program simulates a used interacting with `ftp`.

```rust

use expectrl::{spawn, Regex, Eof, Error};

fn main() -> Result<(), Error> {

    let mut p = spawn("ftp speedtest.tele2.net")?;

    p.expect(Regex("Name \\(.*\\):"))?;

    p.send_line("anonymous")?;

    p.expect("Password")?;

    p.send_line("test")?;

    p.expect("ftp>")?;

    p.send_line("cd upload")?;

    p.expect("successfully changed.\r\nftp>")?;

    p.send_line("pwd")?;

    p.expect(Regex("[0-9]+ \"/upload\""))?;

    p.send_line("exit")?;

    p.expect(Eof)?;

    Ok(())

}

```

The same example but the password will be read from stdin.

```rust

use std::io::stdout;

use expectrl::{

    interact::{actions::lookup::Lookup, InteractOptions},

    spawn, stream::stdin::Stdin,

    ControlCode, Error, Regex,

};

fn main() -> Result<(), Error> {

    let mut auth = false;

    let mut login_lookup = Lookup::new();

    let opts = InteractOptions::new(&mut auth).on_output(|ctx| {

        if login_lookup

            .on(ctx.buf, ctx.eof, "Login successful")?

            .is_some()

        {

            **ctx.state = true;

            return Ok(true);

        }

        Ok(false)

    });

    let mut p = spawn("ftp bks4-speedtest-1.tele2.net")?;

    let mut stdin = Stdin::open()?;

    p.interact(&mut stdin, stdout()).spawn(opts)?;

    stdin.close()?;

    if !auth {

        println!("An authefication was not passed");

        return Ok(());

    }

    p.expect("ftp>")?;

    p.send_line("cd upload")?;

    p.expect("successfully changed.")?;

    p.send_line("pwd")?;

    p.expect(Regex("[0-9]+ \"/upload\""))?;

    p.send(ControlCode::EndOfTransmission)?;

    p.expect("Goodbye.")?;

    Ok(())

}

```

#### [For more examples, check the examples directory.](https://github.com/zhiburt/expectrl/tree/main/examples)

## Features

- It has an `async` support (To enable them you must turn on an `async` feature).

- It supports logging.

- It supports interact function.

- It works on windows.

## Notes

It was originally inspired by [philippkeller/rexpect] and [pexpect].

Licensed under [MIT License](LICENSE)

[philippkeller/rexpect]: https://github.com/philippkeller/rexpect

[pexpect]: https://pexpect.readthedocs.io/en/stable/overview.html