unotest/source/cpp/macros_test.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 <unotest/macros_test.hxx>
  11
  12 #include <vector>
  13
  14 #include <com/sun/star/document/MacroExecMode.hpp>
  15 #include <com/sun/star/uno/XComponentContext.hpp>
  16 #include <com/sun/star/frame/DispatchHelper.hpp>
  17 #include <com/sun/star/packages/zip/ZipFileAccess.hpp>
  18 #include <com/sun/star/security/XCertificate.hpp>
  19
  20 #include <basic/basrdll.hxx>
  21 #include <cppunit/TestAssert.h>
  22 #include <comphelper/sequence.hxx>
  23 #include <comphelper/processfactory.hxx>
  24 #include <unotest/directories.hxx>
  25 #include <osl/file.hxx>
  26 #include <osl/process.h>
  27 #include <osl/thread.h>
  28 #include <tools/datetime.hxx>
  29 #include <unotools/tempfile.hxx>
  30 #include <unotools/ucbstreamhelper.hxx>
  31
  32 using namespace css;
  33
  34 namespace unotest
  35 {
  36 MacrosTest::MacrosTest()
  37     : mpDll(std::make_unique<BasicDLL>())
  38 {
  39 }
  40
  41 MacrosTest::~MacrosTest() = default;
  42
  43 uno::Reference<css::lang::XComponent>
  44 MacrosTest::loadFromDesktop(const OUString& rURL, const OUString& rDocService,
  45                             const uno::Sequence<beans::PropertyValue>& rExtraArgs)
  46 {
  47     CPPUNIT_ASSERT_MESSAGE("no desktop", mxDesktop.is());
  48     std::vector<beans::PropertyValue> args;
  49     beans::PropertyValue aMacroValue;
  50     aMacroValue.Name = "MacroExecutionMode";
  51     aMacroValue.Handle = -1;
  52     aMacroValue.Value <<= document::MacroExecMode::ALWAYS_EXECUTE_NO_WARN;
  53     aMacroValue.State = beans::PropertyState_DIRECT_VALUE;
  54     args.push_back(aMacroValue);
  55
  56     if (!rDocService.isEmpty())
  57     {
  58         beans::PropertyValue aValue;
  59         aValue.Name = "DocumentService";
  60         aValue.Handle = -1;
  61         aValue.Value <<= rDocService;
  62         aValue.State = beans::PropertyState_DIRECT_VALUE;
  63         args.push_back(aValue);
  64     }
  65
  66     args.insert(args.end(), rExtraArgs.begin(), rExtraArgs.end());
  67
  68     uno::Reference<lang::XComponent> xComponent = mxDesktop->loadComponentFromURL(
  69         rURL, "_default", 0, comphelper::containerToSequence(args));
  70     OUString sMessage = "loading failed: " + rURL;
  71     CPPUNIT_ASSERT_MESSAGE(OUStringToOString(sMessage, RTL_TEXTENCODING_UTF8).getStr(),
  72                            xComponent.is());
  73     return xComponent;
  74 }
  75
  76 void MacrosTest::dispatchCommand(const uno::Reference<lang::XComponent>& xComponent,
  77                                  const OUString& rCommand,
  78                                  const uno::Sequence<beans::PropertyValue>& rPropertyValues)
  79 {
  80     uno::Reference<frame::XController> xController
  81         = uno::Reference<frame::XModel>(xComponent, uno::UNO_QUERY_THROW)->getCurrentController();
  82     CPPUNIT_ASSERT(xController.is());
  83     uno::Reference<frame::XDispatchProvider> xFrame(xController->getFrame(), uno::UNO_QUERY);
  84     CPPUNIT_ASSERT(xFrame.is());
  85
  86     uno::Reference<uno::XComponentContext> xContext = ::comphelper::getProcessComponentContext();
  87     uno::Reference<frame::XDispatchHelper> xDispatchHelper(frame::DispatchHelper::create(xContext));
  88     CPPUNIT_ASSERT(xDispatchHelper.is());
  89
  90     xDispatchHelper->executeDispatch(xFrame, rCommand, OUString(), 0, rPropertyValues);
  91 }
  92
  93 std::unique_ptr<SvStream> MacrosTest::parseExportStream(const utl::TempFile& rTempFile,
  94                                                         const OUString& rStreamName)
  95 {
  96     const OUString aUrl = rTempFile.GetURL();
  97     uno::Reference<uno::XComponentContext> xComponentContext
  98         = comphelper::getProcessComponentContext();
  99     uno::Reference<packages::zip::XZipFileAccess2> const xZipNames(
 100         packages::zip::ZipFileAccess::createWithURL(xComponentContext, aUrl));
 101     uno::Reference<io::XInputStream> const xInputStream(xZipNames->getByName(rStreamName),
 102                                                         uno::UNO_QUERY);
 103     std::unique_ptr<SvStream> pStream(utl::UcbStreamHelper::CreateStream(xInputStream, true));
 104     return pStream;
 105 }
 106
 107 void MacrosTest::setUpNssGpg(const test::Directories& rDirectories, const OUString& rTestName)
 108 {
 109     OUString aSourceDir = rDirectories.getURLFromSrc(u"/test/signing-keys/");
 110     OUString aTargetDir = rDirectories.getURLFromWorkdir(
 111         OUStringConcatenation("CppunitTest/" + rTestName + ".test.user"));
 112
 113     // Set up NSS database in workdir/CppunitTest/
 114     osl::File::copy(aSourceDir + "cert9.db", aTargetDir + "/cert9.db");
 115     osl::File::copy(aSourceDir + "key4.db", aTargetDir + "/key4.db");
 116     osl::File::copy(aSourceDir + "pkcs11.txt", aTargetDir + "/pkcs11.txt");
 117
 118     // Make gpg use our own defined setup & keys
 119     osl::File::copy(aSourceDir + "pubring.gpg", aTargetDir + "/pubring.gpg");
 120     osl::File::copy(aSourceDir + "random_seed", aTargetDir + "/random_seed");
 121     osl::File::copy(aSourceDir + "secring.gpg", aTargetDir + "/secring.gpg");
 122     osl::File::copy(aSourceDir + "trustdb.gpg", aTargetDir + "/trustdb.gpg");
 123
 124     OUString aTargetPath;
 125     osl::FileBase::getSystemPathFromFileURL(aTargetDir, aTargetPath);
 126
 127 #ifdef _WIN32
 128     // CryptoAPI test certificates
 129     osl::File::copy(aSourceDir + "test.p7b", aTargetDir + "/test.p7b");
 130     OUString caVar("LIBO_TEST_CRYPTOAPI_PKCS7");
 131     osl_setEnvironment(caVar.pData, aTargetPath.pData);
 132 #else
 133     OUString mozCertVar("MOZILLA_CERTIFICATE_FOLDER");
 134     osl_setEnvironment(mozCertVar.pData, aTargetPath.pData);
 135 #endif
 136     OUString gpgHomeVar("GNUPGHOME");
 137     osl_setEnvironment(gpgHomeVar.pData, aTargetPath.pData);
 138
 139 #if HAVE_GPGCONF_SOCKETDIR
 140     auto const ldPath = std::getenv("LIBO_LD_PATH");
 141     m_gpgconfCommandPrefix
 142         = ldPath == nullptr ? OString() : OString::Concat("LD_LIBRARY_PATH=") + ldPath + " ";
 143     OString path;
 144     bool ok = aTargetPath.convertToString(&path, osl_getThreadTextEncoding(),
 145                                           RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR
 146                                               | RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR);
 147     // if conversion fails, at least provide a best-effort conversion in the message here, for
 148     // context
 149     CPPUNIT_ASSERT_MESSAGE(OUStringToOString(aTargetPath, RTL_TEXTENCODING_UTF8).getStr(), ok);
 150     m_gpgconfCommandPrefix += "GNUPGHOME=" + path + " " GPGME_GPGCONF;
 151     // HAVE_GPGCONF_SOCKETDIR is only defined in configure.ac for Linux for now, so (a) std::system
 152     // behavior will conform to POSIX (and the relevant env var to set is named LD_LIBRARY_PATH), and
 153     // (b) gpgconf --create-socketdir should return zero:
 154     OString cmd = m_gpgconfCommandPrefix + " --create-socketdir";
 155     int res = std::system(cmd.getStr());
 156     CPPUNIT_ASSERT_EQUAL_MESSAGE(cmd.getStr(), 0, res);
 157 #else
 158     (void)this;
 159 #endif
 160 }
 161
 162 void MacrosTest::tearDownNssGpg()
 163 {
 164 #if HAVE_GPGCONF_SOCKETDIR
 165     // HAVE_GPGCONF_SOCKETDIR is only defined in configure.ac for Linux for now, so (a) std::system
 166     // behavior will conform to POSIX, and (b) gpgconf --remove-socketdir should return zero:
 167     OString cmd = m_gpgconfCommandPrefix + " --remove-socketdir";
 168     int res = std::system(cmd.getStr());
 169     CPPUNIT_ASSERT_EQUAL_MESSAGE(cmd.getStr(), 0, res);
 170 #else
 171     (void)this;
 172 #endif
 173 }
 174
 175 bool MacrosTest::IsValid(const css::uno::Reference<css::security::XCertificate>& cert)
 176 {
 177     return DateTime(DateTime::SYSTEM)
 178         .IsBetween(cert->getNotValidBefore(), cert->getNotValidAfter());
 179 }
 180
 181 css::uno::Reference<css::security::XCertificate> MacrosTest::GetValidCertificate(
 182     const css::uno::Sequence<css::uno::Reference<css::security::XCertificate>>& certs)
 183 {
 184     if (auto it = std::find_if(certs.begin(), certs.end(), IsValid); it != certs.end())
 185         return *it;
 186     return {};
 187 }
 188 }
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */