Statistics
| Branch: | Tag: | Revision:

root / test / ganeti.locking_unittest.py @ 25231ec5

History | View | Annotate | Download (46.1 kB)

1
#!/usr/bin/python
2
#
3

    
4
# Copyright (C) 2006, 2007 Google Inc.
5
#
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
10
#
11
# This program is distributed in the hope that it will be useful, but
12
# WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
# General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19
# 0.0510-1301, USA.
20

    
21

    
22
"""Script for unittesting the locking module"""
23

    
24

    
25
import os
26
import unittest
27
import time
28
import Queue
29
import threading
30

    
31
from ganeti import locking
32
from ganeti import errors
33

    
34
import testutils
35

    
36

    
37
# This is used to test the ssynchronize decorator.
38
# Since it's passed as input to a decorator it must be declared as a global.
39
_decoratorlock = locking.SharedLock()
40

    
41
#: List for looping tests
42
ITERATIONS = range(8)
43

    
44

    
45
def _Repeat(fn):
46
  """Decorator for executing a function many times"""
47
  def wrapper(*args, **kwargs):
48
    for i in ITERATIONS:
49
      fn(*args, **kwargs)
50
  return wrapper
51

    
52

    
53
def SafeSleep(duration):
54
  start = time.time()
55
  while True:
56
    delay = start + duration - time.time()
57
    if delay <= 0.0:
58
      break
59
    time.sleep(delay)
60

    
61

    
62
class _ThreadedTestCase(unittest.TestCase):
63
  """Test class that supports adding/waiting on threads"""
64
  def setUp(self):
65
    unittest.TestCase.setUp(self)
66
    self.done = Queue.Queue(0)
67
    self.threads = []
68

    
69
  def _addThread(self, *args, **kwargs):
70
    """Create and remember a new thread"""
71
    t = threading.Thread(*args, **kwargs)
72
    self.threads.append(t)
73
    t.start()
74
    return t
75

    
76
  def _waitThreads(self):
77
    """Wait for all our threads to finish"""
78
    for t in self.threads:
79
      t.join(60)
80
      self.failIf(t.isAlive())
81
    self.threads = []
82

    
83

    
84
class _ConditionTestCase(_ThreadedTestCase):
85
  """Common test case for conditions"""
86

    
87
  def setUp(self, cls):
88
    _ThreadedTestCase.setUp(self)
89
    self.lock = threading.Lock()
90
    self.cond = cls(self.lock)
91

    
92
  def _testAcquireRelease(self):
93
    self.assert_(not self.cond._is_owned())
94
    self.assertRaises(RuntimeError, self.cond.wait)
95
    self.assertRaises(RuntimeError, self.cond.notifyAll)
96

    
97
    self.cond.acquire()
98
    self.assert_(self.cond._is_owned())
99
    self.cond.notifyAll()
100
    self.assert_(self.cond._is_owned())
101
    self.cond.release()
102

    
103
    self.assert_(not self.cond._is_owned())
104
    self.assertRaises(RuntimeError, self.cond.wait)
105
    self.assertRaises(RuntimeError, self.cond.notifyAll)
106

    
107
  def _testNotification(self):
108
    def _NotifyAll():
109
      self.done.put("NE")
110
      self.cond.acquire()
111
      self.done.put("NA")
112
      self.cond.notifyAll()
113
      self.done.put("NN")
114
      self.cond.release()
115

    
116
    self.cond.acquire()
117
    self._addThread(target=_NotifyAll)
118
    self.assertEqual(self.done.get(True, 1), "NE")
119
    self.assertRaises(Queue.Empty, self.done.get_nowait)
120
    self.cond.wait()
121
    self.assertEqual(self.done.get(True, 1), "NA")
122
    self.assertEqual(self.done.get(True, 1), "NN")
123
    self.assert_(self.cond._is_owned())
124
    self.cond.release()
125
    self.assert_(not self.cond._is_owned())
126

    
127

    
128
class TestSingleNotifyPipeCondition(_ConditionTestCase):
129
  """SingleNotifyPipeCondition tests"""
130

    
131
  def setUp(self):
132
    _ConditionTestCase.setUp(self, locking.SingleNotifyPipeCondition)
133

    
134
  def testAcquireRelease(self):
135
    self._testAcquireRelease()
136

    
137
  def testNotification(self):
138
    self._testNotification()
139

    
140
  def testWaitReuse(self):
141
    self.cond.acquire()
142
    self.cond.wait(0)
143
    self.cond.wait(0.1)
144
    self.cond.release()
145

    
146
  def testNoNotifyReuse(self):
147
    self.cond.acquire()
148
    self.cond.notifyAll()
149
    self.assertRaises(RuntimeError, self.cond.wait)
150
    self.assertRaises(RuntimeError, self.cond.notifyAll)
151
    self.cond.release()
152

    
153

    
154
class TestPipeCondition(_ConditionTestCase):
155
  """PipeCondition tests"""
156

    
157
  def setUp(self):
158
    _ConditionTestCase.setUp(self, locking.PipeCondition)
159

    
160
  def testAcquireRelease(self):
161
    self._testAcquireRelease()
162

    
163
  def testNotification(self):
164
    self._testNotification()
165

    
166
  def _TestWait(self, fn):
167
    self._addThread(target=fn)
168
    self._addThread(target=fn)
169
    self._addThread(target=fn)
170

    
171
    # Wait for threads to be waiting
172
    self.assertEqual(self.done.get(True, 1), "A")
173
    self.assertEqual(self.done.get(True, 1), "A")
174
    self.assertEqual(self.done.get(True, 1), "A")
175

    
176
    self.assertRaises(Queue.Empty, self.done.get_nowait)
177

    
178
    self.cond.acquire()
179
    self.assertEqual(self.cond._nwaiters, 3)
180
    # This new thread can"t acquire the lock, and thus call wait, before we
181
    # release it
182
    self._addThread(target=fn)
183
    self.cond.notifyAll()
184
    self.assertRaises(Queue.Empty, self.done.get_nowait)
185
    self.cond.release()
186

    
187
    # We should now get 3 W and 1 A (for the new thread) in whatever order
188
    w = 0
189
    a = 0
190
    for i in range(4):
191
      got = self.done.get(True, 1)
192
      if got == "W":
193
        w += 1
194
      elif got == "A":
195
        a += 1
196
      else:
197
        self.fail("Got %s on the done queue" % got)
198

    
199
    self.assertEqual(w, 3)
200
    self.assertEqual(a, 1)
201

    
202
    self.cond.acquire()
203
    self.cond.notifyAll()
204
    self.cond.release()
205
    self._waitThreads()
206
    self.assertEqual(self.done.get_nowait(), "W")
207
    self.assertRaises(Queue.Empty, self.done.get_nowait)
208

    
209
  def testBlockingWait(self):
210
    def _BlockingWait():
211
      self.cond.acquire()
212
      self.done.put("A")
213
      self.cond.wait()
214
      self.cond.release()
215
      self.done.put("W")
216

    
217
    self._TestWait(_BlockingWait)
218

    
219
  def testLongTimeoutWait(self):
220
    def _Helper():
221
      self.cond.acquire()
222
      self.done.put("A")
223
      self.cond.wait(15.0)
224
      self.cond.release()
225
      self.done.put("W")
226

    
227
    self._TestWait(_Helper)
228

    
229
  def _TimeoutWait(self, timeout, check):
230
    self.cond.acquire()
231
    self.cond.wait(timeout)
232
    self.cond.release()
233
    self.done.put(check)
234

    
235
  def testShortTimeoutWait(self):
236
    self._addThread(target=self._TimeoutWait, args=(0.1, "T1"))
237
    self._addThread(target=self._TimeoutWait, args=(0.1, "T1"))
238
    self._waitThreads()
239
    self.assertEqual(self.done.get_nowait(), "T1")
240
    self.assertEqual(self.done.get_nowait(), "T1")
241
    self.assertRaises(Queue.Empty, self.done.get_nowait)
242

    
243
  def testZeroTimeoutWait(self):
244
    self._addThread(target=self._TimeoutWait, args=(0, "T0"))
245
    self._addThread(target=self._TimeoutWait, args=(0, "T0"))
246
    self._addThread(target=self._TimeoutWait, args=(0, "T0"))
247
    self._waitThreads()
248
    self.assertEqual(self.done.get_nowait(), "T0")
249
    self.assertEqual(self.done.get_nowait(), "T0")
250
    self.assertEqual(self.done.get_nowait(), "T0")
251
    self.assertRaises(Queue.Empty, self.done.get_nowait)
252

    
253

    
254
class TestSharedLock(_ThreadedTestCase):
255
  """SharedLock tests"""
256

    
257
  def setUp(self):
258
    _ThreadedTestCase.setUp(self)
259
    self.sl = locking.SharedLock()
260

    
261
  def testSequenceAndOwnership(self):
262
    self.assert_(not self.sl._is_owned())
263
    self.sl.acquire(shared=1)
264
    self.assert_(self.sl._is_owned())
265
    self.assert_(self.sl._is_owned(shared=1))
266
    self.assert_(not self.sl._is_owned(shared=0))
267
    self.sl.release()
268
    self.assert_(not self.sl._is_owned())
269
    self.sl.acquire()
270
    self.assert_(self.sl._is_owned())
271
    self.assert_(not self.sl._is_owned(shared=1))
272
    self.assert_(self.sl._is_owned(shared=0))
273
    self.sl.release()
274
    self.assert_(not self.sl._is_owned())
275
    self.sl.acquire(shared=1)
276
    self.assert_(self.sl._is_owned())
277
    self.assert_(self.sl._is_owned(shared=1))
278
    self.assert_(not self.sl._is_owned(shared=0))
279
    self.sl.release()
280
    self.assert_(not self.sl._is_owned())
281

    
282
  def testBooleanValue(self):
283
    # semaphores are supposed to return a true value on a successful acquire
284
    self.assert_(self.sl.acquire(shared=1))
285
    self.sl.release()
286
    self.assert_(self.sl.acquire())
287
    self.sl.release()
288

    
289
  def testDoubleLockingStoE(self):
290
    self.sl.acquire(shared=1)
291
    self.assertRaises(AssertionError, self.sl.acquire)
292

    
293
  def testDoubleLockingEtoS(self):
294
    self.sl.acquire()
295
    self.assertRaises(AssertionError, self.sl.acquire, shared=1)
296

    
297
  def testDoubleLockingStoS(self):
298
    self.sl.acquire(shared=1)
299
    self.assertRaises(AssertionError, self.sl.acquire, shared=1)
300

    
301
  def testDoubleLockingEtoE(self):
302
    self.sl.acquire()
303
    self.assertRaises(AssertionError, self.sl.acquire)
304

    
305
  # helper functions: called in a separate thread they acquire the lock, send
306
  # their identifier on the done queue, then release it.
307
  def _doItSharer(self):
308
    try:
309
      self.sl.acquire(shared=1)
310
      self.done.put('SHR')
311
      self.sl.release()
312
    except errors.LockError:
313
      self.done.put('ERR')
314

    
315
  def _doItExclusive(self):
316
    try:
317
      self.sl.acquire()
318
      self.done.put('EXC')
319
      self.sl.release()
320
    except errors.LockError:
321
      self.done.put('ERR')
322

    
323
  def _doItDelete(self):
324
    try:
325
      self.sl.delete()
326
      self.done.put('DEL')
327
    except errors.LockError:
328
      self.done.put('ERR')
329

    
330
  def testSharersCanCoexist(self):
331
    self.sl.acquire(shared=1)
332
    threading.Thread(target=self._doItSharer).start()
333
    self.assert_(self.done.get(True, 1))
334
    self.sl.release()
335

    
336
  @_Repeat
337
  def testExclusiveBlocksExclusive(self):
338
    self.sl.acquire()
339
    self._addThread(target=self._doItExclusive)
340
    self.assertRaises(Queue.Empty, self.done.get_nowait)
341
    self.sl.release()
342
    self._waitThreads()
343
    self.failUnlessEqual(self.done.get_nowait(), 'EXC')
344

    
345
  @_Repeat
346
  def testExclusiveBlocksDelete(self):
347
    self.sl.acquire()
348
    self._addThread(target=self._doItDelete)
349
    self.assertRaises(Queue.Empty, self.done.get_nowait)
350
    self.sl.release()
351
    self._waitThreads()
352
    self.failUnlessEqual(self.done.get_nowait(), 'DEL')
353
    self.sl = locking.SharedLock()
354

    
355
  @_Repeat
356
  def testExclusiveBlocksSharer(self):
357
    self.sl.acquire()
358
    self._addThread(target=self._doItSharer)
359
    self.assertRaises(Queue.Empty, self.done.get_nowait)
360
    self.sl.release()
361
    self._waitThreads()
362
    self.failUnlessEqual(self.done.get_nowait(), 'SHR')
363

    
364
  @_Repeat
365
  def testSharerBlocksExclusive(self):
366
    self.sl.acquire(shared=1)
367
    self._addThread(target=self._doItExclusive)
368
    self.assertRaises(Queue.Empty, self.done.get_nowait)
369
    self.sl.release()
370
    self._waitThreads()
371
    self.failUnlessEqual(self.done.get_nowait(), 'EXC')
372

    
373
  @_Repeat
374
  def testSharerBlocksDelete(self):
375
    self.sl.acquire(shared=1)
376
    self._addThread(target=self._doItDelete)
377
    self.assertRaises(Queue.Empty, self.done.get_nowait)
378
    self.sl.release()
379
    self._waitThreads()
380
    self.failUnlessEqual(self.done.get_nowait(), 'DEL')
381
    self.sl = locking.SharedLock()
382

    
383
  @_Repeat
384
  def testWaitingExclusiveBlocksSharer(self):
385
    """SKIPPED testWaitingExclusiveBlockSharer"""
386
    return
387

    
388
    self.sl.acquire(shared=1)
389
    # the lock is acquired in shared mode...
390
    self._addThread(target=self._doItExclusive)
391
    # ...but now an exclusive is waiting...
392
    self._addThread(target=self._doItSharer)
393
    # ...so the sharer should be blocked as well
394
    self.assertRaises(Queue.Empty, self.done.get_nowait)
395
    self.sl.release()
396
    self._waitThreads()
397
    # The exclusive passed before
398
    self.failUnlessEqual(self.done.get_nowait(), 'EXC')
399
    self.failUnlessEqual(self.done.get_nowait(), 'SHR')
400

    
401
  @_Repeat
402
  def testWaitingSharerBlocksExclusive(self):
403
    """SKIPPED testWaitingSharerBlocksExclusive"""
404
    return
405

    
406
    self.sl.acquire()
407
    # the lock is acquired in exclusive mode...
408
    self._addThread(target=self._doItSharer)
