def test_window(self):
# Note: UIActionSimulator.Text() doesn't seem to work on wxPython 4.0.7,
# but it works again on wxPython 4.1. It worked on wxPython 4.0.1.
wx_ver = tuple(int(v) for v in wx.__version__.split("."))
if wx_ver < (4, 1, 0):
logging.warning(
"Test case is known to fail on wxPython 4.0.7 due to buggy UIActionSimulator.Text"
)
bugreporter = OdemisBugreporter()
# Special verison of .run(), which simulates inputs
bugreporter._compress_files_f = bugreporter._executor.submit(
bugreporter.compress_files)
app = wx.App()
gui = BugreporterFrame(bugreporter)
bugreporter.gui = gui
# Create simulator and focus field
sim = wx.UIActionSimulator()
self.gui_loop(0.1)
# Fill up the form
gui.name_ctrl.SetFocus()
# TODO: how to simulate typing non ascii-characters? .Char() + modifiers?
# sim.Text(b"Tstingteam member")
gui.name_ctrl.SetValue(u"TÉstingteam member")
self.gui_loop(0.1)
gui.email_ctrl.SetFocus()
gui.email_ctrl.SetValue(TEST_SUPPORT_TEAM_EMAIL)
# sim.Text(TEST_SUPPORT_TEAM_EMAIL) # "@" doesn't work
self.gui_loop(0.1)
gui.summary_ctrl.SetFocus()
sim.Text(b"Bugreporter test")
self.gui_loop(0.1)
gui.description_ctrl.SetFocus()
sim.Text(b"This is a test")
self.gui_loop(0.1)
# Simulates a "click" on the button by pressing Enter
gui.report_btn.SetFocus()
sim.Char(ord("\r"))
self.gui_loop(0.1)
try:
# If sent successfully, the window should close after a few seconds
self.gui_loop(2)
bugreporter._compress_files_f.result()
self.gui_loop(2)
self.assertFalse(
gui
) # wxPython widgets which are destroyed are considered "False"
bugreporter._executor.shutdown(
) # wait for the background tasks to complete
finally:
# app.MainLoop() # DEBUG: For leaving the window afterwards
if gui:
gui.Destroy()
def setUp(self):
self.bugreporter = OdemisBugreporter()
class TestOdemisBugreporter(unittest.TestCase):
def setUp(self):
self.bugreporter = OdemisBugreporter()
def test_search_api_key(self):
"""
Tests search_api_key function.
"""
# If test computer has key saved in .local/share/odemis or /usr/share/odemis,
# check this key, otherwise expect LookupError
customer_key_path = os.path.join(os.path.expanduser(u"~"), '.local',
'share', 'odemis', 'osticket.key')
fallback_key_path = os.path.join('/usr', 'share', 'odemis',
'osticket.key')
if not os.path.isfile(customer_key_path) and not os.path.isfile(
fallback_key_path):
self.assertRaises(LookupError, self.bugreporter.search_api_key)
else:
try:
api_key = self.bugreporter.search_api_key()
self.assertEqual(type(api_key), str,
"API key needs to be a string.")
self.assertFalse(
'\n' in api_key,
"API key should not contain newline character")
except Exception as e:
self.fail("search_api_key failed with exception %s" % e)
def test_source_api_key(self):
"""
Tests format of source api key.
"""
with open(TEST_KEY_PATH, 'r') as key_file:
api_key = key_file.read().strip('\n')
self.assertEqual(type(api_key), str, "API key needs to be a string.")
self.assertFalse('\n' in api_key,
"API key should not contain newline character")
def test_create_ticket(self):
"""
Tests ticket creation on osticket server.
"""
if TEST_NO_SUPPORT_TICKET == 1:
logging.info('Skipping "test_create_ticket"')
return
with open(TEST_KEY_PATH, 'r') as key_file:
api_key = key_file.read().strip('\n')
description = {
'name': u'TÉstingteam member',
'email': u'*****@*****.**',
'subject': u'Bugreporter test',
'message':
u"This is a test, including some non-ascii characters like µ or 你好",
'topicId': REPORTER_TEST_ID,
'attachments': [],
}
# Check without a file
try:
self.bugreporter.create_ticket(api_key, description)
except Exception as e:
self.fail('Uploading without a file failed with exception %s' % e)
def test_wrong_api_key(self):
"""Create a ticket with an incorrect API key"""
description = {
'name': u'Testingteam member',
'email': u'*****@*****.**',
'subject': u'Bugreporter test',
'message': u"This is a test",
'topicId': REPORTER_TEST_ID,
'attachments': [],
}
incorrect_api_key = 'xxxxxxx'
self.assertRaises(HTTPError, self.bugreporter.create_ticket,
incorrect_api_key, description)
def test_large_file(self):
"""
Tests whether large files are compressed and uploaded properly.
"""
# Add large file to list of files that will be compressed
if not os.path.isdir(
os.path.expanduser(u"~") + '/odemis-overlay-report'):
os.mkdir(os.path.expanduser(u"~") + '/odemis-overlay-report')
fn = os.path.expanduser(
u"~") + '/odemis-overlay-report/bugreporter_test'
with open(fn, 'w+') as f:
f.write('x' * int(5e8)) # 500 MB file
# Compress
try:
self.bugreporter.compress_files()
except Exception as e:
self.fail("Compression of large file failed with exception %s" % e)
self.assertTrue(zipfile.is_zipfile(self.bugreporter.zip_fn))
files = [
'odemis.log', 'odemis-gui.log', 'odemis-gui.log.1', 'odemis.conf',
'syslog', 'odemis-mic-selector.log', 'odemis-bug-screenshot.png'
]
zip_file = zipfile.ZipFile(self.bugreporter.zip_fn)
for f in files:
if os.path.isfile(f):
self.assertTrue(f in zip_file.namelist(),
"File %s not found in archive." % f)
# Create ticket
if TEST_NO_SUPPORT_TICKET != 1:
with open(TEST_KEY_PATH, 'r') as key_file:
api_key = key_file.read().strip('\n')
description = {
'name': 'Testingteam member',
'email': TEST_SUPPORT_TEAM_EMAIL,
'subject': 'Bugreporter test',
'message': "This is a test.",
'topicId': REPORTER_TEST_ID,
'attachments': [],
}
try:
self.bugreporter.create_ticket(api_key, description,
[self.bugreporter.zip_fn])
except Exception as e:
os.remove(self.bugreporter.zip_fn)
os.remove(fn)
self.fail(
'Uploading with a large file failed with exception %s' % e)
os.remove(self.bugreporter.zip_fn)
os.remove(fn)
def test_compress_file(self):
"""Test log file compression"""
self.bugreporter.compress_files()
self.assertTrue(zipfile.is_zipfile(self.bugreporter.zip_fn))
os.remove(self.bugreporter.zip_fn)
def test_window(self):
bugreporter = OdemisBugreporter()
# Special verison of .run(), which simulates inputs
bugreporter._compress_files_f = bugreporter._executor.submit(
bugreporter.compress_files)
app = wx.App()
gui = BugreporterFrame(bugreporter)
bugreporter.gui = gui
# Create simulator and focus field
sim = wx.UIActionSimulator()
self.gui_loop(0.1)
# Fill up the form
gui.name_ctrl.SetFocus()
# TODO: how to simulate typing non ascii-characters? .Char() + modifiers?
# sim.Text(u"Tstingteam member")
gui.name_ctrl.SetValue(u"TÉstingteam member")
self.gui_loop(0.1)
gui.email_ctrl.SetFocus()
gui.email_ctrl.SetValue(TEST_SUPPORT_TEAM_EMAIL)
# sim.Text(TEST_SUPPORT_TEAM_EMAIL) # "@" doesn't work
self.gui_loop(0.1)
gui.summary_ctrl.SetFocus()
sim.Text("Bugreporter test")
self.gui_loop(0.1)
gui.description_ctrl.SetFocus()
sim.Text("This is a test")
self.gui_loop(0.1)
# Simulates a "click" on the button by pressing Enter
gui.report_btn.SetFocus()
sim.Char(ord("\r"))
self.gui_loop(0.1)
try:
# If sent successfully, the window should close after a few seconds
self.gui_loop(2)
bugreporter._compress_files_f.result()
self.gui_loop(2)
self.assertFalse(
gui
) # wxPython widgets which are destroyed are considered "False"
bugreporter._executor.shutdown(
) # wait for the background tasks to complete
finally:
# app.MainLoop() # DEBUG: For leaving the window afterwards
if gui:
gui.Destroy()
def gui_loop(self, slp=0):
"""
Execute the main loop for the GUI until all the current events are processed
slp (0<=float): time to wait (s)
"""
start = time.time()
app = wx.GetApp()
if app is None:
return
while True:
wx.CallAfter(app.ExitMainLoop)
app.MainLoop()
if time.time() > (start + slp):
break