lux_lib/operations/
test.rs

1use std::{io, ops::Deref, path::PathBuf, process::Command};
2
3use super::{
4    BuildWorkspace, BuildWorkspaceError, Install, InstallError, PackageInstallSpec, Sync, SyncError,
5};
6use crate::tree::InstallTree;
7use crate::workspace::{WorkspaceError, WorkspaceTreeError};
8use crate::{
9    build::BuildBehaviour,
10    config::{Config, ConfigError},
11    lua_installation::{LuaBinary, LuaBinaryError},
12    lua_rockspec::{LuaVersionError, TestSpecError, ValidatedTestSpec},
13    package::{PackageName, PackageVersionReqError},
14    path::{Paths, PathsError},
15    project::{project_toml::LocalProjectTomlValidationError, Project, ProjectError},
16    rockspec::Rockspec,
17    tree::{self, TreeError},
18    workspace::Workspace,
19};
20use bon::Builder;
21use itertools::Itertools;
22use miette::Diagnostic;
23use path_slash::PathBufExt;
24use thiserror::Error;
25
26#[cfg(target_family = "unix")]
27const BUSTED_EXE: &str = "busted";
28#[cfg(target_family = "windows")]
29const BUSTED_EXE: &str = "busted.bat";
30
31#[derive(Builder)]
32#[builder(start_fn = new, finish_fn(name = _run, vis = ""))]
33pub struct Test<'a> {
34    #[builder(start_fn)]
35    workspace: Workspace,
36    #[builder(start_fn)]
37    config: &'a Config,
38
39    #[builder(field)]
40    args: Vec<String>,
41
42    /// Package to run tests for
43    package: Option<PackageName>,
44
45    no_lock: Option<bool>,
46
47    #[builder(default)]
48    env: TestEnv,
49}
50
51impl<State: test_builder::State> TestBuilder<'_, State> {
52    pub fn arg(mut self, arg: impl Into<String>) -> Self {
53        self.args.push(arg.into());
54        self
55    }
56
57    pub fn args(mut self, args: impl IntoIterator<Item: Into<String>>) -> Self {
58        self.args.extend(args.into_iter().map_into());
59        self
60    }
61
62    pub async fn run(self) -> Result<(), RunTestsError>
63    where
64        State: test_builder::IsComplete,
65    {
66        run_tests(self._run()).await
67    }
68}
69
70#[derive(Default)]
71pub enum TestEnv {
72    /// An environment that is isolated from `HOME` and `XDG` base directories (default).
73    #[default]
74    Pure,
75    /// An impure environment in which `HOME` and `XDG` base directories can influence
76    /// the test results.
77    Impure,
78}
79
80#[derive(Error, Debug, Diagnostic)]
81pub enum RunTestsError {
82    #[error(transparent)]
83    #[diagnostic(transparent)]
84    Config(#[from] ConfigError),
85    #[error(transparent)]
86    #[diagnostic(transparent)]
87    InstallTestDependencies(#[from] InstallTestDependenciesError),
88    #[error("build failed")]
89    #[diagnostic(forward(0))]
90    BuildWorkspace(#[from] BuildWorkspaceError),
91    #[error("tests failed!")]
92    TestFailure,
93    #[error("failed to execute '{cmd}'")]
94    RunCommandFailure {
95        cmd: String,
96        source: io::Error,
97        #[help]
98        help: Option<String>,
99    },
100    #[error(transparent)]
101    Io(#[from] io::Error),
102    #[error(transparent)]
103    #[diagnostic(transparent)]
104    Project(#[from] ProjectError),
105    #[error(transparent)]
106    #[diagnostic(transparent)]
107    Paths(#[from] PathsError),
108    #[error(transparent)]
109    #[diagnostic(transparent)]
110    Workspace(#[from] WorkspaceError),
111    #[error(transparent)]
112    #[diagnostic(transparent)]
113    Tree(#[from] WorkspaceTreeError),
114    #[error(transparent)]
115    #[diagnostic(transparent)]
116    ProjectTomlValidation(#[from] LocalProjectTomlValidationError),
117    #[error("failed to sync dependencies")]
118    #[diagnostic(forward(0))]
119    Sync(#[from] SyncError),
120    #[error(transparent)]
121    #[diagnostic(transparent)]
122    TestSpec(#[from] TestSpecError),
123    #[error(transparent)]
124    #[diagnostic(transparent)]
125    LuaVersion(#[from] LuaVersionError),
126    #[error(transparent)]
127    #[diagnostic(transparent)]
128    LuaBinary(#[from] LuaBinaryError),
129}
130
131#[tracing::instrument(name = "🧪 Running tests", skip_all)]
132
133async fn run_tests(test: Test<'_>) -> Result<(), RunTestsError> {
134    let workspace = test.workspace;
135    let config = test.config;
136    let no_lock = test.no_lock.unwrap_or(false);
137
138    if let Some(package) = test.package {
139        let project = workspace.select_member(&package)?;
140        run_project_tests(&workspace, project, no_lock, &test.args, &test.env, config).await
141    } else {
142        for project in workspace.members() {
143            run_project_tests(&workspace, project, no_lock, &test.args, &test.env, config).await?;
144        }
145        Ok(())
146    }
147}
148
149async fn run_project_tests(
150    workspace: &Workspace,
151    project: &Project,
152    no_lock: bool,
153    test_args: &[String],
154    test_env: &TestEnv,
155    config: &Config,
156) -> Result<(), RunTestsError> {
157    let rocks = project.toml().into_local()?;
158    let test_spec = rocks.test().current_platform().to_validated(project)?;
159    let test_config = test_spec.test_config(config)?;
160
161    if no_lock {
162        let rockspec = project.toml().into_local()?;
163        ensure_test_dependencies(workspace, project, rockspec, &test_config).await?;
164    } else {
165        Sync::new(workspace, &test_config)
166            .sync_test_dependencies()
167            .await?;
168    }
169
170    BuildWorkspace::new(workspace, &test_config)
171        .package(project.toml().package().clone())
172        .no_lock(no_lock)
173        .only_deps(false)
174        .build()
175        .await?;
176
177    let lua_version = project.lua_version(&test_config)?;
178    let project_tree = workspace.lua_version_tree(lua_version, &test_config)?;
179    let test_tree = workspace.test_tree(&test_config)?;
180    let mut paths = Paths::new(&project_tree)?;
181    let test_tree_paths = Paths::new(&test_tree)?;
182    paths.prepend(&test_tree_paths);
183
184    let test_executable = match &test_spec {
185        ValidatedTestSpec::Busted { .. } => BUSTED_EXE.to_string(),
186        ValidatedTestSpec::BustedNlua { .. } => BUSTED_EXE.to_string(),
187        ValidatedTestSpec::Command(spec) => spec.command.to_string(),
188        ValidatedTestSpec::LuaScript(_) => {
189            let lua_version = project.lua_version(&test_config)?;
190            let lua_binary = LuaBinary::new(lua_version, &test_config);
191            let lua_bin_path: PathBuf = lua_binary.try_into()?;
192            lua_bin_path.to_slash_lossy().to_string()
193        }
194    };
195    let mut command = Command::new(&test_executable);
196    let mut command = command
197        .current_dir(project.root().deref())
198        .args(test_spec.args())
199        .args(test_args)
200        .env("PATH", paths.path_prepended().joined())
201        .env("LUA_PATH", paths.package_path().joined())
202        .env("LUA_CPATH", paths.package_cpath().joined());
203    if let TestEnv::Pure = test_env {
204        // isolate the test runner from the user's own config/data files
205        // by initialising empty HOME and XDG base directory paths
206        let home = test_tree.root().join("home");
207        let xdg = home.join("xdg");
208        let _ = tokio::fs::remove_dir_all(&home).await;
209        let xdg_config_home = xdg.join("config");
210        tokio::fs::create_dir_all(&xdg_config_home).await?;
211        let xdg_state_home = xdg.join("local").join("state");
212        tokio::fs::create_dir_all(&xdg_state_home).await?;
213        let xdg_data_home = xdg.join("local").join("share");
214        tokio::fs::create_dir_all(&xdg_data_home).await?;
215        command = command
216            .env("HOME", home)
217            .env("XDG_CONFIG_HOME", xdg_config_home)
218            .env("XDG_STATE_HOME", xdg_state_home)
219            .env("XDG_DATA_HOME", xdg_data_home);
220    }
221    let status = match command.status() {
222        Ok(status) => Ok(status),
223        Err(err) => {
224            let help = if err.to_string().starts_with("No such file") {
225                Some(format!(
226                    "make sure '{}' is available on your PATH",
227                    test_executable
228                ))
229            } else {
230                None
231            };
232            Err(RunTestsError::RunCommandFailure {
233                cmd: test_executable,
234                source: err,
235                help,
236            })
237        }
238    }?;
239    if !status.success() {
240        Err(RunTestsError::TestFailure)
241    } else {
242        Ok(())
243    }
244}
245
246#[derive(Error, Debug, Diagnostic)]
247#[error("error installing test dependencies: {0}")]
248#[diagnostic(forward(0))]
249pub enum InstallTestDependenciesError {
250    WorkspaceTree(#[from] WorkspaceTreeError),
251    Tree(#[from] TreeError),
252    Install(#[from] InstallError),
253    PackageVersionReq(#[from] PackageVersionReqError),
254}
255
256/// Ensure test dependencies are installed
257/// This defaults to the local project tree if cwd is a project root.
258async fn ensure_test_dependencies(
259    workspace: &Workspace,
260    project: &Project,
261    rockspec: impl Rockspec,
262    config: &Config,
263) -> Result<(), InstallTestDependenciesError> {
264    let test_tree = workspace.test_tree(config)?;
265    let rockspec_dependencies = rockspec.test_dependencies().current_platform();
266    let test_dependencies = rockspec
267        .test()
268        .current_platform()
269        .test_dependencies(project)
270        .iter()
271        .filter(|test_dep| {
272            !rockspec_dependencies
273                .iter()
274                .any(|dep| dep.name() == test_dep.name())
275        })
276        .filter_map(|dep| {
277            let build_behaviour = if test_tree
278                .match_rocks(dep)
279                .is_ok_and(|matches| matches.is_found())
280            {
281                Some(BuildBehaviour::NoForce)
282            } else {
283                Some(BuildBehaviour::Force)
284            };
285            build_behaviour.map(|build_behaviour| {
286                PackageInstallSpec::new(dep.clone(), tree::EntryType::Entrypoint)
287                    .build_behaviour(build_behaviour)
288                    .build()
289            })
290        })
291        .chain(
292            rockspec_dependencies
293                .iter()
294                .filter(|req| !req.name().eq(&PackageName::new("lua".into())))
295                .filter_map(|dep| {
296                    let build_behaviour = if test_tree
297                        .match_rocks(dep.package_req())
298                        .is_ok_and(|matches| matches.is_found())
299                    {
300                        Some(BuildBehaviour::NoForce)
301                    } else {
302                        Some(BuildBehaviour::Force)
303                    };
304                    build_behaviour.map(|build_behaviour| {
305                        PackageInstallSpec::new(
306                            dep.package_req().clone(),
307                            tree::EntryType::Entrypoint,
308                        )
309                        .build_behaviour(build_behaviour)
310                        .pin(*dep.pin())
311                        .opt(*dep.opt())
312                        .maybe_source(dep.source.clone())
313                        .build()
314                    })
315                }),
316        )
317        .collect();
318
319    Install::new(config)
320        .packages(test_dependencies)
321        .tree(test_tree)
322        .install()
323        .await?;
324
325    Ok(())
326}
327
328#[cfg(test)]
329mod tests {
330    use std::path::Path;
331
332    use crate::{
333        config::ConfigBuilder, lua_installation::detect_installed_lua_version,
334        lua_version::LuaVersion,
335    };
336
337    use super::*;
338    use assert_fs::{prelude::PathCopy, TempDir};
339
340    #[tokio::test]
341    async fn test_command_spec() {
342        let project_root = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
343            .join("resources/test/sample-projects/command-test/");
344        run_test(&project_root).await
345    }
346
347    #[tokio::test]
348    async fn test_lua_script_spec() {
349        let project_root = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
350            .join("resources/test/sample-projects/lua-script-test/");
351        run_test(&project_root).await
352    }
353
354    async fn run_test(project_root: &Path) {
355        let temp_dir = TempDir::new().unwrap();
356        temp_dir.copy_from(project_root, &["**"]).unwrap();
357        let workspace_root = temp_dir.path();
358        let workspace = Workspace::from(workspace_root).unwrap().unwrap();
359        let tree_root = workspace.root().to_path_buf().join(".lux");
360        let _ = tokio::fs::remove_dir_all(&tree_root).await;
361
362        let lua_version = detect_installed_lua_version().or(Some(LuaVersion::Lua51));
363
364        let config = ConfigBuilder::new()
365            .unwrap()
366            .user_tree(Some(tree_root))
367            .lua_version(lua_version)
368            .build()
369            .unwrap();
370
371        Test::new(workspace, &config).run().await.unwrap();
372    }
373}
lux_lib/operations/test.rs

lux_lib/operations/
test.rs