409
    # ...but now a sharer is waiting...
410
    self._addThread(target=self._doItExclusive)
411
    # ...the exclusive is waiting too...
412
    self.assertRaises(Queue.Empty, self.done.get_nowait)
413
    self.sl.release()
414
    self._waitThreads()
415
    # The sharer passed before
416
    self.assertEqual(self.done.get_nowait(), 'SHR')
417
    self.assertEqual(self.done.get_nowait(), 'EXC')
418

    
419
  def testDelete(self):
420
    self.sl.delete()
421
    self.assertRaises(errors.LockError, self.sl.acquire)
422
    self.assertRaises(errors.LockError, self.sl.acquire, shared=1)
423
    self.assertRaises(errors.LockError, self.sl.delete)
424

    
425
  def testDeleteTimeout(self):
426
    self.sl.delete(timeout=60)
427

    
428
  def testNoDeleteIfSharer(self):
429
    self.sl.acquire(shared=1)
430
    self.assertRaises(AssertionError, self.sl.delete)
431

    
432
  @_Repeat
433
  def testDeletePendingSharersExclusiveDelete(self):
434
    self.sl.acquire()
435
    self._addThread(target=self._doItSharer)
436
    self._addThread(target=self._doItSharer)
437
    self._addThread(target=self._doItExclusive)
438
    self._addThread(target=self._doItDelete)
439
    self.sl.delete()
440
    self._waitThreads()
441
    # The threads who were pending return ERR
442
    for _ in range(4):
443
      self.assertEqual(self.done.get_nowait(), 'ERR')
444
    self.sl = locking.SharedLock()
445

    
446
  @_Repeat
447
  def testDeletePendingDeleteExclusiveSharers(self):
448
    self.sl.acquire()
449
    self._addThread(target=self._doItDelete)
450
    self._addThread(target=self._doItExclusive)
451
    self._addThread(target=self._doItSharer)
452
    self._addThread(target=self._doItSharer)
453
    self.sl.delete()
454
    self._waitThreads()
455
    # The two threads who were pending return both ERR
456
    self.assertEqual(self.done.get_nowait(), 'ERR')
457
    self.assertEqual(self.done.get_nowait(), 'ERR')
458
    self.assertEqual(self.done.get_nowait(), 'ERR')
459
    self.assertEqual(self.done.get_nowait(), 'ERR')
460
    self.sl = locking.SharedLock()
461

    
462
  @_Repeat
463
  def testExclusiveAcquireTimeout(self):
464
    for shared in [0, 1]:
465
      on_queue = threading.Event()
466
      release_exclusive = threading.Event()
467

    
468
      def _LockExclusive():
469
        self.sl.acquire(shared=0, test_notify=on_queue.set)
470
        self.done.put("A: start wait")
471
        release_exclusive.wait()
472
        self.done.put("A: end wait")
473
        self.sl.release()
474

    
475
      # Start thread to hold lock in exclusive mode
476
      self._addThread(target=_LockExclusive)
477

    
478
      # Wait for wait to begin
479
      self.assertEqual(self.done.get(timeout=60), "A: start wait")
480

    
481
      # Wait up to 60s to get lock, but release exclusive lock as soon as we're
482
      # on the queue
483
      self.failUnless(self.sl.acquire(shared=shared, timeout=60,
484
                                      test_notify=release_exclusive.set))
485

    
486
      self.done.put("got 2nd")
487
      self.sl.release()
488

    
489
      self._waitThreads()
490

    
491
      self.assertEqual(self.done.get_nowait(), "A: end wait")
492
      self.assertEqual(self.done.get_nowait(), "got 2nd")
493
      self.assertRaises(Queue.Empty, self.done.get_nowait)
494

    
495
  @_Repeat
496
  def testAcquireExpiringTimeout(self):
497
    def _AcquireWithTimeout(shared, timeout):
498
      if not self.sl.acquire(shared=shared, timeout=timeout):
499
        self.done.put("timeout")
500

    
501
    for shared in [0, 1]:
502
      # Lock exclusively
503
      self.sl.acquire()
504

    
505
      # Start shared acquires with timeout between 0 and 20 ms
506
      for i in range(11):
507
        self._addThread(target=_AcquireWithTimeout,
508
                        args=(shared, i * 2.0 / 1000.0))
509

    
510
      # Wait for threads to finish (makes sure the acquire timeout expires
511
      # before releasing the lock)
512
      self._waitThreads()
513

    
514
      # Release lock
515
      self.sl.release()
516

    
517
      for _ in range(11):
518
        self.assertEqual(self.done.get_nowait(), "timeout")
519

    
520
      self.assertRaises(Queue.Empty, self.done.get_nowait)
521

    
522
  @_Repeat
523
  def testSharedSkipExclusiveAcquires(self):
524
    # Tests whether shared acquires jump in front of exclusive acquires in the
525
    # queue.
526

    
527
    def _Acquire(shared, name, notify_ev, wait_ev):
528
      if notify_ev:
529
        notify_fn = notify_ev.set
530
      else:
531
        notify_fn = None
532

    
533
      if wait_ev:
534
        wait_ev.wait()
535

    
536
      if not self.sl.acquire(shared=shared, test_notify=notify_fn):
537
        return
538

    
539
      self.done.put(name)
540
      self.sl.release()
541

    
542
    # Get exclusive lock while we fill the queue
543
    self.sl.acquire()
544

    
545
    shrcnt1 = 5
546
    shrcnt2 = 7
547
    shrcnt3 = 9
548
    shrcnt4 = 2
549

    
550
    # Add acquires using threading.Event for synchronization. They'll be
551
    # acquired exactly in the order defined in this list.
552
    acquires = (shrcnt1 * [(1, "shared 1")] +
553
                3 * [(0, "exclusive 1")] +
554
                shrcnt2 * [(1, "shared 2")] +
555
                shrcnt3 * [(1, "shared 3")] +
556
                shrcnt4 * [(1, "shared 4")] +
557
                3 * [(0, "exclusive 2")])
558

    
559
    ev_cur = None
560
    ev_prev = None
561

    
562
    for args in acquires:
563
      ev_cur = threading.Event()
564
      self._addThread(target=_Acquire, args=args + (ev_cur, ev_prev))
565
      ev_prev = ev_cur
566

    
567
    # Wait for last acquire to start
568
    ev_prev.wait()
569

    
570
    # Expect 6 pending exclusive acquires and 1 for all shared acquires
571
    # together
572
    self.assertEqual(self.sl._count_pending(), 7)
573

    
574
    # Release exclusive lock and wait
575
    self.sl.release()
576

    
577
    self._waitThreads()
578

    
579
    # Check sequence
580
    for _ in range(shrcnt1 + shrcnt2 + shrcnt3 + shrcnt4):
581
      # Shared locks aren't guaranteed to be notified in order, but they'll be
582
      # first
583
      tmp = self.done.get_nowait()
584
      if tmp == "shared 1":
585
        shrcnt1 -= 1
586
      elif tmp == "shared 2":
587
        shrcnt2 -= 1
588
      elif tmp == "shared 3":
589
        shrcnt3 -= 1
590
      elif tmp == "shared 4":
591
        shrcnt4 -= 1
592
    self.assertEqual(shrcnt1, 0)
593
    self.assertEqual(shrcnt2, 0)
594
    self.assertEqual(shrcnt3, 0)
595
    self.assertEqual(shrcnt3, 0)
596

    
597
    for _ in range(3):
