Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unit tests for PackedScene #79440

Merged
merged 1 commit into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions tests/scene/test_packed_scene.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/**************************************************************************/
/* test_packed_scene.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_PACKED_SCENE_H
#define TEST_PACKED_SCENE_H

#include "scene/resources/packed_scene.h"

#include "tests/test_macros.h"

namespace TestPackedScene {

TEST_CASE("[PackedScene] Pack Scene and Retrieve State") {
// Create a scene to pack.
Node *scene = memnew(Node);
scene->set_name("TestScene");

// Pack the scene.
PackedScene packed_scene;
const Error err = packed_scene.pack(scene);
CHECK(err == OK);

// Retrieve the packed state.
Ref<SceneState> state = packed_scene.get_state();
CHECK(state.is_valid());
CHECK(state->get_node_count() == 1);
CHECK(state->get_node_name(0) == "TestScene");

memdelete(scene);
}

TEST_CASE("[PackedScene] Clear Packed Scene") {
// Create a scene to pack.
Node *scene = memnew(Node);
scene->set_name("TestScene");

// Pack the scene.
PackedScene packed_scene;
packed_scene.pack(scene);

// Clear the packed scene.
packed_scene.clear();

// Check if it has been cleared.
Ref<SceneState> state = packed_scene.get_state();
CHECK_FALSE(state->get_node_count() == 1);

memdelete(scene);
}

TEST_CASE("[PackedScene] Can Instantiate Packed Scene") {
// Create a scene to pack.
Node *scene = memnew(Node);
scene->set_name("TestScene");

// Pack the scene.
PackedScene packed_scene;
packed_scene.pack(scene);

// Check if the packed scene can be instantiated.
const bool can_instantiate = packed_scene.can_instantiate();
CHECK(can_instantiate == true);

memdelete(scene);
}

TEST_CASE("[PackedScene] Instantiate Packed Scene") {
// Create a scene to pack.
Node *scene = memnew(Node);
scene->set_name("TestScene");

// Pack the scene.
PackedScene packed_scene;
packed_scene.pack(scene);

// Instantiate the packed scene.
Node *instance = packed_scene.instantiate();
CHECK(instance != nullptr);
CHECK(instance->get_name() == "TestScene");

memdelete(scene);
memdelete(instance);
}

} // namespace TestPackedScene

#endif // TEST_PACKED_SCENE_H
1 change: 1 addition & 0 deletions tests/test_main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
#include "tests/scene/test_navigation_region_2d.h"
#include "tests/scene/test_navigation_region_3d.h"
#include "tests/scene/test_node.h"
#include "tests/scene/test_packed_scene.h"
#include "tests/scene/test_path_2d.h"
#include "tests/scene/test_path_3d.h"
#include "tests/scene/test_primitives.h"
Expand Down