xattr 1.6.1

unix extended filesystem attributes
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

use std::collections::BTreeSet;
use std::ffi::OsStr;
use xattr::FileExt;

use tempfile::{tempfile, tempfile_in, NamedTempFile};

#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_fd() {
    use std::os::unix::ffi::OsStrExt;
    let tmp = tempfile().unwrap();
    assert!(tmp.get_xattr("user.test").unwrap().is_none());
    assert_eq!(
        tmp.list_xattr()
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );

    tmp.set_xattr("user.test", b"my test").unwrap();
    assert_eq!(tmp.get_xattr("user.test").unwrap().unwrap(), b"my test");
    assert_eq!(
        tmp.list_xattr()
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .collect::<Vec<_>>(),
        vec![OsStr::new("user.test")]
    );

    tmp.remove_xattr("user.test").unwrap();
    assert!(tmp.get_xattr("user.test").unwrap().is_none());
    assert_eq!(
        tmp.list_xattr()
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );
}

#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_path() {
    use std::os::unix::ffi::OsStrExt;
    let tmp = NamedTempFile::new().unwrap();
    assert!(xattr::get(tmp.path(), "user.test").unwrap().is_none());
    assert_eq!(
        xattr::list(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );

    xattr::set(tmp.path(), "user.test", b"my test").unwrap();
    assert_eq!(
        xattr::get(tmp.path(), "user.test").unwrap().unwrap(),
        b"my test"
    );
    assert_eq!(
        xattr::list(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .collect::<Vec<_>>(),
        vec![OsStr::new("user.test")]
    );

    xattr::remove(tmp.path(), "user.test").unwrap();
    assert!(xattr::get(tmp.path(), "user.test").unwrap().is_none());
    assert_eq!(
        xattr::list(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );
}

#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_missing() {
    assert!(xattr::get("/var/empty/does-not-exist", "user.test").is_err());
}

#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_debug() {
    use std::os::unix::ffi::OsStrExt;

    // Only works on "real" filesystems.
    let tmp = tempfile().unwrap();

    tmp.set_xattr("user.myattr", b"value").unwrap();
    let mut attrs = tmp.list_xattr().unwrap();

    let debugstr = format!("{:?}", attrs);

    // Debug is idempotent
    assert_eq!(debugstr, format!("{:?}", attrs));

    // It produces the right value. We can't just assert that it's equal to the expected value as
    // the system may have added additional attributes (selinux, etc.). See #68.
    assert!(debugstr.starts_with("XAttrs(["));
    assert!(debugstr.ends_with("])"));
    assert!(debugstr.contains(r#""user.myattr""#));

    // It doesn't affect the underlying iterator.
    assert_eq!(
        "user.myattr",
        attrs.find(|x| x.as_bytes().starts_with(b"user.")).unwrap()
    );

    // drain it.
    let _ = attrs.by_ref().count();

    // An empty iterator produces the right value.
    assert_eq!(r#"XAttrs([])"#, format!("{:?}", attrs));
}

#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_multi() {
    use std::os::unix::ffi::OsStrExt;
    // Only works on "real" filesystems.
    let tmp = tempfile().unwrap();
    let mut items: BTreeSet<_> = [
        OsStr::new("user.test1"),
        OsStr::new("user.test2"),
        OsStr::new("user.test3"),
    ]
    .iter()
    .cloned()
    .collect();

    for it in &items {
        tmp.set_xattr(it, b"value").unwrap();
    }
    for it in tmp
        .list_xattr()
        .unwrap()
        .filter(|x| x.as_bytes().starts_with(b"user."))
    {
        assert!(items.remove(&*it));
    }
    assert!(items.is_empty());
}

// This test is skipped on android because the /data/tmp filesystem doesn't support >4kib of
// extended attributes.
#[test]
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "macos"))]
fn test_large() {
    use std::ffi::OsString;
    use std::os::unix::ffi::OsStrExt;
    // On Linux, this only works in tmpfs!
    let tmp = if cfg!(target_os = "linux") {
        tempfile_in("/dev/shm")
    } else {
        tempfile()
    }
    .unwrap();
    let mut items: BTreeSet<OsString> = (0..100)
        .map(|i| format!("user.test{i:0100}").into())
        .collect();

    for it in &items {
        tmp.set_xattr(it, b"value").unwrap();
    }
    for it in tmp
        .list_xattr()
        .unwrap()
        .filter(|x| x.as_bytes().starts_with(b"user."))
    {
        assert!(items.remove(&*it));
    }
    assert!(items.is_empty());
}

// Tests the deref API variants - regression test for
// https://github.com/Stebalien/xattr/issues/57
#[test]
#[cfg(any(
    target_os = "linux",
    target_os = "freebsd",
    target_os = "macos",
    target_os = "android"
))]
fn test_path_deref() {
    use std::os::unix::ffi::OsStrExt;
    // Only works on "real" filesystems.
    let tmp = NamedTempFile::new().unwrap();
    assert!(xattr::get_deref(tmp.path(), "user.test").unwrap().is_none());
    assert_eq!(
        xattr::list_deref(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );

    xattr::set_deref(tmp.path(), "user.test", b"my test").unwrap();
    assert_eq!(
        xattr::get_deref(tmp.path(), "user.test").unwrap().unwrap(),
        b"my test"
    );
    assert_eq!(
        xattr::list_deref(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .collect::<Vec<_>>(),
        vec![OsStr::new("user.test")]
    );

    xattr::remove_deref(tmp.path(), "user.test").unwrap();
    assert!(xattr::get_deref(tmp.path(), "user.test").unwrap().is_none());
    assert_eq!(
        xattr::list_deref(tmp.path())
            .unwrap()
            .filter(|x| x.as_bytes().starts_with(b"user."))
            .count(),
        0
    );
}