office-gobmx/pyuno/qa/pytests/testcollections_XIndexAccess.py
Stephan Bergmann e7a3329fd0 DeInitVCL in PythonTest
After b9757f5cfd "loplugin:useuniqueptr in
vcl/svdata" ASan/UBSan builds started to fail (like
<https://ci.libreoffice.org//job/lo_ubsan/1025/>) at the end of
PythonTest_dbaccess_python (and probably other PythonTests), when during exit
the static utl::ConfigManager instance already happens to be destroyed by the
time the static ImplSVData's mpSettingsConfigItem is destroyed (which would
normally be cleared during DeInitVCL, if PythonTests would call that, and which
in the past had thus simply been leaked in PythonTests when that
mpSettingsConfigItem was a plain pointer instead of std::unique_ptr).

So ensure that PythonTests that initialize VCL also call DeInitVCL, via a new
private_deinitTestEnvironment, complementing the existing
private_initTestEnvironment.

However, while private_initTestEnvironment is called once (typically via
UnoInProcess.setUp, which internally makes sure to only call it once) as soon as
the first executed test needs it, private_deinitTestEnvironment must be called
once after the lasts test needing it has executed.  The only way that I found to
do that is to override unittest.TextTestResult's stopTestRun method, which is
called once after all tests have been executed.  Hence a new test runner setup
in unotest/source/python/org/libreoffice/unittest.py that is now called from
solenv/gbuild/PythonTest.mk.

That revealed a few places in PythonTests that didn't yet close/delete documents
that they had opened, which has now been added.

One remaining problem then is that classes like SwXTextDocument and friends call
Application::GetSolarMutex from their dtors, via sw::UnoImplPtrDeleter (a "Smart
pointer class ensuring that the pointed object is deleted with a locked
SolarMutex", sw/inc/unobaseclass.hxx).  That means that any PyUNO proxies to
such C++ objects that remain alive after private_deinitTestEnvironment will
cause issues at exit, when Python does a final garbage collection of those
objects.  The ultimate fix will be to remove that unhelpful UnoImplPtrDeleter
and its locking of SolarMutex from the dtors of UNO objects; until then, the
Python code is now sprinkled with some HACKs to make sure all those PyUNO
proxies are released in a timely fashion (see the comment in
unotest/source/python/org/libreoffice/unittest.py for details).  (Also, it would
probably help if UnoInProcess didn't keep a local self.xDoc around referencing
(just) the last result of calling one of its open* methods, confusingly making
it the responsibility of UnoInProcess to close that one document while making it
the responsibility of the test code making the other UnoInProcess.open* calls to
close any other documents.)

Change-Id: Ief27c81e2b763e9be20cbf3234b68924315f13be
Reviewed-on: https://gerrit.libreoffice.org/60100
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2018-09-07 07:31:48 +02:00

326 lines
10 KiB
Python

#!/usr/bin/env python
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
import unittest
import uno
from inspect import isclass
from testcollections_base import CollectionsTestBase
from com.sun.star.beans import PropertyValue
# Footnote instance factory
def getFootnoteInstance(doc):
return doc.createInstance("com.sun.star.text.Footnote")
# Tests behaviour of objects implementing XIndexAccess using the new-style
# collection accessors
# The objects chosen have no special meaning, they just happen to implement the
# tested interfaces
class TestXIndexAccess(CollectionsTestBase):
def insertTestFootnotes(self, doc, count):
cursor = doc.Text.createTextCursor()
for i in range(count):
footnote = getFootnoteInstance(doc)
footnote.Label = 'n'+str(i)
doc.Text.insertTextContent(cursor, footnote, 0)
def readValuesTestFixture(self, doc, count, key, expected):
# Given
doc.Text.setString('')
self.insertTestFootnotes(doc, count)
# When
captured = None
try:
actual = doc.Footnotes[key]
except Exception as e:
captured = e
# Then
if isclass(expected) and issubclass(expected, Exception):
# expected is exception
self.assertNotEqual(None, captured)
self.assertEqual(expected.__name__, type(captured).__name__)
elif type(expected) is tuple:
# expected is tuple
self.assertEqual(None, captured)
self.assertTrue(type(actual) is tuple)
self.assertEqual(len(expected), len(actual))
for i in range(len(expected)):
self.assertEqual('n'+str(expected[i]), actual[i].Label)
else:
# expected is value
self.assertEqual(None, captured)
self.assertTrue(type(actual) is not tuple)
self.assertEqual('n'+str(expected), actual.Label)
# Tests syntax:
# num = len(obj) # Number of elements
# For:
# length = 0
def test_XIndexAccess_Len_0(self):
# Given
doc = self.createBlankTextDocument()
# When
count = len(doc.Footnotes)
# Then
self.assertEqual(0, count)
doc.close(True);
# Tests syntax:
# num = len(obj) # Number of elements
# For:
# length = 1
def test_XIndexAccess_Len_1(self):
# Given
doc = self.createBlankTextDocument()
cursor = doc.Text.createTextCursor()
footnote = getFootnoteInstance(doc)
doc.Text.insertTextContent(cursor, footnote, 0)
# When
count = len(doc.Footnotes)
# Then
self.assertEqual(1, count)
doc.close(True);
# Tests syntax:
# val = obj[0] # Access by index
# For:
# Single indices
def test_XIndexAccess_ReadIndex_Single(self):
doc = self.createBlankTextDocument()
self.readValuesTestFixture(doc, 0, -1, IndexError)
self.readValuesTestFixture(doc, 0, 0, IndexError)
self.readValuesTestFixture(doc, 0, 1, IndexError)
self.readValuesTestFixture(doc, 1, -3, IndexError)
self.readValuesTestFixture(doc, 1, -2, IndexError)
self.readValuesTestFixture(doc, 1, -1, 0)
self.readValuesTestFixture(doc, 1, 0, 0)
self.readValuesTestFixture(doc, 1, 1, IndexError)
self.readValuesTestFixture(doc, 1, 2, IndexError)
self.readValuesTestFixture(doc, 2, -4, IndexError)
self.readValuesTestFixture(doc, 2, -3, IndexError)
self.readValuesTestFixture(doc, 2, -2, 0)
self.readValuesTestFixture(doc, 2, -1, 1)
self.readValuesTestFixture(doc, 2, 0, 0)
self.readValuesTestFixture(doc, 2, 1, 1)
self.readValuesTestFixture(doc, 2, 2, IndexError)
self.readValuesTestFixture(doc, 2, 3, IndexError)
doc.close(True);
def test_XIndexAccess_ReadIndex_Single_Invalid(self):
doc = self.createBlankTextDocument()
self.readValuesTestFixture(doc, 0, None, TypeError)
self.readValuesTestFixture(doc, 0, 'foo', TypeError)
self.readValuesTestFixture(doc, 0, 12.34, TypeError)
self.readValuesTestFixture(doc, 0, (0, 1), TypeError)
self.readValuesTestFixture(doc, 0, [0, 1], TypeError)
self.readValuesTestFixture(doc, 0, {'a': 'b'}, TypeError)
doc.close(True);
# Tests syntax:
# val1,val2 = obj[2:4] # Access by slice
def test_XIndexAccess_ReadSlice(self):
doc = self.createBlankTextDocument()
test_max = 4
for i in range(test_max):
t = tuple(range(i))
for j in [x for x in range(-test_max-2, test_max+3)] + [None]:
for k in [x for x in range(-test_max-2, test_max+3)] + [None]:
key = slice(j, k)
expected = t[key]
self.readValuesTestFixture(doc, i, key, expected)
doc.close(True);
# Tests syntax:
# val1,val2 = obj[0:3:2] # Access by extended slice
def test_XIndexAccess_ReadExtendedSlice(self):
doc = self.createBlankTextDocument()
test_max = 4
for i in range(test_max):
t = tuple(range(i))
for j in [x for x in range(-test_max-2, test_max+3)] + [None]:
for k in [x for x in range(-test_max-2, test_max+3)] + [None]:
for l in [-2, -1, 2]:
key = slice(j, k, l)
expected = t[key]
self.readValuesTestFixture(doc, i, key, expected)
doc.close(True);
# Tests syntax:
# if val in obj: ... # Test value presence
# For:
# Present element
def test_XIndexAccess_In_Present(self):
# Given
doc = self.createBlankTextDocument()
cursor = doc.Text.createTextCursor()
footnote = getFootnoteInstance(doc)
footnote.setLabel('foo')
doc.Text.insertTextContent(cursor, footnote, 0)
footnote = doc.Footnotes.getByIndex(0)
# When
present = footnote in doc.Footnotes
# Then
self.assertTrue(present)
doc.close(True);
# Tests syntax:
# if val in obj: ... # Test value presence
# For:
# None
def test_XIndexAccess_In_None(self):
# Given
doc = self.createBlankTextDocument()
# When
present = None in doc.Footnotes
# Then
self.assertFalse(present)
doc.close(True);
# Tests syntax:
# if val in obj: ... # Test value presence
# For:
# Absent element (string)
def test_XIndexAccess_In_String(self):
# Given
doc = self.createBlankTextDocument()
# When / Then
present = "foo" in doc.Footnotes
# Then
self.assertFalse(present)
doc.close(True);
# Tests syntax:
# if val in obj: ... # Test value presence
# For:
# Absent element (dict)
def test_XIndexAccess_In_Dict(self):
# Given
doc = self.createBlankTextDocument()
# When / Then
with self.assertRaises(TypeError):
present = {} in doc.Footnotes
doc.close(True);
# Tests syntax:
# for val in obj: ... # Implicit iterator (values)
# For:
# 0 elements
def test_XIndexAccess_ForIn_0(self):
# Given
doc = self.createBlankTextDocument()
# When
read_footnotes = []
for f in doc.Footnotes:
read_footnotes.append(f)
# Then
self.assertEqual(0, len(read_footnotes))
doc.close(True);
# Tests syntax:
# for val in obj: ... # Implicit iterator (values)
# For:
# 1 element
def test_XIndexAccess_ForIn_1(self):
# Given
doc = self.createBlankTextDocument()
cursor = doc.Text.createTextCursor()
footnote = getFootnoteInstance(doc)
footnote.setLabel('foo')
doc.Text.insertTextContent(cursor, footnote, 0)
# When
read_footnotes = []
for f in doc.Footnotes:
read_footnotes.append(f)
# Then
self.assertEqual(1, len(read_footnotes))
self.assertEqual('foo', read_footnotes[0].Label)
doc.close(True);
# Tests syntax:
# for val in obj: ... # Implicit iterator (values)
# For:
# 2 elements
def test_XIndexAccess_ForIn_2(self):
# Given
doc = self.createBlankTextDocument()
cursor = doc.Text.createTextCursor()
footnote1 = getFootnoteInstance(doc)
footnote2 = getFootnoteInstance(doc)
footnote1.setLabel('foo')
footnote2.setLabel('bar')
doc.Text.insertTextContent(cursor, footnote1, 0)
doc.Text.insertTextContent(cursor, footnote2, 0)
# When
read_footnotes = []
for f in doc.Footnotes:
read_footnotes.append(f)
# Then
self.assertEqual(2, len(read_footnotes))
self.assertEqual('foo', read_footnotes[0].Label)
self.assertEqual('bar', read_footnotes[1].Label)
doc.close(True);
# Tests syntax:
# itr = iter(obj) # Named iterator (values)
# For:
# 1 element
def test_XIndexAccess_Iter_0(self):
# Given
doc = self.createBlankTextDocument()
cursor = doc.Text.createTextCursor()
footnote = getFootnoteInstance(doc)
footnote.setLabel('foo')
doc.Text.insertTextContent(cursor, footnote, 0)
# When
itr = iter(doc.Footnotes)
# Then
self.assertIsNotNone(next(itr))
with self.assertRaises(StopIteration):
next(itr)
doc.close(True);
if __name__ == '__main__':
unittest.main()
# vim:set shiftwidth=4 softtabstop=4 expandtab: