treeboot-core 0.9.0

Reusable worktree bootstrap engine for the treeboot CLI.
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

use std::collections::BTreeSet;
use std::path::PathBuf;

use crate::{FileOperationKind, FileOperationSummary, MetadataField};

#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) enum FileAction {
    CreateDirectory {
        operation: FileOperationKind,
        source: PathBuf,
        target: PathBuf,
        target_path: PathBuf,
    },
    CopyFile {
        operation: FileOperationKind,
        source: PathBuf,
        target: PathBuf,
        source_path: PathBuf,
        target_path: PathBuf,
        metadata_policy: MetadataPolicy,
        replace: bool,
    },
    RepairMetadata {
        operation: FileOperationKind,
        source: PathBuf,
        target: PathBuf,
        source_path: PathBuf,
        target_path: PathBuf,
        metadata_policy: MetadataPolicy,
        target_kind: MetadataTarget,
        report: bool,
    },
    CreateSymlink {
        operation: FileOperationKind,
        source: PathBuf,
        target: PathBuf,
        target_path: PathBuf,
        preserved_source_path: Option<PathBuf>,
        link_target: PathBuf,
        final_target: PathBuf,
        target_is_dir: bool,
        replace: bool,
    },
    Delete {
        target: PathBuf,
        target_path: PathBuf,
    },
    Skip {
        operation: FileOperationKind,
        target: PathBuf,
        reason: String,
    },
    Warning {
        path: PathBuf,
        reason: String,
    },
}

impl FileAction {
    pub(crate) fn counts(&self) -> bool {
        !matches!(
            self,
            Self::RepairMetadata { report: false, .. } | Self::Warning { .. }
        )
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct MetadataPolicy {
    pub(crate) permissions: bool,
    pub(crate) owner: bool,
    pub(crate) group: bool,
}

impl MetadataPolicy {
    pub(crate) fn from_ignored(fields: &[MetadataField]) -> Self {
        Self {
            permissions: !fields.contains(&MetadataField::Permissions),
            owner: !fields.contains(&MetadataField::Owner),
            group: !fields.contains(&MetadataField::Group),
        }
    }
}

impl Default for MetadataPolicy {
    fn default() -> Self {
        Self {
            permissions: true,
            owner: true,
            group: true,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum MetadataTarget {
    File,
    Directory,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) struct PlannedFileOperationActions {
    pub(crate) operation: FileOperationKind,
    pub(crate) source: PathBuf,
    pub(crate) target: PathBuf,
    pub(crate) expanded: bool,
    pub(crate) actions: Vec<FileAction>,
}

impl PlannedFileOperationActions {
    pub(crate) fn progress_action_count(&self) -> usize {
        self.actions.iter().filter(|action| action.counts()).count()
    }

    pub(crate) fn summary(&self) -> FileOperationSummary {
        summarize_actions(&self.actions, self.expanded)
    }
}

pub(crate) fn add_symlink_warnings(groups: &mut [PlannedFileOperationActions]) {
    let created_paths = groups
        .iter()
        .flat_map(|group| group.actions.iter())
        .filter_map(|action| match action {
            FileAction::CreateDirectory { target_path, .. }
            | FileAction::CopyFile { target_path, .. }
            | FileAction::CreateSymlink { target_path, .. } => Some(target_path.clone()),
            FileAction::RepairMetadata { .. }
            | FileAction::Delete { .. }
            | FileAction::Skip { .. }
            | FileAction::Warning { .. } => None,
        })
        .collect::<BTreeSet<_>>();
    for group in groups {
        let warnings = group
            .actions
            .iter()
            .filter_map(|action| match action {
                FileAction::CreateSymlink {
                    target,
                    final_target,
                    ..
                } if !final_target.exists() && !created_paths.contains(final_target) => {
                    Some(FileAction::Warning {
                        path: target.clone(),
                        reason: "symlink target does not exist".to_owned(),
                    })
                }
                _ => None,
            })
            .collect::<Vec<_>>();

        group.actions.extend(warnings);
    }
}

fn summarize_actions(actions: &[FileAction], expanded: bool) -> FileOperationSummary {
    let mut summary = FileOperationSummary {
        expanded,
        ..FileOperationSummary::default()
    };

    for action in actions {
        match action {
            FileAction::CreateDirectory { .. }
            | FileAction::CopyFile { .. }
            | FileAction::CreateSymlink { .. } => summary.changed += 1,
            FileAction::RepairMetadata { report: true, .. } => {
                summary.changed += 1;
                summary.metadata_changed += 1;
            }
            FileAction::RepairMetadata { report: false, .. } => {}
            FileAction::Delete { .. } => summary.deleted += 1,
            FileAction::Skip { reason, .. } => {
                summary.skipped += 1;
                if summary.skip_reason.is_none() {
                    summary.skip_reason = Some(reason.clone());
                }
            }
            FileAction::Warning { .. } => summary.warnings += 1,
        }
    }

    summary
}