Add e2e tests (#582)

* feature(tests): e2e tests

* chore(build): github action

* chore(build): fix workflow

* chore(build): fix workflow

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* work

* working

* working

* working

* bring back the proper errors

* make e2e flow run properly

* style(fmt): make rustfmt happy

* style(fmt): make rustfmt happy

* run on everything just to test the workflow

* bring back running behaviour on workflow

17 files changed, 1351 insertions, 0 deletions

diff --git a/src/tests/e2e/cases.rs b/src/tests/e2e/cases.rs
new file mode 100644
index 000000000..5af67074c
--- /dev/null
+++ b/src/tests/e2e/cases.rs
@@ -0,0 +1,716 @@
+use ::insta::assert_snapshot;
+use zellij_utils::pane_size::PositionAndSize;
+
+use rand::Rng;
+
+use super::remote_runner::{RemoteRunner, RemoteTerminal, Step};
+use crate::tests::utils::commands::{
+    CLOSE_PANE_IN_PANE_MODE, DETACH_IN_SESSION_MODE, ENTER, LOCK_MODE, NEW_TAB_IN_TAB_MODE,
+    PANE_MODE, QUIT, RESIZE_LEFT_IN_RESIZE_MODE, RESIZE_MODE, SCROLL_MODE,
+    SCROLL_UP_IN_SCROLL_MODE, SESSION_MODE, SPLIT_RIGHT_IN_PANE_MODE, TAB_MODE,
+    TOGGLE_ACTIVE_TERMINAL_FULLSCREEN_IN_PANE_MODE,
+};
+
+// All the E2E tests are marked as "ignored" so that they can be run separately from the normal
+// tests
+
+#[test]
+#[ignore]
+pub fn starts_with_one_terminal() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("starts_with_one_terminal", fake_win_size, None)
+        .add_step(Step {
+            name: "Wait for app to load",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn split_terminals_vertically() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+
+    let last_snapshot = RemoteRunner::new("split_terminals_vertically", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for new pane to appear",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn cannot_split_terminals_vertically_when_active_terminal_is_too_small() {
+    let fake_win_size = PositionAndSize {
+        cols: 8,
+        rows: 20,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new(
+        "cannot_split_terminals_vertically_when_active_terminal_is_too_small",
+        fake_win_size,
+        None,
+    )
+    .add_step(Step {
+        name: "Split pane to the right",
+        instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+            let mut step_is_complete = false;
+            if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2) {
+                remote_terminal.send_key(&PANE_MODE);
+                remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                // back to normal mode after split
+                remote_terminal.send_key(&ENTER);
+                step_is_complete = true;
+            }
+            step_is_complete
+        },
+    })
+    .add_step(Step {
+        name: "Send text to terminal",
+        instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+            // this is just normal input that should be sent into the one terminal so that we can make
+            // sure we silently failed to split in the previous step
+            remote_terminal.send_key(&"Hi!".as_bytes());
+            true
+        },
+    })
+    .add_step(Step {
+        name: "Wait for text to appear",
+        instruction: |remote_terminal: RemoteTerminal| -> bool {
+            let mut step_is_complete = false;
+            if remote_terminal.cursor_position_is(5, 2) && remote_terminal.snapshot_contains("Hi!")
+            {
+                step_is_complete = true;
+            }
+            step_is_complete
+        },
+    })
+    .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn scrolling_inside_a_pane() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("scrolling_inside_a_pane", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Fill terminal with text",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    remote_terminal.send_key(&format!("{:0<57}", "line1 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line2 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line3 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line4 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line5 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line6 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line7 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line8 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line9 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line10 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line11 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line12 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line13 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line14 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line15 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line16 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line17 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line18 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<59}", "line19 ").as_bytes());
+                    remote_terminal.send_key(&format!("{:0<58}", "line20 ").as_bytes());
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Scroll up inside pane",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(119, 20) {
+                    // all lines have been written to the pane
+                    remote_terminal.send_key(&SCROLL_MODE);
+                    remote_terminal.send_key(&SCROLL_UP_IN_SCROLL_MODE);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for scroll to finish",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(119, 20)
+                    && remote_terminal.snapshot_contains("line1 ")
+                {
+                    // scrolled up one line
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn toggle_pane_fullscreen() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("toggle_pane_fullscreen", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Change newly opened pane to be fullscreen",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&TOGGLE_ACTIVE_TERMINAL_FULLSCREEN_IN_PANE_MODE);
+                    // back to normal mode after toggling fullscreen
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for pane to become fullscreen",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(2, 0) {
+                    // cursor is in full screen pane now
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn open_new_tab() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("open_new_tab", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Open new tab",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    remote_terminal.send_key(&TAB_MODE);
+                    remote_terminal.send_key(&NEW_TAB_IN_TAB_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for new tab to open",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(2, 2)
+                    && remote_terminal.tip_appears()
+                    && remote_terminal.snapshot_contains("Tab #2")
+                    && remote_terminal.status_bar_appears()
+                {
+                    // cursor is in the newly opened second tab
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn close_pane() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("close_pane", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Close pane",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&CLOSE_PANE_IN_PANE_MODE);
+                    // back to normal mode after close
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for pane to close",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(2, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the original pane
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn exit_zellij() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("exit_zellij", fake_win_size, None)
+        .add_step(Step {
+            name: "Wait for app to load",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&QUIT);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for app to exit",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if !remote_terminal.status_bar_appears()
+                    && remote_terminal.snapshot_contains("Bye from Zellij!")
+                {
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert!(last_snapshot.contains("Bye from Zellij!"));
+}
+
+#[test]
+#[ignore]
+pub fn closing_last_pane_exits_zellij() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("closing_last_pane_exits_zellij", fake_win_size, None)
+        .add_step(Step {
+            name: "Close pane",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&CLOSE_PANE_IN_PANE_MODE);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for app to exit",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.snapshot_contains("Bye from Zellij!") {
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert!(last_snapshot.contains("Bye from Zellij!"));
+}
+
+#[test]
+#[ignore]
+pub fn resize_pane() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("resize_pane", fake_win_size, None)
+        .add_step(Step {
+            name: "Split pane to the right",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&PANE_MODE);
+                    remote_terminal.send_key(&SPLIT_RIGHT_IN_PANE_MODE);
+                    // back to normal mode after split
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Resize pane",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(63, 2) && remote_terminal.tip_appears() {
+                    // cursor is in the newly opened second pane
+                    remote_terminal.send_key(&RESIZE_MODE);
+                    remote_terminal.send_key(&RESIZE_LEFT_IN_RESIZE_MODE);
+                    // back to normal mode after resizing
+                    remote_terminal.send_key(&ENTER);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for pane to be resized",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.cursor_position_is(53, 2) && remote_terminal.tip_appears() {
+                    // pane has been resized
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .run_all_steps();
+    assert_snapshot!(last_snapshot);
+}
+
+#[test]
+#[ignore]
+pub fn lock_mode() {
+    let fake_win_size = PositionAndSize {
+        cols: 120,
+        rows: 24,
+        x: 0,
+        y: 0,
+        ..Default::default()
+    };
+    let last_snapshot = RemoteRunner::new("lock_mode", fake_win_size, None)
+        .add_step(Step {
+            name: "Enter lock mode",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.status_bar_appears() && remote_terminal.cursor_position_is(2, 2)
+                {
+                    remote_terminal.send_key(&LOCK_MODE);
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Send keys that should not be intercepted by the app",
+            instruction: |mut remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_terminal.snapshot_contains("INTERFACE LOCKED") {
+                    remote_terminal.send_key(&TAB_MODE);
+                    remote_terminal.send_key(&NEW_TAB_IN_TAB_MODE);
+                    remote_terminal.send_key(&"abc".as_bytes());
+                    step_is_complete = true;
+                }
+                step_is_complete
+            },
+        })
+        .add_step(Step {
+            name: "Wait for terminal to render sent keys",
+            instruction: |remote_terminal: RemoteTerminal| -> bool {
+                let mut step_is_complete = false;
+                if remote_termin