netsuke-build 0.1.0-beta1

A YAML-powered Ninja/Jinja hybrid build system.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Capability-scoped access to the directory containing a manifest.
//!
//! Opening the workspace through `cap_std` keeps later reads inside the
//! manifest's own directory tree; the ambient authority is exercised exactly
//! once, here, to obtain the handle.

use crate::localization::{self, keys};
use anyhow::{Context, Result, anyhow};
use camino::{Utf8Path, Utf8PathBuf};
use cap_std::{ambient_authority, fs_utf8::Dir};
use std::{env, path::Path};

/// Resolve a potentially relative manifest parent path to an absolute UTF-8 workspace root.
fn resolve_absolute_workspace_root(utf8_parent: &Utf8Path) -> Result<Utf8PathBuf> {
    let workspace_base = if utf8_parent.is_absolute() {
        utf8_parent.to_path_buf().into_std_path_buf()
    } else {
        env::current_dir()
            .context(localization::message(keys::MANIFEST_RESOLVE_WORKSPACE_ROOT))?
            .join(utf8_parent.as_std_path())
    };
    Utf8PathBuf::from_path_buf(workspace_base).map_err(|invalid| {
        anyhow!(
            "{}",
            localization::message(keys::MANIFEST_WORKSPACE_NON_UTF8)
                .with_arg("path", invalid.display().to_string())
        )
    })
}

/// A manifest's workspace opened for capability-based access.
#[derive(Debug)]
pub(super) struct ManifestWorkspace {
    /// Capability-scoped handle on the workspace root.
    pub(super) dir: Dir,
    /// Absolute UTF-8 path of the workspace root.
    pub(super) root: Utf8PathBuf,
    /// Manifest file name relative to the workspace root.
    pub(super) manifest_file: String,
}

/// Open the directory containing `path` as a capability-scoped workspace.
pub(super) fn open_manifest_workspace(path: &Path) -> Result<ManifestWorkspace> {
    let parent = match path.parent() {
        Some(parent) if !parent.as_os_str().is_empty() => parent,
        _ => Path::new("."),
    };
    let manifest_file = match path.file_name() {
        None => {
            return Err(anyhow!(
                "{}",
                localization::message(keys::MANIFEST_PATH_MISSING_NAME)
                    .with_arg("path", path.display().to_string())
            ));
        }
        Some(name) => name.to_str().map(str::to_owned).ok_or_else(|| {
            anyhow!(
                "{}",
                localization::message(keys::MANIFEST_PATH_NON_UTF8)
                    .with_arg("manifest", path.display().to_string())
                    .with_arg("path", path.display().to_string())
            )
        })?,
    };
    let utf8_parent = Utf8Path::from_path(parent).ok_or_else(|| {
        anyhow!(
            "{}",
            localization::message(keys::MANIFEST_PATH_NON_UTF8)
                .with_arg("manifest", &manifest_file)
                .with_arg("path", path.display().to_string())
        )
    })?;
    let root = resolve_absolute_workspace_root(utf8_parent)?;
    tracing::debug!(workspace = %root, manifest = %manifest_file, "opening manifest workspace directory");
    let dir = Dir::open_ambient_dir(root.as_path(), ambient_authority())
        .inspect_err(|err| {
            tracing::warn!(workspace = %root, manifest = %manifest_file, error = %err, "failed to open manifest workspace directory");
        })
        .with_context(|| {
            localization::message(keys::MANIFEST_OPEN_WORKSPACE_FAILED)
                .with_arg("workspace", root.as_str())
                .with_arg("manifest", &manifest_file)
        })?;
    Ok(ManifestWorkspace {
        dir,
        root,
        manifest_file,
    })
}