# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 Rickard Lindberg, Roger Lindberg
#
# This file is part of Timeline.
#
# Timeline is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Timeline 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Timeline. If not, see <http://www.gnu.org/licenses/>.
import contextlib
import gc
import random
import unittest
import wx
from timelinelib.calendar.gregorian.timetype import GregorianTimeType
from timelinelib.test.utils import svg_to_dict
[docs]class UnitTestCase(unittest.TestCase):
HALT_GUI = False
AUTO_CLOSE = False
[docs] def assertSvgEqual(self, left, right):
self.assertEqual(svg_to_dict(left), svg_to_dict(right), "\nLeft: {!r}\nRight: {!r}".format(left, right))
[docs] def assertPeriodsEqual(self, first, second, time_type=GregorianTimeType()):
message = "Periods not equal.\n First: %s \"%s\"\n Second: %s \"%s\"" % (
first,
time_type.format_period(first),
second,
time_type.format_period(second),
)
self.assertEqual(first, second, message)
[docs] def assertInstanceNotIn(self, object_, list_):
for element in list_:
if element is object_:
self.fail("%r was in list" % object_)
[docs] def assertEqNeImplementationIsCorrect(self, create_fn, modifiers):
(modification_description, modifier_fn) = get_random_modifier(modifiers)
one = modifier_fn(create_fn())
other = modifier_fn(create_fn())
fail_message_one_other = "%r vs %r (%s)" % (one, other,
modification_description)
self.assertTrue(type(one) == type(other), fail_message_one_other)
self.assertFalse(one is None, fail_message_one_other)
self.assertTrue(one is not None, fail_message_one_other)
self.assertTrue(one is not other, fail_message_one_other)
self.assertFalse(one is other, fail_message_one_other)
self.assertTrue(one == other, fail_message_one_other)
self.assertFalse(one != other, fail_message_one_other)
self.assertTrue(one == one, fail_message_one_other)
self.assertFalse(one != one, fail_message_one_other)
(modification_description, modifier_fn) = get_random_modifier(modifiers)
modified = modifier_fn(other)
fail_message_modified_one = "%r vs %r (%s)" % (modified, one,
modification_description)
self.assertTrue(type(modified) == type(one), fail_message_modified_one)
self.assertTrue(modified is not one, fail_message_modified_one)
self.assertFalse(modified is one, fail_message_modified_one)
self.assertTrue(modified != one, fail_message_modified_one)
self.assertFalse(modified == one, fail_message_modified_one)
[docs] def show_dialog(self, dialog_class, *args, **kwargs):
with self.wxapp() as app:
dialog = dialog_class(*args, **kwargs)
try:
if self.HALT_GUI:
if self.AUTO_CLOSE:
wx.CallLater(2000, dialog.Close)
dialog.ShowModal()
finally:
dialog.Destroy()
[docs] @contextlib.contextmanager
def wxapp(self):
app = self.get_wxapp()
try:
yield app
finally:
self.destroy_wxapp(app)
[docs] def get_wxapp(self):
return wx.App(False)
[docs] def destroy_wxapp(self, app):
if app.GetTopWindow():
app.GetTopWindow().Destroy()
app.Destroy()
# A problem was seen when running these two tests in sequence:
#
# unit.calendar.num.periodpicker.TestNumPeriodPicker.test_show_manual_test_dialog
# timelinelib.general.xmlparser
#
# The first one uses wx.App. The doctest failed because it did not seem
# to capture stdout. I suspect that wx.App does something with stdout,
# and a clean shutdown is needed to restore it. For some reason a
# gc.collect() seems to fix it. I'm not sure why, but this seems to
# work.
#
# The failure did not always happen, so I suspect it was a timing
# issue. If the gc.collect() happened in time, the error did not
# occur.
gc.collect()
[docs]def get_random_modifier(modifiers):
return random.choice(modifiers)