test_osn_audio.ts

import 'mocha';
import { expect } from 'chai';
import * as osn from '../osn';
import { logInfo, logEmptyLine } from '../util/logger';
import { OBSHandler } from '../util/obs_handler';
import { deleteConfigFiles } from '../util/general';
import { ETestErrorMsg, GetErrorMessage } from '../util/error_messages';

const testName = 'osn-audio';

describe(testName, () => {
    let obs: OBSHandler;
    let hasTestFailed: boolean = false;

    // Initialize OBS process
    before(function() {
        logInfo(testName, 'Starting ' + testName + ' tests');
        deleteConfigFiles();
        obs = new OBSHandler(testName);
    });

    // Shutdown OBS process
    after(async function() {
        obs.shutdown();

        if (hasTestFailed === true) {
            logInfo(testName, 'One or more test cases failed. Uploading cache');
            await obs.uploadTestCache();
        }

        obs = null;
        deleteConfigFiles();
        logInfo(testName, 'Finished ' + testName + ' tests');
        logEmptyLine();
    });

    afterEach(function() {
        if (this.currentTest.state == 'failed') {
            hasTestFailed = true;
        }
    });

    it('Get and set audio context', () => {
        let currentAudio = osn.AudioFactory.audioContext;

        // Check if the current video context correctly returns the default values
        expect(currentAudio.sampleRate).to.equal(44100, GetErrorMessage(ETestErrorMsg.AudioDefaultSampleRate));
        expect(currentAudio.speakers).to.equal(osn.ESpeakerLayout.Stereo, GetErrorMessage(ETestErrorMsg.AudioDefaultSpeakers));

        const newAudioContext: osn.IAudio = {
            sampleRate: 48000,
            speakers: osn.ESpeakerLayout.SevenOne
        }
        osn.AudioFactory.audioContext = newAudioContext;

        currentAudio = osn.AudioFactory.audioContext;
        expect(currentAudio.sampleRate).to.equal(48000, GetErrorMessage(ETestErrorMsg.AudioSampleRate));
        expect(currentAudio.speakers).to.equal(osn.ESpeakerLayout.SevenOne, GetErrorMessage(ETestErrorMsg.AudioSpeakers));
    });

    it('Get output audio devices', function() {
        const devices = osn.NodeObs.OBS_settings_getOutputAudioDevices();
        expect(devices).to.not.equal(undefined, GetErrorMessage(ETestErrorMsg.AudioDevices));
        expect(Array.isArray(devices)).to.equal(true, GetErrorMessage(ETestErrorMsg.AudioDevicesIsArray));
        let foundDefaultDevice = false;
        for (const device of devices) {
            expect(device).to.have.property('id');
            expect(device).to.have.property('description');
            logInfo(testName, `Output Audio Device Found: ${device.description} with id: ${device.id}`);
            if (device.id === 'default') {
                foundDefaultDevice = true;
            }
        }
        if (!obs.isDarwinCI()) { // On virtual mac(s) the default output device is not included in the list of output devices
            expect(foundDefaultDevice).to.equal(true, GetErrorMessage(ETestErrorMsg.DefaultDeviceNotFound));
        }
    });

    it('Get input audio devices', function() {
        const devices = osn.NodeObs.OBS_settings_getInputAudioDevices();
        expect(devices).to.not.equal(undefined, GetErrorMessage(ETestErrorMsg.AudioDevices));
        expect(Array.isArray(devices)).to.equal(true, GetErrorMessage(ETestErrorMsg.AudioDevicesIsArray));
        let foundDefaultDevice = false;
        for (const device of devices) {
            expect(device).to.have.property('id');
            expect(device).to.have.property('description');
            logInfo(testName, `Input Audio Device Found: ${device.description} with id: ${device.id}`);
            if (device.id === 'default') {
                foundDefaultDevice = true;
            }
        }
        expect(foundDefaultDevice).to.equal(true, GetErrorMessage(ETestErrorMsg.DefaultDeviceNotFound));
    });
});