sw/qa/inc/swmodeltestbase.hxx

   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 #ifndef INCLUDED_SW_QA_INC_SWMODELTESTBASE_HXX
  11 #define INCLUDED_SW_QA_INC_SWMODELTESTBASE_HXX
  12
  13 #include <memory>
  14 #include <string_view>
  15
  16 #include <com/sun/star/beans/XPropertySet.hpp>
  17 #include <com/sun/star/container/XNameAccess.hpp>
  18 #include <com/sun/star/drawing/XShape.hpp>
  19 #include <com/sun/star/style/XAutoStyleFamily.hpp>
  20 #include <com/sun/star/text/XTextRange.hpp>
  21 #include <com/sun/star/table/XCell.hpp>
  22 #include <com/sun/star/table/BorderLine2.hpp>
  23 #include <com/sun/star/xml/AttributeData.hpp>
  24
  25 #include "swqahelperdllapi.h"
  26 #include <test/unoapixml_test.hxx>
  27 #include <unotools/tempfile.hxx>
  28
  29 #include <doc.hxx>
  30
  31 #define DECLARE_SW_ROUNDTRIP_TEST(TestName, filename, password, BaseClass) \
  32     class TestName : public BaseClass { \
  33         public:\
  34     CPPUNIT_TEST_SUITE(TestName); \
  35     CPPUNIT_TEST(Load_Verify_Reload_Verify); \
  36     CPPUNIT_TEST_SUITE_END(); \
  37     \
  38     void Load_Verify_Reload_Verify() {\
  39         executeLoadVerifyReloadVerify(filename, password);\
  40     }\
  41     void verify() override;\
  42     }; \
  43     CPPUNIT_TEST_SUITE_REGISTRATION(TestName); \
  44     void TestName::verify()
  45
  46 #define DECLARE_OOXMLEXPORT_TEST(TestName, filename) DECLARE_SW_ROUNDTRIP_TEST(TestName, filename, nullptr, Test)
  47 #define DECLARE_ODFEXPORT_TEST(TestName, filename) DECLARE_SW_ROUNDTRIP_TEST(TestName, filename, nullptr, Test)
  48 #define DECLARE_WW8EXPORT_TEST(TestName, filename) DECLARE_SW_ROUNDTRIP_TEST(TestName, filename, nullptr, Test)
  49
  50 class SwXTextDocument;
  51 namespace comphelper
  52 {
  53 class ConfigurationChanges;
  54 }
  55 namespace vcl
  56 {
  57 namespace pdf
  58 {
  59 class PDFiumDocument;
  60 }
  61 }
  62
  63 /// Temporarily enables the ExportFormFields setting.
  64 class SWQAHELPER_DLLPUBLIC SwExportFormFieldsGuard
  65 {
  66     std::shared_ptr<comphelper::ConfigurationChanges> m_pBatch;
  67     bool m_bValue;
  68 public:
  69     SwExportFormFieldsGuard();
  70     ~SwExportFormFieldsGuard();
  71 };
  72
  73 /// Base class for filter tests loading or roundtripping a document, then asserting the document model.
  74 class SWQAHELPER_DLLPUBLIC SwModelTestBase : public UnoApiXmlTest
  75 {
  76 protected:
  77     xmlBufferPtr mpXmlBuffer;
  78     OUString mpFilter;
  79
  80     /// Copy&paste helper.
  81     void paste(std::u16string_view aFilename, const OUString& aInstance, css::uno::Reference<css::text::XTextRange> const& xTextRange);
  82
  83 public:
  84     SwModelTestBase(const OUString& pTestDocumentPath = OUString(), const OUString& pFilter = {});
  85
  86 protected:
  87     /**
  88      * Helper func used by each unit test to test the 'export' code.
  89      * (Loads the requested file, calls 'verify' function, save it to temp file, load the
  90      * temp file and then calls 'verify' function again)
  91      */
  92     void executeLoadVerifyReloadVerify(const char* filename, const char* pPassword = nullptr);
  93
  94     /**
  95      * Function overridden by unit test. See DECLARE_SW_*_TEST macros
  96      */
  97     virtual void verify()
  98     {
  99         CPPUNIT_FAIL( "verify method must be overridden" );
 100     }
 101
 102     void calcLayout();
 103
 104     /// Get the body text of the whole document.
 105     OUString getBodyText() const;
 106
 107     /// Get a family of styles, see com.sun.star.style.StyleFamilies for possible values.
 108     css::uno::Reference<css::container::XNameAccess> getStyles(const OUString& aFamily);
 109
 110     /// Get a family of auto styles, see com.sun.star.style.StyleFamilies for possible values.
 111     css::uno::Reference<css::style::XAutoStyleFamily> getAutoStyles(const OUString& aFamily);
 112
 113     /// Similar to parseExport(), but this gives the xmlDocPtr of the layout dump.
 114     xmlDocUniquePtr parseLayoutDump(const css::uno::Reference< css::lang::XComponent >& xComponent = nullptr);
 115
 116     template< typename T >
 117     T getProperty( const css::uno::Any& obj, const OUString& name ) const
 118     {
 119         css::uno::Reference< css::beans::XPropertySet > properties( obj, uno::UNO_QUERY_THROW );
 120         T data;
 121         if (!css::uno::fromAny(properties->getPropertyValue(name), &data))
 122         {
 123             OString const msg("the property is of unexpected type or void: "
 124                     + OUStringToOString(name, RTL_TEXTENCODING_UTF8));
 125             CPPUNIT_FAIL(msg.getStr());
 126         }
 127         return data;
 128     }
 129
 130     template< typename T >
 131     T getProperty( const css::uno::Reference< css::uno::XInterface >& obj, const OUString& name ) const
 132     {
 133         css::uno::Reference< css::beans::XPropertySet > properties( obj, uno::UNO_QUERY_THROW );
 134         T data = T();
 135         if (!(properties->getPropertyValue(name) >>= data))
 136         {
 137             OString const msg("the property is of unexpected type or void: "
 138                     + OUStringToOString(name, RTL_TEXTENCODING_UTF8));
 139             CPPUNIT_FAIL(msg.getStr());
 140         }
 141         return data;
 142     }
 143
 144     bool isPropertyVoid(const css::uno::Reference<css::uno::XInterface>& object, const OUString& name) const
 145     {
 146         if (!hasProperty(object, name))
 147             return false;
 148
 149         css::uno::Reference< css::beans::XPropertySet > properties(object, uno::UNO_QUERY_THROW);
 150         return !properties->getPropertyValue(name).hasValue();
 151     }
 152
 153     bool hasProperty(const css::uno::Reference<css::uno::XInterface>& obj, const OUString& name) const;
 154
 155     css::xml::AttributeData getUserDefineAttribute(const css::uno::Any& obj, const OUString& name, const OUString& rValue) const;
 156
 157     int getParagraphs( css::uno::Reference<text::XText> const & xText );
 158
 159     /// Get number of paragraphs of the document.
 160     int getParagraphs();
 161
 162     css::uno::Reference<css::text::XTextContent> getParagraphOrTable(int number, css::uno::Reference<css::text::XText> const & xText = css::uno::Reference<css::text::XText>()) const;
 163
 164     // Get paragraph (counted from 1), optionally check it contains the given text.
 165     css::uno::Reference< css::text::XTextRange > getParagraph( int number, const OUString& content = OUString() ) const;
 166
 167     sal_Int16 getNumberingTypeOfParagraph(int nPara);
 168
 169     css::uno::Reference<css::text::XTextRange> getParagraphOfText(int number, css::uno::Reference<css::text::XText> const & xText, const OUString& content = OUString()) const;
 170
 171     /// get nth object/fly that is anchored AT paragraph
 172     css::uno::Reference<css::beans::XPropertySet> getParagraphAnchoredObject(
 173         int const index, css::uno::Reference<css::text::XTextRange> const & xPara) const;
 174
 175     /// Get run (counted from 1) of a paragraph, optionally check it contains the given text.
 176     css::uno::Reference<css::text::XTextRange> getRun(uno::Reference<css::text::XTextRange> const & xParagraph, int number, const OUString& content = OUString()) const;
 177
 178     /// Get math formula string of a run.
 179     OUString getFormula(css::uno::Reference<css::text::XTextRange> const & xRun) const;
 180
 181     /// get cell of a table; table can be retrieved with getParagraphOrTable
 182     css::uno::Reference<css::table::XCell> getCell(
 183             css::uno::Reference<css::uno::XInterface> const& xTableIfc,
 184             OUString const& rCell, OUString const& rContent = OUString());
 185
 186     /// Get shape (counted from 1)
 187     css::uno::Reference<css::drawing::XShape> getShape(int number);
 188
 189     /// Select shape (counted from 1)
 190     void selectShape(int number);
 191
 192     /// Get shape by name
 193     css::uno::Reference<css::drawing::XShape> getShapeByName(std::u16string_view aName);
 194
 195     /// Get TextFrame by name
 196     css::uno::Reference<css::drawing::XShape> getTextFrameByName(const OUString& aName);
 197
 198     void header();
 199
 200     void saveAndReload(const OUString& pFilter, const char* pPassword = nullptr);
 201
 202     /// Combines load() and save().
 203     void loadAndSave(const char* pName, const char* pPassword = nullptr);
 204
 205     /// Combines load() and saveAndReload().
 206     void loadAndReload(const char* pName);
 207
 208     /// Get page count.
 209     int getPages() const;
 210
 211     /// Get shape count.
 212     int getShapes() const;
 213
 214     /**
 215      * Creates a new document to be used with the internal sw/ API.
 216      *
 217      * Examples:
 218      * createSwDoc();
 219      * createSwDoc("test.fodt");
 220      * createSwDoc("test.fodt", "test");
 221      */
 222     void createSwDoc(const char* pName = nullptr, const char* pPassword = nullptr);
 223
 224     /**
 225      * As createSwDoc except a Web Document in Browse Mode
 226      */
 227     void createSwWebDoc(const char* pName = nullptr);
 228
 229     /**
 230      * As createSwDoc except a Global Document
 231      */
 232     void createSwGlobalDoc(const char* pName = nullptr);
 233
 234     /**
 235      * Gets SwDoc from loaded component
 236      */
 237     SwDoc* getSwDoc();
 238
 239     /**
 240      * Gets SwDocShell from loaded component
 241      */
 242     SwDocShell* getSwDocShell();
 243
 244     /**
 245      * Gets SwXTextDocument from loaded component
 246      */
 247     SwXTextDocument* getSwTextDoc();
 248
 249     /**
 250      * Wraps a reqif-xhtml fragment into an XHTML file, and XML-parses it.
 251      */
 252     xmlDocUniquePtr WrapReqifFromTempFile();
 253
 254     void emulateTyping(std::u16string_view rStr);
 255
 256 private:
 257     void loadURL(OUString const& rURL, const char* pPassword = nullptr);
 258
 259     void dumpLayout(SwDoc* pDoc);
 260 };
 261
 262 /**
 263  * Test whether the expected and actual borderline parameters are equal
 264  * and assert if not.
 265  *
 266  * @param[in]   rExpected    expected borderline object
 267  * @param[in]   rActual      actual borderline object
 268  * @param[in]   rSourceLine  line from where the assertion is called
 269  * Note: This method is the implementation of CPPUNIT_ASSERT_BORDER_EQUAL, so
 270  *       use that macro instead.
 271 **/
 272 inline void assertBorderEqual(
 273     const css::table::BorderLine2& rExpected, const css::table::BorderLine2& rActual,
 274     const CppUnit::SourceLine& rSourceLine )
 275 {
 276     CPPUNIT_NS::assertEquals( rExpected.Color, rActual.Color, rSourceLine, "different Color" );
 277     CPPUNIT_NS::assertEquals( rExpected.InnerLineWidth, rActual.InnerLineWidth, rSourceLine, "different InnerLineWidth" );
 278     CPPUNIT_NS::assertEquals( rExpected.OuterLineWidth, rActual.OuterLineWidth, rSourceLine, "different OuterLineWidth" );
 279     CPPUNIT_NS::assertEquals( rExpected.LineDistance, rActual.LineDistance, rSourceLine, "different LineDistance" );
 280     CPPUNIT_NS::assertEquals( rExpected.LineStyle, rActual.LineStyle, rSourceLine, "different LineStyle" );
 281     CPPUNIT_NS::assertEquals( rExpected.LineWidth, rActual.LineWidth, rSourceLine, "different LineWidth" );
 282 }
 283
 284 #define CPPUNIT_ASSERT_BORDER_EQUAL(aExpected, aActual) \
 285         assertBorderEqual( aExpected, aActual, CPPUNIT_SOURCELINE() ) \
 286
 287 #endif // INCLUDED_SW_QA_INC_SWMODELTESTBASE_HXX
 288
 289 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */