Add unit tests for type_convert Variant utility function

tests/core/variant/test_variant_utility.h

@@ -0,0 +1,141 @@
+/**************************************************************************/
+/*  test_variant_utility.h                                                */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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.                 */
+/**************************************************************************/
+
+#ifndef TEST_VARIANT_UTILITY_H
+#define TEST_VARIANT_UTILITY_H
+
+#include "core/variant/variant_utility.h"
+
+#include "tests/test_macros.h"
+
+namespace TestVariantUtility {
+
+TEST_CASE("[VariantUtility] Type conversion") {
+	Variant converted;
+	converted = VariantUtilityFunctions::type_convert("Hi!", Variant::Type::NIL);
+	CHECK(converted.get_type() == Variant::Type::NIL);
+	CHECK(converted == Variant());
+
+	converted = VariantUtilityFunctions::type_convert("Hi!", Variant::Type::INT);
+	CHECK(converted.get_type() == Variant::Type::INT);
+	CHECK(converted == Variant(0));
+
+	converted = VariantUtilityFunctions::type_convert("123", Variant::Type::INT);
+	CHECK(converted.get_type() == Variant::Type::INT);
+	CHECK(converted == Variant(123));
+
+	converted = VariantUtilityFunctions::type_convert(123, Variant::Type::STRING);
+	CHECK(converted.get_type() == Variant::Type::STRING);
+	CHECK(converted == Variant("123"));
+
+	converted = VariantUtilityFunctions::type_convert(123.4, Variant::Type::INT);
+	CHECK(converted.get_type() == Variant::Type::INT);
+	CHECK(converted == Variant(123));
+
+	converted = VariantUtilityFunctions::type_convert(5, Variant::Type::VECTOR2);
+	CHECK(converted.get_type() == Variant::Type::VECTOR2);
+	CHECK(converted == Variant(Vector2(0, 0)));
+
+	converted = VariantUtilityFunctions::type_convert(Vector3(1, 2, 3), Variant::Type::VECTOR2);
+	CHECK(converted.get_type() == Variant::Type::VECTOR2);
+	CHECK(converted == Variant(Vector2(1, 2)));
+
+	converted = VariantUtilityFunctions::type_convert(Vector2(1, 2), Variant::Type::VECTOR4);
+	CHECK(converted.get_type() == Variant::Type::VECTOR4);
+	CHECK(converted == Variant(Vector4(1, 2, 0, 0)));
+
+	converted = VariantUtilityFunctions::type_convert(Vector4(1.2, 3.4, 5.6, 7.8), Variant::Type::VECTOR3I);
+	CHECK(converted.get_type() == Variant::Type::VECTOR3I);
+	CHECK(converted == Variant(Vector3i(1, 3, 5)));
+
+	{
+		Basis basis = Basis::from_scale(Vector3(1.2, 3.4, 5.6));
+		Transform3D transform = Transform3D(basis, Vector3());
+
+		converted = VariantUtilityFunctions::type_convert(transform, Variant::Type::BASIS);
+		CHECK(converted.get_type() == Variant::Type::BASIS);
+		CHECK(converted == basis);
+
+		converted = VariantUtilityFunctions::type_convert(basis, Variant::Type::TRANSFORM3D);
+		CHECK(converted.get_type() == Variant::Type::TRANSFORM3D);
+		CHECK(converted == transform);
+
+		converted = VariantUtilityFunctions::type_convert(basis, Variant::Type::STRING);
+		CHECK(converted.get_type() == Variant::Type::STRING);
+		CHECK(converted == Variant("[X: (1.2, 0, 0), Y: (0, 3.4, 0), Z: (0, 0, 5.6)]"));
+	}
+
+	{
+		Array arr;
+		arr.push_back(1.2);
+		arr.push_back(3.4);
+		arr.push_back(5.6);
+
+		PackedFloat64Array packed;
+		packed.push_back(1.2);
+		packed.push_back(3.4);
+		packed.push_back(5.6);
+
+		converted = VariantUtilityFunctions::type_convert(arr, Variant::Type::PACKED_FLOAT64_ARRAY);
+		CHECK(converted.get_type() == Variant::Type::PACKED_FLOAT64_ARRAY);
+		CHECK(converted == packed);
+
+		converted = VariantUtilityFunctions::type_convert(packed, Variant::Type::ARRAY);
+		CHECK(converted.get_type() == Variant::Type::ARRAY);
+		CHECK(converted == arr);
+	}
+
+	{
+		// Check that using Variant::call_utility_function also works.
+		Vector<const Variant *> args;
+		Variant data_arg = "Hi!";
+		args.push_back(&data_arg);
+		Variant type_arg = Variant::Type::NIL;
+		args.push_back(&type_arg);
+		Callable::CallError call_error;
+		Variant::call_utility_function("type_convert", &converted, (const Variant **)args.ptr(), 2, call_error);
+		CHECK(converted.get_type() == Variant::Type::NIL);
+		CHECK(converted == Variant());
+
+		type_arg = Variant::Type::INT;
+		Variant::call_utility_function("type_convert", &converted, (const Variant **)args.ptr(), 2, call_error);
+		CHECK(converted.get_type() == Variant::Type::INT);
+		CHECK(converted == Variant(0));
+
+		data_arg = "123";
+		Variant::call_utility_function("type_convert", &converted, (const Variant **)args.ptr(), 2, call_error);
+		CHECK(converted.get_type() == Variant::Type::INT);
+		CHECK(converted == Variant(123));
+	}
+}
+
+} // namespace TestVariantUtility
+
+#endif // TEST_VARIANT_UTILITY_H

tests/test_main.cpp

@@ -89,6 +89,7 @@
 #include "tests/core/variant/test_array.h"
 #include "tests/core/variant/test_dictionary.h"
 #include "tests/core/variant/test_variant.h"
+#include "tests/core/variant/test_variant_utility.h"
 #include "tests/scene/test_animation.h"
 #include "tests/scene/test_arraymesh.h"
 #include "tests/scene/test_audio_stream_wav.h"