LUMIERA.clone/tests/core/steam/asset/dependent-assets-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

212 lines
6.8 KiB
C++
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
DependentAssets(Test) - check the asset dependency handling
Copyright (C)
2008, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.
* *****************************************************************/
/** @file dependent-assets-test.cpp
** unit test \ref DependentAssets_test
*/
#include "lib/test/run.hpp"
#include "steam/asset/testasset.hpp"
#include "steam/asset/asset-diagnostics.hpp"
#include "vault/media-access-mock.hpp"
#include "lib/depend-inject.hpp"
#include "steam/asset/media.hpp"
#include "steam/asset/clip.hpp"
#include "lib/util.hpp"
using util::contains;
using util::isnil;
namespace steam {
namespace asset{
namespace test {
using MediaAccessMock = lib::DependInject<vault::MediaAccessFacade>
::Local<vault::test::MediaAccessMock>;
/***************************************************************//**
* @test the handling of Assets dependent on other Assets and the
* enabling/disabling of Assets.
* @see asset::Asset
* @see asset::Clip
*/
class DependentAssets_test : public Test
{
virtual void run (Arg)
{
checkDependencyMechanics ();
checkUnlinking ();
checkEnablementPropagation ();
checkRealAssetDependencyRegistration ();
}
typedef TestAsset<Asset> TA;
typedef TA::PA PTestA;
/** @test check operation of basic asset dependency support
*/
void checkDependencyMechanics ()
{
PAsset a1 = TA::create();
CHECK (isnil (a1->getParents()));
CHECK (isnil (a1->getDependant()));
PTestA a2 = TA::create(a1);
CHECK (a1 == a2->getParents()[0]); // TestAsset registered a1 as parent
CHECK (a2 == a1->getDependant()[0]);
PAsset a3 = TA::create();
a2->set_depend(a3);
CHECK (a3 == a2->getParents()[1]);
CHECK (a2 == a3->getDependant()[0]);
CHECK (!contains (a1->getDependant(), a3));
}
/** @test unlink operation removing inter asset links
*/
void checkUnlinking ()
{
PTestA a1_ = TA::create();
PAsset a1 (a1_);
PTestA a2_ = TA::create(a1);
PAsset a2 (a2_);
PAsset a3 = TA::create(a2);
CHECK (a1 == a2->getParents()[0]);
CHECK (a2 == a1->getDependant()[0]);
CHECK (a2 == a3->getParents()[0]);
CHECK (a3 == a2->getDependant()[0]);
a2_->call_unlink();
CHECK (isnil (a2->getDependant()));
CHECK (!contains (a1->getDependant(), a2)); // has been propagated up
CHECK (!isnil (a2->getParents()));
CHECK (contains (a3->getParents(), a2)); // but up-links remain intact
a2_->call_unlink(a1->getID());
a2_->set_depend(a1);
PAsset a4 = TA::create(a1);
CHECK (a1 == a2->getParents()[0]);
CHECK (a1 == a4->getParents()[0]);
CHECK (a2 == a1->getDependant()[0]);
CHECK (a4 == a1->getDependant()[1]);
a1_->call_unlink(a4->getID());
CHECK (!contains (a1->getDependant(), a4)); // selectively removed
CHECK ( contains (a1->getDependant(), a2));
CHECK (a1 == a4->getParents()[0]); // no propagation
}
/** @test enabling and disabling an asset should
* propagate to dependant assets
*/
void checkEnablementPropagation ()
{
PAsset a1 = TA::create();
PTestA a2_= TA::create(a1);
PAsset a2 (a2_);
PAsset a3 = TA::create(); // not dependant
CHECK (a1->isActive());
CHECK (a2->isActive());
CHECK (a3->isActive());
a1->enable(false);
CHECK (!a1->isActive());
CHECK (!a2->isActive());
CHECK (a3->isActive());
a2->enable(true);
CHECK (!a1->isActive());
CHECK (!a2->isActive()); // ignored because parent is disabled
a1->enable(true);
CHECK (a1->isActive());
CHECK (a2->isActive());
a2->enable(false);
CHECK (a1->isActive());
CHECK (!a2->isActive()); // disabling not propagated to parent
a2->enable(true);
CHECK (a1->isActive());
CHECK (a2->isActive());
a3->enable(false);
CHECK (a1->isActive());
CHECK (a2->isActive());
CHECK (!a3->isActive()); // no dependency...
a1->enable(false);
a3->enable();
CHECK (!a1->isActive());
CHECK (!a2->isActive());
CHECK (a3->isActive());
a1->enable();
a2_->set_depend(a3); // now add a new parent dependency
a3->enable(false);
CHECK (a1->isActive());
CHECK (!a2->isActive()); // has been propagated via the new dependency
CHECK (!a3->isActive());
a2->enable(true);
CHECK (a1->isActive()); // no change because one of the parents is disbled
CHECK (!a2->isActive());
CHECK (!a3->isActive());
a1->enable(false);
CHECK (!a1->isActive());
a3->enable(true);
CHECK (!a1->isActive()); // no propagation because the disabled other parent (a1)
CHECK (!a2->isActive());
CHECK (a3->isActive());
a1->enable(true);
CHECK (a1->isActive()); // but now propagation is possible
CHECK (a2->isActive());
CHECK (a3->isActive());
}
/** @test each real world asset subclass has to care
* for registering and deregistering any additional
* dependencies. Here we collect some more prominent
* examples (and hopefully don't fail to cover any
* important special cases...)
*/
void checkRealAssetDependencyRegistration ()
{
MediaAccessMock useMockMedia;
// -----Media and Clip--------------------------------
typedef lib::P<Media> PM;
typedef lib::P<Clip> PC;
PM mm = asset::Media::create("test-1", VIDEO);
PC cc = mm->createClip()->findClipAsset();
CHECK (dependencyCheck (cc,mm));
}
};
/** Register this test class... */
LAUNCHER (DependentAssets_test, "unit function asset");
}}} // namespace steam::asset::test