From 39507da6ae03a18724ebe875d72350b5dc3aa230 Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Thu, 12 Nov 2026 00:14:28 -0700 Subject: [PATCH] Pin size-zero environments and moves onto the current location Characterization tests for two untested boundaries: an environment of size 0 has no locations, its id/coordinate/entity lookups throw, and addEntityToLocation places nothing; moving an entity to the location it is already in leaves exactly one pointer there with its ids intact. README's Errors section now says which lookups stay safe on an empty grid. Co-Authored-By: Claude Opus 5.5 --- README.md | 2 +- src/tests.cpp | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 206b2e1..761b80a 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ Lookups that find nothing throw `std::runtime_error`: `addEntityToLocation` does not throw when no grid location has the given location's id. The entity is then placed nowhere, and its grid id, environment id, and location id are left unchanged. `Grid::addEntityToLocation` returns whether it placed the entity; `Environment::addEntityToLocation` returns nothing. -`Grid::getFirstLocation` and `Grid::getRandomLocation` do not check for an empty grid. Calling either on a grid with no locations — including indirectly through `Environment::addEntity` on an environment of size `0` — is undefined behaviour. +`Grid::getFirstLocation` and `Grid::getRandomLocation` do not check for an empty grid. Calling either on a grid with no locations — including indirectly through `Environment::addEntity` on an environment of size `0` — is undefined behaviour. The other lookups are safe on an empty grid: `Grid::getLocation`, `Grid::getLocationByCoordinates`, `Environment::getEntity`, and `Environment::getFirstEntity` throw as described above, and `addEntityToLocation` places nothing. ## Building diff --git a/src/tests.cpp b/src/tests.cpp index 222775b..6dd2fba 100644 --- a/src/tests.cpp +++ b/src/tests.cpp @@ -1366,6 +1366,76 @@ void testMovingEntityWhoseLocationIdNamesNoGridLocationThrows() { std::cout << " --- " << "Success" << std::endl; } +void testEnvironmentOfSizeZeroHasNoLocationsAndLookupsThrow() { + std::cout << "Test 82 - An environment of size zero has no locations, its lookups throw, and it places nothing"; + Environment environment(0, "Void", 0); + assert(environment.getGrid()->getLocations().size() == 0); + assert(environment.getGrid()->getSize() == 0); + assert(environment.getNumEntities() == 0); + + bool threwById = false; + try { + environment.getGrid()->getLocation("0-0-0"); + } catch (const std::runtime_error& e) { + threwById = true; + } + bool threwByCoordinates = false; + try { + environment.getGrid()->getLocationByCoordinates(0, 0); + } catch (const std::runtime_error& e) { + threwByCoordinates = true; + } + bool threwFirstEntity = false; + try { + environment.getFirstEntity(); + } catch (const std::runtime_error& e) { + threwFirstEntity = true; + } + bool threwEntityById = false; + try { + environment.getEntity(0); + } catch (const std::runtime_error& e) { + threwEntityById = true; + } + assert(threwById == true); + assert(threwByCoordinates == true); + assert(threwFirstEntity == true); + assert(threwEntityById == true); + + // a separately constructed location with a plausible id still names nothing in the grid + Entity entity(0, "Daniel"); + Location elsewhere("0-0-0", 0, 0); + environment.addEntityToLocation(entity, elsewhere); + assert(environment.getNumEntities() == 0); + assert(environment.isEntityPresent(entity) == false); + assert(entity.getEnvironmentId() == -1); + assert(entity.getGridId() == -1); + assert(elsewhere.getNumEntities() == 0); + + std::ostringstream buffer; + std::streambuf* previousBuffer = std::cout.rdbuf(buffer.rdbuf()); + environment.printConsoleRepresentation(); + std::cout.rdbuf(previousBuffer); + assert(buffer.str() == "\n"); + std::cout << " --- " << "Success" << std::endl; +} + +void testMovingEntityToItsCurrentLocationLeavesItThere() { + std::cout << "Test 83 - Moving an entity to the location it is already in leaves a single pointer there"; + Environment environment(0, "Earth", 3); + Entity entity(0, "Daniel"); + environment.addEntityToLocation(entity, environment.getGrid()->getLocationByCoordinates(1, 1)); + environment.moveEntityToNewLocation(0, "0-1-1"); + Location& location = environment.getGrid()->getLocation("0-1-1"); + assert(location.getNumEntities() == 1); + assert(location.getEntities()[0] == &entity); + assert(entity.getLocationId() == "0-1-1"); + assert(entity.getEnvironmentId() == 0); + assert(entity.getGridId() == 0); + assert(environment.getNumEntities() == 1); + std::cout << " --- " << "Success" << std::endl; +} + void seedRandomNumberGenerator() { srand (time (NULL)); } @@ -1456,5 +1526,7 @@ int main() { testAddingEntityToLocationInGridReportsWhetherItWasPlaced(); testMovingEntityInDirectionStartsFromItsLocationId(); testMovingEntityWhoseLocationIdNamesNoGridLocationThrows(); + testEnvironmentOfSizeZeroHasNoLocationsAndLookupsThrow(); + testMovingEntityToItsCurrentLocationLeavesItThere(); return 0; } \ No newline at end of file