users 0.4.3

Library for getting information on Unix users and groups
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

//! Mockable users and groups.
//!
//! When you're testing your code, you don't want to actually rely on the
//! system actually having various users and groups present - it's much better
//! to have a custom set of users that are *guaranteed* to be there, so you can
//! test against them.
//!
//! This sub-library allows you to create these custom users and groups
//! definitions, then access them using the same `Users` trait as in the main
//! library, with few changes to your code.
//!
//! Creating Mock Users
//! -------------------
//!
//! The only thing a mock users object needs to know in advance is the UID of
//! the current user. Aside from that, you can add users and groups with
//! `add_user` and `add_group` to the object:
//!
//! ```
//! use users::mock::{MockUsers, User, Group};
//! let mut users = MockUsers::with_current_uid(1000);
//! users.add_user(User { uid: 1000, name: "Bobbins".to_string(), primary_group: 100, home_dir: "/home/bobbins".to_string(), shell: "/bin/bash".to_string() });
//! users.add_group(Group { gid: 100, name: "funkyppl".to_string(), members: vec![ "other_person".to_string() ] });
//! ```
//!
//! The exports get re-exported into the mock module, for simpler `use` lines.
//!
//! Using Mock Users
//! ----------------
//!
//! To set your program up to use either type of Users object, make your
//! functions and structs accept a generic parameter that implements the `Users`
//! trait. Then, you can pass in an object of either OS or Mock type.
//!
//! Here's a complete example:
//!
//! ```
//! use users::{Users, OSUsers, User};
//! use users::mock::MockUsers;
//!
//! fn print_current_username<U: Users>(users: &mut U) {
//!     println!("Current user: {:?}", users.get_current_username());
//! }
//!
//! let mut users = MockUsers::with_current_uid(1001);
//! users.add_user(User { uid: 1001, name: "fred".to_string(), primary_group: 101 , home_dir: "/home/fred".to_string(), shell: "/bin/bash".to_string()});
//! print_current_username(&mut users);
//!
//! let mut actual_users = OSUsers::empty_cache();
//! print_current_username(&mut actual_users);
//! ```

pub use super::{Users, User, Group};
use std::collections::HashMap;
use libc::{uid_t, gid_t};

/// A mocking users object that you can add your own users and groups to.
pub struct MockUsers {
    users: HashMap<uid_t, User>,
    groups: HashMap<gid_t, Group>,
    uid: uid_t,
}

impl MockUsers {
    /// Create a new, empty mock users object.
    pub fn with_current_uid(current_uid: uid_t) -> MockUsers {
        MockUsers {
            users: HashMap::new(),
            groups: HashMap::new(),
            uid: current_uid,
        }
    }

    /// Add a user to the users table.
    pub fn add_user(&mut self, user: User) -> Option<User> {
        self.users.insert(user.uid, user)
    }

    /// Add a group to the groups table.
    pub fn add_group(&mut self, group: Group) -> Option<Group> {
        self.groups.insert(group.gid, group)
    }
}

impl Users for MockUsers {
    fn get_user_by_uid(&mut self, uid: uid_t) -> Option<User> {
        self.users.get(&uid).cloned()
    }

    fn get_user_by_name(&mut self, username: &str) -> Option<User> {
        self.users.values().find(|u| u.name == username).cloned()
    }

    fn get_group_by_gid(&mut self, gid: gid_t) -> Option<Group> {
        self.groups.get(&gid).cloned()
    }

    fn get_group_by_name(&mut self, group_name: &str) -> Option<Group> {
        self.groups.values().find(|g| g.name == group_name).cloned()
    }

    fn get_current_uid(&mut self) -> uid_t {
        self.uid
    }

    fn get_current_username(&mut self) -> Option<String> {
        self.users.get(&self.uid).map(|u| u.name.clone())
    }

    fn get_current_gid(&mut self) -> uid_t {
        self.uid
    }

    fn get_current_groupname(&mut self) -> Option<String> {
        self.groups.get(&self.uid).map(|u| u.name.clone())
    }

    fn get_effective_uid(&mut self) -> uid_t {
        self.uid
    }

    fn get_effective_username(&mut self) -> Option<String> {
        self.users.get(&self.uid).map(|u| u.name.clone())
    }

    fn get_effective_gid(&mut self) -> uid_t {
        self.uid
    }

    fn get_effective_groupname(&mut self) -> Option<String> {
        self.groups.get(&self.uid).map(|u| u.name.clone())
    }
}

#[cfg(test)]
mod test {
    use super::{Users, User, Group, MockUsers};

    #[test]
    fn current_username() {
        let mut users = MockUsers::with_current_uid(1337);
        users.add_user(User { uid: 1337, name: "fred".to_string(), primary_group: 101, home_dir: "/home/fred".to_string(), shell: "/bin/bash".to_string() });
        assert_eq!(Some("fred".to_string()), users.get_current_username())
    }

    #[test]
    fn no_current_username() {
        let mut users = MockUsers::with_current_uid(1337);
        assert_eq!(None, users.get_current_username())
    }

    #[test]
    fn uid() {
        let mut users = MockUsers::with_current_uid(0);
        users.add_user(User { uid: 1337, name: "fred".to_string(), primary_group: 101, home_dir: "/home/fred".to_string(), shell: "/bin/bash".to_string() });
        assert_eq!(Some("fred".to_string()), users.get_user_by_uid(1337).map(|u| u.name))
    }

    #[test]
    fn username() {
        let mut users = MockUsers::with_current_uid(1337);
        users.add_user(User { uid: 1440, name: "fred".to_string(), primary_group: 101, home_dir: "/home/fred".to_string(), shell: "/bin/bash".to_string() });
        assert_eq!(Some(1440), users.get_user_by_name("fred").map(|u| u.uid))
    }

    #[test]
    fn no_username() {
        let mut users = MockUsers::with_current_uid(1337);
        users.add_user(User { uid: 1440, name: "fred".to_string(), primary_group: 101, home_dir: "/home/fred".to_string(), shell: "/bin/bash".to_string() });
        assert_eq!(None, users.get_user_by_name("criminy").map(|u| u.uid))
    }

    #[test]
    fn no_uid() {
        let mut users = MockUsers::with_current_uid(0);
        assert_eq!(None, users.get_user_by_uid(1337).map(|u| u.name))
    }

    #[test]
    fn gid() {
        let mut users = MockUsers::with_current_uid(0);
        users.add_group(Group { gid: 1337, name: "fred".to_string(), members: vec![], });
        assert_eq!(Some("fred".to_string()), users.get_group_by_gid(1337).map(|g| g.name))
    }

    #[test]
    fn group_name() {
        let mut users = MockUsers::with_current_uid(0);
        users.add_group(Group { gid: 1337, name: "fred".to_string(), members: vec![], });
        assert_eq!(Some(1337), users.get_group_by_name("fred").map(|g| g.gid))
    }

    #[test]
    fn no_group_name() {
        let mut users = MockUsers::with_current_uid(0);
        users.add_group(Group { gid: 1337, name: "fred".to_string(), members: vec![], });
        assert_eq!(None, users.get_group_by_name("santa").map(|g| g.gid))
    }

    #[test]
    fn no_gid() {
        let mut users = MockUsers::with_current_uid(0);
        assert_eq!(None, users.get_group_by_gid(1337).map(|g| g.name))
    }
}