Adding bone sets #289
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,4 +21,7 @@ Thumbs.db | |
|
|
||
| # Cache files | ||
| __pycache__/ | ||
| *.pyc | ||
|
|
||
| # XML files | ||
| *.xml | ||
|
Collaborator
There was a problem hiding this comment. All of the bones will be stored in the What we're really looking for here is just a refactoring of the endpoints where the I'm sorry if the issue description wasn't clear–I understand how it may have caused confusion here. I've rewritten the issue description a bit to clarify what needs to be done. |
|
Collaborator
There was a problem hiding this comment. While I do appreciate the work on this, a test suite is not necessary at this time. At this stage it would slow us down, and I've set up work in other issues to set up tests. We can get rid of this test suite for now. I realize that my wording of the issue descriptions probably made it sound like server unit tests were necessary, so I'm sorry for the lack of clarity on that. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /** | ||
| * Test suite for boneset-api server | ||
| * Tests the multi-boneset URL construction functionality | ||
| */ | ||
|
|
||
| const { app, escapeHtml, searchItems, initializeSearchCache } = require('./server'); | ||
| const request = require('supertest'); | ||
|
|
||
| // Note: These tests require supertest to be installed | ||
| // To run: npm install --save-dev jest supertest | ||
|
|
||
| describe('Boneset API - Multi-Boneset Support', () => { | ||
| describe('GET /api/description/', () => { | ||
| test('should accept bonesetId parameter for different bonesets', async () => { | ||
| // This test verifies that the endpoint now accepts a bonesetId parameter | ||
| // Example: /api/description/?boneId=anterior_iliac_spines&bonesetId=bony_pelvis | ||
| const response = await request(app) | ||
| .get('/api/description/') | ||
| .query({ boneId: 'test_bone', bonesetId: 'bony_pelvis' }); | ||
|
Check failure on line 19 in boneset-api/server.test.js
|
||
|
|
||
| // The endpoint should handle the bonesetId parameter | ||
| // (May fail to fetch due to test environment, but parameters should be accepted) | ||
| expect(response.status).toBeDefined(); | ||
| }); | ||
|
|
||
| test('should default to bony_pelvis when bonesetId is not provided', async () => { | ||
| const response = await request(app) | ||
| .get('/api/description/') | ||
| .query({ boneId: 'test_bone' }); | ||
|
|
||
| expect(response.status).toBeDefined(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('GET /api/bone-data/', () => { | ||
| test('should accept bonesetId parameter for different bonesets', async () => { | ||
| // Example: /api/bone-data/?boneId=anterior_iliac_spines&bonesetId=custom_boneset | ||
| const response = await request(app) | ||
| .get('/api/bone-data/') | ||
| .query({ boneId: 'test_bone', bonesetId: 'custom_boneset' }); | ||
|
|
||
| expect(response.status).toBeDefined(); | ||
| }); | ||
|
|
||
| test('should default to bony_pelvis when bonesetId is not provided', async () => { | ||
| const response = await request(app) | ||
| .get('/api/bone-data/') | ||
| .query({ boneId: 'test_bone' }); | ||
|
|
||
| expect(response.status).toBeDefined(); | ||
| }); | ||
|
|
||
| test('should require boneId parameter', async () => { | ||
| const response = await request(app) | ||
| .get('/api/bone-data/'); | ||
|
|
||
| expect(response.status).toBe(400); | ||
| }); | ||
| }); | ||
|
|
||
| describe('GET /api/annotations/:boneId', () => { | ||
| test('should accept bonesetId query parameter for different bonesets', async () => { | ||
| // Example: /api/annotations/anterior_iliac_spines?bonesetId=custom_boneset | ||
| const response = await request(app) | ||
| .get('/api/annotations/test_bone') | ||
| .query({ bonesetId: 'custom_boneset' }); | ||
|
|
||
| expect(response.status).toBeDefined(); | ||
| }); | ||
|
|
||
| test('should default to bony_pelvis when bonesetId is not provided', async () => { | ||
| const response = await request(app) | ||
| .get('/api/annotations/test_bone'); | ||
|
|
||
| expect(response.status).toBeDefined(); | ||
| }); | ||
|
|
||
| test('should validate boneId format', async () => { | ||
| const response = await request(app) | ||
| .get('/api/annotations/../invalid'); | ||
|
|
||
| expect(response.status).toBe(400); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Helper function - getGitHubBonesetUrl', () => { | ||
| test('should construct correct GitHub URLs for different bonesets', () => { | ||
| // Test that different bonesetIds produce different URLs | ||
| // Test examples when testing framework is available: | ||
| // const url_pelvis = getGitHubBonesetUrl('bony_pelvis'); | ||
| // expect(url_pelvis).toBe('https://raw.githubusercontent.com/oss-slu/DigitalBonesBox/data/bony_pelvis/'); | ||
| // | ||
| // const url_custom = getGitHubBonesetUrl('custom_boneset'); | ||
| // expect(url_custom).toBe('https://raw.githubusercontent.com/oss-slu/DigitalBonesBox/data/custom_boneset/'); | ||
| expect(true).toBe(true); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Security - SSRF Prevention', () => { | ||
| test('should prevent path traversal in boneId', async () => { | ||
| const response = await request(app) | ||
| .get('/api/bone-data/') | ||
| .query({ boneId: '../../etc/passwd' }); | ||
|
|
||
| expect(response.status).toBe(400); | ||
| }); | ||
|
|
||
| test('should prevent special characters in boneId', async () => { | ||
| const response = await request(app) | ||
| .get('/api/bone-data/') | ||
| .query({ boneId: '<script>alert(1)</script>' }); | ||
|
|
||
| expect(response.status).toBe(400); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('API v2 - Future Boneset Support', () => { | ||
| test('documentation: new bonesets can be added by following the naming convention', () => { | ||
| // To support a new boneset in the future: | ||
| // 1. Create a GitHub branch or directory named "{BonesetName}" in oss-slu/DigitalBonesBox/data/ | ||
| // 2. The structure should follow: | ||
| // - boneset/{boneset_id}.json | ||
| // - bones/{bone_ids}.json | ||
| // - descriptions/{bone_id}_description.json | ||
| // - images/ | ||
| // - annotations/text_label_annotations/{bone_id}_text_annotations.json | ||
| // - annotations/rotations annotations/template_{boneset_id}.json | ||
| // 3. Call the API endpoints with ?bonesetId={BonesetName} parameter | ||
| // 4. The server will automatically route to the correct GitHub URLs | ||
| expect(true).toBe(true); | ||
| }); | ||
| }); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why was this added?