cow.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. #
  2. # BitBake Tests for Copy-on-Write (cow.py)
  3. #
  4. # SPDX-License-Identifier: GPL-2.0-only
  5. #
  6. # Copyright 2006 Holger Freyther <freyther@handhelds.org>
  7. # Copyright (C) 2020 Agilent Technologies, Inc.
  8. #
  9. import io
  10. import re
  11. import sys
  12. import unittest
  13. import contextlib
  14. import collections
  15. from bb.COW import COWDictBase, COWSetBase, COWDictMeta, COWSetMeta
  16. class COWTestCase(unittest.TestCase):
  17. """
  18. Test case for the COW module from mithro
  19. """
  20. def setUp(self):
  21. self._track_warnings = False
  22. self._warning_file = io.StringIO()
  23. self._unhandled_warnings = collections.deque()
  24. COWDictBase.__warn__ = self._warning_file
  25. def tearDown(self):
  26. COWDictBase.__warn__ = sys.stderr
  27. if self._track_warnings:
  28. self._checkAllWarningsRead()
  29. def trackWarnings(self):
  30. self._track_warnings = True
  31. def _collectWarnings(self):
  32. self._warning_file.seek(0)
  33. for warning in self._warning_file:
  34. self._unhandled_warnings.append(warning.rstrip("\n"))
  35. self._warning_file.truncate(0)
  36. self._warning_file.seek(0)
  37. def _checkAllWarningsRead(self):
  38. self._collectWarnings()
  39. self.assertSequenceEqual(self._unhandled_warnings, [])
  40. @contextlib.contextmanager
  41. def checkReportsWarning(self, expected_warning):
  42. self._checkAllWarningsRead()
  43. yield
  44. self._collectWarnings()
  45. warning = self._unhandled_warnings.popleft()
  46. self.assertEqual(warning, expected_warning)
  47. def checkStrOutput(self, obj, expected_levels, expected_keys):
  48. if obj.__class__ is COWDictMeta:
  49. expected_class_name = "COWDict"
  50. elif obj.__class__ is COWSetMeta:
  51. expected_class_name = "COWSet"
  52. else:
  53. self.fail("obj is of unknown type {0}".format(type(obj)))
  54. s = str(obj)
  55. regex = re.compile(r"<(\w+) Level: (\d+) Current Keys: (\d+)>")
  56. match = regex.match(s)
  57. self.assertIsNotNone(match, "bad str output: '{0}'".format(s))
  58. class_name = match.group(1)
  59. self.assertEqual(class_name, expected_class_name)
  60. levels = int(match.group(2))
  61. self.assertEqual(levels, expected_levels, "wrong # levels in str: '{0}'".format(s))
  62. keys = int(match.group(3))
  63. self.assertEqual(keys, expected_keys, "wrong # keys in str: '{0}'".format(s))
  64. def testGetSet(self):
  65. """
  66. Test and set
  67. """
  68. a = COWDictBase.copy()
  69. self.assertEqual(False, 'a' in a)
  70. a['a'] = 'a'
  71. a['b'] = 'b'
  72. self.assertEqual(True, 'a' in a)
  73. self.assertEqual(True, 'b' in a)
  74. self.assertEqual('a', a['a'])
  75. self.assertEqual('b', a['b'])
  76. def testCopyCopy(self):
  77. """
  78. Test the copy of copies
  79. """
  80. # create two COW dict 'instances'
  81. b = COWDictBase.copy()
  82. c = COWDictBase.copy()
  83. # assign some keys to one instance, some keys to another
  84. b['a'] = 10
  85. b['c'] = 20
  86. c['a'] = 30
  87. # test separation of the two instances
  88. self.assertEqual(False, 'c' in c)
  89. self.assertEqual(30, c['a'])
  90. self.assertEqual(10, b['a'])
  91. # test copy
  92. b_2 = b.copy()
  93. c_2 = c.copy()
  94. self.assertEqual(False, 'c' in c_2)
  95. self.assertEqual(10, b_2['a'])
  96. b_2['d'] = 40
  97. self.assertEqual(False, 'd' in c_2)
  98. self.assertEqual(True, 'd' in b_2)
  99. self.assertEqual(40, b_2['d'])
  100. self.assertEqual(False, 'd' in b)
  101. self.assertEqual(False, 'd' in c)
  102. c_2['d'] = 30
  103. self.assertEqual(True, 'd' in c_2)
  104. self.assertEqual(True, 'd' in b_2)
  105. self.assertEqual(30, c_2['d'])
  106. self.assertEqual(40, b_2['d'])
  107. self.assertEqual(False, 'd' in b)
  108. self.assertEqual(False, 'd' in c)
  109. # test copy of the copy
  110. c_3 = c_2.copy()
  111. b_3 = b_2.copy()
  112. b_3_2 = b_2.copy()
  113. c_3['e'] = 4711
  114. self.assertEqual(4711, c_3['e'])
  115. self.assertEqual(False, 'e' in c_2)
  116. self.assertEqual(False, 'e' in b_3)
  117. self.assertEqual(False, 'e' in b_3_2)
  118. self.assertEqual(False, 'e' in b_2)
  119. b_3['e'] = 'viel'
  120. self.assertEqual('viel', b_3['e'])
  121. self.assertEqual(4711, c_3['e'])
  122. self.assertEqual(False, 'e' in c_2)
  123. self.assertEqual(True, 'e' in b_3)
  124. self.assertEqual(False, 'e' in b_3_2)
  125. self.assertEqual(False, 'e' in b_2)
  126. def testCow(self):
  127. self.trackWarnings()
  128. c = COWDictBase.copy()
  129. c['123'] = 1027
  130. c['other'] = 4711
  131. c['d'] = {'abc': 10, 'bcd': 20}
  132. copy = c.copy()
  133. self.assertEqual(1027, c['123'])
  134. self.assertEqual(4711, c['other'])
  135. self.assertEqual({'abc': 10, 'bcd': 20}, c['d'])
  136. self.assertEqual(1027, copy['123'])
  137. self.assertEqual(4711, copy['other'])
  138. with self.checkReportsWarning("Warning: Doing a copy because d is a mutable type."):
  139. self.assertEqual({'abc': 10, 'bcd': 20}, copy['d'])
  140. # cow it now
  141. copy['123'] = 1028
  142. copy['other'] = 4712
  143. copy['d']['abc'] = 20
  144. self.assertEqual(1027, c['123'])
  145. self.assertEqual(4711, c['other'])
  146. self.assertEqual({'abc': 10, 'bcd': 20}, c['d'])
  147. self.assertEqual(1028, copy['123'])
  148. self.assertEqual(4712, copy['other'])
  149. self.assertEqual({'abc': 20, 'bcd': 20}, copy['d'])
  150. def testOriginalTestSuite(self):
  151. # This test suite is a port of the original one from COW.py
  152. self.trackWarnings()
  153. a = COWDictBase.copy()
  154. self.checkStrOutput(a, 1, 0)
  155. a['a'] = 'a'
  156. a['b'] = 'b'
  157. a['dict'] = {}
  158. self.checkStrOutput(a, 1, 4) # 4th member is dict__mutable__
  159. b = a.copy()
  160. self.checkStrOutput(b, 2, 0)
  161. b['c'] = 'b'
  162. self.checkStrOutput(b, 2, 1)
  163. with self.checkReportsWarning("Warning: If you aren't going to change any of the values call with True."):
  164. self.assertListEqual(list(a.iteritems()),
  165. [('a', 'a'),
  166. ('b', 'b'),
  167. ('dict', {})
  168. ])
  169. with self.checkReportsWarning("Warning: If you aren't going to change any of the values call with True."):
  170. b_gen = b.iteritems()
  171. self.assertTupleEqual(next(b_gen), ('a', 'a'))
  172. self.assertTupleEqual(next(b_gen), ('b', 'b'))
  173. self.assertTupleEqual(next(b_gen), ('c', 'b'))
  174. with self.checkReportsWarning("Warning: Doing a copy because dict is a mutable type."):
  175. self.assertTupleEqual(next(b_gen), ('dict', {}))
  176. with self.assertRaises(StopIteration):
  177. next(b_gen)
  178. b['dict']['a'] = 'b'
  179. b['a'] = 'c'
  180. self.checkStrOutput(a, 1, 4)
  181. self.checkStrOutput(b, 2, 3)
  182. with self.checkReportsWarning("Warning: If you aren't going to change any of the values call with True."):
  183. self.assertListEqual(list(a.iteritems()),
  184. [('a', 'a'),
  185. ('b', 'b'),
  186. ('dict', {})
  187. ])
  188. with self.checkReportsWarning("Warning: If you aren't going to change any of the values call with True."):
  189. b_gen = b.iteritems()
  190. self.assertTupleEqual(next(b_gen), ('a', 'c'))
  191. self.assertTupleEqual(next(b_gen), ('b', 'b'))
  192. self.assertTupleEqual(next(b_gen), ('c', 'b'))
  193. self.assertTupleEqual(next(b_gen), ('dict', {'a': 'b'}))
  194. with self.assertRaises(StopIteration):
  195. next(b_gen)
  196. with self.assertRaises(KeyError):
  197. print(b["dict2"])
  198. a['set'] = COWSetBase()
  199. a['set'].add("o1")
  200. a['set'].add("o1")
  201. a['set'].add("o2")
  202. self.assertSetEqual(set(a['set'].itervalues()), {"o1", "o2"})
  203. self.assertSetEqual(set(b['set'].itervalues()), {"o1", "o2"})
  204. b['set'].add('o3')
  205. self.assertSetEqual(set(a['set'].itervalues()), {"o1", "o2"})
  206. self.assertSetEqual(set(b['set'].itervalues()), {"o1", "o2", "o3"})
  207. a['set2'] = set()
  208. a['set2'].add("o1")
  209. a['set2'].add("o1")
  210. a['set2'].add("o2")
  211. # We don't expect 'a' to change anymore
  212. def check_a():
  213. with self.checkReportsWarning("Warning: If you aren't going to change any of the values call with True."):
  214. a_gen = a.iteritems()
  215. self.assertTupleEqual(next(a_gen), ('a', 'a'))
  216. self.assertTupleEqual(next(a_gen), ('b', 'b'))
  217. self.assertTupleEqual(next(a_gen), ('dict', {}))
  218. self.assertTupleEqual(next(a_gen), ('set2', {'o1', 'o2'}))
  219. a_sub_set = next(a_gen)
  220. self.assertEqual(a_sub_set[0], 'set')
  221. self.checkStrOutput(a_sub_set[1], 1, 2)
  222. self.assertSetEqual(set(a_sub_set[1].itervalues()), {'o1', 'o2'})
  223. check_a()
  224. b_gen = b.iteritems(readonly=True)
  225. self.assertTupleEqual(next(b_gen), ('a', 'c'))
  226. self.assertTupleEqual(next(b_gen), ('b', 'b'))
  227. self.assertTupleEqual(next(b_gen), ('c', 'b'))
  228. self.assertTupleEqual(next(b_gen), ('dict', {'a': 'b'}))
  229. self.assertTupleEqual(next(b_gen), ('set2', {'o1', 'o2'}))
  230. b_sub_set = next(b_gen)
  231. self.assertEqual(b_sub_set[0], 'set')
  232. self.checkStrOutput(b_sub_set[1], 2, 1)
  233. self.assertSetEqual(set(b_sub_set[1].itervalues()), {'o1', 'o2', 'o3'})
  234. del b['b']
  235. with self.assertRaises(KeyError):
  236. print(b['b'])
  237. self.assertFalse('b' in b)
  238. check_a()
  239. b.__revertitem__('b')
  240. check_a()
  241. self.assertEqual(b['b'], 'b')
  242. self.assertTrue('b' in b)
  243. b.__revertitem__('dict')
  244. check_a()
  245. b_gen = b.iteritems(readonly=True)
  246. self.assertTupleEqual(next(b_gen), ('a', 'c'))
  247. self.assertTupleEqual(next(b_gen), ('b', 'b'))
  248. self.assertTupleEqual(next(b_gen), ('c', 'b'))
  249. self.assertTupleEqual(next(b_gen), ('dict', {}))
  250. self.assertTupleEqual(next(b_gen), ('set2', {'o1', 'o2'}))
  251. b_sub_set = next(b_gen)
  252. self.assertEqual(b_sub_set[0], 'set')
  253. self.checkStrOutput(b_sub_set[1], 2, 1)
  254. self.assertSetEqual(set(b_sub_set[1].itervalues()), {'o1', 'o2', 'o3'})
  255. self.checkStrOutput(a, 1, 6)
  256. self.checkStrOutput(b, 2, 3)
  257. def testSetMethods(self):
  258. s = COWSetBase()
  259. with self.assertRaises(TypeError):
  260. print(s.iteritems())
  261. with self.assertRaises(TypeError):
  262. print(s.iterkeys())