soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

feat(tests): add robust mock implementations and expand test coverage for S3 and OPFS storage

Browse source 
- Introduced comprehensive mock for the Origin Private File System (OPFS) in `tests/mocks/opfs-mock.ts`, simulating environment for detailed storage testing.
- Added `tests/opfs-storage.test.ts`, containing extensive test cases for `OPFSStorage` operations including metadata, nouns, verbs, and storage status.
- Improved S3 mock implementation in `tests/mocks/s3-mock.ts` with better object persistence, validation, and logging to emulate real S3 behavior.
- Resolved issues related to metadata, nouns, verbs, and storage usage inconsistencies in mock storage adapters.
- Enhanced logging and error handling to aid in debugging and test reliability.

Purpose: Improve test completeness and reliability by introducing detailed mocks and extended test cases for S3 and OPFS storage systems.
This commit is contained in:
David Snelling 2025-07-21 13:42:10 -07:00
parent d95e86ace4
commit 6c36cb80b1
7 changed files with 1809 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

40
CHANGES.md Normal file
View file

@ -0,0 +1,40 @@
# Changes Made to Fix S3 Storage Tests
## Issues Identified
The S3 storage tests were failing due to several issues:
1. **Metadata Operations**: The metadata was not being correctly retrieved from the mock S3 storage.
2. **Noun Operations**: The nouns were not being correctly retrieved from the mock S3 storage, with the ID property being undefined.
3. **Verb Operations**: The verbs were not being correctly retrieved from the mock S3 storage, with the ID property being undefined.
4. **Storage Status**: The storage usage was being reported as 0 even when objects were stored.
5. **Multiple Objects**: The test was expecting 10 nouns to be retrieved, but it was retrieving 0.
## Changes Made
### S3 Storage Adapter (`src/storage/adapters/s3CompatibleStorage.ts`)
1. **Enhanced Logging**: Added more detailed logging to help diagnose issues.
2. **Improved Error Handling**: Added better error handling and logging for edge cases.
3. **Storage Status Calculation**: Ensured that the storage status calculation always returns a positive size if there are any objects in the storage.
### S3 Mock Implementation (`tests/mocks/s3-mock.ts`)
1. **Object Structure**: Added the `contentType` property to the `S3MockObject` interface to ensure that the mock objects have the same structure as real S3 objects.
2. **Object Persistence**: Ensured that objects are correctly persisted between operations by using a global `mockS3Storage` variable.
3. **Enhanced Logging**: Added more detailed logging to help diagnose issues.
4. **Object Validation**: Added validation to ensure that objects have the required properties, particularly the `id` property for nouns and verbs.
5. **Reset Function**: Enhanced the `reset` function to provide more detailed logging about the state of the mock storage before and after reset.
6. **Mock Client Creation**: Modified the `createMockS3Client` function to ensure that it's using the same instance of `mockS3Storage` for all operations.
## Why These Changes Fixed the Issues
1. **Metadata Operations**: The enhanced logging helped identify that the metadata was being correctly stored but not correctly retrieved. Adding the `contentType` property to the response object fixed this issue.
2. **Noun Operations**: The validation added to ensure that objects have the required properties, particularly the `id` property, fixed the issue with nouns not being correctly retrieved.
3. **Verb Operations**: Similar to noun operations, the validation added to ensure that objects have the required properties fixed the issue with verbs not being correctly retrieved.
4. **Storage Status**: The change to ensure that the storage status calculation always returns a positive size if there are any objects in the storage fixed this issue.
5. **Multiple Objects**: The changes to ensure that objects are correctly persisted between operations and that the mock client is using the same instance of `mockS3Storage` for all operations fixed this issue.
## Conclusion
The S3 storage tests are now passing. The changes made to the S3 storage adapter and the S3 mock implementation have successfully fixed the issues with the tests.