test/source/screenshot_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 "test/screenshot_test.hxx"
  11
  12 #include <com/sun/star/util/XCloseable.hpp>
  13 #include <com/sun/star/frame/Desktop.hpp>
  14 #include <comphelper/processfactory.hxx>
  15 #include <vcl/abstdlg.hxx>
  16 #include <vcl/pngwrite.hxx>
  17 #include <vcl/svapp.hxx>
  18 #include <unotools/configmgr.hxx>
  19 #include <unotools/syslocaleoptions.hxx>
  20
  21
  22 namespace {
  23     void splitHelpId( const OString& rHelpId, OUString& rDirname, OUString &rBasename )
  24     {
  25         sal_Int32 nIndex = rHelpId.lastIndexOf( '/' );
  26
  27         if( nIndex > 0 )
  28             rDirname = OStringToOUString( rHelpId.copy( 0, nIndex ), RTL_TEXTENCODING_UTF8 );
  29
  30         if( rHelpId.getLength() > nIndex+1 )
  31             rBasename= OStringToOUString( rHelpId.copy( nIndex+1 ), RTL_TEXTENCODING_UTF8 );
  32     }
  33 }
  34
  35 using namespace css;
  36 using namespace css::uno;
  37
  38 ScreenshotTest::ScreenshotTest()
  39 :   m_aScreenshotDirectory("/screenshots/"),
  40     maKnownDialogs()
  41 {
  42     SvtSysLocaleOptions localeOptions;
  43     maCurrentLanguage = localeOptions.GetLocaleConfigString();
  44 }
  45
  46 ScreenshotTest::~ScreenshotTest()
  47 {
  48 }
  49
  50 void ScreenshotTest::setUp()
  51 {
  52     test::BootstrapFixture::setUp();
  53
  54     mxDesktop = css::frame::Desktop::create( comphelper::getComponentContext(getMultiServiceFactory()) );
  55     CPPUNIT_ASSERT_MESSAGE("no desktop!", mxDesktop.is());
  56
  57     osl::FileBase::RC err = osl::Directory::create( m_directories.getURLFromWorkdir( OUStringToOString(m_aScreenshotDirectory, RTL_TEXTENCODING_UTF8).getStr())) ;
  58     CPPUNIT_ASSERT_MESSAGE(OUStringToOString("Failed to create screenshot directory - " + m_directories.getURLFromWorkdir( OUStringToOString(m_aScreenshotDirectory, RTL_TEXTENCODING_UTF8).getStr()), RTL_TEXTENCODING_UTF8).getStr(), (err == osl::FileBase::E_None || err == osl::FileBase::E_EXIST) );
  59
  60     // initialize maKnownDialogs
  61     if (maKnownDialogs.empty())
  62     {
  63         registerKnownDialogsByID(maKnownDialogs);
  64     }
  65 }
  66
  67 void ScreenshotTest::implSaveScreenshot(const Bitmap& rScreenshot, const OString& rScreenshotId)
  68 {
  69     OUString aDirname, aBasename;
  70     splitHelpId(rScreenshotId, aDirname, aBasename);
  71     aDirname = m_aScreenshotDirectory + maCurrentLanguage + "/" + aDirname;
  72
  73     osl::FileBase::RC err = osl::Directory::createPath(m_directories.getURLFromWorkdir(OUStringToOString(aDirname,RTL_TEXTENCODING_UTF8).getStr()));
  74     CPPUNIT_ASSERT_MESSAGE(OUStringToOString("Failed to create " + aDirname, RTL_TEXTENCODING_UTF8).getStr(),
  75         (err == osl::FileBase::E_None || err == osl::FileBase::E_EXIST));
  76
  77     OUString aFullPath = m_directories.getPathFromWorkdir(OUStringToOString(aDirname + "/" + aBasename + ".png",RTL_TEXTENCODING_UTF8).getStr());
  78     SvFileStream aNew(aFullPath, StreamMode::WRITE | StreamMode::TRUNC);
  79     CPPUNIT_ASSERT_MESSAGE(OUStringToOString("Failed to open " + OUString::number(aNew.GetErrorCode()), RTL_TEXTENCODING_UTF8).getStr(), aNew.IsOpen());
  80
  81     vcl::PNGWriter aPNGWriter(rScreenshot);
  82     aPNGWriter.Write(aNew);
  83 }
  84
  85 void ScreenshotTest::saveScreenshot(VclAbstractDialog& rDialog)
  86 {
  87     const Bitmap aScreenshot(rDialog.createScreenshot());
  88
  89     if (!aScreenshot.IsEmpty())
  90     {
  91         const OString aScreenshotId = rDialog.GetScreenshotId();
  92
  93         if (!aScreenshotId.isEmpty())
  94         {
  95             implSaveScreenshot(aScreenshot, aScreenshotId);
  96         }
  97     }
  98 }
  99
 100 void ScreenshotTest::saveScreenshot(Dialog& rDialog)
 101 {
 102     const Bitmap aScreenshot(rDialog.createScreenshot());
 103
 104     if (!aScreenshot.IsEmpty())
 105     {
 106         const OString aScreenshotId = rDialog.GetScreenshotId();
 107
 108         if (!aScreenshotId.isEmpty())
 109         {
 110             implSaveScreenshot(aScreenshot, aScreenshotId);
 111         }
 112     }
 113 }
 114
 115 VclPtr<VclAbstractDialog> ScreenshotTest::createDialogByName(const OString& rName)
 116 {
 117     const mapType::const_iterator aHit = maKnownDialogs.find(rName);
 118
 119     if (aHit != maKnownDialogs.end())
 120     {
 121         return createDialogByID((*aHit).second);
 122     }
 123
 124     return VclPtr<VclAbstractDialog>();
 125 }
 126
 127 void ScreenshotTest::dumpDialogToPath(VclAbstractDialog& rDialog)
 128 {
 129     const std::vector<OString> aPageDescriptions(rDialog.getAllPageUIXMLDescriptions());
 130
 131     if (aPageDescriptions.size())
 132     {
 133         for (size_t a(0); a < aPageDescriptions.size(); a++)
 134         {
 135             if (rDialog.selectPageByUIXMLDescription(aPageDescriptions[a]))
 136             {
 137                 saveScreenshot(rDialog);
 138             }
 139             else
 140             {
 141                 CPPUNIT_ASSERT(false);
 142             }
 143         }
 144     }
 145     else
 146     {
 147         saveScreenshot(rDialog);
 148     }
 149 }
 150
 151 void ScreenshotTest::dumpDialogToPath(Dialog& rDialog)
 152 {
 153     const std::vector<OString> aPageDescriptions(rDialog.getAllPageUIXMLDescriptions());
 154
 155     if (aPageDescriptions.size())
 156     {
 157         for (size_t a(0); a < aPageDescriptions.size(); a++)
 158         {
 159             if (rDialog.selectPageByUIXMLDescription(aPageDescriptions[a]))
 160             {
 161                 saveScreenshot(rDialog);
 162             }
 163             else
 164             {
 165                 CPPUNIT_ASSERT(false);
 166             }
 167         }
 168     }
 169     else
 170     {
 171         saveScreenshot(rDialog);
 172     }
 173 }
 174
 175 void ScreenshotTest::dumpDialogToPath(const OString& rUIXMLDescription)
 176 {
 177     if (!rUIXMLDescription.isEmpty())
 178     {
 179         VclPtrInstance<Dialog> pDialog(Application::GetDefDialogParent(), WB_STDDIALOG | WB_SIZEABLE, Dialog::InitFlag::NoParent);
 180
 181         {
 182             VclBuilder aBuilder(pDialog, VclBuilderContainer::getUIRootDir(), OStringToOUString(rUIXMLDescription, RTL_TEXTENCODING_UTF8));
 183             vcl::Window *pRoot = aBuilder.get_widget_root();
 184             Dialog *pRealDialog = dynamic_cast<Dialog*>(pRoot);
 185
 186             if (!pRealDialog)
 187             {
 188                 pRealDialog = pDialog;
 189             }
 190
 191             pRealDialog->SetText(utl::ConfigManager::getProductName());
 192             pRealDialog->SetStyle(pDialog->GetStyle() | WB_CLOSEABLE);
 193
 194             dumpDialogToPath(*pRealDialog);
 195         }
 196
 197         pDialog.disposeAndClear();
 198     }
 199 }
 200
 201 void ScreenshotTest::processAllKnownDialogs()
 202 {
 203     for (mapType::const_iterator i = getKnownDialogs().begin(); i != getKnownDialogs().end(); ++i)
 204     {
 205         ScopedVclPtr<VclAbstractDialog> pDlg(createDialogByID((*i).second));
 206
 207         if (pDlg)
 208         {
 209             // known dialog, dump screenshot to path
 210             dumpDialogToPath(*pDlg);
 211         }
 212         else
 213         {
 214             // unknown dialog, should not happen in this basic loop.
 215             // You have probably forgotten to add a case and
 216             // implementastion to createDialogByID, please do this
 217         }
 218     }
 219 }
 220
 221 void ScreenshotTest::processDialogBatchFile(const OUString& rFile)
 222 {
 223     test::Directories aDirectories;
 224     const OUString aURL(aDirectories.getURLFromSrc(rFile));
 225     SvFileStream aStream(aURL, StreamMode::READ);
 226     OString aNextUIFile;
 227     const OString aComment("#");
 228
 229     while (aStream.ReadLine(aNextUIFile))
 230     {
 231         if (!aNextUIFile.isEmpty() && !aNextUIFile.startsWith(aComment))
 232         {
 233             // first check if it's a known dialog
 234             ScopedVclPtr<VclAbstractDialog> pDlg(createDialogByName(aNextUIFile));
 235
 236             if (pDlg)
 237             {
 238                 // known dialog, dump screenshot to path
 239                 dumpDialogToPath(*pDlg);
 240             }
 241             else
 242             {
 243                 // unknown dialog, try fallback to generic created
 244                 // VclBuilder-generated instance. Keep in mind that Dialogs
 245                 // using this mechanism will probably not be layouted well
 246                 // since the setup/initialization part is missing. Thus,
 247                 // only use for fallback when only the UI file is available.
 248                 dumpDialogToPath(aNextUIFile);
 249             }
 250         }
 251     }
 252 }
 253
 254 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */