bootstrapfixture.cxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * 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/. */ #include <config_validation.h> #include <test/bootstrapfixture.hxx> #include <vcl/errinf.hxx> #include <sal/log.hxx> #include <comphelper/processfactory.hxx> #include <com/sun/star/lang/XMultiServiceFactory.hpp> #include <com/sun/star/ucb/XContentProvider.hpp> #include <com/sun/star/ucb/XUniversalContentBroker.hpp> #include <vcl/outdev.hxx> #include <vcl/svapp.hxx> #include <tools/link.hxx> #include <vcl/graphicfilter.hxx> #include <osl/file.hxx> #include <osl/process.h> #include <unotest/getargument.hxx> #include <unotools/tempfile.hxx> #include <vcl/salgtype.hxx> #include <vcl/scheduler.hxx> #include <vcl/virdev.hxx> #include <o3tl/string_view.hxx> #include <memory> #include <cstring> #include "setupvcl.hxx" using namespace ::com::sun::star; static void aBasicErrorFunc( const OUString &rErr, const OUString &rAction ) { OString aErr = "Unexpected dialog: " + OUStringToOString( rAction, RTL_TEXTENCODING_ASCII_US ) + " Error: " + OUStringToOString( rErr, RTL_TEXTENCODING_ASCII_US ); CPPUNIT_ASSERT_MESSAGE( aErr.getStr(), false); } // NB. this constructor is called before any tests are run, once for each // test function in a rather non-intuitive way. This is why all the 'real' // heavy lifting is deferred until setUp. setUp and tearDown are interleaved // between the tests as you might expect. test::BootstrapFixture::BootstrapFixture( bool bAssertOnDialog, bool bNeedUCB ) : m_bNeedUCB( bNeedUCB ) , m_bAssertOnDialog( bAssertOnDialog ) { } extern "C" { static void test_init_impl(bool bAssertOnDialog, bool bNeedUCB, lang::XMultiServiceFactory * pSFactory) { if (bAssertOnDialog) ErrorRegistry::RegisterDisplay( aBasicErrorFunc ); // Make GraphicConverter work, normally done in desktop::Desktop::Main() Application::SetFilterHdl( LINK(nullptr, test::BootstrapFixture, ImplInitFilterHdl)); if (bNeedUCB) { // initialise unconfigured UCB: uno::Reference<ucb::XUniversalContentBroker> xUcb(pSFactory->createInstance(u"com.sun.star.ucb.UniversalContentBroker"_ustr), uno::UNO_QUERY_THROW); uno::Reference<ucb::XContentProvider> xFileProvider(pSFactory->createInstance(u"com.sun.star.ucb.FileContentProvider"_ustr), uno::UNO_QUERY_THROW); xUcb->registerContentProvider(xFileProvider, u"file"_ustr, true); uno::Reference<ucb::XContentProvider> xTdocProvider(pSFactory->createInstance(u"com.sun.star.ucb.TransientDocumentsContentProvider"_ustr), uno::UNO_QUERY); if (xTdocProvider.is()) { xUcb->registerContentProvider(xTdocProvider, u"vnd.sun.star.tdoc"_ustr, true); } } } // this is called from pyuno SAL_DLLPUBLIC_EXPORT void test_init(lang::XMultiServiceFactory *pFactory) { try { ::comphelper::setProcessServiceFactory(pFactory); test::setUpVcl(true); // hard-code python tests to headless test_init_impl(false, true, pFactory); } catch (...) { abort(); } } // this is called from pyuno SAL_DLLPUBLIC_EXPORT void test_deinit() { DeInitVCL(); } } // extern "C" void test::BootstrapFixture::setUp() { test::BootstrapFixtureBase::setUp(); test_init_impl(m_bAssertOnDialog, m_bNeedUCB, m_xSFactory.get()); #if OSL_DEBUG_LEVEL > 0 Scheduler::ProcessEventsToIdle(); #endif } test::BootstrapFixture::~BootstrapFixture() { } #if HAVE_EXPORT_VALIDATION namespace { OString loadFile(const OUString& rURL) { osl::File aFile(rURL); osl::FileBase::RC eStatus = aFile.open(osl_File_OpenFlag_Read); CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None, eStatus); sal_uInt64 nSize; aFile.getSize(nSize); std::unique_ptr<char[]> aBytes(new char[nSize]); sal_uInt64 nBytesRead; aFile.read(aBytes.get(), nSize, nBytesRead); CPPUNIT_ASSERT_EQUAL(nSize, nBytesRead); OString aContent(aBytes.get(), nBytesRead); return aContent; } constexpr std::u16string_view grand_total = u"Grand total of errors in submitted package: "; OUString filterOut(const OUString& s, std::u16string_view excludedSubstr) { OUString result = s; for (;;) { sal_Int32 pos = result.indexOf(excludedSubstr); if (pos < 0) break; sal_Int32 start = result.lastIndexOf('\n', pos); if (!result.match("ERROR", start + 1)) return s; // unexpected string format sal_Int32 end = result.indexOf('\n', pos); result = result.replaceAt(start, end - start, u""_ustr); pos = result.lastIndexOf(grand_total); if (pos < 0) return s; // unexpected string format start = end = pos + grand_total.size(); while (end < result.getLength() && rtl::isAsciiDigit(result[end])) ++end; std::u16string_view aNumber = result.subView(start, end - start); sal_Int32 nErrors = o3tl::toInt32(aNumber) - 1; result = result.replaceAt(start, end - start, OUString::number(nErrors)); } return result; } OUString filterValidationResults(const OUString& s) { OUString result = s; // In ECMA-376-1 Second Edition, 2008, there is the following restriction for oleObj: // // <xsd:choice minOccurs="1" maxOccurs="1"> // <xsd:element name="embed" type="CT_OleObjectEmbed"/> // <xsd:element name="link" type="CT_OleObjectLink"/> // <xsd:element name="pic" type="CT_Picture"/> // </xsd:choice> // // This makes simultaneous use of embed (or link) and pic impossible. This was obviously a // mistake; and the following editions of standard fixed it: e.g., in ECMA-376-1:2016, that // rule is // // <xsd:choice minOccurs="1" maxOccurs="1"> // <xsd:element name="embed" type="CT_OleObjectEmbed"/> // <xsd:element name="link" type="CT_OleObjectLink"/> // </xsd:choice> // <xsd:element name="pic" type="CT_Picture" minOccurs="1" maxOccurs="1"/> // // But officeotron only knows the old version... result = filterOut(result, u"Invalid content was found starting with element 'p:pic'. No child element is expected at this point."); { /* While the spec says the core-properties relationship must be * officedocument/2006/relationships/metadata/core-properties * MS Office actually just writes the ECMA-376-1ST EDITION version * for both ECMA_Transitional and ISO_Transitional formats. * * officeotron doesn't care that clause 15.2.12.1 fails on all MSWord-produced output. */ result = filterOut(result, u"Entry with MIME type \"application/vnd.openxmlformats-package.core-properties+xml\" has unrecognized relationship type \"http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties\" (see ISO/IEC 29500-1:2008, Clause 15.2.12.1)"); } return result; } } #endif void test::BootstrapFixture::validate(const OUString& rPath, std::u16string_view rFilter) const { test::ValidationFormat eFormat = test::ODF; if (rFilter == u"Calc Office Open XML") eFormat = test::OOXML; else if (rFilter == u"Office Open XML Text") eFormat = test::OOXML; else if (rFilter == u"Impress Office Open XML") eFormat = test::OOXML; else if (rFilter == u"writer8") eFormat = test::ODF; else if (rFilter == u"calc8") eFormat = test::ODF; else if (rFilter == u"impress8") eFormat = test::ODF; else if (rFilter == u"draw8") eFormat = test::ODF; else if (rFilter == u"OpenDocument Text Flat XML") eFormat = test::ODF; else if (rFilter == u"MS Word 97") eFormat = test::MSBINARY; else if (rFilter == u"MS Excel 97") eFormat = test::MSBINARY; else if (rFilter == u"MS PowerPoint 97") eFormat = test::MSBINARY; else { SAL_INFO("test", "BootstrapFixture::validate: unknown filter"); return; } #if HAVE_EXPORT_VALIDATION OUString var; if( eFormat == test::OOXML ) { var = "OFFICEOTRON"; } else if ( eFormat == test::ODF ) { var = "ODFVALIDATOR"; } else if ( eFormat == test::MSBINARY ) { #if HAVE_BFFVALIDATOR var = "BFFVALIDATOR"; #else // Binary Format Validator is disabled return; #endif } OUString aValidator; oslProcessError e = osl_getEnvironment(var.pData, &aValidator.pData); CPPUNIT_ASSERT_EQUAL_MESSAGE( OUString("cannot get env var " + var).toUtf8().getStr(), osl_Process_E_None, e); CPPUNIT_ASSERT_MESSAGE( OUString("empty get env var " + var).toUtf8().getStr(), !aValidator.isEmpty()); if (eFormat == test::ODF) { // invoke without -e so that we know when something new is written // in loext namespace that isn't yet in the custom schema aValidator += " -M " + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-manifest-schema.rng") + " -D " + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-dsig-schema.rng") + " -O " + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-schema.rng") + " -m " + m_directories.getPathFromSrc(u"/schema/mathml2/mathml2.xsd"); } utl::TempFileNamed aOutput; aOutput.EnableKillingFile(); OUString aOutputFile = aOutput.GetFileName(); OUString aCommand = aValidator + " " + rPath + " > " + aOutputFile + " 2>&1"; #if !defined _WIN32 // For now, this is only needed by some Linux ASan builds, so keep it simply and disable it on // Windows (which doesn't support the relevant shell syntax for (un-)setting environment // variables). OUString env; if (test::getArgument(u"env", &env)) { auto const n = env.indexOf('='); if (n == -1) { aCommand = "unset -v " + env + " && " + aCommand; } else { aCommand = env + " " + aCommand; } } #endif SAL_INFO("test", "BootstrapFixture::validate: executing '" << aCommand << "'"); int returnValue = system(OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8).getStr()); OString aContentString = loadFile(aOutput.GetURL()); OUString aContentOUString = OStringToOUString(aContentString, RTL_TEXTENCODING_UTF8); if( eFormat == test::OOXML && !aContentOUString.isEmpty() ) { aContentOUString = filterValidationResults(aContentOUString); // check for validation errors here sal_Int32 nIndex = aContentOUString.lastIndexOf(grand_total); if(nIndex == -1) { SAL_WARN("test", "no summary line"); } else { sal_Int32 nStartOfNumber = nIndex + grand_total.size(); std::u16string_view aNumber = aContentOUString.subView(nStartOfNumber); sal_Int32 nErrors = o3tl::toInt32(aNumber); OString aMsg = "validation error in OOXML export: Errors: " + OString::number(nErrors); if(nErrors) { SAL_WARN("test", aContentOUString); } CPPUNIT_ASSERT_EQUAL_MESSAGE(aMsg.getStr(), sal_Int32(0), nErrors); } } else if( eFormat == test::ODF && !aContentOUString.isEmpty() ) { if( aContentOUString.indexOf("Error") != -1 ) { SAL_WARN("test", aContentOUString); CPPUNIT_FAIL(aContentString.getStr()); } } CPPUNIT_ASSERT_EQUAL_MESSAGE( OString( "failed to execute: " + OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8) + "\n" + OUStringToOString(aContentOUString, RTL_TEXTENCODING_UTF8)).getStr(), 0, returnValue); #else (void)rPath; (void)eFormat; #endif } IMPL_STATIC_LINK( test::BootstrapFixture, ImplInitFilterHdl, ConvertData&, rData, bool) { return GraphicFilter::GetGraphicFilter().GetFilterCallback().Call( rData ); } bool test::BootstrapFixture::IsDefaultDPI() { return (Application::GetDefaultDevice()->GetDPIX() == 96 && Application::GetDefaultDevice()->GetDPIY() == 96); } std::pair<double, double> test::BootstrapFixture::getDPIScaling() { return { Application::GetDefaultDevice()->GetDPIX() / 96.0, Application::GetDefaultDevice()->GetDPIY() / 96.0 }; } sal_uInt16 test::BootstrapFixture::getDefaultDeviceBitCount() { ScopedVclPtr<VirtualDevice> device = VclPtr<VirtualDevice>::Create(DeviceFormat::WITHOUT_ALPHA); return device->GetBitCount(); } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

↑ V1048 The 'eFormat' variable was assigned the same value.

↑ V1083 Signed integer overflow is possible in 'o3tl::toInt32(aNumber) - 1' arithmetic expression. This leads to undefined behavior. Left operand is in range [-2147483648..2147483647], right operand is '1'.