1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
# -*- coding: utf-8 -*-
# Pitivi video editor
# Copyright (c) 2009, Alessandro Decina <alessandro.d@gmail.com>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, see <http://www.gnu.org/licenses/>.
"""Tests for the pitivi.undo.undo module."""
# pylint: disable=protected-access
from unittest import mock
from gi.repository import GES
from gi.repository import Gst
from pitivi.undo.base import UndoableAction
from pitivi.undo.undo import UndoableActionLog
from pitivi.undo.undo import UndoableActionStack
from pitivi.undo.undo import UndoError
from pitivi.undo.undo import UndoWrongStateError
from tests import common
class TestUndoableActionStack(common.TestCase):
"""Tests for the UndoableActionStack class."""
def test_undo_do(self):
"""Checks an undo() and do() sequence."""
state = {"actions": 2}
class Action(UndoableAction):
def do(self):
state["actions"] += 1
def undo(self):
state["actions"] -= 1
stack = UndoableActionStack("meh", mergeable=False)
action1 = Action()
action2 = Action()
stack.push(action1)
stack.push(action2)
stack.undo()
self.assertEqual(state["actions"], 0)
stack.do()
self.assertEqual(state["actions"], 2)
def test_undo_error(self):
"""Checks undo a stack containing a failing action."""
stack = UndoableActionStack("meh", mergeable=False)
action1 = mock.Mock(spec=UndoableAction)
action1.expand.return_value = False
action2 = mock.Mock(spec=UndoableAction)
action2.expand.return_value = False
action2.undo.side_effect = UndoError("meh")
action3 = mock.Mock(spec=UndoableAction)
stack.push(action1)
stack.push(action2)
stack.push(action3)
self.assertRaises(UndoError, stack.undo)
self.assertEqual(action1.undo.call_count, 0)
self.assertEqual(action2.undo.call_count, 1)
self.assertEqual(action3.undo.call_count, 1)
class TestUndoableActionLog(common.TestCase):
"""Tests for the UndoableActionLog class."""
def setUp(self):
self.log = UndoableActionLog()
self._connect_to_undoable_action_log(self.log)
self.signals = []
def tearDown(self):
self._disconnect_from_undoable_action_log()
def check_signals(self, *expected_signals):
signals = [item[0] for item in self.signals]
self.assertListEqual(signals, list(expected_signals))
def _undo_action_log_signal_cb(self, log, *args):
args = list(args)
signal_name = args.pop(-1)
self.signals.append((signal_name, args))
def _connect_to_undoable_action_log(self, log):
for signal_name in ("begin", "push", "rollback", "commit", "move"):
log.connect(signal_name, self._undo_action_log_signal_cb, signal_name)
def _disconnect_from_undoable_action_log(self):
self.log.disconnect_by_func(self._undo_action_log_signal_cb)
def test_rollback_wrong_state(self):
self.assertRaises(UndoWrongStateError, self.log.rollback)
def test_commit_wrong_state(self):
self.assertRaises(UndoWrongStateError, self.log.commit, "")
def test_push_wrong_state(self):
# no error in this case
self.log.push(None)
def test_undo_wrong_state(self):
self.assertRaises(UndoWrongStateError, self.log.undo)
def test_redo_wrong_state(self):
self.assertRaises(UndoWrongStateError, self.log.redo)
def test_checkpoint(self):
self.log.begin("meh")
self.log.push(mock.Mock(spec=UndoableAction))
self.assertRaises(UndoWrongStateError, self.log.checkpoint)
self.log.rollback()
self.log.checkpoint()
self.assertNotEqual(self.log._checkpoint, None)
def test_dirty(self):
self.assertFalse(self.log.dirty())
self.log.begin("meh")
self.log.push(mock.Mock(spec=UndoableAction))
self.log.commit("meh")
self.assertTrue(self.log.dirty())
self.log.checkpoint()
self.assertFalse(self.log.dirty())
self.log.undo()
self.assertTrue(self.log.dirty())
self.log.redo()
self.assertFalse(self.log.dirty())
def test_commit(self):
"""Checks committing a stack."""
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("meh")
self.assertEqual(len(self.signals), 1)
name, (_stack,) = self.signals[0]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(self.log.undo_stacks, [])
self.log.push(mock.Mock(spec=UndoableAction))
self.log.commit("meh")
self.assertEqual(len(self.signals), 3)
name, (_stack, _action) = self.signals[1]
self.assertEqual(name, "push")
name, (_stack,) = self.signals[2]
self.assertEqual(name, "commit")
self.assertFalse(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 1)
self.assertEqual(len(self.log.redo_stacks), 0)
def test_commit_proper(self):
self.log.begin("meh")
self.assertRaises(UndoWrongStateError, self.log.commit, "notmeh")
def test_nested_commit(self):
"""Checks two nested commits."""
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("meh")
self.assertEqual(len(self.signals), 1)
name, (_stack,) = self.signals[0]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("nested")
self.assertEqual(len(self.signals), 2)
name, (_stack,) = self.signals[1]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(self.log.undo_stacks, [])
self.log.push(mock.Mock(spec=UndoableAction))
self.log.commit("nested")
self.assertEqual(len(self.signals), 4)
name, (_stack, _action) = self.signals[2]
self.assertEqual(name, "push")
name, (_stack,) = self.signals[3]
self.assertEqual(name, "commit")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.assertEqual(self.log.undo_stacks, [])
self.log.commit("meh")
self.assertEqual(len(self.signals), 5)
name, (_stack,) = self.signals[4]
self.assertEqual(name, "commit")
self.assertFalse(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 1)
self.assertEqual(len(self.log.redo_stacks), 0)
def test_finalizing_action(self):
action1 = mock.Mock()
action2 = mock.Mock()
with self.log.started("one", finalizing_action=action1):
self.log.push(mock.Mock(spec=UndoableAction))
with self.log.started("two", finalizing_action=action2):
self.log.push(mock.Mock(spec=UndoableAction))
action1.do.assert_called_once_with()
# For now, we call the finalizing action only for the top stack.
action2.do.assert_not_called()
def test_rollback(self):
"""Checks a rollback."""
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("meh")
self.check_signals("begin")
name, (_stack,) = self.signals[0]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
action = mock.Mock(spec=UndoableAction)
self.log.push(action)
self.log.rollback()
action.undo.assert_called_once_with()
self.check_signals("begin", "push", "rollback")
name, (_stack,) = self.signals[2]
self.assertEqual(name, "rollback")
self.assertFalse(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
def test_rollback_noop(self):
"""Checks a rollback which does not act."""
self.log.begin("meh")
action = mock.Mock(spec=UndoableAction)
self.log.push(action)
self.log.rollback(undo=False)
action.undo.assert_not_called()
def test_nested_rollback(self):
"""Checks two nested rollbacks."""
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("meh")
self.assertEqual(len(self.signals), 1)
name, (_stack,) = self.signals[0]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.begin("nested")
self.assertEqual(len(self.signals), 2)
name, (_stack,) = self.signals[1]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
self.log.rollback()
self.assertEqual(len(self.signals), 3)
name, (_stack,) = self.signals[2]
self.assertEqual(name, "rollback")
self.assertTrue(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.rollback()
self.assertEqual(len(self.signals), 4)
name, (_stack,) = self.signals[3]
self.assertEqual(name, "rollback")
self.assertFalse(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
def test_undo_redo(self):
"""Tries an undo() redo() sequence."""
# begin
self.log.begin("meh")
self.assertEqual(len(self.signals), 1)
name, (_stack,) = self.signals[0]
self.assertEqual(name, "begin")
self.assertTrue(self.log.is_in_transaction())
# push two actions
action1 = mock.Mock(spec=UndoableAction)
action1.expand.return_value = False
self.log.push(action1)
self.assertEqual(len(self.signals), 2)
name, (_stack, signal_action) = self.signals[1]
self.assertEqual(name, "push")
self.assertTrue(action1 is signal_action)
action2 = mock.Mock(spec=UndoableAction)
self.log.push(action2)
self.assertEqual(len(self.signals), 3)
name, (_stack, signal_action) = self.signals[2]
self.assertEqual(name, "push")
self.assertTrue(action2 is signal_action)
# commit
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
self.log.commit("meh")
self.assertEqual(len(self.signals), 4)
name, (_stack,) = self.signals[3]
self.assertEqual(name, "commit")
self.assertFalse(self.log.is_in_transaction())
self.assertEqual(len(self.log.undo_stacks), 1)
self.assertEqual(len(self.log.redo_stacks), 0)
self.assertEqual(action1.do.call_count, 0)
self.assertEqual(action1.undo.call_count, 0)
self.assertEqual(action2.do.call_count, 0)
self.assertEqual(action2.undo.call_count, 0)
# undo what we just committed
self.log.undo()
self.assertEqual(len(self.signals), 5)
name, _args = self.signals[4]
self.assertEqual(name, "move")
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 1)
self.assertEqual(action1.do.call_count, 0)
self.assertEqual(action1.undo.call_count, 1)
self.assertEqual(action2.do.call_count, 0)
self.assertEqual(action2.undo.call_count, 1)
# redo
self.log.redo()
self.assertEqual(len(self.signals), 6)
name, _args = self.signals[5]
self.assertEqual(name, "move")
self.assertEqual(len(self.log.undo_stacks), 1)
self.assertEqual(len(self.log.redo_stacks), 0)
self.assertEqual(action1.do.call_count, 1)
self.assertEqual(action1.undo.call_count, 1)
self.assertEqual(action2.do.call_count, 1)
self.assertEqual(action2.undo.call_count, 1)
def test_order(self):
"""Checks actions are undone and redone in the correct order."""
order = mock.Mock()
order.action1 = mock.Mock(spec=UndoableAction)
order.action1.expand.return_value = False
order.action2 = mock.Mock(spec=UndoableAction)
order.action2.expand.return_value = False
order.action3 = mock.Mock(spec=UndoableAction)
order.action3.expand.return_value = False
with self.log.started("meh"):
self.log.push(order.action1)
with self.log.started("nested"):
self.log.push(order.action2)
self.log.push(order.action3)
self.log.undo()
order.assert_has_calls([mock.call.action3.undo(),
mock.call.action2.undo(),
mock.call.action1.undo()])
self.log.redo()
order.assert_has_calls([mock.call.action1.do(),
mock.call.action2.do(),
mock.call.action3.do()])
self.log.undo()
order.assert_has_calls([mock.call.action3.undo(),
mock.call.action2.undo(),
mock.call.action1.undo()])
def test_toplevel_operation(self):
"""Checks the toplevel operations nesting."""
self.log.begin("one", toplevel=False)
self.log.commit("one")
self.log.begin("two", toplevel=True)
self.log.commit("two")
self.log.begin("three")
self.assertRaises(UndoWrongStateError,
self.log.begin,
"four", toplevel=True)
self.log.begin("nested1")
self.log.begin("nested2", toplevel=False)
def test_failing_operation_rollback(self):
"""Checks that failing operations are rolled back."""
action = mock.Mock(spec=UndoableAction)
class WatchingError(Exception):
pass
with self.assertRaises(WatchingError):
with self.log.started("failing_op"):
self.log.push(action)
raise WatchingError()
# Check the rollback happened
self.assertEqual(action.do.call_count, 0)
self.assertEqual(action.undo.call_count, 1)
# Check the undo and redo stacks are empty
self.assertEqual(len(self.log.undo_stacks), 0)
self.assertEqual(len(self.log.redo_stacks), 0)
def test_merging(self):
with self.log.started("one", mergeable=False):
action = mock.Mock(spec=UndoableAction)
action.expand.side_effect = Exception("should not have been called")
self.log.push(action)
self.assertEqual(len(self.log.undo_stacks), 1)
with self.log.started("one", mergeable=True):
action = mock.Mock(spec=UndoableAction)
action.expand.return_value = False
self.log.push(action)
self.assertEqual(len(self.log.undo_stacks), 2)
with self.log.started("one", mergeable=True):
action = mock.Mock(spec=UndoableAction)
action.expand.return_value = True
self.log.push(action)
self.assertEqual(len(self.log.undo_stacks), 3)
with self.log.started("one", mergeable=True):
action = mock.Mock(spec=UndoableAction)
action.expand.return_value = True
self.log.push(action)
self.assertEqual(len(self.log.undo_stacks), 3)
with self.log.started("one", mergeable=False):
action = mock.Mock(spec=UndoableAction)
action.expand.side_effect = Exception("should not have been called")
self.log.push(action)
self.assertEqual(len(self.log.undo_stacks), 4)
class TestRollback(common.TestCase):
@common.setup_timeline
def test_rollback_of_nested_operation_does_not_add_actions_to_parent(self):
clip1 = GES.TitleClip()
clip1.set_start(0 * Gst.SECOND)
clip1.set_duration(1 * Gst.SECOND)
clip2 = GES.TitleClip()
clip2.set_start(1 * Gst.SECOND)
clip2.set_duration(1 * Gst.SECOND)
# begin parent operation
self.action_log.begin("parent")
# push one parent action
self.layer.add_clip(clip1)
stack_snapshot = self.action_log._get_last_stack().done_actions[::]
# begin nested operation
self.action_log.begin("nested")
# push one nested action
self.layer.add_clip(clip2)
self.action_log.rollback()
self.assertListEqual(self.action_log._get_last_stack().done_actions, stack_snapshot)
|