598
      self.assertEqual(self.done.get_nowait(), "exclusive 1")
599

    
600
    for _ in range(3):
601
      self.assertEqual(self.done.get_nowait(), "exclusive 2")
602

    
603
    self.assertRaises(Queue.Empty, self.done.get_nowait)
604

    
605
  @_Repeat
606
  def testMixedAcquireTimeout(self):
607
    sync = threading.Condition()
608

    
609
    def _AcquireShared(ev):
610
      if not self.sl.acquire(shared=1, timeout=None):
611
        return
612

    
613
      self.done.put("shared")
614

    
615
      # Notify main thread
616
      ev.set()
617

    
618
      # Wait for notification
619
      sync.acquire()
620
      try:
621
        sync.wait()
622
      finally:
623
        sync.release()
624

    
625
      # Release lock
626
      self.sl.release()
627

    
628
    acquires = []
629
    for _ in range(3):
630
      ev = threading.Event()
631
      self._addThread(target=_AcquireShared, args=(ev, ))
632
      acquires.append(ev)
633

    
634
    # Wait for all acquires to finish
635
    for i in acquires:
636
      i.wait()
637

    
638
    self.assertEqual(self.sl._count_pending(), 0)
639

    
640
    # Try to get exclusive lock
641
    self.failIf(self.sl.acquire(shared=0, timeout=0.02))
642

    
643
    # Acquire exclusive without timeout
644
    exclsync = threading.Condition()
645
    exclev = threading.Event()
646

    
647
    def _AcquireExclusive():
648
      if not self.sl.acquire(shared=0):
649
        return
650

    
651
      self.done.put("exclusive")
652

    
653
      # Notify main thread
654
      exclev.set()
655

    
656
      exclsync.acquire()
657
      try:
658
        exclsync.wait()
659
      finally:
660
        exclsync.release()
661

    
662
      self.sl.release()
663

    
664
    self._addThread(target=_AcquireExclusive)
665

    
666
    # Try to get exclusive lock
667
    self.failIf(self.sl.acquire(shared=0, timeout=0.02))
668

    
669
    # Make all shared holders release their locks
670
    sync.acquire()
671
    try:
672
      sync.notifyAll()
673
    finally:
674
      sync.release()
675

    
676
    # Wait for exclusive acquire to succeed
677
    exclev.wait()
678

    
679
    self.assertEqual(self.sl._count_pending(), 0)
680

    
681
    # Try to get exclusive lock
682
    self.failIf(self.sl.acquire(shared=0, timeout=0.02))
683

    
684
    def _AcquireSharedSimple():
685
      if self.sl.acquire(shared=1, timeout=None):
686
        self.done.put("shared2")
687
        self.sl.release()
688

    
689
    for _ in range(10):
690
      self._addThread(target=_AcquireSharedSimple)
691

    
692
    # Tell exclusive lock to release
693
    exclsync.acquire()
694
    try:
695
      exclsync.notifyAll()
696
    finally:
697
      exclsync.release()
698

    
699
    # Wait for everything to finish
700
    self._waitThreads()
701

    
702
    self.assertEqual(self.sl._count_pending(), 0)
703

    
704
    # Check sequence
705
    for _ in range(3):
706
      self.assertEqual(self.done.get_nowait(), "shared")
707

    
708
    self.assertEqual(self.done.get_nowait(), "exclusive")
709

    
710
    for _ in range(10):
711
      self.assertEqual(self.done.get_nowait(), "shared2")
712

    
713
    self.assertRaises(Queue.Empty, self.done.get_nowait)
714

    
715

    
716
class TestSSynchronizedDecorator(_ThreadedTestCase):
717
  """Shared Lock Synchronized decorator test"""
718

    
719
  def setUp(self):
720
    _ThreadedTestCase.setUp(self)
721

    
722
  @locking.ssynchronized(_decoratorlock)
723
  def _doItExclusive(self):
724
    self.assert_(_decoratorlock._is_owned())
725
    self.done.put('EXC')
726

    
727
  @locking.ssynchronized(_decoratorlock, shared=1)
728
  def _doItSharer(self):
729
    self.assert_(_decoratorlock._is_owned(shared=1))
730
    self.done.put('SHR')
731

    
732
  def testDecoratedFunctions(self):
733
    self._doItExclusive()
734
    self.assert_(not _decoratorlock._is_owned())
735
    self._doItSharer()
736
    self.assert_(not _decoratorlock._is_owned())
737

    
738
  def testSharersCanCoexist(self):
739
    _decoratorlock.acquire(shared=1)
740
    threading.Thread(target=self._doItSharer).start()
741
    self.assert_(self.done.get(True, 1))
742
    _decoratorlock.release()
743

    
744
  @_Repeat
745
  def testExclusiveBlocksExclusive(self):
746
    _decoratorlock.acquire()
747
    self._addThread(target=self._doItExclusive)
748
    # give it a bit of time to check that it's not actually doing anything
749
    self.assertRaises(Queue.Empty, self.done.get_nowait)
750
    _decoratorlock.release()
751
    self._waitThreads()
752
    self.failUnlessEqual(self.done.get_nowait(), 'EXC')
753

    
754
  @_Repeat
755
  def testExclusiveBlocksSharer(self):
756
    _decoratorlock.acquire()
757
    self._addThread(target=self._doItSharer)
758
    self.assertRaises(Queue.Empty, self.done.get_nowait)
759
    _decoratorlock.release()
760
    self._waitThreads()
761
    self.failUnlessEqual(self.done.get_nowait(), 'SHR')
762

    
763
  @_Repeat
764
  def testSharerBlocksExclusive(self):
765
    _decoratorlock.acquire(shared=1)
766
    self._addThread(target=self._doItExclusive)
767
    self.assertRaises(Queue.Empty, self.done.get_nowait)
768
    _decoratorlock.release()
769
    self._waitThreads()
770
    self.failUnlessEqual(self.done.get_nowait(), 'EXC')
771

    
772

    
773
class TestLockSet(_ThreadedTestCase):
774
  """LockSet tests"""
775

    
776
  def setUp(self):
777
    _ThreadedTestCase.setUp(self)
778
    self._setUpLS()
779

    
780
  def _setUpLS(self):
781
    """Helper to (re)initialize the lock set"""
782
    self.resources = ['one', 'two', 'three']
783
    self.ls = locking.LockSet(members=self.resources)
784

    
785
  def testResources(self):
786
    self.assertEquals(self.ls._names(), set(self.resources))
787
    newls = locking.LockSet()
788
    self.assertEquals(newls._names(), set())
789

    
790
  def testAcquireRelease(self):
791
    self.assert_(self.ls.acquire('one'))
792
    self.assertEquals(self.ls._list_owned(), set(['one']))
793
    self.ls.release()
794
    self.assertEquals(self.ls._list_owned(), set())
795
    self.assertEquals(self.ls.acquire(['one']), set(['one']))
796
    self.assertEquals(self.ls._list_owned(), set(['one']))
797
    self.ls.release()
798
    self.assertEquals(self.ls._list_owned(), set())
799
    self.ls.acquire(['one', 'two', 'three'])
800
    self.assertEquals(self.ls._list_owned(), set(['one', 'two', 'three']))
801
    self.ls.release('one')
802
    self.assertEquals(self.ls._list_owned(), set(['two', 'three']))
803
    self.ls.release(['three'])
804
    self.assertEquals(self.ls._list_owned(), set(['two']))
805
    self.ls.release()
806
    self.assertEquals(self.ls._list_owned(), set())
807
    self.assertEquals(self.ls.acquire(['one', 'three']), set(['one', 'three']))
808
    self.assertEquals(self.ls._list_owned(), set(['one', 'three']))
809
    self.ls.release()
810
    self.assertEquals(self.ls._list_owned(), set())
811

    
812
  def testNoDoubleAcquire(self):
813
    self.ls.acquire('one')
814
    self.assertRaises(AssertionError, self.ls.acquire, 'one')
815
    self.assertRaises(AssertionError, self.ls.acquire, ['two'])
816
    self.assertRaises(AssertionError, self.ls.acquire, ['two', 'three'])
817
    self.ls.release()
818
    self.ls.acquire(['one', 'three'])
819
    self.ls.release('one')
820
    self.assertRaises(AssertionError, self.ls.acquire, ['two'])
821
    self.ls.release('three')
822

    
823
  def testNoWrongRelease(self):
824
    self.assertRaises(AssertionError, self.ls.release)
825
    self.ls.acquire('one')
826
    self.assertRaises(AssertionError, self.ls.release, 'two')
827

    
828
  def testAddRemove(self):
829
    self.ls.add('four')
830
    self.assertEquals(self.ls._list_owned(), set())
831
    self.assert_('four' in self.ls._names())
832
    self.ls.add(['five', 'six', 'seven'], acquired=1)
833
    self.assert_('five' in self.ls._names())
834
    self.assert_('six' in self.ls._names())
835
    self.assert_('seven' in self.ls._names())
836
    self.assertEquals(self.ls._list_owned(), set(['five', 'six', 'seven']))
837
    self.assertEquals(self.ls.remove(['five', 'six']), ['five', 'six'])
838
    self.assert_('five' not in self.ls._names())
839
    self.assert_('six' not in self.ls._names())
840
    self.assertEquals(self.ls._list_owned(), set(['seven']))
841
    self.assertRaises(AssertionError, self.ls.add, 'eight', acquired=1)
842
    self.ls.remove('seven')
843
    self.assert_('seven' not in self.ls._names())
844
    self.assertEquals(self.ls._list_owned(), set([]))
845
    self.ls.acquire(None, shared=1)
846
    self.assertRaises(AssertionError, self.ls.add, 'eight')
847
    self.ls.release()
848
    self.ls.acquire(None)
849
    self.ls.add('eight', acquired=1)
850
    self.assert_('eight' in self.ls._names())
851
    self.assert_('eight' in self.ls._list_owned())
852
    self.ls.add('nine')
853
    self.assert_('nine' in self.ls._names())
854
    self.assert_('nine' not in self.ls._list_owned())
855
    self.ls.release()
856
    self.ls.remove(['two'])
857
    self.assert_('two' not in self.ls._names())
858
    self.ls.acquire('three')
859
    self.assertEquals(self.ls.remove(['three']), ['three'])
860
    self.assert_('three' not in self.ls._names())
861
    self.assertEquals(self.ls.remove('three'), [])
862
    self.assertEquals(self.ls.remove(['one', 'three', 'six']), ['one'])
863
    self.assert_('one' not in self.ls._names())
864

    
865
  def testRemoveNonBlocking(self):
866
    self.ls.acquire('one')
867
    self.assertEquals(self.ls.remove('one'), ['one'])
868
    self.ls.acquire(['two', 'three'])
869
    self.assertEquals(self.ls.remove(['two', 'three']),
870
                      ['two', 'three'])
871

    
872
  def testNoDoubleAdd(self):
873
    self.assertRaises(errors.LockError, self.ls.add, 'two')
874
    self.ls.add('four')
875
    self.assertRaises(errors.LockError, self.ls.add, 'four')
876

    
877
  def testNoWrongRemoves(self):
878
    self.ls.acquire(['one', 'three'], shared=1)
879
    # Cannot remove 'two' while holding something which is not a superset
880
    self.assertRaises(AssertionError, self.ls.remove, 'two')
881
    # Cannot remove 'three' as we are sharing it
882
    self.assertRaises(AssertionError, self.ls.remove, 'three')
883

    
884
  def testAcquireSetLock(self):
885
    # acquire the set-lock exclusively
886
    self.assertEquals(self.ls.acquire(None), set(['one', 'two', 'three']))
887
    self.assertEquals(self.ls._list_owned(), set(['one', 'two', 'three']))
888
    self.assertEquals(self.ls._is_owned(), True)
889
    self.assertEquals(self.ls._names(), set(['one', 'two', 'three']))
890
    # I can still add/remove elements...
891
    self.assertEquals(self.ls.remove(['two', 'three']), ['two', 'three'])
892
    self.assert_(self.ls.add('six'))
893
    self.ls.release()
894
    # share the set-lock
895
    self.assertEquals(self.ls.acquire(None, shared=1), set(['one', 'six']))
896
    # adding new elements is not possible
897
    self.assertRaises(AssertionError, self.ls.add, 'five')
898
    self.ls.release()
899

    
900
  def testAcquireWithRepetitions(self):
901
    self.assertEquals(self.ls.acquire(['two', 'two', 'three'], shared=1),
902
                      set(['two', 'two', 'three']))
903
    self.ls.release(['two', 'two'])
904
    self.assertEquals(self.ls._list_owned(), set(['three']))
905

    
906
  def testEmptyAcquire(self):
907
    # Acquire an empty list of locks...
908
    self.assertEquals(self.ls.acquire([]), set())
909
    self.assertEquals(self.ls._list_owned(), set())
910
    # New locks can still be addded
911
    self.assert_(self.ls.add('six'))
912
    # "re-acquiring" is not an issue, since we had really acquired nothing
913
    self.assertEquals(self.ls.acquire([], shared=1), set())
914
    self.assertEquals(self.ls._list_owned(), set())
915
    # We haven't really acquired anything, so we cannot release
916
    self.assertRaises(AssertionError, self.ls.release)
917

    
918
  def _doLockSet(self, names, shared):
919
    try:
920
      self.ls.acquire(names, shared=shared)
921
      self.done.put('DONE')
922
      self.ls.release()
923
    except errors.LockError:
924
      self.done.put('ERR')
925

    
926
  def _doAddSet(self, names):
927
    try:
928
      self.ls.add(names, acquired=1)
929
      self.done.put('DONE')
930
      self.ls.release()
931
    except errors.LockError:
932
      self.done.put('ERR')
933

    
934
  def _doRemoveSet(self, names):
935
    self.done.put(self.ls.remove(names))
936

    
937
  @_Repeat
938
  def testConcurrentSharedAcquire(self):
939
    self.ls.acquire(['one', 'two'], shared=1)
940
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 1))
941
    self._waitThreads()
942
    self.assertEqual(self.done.get_nowait(), 'DONE')
943
    self._addThread(target=self._doLockSet, args=(['one', 'two', 'three'], 1))
944
    self._waitThreads()
945
    self.assertEqual(self.done.get_nowait(), 'DONE')
946
    self._addThread(target=self._doLockSet, args=('three', 1))
947
    self._waitThreads()
948
    self.assertEqual(self.done.get_nowait(), 'DONE')
949
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 0))
950
    self._addThread(target=self._doLockSet, args=(['two', 'three'], 0))
951
    self.assertRaises(Queue.Empty, self.done.get_nowait)
952
    self.ls.release()
953
    self._waitThreads()
954
    self.assertEqual(self.done.get_nowait(), 'DONE')
955
    self.assertEqual(self.done.get_nowait(), 'DONE')
956

    
957
  @_Repeat
958
  def testConcurrentExclusiveAcquire(self):
959
    self.ls.acquire(['one', 'two'])
960
    self._addThread(target=self._doLockSet, args=('three', 1))
961
    self._waitThreads()
962
    self.assertEqual(self.done.get_nowait(), 'DONE')
963
    self._addThread(target=self._doLockSet, args=('three', 0))
964
    self._waitThreads()
965
    self.assertEqual(self.done.get_nowait(), 'DONE')
966
    self.assertRaises(Queue.Empty, self.done.get_nowait)
967
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 0))
968
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 1))
969
    self._addThread(target=self._doLockSet, args=('one', 0))
970
    self._addThread(target=self._doLockSet, args=('one', 1))
971
    self._addThread(target=self._doLockSet, args=(['two', 'three'], 0))
972
    self._addThread(target=self._doLockSet, args=(['two', 'three'], 1))
973
    self.assertRaises(Queue.Empty, self.done.get_nowait)
974
    self.ls.release()
975
    self._waitThreads()
976
    for _ in range(6):
977
      self.failUnlessEqual(self.done.get_nowait(), 'DONE')
978

    
979
  @_Repeat
980
  def testSimpleAcquireTimeoutExpiring(self):
981
    names = sorted(self.ls._names())
982
    self.assert_(len(names) >= 3)
983

    
984
    # Get name of first lock
985
    first = names[0]
986

    
987
    # Get name of last lock
988
    last = names.pop()
989

    
990
    checks = [
991
      # Block first and try to lock it again
992
      (first, first),
993

    
994
      # Block last and try to lock all locks
995
      (None, first),
996

    
997
      # Block last and try to lock it again
998
      (last, last),
999
      ]
1000

    
1001
    for (wanted, block) in checks:
1002
      # Lock in exclusive mode
1003
      self.assert_(self.ls.acquire(block, shared=0))
1004

    
1005
      def _AcquireOne():
1006
        # Try to get the same lock again with a timeout (should never succeed)
1007
        acquired = self.ls.acquire(wanted, timeout=0.1, shared=0)
1008
        if acquired:
1009
          self.done.put("acquired")
1010
          self.ls.release()
1011
        else:
1012
          self.assert_(acquired is None)
1013
          self.assert_(not self.ls._list_owned())
1014
          self.assert_(not self.ls._is_owned())
1015
          self.done.put("not acquired")
1016

    
1017
      self._addThread(target=_AcquireOne)
1018

    
1019
      # Wait for timeout in thread to expire
1020
      self._waitThreads()
1021

    
1022
      # Release exclusive lock again
1023
      self.ls.release()
1024

    
1025
      self.assertEqual(self.done.get_nowait(), "not acquired")
1026
      self.assertRaises(Queue.Empty, self.done.get_nowait)
1027

    
1028
  @_Repeat
1029
  def testDelayedAndExpiringLockAcquire(self):
1030
    self._setUpLS()
1031
    self.ls.add(['five', 'six', 'seven', 'eight', 'nine'])
1032

    
1033
    for expire in (False, True):
1034
      names = sorted(self.ls._names())
1035
      self.assertEqual(len(names), 8)
1036

    
1037
      lock_ev = dict([(i, threading.Event()) for i in names])
1038

    
1039
      # Lock all in exclusive mode
1040
      self.assert_(self.ls.acquire(names, shared=0))
1041

    
1042
      if expire:
1043
        # We'll wait at least 300ms per lock
1044
        lockwait = len(names) * [0.3]
1045

    
1046
        # Fail if we can't acquire all locks in 400ms. There are 8 locks, so
1047
        # this gives us up to 2.4s to fail.
1048
        lockall_timeout = 0.4
1049
      else:
1050
        # This should finish rather quickly
1051
        lockwait = None
1052
        lockall_timeout = len(names) * 5.0
1053

    
1054
      def _LockAll():
1055
        def acquire_notification(name):
1056
          if not expire:
1057
            self.done.put("getting %s" % name)
1058

    
1059
          # Kick next lock
1060
          lock_ev[name].set()
1061

    
1062
        if self.ls.acquire(names, shared=0, timeout=lockall_timeout,
1063
                           test_notify=acquire_notification):
1064
          self.done.put("got all")
1065
          self.ls.release()
1066
        else:
1067
          self.done.put("timeout on all")
1068

    
1069
        # Notify all locks
1070
        for ev in lock_ev.values():
1071
          ev.set()
1072

    
1073
      t = self._addThread(target=_LockAll)
1074

    
1075
      for idx, name in enumerate(names):
1076
        # Wait for actual acquire on this lock to start
1077
        lock_ev[name].wait(10.0)
1078

    
1079
        if expire and t.isAlive():
1080
          # Wait some time after getting the notification to make sure the lock
1081
          # acquire will expire
1082
          SafeSleep(lockwait[idx])
1083

    
1084
        self.ls.release(names=name)
1085

    
1086
      self.assert_(not self.ls._list_owned())
1087

    
1088
      self._waitThreads()
1089

    
1090
      if expire:
1091
        # Not checking which locks were actually acquired. Doing so would be
1092
        # too timing-dependant.
1093
        self.assertEqual(self.done.get_nowait(), "timeout on all")
1094
      else:
1095
        for i in names:
1096
          self.assertEqual(self.done.get_nowait(), "getting %s" % i)
1097
        self.assertEqual(self.done.get_nowait(), "got all")
1098
      self.assertRaises(Queue.Empty, self.done.get_nowait)
1099

    
1100
  @_Repeat
1101
  def testConcurrentRemove(self):
1102
    self.ls.add('four')
1103
    self.ls.acquire(['one', 'two', 'four'])
1104
    self._addThread(target=self._doLockSet, args=(['one', 'four'], 0))
1105
    self._addThread(target=self._doLockSet, args=(['one', 'four'], 1))
1106
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 0))
1107
    self._addThread(target=self._doLockSet, args=(['one', 'two'], 1))
1108
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1109
    self.ls.remove('one')
1110
    self.ls.release()
1111
    self._waitThreads()
1112
    for i in range(4):
1113
      self.failUnlessEqual(self.done.get_nowait(), 'ERR')
1114
    self.ls.add(['five', 'six'], acquired=1)
1115
    self._addThread(target=self._doLockSet, args=(['three', 'six'], 1))
1116
    self._addThread(target=self._doLockSet, args=(['three', 'six'], 0))
1117
    self._addThread(target=self._doLockSet, args=(['four', 'six'], 1))
1118
    self._addThread(target=self._doLockSet, args=(['four', 'six'], 0))
1119
    self.ls.remove('five')
1120
    self.ls.release()
1121
    self._waitThreads()
1122
    for i in range(4):
1123
      self.failUnlessEqual(self.done.get_nowait(), 'DONE')
1124
    self.ls.acquire(['three', 'four'])
1125
    self._addThread(target=self._doRemoveSet, args=(['four', 'six'], ))
1126
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1127
    self.ls.remove('four')
1128
    self._waitThreads()
1129
    self.assertEqual(self.done.get_nowait(), ['six'])
1130
    self._addThread(target=self._doRemoveSet, args=(['two']))
1131
    self._waitThreads()
1132
    self.assertEqual(self.done.get_nowait(), ['two'])
1133
    self.ls.release()
1134
    # reset lockset
1135
    self._setUpLS()
