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 <cstddef>
  23
  24 #include "com/sun/star/beans/NamedValue.hpp"
  25 #include "com/sun/star/beans/PropertyChangeEvent.hpp"
  26 #include "com/sun/star/beans/XPropertyChangeListener.hpp"
  27 #include "com/sun/star/beans/XPropertySet.hpp"
  28 #include "com/sun/star/beans/XPropertyState.hpp"
  29 #include "com/sun/star/configuration/theDefaultProvider.hpp"
  30 #include "com/sun/star/container/XHierarchicalNameAccess.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/uno/Any.hxx"
  37 #include "com/sun/star/uno/Reference.hxx"
  38 #include "com/sun/star/uno/RuntimeException.hpp"
  39 #include "com/sun/star/uno/Sequence.hxx"
  40 #include "com/sun/star/uno/XComponentContext.hpp"
  41 #include "com/sun/star/uno/XInterface.hpp"
  42 #include "com/sun/star/util/XChangesBatch.hpp"
  43 #include "cppuhelper/implbase1.hxx"
  44 #include "cppuhelper/servicefactory.hxx"
  45 #include "osl/conditn.hxx"
  46 #include "osl/thread.h"
  47 #include "osl/thread.hxx"
  48 #include "osl/time.h"
  49 #include "rtl/ref.hxx"
  50 #include "rtl/string.h"
  51 #include "rtl/textcvt.h"
  52 #include "rtl/ustrbuf.hxx"
  53 #include "rtl/ustring.h"
  54 #include "rtl/ustring.hxx"
  55 #include "sal/types.h"
  56 #include "testshl/simpleheader.hxx"
  57
  58 namespace {
  59
  60 void normalize(
  61     OUString const & path, OUString const & relative,
  62     OUString * normalizedPath, OUString * name)
  63 {
  64     sal_Int32 i = relative.lastIndexOf('/');
  65     if (i == -1) {
  66         *normalizedPath = path;
  67         *name = relative;
  68     } else {
  69         OUStringBuffer buf(path);
  70         buf.append(sal_Unicode('/'));
  71         buf.append(relative.copy(0, i));
  72         *normalizedPath = buf.makeStringAndClear();
  73         *name = relative.copy(i + 1);
  74     }
  75 }
  76
  77 class Test: public CppUnit::TestFixture {
  78 public:
  79     virtual void setUp();
  80     virtual void tearDown();
  81
  82     void testKeyFetch();
  83     void testKeySet();
  84     void testKeyReset();
  85     void testSetSetMemberName();
  86     void testReadCommands();
  87     void testThreads();
  88     void testRecursive();
  89     void testCrossThreads();
  90
  91     css::uno::Any getKey(
  92         OUString const & path, OUString const & relative) const;
  93
  94     void setKey(
  95         OUString const & path, OUString const & name,
  96         css::uno::Any const & value) const;
  97
  98     bool resetKey(OUString const & path, OUString const & name) const;
  99
 100     css::uno::Reference< css::uno::XInterface > createViewAccess(
 101         OUString const & path) const;
 102
 103     css::uno::Reference< css::uno::XInterface > createUpdateAccess(
 104         OUString const & path) const;
 105
 106     CPPUNIT_TEST_SUITE(Test);
 107     CPPUNIT_TEST(testKeyFetch);
 108     CPPUNIT_TEST(testKeySet);
 109     CPPUNIT_TEST(testKeyReset);
 110     CPPUNIT_TEST(testSetSetMemberName);
 111     CPPUNIT_TEST(testReadCommands);
 112     CPPUNIT_TEST(testThreads);
 113     CPPUNIT_TEST(testRecursive);
 114     CPPUNIT_TEST(testCrossThreads);
 115     CPPUNIT_TEST_SUITE_END();
 116
 117 private:
 118     css::uno::Reference< css::uno::XComponentContext > context_;
 119     css::uno::Reference< css::lang::XMultiServiceFactory > provider_;
 120 };
 121
 122 class TestThread: public osl::Thread {
 123 public:
 124     TestThread(osl::Condition & stop);
 125
 126     bool getSuccess() const;
 127
 128 protected:
 129     virtual bool iteration() = 0;
 130
 131 private:
 132     virtual void SAL_CALL run();
 133
 134     osl::Condition & stop_;
 135     bool success_;
 136 };
 137
 138 TestThread::TestThread(
 139     osl::Condition & stop):
 140     stop_(stop), success_(true)
 141 {}
 142
 143 bool TestThread::getSuccess() const {
 144     return success_;
 145 }
 146
 147 void TestThread::run() {
 148     try {
 149         while (!stop_.check()) {
 150             if (!iteration()) {
 151                 success_ = false;
 152             }
 153         }
 154     } catch (...) {
 155         success_ = false;
 156     }
 157 }
 158
 159 class ReaderThread: public TestThread {
 160 public:
 161     ReaderThread(
 162         osl::Condition & stop, Test const & test, OUString const & path,
 163         OUString const & relative);
 164
 165 private:
 166     virtual bool iteration();
 167
 168     Test const & test_;
 169     OUString path_;
 170     OUString relative_;
 171 };
 172
 173 ReaderThread::ReaderThread(
 174     osl::Condition & stop, Test const & test, OUString const & path,
 175     OUString const & relative):
 176     TestThread(stop), test_(test), path_(path), relative_(relative)
 177 {
 178     create();
 179 }
 180
 181 bool ReaderThread::iteration() {
 182     return test_.getKey(path_, relative_).hasValue();
 183 }
 184
 185 class WriterThread: public TestThread {
 186 public:
 187     WriterThread(
 188         osl::Condition & stop, Test const & test, OUString const & path,
 189         OUString const & relative);
 190
 191 private:
 192     virtual bool iteration();
 193
 194     Test const & test_;
 195     OUString path_;
 196     OUString name_;
 197     std::size_t index_;
 198 };
 199
 200 WriterThread::WriterThread(
 201     osl::Condition & stop, Test const & test, OUString const & path,
 202     OUString const & relative):
 203     TestThread(stop), test_(test), index_(0)
 204 {
 205     normalize(path, relative, &path_, &name_);
 206     create();
 207 }
 208
 209 bool WriterThread::iteration() {
 210     OUString options[] = {
 211         OUString("fish"),
 212         OUString("chips"),
 213         OUString("kippers"),
 214         OUString("bloaters") };
 215     test_.setKey(path_, name_, css::uno::makeAny(options[index_]));
 216     index_ = (index_ + 1) % (sizeof options / sizeof (OUString));
 217     return true;
 218 }
 219
 220 class RecursiveTest:
 221     public cppu::WeakImplHelper1< css::beans::XPropertyChangeListener >
 222 {
 223 public:
 224     RecursiveTest(Test const & theTest, int count, bool * destroyed);
 225
 226     void test();
 227
 228 protected:
 229     virtual ~RecursiveTest();
 230
 231     virtual void step() const = 0;
 232
 233     Test const & test_;
 234
 235 private:
 236     virtual void SAL_CALL disposing(css::lang::EventObject const &)
 237         throw (css::uno::RuntimeException);
 238
 239     virtual void SAL_CALL propertyChange(
 240         css::beans::PropertyChangeEvent const &)
 241         throw (css::uno::RuntimeException);
 242
 243     int count_;
 244     bool * destroyed_;
 245     css::uno::Reference< css::beans::XPropertySet > properties_;
 246 };
 247
 248 RecursiveTest::RecursiveTest(
 249     Test const & theTest, int count, bool * destroyed):
 250     test_(theTest), count_(count), destroyed_(destroyed)
 251 {}
 252
 253 void RecursiveTest::test() {
 254     properties_ = css::uno::Reference< css::beans::XPropertySet >(
 255         test_.createUpdateAccess(
 256             OUString(
 257                 RTL_CONSTASCII_USTRINGPARAM(
 258                     "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 259                     "dotuno:WebHtml"))),
 260         css::uno::UNO_QUERY_THROW);
 261     properties_->addPropertyChangeListener(
 262         OUString("Label"), this);
 263     step();
 264     CPPUNIT_ASSERT(count_ == 0);
 265     css::uno::Reference< css::lang::XComponent >(
 266         properties_, css::uno::UNO_QUERY_THROW)->dispose();
 267 }
 268
 269 RecursiveTest::~RecursiveTest() {
 270     *destroyed_ = true;
 271 }
 272
 273 void RecursiveTest::disposing(css::lang::EventObject const & Source)
 274     throw (css::uno::RuntimeException)
 275 {
 276     CPPUNIT_ASSERT(properties_.is() && Source.Source == properties_);
 277     properties_.clear();
 278 }
 279
 280 void RecursiveTest::propertyChange(css::beans::PropertyChangeEvent const & evt)
 281     throw (css::uno::RuntimeException)
 282 {
 283     CPPUNIT_ASSERT( evt.Source == properties_ && evt.PropertyName == "Label" );
 284     if (count_ > 0) {
 285         --count_;
 286         step();
 287     }
 288 }
 289
 290 class SimpleRecursiveTest: public RecursiveTest {
 291 public:
 292     SimpleRecursiveTest(Test const & theTest, int count, bool * destroyed);
 293
 294 private:
 295     virtual void step() const;
 296 };
 297
 298 SimpleRecursiveTest::SimpleRecursiveTest(
 299     Test const & theTest, int count, bool * destroyed):
 300     RecursiveTest(theTest, count, destroyed)
 301 {}
 302
 303 void SimpleRecursiveTest::step() const {
 304     test_.setKey(
 305         OUString(
 306             RTL_CONSTASCII_USTRINGPARAM(
 307                 "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 308                 "dotuno:WebHtml")),
 309         OUString("Label"),
 310         css::uno::makeAny(OUString("step")));
 311 }
 312
 313 class CrossThreadTest: public RecursiveTest {
 314 public:
 315     CrossThreadTest(Test const & theTest, int count, bool * destroyed);
 316
 317 private:
 318     virtual void step() const;
 319 };
 320
 321 CrossThreadTest::CrossThreadTest(
 322     Test const & theTest, int count, bool * destroyed):
 323     RecursiveTest(theTest, count, destroyed)
 324 {}
 325
 326 void CrossThreadTest::step() const {
 327     osl::Condition stop;
 328     stop.set();
 329     WriterThread(
 330         stop, test_,
 331         OUString(
 332             RTL_CONSTASCII_USTRINGPARAM(
 333                 "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 334                 "dotuno:WebHtml")),
 335         OUString("Label")).join();
 336     test_.resetKey(
 337         OUString(
 338             RTL_CONSTASCII_USTRINGPARAM(
 339                 "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 340                 "dotuno:WebHtml")),
 341         OUString("Label"));
 342 }
 343
 344 void Test::setUp() {
 345     char const * forward = getForwardString();
 346     rtl_uString * registry = 0;
 347     CPPUNIT_ASSERT(
 348         rtl_convertStringToUString(
 349             &registry, forward, rtl_str_getLength(forward),
 350             osl_getThreadTextEncoding(),
 351             (RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR |
 352              RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR |
 353              RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR)));
 354     context_ = css::uno::Reference< css::uno::XComponentContext >(
 355         css::uno::Reference< css::beans::XPropertySet >(
 356             cppu::createRegistryServiceFactory(
 357                 OUString(registry, SAL_NO_ACQUIRE)),
 358             css::uno::UNO_QUERY_THROW)->getPropertyValue(
 359                 OUString("DefaultContext")),
 360         css::uno::UNO_QUERY_THROW);
 361     provider_ = css::configuration::theDefaultProvider::get(context_);
 362 }
 363
 364 void Test::tearDown() {
 365     css::uno::Reference< css::lang::XComponent >(
 366         context_, css::uno::UNO_QUERY_THROW)->dispose();
 367 }
 368
 369 void Test::testKeyFetch() {
 370     OUString s;
 371     CPPUNIT_ASSERT(
 372         getKey(
 373             OUString("/org.openoffice.Setup"),
 374             OUString("L10N/ooLocale")) >>=
 375         s);
 376     CPPUNIT_ASSERT(
 377         getKey(
 378             OUString("/org.openoffice.Setup"),
 379             OUString("Test/AString")) >>=
 380         s);
 381 }
 382
 383 void Test::testKeySet() {
 384     setKey(
 385         OUString("/org.openoffice.Setup/Test"),
 386         OUString("AString"),
 387         css::uno::makeAny(OUString("baa")));
 388     OUString s;
 389     CPPUNIT_ASSERT(
 390         getKey(
 391             OUString("/org.openoffice.Setup/Test"),
 392             OUString("AString")) >>=
 393         s);
 394     CPPUNIT_ASSERT( s == "baa" );
 395 }
 396
 397 void Test::testKeyReset() {
 398     if (resetKey(
 399             OUString("/org.openoffice.Setup/Test"),
 400             OUString("AString")))
 401     {
 402         OUString s;
 403         CPPUNIT_ASSERT(
 404             getKey(
 405                 OUString("/org.openoffice.Setup/Test"),
 406                 OUString("AString")) >>=
 407             s);
 408         CPPUNIT_ASSERT( s == "Foo" );
 409     }
 410 }
 411
 412 void Test::testSetSetMemberName() {
 413     OUString s;
 414     CPPUNIT_ASSERT(
 415         getKey(
 416             OUString(
 417                 RTL_CONSTASCII_USTRINGPARAM(
 418                     "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 419                     ".uno:FontworkShapeType")),
 420             OUString("Label")) >>=
 421         s);
 422     CPPUNIT_ASSERT( s == "Fontwork Shape" );
 423
 424     css::uno::Reference< css::container::XNameAccess > access(
 425         createUpdateAccess(
 426             OUString(
 427                 RTL_CONSTASCII_USTRINGPARAM(
 428                     "/org.openoffice.UI.GenericCommands/UserInterface/"
 429                     "Commands"))),
 430         css::uno::UNO_QUERY_THROW);
 431     css::uno::Reference< css::container::XNamed > member;
 432     access->getByName(
 433         OUString(".uno:FontworkGalleryFloater")) >>=
 434         member;
 435     CPPUNIT_ASSERT(member.is());
 436     member->setName(
 437         OUString(".uno:FontworkShapeType"));
 438     css::uno::Reference< css::util::XChangesBatch >(
 439         access, css::uno::UNO_QUERY_THROW)->commitChanges();
 440     css::uno::Reference< css::lang::XComponent >(
 441         access, css::uno::UNO_QUERY_THROW)->dispose();
 442
 443     CPPUNIT_ASSERT(
 444         getKey(
 445             OUString(
 446                 RTL_CONSTASCII_USTRINGPARAM(
 447                     "/org.openoffice.UI.GenericCommands/UserInterface/Commands/"
 448                     ".uno:FontworkShapeType")),
 449             OUString("Label")) >>=
 450         s);
 451     CPPUNIT_ASSERT( s == "Fontwork Gallery" );
 452 }
 453
 454 void Test::testReadCommands() {
 455     css::uno::Reference< css::container::XNameAccess > access(
 456         createViewAccess(
 457             OUString(
 458                 RTL_CONSTASCII_USTRINGPARAM(
 459                     "/org.openoffice.UI.GenericCommands/UserInterface/"
 460                     "Commands"))),
 461         css::uno::UNO_QUERY_THROW);
 462     css::uno::Sequence< OUString > names(access->getElementNames());
 463     CPPUNIT_ASSERT(names.getLength() == 695);
 464         // testSetSetMemberName() already removed ".uno:FontworkGalleryFloater"
 465     sal_uInt32 n = osl_getGlobalTimer();
 466     for (int i = 0; i < 8; ++i) {
 467         for (sal_Int32 j = 0; j < names.getLength(); ++j) {
 468             css::uno::Reference< css::container::XNameAccess > child;
 469             if (access->getByName(names[j]) >>= child) {
 470                 CPPUNIT_ASSERT(child.is());
 471                 child->getByName(
 472                     OUString("Label"));
 473                 child->getByName(
 474                     OUString("ContextLabel"));
 475                 child->getByName(
 476                     OUString("Properties"));
 477             }
 478         }
 479     }
 480     n = osl_getGlobalTimer() - n;
 481     t_print("Reading elements took %" SAL_PRIuUINT32 " ms\n", n);
 482     css::uno::Reference< css::lang::XComponent >(
 483         access, css::uno::UNO_QUERY_THROW)->dispose();
 484 }
 485
 486 void Test::testThreads() {
 487     struct Entry { OUString path; OUString relative; };
 488     Entry list[] = {
 489         { OUString("/org.openoffice.Setup"),
 490           OUString("Test/AString") },
 491         { OUString("/org.openoffice.Setup"),
 492           OUString("Test/AString") },
 493         { OUString(
 494                   "/org.openoffice.UI.GenericCommands"),
 495           OUString(
 496                   "UserInterface/Commands/dotuno:WebHtml/Label") },
 497         { OUString(
 498                   "/org.openoffice.UI.GenericCommands"),
 499           OUString(
 500                   "UserInterface/Commands/dotuno:NewPresentation/Label") },
 501         { OUString(
 502                   "/org.openoffice.UI.GenericCommands"),
 503           OUString(
 504                   "UserInterface/Commands/dotuno:RecentFileList/Label") },
 505         { OUString("/org.openoffice.Setup"),
 506           OUString("L10N/ooLocale") },
 507         { OUString("/org.openoffice.Setup"),
 508           OUString("Test/ABoolean") }
 509     };
 510     std::size_t const numReaders = sizeof list / sizeof (Entry);
 511     std::size_t const numWriters = numReaders - 2;
 512     ReaderThread * readers[numReaders];
 513     WriterThread * writers[numWriters];
 514     osl::Condition stop;
 515     for (std::size_t i = 0; i < numReaders; ++i) {
 516         CPPUNIT_ASSERT(getKey(list[i].path, list[i].relative).hasValue());
 517         readers[i] = new ReaderThread(
 518             stop, *this, list[i].path, list[i].relative);
 519     }
 520     for (std::size_t i = 0; i < numWriters; ++i) {
 521         writers[i] = new WriterThread(
 522             stop, *this, list[i].path, list[i].relative);
 523     }
 524     for (int i = 0; i < 5; ++i) {
 525         for (std::size_t j = 0; j < numReaders; ++j) {
 526             OUString path;
 527             OUString name;
 528             normalize(list[j].path, list[j].relative, &path, &name);
 529             resetKey(path, name);
 530             osl::Thread::yield();
 531         }
 532     }
 533     stop.set();
 534     bool success = true;
 535     for (std::size_t i = 0; i < numReaders; ++i) {
 536         readers[i]->join();
 537         success = success && readers[i]->getSuccess();
 538         delete readers[i];
 539     }
 540     for (std::size_t i = 0; i < numWriters; ++i) {
 541         writers[i]->join();
 542         success = success && writers[i]->getSuccess();
 543         delete writers[i];
 544     }
 545     CPPUNIT_ASSERT(success);
 546 }
 547
 548 void Test::testRecursive() {
 549     bool destroyed = false;
 550     rtl::Reference< RecursiveTest >(
 551         new SimpleRecursiveTest(*this, 100, &destroyed))->test();
 552     CPPUNIT_ASSERT(destroyed);
 553 }
 554
 555 void Test::testCrossThreads() {
 556     bool destroyed = false;
 557     rtl::Reference< RecursiveTest >(
 558         new SimpleRecursiveTest(*this, 10, &destroyed))->test();
 559     CPPUNIT_ASSERT(destroyed);
 560 }
 561
 562 css::uno::Any Test::getKey(
 563     OUString const & path, OUString const & relative) const
 564 {
 565     css::uno::Reference< css::container::XHierarchicalNameAccess > access(
 566         createViewAccess(path), css::uno::UNO_QUERY_THROW);
 567     css::uno::Any value(access->getByHierarchicalName(relative));
 568     css::uno::Reference< css::lang::XComponent >(
 569         access, css::uno::UNO_QUERY_THROW)->dispose();
 570     return value;
 571 }
 572
 573 void Test::setKey(
 574     OUString const & path, OUString const & name,
 575     css::uno::Any const & value) const
 576 {
 577     css::uno::Reference< css::container::XNameReplace > access(
 578         createUpdateAccess(path), css::uno::UNO_QUERY_THROW);
 579     access->replaceByName(name, value);
 580     css::uno::Reference< css::util::XChangesBatch >(
 581         access, css::uno::UNO_QUERY_THROW)->commitChanges();
 582     css::uno::Reference< css::lang::XComponent >(
 583         access, css::uno::UNO_QUERY_THROW)->dispose();
 584 }
 585
 586 bool Test::resetKey(OUString const & path, OUString const & name)
 587     const
 588 {
 589     //TODO: support setPropertyToDefault
 590     css::uno::Reference< css::util::XChangesBatch > access(
 591         createUpdateAccess(path), css::uno::UNO_QUERY_THROW);
 592     css::uno::Reference< css::beans::XPropertyState > state(
 593         access, css::uno::UNO_QUERY);
 594     if (!state.is()) {
 595         return false;
 596     }
 597     state->setPropertyToDefault(name);
 598     access->commitChanges();
 599     css::uno::Reference< css::lang::XComponent >(
 600         access, css::uno::UNO_QUERY_THROW)->dispose();
 601     return true;
 602 }
 603
 604 css::uno::Reference< css::uno::XInterface > Test::createViewAccess(
 605     OUString const & path) const
 606 {
 607     css::uno::Any arg(
 608         css::uno::makeAny(
 609             css::beans::NamedValue(
 610                 OUString("nodepath"),
 611                 css::uno::makeAny(path))));
 612     return provider_->createInstanceWithArguments(
 613         OUString(
 614                 "com.sun.star.configuration.ConfigurationAccess"),
 615         css::uno::Sequence< css::uno::Any >(&arg, 1));
 616 }
 617
 618 css::uno::Reference< css::uno::XInterface > Test::createUpdateAccess(
 619     OUString const & path) const
 620 {
 621     css::uno::Any arg(
 622         css::uno::makeAny(
 623             css::beans::NamedValue(
 624                 OUString("nodepath"),
 625                 css::uno::makeAny(path))));
 626     return provider_->createInstanceWithArguments(
 627         OUString(
 628                 "com.sun.star.configuration.ConfigurationUpdateAccess"),
 629         css::uno::Sequence< css::uno::Any >(&arg, 1));
 630 }
 631
 632 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(Test, "alltest");
 633
 634 }
 635
 636 NOADDITIONAL;
 637
 638 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */