Skip to content

Add unit test for function bitmap_filename #137

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
rory-cd wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add unit test for function bitmap_filename #137

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e55d993
Add bitmap_filename unit test
rory-cd Nov 17, 2025
dc769e3
Merge remote-tracking branch 'upstream/main' into test/bitmap_filename
rory-cd Nov 27, 2025
d1b150a
Fix potential integer underflow as per review
rory-cd Nov 30, 2025
53e084a
Merge remote-tracking branch 'upstream/main' into test/bitmap_filename
rory-cd Nov 30, 2025
4f9104f
Merge branch 'main' into test/bitmap_filename
rory-cd Jan 18, 2026
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
38 changes: 38 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 @@ -4,6 +4,8 @@

#include "catch.hpp"

#include <string>

#include "types.h"
#include "graphics.h"
#include "resources.h"
Expand Down Expand Up @@ -128,3 +130,39 @@ TEST_CASE("bitmap bounding details can be retrieved", "[bitmap]")
}
free_bitmap(bmp);
}

TEST_CASE("bitmap filename can be retrieved", "[bitmap_filename]")
{
SECTION("returns correct filename for bitmap")
{
std::string expected_filename = "rocket_sprt.png";

// Load a bitmap
bitmap bmp = load_bitmap("rocket", expected_filename);
REQUIRE(bmp != nullptr);
REQUIRE(bitmap_valid(bmp));

// Extract filename
std::string filepath = bitmap_filename(bmp);
size_t idx = filepath.size() - expected_filename.size();
std::string filename = filepath.substr(idx, expected_filename.size());
Copy link

@ralphweng2023 ralphweng2023 Nov 30, 2025

Choose a reason for hiding this comment

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

Unsafe substring extraction

This code has a potential unsigned integer underflow if filepath is shorter than expected_filename:

size_t idx = filepath.size() - expected_filename.size();  // Can underflow!
std::string filename = filepath.substr(idx, expected_filename.size());

I would suggest do it this way:

std::string filepath = bitmap_filename(bmp);
REQUIRE(filepath.size() >= expected_filename.size());
std::string filename = filepath.substr(filepath.size() - expected_filename.size());
REQUIRE(filename == expected_filename);


REQUIRE(filename == expected_filename);
free_bitmap(bmp);
}

SECTION("returns empty string for null bitmap")
{
bitmap null_bmp = nullptr;
std::string filepath = bitmap_filename(null_bmp);
REQUIRE(filepath == "");
}

SECTION("returns empty string for newly created bitmap")
{
bitmap created_bmp = create_bitmap("new bitmap", 100, 100);
std::string filepath = bitmap_filename(created_bmp);
REQUIRE(filepath == "");
free_bitmap(created_bmp);
}
}