@sprucelabs/spruce-cli 24.0.0 → 24.1.0

package/src/__tests__/behavioral/tests/migrationToInstance/support/InstanceTest3.txt

@@ -0,0 +1,222 @@
+import {
+    activeRecordCardAssert,
+    buttonAssert,
+    interactor,
+    MockActiveRecordCard,
+    vcAssert,
+} from '@sprucelabs/heartwood-view-controllers'
+import { eventFaker, fake } from '@sprucelabs/spruce-test-fixtures'
+import { test, suite, generateId, assert } from '@sprucelabs/test-utils'
+import { PublicHomeIntegration } from '../../google.types'
+import RootSkillViewController from '../../skillViewControllers/Root.svc'
+import AddHomeIntegrationCardViewController from '../../viewControllers/AddHomeIntegrationCard.vc'
+import AbstractGoogleTest from '../support/AbstractGoogleTest'
+import { DeleteHomeIntergrationTargetAndPayload } from '../support/EventFaker'
+import SpyAddHomeIntegrationCard from './homeIntegrations/SpyAddHomeIntegrationCard'
+
+@fake.login()
+@suite()
+export default class RootSkillViewTest extends AbstractGoogleTest {
+    private vc!: SpyRootSkillView
+    private fakedIntegrations: PublicHomeIntegration[] = []
+    protected names: string[] = []
+
+    protected async beforeEach(): Promise<void> {
+        await super.beforeEach()
+
+        this.fakedIntegrations = []
+        this.names = []
+
+        this.views.setController(
+            'google.add-home-integration-card',
+            SpyAddHomeIntegrationCard
+        )
+        this.views.setController('active-record-card', MockActiveRecordCard)
+        this.views.setController('google.root', SpyRootSkillView)
+        this.vc = this.views.Controller('google.root', {}) as SpyRootSkillView
+
+        await this.eventFaker.fakeListHomeIntegrations(() => {
+            return this.fakedIntegrations
+        })
+
+        await this.eventFaker.fakeDeleteHomeIntegration()
+    }
+
+    @test()
+    protected async rendersACard() {
+        vcAssert.assertSkillViewRendersCard(this.vc, 'home-cloud-integrations')
+    }
+
+    @test()
+    protected async cardRendersList() {
+        activeRecordCardAssert.skillViewRendersActiveRecordCard(this.vc)
+    }
+
+    @test()
+    protected async requiresLogin() {
+        await vcAssert.assertLoginIsRequired(this.vc)
+    }
+
+    @test()
+    protected async returnsAListOfIntegrations() {
+        const integration = this.seedIntegration()
+        await this.load()
+        this.assertRendersIntegrationRow(integration.id)
+    }
+
+    @test()
+    protected async homeIntegrationsCardRendersExpectedButtons() {
+        buttonAssert.cardRendersButtons(this.homeIntegrationsCardVc, [
+            'instructions',
+            'add',
+        ])
+    }
+
+    @test()
+    protected async clickingAddIntegrationRendersDialog() {
+        await this.loadClickAddAndAssertRendersDialog()
+    }
+
+    @test()
+    protected async callingOnDoneInAddCardHidesDialog() {
+        const { addCardVc, dialogVc } =
+            await this.loadClickAddAndAssertRendersDialog()
+        await addCardVc.simulateClickDone()
+
+        assert.isFalse(dialogVc.getIsVisible())
+    }
+
+    @test()
+    protected async eachRowRendersDeleteButton() {
+        const integration = await this.seedOneIntegrationAndLoad()
+
+        this.homeIntegrationsCardVc.assertRowRendersButton(
+            integration.id,
+            'delete'
+        )
+    }
+
+    @test()
+    protected async clickingDeleteButtonRendersAlert() {
+        await this.seedLoadClickDeleteAndAssertConfirm()
+    }
+
+    @test()
+    protected async clickingDeleteAndConfirmingRemovesRow() {
+        const integration = await this.seedLoadClickDeleteAndConfirm()
+        this.homeIntegrationsCardVc.assertDoesNotRenderRow(integration.id)
+    }
+
+    @test()
+    protected async doesNotRefreshListIfUserCancels() {
+        const int = await this.seedLoadClickDeleteAndDecline()
+
+        this.assertRendersIntegrationRow(int.id)
+    }
+
+    @test()
+    protected async confirmingDeleteShouldEmitDeleteEvent() {
+        let passedTarget:
+            | DeleteHomeIntergrationTargetAndPayload['target']
+            | undefined
+
+        await this.eventFaker.fakeDeleteHomeIntegration(({ target }) => {
+            passedTarget = target
+        })
+
+        const integration = await this.seedLoadClickDeleteAndConfirm()
+
+        assert.isEqualDeep(passedTarget, {
+            integrationId: integration.id,
+        })
+    }
+
+    @test()
+    protected async doesNotEmitEventIfDeclined() {
+        await eventFaker.makeEventThrow(
+            'google.delete-home-integration::v2025_02_08'
+        )
+
+        await this.seedLoadClickDeleteAndDecline()
+    }
+
+    private async loadClickAddAndAssertRendersDialog() {
+        await this.load()
+        const dialogVc = await vcAssert.assertRendersDialog(this.vc, () =>
+            interactor.clickButton(this.homeIntegrationsCardVc, 'add')
+        )
+
+        const addCardVc = vcAssert.assertRendersAsInstanceOf(
+            dialogVc,
+            AddHomeIntegrationCardViewController
+        ) as SpyAddHomeIntegrationCard
+        return { dialogVc, addCardVc }
+    }
+
+    private async seedLoadClickDeleteAndConfirm() {
+        const { confirmVc, integration } =
+            await this.seedLoadClickDeleteAndAssertConfirm()
+
+        await confirmVc.accept()
+
+        return integration
+    }
+
+    private async seedLoadClickDeleteAndDecline() {
+        const { confirmVc, integration } =
+            await this.seedLoadClickDeleteAndAssertConfirm()
+
+        const int = integration
+
+        await confirmVc.decline()
+        return int
+    }
+
+    private assertRendersIntegrationRow(id: string) {
+        this.homeIntegrationsCardVc.assertRendersRow(id)
+    }
+
+    private async seedLoadClickDeleteAndAssertConfirm() {
+        const integration = await this.seedOneIntegrationAndLoad()
+
+        const confirmVc = await vcAssert.assertRendersConfirm(this.vc, () =>
+            interactor.clickButtonInRow(this.listVc, integration.id, 'delete')
+        )
+        return { confirmVc, integration }
+    }
+
+    private get listVc() {
+        return this.homeIntegrationsCardVc.getListVc()
+    }
+
+    private async seedOneIntegrationAndLoad() {
+        const integration = this.seedIntegration()
+        await this.load()
+        return integration
+    }
+
+    private seedIntegration() {
+        const integration: PublicHomeIntegration = {
+            description: generateId(),
+            id: generateId(),
+            name: generateId(),
+        }
+
+        this.fakedIntegrations.push(integration)
+        return integration
+    }
+
+    private async load() {
+        await this.views.load(this.vc)
+    }
+
+    private get homeIntegrationsCardVc() {
+        return this.vc.getHomeIntegrationsCardVc()
+    }
+}
+
+class SpyRootSkillView extends RootSkillViewController {
+    public getHomeIntegrationsCardVc() {
+        return this.activeRecordCardVc as MockActiveRecordCard
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/support/StaticTest.txt

@@ -0,0 +1,34 @@
+import { assertOptions } from '@sprucelabs/schema'
+import { fake } from '@sprucelabs/spruce-test-fixtures'
+import AbstractSpruceTest, {
+    test,
+    assert,
+    errorAssert,
+} from '@sprucelabs/test-utils'
+
+@fake.login()
+export default class StaticTestFinderTest extends AbstractSpruceTest {
+    @test()
+    protected static async throwsWithMissing() {
+        const finder = StaticTestFinder.Finder()
+        const err = await assert.doesThrowAsync(() => finder.find())
+        errorAssert.assertError(err, 'MISSING_PARAMETERS', {
+            parameters: ['lookupDir'],
+        })
+    }
+
+    @test()
+    protected static async yourNextTest() {
+        assert.isTrue(false)
+    }
+}
+
+class StaticTestFinder {
+    public static Finder() {
+        return new this()
+    }
+
+    public async find() {
+        assertOptions({}, ['lookupDir'])
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/support/StaticTest2.txt

@@ -0,0 +1,62 @@
+import { fake, seed } from '@sprucelabs/spruce-test-fixtures'
+import { assert, test } from '@sprucelabs/test-utils'
+import { HomeIntegration, PublicHomeIntegration } from '../../../google.types'
+import AbstractGoogleTest from '../../support/AbstractGoogleTest'
+
+@fake.login()
+export default class ListHomeIntegrationsLIstenerTest extends AbstractGoogleTest {
+    protected static async beforeEach(): Promise<void> {
+        await super.beforeEach()
+        await this.bootSkill()
+    }
+
+    protected static async afterEach(): Promise<void> {
+    }
+
+    @test()
+    protected static async skillIsListening() {
+        await this.emit()
+    }
+
+    @test()
+    @seed('homeIntegrations', 1)
+    protected static async canReturnFirstHomeIntegration() {
+        const expected = await this.getFirstHomeIntegration()
+        const integrations = await this.emit()
+        assert.isLength(integrations, 1)
+        const first = integrations[0]
+        this.assertIntegrationEqualsExpected(first, expected)
+    }
+
+    @test()
+    @seed('homeIntegrations', 2)
+    protected static async canReturnMultipleHomeIntegrations() {
+        const expected = await this.homeIntegrations.find(
+            {},
+            {},
+            { shouldIncludePrivateFields: true }
+        )
+        const integrations = await this.emit()
+        assert.isLength(integrations, 2)
+        this.assertIntegrationEqualsExpected(integrations[0], expected[0])
+        this.assertIntegrationEqualsExpected(integrations[1], expected[1])
+    }
+
+    private static assertIntegrationEqualsExpected(
+        first: PublicHomeIntegration,
+        expected: HomeIntegration
+    ) {
+        assert.isEqual(first.id, expected.id)
+        assert.isEqual(first.name, expected.name)
+        assert.isEqual(first.description, expected.description)
+    }
+
+    private static async emit() {
+        const [{ integrations }] =
+            await this.fakedClient.emitAndFlattenResponses(
+                'google.list-home-integrations::v2025_02_08'
+            )
+
+        return integrations
+    }
+}

package/src/__tests__/behavioral/tests/migrationToInstance/support/StaticTest3.txt

@@ -0,0 +1,221 @@
+import {
+    activeRecordCardAssert,
+    buttonAssert,
+    interactor,
+    MockActiveRecordCard,
+    vcAssert,
+} from '@sprucelabs/heartwood-view-controllers'
+import { eventFaker, fake } from '@sprucelabs/spruce-test-fixtures'
+import { test, generateId, assert } from '@sprucelabs/test-utils'
+import { PublicHomeIntegration } from '../../google.types'
+import RootSkillViewController from '../../skillViewControllers/Root.svc'
+import AddHomeIntegrationCardViewController from '../../viewControllers/AddHomeIntegrationCard.vc'
+import AbstractGoogleTest from '../support/AbstractGoogleTest'
+import { DeleteHomeIntergrationTargetAndPayload } from '../support/EventFaker'
+import SpyAddHomeIntegrationCard from './homeIntegrations/SpyAddHomeIntegrationCard'
+
+@fake.login()
+export default class RootSkillViewTest extends AbstractGoogleTest {
+    private static vc: SpyRootSkillView
+    private static fakedIntegrations: PublicHomeIntegration[] = []
+    protected static names: string[] = []
+
+    protected static async beforeEach(): Promise<void> {
+        await super.beforeEach()
+
+        this.fakedIntegrations = []
+        this.names = []
+
+        this.views.setController(
+            'google.add-home-integration-card',
+            SpyAddHomeIntegrationCard
+        )
+        this.views.setController('active-record-card', MockActiveRecordCard)
+        this.views.setController('google.root', SpyRootSkillView)
+        this.vc = this.views.Controller('google.root', {}) as SpyRootSkillView
+
+        await this.eventFaker.fakeListHomeIntegrations(() => {
+            return this.fakedIntegrations
+        })
+
+        await this.eventFaker.fakeDeleteHomeIntegration()
+    }
+
+    @test()
+    protected static async rendersACard() {
+        vcAssert.assertSkillViewRendersCard(this.vc, 'home-cloud-integrations')
+    }
+
+    @test()
+    protected static async cardRendersList() {
+        activeRecordCardAssert.skillViewRendersActiveRecordCard(this.vc)
+    }
+
+    @test()
+    protected static async requiresLogin() {
+        await vcAssert.assertLoginIsRequired(this.vc)
+    }
+
+    @test()
+    protected static async returnsAListOfIntegrations() {
+        const integration = this.seedIntegration()
+        await this.load()
+        this.assertRendersIntegrationRow(integration.id)
+    }
+
+    @test()
+    protected static async homeIntegrationsCardRendersExpectedButtons() {
+        buttonAssert.cardRendersButtons(this.homeIntegrationsCardVc, [
+            'instructions',
+            'add',
+        ])
+    }
+
+    @test()
+    protected static async clickingAddIntegrationRendersDialog() {
+        await this.loadClickAddAndAssertRendersDialog()
+    }
+
+    @test()
+    protected static async callingOnDoneInAddCardHidesDialog() {
+        const { addCardVc, dialogVc } =
+            await this.loadClickAddAndAssertRendersDialog()
+        await addCardVc.simulateClickDone()
+
+        assert.isFalse(dialogVc.getIsVisible())
+    }
+
+    @test()
+    protected static async eachRowRendersDeleteButton() {
+        const integration = await this.seedOneIntegrationAndLoad()
+
+        this.homeIntegrationsCardVc.assertRowRendersButton(
+            integration.id,
+            'delete'
+        )
+    }
+
+    @test()
+    protected static async clickingDeleteButtonRendersAlert() {
+        await this.seedLoadClickDeleteAndAssertConfirm()
+    }
+
+    @test()
+    protected static async clickingDeleteAndConfirmingRemovesRow() {
+        const integration = await this.seedLoadClickDeleteAndConfirm()
+        this.homeIntegrationsCardVc.assertDoesNotRenderRow(integration.id)
+    }
+
+    @test()
+    protected static async doesNotRefreshListIfUserCancels() {
+        const int = await this.seedLoadClickDeleteAndDecline()
+
+        this.assertRendersIntegrationRow(int.id)
+    }
+
+    @test()
+    protected static async confirmingDeleteShouldEmitDeleteEvent() {
+        let passedTarget:
+            | DeleteHomeIntergrationTargetAndPayload['target']
+            | undefined
+
+        await this.eventFaker.fakeDeleteHomeIntegration(({ target }) => {
+            passedTarget = target
+        })
+
+        const integration = await this.seedLoadClickDeleteAndConfirm()
+
+        assert.isEqualDeep(passedTarget, {
+            integrationId: integration.id,
+        })
+    }
+
+    @test()
+    protected static async doesNotEmitEventIfDeclined() {
+        await eventFaker.makeEventThrow(
+            'google.delete-home-integration::v2025_02_08'
+        )
+
+        await this.seedLoadClickDeleteAndDecline()
+    }
+
+    private static async loadClickAddAndAssertRendersDialog() {
+        await this.load()
+        const dialogVc = await vcAssert.assertRendersDialog(this.vc, () =>
+            interactor.clickButton(this.homeIntegrationsCardVc, 'add')
+        )
+
+        const addCardVc = vcAssert.assertRendersAsInstanceOf(
+            dialogVc,
+            AddHomeIntegrationCardViewController
+        ) as SpyAddHomeIntegrationCard
+        return { dialogVc, addCardVc }
+    }
+
+    private static async seedLoadClickDeleteAndConfirm() {
+        const { confirmVc, integration } =
+            await this.seedLoadClickDeleteAndAssertConfirm()
+
+        await confirmVc.accept()
+
+        return integration
+    }
+
+    private static async seedLoadClickDeleteAndDecline() {
+        const { confirmVc, integration } =
+            await this.seedLoadClickDeleteAndAssertConfirm()
+
+        const int = integration
+
+        await confirmVc.decline()
+        return int
+    }
+
+    private static assertRendersIntegrationRow(id: string) {
+        this.homeIntegrationsCardVc.assertRendersRow(id)
+    }
+
+    private static async seedLoadClickDeleteAndAssertConfirm() {
+        const integration = await this.seedOneIntegrationAndLoad()
+
+        const confirmVc = await vcAssert.assertRendersConfirm(this.vc, () =>
+            interactor.clickButtonInRow(this.listVc, integration.id, 'delete')
+        )
+        return { confirmVc, integration }
+    }
+
+    private static get listVc() {
+        return this.homeIntegrationsCardVc.getListVc()
+    }
+
+    private static async seedOneIntegrationAndLoad() {
+        const integration = this.seedIntegration()
+        await this.load()
+        return integration
+    }
+
+    private static seedIntegration() {
+        const integration: PublicHomeIntegration = {
+            description: generateId(),
+            id: generateId(),
+            name: generateId(),
+        }
+
+        this.fakedIntegrations.push(integration)
+        return integration
+    }
+
+    private static async load() {
+        await this.views.load(this.vc)
+    }
+
+    private static get homeIntegrationsCardVc() {
+        return this.vc.getHomeIntegrationsCardVc()
+    }
+}
+
+class SpyRootSkillView extends RootSkillViewController {
+    public getHomeIntegrationsCardVc() {
+        return this.activeRecordCardVc as MockActiveRecordCard
+    }
+}

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

@@ -0,0 +1,50 @@
+import { namesUtil } from '@sprucelabs/spruce-skill-utils'
+
+export function generateExpectedInstanceTestContents(name: string) {
+    const pascal = namesUtil.toPascal(name)
+    const camel = namesUtil.toCamel(name)
+
+    return `import { fake } from '@sprucelabs/spruce-test-fixtures'
+import AbstractSpruceTest, { test, suite, assert } from '@sprucelabs/test-utils'
+
+@fake.login()
+@suite()
+export default class ${pascal}Test extends AbstractSpruceTest {
+	@test()
+	protected async canCreate${pascal}() {
+		const ${camel} = new ${pascal}()
+		assert.isTruthy(${camel})
+	}
+
+	@test()
+	protected async yourNextTest() {
+		assert.isTrue(false)
+	}
+}
+
+class ${pascal} {}`
+}
+
+export function generateExpectedStaticTestContents(name: string) {
+    const pascal = namesUtil.toPascal(name)
+    const camel = namesUtil.toCamel(name)
+
+    return `import { fake } from '@sprucelabs/spruce-test-fixtures'
+import AbstractSpruceTest, { test, assert } from '@sprucelabs/test-utils'
+
+@fake.login()
+export default class ${pascal}Test extends AbstractSpruceTest {
+	@test()
+	protected static async canCreate${pascal}() {
+		const ${camel} = new ${pascal}()
+		assert.isTruthy(${camel})
+	}
+
+	@test()
+	protected static async yourNextTest() {
+		assert.isTrue(false)
+	}
+}
+
+class ${pascal} {}`
+}

package/src/__tests__/behavioral/versions/ResolvingVersions.test.ts

@@ -47,7 +47,6 @@ export default class ResolvingVersionsTest extends AbstractSkillTest {
 
     @test()
     protected static async addsVersionFromPackageJsonWhenChoosingDifferentVersion() {
-        debugger
         await this.resolveAndAssertChoices([
             this.newVersionChoice,
             this.buildVersionChoice('v2023_09_16'),
@@ -56,9 +55,8 @@ export default class ResolvingVersionsTest extends AbstractSkillTest {
 
     @test()
     protected static async doesNotAddVersionToChoicesIfDirMatchesVersion() {
-        debugger
         this.createVersionDir('v2023_09_16')
-        debugger
+
         await this.resolveAndAssertChoices([
             this.newVersionChoice,
             this.buildVersionChoice('v2023_09_16'),

package/src/__tests__/implementation/OrganizationStore.test.ts

@@ -26,7 +26,9 @@ export default class OrganizationStoreTest extends AbstractCliTest {
         assert.isFalse(isInstalled)
     }
 
-    @test()
+    @test.skip(
+        'conflicting with "InstallingASkillAtAnOrg which is deleting orgs'
+    )
     protected static async canDeleteOrg() {
         await this.FeatureFixture().installCachedFeatures('organizations')
 
@@ -68,7 +70,9 @@ export default class OrganizationStoreTest extends AbstractCliTest {
         assert.isTrue(isInstalled)
     }
 
-    @test()
+    @test.skip(
+        'is conflicting with "InstallingASkillAtAnOrg" which is deleting orgs'
+    )
     protected static async canGetMyOrgs() {
         await this.FeatureFixture().installCachedFeatures('organizations')
 

package/src/__tests__/testDirsAndFiles/static_test_migration_1/src/__tests__/AnotherStaticTest.test.ts

@@ -0,0 +1,33 @@
+import { fake } from '@sprucelabs/spruce-test-fixtures'
+import AbstractSpruceTest, {
+    test,
+    assert,
+    errorAssert,
+} from '@sprucelabs/test-utils'
+
+@fake.login()
+export default class StaticTestFinderTest extends AbstractSpruceTest {
+    @test()
+    protected static async throwsWithMissing() {
+        const finder = StaticTestFinder.Finder()
+        const err = await assert.doesThrowAsync(() => finder.find())
+        errorAssert.assertError(err, 'MISSING_PARAMETERS', {
+            parameters: ['lookupDir'],
+        })
+    }
+
+    @test()
+    protected static async yourNextTest() {
+        assert.isTrue(false)
+    }
+}
+
+class StaticTestFinder {
+    public static Finder() {
+        return new this()
+    }
+
+    public async find() {
+        // assertOptions({}, ['lookupDir'])
+    }
+}

package/src/__tests__/testDirsAndFiles/static_test_migration_1/src/__tests__/StaticTest1.test.ts

@@ -0,0 +1,33 @@
+import { fake } from '@sprucelabs/spruce-test-fixtures'
+import AbstractSpruceTest, {
+    test,
+    assert,
+    errorAssert,
+} from '@sprucelabs/test-utils'
+
+@fake.login()
+export default class StaticTestFinderTest extends AbstractSpruceTest {
+    @test()
+    protected static async throwsWithMissing() {
+        const finder = StaticTestFinder.Finder()
+        const err = await assert.doesThrowAsync(() => finder.find())
+        errorAssert.assertError(err, 'MISSING_PARAMETERS', {
+            parameters: ['lookupDir'],
+        })
+    }
+
+    @test()
+    protected static async yourNextTest() {
+        assert.isTrue(false)
+    }
+}
+
+class StaticTestFinder {
+    public static Finder() {
+        return new this()
+    }
+
+    public async find() {
+        // assertOptions({}, ['lookupDir'])
+    }
+}