#include #include #include #include "AMFDeserialize.h" #include "AMFFormat.h" /** * Helper method that all tests use to get their respective AMF. */ std::unique_ptr ReadFromBitStream(RakNet::BitStream* bitStream) { AMFDeserialize deserializer; std::unique_ptr returnValue(deserializer.Read(bitStream)); return returnValue; } /** * @brief Test reading an AMFUndefined value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFUndefinedTest) { CBITSTREAM bitStream.Write(0x00); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFUndefined); } /** * @brief Test reading an AMFNull value from a BitStream. * */ TEST(dCommonTests, AMFDeserializeAMFNullTest) { CBITSTREAM bitStream.Write(0x01); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFNull); } /** * @brief Test reading an AMFFalse value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFFalseTest) { CBITSTREAM bitStream.Write(0x02); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFFalse); } /** * @brief Test reading an AMFTrue value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFTrueTest) { CBITSTREAM bitStream.Write(0x03); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFTrue); } /** * @brief Test reading an AMFInteger value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFIntegerTest) { CBITSTREAM { bitStream.Write(0x04); // 127 == 01111111 bitStream.Write(127); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFInteger); // Check that the max value of a byte can be read correctly ASSERT_EQ(static_cast(res.get())->GetIntegerValue(), 127); } bitStream.Reset(); { bitStream.Write(0x04); bitStream.Write(UINT32_MAX); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFInteger); // Check that we can read the maximum value correctly ASSERT_EQ(static_cast(res.get())->GetIntegerValue(), 536870911); } bitStream.Reset(); { bitStream.Write(0x04); // 131 == 10000011 bitStream.Write(131); // 255 == 11111111 bitStream.Write(255); // 127 == 01111111 bitStream.Write(127); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFInteger); // Check that short max can be read correctly ASSERT_EQ(static_cast(res.get())->GetIntegerValue(), UINT16_MAX); } bitStream.Reset(); { bitStream.Write(0x04); // 255 == 11111111 bitStream.Write(255); // 127 == 01111111 bitStream.Write(127); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFInteger); // Check that 2 byte max can be read correctly ASSERT_EQ(static_cast(res.get())->GetIntegerValue(), 16383); } } /** * @brief Test reading an AMFDouble value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFDoubleTest) { CBITSTREAM bitStream.Write(0x05); bitStream.Write(25346.4f); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFDouble); ASSERT_EQ(static_cast(res.get())->GetDoubleValue(), 25346.4f); } /** * @brief Test reading an AMFString value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFStringTest) { CBITSTREAM bitStream.Write(0x06); bitStream.Write(0x0F); std::string toWrite = "stateID"; for (auto e : toWrite) bitStream.Write(e); std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFString); ASSERT_EQ(static_cast(res.get())->GetStringValue(), "stateID"); } /** * @brief Test reading an AMFArray value from a BitStream. */ TEST(dCommonTests, AMFDeserializeAMFArrayTest) { CBITSTREAM // Test empty AMFArray bitStream.Write(0x09); bitStream.Write(0x01); bitStream.Write(0x01); { std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFArray); ASSERT_EQ(static_cast(res.get())->GetAssociativeMap().size(), 0); ASSERT_EQ(static_cast(res.get())->GetDenseArray().size(), 0); } bitStream.Reset(); // Test a key'd value and dense value bitStream.Write(0x09); bitStream.Write(0x03); bitStream.Write(0x15); for (auto e : "BehaviorID") if (e != '\0') bitStream.Write(e); bitStream.Write(0x06); bitStream.Write(0x0B); for (auto e : "10447") if (e != '\0') bitStream.Write(e); bitStream.Write(0x01); bitStream.Write(0x06); bitStream.Write(0x0B); for (auto e : "10447") if (e != '\0') bitStream.Write(e); { std::unique_ptr res(ReadFromBitStream(&bitStream)); ASSERT_EQ(res->GetValueType(), AMFValueType::AMFArray); ASSERT_EQ(static_cast(res.get())->GetAssociativeMap().size(), 1); ASSERT_EQ(static_cast(res.get())->GetDenseArray().size(), 1); ASSERT_EQ(static_cast(res.get())->FindValue("BehaviorID")->GetStringValue(), "10447"); ASSERT_EQ(static_cast(res.get())->GetValueAt(0)->GetStringValue(), "10447"); } } /** * @brief This test checks that if we recieve an unimplemented AMFValueType * we correctly throw an error and can actch it. * */ #pragma message("-- The AMFDeserializeUnimplementedValuesTest causes a known memory leak of 880 bytes since it throws errors! --") TEST(dCommonTests, AMFDeserializeUnimplementedValuesTest) { std::vector unimplementedValues = { AMFValueType::AMFXMLDoc, AMFValueType::AMFDate, AMFValueType::AMFObject, AMFValueType::AMFXML, AMFValueType::AMFByteArray, AMFValueType::AMFVectorInt, AMFValueType::AMFVectorUInt, AMFValueType::AMFVectorDouble, AMFValueType::AMFVectorObject, AMFValueType::AMFDictionary }; // Run unimplemented tests to check that errors are thrown if // unimplemented AMF values are attempted to be parsed. std::ifstream fileStream; fileStream.open("AMFBitStreamUnimplementedTest.bin", std::ios::binary); // Read a test BitStream from a file std::vector baseBitStream; char byte = 0; while (fileStream.get(byte)) { baseBitStream.push_back(byte); } fileStream.close(); for (auto amfValueType : unimplementedValues) { RakNet::BitStream testBitStream; for (auto element : baseBitStream) { testBitStream.Write(element); } testBitStream.Write(amfValueType); bool caughtException = false; try { ReadFromBitStream(&testBitStream); } catch (AMFValueType unimplementedValueType) { caughtException = true; } ASSERT_EQ(caughtException, true); } } /** * @brief Test reading a packet capture from live from a BitStream */ TEST(dCommonTests, AMFDeserializeLivePacketTest) { std::ifstream testFileStream; testFileStream.open("AMFBitStreamTest.bin", std::ios::binary); // Read a test BitStream from a file RakNet::BitStream testBitStream; char byte = 0; while (testFileStream.get(byte)) { testBitStream.Write(byte); } testFileStream.close(); auto resultFromFn = ReadFromBitStream(&testBitStream); auto result = static_cast(resultFromFn.get()); // Test the outermost array ASSERT_EQ(result->FindValue("BehaviorID")->GetStringValue(), "10447"); ASSERT_EQ(result->FindValue("objectID")->GetStringValue(), "288300744895913279"); // Test the execution state array auto executionState = result->FindValue("executionState"); ASSERT_NE(executionState, nullptr); auto strips = executionState->FindValue("strips")->GetDenseArray(); ASSERT_EQ(strips.size(), 1); auto stripsPosition0 = dynamic_cast(strips[0]); auto actionIndex = stripsPosition0->FindValue("actionIndex"); ASSERT_EQ(actionIndex->GetDoubleValue(), 0.0f); auto stripIDExecution = stripsPosition0->FindValue("id"); ASSERT_EQ(stripIDExecution->GetDoubleValue(), 0.0f); auto stateIDExecution = executionState->FindValue("stateID"); ASSERT_EQ(stateIDExecution->GetDoubleValue(), 0.0f); auto states = result->FindValue("states")->GetDenseArray(); ASSERT_EQ(states.size(), 1); auto firstState = dynamic_cast(states[0]); auto stateID = firstState->FindValue("id"); ASSERT_EQ(stateID->GetDoubleValue(), 0.0f); auto stripsInState = firstState->FindValue("strips")->GetDenseArray(); ASSERT_EQ(stripsInState.size(), 1); auto firstStrip = dynamic_cast(stripsInState[0]); auto actionsInFirstStrip = firstStrip->FindValue("actions")->GetDenseArray(); ASSERT_EQ(actionsInFirstStrip.size(), 3); auto actionID = firstStrip->FindValue("id"); ASSERT_EQ(actionID->GetDoubleValue(), 0.0f); auto uiArray = firstStrip->FindValue("ui"); auto xPos = uiArray->FindValue("x"); auto yPos = uiArray->FindValue("y"); ASSERT_EQ(xPos->GetDoubleValue(), 103.0f); ASSERT_EQ(yPos->GetDoubleValue(), 82.0f); auto stripID = firstStrip->FindValue("id"); ASSERT_EQ(stripID->GetDoubleValue(), 0.0f); auto firstAction = dynamic_cast(actionsInFirstStrip[0]); auto firstType = firstAction->FindValue("Type"); ASSERT_EQ(firstType->GetStringValue(), "OnInteract"); auto firstCallback = firstAction->FindValue("__callbackID__"); ASSERT_EQ(firstCallback->GetStringValue(), ""); auto secondAction = dynamic_cast(actionsInFirstStrip[1]); auto secondType = secondAction->FindValue("Type"); ASSERT_EQ(secondType->GetStringValue(), "FlyUp"); auto secondCallback = secondAction->FindValue("__callbackID__"); ASSERT_EQ(secondCallback->GetStringValue(), ""); auto secondDistance = secondAction->FindValue("Distance"); ASSERT_EQ(secondDistance->GetDoubleValue(), 25.0f); auto thirdAction = dynamic_cast(actionsInFirstStrip[2]); auto thirdType = thirdAction->FindValue("Type"); ASSERT_EQ(thirdType->GetStringValue(), "FlyDown"); auto thirdCallback = thirdAction->FindValue("__callbackID__"); ASSERT_EQ(thirdCallback->GetStringValue(), ""); auto thirdDistance = thirdAction->FindValue("Distance"); ASSERT_EQ(thirdDistance->GetDoubleValue(), 25.0f); } /** * @brief Tests that having no BitStream returns a nullptr. */ TEST(dCommonTests, AMFDeserializeNullTest) { auto result = ReadFromBitStream(nullptr); ASSERT_EQ(result.get(), nullptr); } TEST(dCommonTests, AMFBadConversionTest) { std::ifstream testFileStream; testFileStream.open("AMFBitStreamTest.bin", std::ios::binary); // Read a test BitStream from a file RakNet::BitStream testBitStream; char byte = 0; while (testFileStream.get(byte)) { testBitStream.Write(byte); } testFileStream.close(); auto resultFromFn = ReadFromBitStream(&testBitStream); auto result = static_cast(resultFromFn.get()); // Actually a string value. ASSERT_EQ(result->FindValue("BehaviorID"), nullptr); // Does not exist in the associative portion ASSERT_EQ(result->FindValue("DOES_NOT_EXIST"), nullptr); result->PushBackValue(new AMFTrueValue()); // Exists and is correct type ASSERT_NE(result->GetValueAt(0), nullptr); // Value exists but is wrong typing ASSERT_EQ(result->GetValueAt(0), nullptr); // Value is out of bounds ASSERT_EQ(result->GetValueAt(1), nullptr); } /** * Below is the AMF that is in the AMFBitStreamTest.bin file that we are reading in * from a bitstream to test. args: amf3! { "objectID": "288300744895913279", "BehaviorID": "10447", "executionState": amf3! { "strips": amf3! [ amf3! { "actionIndex": 0.0, "id": 0.0, }, ], "stateID": 0.0, }, "states": amf3! [ amf3! { "id": 0.0, "strips": amf3! [ amf3! { "actions": amf3! [ amf3! { "Type": "OnInteract", "__callbackID__": "", }, amf3! { "Distance": 25.0, "Type": "FlyUp", "__callbackID__": "", }, amf3! { "Distance": 25.0, "Type": "FlyDown", "__callbackID__": "", }, ], "id": 0.0, "ui": amf3! { "x": 103.0, "y": 82.0, }, }, ], }, ], } */