1136

    
1137
  @_Repeat
1138
  def testConcurrentSharedSetLock(self):
1139
    # share the set-lock...
1140
    self.ls.acquire(None, shared=1)
1141
    # ...another thread can share it too
1142
    self._addThread(target=self._doLockSet, args=(None, 1))
1143
    self._waitThreads()
1144
    self.assertEqual(self.done.get_nowait(), 'DONE')
1145
    # ...or just share some elements
1146
    self._addThread(target=self._doLockSet, args=(['one', 'three'], 1))
1147
    self._waitThreads()
1148
    self.assertEqual(self.done.get_nowait(), 'DONE')
1149
    # ...but not add new ones or remove any
1150
    t = self._addThread(target=self._doAddSet, args=(['nine']))
1151
    self._addThread(target=self._doRemoveSet, args=(['two'], ))
1152
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1153
    # this just releases the set-lock
1154
    self.ls.release([])
1155
    t.join(60)
1156
    self.assertEqual(self.done.get_nowait(), 'DONE')
1157
    # release the lock on the actual elements so remove() can proceed too
1158
    self.ls.release()
1159
    self._waitThreads()
1160
    self.failUnlessEqual(self.done.get_nowait(), ['two'])
1161
    # reset lockset
1162
    self._setUpLS()
1163

    
1164
  @_Repeat
1165
  def testConcurrentExclusiveSetLock(self):
1166
    # acquire the set-lock...
1167
    self.ls.acquire(None, shared=0)
1168
    # ...no one can do anything else
1169
    self._addThread(target=self._doLockSet, args=(None, 1))
1170
    self._addThread(target=self._doLockSet, args=(None, 0))
1171
    self._addThread(target=self._doLockSet, args=(['three'], 0))
1172
    self._addThread(target=self._doLockSet, args=(['two'], 1))
1173
    self._addThread(target=self._doAddSet, args=(['nine']))
1174
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1175
    self.ls.release()
1176
    self._waitThreads()
1177
    for _ in range(5):
1178
      self.assertEqual(self.done.get(True, 1), 'DONE')
1179
    # cleanup
1180
    self._setUpLS()
1181

    
1182
  @_Repeat
1183
  def testConcurrentSetLockAdd(self):
1184
    self.ls.acquire('one')
1185
    # Another thread wants the whole SetLock
1186
    self._addThread(target=self._doLockSet, args=(None, 0))
1187
    self._addThread(target=self._doLockSet, args=(None, 1))
1188
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1189
    self.assertRaises(AssertionError, self.ls.add, 'four')
1190
    self.ls.release()
1191
    self._waitThreads()
1192
    self.assertEqual(self.done.get_nowait(), 'DONE')
1193
    self.assertEqual(self.done.get_nowait(), 'DONE')
1194
    self.ls.acquire(None)
1195
    self._addThread(target=self._doLockSet, args=(None, 0))
1196
    self._addThread(target=self._doLockSet, args=(None, 1))
1197
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1198
    self.ls.add('four')
1199
    self.ls.add('five', acquired=1)
1200
    self.ls.add('six', acquired=1, shared=1)
1201
    self.assertEquals(self.ls._list_owned(),
1202
      set(['one', 'two', 'three', 'five', 'six']))
1203
    self.assertEquals(self.ls._is_owned(), True)
1204
    self.assertEquals(self.ls._names(),
1205
      set(['one', 'two', 'three', 'four', 'five', 'six']))
1206
    self.ls.release()
1207
    self._waitThreads()
1208
    self.assertEqual(self.done.get_nowait(), 'DONE')
1209
    self.assertEqual(self.done.get_nowait(), 'DONE')
1210
    self._setUpLS()
1211

    
1212
  @_Repeat
1213
  def testEmptyLockSet(self):
1214
    # get the set-lock
1215
    self.assertEqual(self.ls.acquire(None), set(['one', 'two', 'three']))
1216
    # now empty it...
1217
    self.ls.remove(['one', 'two', 'three'])
1218
    # and adds/locks by another thread still wait
1219
    self._addThread(target=self._doAddSet, args=(['nine']))
1220
    self._addThread(target=self._doLockSet, args=(None, 1))
1221
    self._addThread(target=self._doLockSet, args=(None, 0))
1222
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1223
    self.ls.release()
1224
    self._waitThreads()
1225
    for _ in range(3):
1226
      self.assertEqual(self.done.get_nowait(), 'DONE')
1227
    # empty it again...
1228
    self.assertEqual(self.ls.remove(['nine']), ['nine'])
1229
    # now share it...
1230
    self.assertEqual(self.ls.acquire(None, shared=1), set())
1231
    # other sharers can go, adds still wait
1232
    self._addThread(target=self._doLockSet, args=(None, 1))
1233
    self._waitThreads()
1234
    self.assertEqual(self.done.get_nowait(), 'DONE')
1235
    self._addThread(target=self._doAddSet, args=(['nine']))
1236
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1237
    self.ls.release()
1238
    self._waitThreads()
1239
    self.assertEqual(self.done.get_nowait(), 'DONE')
1240
    self._setUpLS()
1241

    
1242

    
1243
class TestGanetiLockManager(_ThreadedTestCase):
1244

    
1245
  def setUp(self):
1246
    _ThreadedTestCase.setUp(self)
1247
    self.nodes=['n1', 'n2']
1248
    self.instances=['i1', 'i2', 'i3']
1249
    self.GL = locking.GanetiLockManager(nodes=self.nodes,
1250
                                        instances=self.instances)
1251

    
1252
  def tearDown(self):
1253
    # Don't try this at home...
1254
    locking.GanetiLockManager._instance = None
1255

    
1256
  def testLockingConstants(self):
1257
    # The locking library internally cheats by assuming its constants have some
1258
    # relationships with each other. Check those hold true.
1259
    # This relationship is also used in the Processor to recursively acquire
1260
    # the right locks. Again, please don't break it.
1261
    for i in range(len(locking.LEVELS)):
1262
      self.assertEqual(i, locking.LEVELS[i])
1263

    
1264
  def testDoubleGLFails(self):
1265
    self.assertRaises(AssertionError, locking.GanetiLockManager)
1266

    
1267
  def testLockNames(self):
1268
    self.assertEqual(self.GL._names(locking.LEVEL_CLUSTER), set(['BGL']))
1269
    self.assertEqual(self.GL._names(locking.LEVEL_NODE), set(self.nodes))
1270
    self.assertEqual(self.GL._names(locking.LEVEL_INSTANCE),
1271
                     set(self.instances))
1272

    
1273
  def testInitAndResources(self):
1274
    locking.GanetiLockManager._instance = None
1275
    self.GL = locking.GanetiLockManager()
1276
    self.assertEqual(self.GL._names(locking.LEVEL_CLUSTER), set(['BGL']))
1277
    self.assertEqual(self.GL._names(locking.LEVEL_NODE), set())
1278
    self.assertEqual(self.GL._names(locking.LEVEL_INSTANCE), set())
1279

    
1280
    locking.GanetiLockManager._instance = None
1281
    self.GL = locking.GanetiLockManager(nodes=self.nodes)
1282
    self.assertEqual(self.GL._names(locking.LEVEL_CLUSTER), set(['BGL']))
1283
    self.assertEqual(self.GL._names(locking.LEVEL_NODE), set(self.nodes))
1284
    self.assertEqual(self.GL._names(locking.LEVEL_INSTANCE), set())
