@sprucelabs/spruce-cli/src/__tests__/behavioral/conversations/TestingAConversation.test.ts

Command line interface for building Spruce skills.

import { diskUtil } from '@sprucelabs/spruce-skill-utils'
import { test, assert } from '@sprucelabs/test-utils'
import findProcess from 'find-process'
import AbstractCliTest from '../../../tests/AbstractCliTest'
import testUtil from '../../../tests/utilities/test.utility'

export default class TestingAConversationTest extends AbstractCliTest {
    @test.skip('bring back if re introducing conversation topics')
    protected static async hasTestConvoFeature() {
        assert.isFunction(this.Action('conversation', 'test').execute)
    }

    @test.skip('bring back if re introducing conversation topics')
    protected static async shouldRunWithoutConversationShouldShutdownOnItsOwn() {
        await this.FeatureFixture().installCachedFeatures('conversation')

        this.disablePermissionSyncing()

        const test = await this.Action('conversation', 'test').execute({
            shouldReturnImmediately: true,
            shouldRunSilently: true,
        })

        assert.isTruthy(test.meta)
        assert.isFunction(test.meta.kill)
        assert.isNumber(test.meta.pid)
        assert.isTruthy(test.meta.promise)

        let psResults

        do {
            psResults = await findProcess('pid', test.meta.pid)
        } while (psResults.length > 0)
    }

    @test.skip('bring back if re introducing conversation topics')
    protected static async runsUntilKilled() {
        await this.installAndCreateConversation()

        const test = await this.Action('conversation', 'test').execute({
            shouldReturnImmediately: true,
            shouldRunSilently: true,
        })

        assert.isTruthy(test.meta)
        assert.isFunction(test.meta.kill)
        assert.isNumber(test.meta.pid)
        assert.isTruthy(test.meta.promise)

        await this.wait(1000)

        let psResults = await findProcess('pid', test.meta.pid)
        assert.isAbove(psResults.length, 0)

        await test.meta.kill()

        do {
            psResults = await findProcess('pid', test.meta.pid)
        } while (psResults.length > 0)
    }

    @test.skip('bring back if re introducing conversation topics')
    protected static async doesntReturnErrorWhenKilled() {
        await this.installAndCreateConversation()
        const test = this.Action(
            'conversation',
            'test'
            //@ts-ignore
        ).getChild() as TestAction

        setTimeout(async () => {
            await test.kill()
        }, 5000)

        const results = await test.execute({
            shouldRunSilently: true,
        })

        assert.isFalsy(results.errors)
    }

    @test.skip('bring back if re introducing conversation topics')
    protected static async returnsErrorWhenScriptErrors() {
        const { createResults } = await this.installAndCreateConversation()

        const topic = testUtil.assertFileByNameInGeneratedFiles(
            'knockKnockJoke',
            createResults.files
        )

        diskUtil.writeFile(topic, 'throw new Error("whaaa")')

        const test = this.Action('conversation', 'test')

        const results = await test.execute({
            shouldRunSilently: true,
        })

        assert.isArray(results.errors)
    }

    private static async installAndCreateConversation() {
        await this.FeatureFixture().installCachedFeatures('conversation')
        this.disablePermissionSyncing()

        const results = await this.Action('conversation', 'create').execute({
            nameReadable: 'tell a knock knock joke',
            nameCamel: 'knockKnockJoke',
        })

        assert.isFalsy(results.errors)
        return { createResults: results }
    }

    private static disablePermissionSyncing() {
        const env = this.Service('env')
        env.set('SHOULD_REGISTER_PERMISSIONS', 'false')
    }
}