@sprucelabs/spruce-cli/src/__tests__/behavioral/upgrading/UpdatingDependencies2.test.ts

Command line interface for building Spruce skills.

import { test, assert } from '@sprucelabs/test-utils'
import { random, uniq } from 'lodash'
import UpdateDependenciesAction from '../../../features/node/actions/UpdateDependenciesAction'
import CommandServiceImpl from '../../../services/CommandService'
import AbstractCliTest from '../../../tests/AbstractCliTest'
import { NpmPackage } from '../../../types/cli.types'

export default class UpdateDependencies2Test extends AbstractCliTest {
    private static action: UpdateDependenciesAction

    protected static async beforeEach() {
        await super.beforeEach()
        this.action = this.Action('node', 'updateDependencies')
    }

    @test()
    protected static async locksVersionOfDependencyWhenDependencyAlreadyInPackageJson() {
        await this.FeatureFixture().installCachedFeatures('skills')

        this.Service('pkg').set({ path: 'dependencies.axios', value: '0.0.1' })

        const skill = this.featureInstaller.getFeature('skill')
        skill.packageDependencies.push({
            name: 'axios',
            version: '0.21.3',
        })

        const passedArgs: string[] = []

        CommandServiceImpl.fakeCommand(/(npm|yarn).*?(install|add)/, {
            code: 0,
            callback: (_, args) => {
                passedArgs.push(...args)
            },
        })

        await this.action.execute({})

        assert.doesInclude(passedArgs, 'axios@0.21.3')
    }

    @test()
    protected static async runsAddForAllDependenciesInPkgJson() {
        await this.FeatureFixture().installCachedFeatures('events')

        const name = await this.installRandomPackage()
        const devName = await this.installRandomDevPackage()
        const blocked = this.blockRandomPackages()

        const { allDeps, allDevDeps } = this.loadAllDependencies(name, devName)

        let passedArgs: any[] = []

        CommandServiceImpl.fakeCommand(/(npm|yarn).*?(install|add)/, {
            code: 0,
            callback: (_, args) => {
                passedArgs.push(args)
            },
        })

        await this.action.execute({})

        const pkg = this.Service('pkg')
        const features = await this.featureInstaller.getInstalledFeatures()

        for (const feature of features) {
            const featureDependencies =
                feature.packageDependencies as NpmPackage[]

            const deps = uniq(
                [
                    ...allDeps,
                    ...featureDependencies
                        .filter((d) => !d.isDev && !allDevDeps.includes(d.name))
                        .map((d) => d.name),
                ]
                    .map((n) => pkg.stripLatest(n))
                    .filter((n) => n !== blocked)
            )

            const devDeps = uniq(
                [
                    ...allDevDeps,
                    ...featureDependencies
                        .filter((d) => d.isDev && !allDeps.includes(d.name))
                        .map((d) => d.name),
                ]
                    .map((n) => pkg.stripLatest(n))
                    .filter((n) => n !== blocked)
            )

            for (const d of deps) {
                assert.doesInclude(passedArgs[0], d)
            }

            for (const d of devDeps) {
                assert.doesInclude(passedArgs[1], d)
            }
        }

        assert.doesNotInclude(passedArgs[0], blocked)
        assert.doesNotInclude(passedArgs[1], blocked)
    }

    private static loadAllDependencies(name: string, devName: string) {
        const pkg = this.Service('pkg')
        const pkgJson = pkg.readPackage()
        const allDeps = [...(Object.keys(pkgJson.dependencies) ?? []), name]
        const allDevDeps = [
            ...(Object.keys(pkgJson.devDependencies) ?? []),
            devName,
        ]
        return { allDeps, allDevDeps }
    }

    protected static async installRandomPackage() {
        const names = ['moment', 'lodash']
        const name = names[random(0, names.length - 1)]
        const pkg = this.Service('pkg')
        await pkg.install(name)

        return name
    }

    protected static async installRandomDevPackage() {
        const names = ['chalk', 'axios']
        const name = names[random(0, names.length - 1)]
        const pkg = this.Service('pkg')
        await pkg.install(name, { isDev: true })

        return name
    }

    protected static blockRandomPackages() {
        const names = ['@sprucelabs/error', 'typescript']
        const name = names[random(0, names.length - 1)]

        this.action.blockUpgrade(name, this.Service('pkg'))
        this.action.blockUpgrade('random', this.Service('pkg'))

        return name
    }
}