Best way to wait for adapter stop?

[klein0r]

I have a schedule adapter and I want to perform some checks when everything is finished (based on adapter configuration). What is the best way to wait for the adapter to stop?

Something like this?

'use strict';

const path = require('path');
const { tests, IntegrationTestHarness } = require('@iobroker/testing');
const chai = require('chai');
const expect = chai.expect;

// Run integration tests - See https://github.com/ioBroker/testing for a detailed explanation and further options
tests.integration(path.join(__dirname, '..'), {
    defineAdditionalTests({ suite }) {

        suite('Test', getHarness => {
            /**
             * @type {IntegrationTestHarness}
             */
            let harness;
            before(() => {
                harness = getHarness();
            });

            it('Should work', function (done) {
                this.timeout(60000);

                harness.startAdapterAndWait()
                    .then(() => {
                        expect(harness.isAdapterRunning()).to.equal(true);
                        expect(harness.isControllerRunning()).to.equal(true);

                        // Wait for adapter stop
                        return new Promise(resolve => {
                            harness.on('stateChange', async (id, state) => {
                                if (
                                    id === `system.adapter.${harness.adapterName}.0.alive` &&
                                    state &&
                                    state.val === false
                                ) {
                                    resolve(true);
                                }
                            });
                        });
                    })
                    .then(() => {
                        console.log('-----------------> STOPPED NOW');

                        done();
                    });
            });
        });

    }
});

[klein0r]

It would be awesome if the test lib provides a function with a promise which waits for stop and checks the allowed exist codes to resolve the promise. Like

harness.startAdapterAndWaitForStop()
    .then(exitCode => {
        // ...
    });

[AlCalzone]

I don't think this was a use case before, so it wasn't considered yet. Currently a suite essentially ends when the adapter stops.

[klein0r]

I've migrated some testing logic to the integration tests for iCal. See https://github.com/iobroker-community-adapters/ioBroker.ical/blob/062b64f3555f40fb0c523f260ae126e0c2cf0759/test/integration.js

But I don't know if this is the best way to do it. At the moment the adapter is started with given settings in the "before" section and returns a promise which will be resolved when the adapter has been stopped. After that, all states can be checked.

[AlCalzone]

This

                            expect(harness.isAdapterRunning()).to.be.true;
                            expect(harness.isControllerRunning()).to.be.true;

is unnecessary IMO, since startAdapterAndWait will resolve as soon as the above is true.

The rest with the waiting looks like a viable workaround, although it is a bit awkward. I'll look into making this feel more "natural".

[klein0r]

although it is a bit awkward

That was the reason for this issue 😄 Thanks a lot!