blob: c13a7c9294f983d2ecd3037cf8f1803370172cbe [file] [log] [blame]
Collin Winterb24ef192010-03-18 00:23:44 +00001import sys
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +00002import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003from test import support
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +00004
R. David Murraya21e4ca2009-03-31 23:16:50 +00005pwd = support.import_module('pwd')
Barry Warsaw3d070fb1996-12-11 16:53:51 +00006
xdegaye76fdac42017-11-25 17:32:27 +01007@unittest.skipUnless(hasattr(pwd, 'getpwall'), 'Does not have getpwall()')
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +00008class PwdTest(unittest.TestCase):
Barry Warsaw3d070fb1996-12-11 16:53:51 +00009
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000010 def test_values(self):
xdegaye76fdac42017-11-25 17:32:27 +010011 entries = pwd.getpwall()
Barry Warsaw3d070fb1996-12-11 16:53:51 +000012
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000013 for e in entries:
14 self.assertEqual(len(e), 7)
15 self.assertEqual(e[0], e.pw_name)
Ezio Melottie9615932010-01-24 19:26:24 +000016 self.assertIsInstance(e.pw_name, str)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000017 self.assertEqual(e[1], e.pw_passwd)
Ezio Melottie9615932010-01-24 19:26:24 +000018 self.assertIsInstance(e.pw_passwd, str)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000019 self.assertEqual(e[2], e.pw_uid)
Ezio Melottie9615932010-01-24 19:26:24 +000020 self.assertIsInstance(e.pw_uid, int)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000021 self.assertEqual(e[3], e.pw_gid)
Ezio Melottie9615932010-01-24 19:26:24 +000022 self.assertIsInstance(e.pw_gid, int)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000023 self.assertEqual(e[4], e.pw_gecos)
Ezio Melottie9615932010-01-24 19:26:24 +000024 self.assertIsInstance(e.pw_gecos, str)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000025 self.assertEqual(e[5], e.pw_dir)
Ezio Melottie9615932010-01-24 19:26:24 +000026 self.assertIsInstance(e.pw_dir, str)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000027 self.assertEqual(e[6], e.pw_shell)
Ezio Melottie9615932010-01-24 19:26:24 +000028 self.assertIsInstance(e.pw_shell, str)
Barry Warsaw3d070fb1996-12-11 16:53:51 +000029
Walter Dörwald66e1e502003-04-15 15:39:08 +000030 # The following won't work, because of duplicate entries
31 # for one uid
32 # self.assertEqual(pwd.getpwuid(e.pw_uid), e)
33 # instead of this collect all entries for one uid
Zachary Ware9fe6d862013-12-08 00:20:35 -060034 # and check afterwards (done in test_values_extended)
35
36 def test_values_extended(self):
xdegaye76fdac42017-11-25 17:32:27 +010037 entries = pwd.getpwall()
Zachary Ware9fe6d862013-12-08 00:20:35 -060038 entriesbyname = {}
39 entriesbyuid = {}
40
41 if len(entries) > 1000: # Huge passwd file (NIS?) -- skip this test
42 self.skipTest('passwd file is huge; extended test skipped')
43
44 for e in entries:
Walter Dörwaldecd2fdc2003-04-22 11:05:57 +000045 entriesbyname.setdefault(e.pw_name, []).append(e)
Walter Dörwald66e1e502003-04-15 15:39:08 +000046 entriesbyuid.setdefault(e.pw_uid, []).append(e)
47
48 # check whether the entry returned by getpwuid()
49 # for each uid is among those from getpwall() for this uid
50 for e in entries:
Fredrik Lundh0e664e12005-12-12 20:53:40 +000051 if not e[0] or e[0] == '+':
52 continue # skip NIS entries etc.
Benjamin Peterson577473f2010-01-19 00:09:57 +000053 self.assertIn(pwd.getpwnam(e.pw_name), entriesbyname[e.pw_name])
54 self.assertIn(pwd.getpwuid(e.pw_uid), entriesbyuid[e.pw_uid])
Fred Drake004d5e62000-10-23 17:22:08 +000055
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000056 def test_errors(self):
57 self.assertRaises(TypeError, pwd.getpwuid)
Serhiy Storchaka55e22382013-02-11 20:32:47 +020058 self.assertRaises(TypeError, pwd.getpwuid, 3.14)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000059 self.assertRaises(TypeError, pwd.getpwnam)
Serhiy Storchaka55e22382013-02-11 20:32:47 +020060 self.assertRaises(TypeError, pwd.getpwnam, 42)
xdegaye76fdac42017-11-25 17:32:27 +010061 self.assertRaises(TypeError, pwd.getpwall, 42)
Barry Warsaw3d070fb1996-12-11 16:53:51 +000062
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000063 # try to get some errors
64 bynames = {}
65 byuids = {}
xdegaye76fdac42017-11-25 17:32:27 +010066 for (n, p, u, g, gecos, d, s) in pwd.getpwall():
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000067 bynames[n] = u
68 byuids[u] = n
Barry Warsaw3d070fb1996-12-11 16:53:51 +000069
Guido van Rossum9afbb4e2007-02-11 18:54:18 +000070 allnames = list(bynames.keys())
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000071 namei = 0
72 fakename = allnames[namei]
73 while fakename in bynames:
Guido van Rossumc1f779c2007-07-03 08:25:58 +000074 chars = list(fakename)
Guido van Rossum805365e2007-05-07 22:24:25 +000075 for i in range(len(chars)):
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000076 if chars[i] == 'z':
77 chars[i] = 'A'
78 break
79 elif chars[i] == 'Z':
80 continue
81 else:
82 chars[i] = chr(ord(chars[i]) + 1)
83 break
84 else:
85 namei = namei + 1
86 try:
87 fakename = allnames[namei]
88 except IndexError:
89 # should never happen... if so, just forget it
90 break
Guido van Rossumc1f779c2007-07-03 08:25:58 +000091 fakename = ''.join(chars)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +000092
93 self.assertRaises(KeyError, pwd.getpwnam, fakename)
94
Collin Winterb24ef192010-03-18 00:23:44 +000095 # In some cases, byuids isn't a complete list of all users in the
96 # system, so if we try to pick a value not in byuids (via a perturbing
97 # loop, say), pwd.getpwuid() might still be able to find data for that
98 # uid. Using sys.maxint may provoke the same problems, but hopefully
99 # it will be a more repeatable failure.
100 fakeuid = sys.maxsize
101 self.assertNotIn(fakeuid, byuids)
xdegaye76fdac42017-11-25 17:32:27 +0100102 self.assertRaises(KeyError, pwd.getpwuid, fakeuid)
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +0000103
Serhiy Storchaka55e22382013-02-11 20:32:47 +0200104 # -1 shouldn't be a valid uid because it has a special meaning in many
105 # uid-related functions
xdegaye76fdac42017-11-25 17:32:27 +0100106 self.assertRaises(KeyError, pwd.getpwuid, -1)
Serhiy Storchaka55e22382013-02-11 20:32:47 +0200107 # should be out of uid_t range
108 self.assertRaises(KeyError, pwd.getpwuid, 2**128)
109 self.assertRaises(KeyError, pwd.getpwuid, -2**128)
110
Walter Dörwaldb1ded1e2003-04-15 11:10:33 +0000111if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -0500112 unittest.main()