Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 1 | """Test script for the dbm.open function based on testdumbdbm.py""" |
| 2 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 3 | import unittest |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 4 | import glob |
| 5 | import test.support |
| 6 | |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 7 | # Skip tests if dbm module doesn't exist. |
| 8 | dbm = test.support.import_module('dbm') |
| 9 | |
Ezio Melotti | b08495b | 2013-07-07 13:15:08 +0200 | [diff] [blame] | 10 | try: |
| 11 | from dbm import ndbm |
| 12 | except ImportError: |
| 13 | ndbm = None |
| 14 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 15 | _fname = test.support.TESTFN |
| 16 | |
| 17 | # |
| 18 | # Iterates over every database module supported by dbm currently available, |
| 19 | # setting dbm to use each in turn, and yielding that module |
| 20 | # |
| 21 | def dbm_iterator(): |
Georg Brandl | b17acad | 2008-05-28 08:43:17 +0000 | [diff] [blame] | 22 | for name in dbm._names: |
| 23 | try: |
| 24 | mod = __import__(name, fromlist=['open']) |
| 25 | except ImportError: |
| 26 | continue |
| 27 | dbm._modules[name] = mod |
| 28 | yield mod |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 29 | |
| 30 | # |
| 31 | # Clean up all scratch databases we might have created during testing |
| 32 | # |
| 33 | def delete_files(): |
| 34 | # we don't know the precise name the underlying database uses |
| 35 | # so we use glob to locate all names |
| 36 | for f in glob.glob(_fname + "*"): |
| 37 | test.support.unlink(f) |
| 38 | |
| 39 | |
Ezio Melotti | f79493b | 2013-03-01 11:23:28 +0200 | [diff] [blame] | 40 | class AnyDBMTestCase: |
Serhiy Storchaka | 70af06c | 2018-04-29 15:45:03 +0300 | [diff] [blame] | 41 | _dict = {'a': b'Python:', |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 42 | 'b': b'Programming', |
| 43 | 'c': b'the', |
| 44 | 'd': b'way', |
| 45 | 'f': b'Guido', |
| 46 | 'g': b'intended', |
| 47 | } |
| 48 | |
Georg Brandl | b17acad | 2008-05-28 08:43:17 +0000 | [diff] [blame] | 49 | def init_db(self): |
| 50 | f = dbm.open(_fname, 'n') |
| 51 | for k in self._dict: |
| 52 | f[k.encode("ascii")] = self._dict[k] |
| 53 | f.close() |
| 54 | |
| 55 | def keys_helper(self, f): |
| 56 | keys = sorted(k.decode("ascii") for k in f.keys()) |
| 57 | dkeys = sorted(self._dict.keys()) |
| 58 | self.assertEqual(keys, dkeys) |
| 59 | return keys |
| 60 | |
| 61 | def test_error(self): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 62 | self.assertTrue(issubclass(self.module.error, OSError)) |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 63 | |
Amaury Forgeot d'Arc | b5cf301 | 2008-09-25 22:27:43 +0000 | [diff] [blame] | 64 | def test_anydbm_not_existing(self): |
| 65 | self.assertRaises(dbm.error, dbm.open, _fname) |
| 66 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 67 | def test_anydbm_creation(self): |
| 68 | f = dbm.open(_fname, 'c') |
| 69 | self.assertEqual(list(f.keys()), []) |
| 70 | for key in self._dict: |
| 71 | f[key.encode("ascii")] = self._dict[key] |
| 72 | self.read_helper(f) |
| 73 | f.close() |
| 74 | |
briancurtin | 525c25d | 2011-03-14 16:03:54 -0400 | [diff] [blame] | 75 | def test_anydbm_creation_n_file_exists_with_invalid_contents(self): |
Victor Stinner | bf81622 | 2011-06-30 23:25:47 +0200 | [diff] [blame] | 76 | # create an empty file |
| 77 | test.support.create_empty_file(_fname) |
Serhiy Storchaka | 6592d7f | 2018-06-05 16:03:00 +0300 | [diff] [blame] | 78 | with dbm.open(_fname, 'n') as f: |
| 79 | self.assertEqual(len(f), 0) |
briancurtin | 525c25d | 2011-03-14 16:03:54 -0400 | [diff] [blame] | 80 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 81 | def test_anydbm_modification(self): |
| 82 | self.init_db() |
| 83 | f = dbm.open(_fname, 'c') |
| 84 | self._dict['g'] = f[b'g'] = b"indented" |
| 85 | self.read_helper(f) |
Serhiy Storchaka | 2e38cc3 | 2018-04-29 12:38:06 +0300 | [diff] [blame] | 86 | # setdefault() works as in the dict interface |
| 87 | self.assertEqual(f.setdefault(b'xxx', b'foo'), b'foo') |
| 88 | self.assertEqual(f[b'xxx'], b'foo') |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 89 | f.close() |
| 90 | |
| 91 | def test_anydbm_read(self): |
| 92 | self.init_db() |
| 93 | f = dbm.open(_fname, 'r') |
| 94 | self.read_helper(f) |
Serhiy Storchaka | 2e38cc3 | 2018-04-29 12:38:06 +0300 | [diff] [blame] | 95 | # get() works as in the dict interface |
| 96 | self.assertEqual(f.get(b'a'), self._dict['a']) |
| 97 | self.assertEqual(f.get(b'xxx', b'foo'), b'foo') |
| 98 | self.assertIsNone(f.get(b'xxx')) |
| 99 | with self.assertRaises(KeyError): |
| 100 | f[b'xxx'] |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 101 | f.close() |
| 102 | |
| 103 | def test_anydbm_keys(self): |
| 104 | self.init_db() |
| 105 | f = dbm.open(_fname, 'r') |
| 106 | keys = self.keys_helper(f) |
| 107 | f.close() |
| 108 | |
Serhiy Storchaka | 70af06c | 2018-04-29 15:45:03 +0300 | [diff] [blame] | 109 | def test_empty_value(self): |
| 110 | if getattr(dbm._defaultmod, 'library', None) == 'Berkeley DB': |
| 111 | self.skipTest("Berkeley DB doesn't distinguish the empty value " |
| 112 | "from the absent one") |
| 113 | f = dbm.open(_fname, 'c') |
| 114 | self.assertEqual(f.keys(), []) |
| 115 | f[b'empty'] = b'' |
| 116 | self.assertEqual(f.keys(), [b'empty']) |
| 117 | self.assertIn(b'empty', f) |
| 118 | self.assertEqual(f[b'empty'], b'') |
| 119 | self.assertEqual(f.get(b'empty'), b'') |
| 120 | self.assertEqual(f.setdefault(b'empty'), b'') |
| 121 | f.close() |
| 122 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 123 | def test_anydbm_access(self): |
| 124 | self.init_db() |
| 125 | f = dbm.open(_fname, 'r') |
| 126 | key = "a".encode("ascii") |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 127 | self.assertIn(key, f) |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 128 | assert(f[key] == b"Python:") |
| 129 | f.close() |
| 130 | |
| 131 | def read_helper(self, f): |
| 132 | keys = self.keys_helper(f) |
| 133 | for key in self._dict: |
| 134 | self.assertEqual(self._dict[key], f[key.encode("ascii")]) |
| 135 | |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 136 | def tearDown(self): |
| 137 | delete_files() |
| 138 | |
| 139 | def setUp(self): |
Georg Brandl | b17acad | 2008-05-28 08:43:17 +0000 | [diff] [blame] | 140 | dbm._defaultmod = self.module |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 141 | delete_files() |
| 142 | |
| 143 | |
| 144 | class WhichDBTestCase(unittest.TestCase): |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 145 | def test_whichdb(self): |
| 146 | for module in dbm_iterator(): |
| 147 | # Check whether whichdb correctly guesses module name |
| 148 | # for databases opened with "module" module. |
| 149 | # Try with empty files first |
| 150 | name = module.__name__ |
| 151 | if name == 'dbm.dumb': |
| 152 | continue # whichdb can't support dbm.dumb |
Senthil Kumaran | 725c2b9 | 2011-02-26 07:11:27 +0000 | [diff] [blame] | 153 | delete_files() |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 154 | f = module.open(_fname, 'c') |
| 155 | f.close() |
Ezio Melotti | b08495b | 2013-07-07 13:15:08 +0200 | [diff] [blame] | 156 | self.assertEqual(name, self.dbm.whichdb(_fname)) |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 157 | # Now add a key |
| 158 | f = module.open(_fname, 'w') |
| 159 | f[b"1"] = b"1" |
| 160 | # and test that we can find it |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 161 | self.assertIn(b"1", f) |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 162 | # and read it |
Serhiy Storchaka | 22525de | 2018-06-19 13:31:48 +0300 | [diff] [blame] | 163 | self.assertEqual(f[b"1"], b"1") |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 164 | f.close() |
Ezio Melotti | b08495b | 2013-07-07 13:15:08 +0200 | [diff] [blame] | 165 | self.assertEqual(name, self.dbm.whichdb(_fname)) |
| 166 | |
| 167 | @unittest.skipUnless(ndbm, reason='Test requires ndbm') |
| 168 | def test_whichdb_ndbm(self): |
| 169 | # Issue 17198: check that ndbm which is referenced in whichdb is defined |
| 170 | db_file = '{}_ndbm.db'.format(_fname) |
| 171 | with open(db_file, 'w'): |
| 172 | self.addCleanup(test.support.unlink, db_file) |
| 173 | self.assertIsNone(self.dbm.whichdb(db_file[:-3])) |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 174 | |
| 175 | def tearDown(self): |
| 176 | delete_files() |
| 177 | |
| 178 | def setUp(self): |
| 179 | delete_files() |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 180 | self.filename = test.support.TESTFN |
| 181 | self.d = dbm.open(self.filename, 'c') |
| 182 | self.d.close() |
Ezio Melotti | b08495b | 2013-07-07 13:15:08 +0200 | [diff] [blame] | 183 | self.dbm = test.support.import_fresh_module('dbm') |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 184 | |
| 185 | def test_keys(self): |
| 186 | self.d = dbm.open(self.filename, 'c') |
| 187 | self.assertEqual(self.d.keys(), []) |
| 188 | a = [(b'a', b'b'), (b'12345678910', b'019237410982340912840198242')] |
| 189 | for k, v in a: |
| 190 | self.d[k] = v |
| 191 | self.assertEqual(sorted(self.d.keys()), sorted(k for (k, v) in a)) |
| 192 | for k, v in a: |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 193 | self.assertIn(k, self.d) |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 194 | self.assertEqual(self.d[k], v) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 195 | self.assertNotIn(b'xxx', self.d) |
Benjamin Peterson | 1bc15c2 | 2008-10-11 02:19:18 +0000 | [diff] [blame] | 196 | self.assertRaises(KeyError, lambda: self.d[b'xxx']) |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 197 | self.d.close() |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 198 | |
| 199 | |
Ezio Melotti | f79493b | 2013-03-01 11:23:28 +0200 | [diff] [blame] | 200 | def load_tests(loader, tests, pattern): |
| 201 | classes = [] |
Georg Brandl | b17acad | 2008-05-28 08:43:17 +0000 | [diff] [blame] | 202 | for mod in dbm_iterator(): |
Ezio Melotti | f79493b | 2013-03-01 11:23:28 +0200 | [diff] [blame] | 203 | classes.append(type("TestCase-" + mod.__name__, |
| 204 | (AnyDBMTestCase, unittest.TestCase), |
Georg Brandl | b17acad | 2008-05-28 08:43:17 +0000 | [diff] [blame] | 205 | {'module': mod})) |
Ezio Melotti | f79493b | 2013-03-01 11:23:28 +0200 | [diff] [blame] | 206 | suites = [unittest.makeSuite(c) for c in classes] |
| 207 | |
| 208 | tests.addTests(suites) |
| 209 | return tests |
Georg Brandl | 7f986ac | 2008-05-26 10:30:20 +0000 | [diff] [blame] | 210 | |
| 211 | if __name__ == "__main__": |
Ezio Melotti | f79493b | 2013-03-01 11:23:28 +0200 | [diff] [blame] | 212 | unittest.main() |