fix(tests): ensure e2e tests use updated plugins (#1047)

* launch zellij with --data-dir flag in e2e tests, to avoid using prebuilt plugins from assets dir, and instead use the ones from the docker mount. * make the tests use plugins built in release mode to avoid some test failures due to timing issues. * format Makefile.toml. * set uid 1001 to in e2e action (thanks to https://github.com/francisfuzz/actions-uid-gid)
2024-12-23 09:11:40 +03:00 · 2022-02-27 22:05:37 +01:00 · 2022-02-27 22:05:37 +01:00 · 3765aa3483
commit 3765aa3483
parent 90d9cbe90b
3 changed files with 94 additions and 28 deletions
--- a/.github/workflows/e2e.yml
+++ b/.github/workflows/e2e.yml
@ -18,7 +18,7 @@ jobs:
      ssh:
        image: ghcr.io/linuxserver/openssh-server
        env:
-          PUID: 1000
+          PUID: 1001
          PGID: 1000
          TZ: Europe/Vienna
          PASSWORD_ACCESS: true
--- a/Makefile.toml
+++ b/Makefile.toml
@ -9,13 +9,13 @@ ZELLIJ_ASSETS_DIR = "${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/zellij-utils/asse
 # Add clippy to the default flow
 [tasks.dev-test-flow]
 dependencies = [
-  "format-flow",
-  "format-toml-conditioned-flow",
-  "pre-build",
-  "build",
-  "post-build",
-  "test-flow",
-  "clippy",
+    "format-flow",
+    "format-toml-conditioned-flow",
+    "pre-build",
+    "build",
+    "post-build",
+    "test-flow",
+    "clippy",
 ]

 # Patching the default flows to skip testing of wasm32-wasi targets
@ -63,9 +63,32 @@ end
 writefile ${data_dir}/VERSION ${CARGO_MAKE_CRATE_VERSION}
 '''

+[tasks.build-e2e-data-dir]
+dependencies = ["build-plugins-release"]
+script_runner = "@duckscript"
+script = '''
+target_dir = set ${CARGO_TARGET_DIR}
+data_dir = set ${target_dir}/e2e-data
+rm -r ${data_dir}
+plugins = glob_array ${target_dir}/wasm32-wasi/release/*.wasm
+mkdir ${data_dir}
+mkdir ${data_dir}/plugins
+for plugin in ${plugins}
+    plugin_name = basename ${plugin}
+    cp ${plugin} ${data_dir}/plugins/${plugin_name}
+end
+writefile ${data_dir}/VERSION ${CARGO_MAKE_CRATE_VERSION}
+'''
+
 [tasks.launch]
 command = "cargo"
-args = ["run", "--", "--data-dir", "${CARGO_TARGET_DIR}/dev-data/", "@@split(CARGO_MAKE_TASK_ARGS,;)"]
+args = [
+    "run",
+    "--",
+    "--data-dir",
+    "${CARGO_TARGET_DIR}/dev-data/",
+    "@@split(CARGO_MAKE_TASK_ARGS,;)",
+]

 # Simple clippy tweak
 [tasks.clippy]
@ -85,11 +108,19 @@ end
 '''

 [tasks.build-plugins-release]
-env = { "CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS" = ["default-plugins/status-bar", "default-plugins/strider", "default-plugins/tab-bar"] }
+env = { "CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS" = [
+    "default-plugins/status-bar",
+    "default-plugins/strider",
+    "default-plugins/tab-bar",
+] }
 run_task = { name = "build-release", fork = true }

 [tasks.build-plugins]
-env = { "CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS" = ["default-plugins/status-bar", "default-plugins/strider", "default-plugins/tab-bar"] }
+env = { "CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS" = [
+    "default-plugins/status-bar",
+    "default-plugins/strider",
+    "default-plugins/tab-bar",
+] }
 run_task = { name = "build", fork = true }

 [tasks.wasm-opt-plugins]
@ -135,23 +166,48 @@ cp ${ZELLIJ_ASSETS_DIR}/config/default.yaml ${ZELLIJ_EXAMPLE_DIR}/default.yaml
 # CI Releasing Zellij
 [tasks.ci-build-release]
 workspace = false
-dependencies = ["setup-cross-compilation", "build-plugins-release", "wasm-opt-plugins", "manpage"]
+dependencies = [
+    "setup-cross-compilation",
+    "build-plugins-release",
+    "wasm-opt-plugins",
+    "manpage",
+]
 command = "cross"
-args = ["build", "--verbose", "--release", "--target", "${CARGO_MAKE_TASK_ARGS}"]
+args = [
+    "build",
+    "--verbose",
+    "--release",
+    "--target",
+    "${CARGO_MAKE_TASK_ARGS}",
+]

 # Build e2e asset
 [tasks.build-e2e]
 workspace = false
-dependencies = ["build-plugins", "build-dev-data-dir"]
+dependencies = ["build-plugins-release", "build-e2e-data-dir"]
 command = "cargo"
-args = ["build", "--verbose", "--release", "--target", "x86_64-unknown-linux-musl"]
+args = [
+    "build",
+    "--verbose",
+    "--release",
+    "--target",
+    "x86_64-unknown-linux-musl",
+]

 # Run e2e tests - we mark the e2e tests as "ignored" so they will not be run with the normal ones
 [tasks.e2e-test]
 workspace = false
 dependencies = ["build-e2e"]
 command = "cargo"
-args = ["test", "--", "--ignored", "--nocapture", "--test-threads", "1", "@@split(CARGO_MAKE_TASK_ARGS,;)"]
+args = [
+    "test",
+    "--",
+    "--ignored",
+    "--nocapture",
+    "--test-threads",
+    "1",
+    "@@split(CARGO_MAKE_TASK_ARGS,;)",
+]

 [tasks.setup-cross-compilation]
 command = "cargo"
@ -161,7 +217,12 @@ args = ["install", "cross"]
 [tasks.publish]
 clear = true
 workspace = false
-dependencies = [ "update-default-config", "build-plugins-release", "wasm-opt-plugins", "release-commit"]
+dependencies = [
+    "update-default-config",
+    "build-plugins-release",
+    "wasm-opt-plugins",
+    "release-commit",
+]
 run_task = "publish-zellij"

 [tasks.release-commit]
@ -207,6 +268,10 @@ cwd = "zellij-tile-utils"
 script = "cargo publish && sleep 15"

 [tasks.publish-zellij]
-dependencies = ["publish-zellij-client", "publish-zellij-server", "publish-zellij-utils",]
+dependencies = [
+    "publish-zellij-client",
+    "publish-zellij-server",
+    "publish-zellij-utils",
+]
 command = "cargo"
 args = ["publish"]
--- a/src/tests/e2e/remote_runner.rs
+++ b/src/tests/e2e/remote_runner.rs
@ -17,6 +17,7 @@ use std::rc::Rc;

 const ZELLIJ_EXECUTABLE_LOCATION: &str = "/usr/src/zellij/x86_64-unknown-linux-musl/release/zellij";
 const ZELLIJ_LAYOUT_PATH: &str = "/usr/src/zellij/fixtures/layouts";
+const ZELLIJ_DATA_DIR: &str = "/usr/src/zellij/e2e-data";
 const CONNECTION_STRING: &str = "127.0.0.1:2222";
 const CONNECTION_USERNAME: &str = "test";
 const CONNECTION_PASSWORD: &str = "test";
@ -62,8 +63,8 @@ fn start_zellij(channel: &mut ssh2::Channel) {
    channel
        .write_all(
            format!(
-                "{} --session {}\n",
-                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME
+                "{} --session {} --data-dir {}\n",
+                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME, ZELLIJ_DATA_DIR
            )
            .as_bytes(),
        )
@ -76,8 +77,8 @@ fn start_zellij_mirrored_session(channel: &mut ssh2::Channel) {
    channel
        .write_all(
            format!(
-                "{} --session {} options --mirror-session true\n",
-                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME
+                "{} --session {} --data-dir {} options --mirror-session true\n",
+                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME, ZELLIJ_DATA_DIR
            )
            .as_bytes(),
        )
@ -90,8 +91,8 @@ fn start_zellij_in_session(channel: &mut ssh2::Channel, session_name: &str, mirr
    channel
        .write_all(
            format!(
-                "{} --session {} options --mirror-session {}\n",
-                ZELLIJ_EXECUTABLE_LOCATION, session_name, mirrored
+                "{} --session {} --data-dir {} options --mirror-session {}\n",
+                ZELLIJ_EXECUTABLE_LOCATION, session_name, ZELLIJ_DATA_DIR, mirrored
            )
            .as_bytes(),
        )
@ -111,8 +112,8 @@ fn start_zellij_without_frames(channel: &mut ssh2::Channel) {
    channel
        .write_all(
            format!(
-                "{} --session {} options --no-pane-frames\n",
-                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME
+                "{} --session {} --data-dir {} options --no-pane-frames\n",
+                ZELLIJ_EXECUTABLE_LOCATION, SESSION_NAME, ZELLIJ_DATA_DIR
            )
            .as_bytes(),
        )
@ -125,8 +126,8 @@ fn start_zellij_with_layout(channel: &mut ssh2::Channel, layout_path: &str) {
    channel
        .write_all(
            format!(
-                "{} --layout-path {} --session {}\n",
-                ZELLIJ_EXECUTABLE_LOCATION, layout_path, SESSION_NAME
+                "{} --layout-path {} --session {} --data-dir {}\n",
+                ZELLIJ_EXECUTABLE_LOCATION, layout_path, SESSION_NAME, ZELLIJ_DATA_DIR
            )
            .as_bytes(),
        )