razel 0.5.7

a command executor with caching for data processing pipelines
Documentation 
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use crate::cache::BlobDigest;
use crate::{config, ArenaId, CommandId};
use anyhow::{anyhow, Context};
use itertools::Itertools;
use std::ffi::OsStr;
use std::path::{Path, PathBuf};

#[derive(Debug, Eq, PartialEq)]
pub enum FileType {
    DataFile,
    OutputFile,
    ExecutableInWorkspace,
    ExecutableOutsideWorkspace,
    WasiModule,
    SystemExecutable,
    RazelExecutable,
}

impl FileType {
    /// Tries to avoid canonicalize() if possible because that bails on non-existing files.
    /// `Razel::digest_input_files()` reports all missing files at once.
    pub fn from_executable_arg(
        arg: &str,
        workspace_dir: &Path,
    ) -> Result<(Self, Option<PathBuf>), anyhow::Error> {
        let path = Path::new(arg);
        let (file_type, abs_path) = if path
            .file_name()
            .ok_or_else(|| anyhow!("no valid filename: \"{arg}\""))?
            == arg
        {
            assert!(!arg.contains('/'));
            if arg == config::EXECUTABLE {
                (Self::RazelExecutable, None)
            } else {
                (Self::SystemExecutable, None)
            }
        } else if path.iter().contains(&OsStr::new("..")) {
            let canonicalized = path
                .canonicalize()
                .with_context(|| format!("canonicalize \"{arg}\""))?;
            if canonicalized.starts_with(workspace_dir) {
                (Self::ExecutableInWorkspace, Some(canonicalized))
            } else {
                (Self::ExecutableOutsideWorkspace, Some(canonicalized))
            }
        } else if path.is_relative() {
            (Self::ExecutableInWorkspace, Some(workspace_dir.join(path)))
        } else if path.starts_with(workspace_dir) {
            (Self::ExecutableInWorkspace, Some(path.into()))
        } else {
            (Self::ExecutableOutsideWorkspace, Some(path.into()))
        };
        Ok((file_type, abs_path))
    }
}

pub struct File {
    pub id: FileId,
    /// argument from original command line
    pub arg: String,
    pub file_type: FileType,
    pub path: PathBuf,
    /// files without creating_command are input files (data or executable) which must exist before running any commands
    pub creating_command: Option<CommandId>,
    /// file is only used by commands which are filtered out
    pub is_excluded: bool,
    pub digest: Option<BlobDigest>,
    pub locally_cached: bool,
}

impl File {
    pub fn new(id: FileId, arg: String, file_type: FileType, path: PathBuf) -> Self {
        match file_type {
            FileType::DataFile => {}
            FileType::OutputFile | FileType::ExecutableInWorkspace | FileType::WasiModule => {
                assert!(
                    path.is_relative(),
                    "{file_type:?} should have relative path: {path:?}"
                )
            }
            FileType::ExecutableOutsideWorkspace
            | FileType::SystemExecutable
            | FileType::RazelExecutable => assert!(
                path.is_absolute(),
                "{file_type:?} should have absolute path: {path:?}"
            ),
        };
        Self {
            id,
            arg,
            file_type,
            path,
            creating_command: None,
            is_excluded: false,
            digest: None,
            locally_cached: false,
        }
    }

    pub fn executable_for_command_line(&self) -> String {
        match self.file_type {
            FileType::DataFile => {
                panic!();
            }
            FileType::OutputFile | FileType::ExecutableInWorkspace => {
                format!("./{}", self.path.to_str().unwrap())
            }
            FileType::WasiModule => {
                // TODO command line should be directly executable
                self.path.to_str().unwrap().to_string()
            }
            FileType::ExecutableOutsideWorkspace
            | FileType::SystemExecutable
            | FileType::RazelExecutable => self.path.to_str().unwrap().to_string(),
        }
    }
}

pub type FileId = ArenaId<File>;