Skip to content

Create unit test for function bitmap_name #125

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.

Sign up for GitHub

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

Open
sam-stajnko wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Create unit test for function bitmap_name #125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9eeda3c
Create unit test for function bitmap_name
sam-stajnko Aug 28, 2025
fd887b5
Replace load_bitmap with create_bitmap
sam-stajnko Sep 2, 2025
7be239d
Free bitmaps after each test. Minor refinements.
sam-stajnko Sep 12, 2025
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
70 changes: 70 additions & 0 deletions coresdk/src/test/unit_tests/unit_test_bitmap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,73 @@ TEST_CASE("bitmap bounding details can be retrieved", "[bitmap]")
}
free_bitmap(bmp);
}

TEST_CASE("name can be retrieved from bitmap", "[bitmap][bitmap_name]")
{
SECTION("can get bitmap name")
{
bitmap bmp = create_bitmap("rock", 28, 28);
string name = bitmap_name(bmp);
REQUIRE(name == "rock");

free_bitmap(bmp);
}

SECTION("empty string returned for bitmap name when passing nullptr")
{
string name = bitmap_name(nullptr);
REQUIRE(name == "");
}

SECTION("empty string returned for bitmap when passing freed bitmap")
{
bitmap bmp = create_bitmap("treasure", 32, 24);
free_bitmap(bmp);
string name = bitmap_name(bmp);

REQUIRE_FALSE(bitmap_valid(bmp));
REQUIRE_FALSE(name == "treasure");
REQUIRE(name == "");
}

SECTION("can get unique names from bitmaps when names are reused")
{
bitmap bmp_1 = create_bitmap("blank", 100, 200);
bitmap bmp_2 = create_bitmap("blank", 300, 400);
bitmap bmp_3 = create_bitmap("blank", 500, 600);
bitmap bmp_4 = create_bitmap("blank", 700, 800);

string name_1 = bitmap_name(bmp_1);
string name_2 = bitmap_name(bmp_2);
string name_3 = bitmap_name(bmp_3);
string name_4 = bitmap_name(bmp_4);

REQUIRE(name_1 == "blank");
REQUIRE(name_2 == "blank0");
REQUIRE(name_3 == "blank1");
REQUIRE(name_4 == "blank2");

free_all_bitmaps();
}

SECTION("can get name of bitmap when name is empty string")
{
bitmap bmp = create_bitmap("", 64, 64);
string name = bitmap_name(bmp);

REQUIRE(name == "");

free_bitmap(bmp);
}

SECTION("can get name of bitmap when name includes special characters")
{
string silly_name = "AbCdEf 2+3=5 !@#$% \n";
bitmap bmp = create_bitmap(silly_name, 128, 128);

string returned_name = bitmap_name(bmp);
REQUIRE(returned_name == silly_name);
Copy link

@dijidiji dijidiji Aug 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also use Catch2's string matchers for assertions with std::strings.

For example, to use Equals:

using Catch::Matchers::Equals;
Suggested change
REQUIRE(returned_name == silly_name);
REQUIRE_THAT(returned_name, Equals(silly_name));

I'm not sure if there's a reason to prefer using one over the other, just thought it was worth noting. So don't consider this a required change - I'm half reminding myself here for things to note down in the guide!


free_bitmap(bmp);
}
}
Loading