openerp/addons/base/tests/test_orm.py

   1 from collections import defaultdict
   2 from openerp.tools import mute_logger
   3 from openerp.tests import common
   4
   5 UID = common.ADMIN_USER_ID
   6 DB = common.DB
   7
   8
   9 class TestORM(common.TransactionCase):
  10     """ test special behaviors of ORM CRUD functions
  11
  12         TODO: use real Exceptions types instead of Exception """
  13
  14     def setUp(self):
  15         super(TestORM, self).setUp()
  16         cr, uid = self.cr, self.uid
  17         self.partner = self.registry('res.partner')
  18         self.users = self.registry('res.users')
  19         self.p1 = self.partner.name_create(cr, uid, 'W')[0]
  20         self.p2 = self.partner.name_create(cr, uid, 'Y')[0]
  21         self.ir_rule = self.registry('ir.rule')
  22
  23         # sample unprivileged user
  24         employee_gid = self.ref('base.group_user')
  25         self.uid2 = self.users.create(cr, uid, {'name': 'test user', 'login': 'test', 'groups_id': [4,employee_gid]})
  26
  27     @mute_logger('openerp.models')
  28     def testAccessDeletedRecords(self):
  29         """ Verify that accessing deleted records works as expected """
  30         cr, uid, uid2, p1, p2 = self.cr, self.uid, self.uid2, self.p1, self.p2
  31         self.partner.unlink(cr, uid, [p1])
  32
  33         # read() is expected to skip deleted records because our API is not
  34         # transactional for a sequence of search()->read() performed from the
  35         # client-side... a concurrent deletion could therefore cause spurious
  36         # exceptions even when simply opening a list view!
  37         # /!\ Using unprileged user to detect former side effects of ir.rules!
  38         self.assertEqual([{'id': p2, 'name': 'Y'}], self.partner.read(cr, uid2, [p1,p2], ['name']), "read() should skip deleted records")
  39         self.assertEqual([], self.partner.read(cr, uid2, [p1], ['name']), "read() should skip deleted records")
  40
  41         # Deleting an already deleted record should be simply ignored
  42         self.assertTrue(self.partner.unlink(cr, uid, [p1]), "Re-deleting should be a no-op")
  43
  44         # Updating an already deleted record should raise, even as admin
  45         with self.assertRaises(Exception):
  46             self.partner.write(cr, uid, [p1], {'name': 'foo'})
  47
  48     @mute_logger('openerp.models')
  49     def testAccessFilteredRecords(self):
  50         """ Verify that accessing filtered records works as expected for non-admin user """
  51         cr, uid, uid2, p1, p2 = self.cr, self.uid, self.uid2, self.p1, self.p2
  52         partner_model = self.registry('ir.model').search(cr, uid, [('model','=','res.partner')])[0]
  53         self.ir_rule.create(cr, uid, {'name': 'Y is invisible',
  54                                       'domain_force': [('id', '!=', p1)],
  55                                       'model_id': partner_model})
  56         # search as unprivileged user
  57         partners = self.partner.search(cr, uid2, [])
  58         self.assertFalse(p1 in partners, "W should not be visible...")
  59         self.assertTrue(p2 in partners, "... but Y should be visible")
  60
  61         # read as unprivileged user
  62         with self.assertRaises(Exception):
  63             self.partner.read(cr, uid2, [p1], ['name'])
  64         # write as unprivileged user
  65         with self.assertRaises(Exception):
  66             self.partner.write(cr, uid2, [p1], {'name': 'foo'})
  67         # unlink as unprivileged user
  68         with self.assertRaises(Exception):
  69             self.partner.unlink(cr, uid2, [p1])
  70
  71         # Prepare mixed case
  72         self.partner.unlink(cr, uid, [p2])
  73         # read mixed records: some deleted and some filtered
  74         with self.assertRaises(Exception):
  75             self.partner.read(cr, uid2, [p1,p2], ['name'])
  76         # delete mixed records: some deleted and some filtered
  77         with self.assertRaises(Exception):
  78             self.partner.unlink(cr, uid2, [p1,p2])
  79
  80     def test_multi_read(self):
  81         record_id = self.partner.create(self.cr, UID, {'name': 'MyPartner1'})
  82         records = self.partner.read(self.cr, UID, [record_id])
  83         self.assertIsInstance(records, list)
  84
  85     def test_one_read(self):
  86         record_id = self.partner.create(self.cr, UID, {'name': 'MyPartner1'})
  87         record = self.partner.read(self.cr, UID, record_id)
  88         self.assertIsInstance(record, dict)
  89
  90     @mute_logger('openerp.models')
  91     def test_search_read(self):
  92         # simple search_read
  93         self.partner.create(self.cr, UID, {'name': 'MyPartner1'})
  94         found = self.partner.search_read(self.cr, UID, [['name', '=', 'MyPartner1']], ['name'])
  95         self.assertEqual(len(found), 1)
  96         self.assertEqual(found[0]['name'], 'MyPartner1')
  97         self.assertTrue('id' in found[0])
  98
  99         # search_read correct order
 100         self.partner.create(self.cr, UID, {'name': 'MyPartner2'})
 101         found = self.partner.search_read(self.cr, UID, [['name', 'like', 'MyPartner']], ['name'], order="name")
 102         self.assertEqual(len(found), 2)
 103         self.assertEqual(found[0]['name'], 'MyPartner1')
 104         self.assertEqual(found[1]['name'], 'MyPartner2')
 105         found = self.partner.search_read(self.cr, UID, [['name', 'like', 'MyPartner']], ['name'], order="name desc")
 106         self.assertEqual(len(found), 2)
 107         self.assertEqual(found[0]['name'], 'MyPartner2')
 108         self.assertEqual(found[1]['name'], 'MyPartner1')
 109
 110         # search_read that finds nothing
 111         found = self.partner.search_read(self.cr, UID, [['name', '=', 'Does not exists']], ['name'])
 112         self.assertEqual(len(found), 0)
 113
 114     def test_groupby_date(self):
 115         partners = dict(
 116             A='2012-11-19',
 117             B='2012-12-17',
 118             C='2012-12-31',
 119             D='2013-01-07',
 120             E='2013-01-14',
 121             F='2013-01-28',
 122             G='2013-02-11',
 123         )
 124
 125         all_partners = []
 126         partners_by_day = defaultdict(set)
 127         partners_by_month = defaultdict(set)
 128         partners_by_year = defaultdict(set)
 129
 130         for name, date in partners.items():
 131             p = self.partner.create(self.cr, UID, dict(name=name, date=date))
 132             all_partners.append(p)
 133             partners_by_day[date].add(p)
 134             partners_by_month[date.rsplit('-', 1)[0]].add(p)
 135             partners_by_year[date.split('-', 1)[0]].add(p)
 136
 137         def read_group(interval, domain=None):
 138             main_domain = [('id', 'in', all_partners)]
 139             if domain:
 140                 domain = ['&'] + main_domain + domain
 141             else:
 142                 domain = main_domain
 143
 144             rg = self.partner.read_group(self.cr, self.uid, domain, ['date'], 'date' + ':' + interval)
 145             result = {}
 146             for r in rg:
 147                 result[r['date:' + interval]] = set(self.partner.search(self.cr, self.uid, r['__domain']))
 148             return result
 149
 150         self.assertEqual(len(read_group('day')), len(partners_by_day))
 151         self.assertEqual(len(read_group('month')), len(partners_by_month))
 152         self.assertEqual(len(read_group('year')), len(partners_by_year))
 153
 154         rg = self.partner.read_group(self.cr, self.uid, [('id', 'in', all_partners)],
 155                         ['date'], ['date:month', 'date:day'], lazy=False)
 156         self.assertEqual(len(rg), len(all_partners))
 157
 158
 159 class TestInherits(common.TransactionCase):
 160     """ test the behavior of the orm for models that use _inherits;
 161         specifically: res.users, that inherits from res.partner
 162     """
 163
 164     def setUp(self):
 165         super(TestInherits, self).setUp()
 166         self.partner = self.registry('res.partner')
 167         self.user = self.registry('res.users')
 168
 169     def test_default(self):
 170         """ `default_get` cannot return a dictionary or a new id """
 171         defaults = self.user.default_get(self.cr, UID, ['partner_id'])
 172         if 'partner_id' in defaults:
 173             self.assertIsInstance(defaults['partner_id'], (bool, int, long))
 174
 175     def test_create(self):
 176         """ creating a user should automatically create a new partner """
 177         partners_before = self.partner.search(self.cr, UID, [])
 178         foo_id = self.user.create(self.cr, UID, {'name': 'Foo', 'login': 'foo', 'password': 'foo'})
 179         foo = self.user.browse(self.cr, UID, foo_id)
 180
 181         self.assertNotIn(foo.partner_id.id, partners_before)
 182
 183     def test_create_with_ancestor(self):
 184         """ creating a user with a specific 'partner_id' should not create a new partner """
 185         par_id = self.partner.create(self.cr, UID, {'name': 'Foo'})
 186         partners_before = self.partner.search(self.cr, UID, [])
 187         foo_id = self.user.create(self.cr, UID, {'partner_id': par_id, 'login': 'foo', 'password': 'foo'})
 188         partners_after = self.partner.search(self.cr, UID, [])
 189
 190         self.assertEqual(set(partners_before), set(partners_after))
 191
 192         foo = self.user.browse(self.cr, UID, foo_id)
 193         self.assertEqual(foo.name, 'Foo')
 194         self.assertEqual(foo.partner_id.id, par_id)
 195
 196     @mute_logger('openerp.models')
 197     def test_read(self):
 198         """ inherited fields should be read without any indirection """
 199         foo_id = self.user.create(self.cr, UID, {'name': 'Foo', 'login': 'foo', 'password': 'foo'})
 200         foo_values, = self.user.read(self.cr, UID, [foo_id])
 201         partner_id = foo_values['partner_id'][0]
 202         partner_values, = self.partner.read(self.cr, UID, [partner_id])
 203         self.assertEqual(foo_values['name'], partner_values['name'])
 204
 205         foo = self.user.browse(self.cr, UID, foo_id)
 206         self.assertEqual(foo.name, foo.partner_id.name)
 207
 208     @mute_logger('openerp.models')
 209     def test_copy(self):
 210         """ copying a user should automatically copy its partner, too """
 211         foo_id = self.user.create(self.cr, UID, {'name': 'Foo', 'login': 'foo', 'password': 'foo'})
 212         foo_before, = self.user.read(self.cr, UID, [foo_id])
 213         del foo_before['__last_update']
 214         bar_id = self.user.copy(self.cr, UID, foo_id, {'login': 'bar', 'password': 'bar'})
 215         foo_after, = self.user.read(self.cr, UID, [foo_id])
 216         del foo_after['__last_update']
 217
 218         self.assertEqual(foo_before, foo_after)
 219
 220         foo, bar = self.user.browse(self.cr, UID, [foo_id, bar_id])
 221         self.assertEqual(bar.login, 'bar')
 222         self.assertNotEqual(foo.id, bar.id)
 223         self.assertNotEqual(foo.partner_id.id, bar.partner_id.id)
 224
 225     @mute_logger('openerp.models')
 226     def test_copy_with_ancestor(self):
 227         """ copying a user with 'parent_id' in defaults should not duplicate the partner """
 228         foo_id = self.user.create(self.cr, UID, {'name': 'Foo', 'login': 'foo', 'password': 'foo',
 229                                                  'login_date': '2016-01-01', 'signature': 'XXX'})
 230         par_id = self.partner.create(self.cr, UID, {'name': 'Bar'})
 231
 232         foo_before, = self.user.read(self.cr, UID, [foo_id])
 233         del foo_before['__last_update']
 234         partners_before = self.partner.search(self.cr, UID, [])
 235         bar_id = self.user.copy(self.cr, UID, foo_id, {'partner_id': par_id, 'login': 'bar'})
 236         foo_after, = self.user.read(self.cr, UID, [foo_id])
 237         del foo_after['__last_update']
 238         partners_after = self.partner.search(self.cr, UID, [])
 239
 240         self.assertEqual(foo_before, foo_after)
 241         self.assertEqual(set(partners_before), set(partners_after))
 242
 243         foo, bar = self.user.browse(self.cr, UID, [foo_id, bar_id])
 244         self.assertNotEqual(foo.id, bar.id)
 245         self.assertEqual(bar.partner_id.id, par_id)
 246         self.assertEqual(bar.login, 'bar', "login is given from copy parameters")
 247         self.assertFalse(bar.login_date, "login_date should not be copied from original record")
 248         self.assertEqual(bar.name, 'Bar', "name is given from specific partner")
 249         self.assertEqual(bar.signature, foo.signature, "signature should be copied")
 250
 251
 252
 253 CREATE = lambda values: (0, False, values)
 254 UPDATE = lambda id, values: (1, id, values)
 255 DELETE = lambda id: (2, id, False)
 256 FORGET = lambda id: (3, id, False)
 257 LINK_TO = lambda id: (4, id, False)
 258 DELETE_ALL = lambda: (5, False, False)
 259 REPLACE_WITH = lambda ids: (6, False, ids)
 260
 261 def sorted_by_id(list_of_dicts):
 262     "sort dictionaries by their 'id' field; useful for comparisons"
 263     return sorted(list_of_dicts, key=lambda d: d.get('id'))
 264
 265 class TestO2MSerialization(common.TransactionCase):
 266     """ test the orm method 'write' on one2many fields """
 267
 268     def setUp(self):
 269         super(TestO2MSerialization, self).setUp()
 270         self.partner = self.registry('res.partner')
 271
 272     def test_no_command(self):
 273         " empty list of commands yields an empty list of records "
 274         results = self.partner.resolve_2many_commands(
 275             self.cr, UID, 'child_ids', [])
 276
 277         self.assertEqual(results, [])
 278
 279     def test_CREATE_commands(self):
 280         " returns the VALUES dict as-is "
 281         values = [{'foo': 'bar'}, {'foo': 'baz'}, {'foo': 'baq'}]
 282         results = self.partner.resolve_2many_commands(
 283             self.cr, UID, 'child_ids', map(CREATE, values))
 284
 285         self.assertEqual(results, values)
 286
 287     def test_LINK_TO_command(self):
 288         " reads the records from the database, records are returned with their ids. "
 289         ids = [
 290             self.partner.create(self.cr, UID, {'name': 'foo'}),
 291             self.partner.create(self.cr, UID, {'name': 'bar'}),
 292             self.partner.create(self.cr, UID, {'name': 'baz'})
 293         ]
 294         commands = map(LINK_TO, ids)
 295
 296         results = self.partner.resolve_2many_commands(
 297             self.cr, UID, 'child_ids', commands, ['name'])
 298
 299         self.assertEqual(sorted_by_id(results), sorted_by_id([
 300             {'id': ids[0], 'name': 'foo'},
 301             {'id': ids[1], 'name': 'bar'},
 302             {'id': ids[2], 'name': 'baz'}
 303         ]))
 304
 305     def test_bare_ids_command(self):
 306         " same as the equivalent LINK_TO commands "
 307         ids = [
 308             self.partner.create(self.cr, UID, {'name': 'foo'}),
 309             self.partner.create(self.cr, UID, {'name': 'bar'}),
 310             self.partner.create(self.cr, UID, {'name': 'baz'})
 311         ]
 312
 313         results = self.partner.resolve_2many_commands(
 314             self.cr, UID, 'child_ids', ids, ['name'])
 315
 316         self.assertEqual(sorted_by_id(results), sorted_by_id([
 317             {'id': ids[0], 'name': 'foo'},
 318             {'id': ids[1], 'name': 'bar'},
 319             {'id': ids[2], 'name': 'baz'}
 320         ]))
 321
 322     def test_UPDATE_command(self):
 323         " take the in-db records and merge the provided information in "
 324         id_foo = self.partner.create(self.cr, UID, {'name': 'foo'})
 325         id_bar = self.partner.create(self.cr, UID, {'name': 'bar'})
 326         id_baz = self.partner.create(self.cr, UID, {'name': 'baz', 'city': 'tag'})
 327
 328         results = self.partner.resolve_2many_commands(
 329             self.cr, UID, 'child_ids', [
 330                 LINK_TO(id_foo),
 331                 UPDATE(id_bar, {'name': 'qux', 'city': 'tagtag'}),
 332                 UPDATE(id_baz, {'name': 'quux'})
 333             ], ['name', 'city'])
 334
 335         self.assertEqual(sorted_by_id(results), sorted_by_id([
 336             {'id': id_foo, 'name': 'foo', 'city': False},
 337             {'id': id_bar, 'name': 'qux', 'city': 'tagtag'},
 338             {'id': id_baz, 'name': 'quux', 'city': 'tag'}
 339         ]))
 340
 341     def test_DELETE_command(self):
 342         " deleted records are not returned at all. "
 343         ids = [
 344             self.partner.create(self.cr, UID, {'name': 'foo'}),
 345             self.partner.create(self.cr, UID, {'name': 'bar'}),
 346             self.partner.create(self.cr, UID, {'name': 'baz'})
 347         ]
 348         commands = [DELETE(ids[0]), DELETE(ids[1]), DELETE(ids[2])]
 349
 350         results = self.partner.resolve_2many_commands(
 351             self.cr, UID, 'child_ids', commands, ['name'])
 352
 353         self.assertEqual(results, [])
 354
 355     def test_mixed_commands(self):
 356         ids = [
 357             self.partner.create(self.cr, UID, {'name': name})
 358             for name in ['NObar', 'baz', 'qux', 'NOquux', 'NOcorge', 'garply']
 359         ]
 360
 361         results = self.partner.resolve_2many_commands(
 362             self.cr, UID, 'child_ids', [
 363                 CREATE({'name': 'foo'}),
 364                 UPDATE(ids[0], {'name': 'bar'}),
 365                 LINK_TO(ids[1]),
 366                 DELETE(ids[2]),
 367                 UPDATE(ids[3], {'name': 'quux',}),
 368                 UPDATE(ids[4], {'name': 'corge'}),
 369                 CREATE({'name': 'grault'}),
 370                 LINK_TO(ids[5])
 371             ], ['name'])
 372
 373         self.assertEqual(sorted_by_id(results), sorted_by_id([
 374             {'name': 'foo'},
 375             {'id': ids[0], 'name': 'bar'},
 376             {'id': ids[1], 'name': 'baz'},
 377             {'id': ids[3], 'name': 'quux'},
 378             {'id': ids[4], 'name': 'corge'},
 379             {'name': 'grault'},
 380             {'id': ids[5], 'name': 'garply'}
 381         ]))
 382
 383     def test_LINK_TO_pairs(self):
 384         "LINK_TO commands can be written as pairs, instead of triplets"
 385         ids = [
 386             self.partner.create(self.cr, UID, {'name': 'foo'}),
 387             self.partner.create(self.cr, UID, {'name': 'bar'}),
 388             self.partner.create(self.cr, UID, {'name': 'baz'})
 389         ]
 390         commands = map(lambda id: (4, id), ids)
 391
 392         results = self.partner.resolve_2many_commands(
 393             self.cr, UID, 'child_ids', commands, ['name'])
 394
 395         self.assertEqual(sorted_by_id(results), sorted_by_id([
 396             {'id': ids[0], 'name': 'foo'},
 397             {'id': ids[1], 'name': 'bar'},
 398             {'id': ids[2], 'name': 'baz'}
 399         ]))
 400
 401     def test_singleton_commands(self):
 402         "DELETE_ALL can appear as a singleton"
 403         results = self.partner.resolve_2many_commands(
 404             self.cr, UID, 'child_ids', [DELETE_ALL()], ['name'])
 405
 406         self.assertEqual(results, [])
 407
 408 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: