lux_lib/operations/
test.rs

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

lux_lib/operations/
test.rs
