posixmq 1.0.0

An idiomatic library for using posix message queues, with optional mio integration
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

#![cfg(not(target_env="musl"))] // returns its own errors

use std::ffi::CStr;
#[cfg(target_os="linux")]
use std::fs;
use std::io::ErrorKind;
#[cfg(target_os="linux")]
use std::os::unix::fs::PermissionsExt;

extern crate posixmq;
use posixmq::{PosixMq, OpenOptions, remove_queue, remove_queue_c};

fn cstr(s: &str) -> &CStr {
    CStr::from_bytes_with_nul(s.as_bytes()).expect("_c name must have trailing '\0'")
}

#[test]
fn name_too_long() {
    assert_eq!(remove_queue(&vec![b'a'; 1000]).unwrap_err().kind(), ErrorKind::Other);
    assert_eq!(PosixMq::create(&vec![b'a'; 1000]).unwrap_err().kind(), ErrorKind::Other);
}

#[cfg(not(any(target_os="netbsd", target_os="dragonfly")))] // allown any name
#[test]
fn remove_invalid_names() {
    assert_eq!(remove_queue("").unwrap_err().kind(), remove_queue("/").unwrap_err().kind(), "\"\"");
    let err = remove_queue("//").unwrap_err().kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput, "//");
    let err = remove_queue("/foo/bar").unwrap_err().kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput, "/foo/bar");
    let err = remove_queue("/foo/").unwrap_err().kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput, "/foo/");
    //assert_eq!(remove_queue("/root").unwrap_err().kind(), ErrorKind::PermissionDenied, "/root");
}

#[cfg(not(any(
    target_os="netbsd", target_os="dragonfly", // allows any name
    target_os="illumos", target_os="solaris", // allows this
)))]
#[test]
fn just_slash() {
    let error = if cfg!(target_os="freebsd") {ErrorKind::InvalidInput} else {ErrorKind::NotFound};
    assert_eq!(remove_queue("/").expect_err("remove /").kind(), error, "remove /");
    assert_eq!(PosixMq::open("/").expect_err("open /").kind(), error, "open /");
    assert_eq!(PosixMq::create("/").expect_err("create /").kind(), error, "create /");
    assert_eq!(
        remove_queue_c(cstr("/\0")).expect_err("remove c /").kind(),
        error,
        "remove c /"
    );
    assert_eq!(
        OpenOptions::readonly().create().open_c(cstr("/\0")).expect_err("create_c /").kind(),
        error,
        "create_c /"
    );
}

#[cfg(not(any(target_os="netbsd", target_os="dragonfly")))] // allown any name
#[test]
fn open_invalid_names() {
    let err = PosixMq::create("//").expect_err("create //").kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput);
    let err = PosixMq::create("/foo/bar").expect_err("create /foo/bar").kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput);
    let err = PosixMq::create("/foo/").expect_err("create /foo/").kind();
    assert!(err == ErrorKind::PermissionDenied  ||  err == ErrorKind::InvalidInput);
}

#[cfg(not(any(
    target_os="netbsd", target_os="dragonfly", // allows any name
    target_os="illumos", target_os="solaris", // allows these
    target_os="freebsd" // can cause kernel panic
)))]
#[test]
fn reserved_names() {
    // That Linux and FreeBSD doesn't like /. and /.. is not that surprising
    // considering that they expose posix message queues through a virtual
    // file system, but not documented either.
    assert_eq!(remove_queue("/.").unwrap_err().kind(), ErrorKind::PermissionDenied, "remove /.");
    assert_eq!(remove_queue("/..").unwrap_err().kind(), ErrorKind::PermissionDenied, "remove /..");
    assert_eq!(PosixMq::open("/.").unwrap_err().kind(), ErrorKind::PermissionDenied, "open /.");
    assert_eq!(PosixMq::open("/..").unwrap_err().kind(), ErrorKind::PermissionDenied, "open /..");
    assert_eq!(PosixMq::create("/.").unwrap_err().kind(), ErrorKind::PermissionDenied, "create /.");
    assert_eq!(PosixMq::create("/..").unwrap_err().kind(), ErrorKind::PermissionDenied, "create /..");
}

#[test]
fn cstr_empty_name() {
    let error = if cfg!(target_os="netbsd") || cfg!(target_os="dragonfly") {
        ErrorKind::NotFound
    } else {
        ErrorKind::InvalidInput
    };
    assert_eq!(remove_queue_c(cstr("\0")).unwrap_err().kind(), error, "remove queue");
    assert_eq!(OpenOptions::readonly().open_c(cstr("\0")).unwrap_err().kind(), error, "open");
    assert_eq!(
        OpenOptions::readonly().create().open_c(cstr("\0")).unwrap_err().kind(),
        ErrorKind::InvalidInput,
        "create"
    );
}

#[cfg(not(any(target_os="netbsd", target_os="dragonfly")))] // allown any name
#[test]
fn cstr_no_slash() {
    let noslash = cstr("noslash\0");
    let err = remove_queue_c(noslash).expect_err("remove noslash").kind();
    assert!(err == ErrorKind::InvalidInput || err == ErrorKind::NotFound, "remove noslash");
    let err = OpenOptions::readonly().create().open_c(noslash).expect_err("create noslash").kind();
    assert_eq!(err, ErrorKind::InvalidInput, "create noslash");
}


#[test]
fn open_invalid_params() {
    assert_eq!(
        OpenOptions::readwrite().capacity(2).max_msg_len(0).create().open("zero_len").unwrap_err().kind(),
        ErrorKind::InvalidInput
    );
    assert_eq!(
        OpenOptions::readwrite().capacity(0).max_msg_len(2).create().open("zero_cap").unwrap_err().kind(),
        ErrorKind::InvalidInput
    );
    assert_eq!(
        OpenOptions::readwrite().capacity(2).max_msg_len(!0).create().open("bad_len").unwrap_err().kind(),
        ErrorKind::InvalidInput
    );
    assert_eq!(
        OpenOptions::readwrite().capacity(!0).max_msg_len(2).create().open("bad_cap").unwrap_err().kind(),
        ErrorKind::InvalidInput
    );
}

#[test]
fn invalid_permissions() {
    let result = OpenOptions::readwrite().mode(!0).create().open("/set_everything");
    let _ = remove_queue("/set_everything");
    // All tested operating systems ignore unknown bits
    result.expect("unknown bits or permissions were not ignored");
}

#[cfg(target_os="linux")]
#[test]
fn default_permissions() {
    let _ = PosixMq::create("/default_permissions").unwrap();
    let metadata = fs::metadata("/dev/mqueue/default_permissions").unwrap();
    let _ = remove_queue("/default_permissions");
    assert_eq!(metadata.permissions().mode() & 0o777, 0o600);
}

#[cfg(target_os="linux")]
#[test]
fn custom_permissions() {
    let _ = OpenOptions::writeonly()
        .mode(0o344) // bits unlikely to be affected by umask
        .create()
        .open("/custom_permissions")
        .unwrap();
    let metadata = fs::metadata("/dev/mqueue/custom_permissions").unwrap();
    let _ = remove_queue("/custom_permissions");
    assert_eq!(metadata.permissions().mode() & 0o777, 0o344);
}