1285

    
1286
    locking.GanetiLockManager._instance = None
1287
    self.GL = locking.GanetiLockManager(instances=self.instances)
1288
    self.assertEqual(self.GL._names(locking.LEVEL_CLUSTER), set(['BGL']))
1289
    self.assertEqual(self.GL._names(locking.LEVEL_NODE), set())
1290
    self.assertEqual(self.GL._names(locking.LEVEL_INSTANCE),
1291
                     set(self.instances))
1292

    
1293
  def testAcquireRelease(self):
1294
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1295
    self.assertEquals(self.GL._list_owned(locking.LEVEL_CLUSTER), set(['BGL']))
1296
    self.GL.acquire(locking.LEVEL_INSTANCE, ['i1'])
1297
    self.GL.acquire(locking.LEVEL_NODE, ['n1', 'n2'], shared=1)
1298
    self.GL.release(locking.LEVEL_NODE, ['n2'])
1299
    self.assertEquals(self.GL._list_owned(locking.LEVEL_NODE), set(['n1']))
1300
    self.assertEquals(self.GL._list_owned(locking.LEVEL_INSTANCE), set(['i1']))
1301
    self.GL.release(locking.LEVEL_NODE)
1302
    self.assertEquals(self.GL._list_owned(locking.LEVEL_NODE), set())
1303
    self.assertEquals(self.GL._list_owned(locking.LEVEL_INSTANCE), set(['i1']))
1304
    self.GL.release(locking.LEVEL_INSTANCE)
1305
    self.assertRaises(errors.LockError, self.GL.acquire,
1306
                      locking.LEVEL_INSTANCE, ['i5'])
1307
    self.GL.acquire(locking.LEVEL_INSTANCE, ['i3'], shared=1)
1308
    self.assertEquals(self.GL._list_owned(locking.LEVEL_INSTANCE), set(['i3']))
1309

    
1310
  def testAcquireWholeSets(self):
1311
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1312
    self.assertEquals(self.GL.acquire(locking.LEVEL_INSTANCE, None),
1313
                      set(self.instances))
1314
    self.assertEquals(self.GL._list_owned(locking.LEVEL_INSTANCE),
1315
                      set(self.instances))
1316
    self.assertEquals(self.GL.acquire(locking.LEVEL_NODE, None, shared=1),
1317
                      set(self.nodes))
1318
    self.assertEquals(self.GL._list_owned(locking.LEVEL_NODE),
1319
                      set(self.nodes))
1320
    self.GL.release(locking.LEVEL_NODE)
1321
    self.GL.release(locking.LEVEL_INSTANCE)
1322
    self.GL.release(locking.LEVEL_CLUSTER)
1323

    
1324
  def testAcquireWholeAndPartial(self):
1325
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1326
    self.assertEquals(self.GL.acquire(locking.LEVEL_INSTANCE, None),
1327
                      set(self.instances))
1328
    self.assertEquals(self.GL._list_owned(locking.LEVEL_INSTANCE),
1329
                      set(self.instances))
1330
    self.assertEquals(self.GL.acquire(locking.LEVEL_NODE, ['n2'], shared=1),
1331
                      set(['n2']))
1332
    self.assertEquals(self.GL._list_owned(locking.LEVEL_NODE),
1333
                      set(['n2']))
1334
    self.GL.release(locking.LEVEL_NODE)
1335
    self.GL.release(locking.LEVEL_INSTANCE)
1336
    self.GL.release(locking.LEVEL_CLUSTER)
1337

    
1338
  def testBGLDependency(self):
1339
    self.assertRaises(AssertionError, self.GL.acquire,
1340
                      locking.LEVEL_NODE, ['n1', 'n2'])
1341
    self.assertRaises(AssertionError, self.GL.acquire,
1342
                      locking.LEVEL_INSTANCE, ['i3'])
1343
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1344
    self.GL.acquire(locking.LEVEL_NODE, ['n1'])
1345
    self.assertRaises(AssertionError, self.GL.release,
1346
                      locking.LEVEL_CLUSTER, ['BGL'])
1347
    self.assertRaises(AssertionError, self.GL.release,
1348
                      locking.LEVEL_CLUSTER)
1349
    self.GL.release(locking.LEVEL_NODE)
1350
    self.GL.acquire(locking.LEVEL_INSTANCE, ['i1', 'i2'])
1351
    self.assertRaises(AssertionError, self.GL.release,
1352
                      locking.LEVEL_CLUSTER, ['BGL'])
1353
    self.assertRaises(AssertionError, self.GL.release,
1354
                      locking.LEVEL_CLUSTER)
1355
    self.GL.release(locking.LEVEL_INSTANCE)
1356

    
1357
  def testWrongOrder(self):
1358
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1359
    self.GL.acquire(locking.LEVEL_NODE, ['n2'])
1360
    self.assertRaises(AssertionError, self.GL.acquire,
1361
                      locking.LEVEL_NODE, ['n1'])
1362
    self.assertRaises(AssertionError, self.GL.acquire,
1363
                      locking.LEVEL_INSTANCE, ['i2'])
1364

    
1365
  # Helper function to run as a thread that shared the BGL and then acquires
1366
  # some locks at another level.
1367
  def _doLock(self, level, names, shared):
1368
    try:
1369
      self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1370
      self.GL.acquire(level, names, shared=shared)
1371
      self.done.put('DONE')
1372
      self.GL.release(level)
1373
      self.GL.release(locking.LEVEL_CLUSTER)
1374
    except errors.LockError:
1375
      self.done.put('ERR')
1376

    
1377
  @_Repeat
1378
  def testConcurrency(self):
1379
    self.GL.acquire(locking.LEVEL_CLUSTER, ['BGL'], shared=1)
1380
    self._addThread(target=self._doLock,
1381
                    args=(locking.LEVEL_INSTANCE, 'i1', 1))
1382
    self._waitThreads()
1383
    self.assertEqual(self.done.get_nowait(), 'DONE')
1384
    self.GL.acquire(locking.LEVEL_INSTANCE, ['i3'])
1385
    self._addThread(target=self._doLock,
1386
                    args=(locking.LEVEL_INSTANCE, 'i1', 1))
1387
    self._waitThreads()
1388
    self.assertEqual(self.done.get_nowait(), 'DONE')
1389
    self._addThread(target=self._doLock,
1390
                    args=(locking.LEVEL_INSTANCE, 'i3', 1))
1391
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1392
    self.GL.release(locking.LEVEL_INSTANCE)
1393
    self._waitThreads()
1394
    self.assertEqual(self.done.get_nowait(), 'DONE')
1395
    self.GL.acquire(locking.LEVEL_INSTANCE, ['i2'], shared=1)
1396
    self._addThread(target=self._doLock,
1397
                    args=(locking.LEVEL_INSTANCE, 'i2', 1))
1398
    self._waitThreads()
1399
    self.assertEqual(self.done.get_nowait(), 'DONE')
1400
    self._addThread(target=self._doLock,
1401
                    args=(locking.LEVEL_INSTANCE, 'i2', 0))
1402
    self.assertRaises(Queue.Empty, self.done.get_nowait)
1403
    self.GL.release(locking.LEVEL_INSTANCE)
1404
    self._waitThreads()
1405
    self.assertEqual(self.done.get(True, 1), 'DONE')
1406
    self.GL.release(locking.LEVEL_CLUSTER, ['BGL'])
1407

    
1408

    
1409
if __name__ == '__main__':
1410
  testutils.GanetiTestProgram()