Fix Promise scope issues and adopt proven integration testing patterns #41
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,6 +82,7 @@ const { tests } = require('@iobroker/testing'); | |
|
|
||
| // Define test coordinates or configuration | ||
| const TEST_COORDINATES = '52.520008,13.404954'; // Berlin | ||
| const wait = ms => new Promise(resolve => setTimeout(resolve, ms)); | ||
|
|
||
| // Use tests.integration() with defineAdditionalTests | ||
| tests.integration(path.join(__dirname, '..'), { | ||
|
|
@@ -93,40 +94,81 @@ tests.integration(path.join(__dirname, '..'), { | |
| harness = getHarness(); | ||
| }); | ||
|
|
||
| it('should configure and start adapter', function () { | ||
| return new Promise(async (resolve, reject) => { | ||
| try { | ||
| harness = getHarness(); | ||
|
|
||
| // Get adapter object using promisified pattern | ||
| const obj = await new Promise((res, rej) => { | ||
| harness.objects.getObject('system.adapter.brightsky.0', (err, o) => { | ||
| if (err) return rej(err); | ||
| res(o); | ||
| }); | ||
| }); | ||
|
|
||
| if (!obj) { | ||
| return reject(new Error('Adapter object not found')); | ||
| } | ||
|
|
||
| // Configure adapter properties | ||
| Object.assign(obj.native, { | ||
| position: TEST_COORDINATES, | ||
| createCurrently: true, | ||
| createHourly: true, | ||
| createDaily: true, | ||
| // Add other configuration as needed | ||
| }); | ||
|
|
||
| // Set the updated configuration | ||
| harness.objects.setObject(obj._id, obj); | ||
|
|
||
| console.log('✅ Step 1: Configuration written, starting adapter...'); | ||
|
|
||
| // Start adapter and wait | ||
| await harness.startAdapterAndWait(); | ||
|
|
||
| console.log('✅ Step 2: Adapter started'); | ||
|
|
||
| // Wait for adapter to process data | ||
| const waitMs = 15000; | ||
| await wait(waitMs); | ||
|
|
||
| console.log('🔍 Step 3: Checking states after adapter run...'); | ||
|
|
||
| // Get all states created by adapter | ||
| const stateIds = await harness.dbConnection.getStateIDs('your-adapter.0.*'); | ||
|
|
||
| console.log(`📊 Found ${stateIds.length} states`); | ||
|
|
||
| if (stateIds.length > 0) { | ||
| console.log('✅ Adapter successfully created states'); | ||
|
|
||
| // Show sample of created states | ||
| const allStates = await new Promise((res, rej) => { | ||
| harness.states.getStates(stateIds, (err, states) => { | ||
| if (err) return rej(err); | ||
| res(states || []); | ||
| }); | ||
| }); | ||
|
|
||
| console.log('📋 Sample states created:'); | ||
| stateIds.slice(0, 5).forEach((stateId, index) => { | ||
| const state = allStates[index]; | ||
| console.log(` ${stateId}: ${state && state.val !== undefined ? state.val : 'undefined'}`); | ||
| }); | ||
|
|
||
| await harness.stopAdapter(); | ||
| resolve(true); | ||
| } else { | ||
| console.log('❌ No states were created by the adapter'); | ||
| reject(new Error('Adapter did not create any states')); | ||
| } | ||
| } catch (error) { | ||
| reject(error); | ||
| } | ||
| }); | ||
| }).timeout(40000); | ||
| }); | ||
| } | ||
| }); | ||
|
|
@@ -138,79 +180,149 @@ tests.integration(path.join(__dirname, '..'), { | |
|
|
||
| ```javascript | ||
| // Example: Testing successful configuration | ||
| it('should configure and start adapter with valid configuration', function () { | ||
| return new Promise(async (resolve, reject) => { | ||
| // ... successful configuration test as shown above | ||
| }); | ||
| }).timeout(40000); | ||
|
|
||
| // Example: Testing failure scenarios | ||
| it('should NOT create daily states when daily is disabled', function () { | ||
| return new Promise(async (resolve, reject) => { | ||
| try { | ||
| harness = getHarness(); | ||
|
|
||
| console.log('🔍 Step 1: Fetching adapter object...'); | ||
| const obj = await new Promise((res, rej) => { | ||
| harness.objects.getObject('system.adapter.your-adapter.0', (err, o) => { | ||
|
There was a problem hiding this comment. Multiple references use 'your-adapter' while the main example uses 'brightsky'. All adapter references should be consistent - either use a placeholder like 'your-adapter' throughout or use 'brightsky' throughout the examples. |
||
| if (err) return rej(err); | ||
| res(o); | ||
| }); | ||
| }); | ||
|
|
||
| if (!obj) return reject(new Error('Adapter object not found')); | ||
| console.log('✅ Step 1.5: Adapter object loaded'); | ||
|
|
||
| console.log('🔍 Step 2: Updating adapter config...'); | ||
| Object.assign(obj.native, { | ||
| position: TEST_COORDINATES, | ||
| createCurrently: false, | ||
| createHourly: true, | ||
| createDaily: false, // Daily disabled for this test | ||
| }); | ||
|
|
||
| await new Promise((res, rej) => { | ||
| harness.objects.setObject(obj._id, obj, (err) => { | ||
| if (err) return rej(err); | ||
| console.log('✅ Step 2.5: Adapter object updated'); | ||
| res(undefined); | ||
| }); | ||
| }); | ||
|
|
||
| console.log('🔍 Step 3: Starting adapter...'); | ||
| await harness.startAdapterAndWait(); | ||
| console.log('✅ Step 4: Adapter started'); | ||
|
|
||
| console.log('⏳ Step 5: Waiting 20 seconds for states...'); | ||
| await new Promise((res) => setTimeout(res, 20000)); | ||
|
|
||
| console.log('🔍 Step 6: Fetching state IDs...'); | ||
| const stateIds = await harness.dbConnection.getStateIDs('your-adapter.0.*'); | ||
DutchmanNL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| console.log(`📊 Step 7: Found ${stateIds.length} total states`); | ||
|
|
||
| const hourlyStates = stateIds.filter((key) => key.includes('hourly')); | ||
| if (hourlyStates.length > 0) { | ||
| console.log(`✅ Step 8: Correctly ${hourlyStates.length} hourly weather states created`); | ||
| } else { | ||
| console.log('❌ Step 8: No hourly states created (test failed)'); | ||
| return reject(new Error('Expected hourly states but found none')); | ||
| } | ||
|
|
||
| // Check daily states should NOT be present | ||
| const dailyStates = stateIds.filter((key) => key.includes('daily')); | ||
| if (dailyStates.length === 0) { | ||
| console.log(`✅ Step 9: No daily states found as expected`); | ||
| } else { | ||
| console.log(`❌ Step 9: Daily states present (${dailyStates.length}) (test failed)`); | ||
| return reject(new Error('Expected no daily states but found some')); | ||
| } | ||
|
|
||
| await harness.stopAdapter(); | ||
| console.log('🛑 Step 10: Adapter stopped'); | ||
|
|
||
| resolve(true); | ||
| } catch (error) { | ||
| reject(error); | ||
| } | ||
| }); | ||
| }).timeout(40000); | ||
|
|
||
| // Example: Testing missing required configuration | ||
| it('should handle missing required configuration properly', function () { | ||
| return new Promise(async (resolve, reject) => { | ||
| try { | ||
| harness = getHarness(); | ||
|
|
||
| console.log('🔍 Step 1: Fetching adapter object...'); | ||
| const obj = await new Promise((res, rej) => { | ||
| harness.objects.getObject('system.adapter.your-adapter.0', (err, o) => { | ||
|
There was a problem hiding this comment. Multiple references use 'your-adapter' while the main example uses 'brightsky'. All adapter references should be consistent - either use a placeholder like 'your-adapter' throughout or use 'brightsky' throughout the examples.
Contributor
|
||
| if (err) return rej(err); | ||
| res(o); | ||
| }); | ||
| }); | ||
|
|
||
| if (!obj) return reject(new Error('Adapter object not found')); | ||
|
|
||
| console.log('🔍 Step 2: Removing required configuration...'); | ||
| // Remove required configuration to test failure handling | ||
| delete obj.native.position; // This should cause failure or graceful handling | ||
|
|
||
| await new Promise((res, rej) => { | ||
| harness.objects.setObject(obj._id, obj, (err) => { | ||
| if (err) return rej(err); | ||
| res(undefined); | ||
| }); | ||
| }); | ||
|
|
||
| console.log('🔍 Step 3: Starting adapter...'); | ||
| await harness.startAdapterAndWait(); | ||
|
|
||
| console.log('⏳ Step 4: Waiting for adapter to process...'); | ||
| await new Promise((res) => setTimeout(res, 10000)); | ||
|
|
||
| console.log('🔍 Step 5: Checking adapter behavior...'); | ||
| const stateIds = await harness.dbConnection.getStateIDs('your-adapter.0.*'); | ||
DutchmanNL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Check if adapter handled missing configuration gracefully | ||
| if (stateIds.length === 0) { | ||
| console.log('✅ Adapter properly handled missing configuration - no invalid states created'); | ||
| resolve(true); | ||
| } else { | ||
| // If states were created, check if they're in error state | ||
| const connectionState = await new Promise((res, rej) => { | ||
| harness.states.getState('your-adapter.0.info.connection', (err, state) => { | ||
DutchmanNL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (err) return rej(err); | ||
| res(state); | ||
| }); | ||
| }); | ||
|
|
||
| if (!connectionState || connectionState.val === false) { | ||
| console.log('✅ Adapter properly failed with missing configuration'); | ||
| resolve(true); | ||
| } else { | ||
| console.log('❌ Adapter should have failed or handled missing config gracefully'); | ||
| reject(new Error('Adapter should have handled missing configuration')); | ||
| } | ||
| } | ||
|
|
||
| await harness.stopAdapter(); | ||
| } catch (error) { | ||
| console.log('✅ Adapter correctly threw error with missing configuration:', error.message); | ||
| resolve(true); | ||
| } | ||
| }); | ||
| }).timeout(40000); | ||
| ``` | ||
|
|
||
| #### Advanced State Access Patterns | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.