krgamestudios/Toy
1
0
Fork 0
mirror of https://github.com/krgamestudios/Toy.git synced 2026-05-06 00:40:11 +10:00
Code Issues Packages Projects Releases Wiki Activity

FIX: Substrings had corner-cases with incorrect results, read more

Browse Source 
I found this while writing unit tests for Toy_Function, where one
(native) function was named 'identity' and another (custom) was named
'ident' to avoid a naming clash. The rename didn't resolve the clash, so
after some digging, I found that strings compared to substrings would
return a match, despite being different.

This took some awkward corner-case handling, as it turns out
'deepCompareUtil' only returns zero when no differences have been found,
not when a match has been found. I also added checks for this to
Toy_String's unit test, with the parameters checked in both orders i.e.
(a,b) and (b,a), because paranoia is your friend.

The rope pattern is powerful, but also gives you enough rope to hang
yourself.
This commit is contained in:
Kayne Ruse
2026-04-26 22:52:24 +10:00
parent af30246e0c
commit b718b35097
6 changed files with 306 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/units/test_string.c
+142
View File
@@ -619,6 +619,148 @@ int test_string_equality(void) {
Toy_freeBucket(&bucket);
}
//substring non-equality (no concats)
{
//setup
Toy_Bucket* bucket = Toy_allocateBucket(1024);
Toy_String* left = Toy_createStringLength(&bucket, "identity", 8);
Toy_String* right = Toy_createStringLength(&bucket, "ident", 5);
int result = 0; //for print the errors
//check mismatch
if ((result = Toy_compareStrings(left, right)) == 0)
{
char* leftBuffer = Toy_getStringRaw(left);
char* rightBuffer = Toy_getStringRaw(right);
fprintf(stderr, TOY_CC_ERROR "ERROR: String equality '%s' != '%s' is incorrect, found %s\n" TOY_CC_RESET, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
//cleanup
Toy_freeBucket(&bucket);
}
//substring non-equality (with matching and non-matching concats)
{
//setup
Toy_Bucket* bucket = Toy_allocateBucket(1024);
Toy_String* identity = Toy_createStringLength(&bucket, "identity", 8);
Toy_String* ident = Toy_createStringLength(&bucket, "ident", 5);
Toy_String* matchingIdentity = Toy_concatStrings(&bucket,
Toy_createStringLength(&bucket, "ident", 5),
Toy_createStringLength(&bucket, "ity", 3)
);
Toy_String* stolenIdentity = Toy_concatStrings(&bucket,
Toy_createStringLength(&bucket, "id", 2),
Toy_createStringLength(&bucket, "entity", 6)
);
int result = 0; //for print the errors
//ensure the concats match the base
if ((result = Toy_compareStrings(identity, matchingIdentity)) != 0)
{
char* leftBuffer = Toy_getStringRaw(identity);
char* rightBuffer = Toy_getStringRaw(matchingIdentity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed early on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
if ((result = Toy_compareStrings(identity, stolenIdentity)) != 0)
{
char* leftBuffer = Toy_getStringRaw(identity);
char* rightBuffer = Toy_getStringRaw(stolenIdentity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed early on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
//ensure both concats are a mismatch for 'ident'
if ((result = Toy_compareStrings(ident, matchingIdentity)) == 0)
{
char* leftBuffer = Toy_getStringRaw(ident);
char* rightBuffer = Toy_getStringRaw(matchingIdentity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
if ((result = Toy_compareStrings(ident, stolenIdentity)) == 0)
{
char* leftBuffer = Toy_getStringRaw(ident);
char* rightBuffer = Toy_getStringRaw(stolenIdentity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
//repeat these tests with the parameters swapped, just to be safe
if ((result = Toy_compareStrings(matchingIdentity, identity)) != 0)
{
char* leftBuffer = Toy_getStringRaw(matchingIdentity);
char* rightBuffer = Toy_getStringRaw(identity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed early on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
if ((result = Toy_compareStrings(stolenIdentity, identity)) != 0)
{
char* leftBuffer = Toy_getStringRaw(stolenIdentity);
char* rightBuffer = Toy_getStringRaw(identity);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed early on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
if ((result = Toy_compareStrings(matchingIdentity, ident)) == 0)
{
char* leftBuffer = Toy_getStringRaw(matchingIdentity);
char* rightBuffer = Toy_getStringRaw(ident);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
if ((result = Toy_compareStrings(stolenIdentity, ident)) == 0)
{
char* leftBuffer = Toy_getStringRaw(stolenIdentity);
char* rightBuffer = Toy_getStringRaw(ident);
fprintf(stderr, TOY_CC_ERROR "ERROR: Substring concat non-equality failed on line %d with '%s' and '%s' is incorrect, found %s\n" TOY_CC_RESET, __LINE__, leftBuffer, rightBuffer, result < 0 ? "<" : result == 0 ? "==" : ">");
free(leftBuffer);
free(rightBuffer);
Toy_freeBucket(&bucket);
return -1;
}
//cleanup
Toy_freeBucket(&bucket);
}
return 0;
}