diff options
| -rw-r--r-- | vcl/CppunitTest_vcl_dialogs_test.mk | 66 | ||||
| -rw-r--r-- | vcl/Module_vcl.mk | 5 | ||||
| -rw-r--r-- | vcl/qa/unit/data/vcl-dialogs-test.txt | 45 | ||||
| -rw-r--r-- | vcl/qa/unit/vcl-dialogs-test.cxx | 150 |
4 files changed, 266 insertions, 0 deletions
diff --git a/vcl/CppunitTest_vcl_dialogs_test.mk b/vcl/CppunitTest_vcl_dialogs_test.mk new file mode 100644 index 000000000000..b5940155ab73 --- /dev/null +++ b/vcl/CppunitTest_vcl_dialogs_test.mk @@ -0,0 +1,66 @@ +# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*- +#************************************************************************* +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +#************************************************************************* + +$(eval $(call gb_CppunitTest_CppunitTest,vcl_dialogs_test)) + +$(eval $(call gb_CppunitTest_add_exception_objects,vcl_dialogs_test, \ + vcl/qa/unit/vcl-dialogs-test \ +)) + +$(eval $(call gb_CppunitTest_use_sdk_api,vcl_dialogs_test)) + +$(eval $(call gb_CppunitTest_set_include,desktop_dialogs_test,\ + -I$(SRCDIR)/vcl/inc \ + $$(INCLUDE) \ +)) + +$(eval $(call gb_CppunitTest_use_libraries,vcl_dialogs_test, \ + basegfx \ + comphelper \ + cppu \ + cppuhelper \ + drawinglayer \ + editeng \ + i18nlangtag \ + i18nutil \ + msfilter \ + oox \ + sal \ + salhelper \ + sax \ + sfx \ + sot \ + svl \ + svt \ + test \ + tl \ + tk \ + ucbhelper \ + unotest \ + utl \ + vcl \ + xo \ + $(gb_UWINAPI) \ +)) + +$(eval $(call gb_CppunitTest_use_external,vcl_dialogs_test,boost_headers)) + +$(eval $(call gb_CppunitTest_use_sdk_api,vcl_dialogs_test)) + +$(eval $(call gb_CppunitTest_use_ure,vcl_dialogs_test)) +$(eval $(call gb_CppunitTest_use_vcl_non_headless_with_windows,vcl_dialogs_test)) + +$(eval $(call gb_CppunitTest_use_rdb,vcl_dialogs_test,services)) + +# $(eval $(call gb_CppunitTest_use_configuration,vcl_dialogs_test)) +$(eval $(call gb_CppunitTest_use_instdir_configuration,vcl_dialogs_test)) + +# vim: set noet sw=4 ts=4: diff --git a/vcl/Module_vcl.mk b/vcl/Module_vcl.mk index 03c884c491b0..5d5a2ac1e39d 100644 --- a/vcl/Module_vcl.mk +++ b/vcl/Module_vcl.mk @@ -129,4 +129,9 @@ $(eval $(call gb_Module_add_check_targets,vcl,\ CppunitTest_vcl_blocklistparser_test \ )) endif + +$(eval $(call gb_Module_add_slowcheck_targets,vcl,\ + CppunitTest_vcl_dialogs_test \ +)) + # vim: set noet sw=4 ts=4: diff --git a/vcl/qa/unit/data/vcl-dialogs-test.txt b/vcl/qa/unit/data/vcl-dialogs-test.txt new file mode 100644 index 000000000000..42354864f311 --- /dev/null +++ b/vcl/qa/unit/data/vcl-dialogs-test.txt @@ -0,0 +1,45 @@ +# -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- +# +# This file is part of the LibreOffice project. +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# + +# This file contains all dialogs that the unit tests in the module +# will work on if it is in script mode. It will read one-by-one, +# try to open it and create a screenshot that will be saved in +# workdir/screenshots using the pattern of the ui-file name. +# +# Syntax: +# - emty lines are allowed +# - lines starting with '#' are treated as comment +# - all other lines should contain a *.ui filename in the same +# notation as in the dialog constructors (see code) + +# +# The 'known' dialogs which have a hard-coded representation +# in registerKnownDialogsByID/createDialogByID +# + +# No known dialogs in vcl for now + +# +# Dialogs without a hard-coded representation. These will +# be visualized using a fallback based on VclBuilder +# + +# currently deactivated, leads to problems and the test to not work +# This is typically a hint that these should be hard-coded in the +# test case since they need some document and model data to work + +vcl/ui/printerpropertiesdialog.ui +vcl/ui/printerpaperpage.ui +vcl/ui/printerdevicepage.ui +vcl/ui/printdialog.ui +vcl/ui/querydialog.ui +vcl/ui/cupspassworddialog.ui +vcl/ui/errornoprinterdialog.ui +vcl/ui/errornocontentdialog.ui +vcl/ui/printprogressdialog.ui diff --git a/vcl/qa/unit/vcl-dialogs-test.cxx b/vcl/qa/unit/vcl-dialogs-test.cxx new file mode 100644 index 000000000000..914c52db550f --- /dev/null +++ b/vcl/qa/unit/vcl-dialogs-test.cxx @@ -0,0 +1,150 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#include <sal/config.h> +#include <test/screenshot_test.hxx> +#include <rtl/strbuf.hxx> +#include <osl/file.hxx> +#include <sfx2/app.hxx> +#include <vcl/abstdlg.hxx> + +using namespace ::com::sun::star; + +/// Test opening a dialog in vcl +class VclDialogsTest : public ScreenshotTest +{ +private: + /// helper method to populate KnownDialogs, called in setUp(). Needs to be + /// written and has to add entries to KnownDialogs + virtual void registerKnownDialogsByID(mapType& rKnownDialogs) override; + + /// dialog creation for known dialogs by ID. Has to be implemented for + /// each registered known dialog + virtual VclAbstractDialog* createDialogByID(sal_uInt32 nID) override; + +public: + VclDialogsTest(); + virtual ~VclDialogsTest(); + + virtual void setUp() override; + + // try to open a dialog + void openAnyDialog(); + + CPPUNIT_TEST_SUITE(VclDialogsTest); + CPPUNIT_TEST(openAnyDialog); + CPPUNIT_TEST_SUITE_END(); +}; + +VclDialogsTest::VclDialogsTest() +{ +} + +VclDialogsTest::~VclDialogsTest() +{ +} + +void VclDialogsTest::setUp() +{ + ScreenshotTest::setUp(); +} + +void VclDialogsTest::registerKnownDialogsByID(mapType& /*rKnownDialogs*/) +{ + // fill map of known dilogs +} + +VclAbstractDialog* VclDialogsTest::createDialogByID(sal_uInt32 /*nID*/) +{ + return nullptr; +} + +void VclDialogsTest::openAnyDialog() +{ + /// example how to process an input file containing the UXMLDescriptions of the dialogs + /// to dump + if (true) + { + test::Directories aDirectories; + OUString aURL = aDirectories.getURLFromSrc("vcl/qa/unit/data/vcl-dialogs-test.txt"); + SvFileStream aStream(aURL, StreamMode::READ); + OString aNextUIFile; + const OString aComment("#"); + + while (aStream.ReadLine(aNextUIFile)) + { + if (!aNextUIFile.isEmpty() && !aNextUIFile.startsWith(aComment)) + { + // first check if it's a known dialog + std::unique_ptr<VclAbstractDialog> pDlg(createDialogByName(aNextUIFile)); + + if (pDlg) + { + // known dialog, dump screenshot to path + dumpDialogToPath(*pDlg); + } + else + { + // unknown dialog, try fallback to generic created + // VclBuilder-generated instance. Keep in mind that Dialogs + // using this mechanism will probably not be layouted well + // since the setup/initialization part is missing. Thus, + // only use for fallback when only the UI file is available. + dumpDialogToPath(aNextUIFile); + } + } + } + } + + /// example how to dump all known dialogs + if (false) + { + // example for SfxTabDialog: 5 -> "modules/sdraw/ui/drawpagedialog.ui" + // example for TabDialog: 22 -> "modules/simpress/ui/headerfooterdialog.ui" + // example for self-adapted wizard: 0 -> "modules/simpress/ui/publishingdialog.ui" + for (mapType::const_iterator i = getKnownDialogs().begin(); i != getKnownDialogs().end(); i++) + { + std::unique_ptr<VclAbstractDialog> pDlg(createDialogByID((*i).second)); + + if (pDlg) + { + // known dialog, dump screenshot to path + dumpDialogToPath(*pDlg); + } + else + { + // unknown dialog, should not happen in this basic loop. + // You have probably forgotten to add a case and + // implementastion to createDialogByID, please do this + } + } + } + + /// example how to dump a dialog using fallback functionality + if (false) + { + // unknown dialog, try fallback to generic created + // VclBuilder-generated instance. Keep in mind that Dialogs + // using this mechanism will probably not be layouted well + // since the setup/initialization part is missing. Thus, + // only use for fallback when only the UI file is available. + // + // Take any example here, it's only for demonstration - using + // even a known one to demonstrate the fallback possibility + const OString aUIXMLDescription("vcl/ui/printerpropertiesdialog.ui"); + + dumpDialogToPath(aUIXMLDescription); + } +} + +CPPUNIT_TEST_SUITE_REGISTRATION(VclDialogsTest); + +CPPUNIT_PLUGIN_IMPLEMENT(); + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |