configmgr/qa/unit/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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <com/sun/star/beans/NamedValue.hpp>
  23 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  24 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26 #include <com/sun/star/beans/XPropertyState.hpp>
  27 #include <com/sun/star/configuration/ReadOnlyAccess.hpp>
  28 #include <com/sun/star/configuration/theDefaultProvider.hpp>
  29 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  30 #include <com/sun/star/container/XNameContainer.hpp>
  31 #include <com/sun/star/container/XNameReplace.hpp>
  32 #include <com/sun/star/container/XNamed.hpp>
  33 #include <com/sun/star/lang/EventObject.hpp>
  34 #include <com/sun/star/lang/XComponent.hpp>
  35 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  36 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  37 #include <com/sun/star/uno/Any.hxx>
  38 #include <com/sun/star/uno/Reference.hxx>
  39 #include <com/sun/star/uno/Sequence.hxx>
  40 #include <com/sun/star/uno/XInterface.hpp>
  41 #include <com/sun/star/util/XChangesBatch.hpp>
  42 #include <cppu/unotype.hxx>
  43 #include <cppuhelper/implbase.hxx>
  44 #include <osl/time.h>
  45 #include <rtl/ref.hxx>
  46 #include <rtl/ustring.hxx>
  47 #include <sal/types.h>
  48 #include <comphelper/processfactory.hxx>
  49 #include <comphelper/configuration.hxx>
  50 #include <comphelper/configurationlistener.hxx>
  51 #include <cppunit/TestAssert.h>
  52 #include <cppunit/TestFixture.h>
  53 #include <cppunit/extensions/HelperMacros.h>
  54 #include <cppunit/plugin/TestPlugIn.h>
  55 #include <officecfg/Office/Math.hxx>
  56
  57 namespace {
  58
  59 class Test: public CppUnit::TestFixture {
  60 public:
  61     virtual void setUp() override;
  62
  63     void testKeyFetch();
  64     void testKeySet();
  65     void testKeyReset();
  66     void testSetSetMemberName();
  67     void testInsertSetMember();
  68     void testLocalizedProperty();
  69     void testReadCommands();
  70     void testListener();
  71     void testRecursive();
  72     void testCrossThreads();
  73
  74     css::uno::Any getKey(
  75         OUString const & path, OUString const & relative) const;
  76
  77     void setKey(
  78         OUString const & path, OUString const & name,
  79         css::uno::Any const & value) const;
  80
  81     bool resetKey(OUString const & path, OUString const & name) const;
  82
  83     css::uno::Reference< css::uno::XInterface > createViewAccess(
  84         OUString const & path) const;
  85
  86     css::uno::Reference< css::uno::XInterface > createUpdateAccess(
  87         OUString const & path) const;
  88
  89     CPPUNIT_TEST_SUITE(Test);
  90     CPPUNIT_TEST(testKeyFetch);
  91     CPPUNIT_TEST(testKeySet);
  92     CPPUNIT_TEST(testKeyReset);
  93     CPPUNIT_TEST(testSetSetMemberName);
  94     CPPUNIT_TEST(testInsertSetMember);
  95     CPPUNIT_TEST(testLocalizedProperty);
  96     CPPUNIT_TEST(testReadCommands);
  97     CPPUNIT_TEST(testListener);
  98     CPPUNIT_TEST(testRecursive);
  99     CPPUNIT_TEST(testCrossThreads);
 100     CPPUNIT_TEST_SUITE_END();
 101
 102 private:
 103     css::uno::Reference< css::lang::XMultiServiceFactory > provider_;
 104 };
 105
 106 class RecursiveTest:
 107     public cppu::WeakImplHelper< css::beans::XPropertyChangeListener >
 108 {
 109 public:
 110     RecursiveTest(Test const & theTest, int count, bool * destroyed);
 111
 112     void test();
 113
 114 protected:
 115     virtual ~RecursiveTest() override;
 116
 117     virtual void step() const = 0;
 118
 119     Test const & test_;
 120
 121 private:
 122     virtual void SAL_CALL disposing(css::lang::EventObject const &) override;
 123
 124     virtual void SAL_CALL propertyChange(
 125         css::beans::PropertyChangeEvent const &) override;
 126
 127     int count_;
 128     bool * destroyed_;
 129     css::uno::Reference< css::beans::XPropertySet > properties_;
 130 };
 131
 132 RecursiveTest::RecursiveTest(
 133     Test const & theTest, int count, bool * destroyed):
 134     test_(theTest), count_(count), destroyed_(destroyed)
 135 {}
 136
 137 void RecursiveTest::test()
 138 {
 139     properties_.set(
 140         test_.createUpdateAccess(
 141             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/Commands/"
 142                      ".uno:WebHtml"_ustr),
 143         css::uno::UNO_QUERY_THROW);
 144     properties_->addPropertyChangeListener(u"Label"_ustr, this);
 145     step();
 146     CPPUNIT_ASSERT_EQUAL(0, count_);
 147     css::uno::Reference< css::lang::XComponent >(
 148         properties_, css::uno::UNO_QUERY_THROW)->dispose();
 149 }
 150
 151 RecursiveTest::~RecursiveTest()
 152 {
 153     *destroyed_ = true;
 154 }
 155
 156 void RecursiveTest::disposing(css::lang::EventObject const & Source)
 157 {
 158     CPPUNIT_ASSERT(properties_.is());
 159     CPPUNIT_ASSERT_EQUAL(
 160         css::uno::Reference<css::uno::XInterface>(
 161             properties_, css::uno::UNO_QUERY_THROW),
 162         Source.Source);
 163     properties_.clear();
 164 }
 165
 166 void RecursiveTest::propertyChange(css::beans::PropertyChangeEvent const & evt)
 167 {
 168     CPPUNIT_ASSERT_EQUAL(
 169         css::uno::Reference<css::uno::XInterface>(
 170             properties_, css::uno::UNO_QUERY_THROW),
 171         evt.Source);
 172     CPPUNIT_ASSERT_EQUAL( u"Label"_ustr, evt.PropertyName );
 173     if (count_ > 0) {
 174         --count_;
 175         step();
 176     }
 177 }
 178
 179 class SimpleRecursiveTest: public RecursiveTest {
 180 public:
 181     SimpleRecursiveTest(Test const & theTest, int count, bool * destroyed);
 182
 183 private:
 184     virtual void step() const override;
 185 };
 186
 187 SimpleRecursiveTest::SimpleRecursiveTest(
 188     Test const & theTest, int count, bool * destroyed):
 189     RecursiveTest(theTest, count, destroyed)
 190 {}
 191
 192 void SimpleRecursiveTest::step() const
 193 {
 194     test_.setKey(
 195         u"/org.openoffice.Office.UI.GenericCommands/UserInterface/Commands/"
 196                  ".uno:WebHtml"_ustr,
 197         u"Label"_ustr,
 198         css::uno::Any(u"step"_ustr));
 199 }
 200
 201 void Test::setUp()
 202 {
 203     provider_ = css::configuration::theDefaultProvider::get(
 204                         comphelper::getProcessComponentContext() );
 205 }
 206
 207 void Test::testKeyFetch()
 208 {
 209     {
 210         OUString s;
 211         CPPUNIT_ASSERT(
 212             getKey(
 213                 u"/org.openoffice.System"_ustr,
 214                 u"L10N/Locale"_ustr) >>=
 215             s);
 216     }
 217     {
 218         auto const v = getKey(u"/org.openoffice.System"_ustr, u"L10N/['Locale']"_ustr);
 219         CPPUNIT_ASSERT_EQUAL(cppu::UnoType<OUString>::get(), v.getValueType());
 220     }
 221 }
 222
 223 void Test::testKeySet()
 224 {
 225     setKey(
 226         u"/org.openoffice.System/L10N"_ustr,
 227         u"Locale"_ustr,
 228         css::uno::Any(u"com.sun.star.configuration.backend.LocaleBackend UILocale"_ustr));
 229     OUString s;
 230     CPPUNIT_ASSERT(
 231         getKey(
 232             u"/org.openoffice.System/L10N"_ustr,
 233             u"Locale"_ustr) >>=
 234         s);
 235     CPPUNIT_ASSERT_EQUAL( u"com.sun.star.configuration.backend.LocaleBackend UILocale"_ustr, s );
 236 }
 237
 238 void Test::testKeyReset()
 239 {
 240     if (resetKey(
 241             u"/org.openoffice.System/L10N"_ustr,
 242             u"Locale"_ustr))
 243     {
 244         OUString s;
 245         CPPUNIT_ASSERT(
 246             getKey(
 247                 u"/org.openoffice.System/L10N"_ustr,
 248                 u"Locale"_ustr) >>=
 249             s);
 250         CPPUNIT_ASSERT_EQUAL( u"com.sun.star.configuration.backend.LocaleBackend Locale"_ustr, s );
 251     }
 252 }
 253
 254 void Test::testSetSetMemberName()
 255 {
 256     OUString s;
 257     CPPUNIT_ASSERT(
 258         getKey(
 259             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/Commands/"
 260                      ".uno:FontworkShapeType"_ustr,
 261             u"Label"_ustr) >>=
 262         s);
 263     CPPUNIT_ASSERT_EQUAL( u"Fontwork Shape"_ustr, s );
 264
 265     css::uno::Reference< css::container::XNameAccess > access(
 266         createUpdateAccess(
 267             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/"
 268                      "Commands"_ustr),
 269         css::uno::UNO_QUERY_THROW);
 270     css::uno::Reference< css::container::XNamed > member;
 271     access->getByName(u".uno:FontworkGalleryFloater"_ustr) >>= member;
 272     CPPUNIT_ASSERT(member.is());
 273     member->setName(u".uno:FontworkShapeType"_ustr);
 274     css::uno::Reference< css::util::XChangesBatch >(
 275         access, css::uno::UNO_QUERY_THROW)->commitChanges();
 276     css::uno::Reference< css::lang::XComponent >(
 277         access, css::uno::UNO_QUERY_THROW)->dispose();
 278
 279     CPPUNIT_ASSERT(
 280         getKey(
 281             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/Commands/"
 282                     ".uno:FontworkShapeType"_ustr,
 283             u"Label"_ustr) >>=
 284         s);
 285     CPPUNIT_ASSERT_EQUAL( u"Insert Fontwork"_ustr, s );
 286 }
 287
 288 void Test::testInsertSetMember() {
 289     css::uno::Reference<css::container::XNameContainer> access(
 290         createUpdateAccess(
 291             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/Commands"_ustr),
 292         css::uno::UNO_QUERY_THROW);
 293     css::uno::Reference<css::uno::XInterface> member;
 294     member.set(
 295         css::uno::Reference<css::lang::XSingleServiceFactory>(
 296             access, css::uno::UNO_QUERY_THROW)->createInstance());
 297     CPPUNIT_ASSERT(member.is());
 298     access->insertByName(u"A"_ustr, css::uno::Any(member));
 299     member.set(
 300         css::uno::Reference<css::lang::XSingleServiceFactory>(
 301             access, css::uno::UNO_QUERY_THROW)->createInstance());
 302     CPPUNIT_ASSERT(member.is());
 303     try {
 304         access->insertByName(u""_ustr, css::uno::Any(member));
 305         CPPUNIT_FAIL("expected IllegalArgumentException");
 306     } catch (css::lang::IllegalArgumentException &) {}
 307     try {
 308         access->insertByName(u"\x01"_ustr, css::uno::Any(member));
 309         CPPUNIT_FAIL("expected IllegalArgumentException");
 310     } catch (css::lang::IllegalArgumentException &) {}
 311     try {
 312         access->insertByName(u"a/b"_ustr, css::uno::Any(member));
 313     } catch (css::lang::IllegalArgumentException &) {
 314         CPPUNIT_FAIL("unexpected IllegalArgumentException");
 315     }
 316     css::uno::Reference<css::util::XChangesBatch>(
 317         access, css::uno::UNO_QUERY_THROW)->commitChanges();
 318     css::uno::Reference<css::lang::XComponent>(
 319         access, css::uno::UNO_QUERY_THROW)->dispose();
 320 }
 321
 322 void Test::testLocalizedProperty() {
 323     auto const access = css::configuration::ReadOnlyAccess::create(
 324         comphelper::getProcessComponentContext(), u"*"_ustr);
 325     {
 326         // See <https://bugs.documentfoundation.org/show_bug.cgi?id=33638> "Pagination extension
 327         // not localized in LibreOffice", which wants to retrieve the non-canonical xml:lang="pt-PT"
 328         // value for the passed-in "pt" locale:
 329         OUString v;
 330         CPPUNIT_ASSERT(
 331             access->getByHierarchicalName(u"/org.libreoffice.unittest/localized/*pt"_ustr) >>= v);
 332         CPPUNIT_ASSERT_EQUAL(u"pt-PT"_ustr, v);
 333     }
 334     {
 335         // See <https://gerrit.libreoffice.org/c/core/+/147089> "configmgr: fix no longer found
 336         // es-419 -> es fallback", which wants to retrieve the xml:lang="es" value for the passed-in
 337         // "es-419" locale:
 338         OUString v;
 339         CPPUNIT_ASSERT(
 340             access->getByHierarchicalName(u"/org.libreoffice.unittest/localized/*es-419"_ustr) >>= v);
 341         CPPUNIT_ASSERT_EQUAL(u"es"_ustr, v);
 342     }
 343     {
 344         // See <https://git.libreoffice.org/core/+/dfc28be2487c13be36a90efd778b8d8f179c589d%5E%21>
 345         // "configmgr: Use a proper LanguageTag-based locale fallback mechanism":
 346         OUString v;
 347         CPPUNIT_ASSERT(
 348             access->getByHierarchicalName(u"/org.libreoffice.unittest/localized/*zh-Hant-TW"_ustr) >>= v);
 349         CPPUNIT_ASSERT_EQUAL(u"zh-TW"_ustr, v);
 350     }
 351     {
 352         // Make sure a degenerate passed-in "-" locale is handled gracefully:
 353         OUString v;
 354         CPPUNIT_ASSERT(
 355             access->getByHierarchicalName(u"/org.libreoffice.unittest/localized/*-"_ustr) >>= v);
 356         CPPUNIT_ASSERT_EQUAL(u"en-US"_ustr, v);
 357     }
 358     {
 359         // Make sure a degenerate passed-in "-" locale is handled gracefully:
 360         OUString v;
 361         CPPUNIT_ASSERT(
 362             access->getByHierarchicalName(u"/org.libreoffice.unittest/noDefaultLang/*-"_ustr) >>= v);
 363         CPPUNIT_ASSERT_EQUAL(u"en-US"_ustr, v);
 364     }
 365 }
 366
 367 void Test::testReadCommands()
 368 {
 369     css::uno::Reference< css::container::XNameAccess > access(
 370         createViewAccess(
 371             u"/org.openoffice.Office.UI.GenericCommands/UserInterface/"
 372                      "Commands"_ustr),
 373         css::uno::UNO_QUERY_THROW);
 374     const css::uno::Sequence< OUString > names(access->getElementNames());
 375
 376     /*CPPUNIT_ASSERT_EQUAL(749, names.getLength());*/
 377     // testSetSetMemberName() already removed ".uno:FontworkGalleryFloater"
 378     sal_uInt32 n = osl_getGlobalTimer();
 379     for (int i = 0; i < 8; ++i) {
 380         for (OUString const & childName : names) {
 381             css::uno::Reference< css::container::XNameAccess > child;
 382             if (access->getByName(childName) >>= child) {
 383                 CPPUNIT_ASSERT(child.is());
 384                 child->getByName(u"Label"_ustr);
 385                 child->getByName(u"ContextLabel"_ustr);
 386                 child->getByName(u"Properties"_ustr);
 387             }
 388         }
 389     }
 390     n = osl_getGlobalTimer() - n;
 391     printf("Reading elements took %" SAL_PRIuUINT32 " ms\n", n);
 392     css::uno::Reference< css::lang::XComponent >(
 393         access, css::uno::UNO_QUERY_THROW)->dispose();
 394 }
 395
 396 void Test::testListener()
 397 {
 398     OUString aRandomPath = u"/org.openoffice.Office.Math/View"_ustr;
 399
 400     // test with no props.
 401     {
 402         rtl::Reference xListener(
 403             new comphelper::ConfigurationListener(aRandomPath));
 404         xListener->dispose();
 405     }
 406
 407     // test some changes
 408     {
 409         rtl::Reference xListener(
 410             new comphelper::ConfigurationListener(aRandomPath));
 411
 412         comphelper::ConfigurationListenerProperty<bool> aSetting(xListener, u"AutoRedraw"_ustr);
 413         CPPUNIT_ASSERT_MESSAGE("check AutoRedraw defaults to true", aSetting.get());
 414
 415         // set to false
 416         {
 417             std::shared_ptr< comphelper::ConfigurationChanges > xChanges(
 418                 comphelper::ConfigurationChanges::create());
 419             officecfg::Office::Math::View::AutoRedraw::set(false, xChanges);
 420             xChanges->commit();
 421         }
 422         CPPUNIT_ASSERT_MESSAGE("listener failed to trigger", !aSetting.get());
 423
 424         // set to true
 425         {
 426             std::shared_ptr< comphelper::ConfigurationChanges > xChanges(
 427                 comphelper::ConfigurationChanges::create());
 428             officecfg::Office::Math::View::AutoRedraw::set(true, xChanges);
 429             xChanges->commit();
 430         }
 431         CPPUNIT_ASSERT_MESSAGE("listener failed to trigger", aSetting.get());
 432
 433         xListener->dispose();
 434     }
 435 }
 436
 437 void Test::testRecursive()
 438 {
 439     bool destroyed = false;
 440     rtl::Reference< RecursiveTest >(
 441         new SimpleRecursiveTest(*this, 100, &destroyed))->test();
 442     CPPUNIT_ASSERT(destroyed);
 443 }
 444
 445 void Test::testCrossThreads()
 446 {
 447     bool destroyed = false;
 448     rtl::Reference< RecursiveTest >(
 449         new SimpleRecursiveTest(*this, 10, &destroyed))->test();
 450     CPPUNIT_ASSERT(destroyed);
 451 }
 452
 453 css::uno::Any Test::getKey(
 454     OUString const & path, OUString const & relative) const
 455 {
 456     css::uno::Reference< css::container::XHierarchicalNameAccess > access(
 457         createViewAccess(path), css::uno::UNO_QUERY_THROW);
 458     css::uno::Any value(access->getByHierarchicalName(relative));
 459     css::uno::Reference< css::lang::XComponent >(
 460         access, css::uno::UNO_QUERY_THROW)->dispose();
 461     return value;
 462 }
 463
 464 void Test::setKey(
 465     OUString const & path, OUString const & name,
 466     css::uno::Any const & value) const
 467 {
 468     css::uno::Reference< css::container::XNameReplace > access(
 469         createUpdateAccess(path), css::uno::UNO_QUERY_THROW);
 470     access->replaceByName(name, value);
 471     css::uno::Reference< css::util::XChangesBatch >(
 472         access, css::uno::UNO_QUERY_THROW)->commitChanges();
 473     css::uno::Reference< css::lang::XComponent >(
 474         access, css::uno::UNO_QUERY_THROW)->dispose();
 475 }
 476
 477 bool Test::resetKey(OUString const & path, OUString const & name)
 478     const
 479 {
 480     //TODO: support setPropertyToDefault
 481     css::uno::Reference< css::util::XChangesBatch > access(
 482         createUpdateAccess(path), css::uno::UNO_QUERY_THROW);
 483     css::uno::Reference< css::beans::XPropertyState > state(
 484         access, css::uno::UNO_QUERY);
 485     if (!state.is()) {
 486         return false;
 487     }
 488     state->setPropertyToDefault(name);
 489     access->commitChanges();
 490     css::uno::Reference< css::lang::XComponent >(
 491         access, css::uno::UNO_QUERY_THROW)->dispose();
 492     return true;
 493 }
 494
 495 css::uno::Reference< css::uno::XInterface > Test::createViewAccess(
 496     OUString const & path) const
 497 {
 498     css::uno::Any arg(
 499             css::beans::NamedValue(
 500                 u"nodepath"_ustr,
 501                 css::uno::Any(path)));
 502     return provider_->createInstanceWithArguments(
 503         u"com.sun.star.configuration.ConfigurationAccess"_ustr,
 504         css::uno::Sequence< css::uno::Any >(&arg, 1));
 505 }
 506
 507 css::uno::Reference< css::uno::XInterface > Test::createUpdateAccess(
 508     OUString const & path) const
 509 {
 510     css::uno::Any arg(
 511             css::beans::NamedValue(
 512                 u"nodepath"_ustr,
 513                 css::uno::Any(path)));
 514     return provider_->createInstanceWithArguments(
 515         u"com.sun.star.configuration.ConfigurationUpdateAccess"_ustr,
 516         css::uno::Sequence< css::uno::Any >(&arg, 1));
 517 }
 518
 519 CPPUNIT_TEST_SUITE_REGISTRATION(Test);
 520
 521 }
 522
 523 CPPUNIT_PLUGIN_IMPLEMENT();
 524
 525 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */