office-gobmx/pyuno/qa/pytests/testcollections_XCellRange.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

401 lines
12 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 testcollections_base import CollectionsTestBase
from com.sun.star.beans import PropertyValue
from com.sun.star.table import CellAddress
# TextTable instance factory
def getTextTableInstance(doc):
return doc.createInstance('com.sun.star.text.TextTable')
# Tests behaviour of objects implementing XCellRange using the new-style
# collection accessors
class TestXCellRange(CollectionsTestBase):
# TODO negative indices
# Tests syntax:
# cell = cellrange[0,0] # Access cell by indices
# For:
# Spreadsheet
# Cell at Row 0, Col 0
def test_XCellRange_Spreadsheet_Cell_00(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
cell = sht[0, 0]
# Then
self.assertEqual(0, cell.CellAddress.Sheet)
self.assertEqual(0, cell.CellAddress.Row)
self.assertEqual(0, cell.CellAddress.Column)
spr.close(True)
# Tests syntax:
# cell = cellrange[0,0] # Access cell by indices
# For:
# Text table
# Cell at Row 0, Col 0
def test_XCellRange_Table_Cell_00(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
# When
cell = tbl[0, 0]
# Then
self.assertEqual('A1', cell.CellName)
doc.close(True)
# Tests syntax:
# cell = cellrange[0,0] # Access cell by indices
# For:
# Spreadsheet
# Cell at Row 3, Col 7
def test_XCellRange_Spreadsheet_Cell_37(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[3, 7]
# Then
self.assertEqual(0, rng.CellAddress.Sheet)
self.assertEqual(3, rng.CellAddress.Row)
self.assertEqual(7, rng.CellAddress.Column)
spr.close(True)
# Tests syntax:
# cell = cellrange[0,0] # Access cell by indices
# For:
# Text table
# Cell at Row 3, Col 7
def test_XCellRange_Table_Cell_37(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
# When
cell = tbl[3, 7]
# Then
self.assertEqual('H4', cell.CellName)
doc.close(True)
# Tests syntax:
# rng = cellrange[0,1:2] # Access cell range by index,slice
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_Index_Slice(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[0, 1:3]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(0, rng.RangeAddress.StartRow)
self.assertEqual(1, rng.RangeAddress.StartColumn)
self.assertEqual(0, rng.RangeAddress.EndRow)
self.assertEqual(2, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[0,1:2] # Access cell range by index,slice
# For:
# Text table
def test_XCellRange_Table_Range_Index_Slice(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
doc.lockControllers()
tbl.DataArray = tuple(tuple(str(100 + y) for y in range(10*x, 10*x + 10)) for x in range(10))
doc.unlockControllers()
# When
rng = tbl[0, 1:3]
# Then
self.assertEqual((('101', '102'),), rng.DataArray)
doc.close(True)
# Tests syntax:
# rng = cellrange[1:2,0] # Access cell range by slice,index
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_Slice_Index(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[1:3, 0]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(1, rng.RangeAddress.StartRow)
self.assertEqual(0, rng.RangeAddress.StartColumn)
self.assertEqual(2, rng.RangeAddress.EndRow)
self.assertEqual(0, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[1:2,0] # Access cell range by index,slice
# For:
# Text table
def test_XCellRange_Table_Range_Slice_Index(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
doc.lockControllers()
tbl.DataArray = tuple(tuple(str(100 + y) for y in range(10*x, 10*x + 10)) for x in range(10))
doc.unlockControllers()
# When
rng = tbl[1:3, 0]
# Then
self.assertEqual((('110',), ('120',)), rng.DataArray)
doc.close(True)
# Tests syntax:
# rng = cellrange[0:1,2:3] # Access cell range by slices
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_Slices(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[1:3, 3:5]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(1, rng.RangeAddress.StartRow)
self.assertEqual(3, rng.RangeAddress.StartColumn)
self.assertEqual(2, rng.RangeAddress.EndRow)
self.assertEqual(4, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[0:1,2:3] # Access cell range by slices
# For:
# Spreadsheet
# Zero rows/columns
def test_XCellRange_Spreadsheet_Range_Slices_Invalid(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When / Then
with self.assertRaises(KeyError):
rng = sht[1:1, 3:5]
with self.assertRaises(KeyError):
rng = sht[1:3, 3:3]
spr.close(True)
# Tests syntax:
# rng = cellrange[0:1,2:3] # Access cell range by slices
# For:
# Text table
def test_XCellRange_Table_Range_Slices(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
doc.lockControllers()
tbl.DataArray = tuple(tuple(str(100 + y) for y in range(10*x, 10*x + 10)) for x in range(10))
doc.unlockControllers()
# When
rng = tbl[1:3, 3:5]
# Then
self.assertEqual((('113', '114'), ('123', '124')), rng.DataArray)
doc.close(True)
# Tests syntax:
# rng = cellrange['A1:B2'] # Access cell range by descriptor
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_Descriptor(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht['A3:B4']
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(2, rng.RangeAddress.StartRow)
self.assertEqual(0, rng.RangeAddress.StartColumn)
self.assertEqual(3, rng.RangeAddress.EndRow)
self.assertEqual(1, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange['A1:B2'] # Access cell range by descriptor
# For:
# Table
def test_XCellRange_Table_Range_Descriptor(self):
# Given
doc = self.createBlankTextDocument()
text_table = getTextTableInstance(doc)
text_table.initialize(10, 10)
cursor = doc.Text.createTextCursor()
doc.Text.insertTextContent(cursor, text_table, False)
tbl = doc.TextTables.getByIndex(0)
doc.lockControllers()
tbl.DataArray = tuple(tuple(str(100 + y) for y in range(10*x, 10*x + 10)) for x in range(10))
doc.unlockControllers()
# When
rng = tbl['A3:B4']
# Then
self.assertEqual((('120', '121'), ('130', '131')), rng.DataArray)
doc.close(True)
# Tests syntax:
# rng = cellrange['Name'] # Access cell range by name
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_Name(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
expr = '$' + sht.Name + '.$C2:F10'
addr = CellAddress(Sheet=0, Row=1, Column=2)
sht.NamedRanges.addNewByName('foo', expr, addr, 0)
# When
rng = sht['foo']
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(1, rng.RangeAddress.StartRow)
self.assertEqual(2, rng.RangeAddress.StartColumn)
self.assertEqual(9, rng.RangeAddress.EndRow)
self.assertEqual(5, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[0] # Access cell range by row index
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_RowIndex(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[0]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(0, rng.RangeAddress.StartRow)
self.assertEqual(0, rng.RangeAddress.StartColumn)
self.assertEqual(0, rng.RangeAddress.EndRow)
self.assertEqual(1023, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[0,:] # Access cell range by row index
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_RowIndex_FullSlice(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[0, :]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(0, rng.RangeAddress.StartRow)
self.assertEqual(0, rng.RangeAddress.StartColumn)
self.assertEqual(0, rng.RangeAddress.EndRow)
self.assertEqual(1023, rng.RangeAddress.EndColumn)
spr.close(True)
# Tests syntax:
# rng = cellrange[:,0] # Access cell range by column index
# For:
# Spreadsheet
def test_XCellRange_Spreadsheet_Range_FullSlice_ColumnIndex(self):
# Given
spr = self.createBlankSpreadsheet()
sht = spr.Sheets.getByIndex(0)
# When
rng = sht[:, 0]
# Then
self.assertEqual(0, rng.RangeAddress.Sheet)
self.assertEqual(0, rng.RangeAddress.StartRow)
self.assertEqual(0, rng.RangeAddress.StartColumn)
self.assertEqual(1048575, rng.RangeAddress.EndRow)
self.assertEqual(0, rng.RangeAddress.EndColumn)
spr.close(True)
if __name__ == '__main__':
unittest.main()
# vim:set shiftwidth=4 softtabstop=4 expandtab: