Torque3D/Engine/source/console/test/runtimeClassRepTest.cpp

//-----------------------------------------------------------------------------
// Copyright (c) 2014 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#ifdef TORQUE_TESTS_ENABLED
#include "testing/unitTesting.h"
#include "platform/platform.h"
#include "console/simBase.h"
#include "console/consoleTypes.h"
#include "console/runtimeClassRep.h"

class RuntimeRegisteredSimObject : public SimObject
{
   typedef SimObject Parent;

protected:
   bool mFoo;

public:
   RuntimeRegisteredSimObject() : mFoo(false) {};

   DECLARE_RUNTIME_CONOBJECT(RuntimeRegisteredSimObject);

   static void initPersistFields();
};

IMPLEMENT_RUNTIME_CONOBJECT(RuntimeRegisteredSimObject);

void RuntimeRegisteredSimObject::initPersistFields()
{
   addField("fooField", TypeBool, Offset(mFoo, RuntimeRegisteredSimObject));
}

TEST(Console, RuntimeClassRep)
{
   // First test to make sure that the test class is not registered (don't
   // know how it could be, but that's programming for you). Stop the test if
   // it is.
   ASSERT_TRUE(!RuntimeRegisteredSimObject::dynRTClassRep.isRegistered())
      << "RuntimeRegisteredSimObject class was already registered with the console";

   // This should not be able to find the class, and return null (this may
   // AssertWarn as well).
   ConsoleObject *conobj = ConsoleObject::create("RuntimeRegisteredSimObject");
   EXPECT_TRUE(conobj == NULL)
      << "Unregistered AbstractClassRep returned non-NULL value! That is really bad!";

   // Register with console system.
   RuntimeRegisteredSimObject::dynRTClassRep.consoleRegister();

   // Make sure that the object knows it's registered.
   EXPECT_TRUE(RuntimeRegisteredSimObject::dynRTClassRep.isRegistered())
      << "RuntimeRegisteredSimObject class failed console registration";

   // Now try again to create the instance.
   conobj = ConsoleObject::create("RuntimeRegisteredSimObject");
   EXPECT_TRUE(conobj != NULL)
      << "AbstractClassRep::create method failed!";

   // Cast the instance, and test it.
   RuntimeRegisteredSimObject *rtinst =
      dynamic_cast<RuntimeRegisteredSimObject *>(conobj);
   EXPECT_TRUE(rtinst != NULL)
      << "Casting failed for some reason";

   // Register it with a name.
   rtinst->registerObject("_utRRTestObject");
   EXPECT_TRUE(rtinst->isProperlyAdded())
      << "registerObject failed on test object";

   // Now execute some script on it.
   Con::evaluate("_utRRTestObject.fooField = true;");

   // Test to make sure field worked.
   EXPECT_TRUE(dAtob(rtinst->getDataField(StringTable->insert("fooField"), NULL)))
      << "Set property failed on instance.";

   // BALETED
   rtinst->deleteObject();

   // Unregister the type.
   RuntimeRegisteredSimObject::dynRTClassRep.consoleUnRegister();

   // And make sure we can't create another one.
   conobj = ConsoleObject::create("RuntimeRegisteredSimObject");
   EXPECT_TRUE(conobj == NULL)
      << "Unregistration of type failed";
}

#endif