Files
watrbx-game-engine/App.UnitTest/Instance.cpp
T
2025-09-18 17:55:52 -04:00

580 lines
17 KiB
C++

#include <boost/test/unit_test.hpp>
#include "rbx/test/Base.UnitTest.Lib.h"
#include "rbx/test/ScopedFastFlagSetting.h"
#include "script/script.h"
#include "v8tree/instance.h"
#include "v8dataModel/BasicPartInstance.h"
#include "v8datamodel/PartInstance.h"
#include "v8dataModel/Tool.h"
#include "rbx/test/DataModelFixture.h"
extern const char* const sInstanceTest;
class InstanceTest : public RBX::DescribedCreatable<InstanceTest, RBX::Instance, sInstanceTest>
{
};
const char* const sInstanceTest = "InstanceTest";
RBX_REGISTER_CLASS(InstanceTest);
extern const char* const sStealDescendants;
class StealDescendants : public RBX::DescribedCreatable<StealDescendants, RBX::Instance, sStealDescendants>
{
private:
typedef RBX::DescribedCreatable<StealDescendants, RBX::Instance, sStealDescendants> Super;
/*override*/ void onDescendantAdded(Instance* instance)
{
if(instance->getParent() != this)
{
instance->setAndLockParent(this);
}
Super::onDescendantAdded(instance);
}
};
const char* const sStealDescendants = "StealDescendants";
RBX_REGISTER_CLASS(StealDescendants);
extern const char* const sThrowOnDescendants;
class ThrowOnDescendants : public RBX::DescribedCreatable<ThrowOnDescendants, RBX::Instance, sThrowOnDescendants>
{
private:
typedef RBX::DescribedCreatable<ThrowOnDescendants, RBX::Instance, sThrowOnDescendants> Super;
/*override*/ void onDescendantAdded(Instance* instance)
{
if(instance->getParent() != this)
{
throw std::runtime_error("");
}
Super::onDescendantAdded(instance);
}
};
const char* const sThrowOnDescendants = "ThrowOnDescendants";
RBX_REGISTER_CLASS(ThrowOnDescendants);
extern const char* const sCheckAncestor;
const char* const sCheckAncestor = "CheckAncestor";
class CheckAncestor
: public RBX::DescribedCreatable<CheckAncestor, RBX::Instance, sCheckAncestor>
{
private:
typedef RBX::DescribedCreatable<CheckAncestor, RBX::Instance, sCheckAncestor> Super;
public:
CheckAncestor()
: RBX::DescribedCreatable<CheckAncestor, RBX::Instance, sCheckAncestor>()
{
setName(sCheckAncestor);
}
protected:
void verifySetAncestor(const RBX::Instance* const newParent, const RBX::Instance* const instanceGettingNewParent) const
{
if (RBX::ServiceProvider::findServiceProvider(newParent))
throw RBX::runtime_error("CheckAncestor can't have a service provider for an ancestor");
Super::verifySetAncestor(newParent, instanceGettingNewParent);
}
};
RBX_REGISTER_CLASS(CheckAncestor);
BOOST_AUTO_TEST_SUITE(Instance)
BOOST_AUTO_TEST_CASE(Clone)
{
int count = RBX::Diagnostics::Countable<RBX::Instance>::getCount();
{
boost::shared_ptr<RBX::Instance> i = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
i->clone(RBX::ScriptingCreator);
}
BOOST_CHECK_EQUAL(count, RBX::Diagnostics::Countable<RBX::Instance>::getCount());
}
BOOST_FIXTURE_TEST_CASE(PerfDynamicCast, RBX::Test::PerformanceTestFixture)
{
shared_ptr<RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
RBX::Instance* inst = part.get();
for (int i=0; i<1000000; ++i)
{
RBX::Tool* testTool = dynamic_cast<RBX::Tool*>(inst);
testTool = 0;
}
}
BOOST_FIXTURE_TEST_CASE(PerfIsA, RBX::Test::PerformanceTestFixture)
{
shared_ptr<RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
RBX::Instance* inst = part.get();
for (int i=0; i<1000000; ++i)
{
inst->getDescriptor().isA(RBX::PartInstance::classDescriptor());
}
}
BOOST_FIXTURE_TEST_CASE(PerfIsAFalse, RBX::Test::PerformanceTestFixture)
{
boost::shared_ptr<RBX::Instance> part = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
RBX::Instance* inst = part.get();
for (int i=0; i<1000000; ++i)
{
inst->isA<RBX::PartInstance>();
}
}
BOOST_FIXTURE_TEST_CASE(PerfIsATool, RBX::Test::PerformanceTestFixture)
{
shared_ptr<RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
RBX::Instance* inst = part.get();
for (int i=0; i<1000000; ++i)
{
inst->isA<RBX::Tool>();
}
}
BOOST_AUTO_TEST_CASE(CastTo)
{
shared_ptr<RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
shared_ptr<RBX::Instance> instance = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
BOOST_CHECK(RBX::Instance::fastDynamicCast<RBX::Instance>(part.get()));
BOOST_CHECK(!RBX::Instance::fastDynamicCast<RBX::PartInstance>(instance.get()));
RBX::Instance* nullInstance = NULL;
BOOST_CHECK(!RBX::Instance::fastDynamicCast<RBX::PartInstance>(nullInstance));
RBX::Instance* inst = part.get();
BOOST_CHECK(inst->fastDynamicCast<RBX::Instance>());
BOOST_CHECK(!instance->fastDynamicCast<RBX::PartInstance>());
}
BOOST_AUTO_TEST_CASE(CastToConst)
{
shared_ptr<const RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
shared_ptr<const RBX::Instance> instance = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
BOOST_CHECK(RBX::Instance::fastDynamicCast<RBX::Instance>(part.get()));
BOOST_CHECK(!RBX::Instance::fastDynamicCast<RBX::PartInstance>(instance.get()));
const RBX::Instance* nullInstance = NULL;
BOOST_CHECK(!RBX::Instance::fastDynamicCast<RBX::PartInstance>(nullInstance));
const RBX::Instance* inst = part.get();
BOOST_CHECK(inst->fastDynamicCast<RBX::Instance>());
BOOST_CHECK(!instance->fastDynamicCast<RBX::PartInstance>());
}
BOOST_AUTO_TEST_CASE(SharedCastTo)
{
shared_ptr<const RBX::PartInstance> part = RBX::Creatable<RBX::Instance>::create<RBX::BasicPartInstance>();
shared_ptr<const RBX::Instance> instance = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
BOOST_CHECK(RBX::Instance::fastSharedDynamicCast<const RBX::Instance>(part));
BOOST_CHECK(!RBX::Instance::fastSharedDynamicCast<const RBX::PartInstance>(instance));
shared_ptr<const RBX::PartInstance> nullInstance;
BOOST_CHECK(!RBX::Instance::fastSharedDynamicCast<const RBX::PartInstance>(nullInstance));
}
BOOST_FIXTURE_TEST_CASE(LockUnlockDeprecated, DataModelFixture)
{
std::auto_ptr<RBX::Reflection::Tuple> result = execute("Instance.Unlock() return Instance.Lock(nil)");
BOOST_REQUIRE_EQUAL(result->values.size(), 1);
BOOST_CHECK(result->values.at(0).get<bool>());
}
BOOST_AUTO_TEST_CASE(Parenting)
{
shared_ptr<RBX::Instance> instance = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
shared_ptr<RBX::Instance> checkAncestor = RBX::Creatable<RBX::Instance>::create<CheckAncestor>();
DataModelFixture dm;
RBX::DataModel::LegacyLock lock(&dm, RBX::DataModelJob::Write);
checkAncestor->setParent2(instance);
BOOST_CHECK(checkAncestor->getParent() != NULL);
BOOST_CHECK_THROW(instance->setParent2(dm.dataModel), std::exception);
instance->setParent(NULL);
BOOST_CHECK_THROW(checkAncestor->setParent2(dm.dataModel), std::exception);
checkAncestor->setParent(NULL);
instance->setParent2(dm.dataModel);
BOOST_CHECK_THROW(checkAncestor->setParent2(instance), std::exception);
instance->setParent(NULL);
checkAncestor->setParent(NULL);
}
BOOST_AUTO_TEST_CASE(ReparentingLock)
{
shared_ptr<RBX::Instance> thievingGrandparent = RBX::Creatable<RBX::Instance>::create<StealDescendants>();
shared_ptr<RBX::Instance> throwingGrandparent = RBX::Creatable<RBX::Instance>::create<ThrowOnDescendants>();
shared_ptr<RBX::Instance> parent = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
shared_ptr<RBX::Instance> child = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
BOOST_CHECK(!parent->getIsParentLocked());
parent->setAndLockParent(thievingGrandparent.get());
BOOST_CHECK(parent->getIsParentLocked());
// grandparent will attempt to steal child from parent, child's parent lock should still have its parent locked
child->setAndLockParent(parent.get());
BOOST_CHECK(child->getIsParentLocked());
BOOST_CHECK(child->getParent() == parent.get());
child->unlockParent();
child->setParent(NULL);
// grandparent will attempt to steal child from parent, child should not have it's parent locked
child->setParent(parent.get());
BOOST_CHECK(!child->getIsParentLocked());
BOOST_CHECK(child->getParent() == parent.get());
child->setParent(NULL);
parent->unlockParent();
parent->setParent(throwingGrandparent.get());
BOOST_CHECK_THROW(child->setAndLockParent(parent.get()), std::exception);
BOOST_CHECK(!child->getIsParentLocked());
child->setParent(NULL);
child->lockParent();
BOOST_CHECK_THROW(child->setAndLockParent(parent.get()), std::exception);
BOOST_CHECK(child->getIsParentLocked());
}
BOOST_AUTO_TEST_CASE(SetParentNull)
{
shared_ptr<RBX::Instance> parent = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
{
shared_ptr<RBX::Instance> child = RBX::Creatable<RBX::Instance>::create<InstanceTest>();
child->setParent(parent.get());
} // child goes out of scope, but the object is still alive since it's a child of parent now
RBX::Instance* child = parent->getChild(0);
child->setParent(NULL);
}
BOOST_AUTO_TEST_CASE(WaitForChildReturnsImmediatelyIfChildPresent)
{
using namespace RBX;
shared_ptr<Script> script = Creatable<RBX::Instance>::create<Script>();
script->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA').Name = 'Renamed'"));
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script->setParent(dm->getWorkspace());
part->setName("PartA");
part->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
BOOST_CHECK_EQUAL(part->getName(), "Renamed");
}
}
BOOST_AUTO_TEST_CASE(WaitForSameChildAfterInitialWaitForChild)
{
using namespace RBX;
shared_ptr<Script> script = Creatable<RBX::Instance>::create<Script>();
script->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA') "
"Workspace:WaitForChild('PartA').Name = 'Renamed'"));
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script->setParent(dm->getWorkspace());
part->setName("PartA");
part->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
BOOST_CHECK_EQUAL(part->getName(), "Renamed");
}
}
BOOST_AUTO_TEST_CASE(TwoScriptsWaitingForSameChild)
{
using namespace RBX;
shared_ptr<Script> script1 = Creatable<RBX::Instance>::create<Script>();
script1->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA') "
"Instance.new('Part', Workspace).Name = 'Alice'"));
shared_ptr<Script> script2 = Creatable<RBX::Instance>::create<Script>();
script2->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA') "
"Instance.new('Part', Workspace).Name = 'Bob'"));
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script1->setParent(dm->getWorkspace());
script2->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
}
G3D::System::sleep(.5f);
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
part->setName("PartA");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Alice") != NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Bob") != NULL);
}
}
BOOST_AUTO_TEST_CASE(TwoScriptsWaitingForSameChildRenameOnResume)
{
using namespace RBX;
shared_ptr<Script> script1 = Creatable<RBX::Instance>::create<Script>();
script1->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA').Name = 'PartB' "));
shared_ptr<Script> script2 = Creatable<RBX::Instance>::create<Script>();
script2->setEmbeddedCode(ProtectedString::fromTestSource(
"wait() "
"p = Workspace:WaitForChild('PartA') "
"p.Name = p.Name .. 'x' "));
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script1->setParent(dm->getWorkspace());
script2->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
}
G3D::System::sleep(.5f);
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
part->setName("PartA");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL("PartBx", part->getName());
}
// check for double-resume scenario
shared_ptr<RBX::Instance> part2 = Creatable<RBX::Instance>::create<BasicPartInstance>();
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
part2->setName("PartA");
part2->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL("PartA", part2->getName());
}
}
BOOST_AUTO_TEST_CASE(TwoScriptsWaitingForDifferentChildren)
{
using namespace RBX;
shared_ptr<Script> script1 = Creatable<RBX::Instance>::create<Script>();
script1->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('Alice').Name = 'AliceX' "));
shared_ptr<Script> script2 = Creatable<RBX::Instance>::create<Script>();
script2->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('Bob').Name = 'BobX' "));
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script1->setParent(dm->getWorkspace());
script2->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
part->setName("Alice");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Alice") == NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("AliceX") != NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Bob") == NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("BobX") == NULL);
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
part->setName("Bob");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Alice") == NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("AliceX") != NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("Bob") == NULL);
BOOST_CHECK(dm->getWorkspace()->findFirstChildByName("BobX") != NULL);
}
}
BOOST_AUTO_TEST_CASE(WaitForDifferentChildAfterInitialWaitForChild)
{
using namespace RBX;
shared_ptr<Script> script = Creatable<RBX::Instance>::create<Script>();
script->setEmbeddedCode(ProtectedString::fromTestSource(
"Workspace:WaitForChild('PartA').Name = 'Phase1' "
"Workspace:WaitForChild('PartB').Name = 'Phase2'"));
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
}
G3D::System::sleep(.5f);
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
part->setName("PartA");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL(part->getName(), "Phase1");
part->setName("PartB");
part->setParent(NULL);
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL(part->getName(), "Phase2");
}
}
BOOST_AUTO_TEST_CASE(WaitForChildOutsideOfDataModel)
{
using namespace RBX;
shared_ptr<Script> script = Creatable<RBX::Instance>::create<Script>();
script->setEmbeddedCode(ProtectedString::fromTestSource(
"p = Workspace:WaitForChild('PartA') "
"p.Parent = nil "
"p.Name = 'Phase1' "
"p:WaitForChild('PartB') "
"p.Name = 'Phase2'"));
shared_ptr<RBX::Instance> part = Creatable<RBX::Instance>::create<BasicPartInstance>();
DataModelFixture dm;
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
script->setParent(dm->getWorkspace());
ServiceProvider::create<RunService>(&dm)->run();
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
part->setName("PartA");
part->setParent(dm->getWorkspace());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL(part->getName(), "Phase1");
BOOST_REQUIRE(part->getParent() == NULL);
shared_ptr<RBX::Instance> subPart = Creatable<RBX::Instance>::create<BasicPartInstance>();
subPart->setName("PartB");
subPart->setParent(part.get());
}
G3D::System::sleep(.5f);
{
DataModel::LegacyLock l(&dm, DataModelJob::Write);
BOOST_CHECK_EQUAL(part->getName(), "Phase2");
}
}
BOOST_AUTO_TEST_SUITE_END()