oox/qa/unit/vba_compression.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 <cppunit/plugin/TestPlugIn.h>
  11 #include <cppunit/extensions/HelperMacros.h>
  12 #include <cppunit/TestFixture.h>
  13 #include <osl/file.hxx>
  14 #include <oox/ole/vbaexport.hxx>
  15 #include <rtl/bootstrap.hxx>
  16 #include <tools/stream.hxx>
  17 #include <unotest/directories.hxx>
  18 #include <algorithm>
  19
  20 class TestVbaCompression : public CppUnit::TestFixture
  21 {
  22 public:
  23     // just a sequence of bytes that should not be compressed at all
  24     void testSimple1();
  25
  26     // a sequence containing one subsequence that can be compressed
  27     void testSimple2();
  28
  29     void testSimple3();
  30
  31     // real stream from a document
  32     void testComplex1();
  33
  34     // tests taken from the VBA specification
  35     // section 3.2
  36
  37     // section 3.2.1
  38     void testSpec321();
  39     // section 3.2.2
  40     void testSpec322();
  41     // section 3.2.3
  42     void testSpec323();
  43
  44     CPPUNIT_TEST_SUITE(TestVbaCompression);
  45     CPPUNIT_TEST(testSimple1);
  46     CPPUNIT_TEST(testSimple2);
  47     CPPUNIT_TEST(testSimple3);
  48     CPPUNIT_TEST(testComplex1);
  49     CPPUNIT_TEST(testSpec321);
  50     CPPUNIT_TEST(testSpec322);
  51     CPPUNIT_TEST(testSpec323);
  52     CPPUNIT_TEST_SUITE_END();
  53
  54 private:
  55     static OUString const & getDebugDirUrl() {
  56         struct DebugDirUrl {
  57             DebugDirUrl() {
  58                 url = "$UserInstallation/debug/";
  59                 rtl::Bootstrap::expandMacros(url);
  60                     //TODO: provide an OUString -> OUString expansion function, and which throws on
  61                     // failure
  62                 auto e = osl::Directory::create(url);
  63                 CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None, e);
  64             }
  65             OUString url;
  66         };
  67         static DebugDirUrl url;
  68         return url.url;
  69     }
  70
  71     test::Directories const m_directories;
  72 };
  73
  74 namespace {
  75
  76 void ReadFiles(const OUString& rTestFile, const OUString& rReference,
  77         SvMemoryStream& rOutputMemoryStream, SvMemoryStream& rReferenceMemoryStream,
  78         const OUString& rDebugPath)
  79 {
  80     SvFileStream aInputStream(rTestFile, StreamMode::READ);
  81     SvMemoryStream aInputMemoryStream(4096, 4096);
  82     aInputMemoryStream.WriteStream(aInputStream);
  83
  84     VBACompression aCompression(rOutputMemoryStream, aInputMemoryStream);
  85     aCompression.write();
  86
  87     SvFileStream aReferenceStream(rReference, StreamMode::READ);
  88     rReferenceMemoryStream.WriteStream(aReferenceStream);
  89
  90     rOutputMemoryStream.Seek(0);
  91     SvFileStream aDebugStream(rDebugPath, StreamMode::WRITE);
  92     aDebugStream.WriteStream(rOutputMemoryStream);
  93 }
  94
  95 }
  96
  97 void TestVbaCompression::testSimple1()
  98 {
  99     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/simple1.bin");
 100     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/simple1.bin");
 101
 102     SvMemoryStream aOutputMemoryStream(4096, 4096);
 103     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 104     ReadFiles(aTestFile, aReference, aOutputMemoryStream,
 105             aReferenceMemoryStream, getDebugDirUrl() + "vba_debug.bin");
 106
 107     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 108
 109     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 110     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 111
 112     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 113             aOutputMemoryStream.GetSize());
 114     for (sal_uInt64 i = 0; i < nSize; ++i)
 115     {
 116         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 117     }
 118 }
 119
 120 void TestVbaCompression::testSimple2()
 121 {
 122     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/simple2.bin");
 123     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/simple2.bin");
 124
 125     SvMemoryStream aOutputMemoryStream(4096, 4096);
 126     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 127     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug2.bin");
 128
 129     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 130
 131     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 132     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 133
 134     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 135             aOutputMemoryStream.GetSize());
 136     for (sal_uInt64 i = 0; i < nSize; ++i)
 137     {
 138         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 139     }
 140 }
 141
 142 void TestVbaCompression::testSimple3()
 143 {
 144     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/simple3.bin");
 145     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/simple3.bin");
 146
 147     SvMemoryStream aOutputMemoryStream(4096, 4096);
 148     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 149     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug3.bin");
 150
 151     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 152
 153     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData()  );
 154     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 155
 156     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 157             aOutputMemoryStream.GetSize());
 158     for (sal_uInt64 i = 0; i < nSize; ++i)
 159     {
 160         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 161     }
 162 }
 163
 164 void TestVbaCompression::testComplex1()
 165 {
 166     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/complex1.bin");
 167     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/complex1.bin");
 168
 169     SvMemoryStream aOutputMemoryStream(4096, 4096);
 170     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 171     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug_complex1.bin");
 172
 173     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 174
 175     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 176     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 177
 178     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 179             aOutputMemoryStream.GetSize());
 180     for (sal_uInt64 i = 0; i < nSize; ++i)
 181     {
 182         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 183     }
 184 }
 185
 186 void TestVbaCompression::testSpec321()
 187 {
 188     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/spec321.bin");
 189     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/spec321.bin");
 190
 191     SvMemoryStream aOutputMemoryStream(4096, 4096);
 192     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 193     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug_spec321.bin");
 194
 195     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 196
 197     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 198     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 199
 200     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 201             aOutputMemoryStream.GetSize());
 202     for (sal_uInt64 i = 0; i < nSize; ++i)
 203     {
 204         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 205     }
 206 }
 207
 208 void TestVbaCompression::testSpec322()
 209 {
 210     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/spec322.bin");
 211     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/spec322.bin");
 212
 213     SvMemoryStream aOutputMemoryStream(4096, 4096);
 214     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 215     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug_spec322.bin");
 216
 217     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 218
 219     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 220     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 221
 222     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 223             aOutputMemoryStream.GetSize());
 224     for (sal_uInt64 i = 0; i < nSize; ++i)
 225     {
 226         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 227     }
 228 }
 229
 230 void TestVbaCompression::testSpec323()
 231 {
 232     OUString aTestFile = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/spec323.bin");
 233     OUString aReference = m_directories.getPathFromSrc("/oox/qa/unit/data/vba/reference/spec323.bin");
 234
 235     SvMemoryStream aOutputMemoryStream(4096, 4096);
 236     SvMemoryStream aReferenceMemoryStream(4096, 4096);
 237     ReadFiles(aTestFile, aReference, aOutputMemoryStream, aReferenceMemoryStream, getDebugDirUrl() + "vba_debug_spec323.bin");
 238
 239     CPPUNIT_ASSERT_EQUAL(aReferenceMemoryStream.GetSize(), aOutputMemoryStream.GetSize());
 240
 241     const sal_uInt8* pReferenceData = static_cast<const sal_uInt8*>( aReferenceMemoryStream.GetData() );
 242     const sal_uInt8* pData = static_cast<const sal_uInt8*>( aOutputMemoryStream.GetData() );
 243
 244     const sal_uInt64 nSize = std::min(aReferenceMemoryStream.GetSize(),
 245             aOutputMemoryStream.GetSize());
 246     for (sal_uInt64 i = 0; i < nSize; ++i)
 247     {
 248         CPPUNIT_ASSERT_EQUAL(static_cast<int>(pReferenceData[i]), static_cast<int>(pData[i]));
 249     }
 250 }
 251
 252 CPPUNIT_TEST_SUITE_REGISTRATION(TestVbaCompression);
 253
 254 CPPUNIT_PLUGIN_IMPLEMENT();
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */