test/source/bootstrapfixture.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <config_validation.h>
  11
  12 #include <test/bootstrapfixture.hxx>
  13 #include <vcl/errinf.hxx>
  14 #include <sal/log.hxx>
  15 #include <comphelper/processfactory.hxx>
  16
  17 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  18 #include <com/sun/star/ucb/XContentProvider.hpp>
  19 #include <com/sun/star/ucb/XUniversalContentBroker.hpp>
  20
  21 #include <vcl/outdev.hxx>
  22 #include <vcl/svapp.hxx>
  23 #include <tools/link.hxx>
  24 #include <vcl/graphicfilter.hxx>
  25 #include <osl/file.hxx>
  26 #include <osl/process.h>
  27 #include <unotest/getargument.hxx>
  28 #include <unotools/tempfile.hxx>
  29 #include <vcl/salgtype.hxx>
  30 #include <vcl/scheduler.hxx>
  31 #include <vcl/virdev.hxx>
  32 #include <o3tl/string_view.hxx>
  33
  34 #include <memory>
  35 #include <cstring>
  36
  37 #include "setupvcl.hxx"
  38
  39 using namespace ::com::sun::star;
  40
  41 static void aBasicErrorFunc( const OUString &rErr, const OUString &rAction )
  42 {
  43     OString aErr = "Unexpected dialog: " +
  44         OUStringToOString( rAction, RTL_TEXTENCODING_ASCII_US ) +
  45         " Error: " +
  46         OUStringToOString( rErr, RTL_TEXTENCODING_ASCII_US );
  47     CPPUNIT_ASSERT_MESSAGE( aErr.getStr(), false);
  48 }
  49
  50 // NB. this constructor is called before any tests are run, once for each
  51 // test function in a rather non-intuitive way. This is why all the 'real'
  52 // heavy lifting is deferred until setUp. setUp and tearDown are interleaved
  53 // between the tests as you might expect.
  54 test::BootstrapFixture::BootstrapFixture( bool bAssertOnDialog, bool bNeedUCB )
  55     : m_bNeedUCB( bNeedUCB )
  56     , m_bAssertOnDialog( bAssertOnDialog )
  57 {
  58 }
  59
  60 extern "C"
  61 {
  62
  63 static void test_init_impl(bool bAssertOnDialog, bool bNeedUCB,
  64         lang::XMultiServiceFactory * pSFactory)
  65 {
  66     if (bAssertOnDialog)
  67         ErrorRegistry::RegisterDisplay( aBasicErrorFunc );
  68
  69     // Make GraphicConverter work, normally done in desktop::Desktop::Main()
  70     Application::SetFilterHdl(
  71             LINK(nullptr, test::BootstrapFixture, ImplInitFilterHdl));
  72
  73     if (bNeedUCB)
  74     {
  75         // initialise unconfigured UCB:
  76         uno::Reference<ucb::XUniversalContentBroker> xUcb(pSFactory->createInstance(u"com.sun.star.ucb.UniversalContentBroker"_ustr), uno::UNO_QUERY_THROW);
  77         uno::Reference<ucb::XContentProvider> xFileProvider(pSFactory->createInstance(u"com.sun.star.ucb.FileContentProvider"_ustr), uno::UNO_QUERY_THROW);
  78         xUcb->registerContentProvider(xFileProvider, u"file"_ustr, true);
  79         uno::Reference<ucb::XContentProvider> xTdocProvider(pSFactory->createInstance(u"com.sun.star.ucb.TransientDocumentsContentProvider"_ustr), uno::UNO_QUERY);
  80         if (xTdocProvider.is())
  81         {
  82             xUcb->registerContentProvider(xTdocProvider, u"vnd.sun.star.tdoc"_ustr, true);
  83         }
  84     }
  85 }
  86
  87 // this is called from pyuno
  88 SAL_DLLPUBLIC_EXPORT void test_init(lang::XMultiServiceFactory *pFactory)
  89 {
  90     try
  91     {
  92         ::comphelper::setProcessServiceFactory(pFactory);
  93         test::setUpVcl(true); // hard-code python tests to headless
  94         test_init_impl(false, true, pFactory);
  95     }
  96     catch (...) { abort(); }
  97 }
  98
  99 // this is called from pyuno
 100 SAL_DLLPUBLIC_EXPORT void test_deinit()
 101 {
 102     DeInitVCL();
 103 }
 104
 105 } // extern "C"
 106
 107 void test::BootstrapFixture::setUp()
 108 {
 109     test::BootstrapFixtureBase::setUp();
 110
 111     test_init_impl(m_bAssertOnDialog, m_bNeedUCB, m_xSFactory.get());
 112
 113 #if OSL_DEBUG_LEVEL > 0
 114     Scheduler::ProcessEventsToIdle();
 115 #endif
 116 }
 117
 118 test::BootstrapFixture::~BootstrapFixture()
 119 {
 120 }
 121
 122 #if HAVE_EXPORT_VALIDATION
 123 namespace {
 124
 125 OString loadFile(const OUString& rURL)
 126 {
 127     osl::File aFile(rURL);
 128     osl::FileBase::RC eStatus = aFile.open(osl_File_OpenFlag_Read);
 129     CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None, eStatus);
 130     sal_uInt64 nSize;
 131     aFile.getSize(nSize);
 132     std::unique_ptr<char[]> aBytes(new char[nSize]);
 133     sal_uInt64 nBytesRead;
 134     aFile.read(aBytes.get(), nSize, nBytesRead);
 135     CPPUNIT_ASSERT_EQUAL(nSize, nBytesRead);
 136     OString aContent(aBytes.get(), nBytesRead);
 137
 138     return aContent;
 139 }
 140
 141 constexpr std::u16string_view grand_total = u"Grand total of errors in submitted package: ";
 142
 143 OUString filterOut(const OUString& s, std::u16string_view excludedSubstr)
 144 {
 145     OUString result = s;
 146     for (;;)
 147     {
 148         sal_Int32 pos = result.indexOf(excludedSubstr);
 149         if (pos < 0)
 150             break;
 151         sal_Int32 start = result.lastIndexOf('\n', pos);
 152         if (!result.match("ERROR", start + 1))
 153             return s; // unexpected string format
 154         sal_Int32 end = result.indexOf('\n', pos);
 155         result = result.replaceAt(start, end - start, u""_ustr);
 156         pos = result.lastIndexOf(grand_total);
 157         if (pos < 0)
 158             return s; // unexpected string format
 159         start = end = pos + grand_total.size();
 160         while (end < result.getLength() && rtl::isAsciiDigit(result[end]))
 161             ++end;
 162         std::u16string_view aNumber = result.subView(start, end - start);
 163         sal_Int32 nErrors = o3tl::toInt32(aNumber) - 1;
 164         result = result.replaceAt(start, end - start, OUString::number(nErrors));
 165     }
 166     return result;
 167 }
 168
 169 OUString filterValidationResults(const OUString& s)
 170 {
 171     OUString result = s;
 172     // In ECMA-376-1 Second Edition, 2008, there is the following restriction for oleObj:
 173     //
 174     // <xsd:choice minOccurs="1" maxOccurs="1">
 175     //  <xsd:element name="embed" type="CT_OleObjectEmbed"/>
 176     //  <xsd:element name="link" type="CT_OleObjectLink"/>
 177     //  <xsd:element name="pic" type="CT_Picture"/>
 178     // </xsd:choice>
 179     //
 180     // This makes simultaneous use of embed (or link) and pic impossible. This was obviously a
 181     // mistake; and the following editions of standard fixed it: e.g., in ECMA-376-1:2016, that
 182     // rule is
 183     //
 184     // <xsd:choice minOccurs="1" maxOccurs="1">
 185     //  <xsd:element name="embed" type="CT_OleObjectEmbed"/>
 186     //  <xsd:element name="link" type="CT_OleObjectLink"/>
 187     // </xsd:choice>
 188     // <xsd:element name="pic" type="CT_Picture" minOccurs="1" maxOccurs="1"/>
 189     //
 190     // But officeotron only knows the old version...
 191     result = filterOut(result, u"Invalid content was found starting with element 'p:pic'. No child element is expected at this point.");
 192     return result;
 193 }
 194 }
 195 #endif
 196
 197 void test::BootstrapFixture::validate(const OUString& rPath, test::ValidationFormat eFormat) const
 198 {
 199 #if HAVE_EXPORT_VALIDATION
 200     OUString var;
 201     if( eFormat == test::OOXML )
 202     {
 203         var = "OFFICEOTRON";
 204     }
 205     else if ( eFormat == test::ODF )
 206     {
 207         var = "ODFVALIDATOR";
 208     }
 209     else if ( eFormat == test::MSBINARY )
 210     {
 211 #if HAVE_BFFVALIDATOR
 212         var = "BFFVALIDATOR";
 213 #else
 214         // Binary Format Validator is disabled
 215         return;
 216 #endif
 217     }
 218     OUString aValidator;
 219     oslProcessError e = osl_getEnvironment(var.pData, &aValidator.pData);
 220     CPPUNIT_ASSERT_EQUAL_MESSAGE(
 221         OUString("cannot get env var " + var).toUtf8().getStr(),
 222         osl_Process_E_None, e);
 223     CPPUNIT_ASSERT_MESSAGE(
 224         OUString("empty get env var " + var).toUtf8().getStr(),
 225         !aValidator.isEmpty());
 226
 227     if (eFormat == test::ODF)
 228     {
 229         // invoke without -e so that we know when something new is written
 230         // in loext namespace that isn't yet in the custom schema
 231         aValidator += " -M "
 232             + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-manifest-schema.rng")
 233             + " -D "
 234             + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-dsig-schema.rng")
 235             + " -O "
 236             + m_directories.getPathFromSrc(u"/schema/libreoffice/OpenDocument-v1.4+libreoffice-schema.rng")
 237             + " -m "
 238             + m_directories.getPathFromSrc(u"/schema/mathml2/mathml2.xsd");
 239     }
 240
 241     utl::TempFileNamed aOutput;
 242     aOutput.EnableKillingFile();
 243     OUString aOutputFile = aOutput.GetFileName();
 244     OUString aCommand = aValidator + " " + rPath + " > " + aOutputFile + " 2>&1";
 245
 246 #if !defined _WIN32
 247     // For now, this is only needed by some Linux ASan builds, so keep it simply and disable it on
 248     // Windows (which doesn't support the relevant shell syntax for (un-)setting environment
 249     // variables).
 250     OUString env;
 251     if (test::getArgument(u"env", &env)) {
 252         auto const n = env.indexOf('=');
 253         if (n == -1) {
 254             aCommand = "unset -v " + env + " && " + aCommand;
 255         } else {
 256             aCommand = env + " " + aCommand;
 257         }
 258     }
 259 #endif
 260
 261     SAL_INFO("test", "BootstrapFixture::validate: executing '" << aCommand << "'");
 262     int returnValue = system(OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8).getStr());
 263
 264     OString aContentString = loadFile(aOutput.GetURL());
 265     OUString aContentOUString = OStringToOUString(aContentString, RTL_TEXTENCODING_UTF8);
 266
 267     if( eFormat == test::OOXML && !aContentOUString.isEmpty() )
 268     {
 269         aContentOUString = filterValidationResults(aContentOUString);
 270         // check for validation errors here
 271         sal_Int32 nIndex = aContentOUString.lastIndexOf(grand_total);
 272         if(nIndex == -1)
 273         {
 274             SAL_WARN("test", "no summary line");
 275         }
 276         else
 277         {
 278             sal_Int32 nStartOfNumber = nIndex + grand_total.size();
 279             std::u16string_view aNumber = aContentOUString.subView(nStartOfNumber);
 280             sal_Int32 nErrors = o3tl::toInt32(aNumber);
 281             OString aMsg = "validation error in OOXML export: Errors: " + OString::number(nErrors);
 282             if(nErrors)
 283             {
 284                 SAL_WARN("test", aContentOUString);
 285             }
 286             CPPUNIT_ASSERT_EQUAL_MESSAGE(aMsg.getStr(), sal_Int32(0), nErrors);
 287         }
 288     }
 289     else if( eFormat == test::ODF && !aContentOUString.isEmpty() )
 290     {
 291         if( aContentOUString.indexOf("Error") != -1 )
 292         {
 293             SAL_WARN("test", aContentOUString);
 294             CPPUNIT_FAIL(aContentString.getStr());
 295         }
 296     }
 297     CPPUNIT_ASSERT_EQUAL_MESSAGE(
 298         OString(
 299             "failed to execute: " + OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8) + "\n"
 300             + OUStringToOString(aContentOUString, RTL_TEXTENCODING_UTF8)).getStr(),
 301         0, returnValue);
 302 #else
 303     (void)rPath;
 304     (void)eFormat;
 305 #endif
 306 }
 307
 308 IMPL_STATIC_LINK(
 309         test::BootstrapFixture, ImplInitFilterHdl, ConvertData&, rData, bool)
 310 {
 311     return GraphicFilter::GetGraphicFilter().GetFilterCallback().Call( rData );
 312 }
 313
 314 bool test::BootstrapFixture::IsDefaultDPI()
 315 {
 316     return (Application::GetDefaultDevice()->GetDPIX() == 96
 317             && Application::GetDefaultDevice()->GetDPIY() == 96);
 318 }
 319
 320 std::pair<double, double> test::BootstrapFixture::getDPIScaling()
 321 {
 322     return { Application::GetDefaultDevice()->GetDPIX() / 96.0,
 323              Application::GetDefaultDevice()->GetDPIY() / 96.0 };
 324 }
 325
 326 sal_uInt16 test::BootstrapFixture::getDefaultDeviceBitCount()
 327 {
 328     ScopedVclPtr<VirtualDevice> device
 329         = VclPtr<VirtualDevice>::Create(DeviceFormat::WITHOUT_ALPHA);
 330     return device->GetBitCount();
 331 }
 332
 333 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */