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_features.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/svapp.hxx>
  22 #include <tools/link.hxx>
  23 #include <vcl/graphicfilter.hxx>
  24 #include <osl/file.hxx>
  25 #include <osl/process.h>
  26 #include <unotools/tempfile.hxx>
  27 #include <vcl/salgtype.hxx>
  28 #include <vcl/scheduler.hxx>
  29 #include <vcl/virdev.hxx>
  30
  31 #include <memory>
  32 #include <cstring>
  33
  34 #include "setupvcl.hxx"
  35
  36 using namespace ::com::sun::star;
  37
  38 static void aBasicErrorFunc( const OUString &rErr, const OUString &rAction )
  39 {
  40     OString aErr = "Unexpected dialog: " +
  41         OUStringToOString( rAction, RTL_TEXTENCODING_ASCII_US ) +
  42         " Error: " +
  43         OUStringToOString( rErr, RTL_TEXTENCODING_ASCII_US );
  44     CPPUNIT_ASSERT_MESSAGE( aErr.getStr(), false);
  45 }
  46
  47 // NB. this constructor is called before any tests are run, once for each
  48 // test function in a rather non-intuitive way. This is why all the 'real'
  49 // heavy lifting is deferred until setUp. setUp and tearDown are interleaved
  50 // between the tests as you might expect.
  51 test::BootstrapFixture::BootstrapFixture( bool bAssertOnDialog, bool bNeedUCB )
  52     : m_bNeedUCB( bNeedUCB )
  53     , m_bAssertOnDialog( bAssertOnDialog )
  54 {
  55 }
  56
  57 extern "C"
  58 {
  59
  60 static void test_init_impl(bool bAssertOnDialog, bool bNeedUCB,
  61         lang::XMultiServiceFactory * pSFactory)
  62 {
  63     if (bAssertOnDialog)
  64         ErrorRegistry::RegisterDisplay( aBasicErrorFunc );
  65
  66     // Make GraphicConverter work, normally done in desktop::Desktop::Main()
  67     Application::SetFilterHdl(
  68             LINK(nullptr, test::BootstrapFixture, ImplInitFilterHdl));
  69
  70     if (bNeedUCB)
  71     {
  72         // initialise unconfigured UCB:
  73         uno::Reference<ucb::XUniversalContentBroker> xUcb(pSFactory->createInstance("com.sun.star.ucb.UniversalContentBroker"), uno::UNO_QUERY_THROW);
  74         uno::Reference<ucb::XContentProvider> xFileProvider(pSFactory->createInstance("com.sun.star.ucb.FileContentProvider"), uno::UNO_QUERY_THROW);
  75         xUcb->registerContentProvider(xFileProvider, "file", true);
  76         uno::Reference<ucb::XContentProvider> xTdocProvider(pSFactory->createInstance("com.sun.star.ucb.TransientDocumentsContentProvider"), uno::UNO_QUERY);
  77         if (xTdocProvider.is())
  78         {
  79             xUcb->registerContentProvider(xTdocProvider, "vnd.sun.star.tdoc", true);
  80         }
  81     }
  82 }
  83
  84 // this is called from pyuno
  85 SAL_DLLPUBLIC_EXPORT void test_init(lang::XMultiServiceFactory *pFactory)
  86 {
  87     try
  88     {
  89         ::comphelper::setProcessServiceFactory(pFactory);
  90         test::setUpVcl(true); // hard-code python tests to headless
  91         test_init_impl(false, true, pFactory);
  92     }
  93     catch (...) { abort(); }
  94 }
  95
  96 // this is called from pyuno
  97 SAL_DLLPUBLIC_EXPORT void test_deinit()
  98 {
  99     DeInitVCL();
 100 }
 101
 102 } // extern "C"
 103
 104 void test::BootstrapFixture::setUp()
 105 {
 106     test::BootstrapFixtureBase::setUp();
 107
 108     test_init_impl(m_bAssertOnDialog, m_bNeedUCB, m_xSFactory.get());
 109
 110 #if OSL_DEBUG_LEVEL > 0
 111     Scheduler::ProcessEventsToIdle();
 112 #endif
 113
 114     mxComponentContext.set(comphelper::getComponentContext(getMultiServiceFactory()));
 115 }
 116
 117 test::BootstrapFixture::~BootstrapFixture()
 118 {
 119 }
 120
 121 #if HAVE_EXPORT_VALIDATION
 122 namespace {
 123
 124 OString loadFile(const OUString& rURL)
 125 {
 126     osl::File aFile(rURL);
 127     osl::FileBase::RC eStatus = aFile.open(osl_File_OpenFlag_Read);
 128     CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None, eStatus);
 129     sal_uInt64 nSize;
 130     aFile.getSize(nSize);
 131     std::unique_ptr<char[]> aBytes(new char[nSize]);
 132     sal_uInt64 nBytesRead;
 133     aFile.read(aBytes.get(), nSize, nBytesRead);
 134     CPPUNIT_ASSERT_EQUAL(nSize, nBytesRead);
 135     OString aContent(aBytes.get(), nBytesRead);
 136
 137     return aContent;
 138 }
 139
 140 }
 141 #endif
 142
 143 void test::BootstrapFixture::validate(const OUString& rPath, test::ValidationFormat eFormat) const
 144 {
 145 #if HAVE_EXPORT_VALIDATION
 146     OUString var;
 147     if( eFormat == test::OOXML )
 148     {
 149         var = "OFFICEOTRON";
 150     }
 151     else if ( eFormat == test::ODF )
 152     {
 153         var = "ODFVALIDATOR";
 154     }
 155     else if ( eFormat == test::MSBINARY )
 156     {
 157 #if HAVE_BFFVALIDATOR
 158         var = "BFFVALIDATOR";
 159 #else
 160         // Binary Format Validator is disabled
 161         return;
 162 #endif
 163     }
 164     OUString aValidator;
 165     oslProcessError e = osl_getEnvironment(var.pData, &aValidator.pData);
 166     CPPUNIT_ASSERT_EQUAL_MESSAGE(
 167         OUString("cannot get env var " + var).toUtf8().getStr(),
 168         osl_Process_E_None, e);
 169     CPPUNIT_ASSERT_MESSAGE(
 170         OUString("empty get env var " + var).toUtf8().getStr(),
 171         !aValidator.isEmpty());
 172
 173     if (eFormat == test::ODF)
 174     {
 175         // invoke without -e so that we know when something new is written
 176         // in loext namespace that isn't yet in the custom schema
 177         aValidator += " -M "
 178             + m_directories.getPathFromSrc("/schema/libreoffice/OpenDocument-manifest-schema-v1.3+libreoffice.rng")
 179             + " -D "
 180             + m_directories.getPathFromSrc("/schema/libreoffice/OpenDocument-dsig-schema-v1.3+libreoffice.rng")
 181             + " -O "
 182             + m_directories.getPathFromSrc("/schema/libreoffice/OpenDocument-schema-v1.3+libreoffice.rng")
 183             + " -m "
 184             + m_directories.getPathFromSrc("/schema/mathml2/mathml2.xsd");
 185     }
 186
 187     utl::TempFile aOutput;
 188     aOutput.EnableKillingFile();
 189     OUString aOutputFile = aOutput.GetFileName();
 190     OUString aCommand = aValidator + " " + rPath + " > " + aOutputFile;
 191
 192     SAL_INFO("test", "BootstrapFixture::validate: executing '" << aCommand << "'");
 193     int returnValue = system(OUStringToOString(aCommand, RTL_TEXTENCODING_UTF8).getStr());
 194
 195     OString aContentString = loadFile(aOutput.GetURL());
 196     OUString aContentOUString = OStringToOUString(aContentString, RTL_TEXTENCODING_UTF8);
 197
 198     if( eFormat == test::OOXML && !aContentOUString.isEmpty() )
 199     {
 200         // check for validation errors here
 201         sal_Int32 nIndex = aContentOUString.lastIndexOf("Grand total of errors in submitted package: ");
 202         if(nIndex == -1)
 203         {
 204             SAL_WARN("test", "no summary line");
 205         }
 206         else
 207         {
 208             sal_Int32 nStartOfNumber = nIndex + std::strlen("Grand total of errors in submitted package: ");
 209             OUString aNumber = aContentOUString.copy(nStartOfNumber);
 210             sal_Int32 nErrors = aNumber.toInt32();
 211             OString aMsg = "validation error in OOXML export: Errors: " + OString::number(nErrors);
 212             if(nErrors)
 213             {
 214                 SAL_WARN("test", aContentOUString);
 215             }
 216             CPPUNIT_ASSERT_EQUAL_MESSAGE(aMsg.getStr(), sal_Int32(0), nErrors);
 217         }
 218     }
 219     else if( eFormat == test::ODF && !aContentOUString.isEmpty() )
 220     {
 221         if( aContentOUString.indexOf("Error") != -1 )
 222         {
 223             SAL_WARN("test", aContentOUString);
 224             CPPUNIT_FAIL(aContentString.getStr());
 225         }
 226     }
 227     CPPUNIT_ASSERT_EQUAL_MESSAGE(
 228         OUStringToOString("failed to execute: " + aCommand + "\n" + aContentOUString,
 229             RTL_TEXTENCODING_UTF8).getStr(), 0, returnValue);
 230 #else
 231     (void)rPath;
 232     (void)eFormat;
 233 #endif
 234 }
 235
 236 IMPL_STATIC_LINK(
 237         test::BootstrapFixture, ImplInitFilterHdl, ConvertData&, rData, bool)
 238 {
 239     return GraphicFilter::GetGraphicFilter().GetFilterCallback().Call( rData );
 240 }
 241
 242 sal_uInt16 test::BootstrapFixture::getDefaultDeviceBitCount()
 243 {
 244     ScopedVclPtr<VirtualDevice> device
 245         = VclPtr<VirtualDevice>::Create(DeviceFormat::DEFAULT);
 246     return device->GetBitCount();
 247 }
 248
 249 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */