@sprucelabs/spruce-cli 24.0.0 → 24.1.0

package/package.json

@@ -4,7 +4,7 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "24.0.0",
+	"version": "24.1.0",
 	"skill": {
 		"namespace": "spruce-cli",
 		"upgradeIgnoreList": [
@@ -73,18 +73,18 @@
 	},
 	"dependencies": {
 		"@jest/reporters": "^29.7.0",
-		"@sprucelabs/error": "^6.0.566",
+		"@sprucelabs/error": "^6.0.577",
 		"@sprucelabs/globby": "^2.0.501",
-		"@sprucelabs/heartwood-view-controllers": "^116.0.15",
-		"@sprucelabs/jest-json-reporter": "^8.0.567",
-		"@sprucelabs/mercury-client": "^42.0.689",
-		"@sprucelabs/mercury-event-emitter": "^42.0.689",
-		"@sprucelabs/mercury-types": "^47.2.0",
-		"@sprucelabs/schema": "^31.0.19",
-		"@sprucelabs/spruce-core-schemas": "^40.1.605",
-		"@sprucelabs/spruce-event-utils": "^40.1.394",
-		"@sprucelabs/spruce-skill-utils": "^31.2.16",
-		"@sprucelabs/spruce-templates": "^24.0.0",
+		"@sprucelabs/heartwood-view-controllers": "^117.2.5",
+		"@sprucelabs/jest-json-reporter": "^8.0.578",
+		"@sprucelabs/mercury-client": "^42.0.733",
+		"@sprucelabs/mercury-event-emitter": "^42.0.733",
+		"@sprucelabs/mercury-types": "^47.2.28",
+		"@sprucelabs/schema": "^31.0.44",
+		"@sprucelabs/spruce-core-schemas": "^40.1.634",
+		"@sprucelabs/spruce-event-utils": "^40.2.32",
+		"@sprucelabs/spruce-skill-utils": "^31.2.47",
+		"@sprucelabs/spruce-templates": "^24.1.0",
 		"@typescript-eslint/eslint-plugin": "^7.7.1",
 		"@typescript-eslint/parser": "^7.7.1",
 		"cfonts": "^3.3.0",
@@ -101,31 +101,31 @@
 		"md5": "^2.3.0",
 		"open": "^8.4.2",
 		"ora": "5.4.1",
-		"semver": "^7.6.3",
+		"semver": "^7.7.1",
 		"string-argv": "^0.3.2",
 		"terminal-kit": "sprucelabsai/terminal-kit",
 		"tree-kill": "^1.2.2",
 		"tsutils": "^3.21.0",
 		"typescript": "^5.7.3",
-		"uuid": "^11.0.5"
+		"uuid": "^11.1.0"
 	},
 	"devDependencies": {
-		"@sprucelabs/data-stores": "^28.5.24",
-		"@sprucelabs/mercury-core-events": "^25.1.0",
-		"@sprucelabs/resolve-path-aliases": "^2.0.527",
-		"@sprucelabs/spruce-conversation-plugin": "^65.0.9",
-		"@sprucelabs/spruce-deploy-plugin": "^65.0.9",
-		"@sprucelabs/spruce-store-plugin": "^65.0.9",
-		"@sprucelabs/spruce-test-fixtures": "^65.0.9",
-		"@sprucelabs/test": "^9.0.67",
-		"@sprucelabs/test-utils": "^5.1.546",
+		"@sprucelabs/data-stores": "^28.5.57",
+		"@sprucelabs/mercury-core-events": "^26.0.9",
+		"@sprucelabs/resolve-path-aliases": "^2.0.531",
+		"@sprucelabs/spruce-conversation-plugin": "^66.0.20",
+		"@sprucelabs/spruce-deploy-plugin": "^66.0.20",
+		"@sprucelabs/spruce-store-plugin": "^66.0.20",
+		"@sprucelabs/spruce-test-fixtures": "^66.0.20",
+		"@sprucelabs/test": "^9.0.71",
+		"@sprucelabs/test-utils": "^5.3.4",
 		"@types/blessed": "^0.1.25",
 		"@types/eslint": "^9.6.1",
 		"@types/fs-extra": "^11.0.4",
 		"@types/inquirer": "^9.0.7",
-		"@types/lodash": "^4.17.14",
+		"@types/lodash": "^4.17.15",
 		"@types/md5": "^2.3.5",
-		"@types/node": "^22.10.7",
+		"@types/node": "^22.13.4",
 		"@types/promise.allsettled": "^1.0.6",
 		"@types/ps-node": "^0.1.3",
 		"@types/semver": "^7.5.8",
@@ -138,7 +138,7 @@
 		"concurrently": "^9.1.2",
 		"conventional-changelog-sprucelabs": "2.0.1",
 		"dotenv": "^16.4.7",
-		"eslint": "^9.18.0",
+		"eslint": "^9.20.1",
 		"eslint-config-spruce": "^11.2.26",
 		"find-process": "^1.4.10",
 		"jest": "^29.7.0",
@@ -571,5 +571,5 @@
 			"open"
 		]
 	},
-	"gitHead": "4ae8247c0a6aeb36bc8d249c50303e01decb96c2"
+	"gitHead": "1dba2146c4738dbd9c94b2937b3553addee5a1a4"
 }

package/src/__tests__/behavioral/conversations/CreatingAConversationTopic.test.ts

@@ -5,12 +5,12 @@ import testUtil from '../../../tests/utilities/test.utility'
 import { CliInterface } from '../../../types/cli.types'
 
 export default class CreatingAConversationTopicTest extends AbstractCliTest {
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async hasCreateConversationAction() {
         assert.isFunction(this.Action('conversation', 'create').execute)
     }
 
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async createsValidConversationTopicDefinition() {
         const cli =
             await this.FeatureFixture().installCachedFeatures('conversation')

package/src/__tests__/behavioral/conversations/RegisteringConversationsOnBoot.test.ts

@@ -2,7 +2,7 @@ import { test, assert } from '@sprucelabs/test-utils'
 import AbstractEventTest from '../../../tests/AbstractEventTest'
 
 export default class RegisteringConversationsOnBootTest extends AbstractEventTest {
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async canRegisterConversationsOnBoot() {
         const { currentSkill } =
             await this.seedDummySkillRegisterCurrentSkillAndInstallToOrg(

package/src/__tests__/behavioral/conversations/TestingAConversation.test.ts

@@ -5,12 +5,12 @@ import AbstractCliTest from '../../../tests/AbstractCliTest'
 import testUtil from '../../../tests/utilities/test.utility'
 
 export default class TestingAConversationTest extends AbstractCliTest {
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async hasTestConvoFeature() {
         assert.isFunction(this.Action('conversation', 'test').execute)
     }
 
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async shouldRunWithoutConversationShouldShutdownOnItsOwn() {
         await this.FeatureFixture().installCachedFeatures('conversation')
 
@@ -33,7 +33,7 @@ export default class TestingAConversationTest extends AbstractCliTest {
         } while (psResults.length > 0)
     }
 
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async runsUntilKilled() {
         await this.installAndCreateConversation()
 
@@ -59,7 +59,7 @@ export default class TestingAConversationTest extends AbstractCliTest {
         } while (psResults.length > 0)
     }
 
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async doesntReturnErrorWhenKilled() {
         await this.installAndCreateConversation()
         const test = this.Action(
@@ -79,7 +79,7 @@ export default class TestingAConversationTest extends AbstractCliTest {
         assert.isFalsy(results.errors)
     }
 
-    @test()
+    @test.skip('bring back if re introducing conversation topics')
     protected static async returnsErrorWhenScriptErrors() {
         const { createResults } = await this.installAndCreateConversation()
 

package/src/__tests__/behavioral/organization/CreatingAnOrg.test.ts

@@ -14,7 +14,6 @@ export default class CreatingAnOrgTest extends AbstractCliTest {
         const slug = `my-org-${new Date().getTime()}`
 
         await this.FeatureFixture().installCachedFeatures('organizations')
-
         await this.people.loginAsDemoPerson()
 
         const results = await this.Action('organization', 'create').execute({

package/src/__tests__/behavioral/tests/migrationToInstance/AbstractInstanceTest.ts

@@ -0,0 +1,77 @@
+import { diskUtil, namesUtil } from '@sprucelabs/spruce-skill-utils'
+import { assert } from '@sprucelabs/test-utils'
+import CreateAction from '../../../../features/test/actions/CreateAction'
+import AbstractSkillTest from '../../../../tests/AbstractSkillTest'
+import testUtil from '../../../../tests/utilities/test.utility'
+
+export default abstract class AbstractInstanceTest extends AbstractSkillTest {
+    protected static skillCacheKey = 'tests'
+    protected static action: CreateAction
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+
+        this.action = this.Action('test', 'create')
+    }
+
+    protected static async createTest(
+        name: string,
+        willPromptForSubDir = false
+    ) {
+        const promise = this.action.execute({
+            type: 'behavioral',
+            nameReadable: name,
+            nameCamel: namesUtil.toCamel(name),
+            namePascal: namesUtil.toPascal(name),
+        })
+
+        await this.ui.waitForInput()
+        await this.ui.sendInput('')
+
+        if (willPromptForSubDir) {
+            await this.ui.waitForInput()
+            await this.ui.sendInput('')
+        }
+
+        const results = await promise
+
+        assert.isFalsy(results.errors, 'Error creating test')
+        return results
+    }
+
+    protected static async createTestAndAssertContentsEqual(
+        name: string,
+        expected: string,
+
+        willPromptForSubDir = false
+    ) {
+        const testFile = await this.createTestAndGetCreatedFilePath(
+            name,
+            willPromptForSubDir
+        )
+
+        const contents = diskUtil.readFile(testFile)
+        assert.isEqual(
+            this.normalizeWhitespace(contents),
+            this.normalizeWhitespace(expected),
+            'Instance test does not match expected'
+        )
+    }
+
+    protected static async createTestAndGetCreatedFilePath(
+        name: string,
+        willPromptForSubDir = false
+    ) {
+        const results = await this.createTest(name, willPromptForSubDir)
+
+        const testFile = testUtil.assertFileByNameInGeneratedFiles(
+            `${namesUtil.toPascal(name)}.test.ts`,
+            results.files
+        )
+        return testFile
+    }
+
+    protected static normalizeWhitespace(contents: string) {
+        return contents.replace(/\s/g, '')
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/InstanceBasedTesting.test.ts

@@ -0,0 +1,19 @@
+import { test } from '@sprucelabs/test-utils'
+import AbstractInstanceTest from './AbstractInstanceTest'
+import { generateExpectedInstanceTestContents } from './testFileContentsGenerators'
+
+export default class InstanceBasedTestingTest extends AbstractInstanceTest {
+    @test()
+    protected static async ifNoTestsExistCreatesInstanceTest() {
+        const name = 'My First Test'
+        const expected = generateExpectedInstanceTestContents(name)
+        await this.createTestAndAssertContentsEqual(name, expected)
+    }
+
+    @test()
+    protected static async secondTestAlsoInstance() {
+        const name = 'My Second Test'
+        const expected = generateExpectedInstanceTestContents(name)
+        await this.createTestAndAssertContentsEqual(name, expected, true)
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/MigratingTests.test.ts

@@ -0,0 +1,99 @@
+import { test, assert } from '@sprucelabs/test-utils'
+import MigrationAction from '../../../../features/test/actions/MigrateAction'
+import AbstractSkillTest from '../../../../tests/AbstractSkillTest'
+import StaticToInstanceMigratorImpl, {
+    StaticToInstanceMigrator,
+    StaticToInstanceMigratorOptions,
+    StaticToInstanceMigratorResults,
+} from '../../../../tests/staticToInstanceMigration/StaticToInstanceMigrator'
+
+export default class MigratingTestsTest extends AbstractSkillTest {
+    private static action: MigrationAction
+    protected static skillCacheKey = 'tests'
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+        StaticToInstanceMigratorImpl.Class = FakeStaticToInstanceMigrator
+        this.action = this.Action('test', 'migrate')
+    }
+
+    @test()
+    protected static async hasMigrateAction() {
+        assert.isFunction(this.Action('test', 'migrate').execute)
+    }
+
+    @test()
+    protected static async migrateCreatsMigrator() {
+        const results = await this.execute()
+        assert.isFalsy(results.errors)
+        assert.isTruthy(this.migrator, 'Migrator not created')
+    }
+
+    @test()
+    protected static async migratorRunsMigratePassingLookupDir() {
+        await this.execute()
+        this.migrator.assertLookupCalledWith(
+            this.resolvePath('src', '__tests__')
+        )
+    }
+
+    @test('returns results from migrator 1', 1, 1)
+    @test('returns results from migrator 2', 2, 3)
+    protected static async returnsResultsFromMigrator(
+        totalTestsSkipped: number,
+        totalTestsUpdated: number
+    ) {
+        FakeStaticToInstanceMigrator.runResults = {
+            totalTestsSkipped,
+            totalTestsUpdated,
+        }
+
+        const results = await this.execute()
+        assert.isEqualDeep(results, {
+            headline: 'Migrated tests from static to instance based.',
+            summaryLines: [
+                `${totalTestsUpdated} test${totalTestsUpdated === 1 ? '' : 's'} updated`,
+                `${totalTestsSkipped} test${totalTestsSkipped === 1 ? '' : 's'} skipped`,
+            ],
+        })
+    }
+
+    private static get migrator(): FakeStaticToInstanceMigrator {
+        return FakeStaticToInstanceMigrator.instance
+    }
+
+    private static async execute() {
+        return await this.action.execute()
+    }
+}
+
+class FakeStaticToInstanceMigrator implements StaticToInstanceMigrator {
+    public static instance: FakeStaticToInstanceMigrator
+    private passedLookupDir?: string
+    public static runResults?: StaticToInstanceMigratorResults
+
+    public constructor(_options: StaticToInstanceMigratorOptions) {
+        FakeStaticToInstanceMigrator.instance = this
+    }
+
+    public async run(
+        lookupDir: string
+    ): Promise<StaticToInstanceMigratorResults> {
+        this.passedLookupDir = lookupDir
+
+        return (
+            FakeStaticToInstanceMigrator.runResults ?? {
+                totalTestsUpdated: 0,
+                totalTestsSkipped: 0,
+            }
+        )
+    }
+
+    public assertLookupCalledWith(expected: string) {
+        assert.isEqual(
+            this.passedLookupDir,
+            expected,
+            `Migrator.run was not called with expected lookup dir.`
+        )
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/StaticTestFinder.test.ts

@@ -0,0 +1,72 @@
+import AbstractSpruceTest, {
+    test,
+    assert,
+    errorAssert,
+    suite,
+} from '@sprucelabs/test-utils'
+import StaticTestFinderImpl from '../../../../tests/staticToInstanceMigration/StaticTestFinder'
+
+@suite()
+export default class StaticTestFinderTest extends AbstractSpruceTest {
+    private finder: StaticTestFinderImpl = StaticTestFinderImpl.Finder()
+    private testPath?: string
+
+    @test()
+    protected async throwsWithMissing() {
+        //@ts-ignore
+        const err = await assert.doesThrowAsync(() => this.finder.find())
+        errorAssert.assertError(err, 'MISSING_PARAMETERS', {
+            parameters: ['lookupDir'],
+        })
+    }
+
+    @test()
+    protected async matchesStaticTests1() {
+        this.setTestMigrationDir('static_test_migration_1')
+        await this.assertFindResultsEqual([
+            'AnotherStaticTest.test.ts',
+            'StaticTest1.test.ts',
+        ])
+    }
+
+    @test()
+    protected async matchesStaticTests2() {
+        this.setTestMigrationDir('static_test_migration_2')
+        await this.assertFindResultsEqual([
+            'AStaticTest.test.ts',
+            'AnotherStaticTest1.test.ts',
+        ])
+    }
+
+    @test()
+    protected async includesAbstractTestsInOtherDirectories() {
+        this.setTestMigrationDir('static_test_migration_3')
+        await this.assertFindResultsEqual([
+            'AbstractWhateverTest.ts',
+            'AStaticTest2.test.ts',
+        ])
+    }
+
+    private async assertFindResultsEqual(files: string[]) {
+        const results = await this.find()
+        const expected = files.map((file) => this.resolveStaticTestFile(file))
+        assert.isEqualDeep(results, expected)
+    }
+
+    private async find() {
+        return await this.finder.find(this.testPath!)
+    }
+
+    private resolveStaticTestFile(file: string) {
+        return this.resolvePath(this.testPath!, 'src', '__tests__', file)
+    }
+
+    private setTestMigrationDir(dirName: string) {
+        this.testPath = this.resolvePath(
+            'build',
+            '__tests__',
+            'testDirsAndFiles',
+            dirName
+        )
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/StaticTestsWhenAlreadyExists.test.ts

@@ -0,0 +1,31 @@
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import { test } from '@sprucelabs/test-utils'
+import AbstractInstanceTest from './AbstractInstanceTest'
+import { generateExpectedStaticTestContents } from './testFileContentsGenerators'
+
+export default class StaticTestsWhenAlreadyExistsTest extends AbstractInstanceTest {
+    @test()
+    protected static async canCreateStaticTestsWhenAlreadyExists() {
+        const testFile =
+            await this.createTestAndGetCreatedFilePath('AFirstTest')
+
+        diskUtil.writeFile(
+            testFile,
+            generateExpectedStaticTestContents('AFirstTest')
+        )
+
+        await this.createTestAndAssertContentsEqual(
+            'ASecondTest',
+            generateExpectedStaticTestContents('ASecondTest'),
+            true
+        )
+
+        diskUtil.deleteFile(testFile)
+
+        await this.createTestAndAssertContentsEqual(
+            'AThirdTest',
+            generateExpectedStaticTestContents('AThirdTest'),
+            true
+        )
+    }
+}