lux_lib/project/
mod.rs

1use itertools::Itertools;
2use miette::{Diagnostic, NamedSource, SourceSpan};
3use path_slash::PathBufExt;
4use project_toml::{
5    LocalProjectTomlValidationError, PartialProjectToml, RemoteProjectTomlValidationError,
6};
7use std::{
8    io,
9    ops::Deref,
10    path::{Path, PathBuf},
11    str::FromStr,
12};
13use thiserror::Error;
14use toml_edit::{DocumentMut, Item};
15
16use crate::fs;
17
18use crate::{
19    config::Config,
20    git::{
21        self,
22        shorthand::RemoteGitUrlShorthand,
23        url::RemoteGitUrl,
24        utils::{GitError, SemVerTagOrSha},
25    },
26    lua_rockspec::{
27        LocalLuaRockspec, LuaRockspecError, LuaVersionError, PartialLuaRockspec,
28        PartialRockspecError, RemoteLuaRockspec,
29    },
30    lua_version::LuaVersion,
31    package::SpecRev,
32    remote_package_db::RemotePackageDB,
33    rockspec::{
34        lua_dependency::{DependencyType, LuaDependencySpec, LuaDependencyType},
35        LuaVersionCompatibility,
36    },
37};
38use crate::{
39    lockfile::PinnedState,
40    package::{PackageName, PackageReq},
41};
42
43pub(crate) mod gen;
44pub mod project_toml;
45
46pub use project_toml::PROJECT_TOML;
47
48pub const EXTRA_ROCKSPEC: &str = "extra.rockspec";
49
50/// A wrapper around [`toml::de::Error`] plus the original source code and the byte range where the
51/// error occurred so that `miette` can render the failure with line numbers and context.
52#[derive(Debug, Error, Diagnostic)]
53#[error("{message}", message = _inner.message())]
54#[diagnostic(
55    code(lux_lib::toml::deserialize),
56    help("check that the file is valid TOML and matches the expected schema"),
57    url("https://lux.lumen-labs.org/reference/lux-toml")
58)]
59pub struct TomlDeError {
60    #[source]
61    _inner: Box<toml::de::Error>,
62    #[source_code]
63    src: NamedSource<String>,
64    #[label("here")]
65    span: SourceSpan,
66}
67
68impl TomlDeError {
69    pub fn new(name: &str, src: &str, inner: toml::de::Error) -> Self {
70        let src = NamedSource::new(name, src.to_string());
71        let span = inner.span().unwrap_or(0..0).into();
72        Self {
73            _inner: Box::new(inner),
74            src,
75            span,
76        }
77    }
78
79    pub fn inner(&self) -> &toml::de::Error {
80        &self._inner
81    }
82}
83
84pub(crate) fn parse_toml<T>(name: &str, src: &str) -> Result<T, TomlDeError>
85where
86    T: serde::de::DeserializeOwned,
87{
88    toml::from_str(src).map_err(|e| TomlDeError::new(name, src, e))
89}
90
91#[derive(Error, Debug, Diagnostic)]
92#[non_exhaustive]
93#[error(transparent)]
94pub enum ProjectError {
95    #[error(transparent)]
96    #[diagnostic(transparent)]
97    Fs(#[from] fs::FsError),
98    #[diagnostic(transparent)]
99    Project(#[from] LocalProjectTomlValidationError),
100    #[diagnostic(transparent)]
101    Toml(#[from] TomlDeError),
102    #[error("error when parsing 'extra.rockspec'")]
103    #[diagnostic(forward(0))]
104    Rockspec(#[from] PartialRockspecError),
105}
106
107#[derive(Error, Debug, Diagnostic)]
108#[non_exhaustive]
109#[error(transparent)]
110pub enum IntoLocalRockspecError {
111    LocalProjectTomlValidationError(Box<LocalProjectTomlValidationError>),
112    RockspecError(Box<LuaRockspecError>),
113}
114
115#[derive(Error, Debug, Diagnostic)]
116#[non_exhaustive]
117#[error(transparent)]
118pub enum IntoRemoteRockspecError {
119    RocksTomlValidationError(Box<RemoteProjectTomlValidationError>),
120    RockspecError(Box<LuaRockspecError>),
121}
122
123#[derive(Error, Debug, Diagnostic)]
124#[non_exhaustive]
125pub enum ProjectEditError {
126    #[error(transparent)]
127    Io(#[from] tokio::io::Error),
128    #[error(transparent)]
129    #[diagnostic(transparent)]
130    Fs(#[from] fs::FsError),
131    #[error(transparent)]
132    Toml(#[from] toml_edit::TomlError),
133    #[error("error parsing {PROJECT_TOML} after edit. This is probably a bug.")]
134    #[diagnostic(forward(0))]
135    TomlDe(#[from] TomlDeError),
136    #[error(transparent)]
137    #[diagnostic(transparent)]
138    Git(#[from] GitError),
139    #[error("unable to query latest version for '{0}'")]
140    #[diagnostic(help("check your server config and ensure the package has been published"))]
141    LatestVersionNotFound(PackageName),
142    #[error("expected field to be a value, but got '{0}'")]
143    #[diagnostic(
144        help("ensure your {PROJECT_TOML} matches the specification"),
145        url("https://lux.lumen-labs.org/reference/lux-toml")
146    )]
147    ExpectedValue(Box<toml_edit::Item>),
148    #[error("expected string, but got '{0}'")]
149    #[diagnostic(
150        help("ensure your {PROJECT_TOML} matches the specification"),
151        url("https://lux.lumen-labs.org/reference/lux-toml")
152    )]
153    ExpectedString(Box<toml_edit::Value>),
154    #[error(transparent)]
155    #[diagnostic(transparent)]
156    GitUrlShorthandParse(#[from] git::shorthand::ParseError),
157}
158
159#[derive(Error, Debug, Diagnostic)]
160#[non_exhaustive]
161pub enum PinError {
162    #[error("package '{0}' not found in dependencies")]
163    #[diagnostic(help("to add it, run 'lx add {0}'"))]
164    PackageNotFound(PackageName),
165    #[error("dependency '{dep}' is already {}pinned!", if *.pin_state == PinnedState::Unpinned { "un" } else { "" })]
166    PinStateUnchanged {
167        pin_state: PinnedState,
168        dep: PackageName,
169    },
170    #[error("unable to parse {toml_path} for editing")]
171    #[diagnostic(
172        code(lux_lib::toml_edit::parse),
173        help("check that the file is valid TOML and matches the expected schema"),
174        url("https://lux.lumen-labs.org/reference/lux-toml")
175    )]
176    ParseTomlEdit {
177        toml_path: String,
178        source: toml_edit::TomlError,
179    },
180    #[error("error parsing lux.toml after edit. This is probably a bug.")]
181    #[diagnostic(forward(0))]
182    TomlDe(#[from] TomlDeError),
183    #[error(transparent)]
184    Io(#[from] tokio::io::Error),
185    #[error(transparent)]
186    #[diagnostic(transparent)]
187    Fs(#[from] fs::FsError),
188}
189
190/// A newtype for the project root directory.
191/// This is used to ensure that the project root is a valid project directory.
192#[derive(Clone, Debug)]
193#[cfg_attr(test, derive(Default))]
194pub struct ProjectRoot(PathBuf);
195
196impl ProjectRoot {
197    pub(crate) fn new() -> Self {
198        Self(PathBuf::new())
199    }
200}
201
202impl AsRef<Path> for ProjectRoot {
203    fn as_ref(&self) -> &Path {
204        self.0.as_ref()
205    }
206}
207
208impl Deref for ProjectRoot {
209    type Target = PathBuf;
210
211    fn deref(&self) -> &Self::Target {
212        &self.0
213    }
214}
215
216/// Lux project, with methods for managing dependencies, etc.
217#[derive(Clone, Debug)]
218pub struct Project {
219    /// The path where the `lux.toml` resides.
220    root: ProjectRoot,
221    /// The parsed lux.toml.
222    toml: PartialProjectToml,
223}
224
225impl Project {
226    /// Load a project at the specified path, if it exists
227    #[tracing::instrument(level = "trace", skip_all)]
228    pub fn from_exact(start: impl AsRef<Path>) -> Result<Option<Self>, ProjectError> {
229        if !start.as_ref().exists() {
230            return Ok(None);
231        }
232
233        if start.as_ref().join(PROJECT_TOML).exists() {
234            let project_toml_path = start.as_ref().join(PROJECT_TOML);
235            let toml_content = fs::sync::read_to_string(&project_toml_path)?;
236            let root = start.as_ref();
237
238            let mut project = Project {
239                root: ProjectRoot(root.to_path_buf()),
240                toml: PartialProjectToml::new(
241                    &project_toml_path.to_string_lossy(),
242                    &toml_content,
243                    ProjectRoot(root.to_path_buf()),
244                )?,
245            };
246
247            if let Some(extra_rockspec) = project.extra_rockspec()? {
248                project.toml = project.toml.merge(extra_rockspec);
249            }
250
251            Ok(Some(project))
252        } else {
253            Ok(None)
254        }
255    }
256
257    /// Get the `lux.toml` path.
258    pub fn toml_path(&self) -> PathBuf {
259        self.root.join(PROJECT_TOML)
260    }
261
262    /// Get the `extra.rockspec` path.
263    pub fn extra_rockspec_path(&self) -> PathBuf {
264        self.root.join(EXTRA_ROCKSPEC)
265    }
266
267    pub fn root(&self) -> &ProjectRoot {
268        &self.root
269    }
270
271    pub fn toml(&self) -> &PartialProjectToml {
272        &self.toml
273    }
274
275    pub fn local_rockspec(&self) -> Result<LocalLuaRockspec, IntoLocalRockspecError> {
276        self.toml()
277            .into_local()
278            .map_err(|err| IntoLocalRockspecError::LocalProjectTomlValidationError(Box::new(err)))?
279            .to_lua_rockspec()
280            .map_err(|err| IntoLocalRockspecError::RockspecError(Box::new(err)))
281    }
282
283    pub fn remote_rockspec(
284        &self,
285        specrev: Option<SpecRev>,
286    ) -> Result<RemoteLuaRockspec, IntoRemoteRockspecError> {
287        self.toml()
288            .into_remote(specrev)
289            .map_err(|err| IntoRemoteRockspecError::RocksTomlValidationError(Box::new(err)))?
290            .to_lua_rockspec()
291            .map_err(|err| IntoRemoteRockspecError::RockspecError(Box::new(err)))
292    }
293
294    pub fn extra_rockspec(&self) -> Result<Option<PartialLuaRockspec>, PartialRockspecError> {
295        if self.extra_rockspec_path().exists() {
296            Ok(Some(PartialLuaRockspec::new(
297                &fs::sync::read_to_string(self.extra_rockspec_path()).map_err(io::Error::other)?,
298            )?))
299        } else {
300            Ok(None)
301        }
302    }
303
304    pub fn lua_version(&self, config: &Config) -> Result<LuaVersion, LuaVersionError> {
305        self.toml().lua_version_matches(config)
306    }
307
308    pub async fn add(
309        &mut self,
310        dependencies: DependencyType<&PackageReq>,
311        package_db: &RemotePackageDB,
312    ) -> Result<(), ProjectEditError> {
313        let mut project_toml =
314            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
315
316        prepare_dependency_tables(&mut project_toml);
317        let table = match dependencies {
318            DependencyType::Regular(_) => &mut project_toml["dependencies"],
319            DependencyType::Build(_) => &mut project_toml["build_dependencies"],
320            DependencyType::Test(_) => &mut project_toml["test_dependencies"],
321            DependencyType::External(_) => &mut project_toml["external_dependencies"],
322        };
323
324        match dependencies {
325            DependencyType::Regular(ref deps)
326            | DependencyType::Build(ref deps)
327            | DependencyType::Test(ref deps) => {
328                for dep in deps {
329                    let dep_version_str = if dep.version_req().is_any() {
330                        package_db
331                            .latest_version(dep.name())
332                            .map(|latest_version| latest_version.to_string())
333                            .unwrap_or_else(|| dep.version_req().to_string())
334                    } else {
335                        dep.version_req().to_string()
336                    };
337                    table[dep.name().to_string()] = toml_edit::value(dep_version_str);
338                }
339            }
340            DependencyType::External(ref deps) => {
341                for (name, dep) in deps {
342                    if let Some(path) = &dep.header {
343                        table[name]["header"] = toml_edit::value(path.to_slash_lossy().to_string());
344                    }
345                    if let Some(path) = &dep.library {
346                        table[name]["library"] =
347                            toml_edit::value(path.to_slash_lossy().to_string());
348                    }
349                }
350            }
351        };
352
353        let toml_content = project_toml.to_string();
354        fs::tokio::write(self.toml_path(), &toml_content).await?;
355        self.toml = PartialProjectToml::new(
356            self.toml_path().to_str().unwrap_or("<lux.toml>"),
357            &toml_content,
358            self.root.clone(),
359        )?;
360
361        Ok(())
362    }
363
364    pub async fn add_git(
365        &mut self,
366        dependencies: LuaDependencyType<&RemoteGitUrlShorthand>,
367    ) -> Result<(), ProjectEditError> {
368        let mut project_toml =
369            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
370
371        prepare_dependency_tables(&mut project_toml);
372        let table = match dependencies {
373            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
374            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
375            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
376        };
377
378        match dependencies {
379            LuaDependencyType::Regular(urls)
380            | LuaDependencyType::Build(urls)
381            | LuaDependencyType::Test(urls) => {
382                for url in urls {
383                    let git_url: RemoteGitUrl = url.clone().into();
384                    let mut dep_entry = toml_edit::table();
385                    match git::utils::latest_semver_tag_or_commit_sha(&git_url)? {
386                        SemVerTagOrSha::SemVerTag(tag) => {
387                            dep_entry["git"] = Item::Value(url.to_string().into());
388                            dep_entry["version"] = Item::Value(tag.clone().into());
389                            if tag.contains("-") {
390                                // Tag contains a specrev.
391                                dep_entry["rev"] = Item::Value(tag.into());
392                            }
393                        }
394                        SemVerTagOrSha::CommitSha(sha) => {
395                            dep_entry["git"] = Item::Value(url.to_string().into());
396                            dep_entry["version"] = Item::Value(sha.into());
397                        }
398                    }
399                    table[git_url.repo()] = dep_entry;
400                }
401            }
402        }
403
404        let toml_content = project_toml.to_string();
405        fs::tokio::write(self.toml_path(), &toml_content).await?;
406        self.toml = PartialProjectToml::new(
407            self.toml_path().to_str().unwrap_or("<lux.toml>"),
408            &toml_content,
409            self.root.clone(),
410        )?;
411
412        Ok(())
413    }
414
415    pub async fn remove(
416        &mut self,
417        dependencies: DependencyType<&PackageName>,
418    ) -> Result<(), ProjectEditError> {
419        let mut project_toml =
420            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
421
422        prepare_dependency_tables(&mut project_toml);
423        let table = match dependencies {
424            DependencyType::Regular(_) => &mut project_toml["dependencies"],
425            DependencyType::Build(_) => &mut project_toml["build_dependencies"],
426            DependencyType::Test(_) => &mut project_toml["test_dependencies"],
427            DependencyType::External(_) => &mut project_toml["external_dependencies"],
428        };
429
430        match dependencies {
431            DependencyType::Regular(ref deps)
432            | DependencyType::Build(ref deps)
433            | DependencyType::Test(ref deps) => {
434                for dep in deps {
435                    table[dep.to_string()] = Item::None;
436                }
437            }
438            DependencyType::External(ref deps) => {
439                for (name, dep) in deps {
440                    if dep.header.is_some() {
441                        table[name]["header"] = Item::None;
442                    }
443                    if dep.library.is_some() {
444                        table[name]["library"] = Item::None;
445                    }
446                }
447            }
448        };
449
450        let toml_content = project_toml.to_string();
451        fs::tokio::write(self.toml_path(), &toml_content).await?;
452        self.toml = PartialProjectToml::new(
453            self.toml_path().to_str().unwrap_or("<lux.toml>"),
454            &toml_content,
455            self.root.clone(),
456        )?;
457
458        Ok(())
459    }
460
461    pub async fn upgrade(
462        &mut self,
463        dependencies: LuaDependencyType<&PackageName>,
464        package_db: &RemotePackageDB,
465    ) -> Result<(), ProjectEditError> {
466        let mut project_toml =
467            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)?;
468
469        prepare_dependency_tables(&mut project_toml);
470        let table = match dependencies {
471            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
472            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
473            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
474        };
475
476        match dependencies {
477            LuaDependencyType::Regular(deps)
478            | LuaDependencyType::Build(deps)
479            | LuaDependencyType::Test(deps) => {
480                let latest_rock_version_str =
481                    |dep: &PackageName| -> Result<String, ProjectEditError> {
482                        Ok(package_db
483                            .latest_version(dep)
484                            .ok_or(ProjectEditError::LatestVersionNotFound(dep.clone()))?
485                            .to_string())
486                    };
487                for dep in deps {
488                    let mut dep_item = table[dep.to_string()].clone();
489                    match &dep_item {
490                        Item::Value(_) => {
491                            let dep_version_str = latest_rock_version_str(dep)?;
492                            table[dep.to_string()] = toml_edit::value(dep_version_str);
493                        }
494                        Item::Table(tbl) => {
495                            match tbl.get("git") {
496                                Some(git_item) => {
497                                    let git_value =
498                                        git_item.clone().into_value().map_err(|err| {
499                                            ProjectEditError::ExpectedValue(Box::new(err))
500                                        })?;
501                                    let git_url_str = git_value.as_str().ok_or(
502                                        ProjectEditError::ExpectedString(Box::new(
503                                            git_value.clone(),
504                                        )),
505                                    )?;
506                                    let shorthand: RemoteGitUrlShorthand = git_url_str.parse()?;
507                                    match git::utils::latest_semver_tag_or_commit_sha(
508                                        &shorthand.into(),
509                                    )? {
510                                        SemVerTagOrSha::SemVerTag(latest_tag) => {
511                                            table[dep.to_string()]["version"] =
512                                                Item::Value(latest_tag.clone().into());
513                                            if latest_tag.contains("-") {
514                                                // Tag contains a specrev.
515                                                table[dep.to_string()]["rev"] =
516                                                    Item::Value(latest_tag.into());
517                                            }
518                                        }
519                                        SemVerTagOrSha::CommitSha(latest_sha) => {
520                                            table[dep.to_string()]["version"] =
521                                                Item::Value(latest_sha.into());
522                                        }
523                                    }
524                                    table[dep.to_string()] = dep_item;
525                                }
526                                None => {
527                                    let dep_version_str = latest_rock_version_str(dep)?;
528                                    dep_item["version".to_string()] =
529                                        toml_edit::value(dep_version_str);
530                                    table[dep.to_string()] = dep_item;
531                                }
532                            }
533                        }
534                        _ => {}
535                    }
536                }
537            }
538        }
539
540        let toml_content = project_toml.to_string();
541        fs::tokio::write(self.toml_path(), &toml_content).await?;
542        self.toml = PartialProjectToml::new(
543            self.toml_path().to_str().unwrap_or("<lux.toml>"),
544            &toml_content,
545            self.root.clone(),
546        )?;
547
548        Ok(())
549    }
550
551    pub async fn upgrade_all(
552        &mut self,
553        package_db: &RemotePackageDB,
554    ) -> Result<(), ProjectEditError> {
555        if let Some(dependencies) = &self.toml().dependencies {
556            let packages = dependencies
557                .iter()
558                .map(|dep| dep.name())
559                .cloned()
560                .collect_vec();
561            self.upgrade(
562                LuaDependencyType::Regular(packages.iter().collect()),
563                package_db,
564            )
565            .await?;
566        }
567        if let Some(dependencies) = &self.toml().build_dependencies {
568            let packages = dependencies
569                .iter()
570                .map(|dep| dep.name())
571                .cloned()
572                .collect_vec();
573            self.upgrade(
574                LuaDependencyType::Build(packages.iter().collect()),
575                package_db,
576            )
577            .await?;
578        }
579        if let Some(dependencies) = &self.toml().test_dependencies {
580            let packages = dependencies
581                .iter()
582                .map(|dep| dep.name())
583                .cloned()
584                .collect_vec();
585            self.upgrade(
586                LuaDependencyType::Test(packages.iter().collect()),
587                package_db,
588            )
589            .await?;
590        }
591        Ok(())
592    }
593
594    pub async fn set_pinned_state(
595        &mut self,
596        dependencies: LuaDependencyType<&PackageName>,
597        pin: PinnedState,
598    ) -> Result<(), PinError> {
599        let mut project_toml =
600            toml_edit::DocumentMut::from_str(&fs::tokio::read_to_string(self.toml_path()).await?)
601                .map_err(|source| PinError::ParseTomlEdit {
602                toml_path: self.toml_path().to_slash_lossy().to_string(),
603                source,
604            })?;
605
606        prepare_dependency_tables(&mut project_toml);
607        let table = match dependencies {
608            LuaDependencyType::Regular(_) => &mut project_toml["dependencies"],
609            LuaDependencyType::Build(_) => &mut project_toml["build_dependencies"],
610            LuaDependencyType::Test(_) => &mut project_toml["test_dependencies"],
611        };
612
613        match dependencies {
614            LuaDependencyType::Regular(ref _deps) => {
615                self.toml.dependencies = Some(
616                    self.toml
617                        .dependencies
618                        .take()
619                        .unwrap_or_default()
620                        .into_iter()
621                        .map(|dep| LuaDependencySpec { pin, ..dep })
622                        .collect(),
623                )
624            }
625            LuaDependencyType::Build(ref _deps) => {
626                self.toml.build_dependencies = Some(
627                    self.toml
628                        .build_dependencies
629                        .take()
630                        .unwrap_or_default()
631                        .into_iter()
632                        .map(|dep| LuaDependencySpec { pin, ..dep })
633                        .collect(),
634                )
635            }
636            LuaDependencyType::Test(ref _deps) => {
637                self.toml.test_dependencies = Some(
638                    self.toml
639                        .test_dependencies
640                        .take()
641                        .unwrap_or_default()
642                        .into_iter()
643                        .map(|dep| LuaDependencySpec { pin, ..dep })
644                        .collect(),
645                )
646            }
647        }
648
649        match dependencies {
650            LuaDependencyType::Regular(ref deps)
651            | LuaDependencyType::Build(ref deps)
652            | LuaDependencyType::Test(ref deps) => {
653                for dep in deps {
654                    let mut dep_item = table[dep.to_string()].clone();
655                    match dep_item {
656                        version @ Item::Value(_) => match &pin {
657                            PinnedState::Unpinned => {}
658                            PinnedState::Pinned => {
659                                if let Ok(mut dep_entry) = toml_edit::table().into_table() {
660                                    dep_entry.set_implicit(true);
661                                    dep_entry["version"] = version;
662                                    dep_entry["pin"] = toml_edit::value(true);
663                                    table[dep.to_string()] = toml_edit::Item::Table(dep_entry);
664                                }
665                            }
666                        },
667                        Item::Table(_) => {
668                            dep_item["pin".to_string()] = toml_edit::value(pin.as_bool());
669                            table[dep.to_string()] = dep_item;
670                        }
671                        _ => {}
672                    }
673                }
674            }
675        }
676
677        let toml_content = project_toml.to_string();
678        fs::tokio::write(self.toml_path(), &toml_content).await?;
679        self.toml = PartialProjectToml::new(
680            self.toml_path().to_str().unwrap_or("<lux.toml>"),
681            &toml_content,
682            self.root.clone(),
683        )?;
684
685        Ok(())
686    }
687
688    pub fn project_files(&self) -> Vec<PathBuf> {
689        project_files(&self.root().0)
690    }
691}
692
693/// Get the files that Lux treats as project files
694/// This respects ignore files and excludes hidden files and directories.
695pub(crate) fn project_files(src: &Path) -> Vec<PathBuf> {
696    ignore::WalkBuilder::new(src)
697        .add(src.join(".cargo"))
698        .follow_links(false)
699        .build()
700        .filter_map(Result::ok)
701        .filter(|entry| entry.file_type().is_some_and(|ft| ft.is_file()))
702        .map(|entry| entry.into_path())
703        .collect_vec()
704}
705
706fn prepare_dependency_tables(project_toml: &mut DocumentMut) {
707    if !project_toml.contains_table("dependencies") {
708        if let Ok(mut table) = toml_edit::table().into_table() {
709            table.set_implicit(true);
710            project_toml["dependencies"] = toml_edit::Item::Table(table);
711        }
712    }
713    if !project_toml.contains_table("build_dependencies") {
714        if let Ok(mut table) = toml_edit::table().into_table() {
715            table.set_implicit(true);
716            project_toml["build_dependencies"] = toml_edit::Item::Table(table);
717        }
718    }
719    if !project_toml.contains_table("test_dependencies") {
720        if let Ok(mut table) = toml_edit::table().into_table() {
721            table.set_implicit(true);
722            project_toml["test_dependencies"] = toml_edit::Item::Table(table);
723        }
724    }
725    if !project_toml.contains_table("external_dependencies") {
726        if let Ok(mut table) = toml_edit::table().into_table() {
727            table.set_implicit(true);
728            project_toml["external_dependencies"] = toml_edit::Item::Table(table);
729        }
730    }
731}
732
733// TODO: More project-based test
734#[cfg(test)]
735mod tests {
736    use std::collections::HashMap;
737
738    use assert_fs::prelude::{PathChild, PathCopy, PathCreateDir};
739    use url::Url;
740
741    use super::*;
742    use crate::{
743        fs,
744        lua_rockspec::ExternalDependencySpec,
745        manifest::{Manifest, ManifestMetadata},
746        package::PackageReq,
747        rockspec::Rockspec,
748    };
749
750    #[tokio::test]
751    async fn test_add_various_dependencies() {
752        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
753            .join("resources/test/sample-projects/no-build-spec/");
754        let project_root = assert_fs::TempDir::new().unwrap();
755        project_root.copy_from(&sample_project, &["**"]).unwrap();
756        let project_root: PathBuf = project_root.path().into();
757        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
758        let add_dependencies = [PackageReq::new("busted".into(), Some(">= 1.0.0".into())).unwrap()];
759        let expected_dependencies = vec![PackageReq::new("busted".into(), Some(">= 1.0.0".into()))
760            .unwrap()
761            .into()];
762
763        let test_manifest_path =
764            PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources/test/manifest-5.1");
765        let content = String::from_utf8(std::fs::read(&test_manifest_path).unwrap()).unwrap();
766        let metadata = ManifestMetadata::new(&content).unwrap();
767        let package_db = Manifest::new(
768            Url::parse("https://example.com").unwrap(),
769            metadata,
770            Default::default(),
771        )
772        .into();
773
774        project
775            .add(
776                DependencyType::Regular(add_dependencies.iter().collect_vec()),
777                &package_db,
778            )
779            .await
780            .unwrap();
781
782        project
783            .add(
784                DependencyType::Build(add_dependencies.iter().collect_vec()),
785                &package_db,
786            )
787            .await
788            .unwrap();
789        project
790            .add(
791                DependencyType::Test(add_dependencies.iter().collect_vec()),
792                &package_db,
793            )
794            .await
795            .unwrap();
796
797        project
798            .add(
799                DependencyType::External(HashMap::from([(
800                    "lib".into(),
801                    ExternalDependencySpec {
802                        library: Some("path.so".into()),
803                        header: None,
804                    },
805                )])),
806                &package_db,
807            )
808            .await
809            .unwrap();
810
811        // Reparse the lux.toml (not usually necessary, but we want to test that the file was
812        // written correctly)
813        let project = Project::from_exact(&project_root).unwrap().unwrap();
814        let validated_toml = project.toml().into_remote(None).unwrap();
815
816        assert_eq!(
817            validated_toml.dependencies().current_platform(),
818            &expected_dependencies
819        );
820        assert_eq!(
821            validated_toml.build_dependencies().current_platform(),
822            &expected_dependencies
823        );
824        assert_eq!(
825            validated_toml.test_dependencies().current_platform(),
826            &expected_dependencies
827        );
828        assert_eq!(
829            validated_toml
830                .external_dependencies()
831                .current_platform()
832                .get("lib")
833                .unwrap(),
834            &ExternalDependencySpec {
835                library: Some("path.so".into()),
836                header: None
837            }
838        );
839    }
840
841    #[tokio::test]
842    async fn test_remove_dependencies() {
843        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
844            .join("resources/test/sample-projects/dependencies/");
845        let project_root = assert_fs::TempDir::new().unwrap();
846        project_root.copy_from(&sample_project, &["**"]).unwrap();
847        let project_root: PathBuf = project_root.path().into();
848        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
849        let lua_cjson = "lua-cjson".into();
850        let plenary_nvim = "plenary.nvim".into();
851        let remove_dependencies = vec![&lua_cjson, &plenary_nvim];
852        project
853            .remove(DependencyType::Regular(remove_dependencies.clone()))
854            .await
855            .unwrap();
856        let check = |project: &Project| {
857            for name in &remove_dependencies {
858                assert!(!project
859                    .toml()
860                    .dependencies
861                    .clone()
862                    .unwrap_or_default()
863                    .iter()
864                    .any(|dep| &dep.name() == name));
865            }
866        };
867        check(&project);
868        // check again after reloading lux.toml
869        let reloaded_project = Project::from_exact(&project_root).unwrap().unwrap();
870        check(&reloaded_project);
871    }
872
873    #[tokio::test]
874    async fn test_extra_rockspec_parsing() {
875        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
876            .join("resources/test/sample-projects/extra-rockspec/");
877        let project_root = assert_fs::TempDir::new().unwrap();
878        project_root.copy_from(&sample_project, &["**"]).unwrap();
879        let project_root: PathBuf = project_root.path().into();
880        let project = Project::from_exact(project_root).unwrap().unwrap();
881
882        let extra_rockspec = project.extra_rockspec().unwrap();
883
884        assert!(extra_rockspec.is_some());
885
886        let rocks = project.toml().into_remote(None).unwrap();
887
888        assert_eq!(rocks.package().to_string(), "custom-package");
889    }
890
891    #[tokio::test]
892    async fn test_pin_dependencies() {
893        test_pin_unpin_dependencies(PinnedState::Pinned).await
894    }
895
896    #[tokio::test]
897    async fn test_unpin_dependencies() {
898        test_pin_unpin_dependencies(PinnedState::Unpinned).await
899    }
900
901    async fn test_pin_unpin_dependencies(pin: PinnedState) {
902        let sample_project = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
903            .join("resources/test/sample-projects/dependencies/");
904        let project_root = assert_fs::TempDir::new().unwrap();
905        project_root.copy_from(&sample_project, &["**"]).unwrap();
906        let project_root: PathBuf = project_root.path().into();
907        let mut project = Project::from_exact(&project_root).unwrap().unwrap();
908        let lua_cjson = "lua-cjson".into();
909        let plenary_nvim = "plenary.nvim".into();
910        let pin_dependencies = vec![&lua_cjson, &plenary_nvim];
911        project
912            .set_pinned_state(LuaDependencyType::Regular(pin_dependencies.clone()), pin)
913            .await
914            .unwrap();
915        let check = |project: &Project| {
916            for name in &pin_dependencies {
917                assert!(project
918                    .toml()
919                    .dependencies
920                    .clone()
921                    .unwrap_or_default()
922                    .iter()
923                    .any(|dep| &dep.name() == name && dep.pin == pin));
924            }
925        };
926        check(&project);
927        // check again after reloading lux.toml
928        let reloaded_project = Project::from_exact(&project_root).unwrap().unwrap();
929        check(&reloaded_project);
930    }
931
932    #[tokio::test]
933    async fn project_files_includes_cargo_directory() {
934        let project_root = assert_fs::TempDir::new().unwrap();
935        let cargo_dir = project_root.child(".cargo");
936        cargo_dir.create_dir_all().unwrap();
937        let cargo_config = cargo_dir.join("config.toml");
938        fs::tokio::write(&cargo_config, "").await.unwrap();
939        let project_files = project_files(&project_root);
940        assert!(project_files.contains(&cargo_config.to_path_buf()));
941    }
942
943    #[tokio::test]
944    async fn from_exact_on_nonexistent_directory() {
945        let empty_dir = assert_fs::TempDir::new().unwrap();
946        assert!(Project::from_exact(&empty_dir).unwrap().is_none());
947    }
948}
lux_lib/project/mod.rs

lux_lib/project/
mod.rs
