tests(codewhisperer): add more unit tests #3195

* add basicCommands security scan tests

* add authUtil tests (WIP)

* initial showSsoPrompt test + cleanup

* add export awsIdSignIn

* additional inlineCompletionService tests

* add CWInlineCompletionProvider tests

* export CWInlineCompletionItemProvider to enable testing

* fix failing tests

* skip tests failing macOS nodejs (16.x, minimum) tests

* add backend.ts tests and fix failing securityScan test

* add showConnectionPrompt test

* codewhisperer explorer node tests

* securityPanelViewProvider tests + additional authUtil test

* cleanup authUtil per team comments

* additional authUtil test updates

* refactor and cleanup

* remove test causing other tests to fail

* remove inlineCompletionService tests that were failing macOS nodejs minimum tests

* fix/remove failing tests

Author: crossrac

src/codewhisperer/service/inlineCompletionService.ts

@@ -23,7 +23,7 @@ import globals from '../../shared/extensionGlobals'
 import { AuthUtil } from '../util/authUtil'
 import { shared } from '../../shared/utilities/functionUtils'
 
-class CWInlineCompletionItemProvider implements vscode.InlineCompletionItemProvider {
+export class CWInlineCompletionItemProvider implements vscode.InlineCompletionItemProvider {
     private activeItemIndex: number | undefined
     public nextMove: number
 

src/codewhisperer/util/showSsoPrompt.ts

@@ -57,7 +57,7 @@ export const showConnectionPrompt = async () => {
     }
 }
 
-async function awsIdSignIn() {
+export async function awsIdSignIn() {
     getLogger().info('selected AWS ID sign in')
     try {
         await AuthUtil.instance.connectToAwsBuilderId()

src/test/codewhisperer/commands/basicCommands.test.ts

@@ -5,15 +5,20 @@
 
 import * as vscode from 'vscode'
 import * as assert from 'assert'
-import { beforeEach } from 'mocha'
 import * as sinon from 'sinon'
+import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
 import { resetCodeWhispererGlobalVariables } from '../testUtil'
 import { assertTelemetryCurried } from '../../testUtil'
-import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
-import { toggleCodeSuggestions, get, set } from '../../../codewhisperer/commands/basicCommands'
-import { FakeMemento } from '../../fakeExtensionContext'
+import { toggleCodeSuggestions, get, set, showSecurityScan } from '../../../codewhisperer/commands/basicCommands'
+import { FakeMemento, FakeExtensionContext } from '../../fakeExtensionContext'
 import { testCommand } from '../../shared/vscode/testUtils'
 import { Command } from '../../../shared/vscode/commands2'
+import { SecurityPanelViewProvider } from '../../../codewhisperer/views/securityPanelViewProvider'
+import { DefaultCodeWhispererClient } from '../../../codewhisperer/client/codewhisperer'
+import { stub } from '../../utilities/stubber'
+import { AuthUtil } from '../../../codewhisperer/util/authUtil'
+import { getTestWindow } from '../../shared/vscode/window'
+import { ExtContext } from '../../../shared/extensions'
 
 describe('CodeWhisperer-basicCommands', function () {
     let targetCommand: Command<any> & vscode.Disposable
@@ -86,4 +91,44 @@ describe('CodeWhisperer-basicCommands', function () {
             })
         })
     })
+
+    describe('showSecurityScan', function () {
+        let mockExtensionContext: vscode.ExtensionContext
+        let mockSecurityPanelViewProvider: SecurityPanelViewProvider
+        let mockClient: DefaultCodeWhispererClient
+        let mockExtContext: ExtContext
+        
+        beforeEach(async function () {
+            resetCodeWhispererGlobalVariables()
+            mockExtensionContext = await FakeExtensionContext.create()
+            mockSecurityPanelViewProvider = new SecurityPanelViewProvider(mockExtensionContext)
+            mockClient = stub(DefaultCodeWhispererClient)
+            mockExtContext = await FakeExtensionContext.getFakeExtContext()
+        })
+
+        afterEach(function () {
+            targetCommand?.dispose()
+            sinon.restore()
+        })
+
+        it('prompts user to reauthenticate if connection is expired', async function () {            
+            targetCommand = testCommand(showSecurityScan, mockExtContext, mockSecurityPanelViewProvider, mockClient)
+            
+            sinon.stub(AuthUtil.instance, 'isConnectionExpired').returns(true)
+            const spy = sinon.stub(AuthUtil.instance, 'showReauthenticatePrompt')
+
+            await targetCommand.execute()
+            assert.ok(spy.called)
+        })
+
+        it('shows information message if there is no active text editor', async function () {            
+            targetCommand = testCommand(showSecurityScan, mockExtContext, mockSecurityPanelViewProvider, mockClient)
+            
+            sinon.stub(AuthUtil.instance, 'isConnectionExpired').returns(false)
+            
+            assert.ok(vscode.window.activeTextEditor === undefined)
+            await targetCommand.execute()
+            assert.strictEqual(getTestWindow().shownMessages[0].message, "Open a valid file to scan.")
+        })    
+    })
 })

src/test/codewhisperer/explorer/codewhispererChildrenNodes.test.ts

@@ -0,0 +1,65 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as assert from 'assert'
+import * as sinon from 'sinon'
+import { 
+    createEnableCodeSuggestionsNode,
+    createAutoSuggestionsNode, 
+    createOpenReferenceLogNode, 
+    createSecurityScanNode, 
+    createSsoSignIn, 
+    createLearnMore,
+    createFreeTierLimitMetNode 
+} from '../../../codewhisperer/explorer/codewhispererChildrenNodes'
+
+describe('codewhisperer children nodes', function () {
+    afterEach(function () {
+        sinon.restore()
+    })
+
+    it('should build enableCodeSuggestions command node', function () {
+        const node = createEnableCodeSuggestionsNode()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.enableCodeSuggestions')
+    })
+
+    it('should build toggleCodeSuggestions command node', function () {
+        const node = createAutoSuggestionsNode(true)
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.toggleCodeSuggestion')
+    })
+
+    it('should build showReferenceLog command node', function () {
+        const node = createOpenReferenceLogNode()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.openReferencePanel')
+    })
+
+    it('should build showSecurityScan command node', function () {
+        const node = createSecurityScanNode()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.security.scan')
+    })
+
+    it('should build showSsoSignIn command node', function () {
+        const node = createSsoSignIn()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.sso')
+    })
+
+    it('should build showLearnMore command node', function () {
+        const node = createLearnMore()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.learnMore')
+    })
+
+    it('should build showFreeTierLimit command node', function () {
+        const node = createFreeTierLimitMetNode()
+
+        assert.strictEqual(node.resource.id, 'aws.codeWhisperer.freeTierLimit')
+    })
+})
+    

src/test/codewhisperer/explorer/codewhispererNode.test.ts

@@ -0,0 +1,69 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as vscode from 'vscode'
+import * as assert from 'assert'
+import * as sinon from 'sinon'
+import { codewhispererNode } from '../../../codewhisperer/explorer/codewhispererNode'
+import { AuthUtil } from '../../../codewhisperer/util/authUtil' 
+
+describe('codewhispererNode', function () {
+    describe('getTreeItem', function () {
+        afterEach(function () {
+            sinon.restore()
+        })
+
+        it('should create a node with correct label and description', function () {
+            const node = codewhispererNode
+            const treeItem = node.getTreeItem()
+
+            assert.strictEqual(treeItem.label, 'CodeWhisperer (Preview)')
+            assert.strictEqual(treeItem.contextValue, 'awsCodeWhispererNode')
+            assert.strictEqual(treeItem.description, '')
+        })
+
+        it('should create a node showing AWS Builder ID connection', function () {
+            sinon.stub(AuthUtil.instance, 'isUsingSavedConnection').get(() => true)            
+            sinon.stub(AuthUtil.instance, 'isConnectionValid').resolves(true)
+            const node = codewhispererNode
+            const treeItem = node.getTreeItem()
+            
+            assert.strictEqual(treeItem.label, 'CodeWhisperer (Preview)')
+            assert.strictEqual(treeItem.contextValue, 'awsCodeWhispererNodeSaved')
+            assert.strictEqual(treeItem.description, 'AWS Builder ID Connected')
+            assert.strictEqual(treeItem.collapsibleState, vscode.TreeItemCollapsibleState.Collapsed)
+        })
+
+        it('should create a node showing enterprise SSO connection', function () {
+            sinon.stub(AuthUtil.instance, 'isUsingSavedConnection').get(() => true)            
+            sinon.stub(AuthUtil.instance, 'isConnectionValid').resolves(true)
+            sinon.stub(AuthUtil.instance, 'isEnterpriseSsoInUse').resolves(true)
+            const node = codewhispererNode
+            const treeItem = node.getTreeItem()
+           
+            assert.strictEqual(treeItem.label, 'CodeWhisperer (Preview)')
+            assert.strictEqual(treeItem.contextValue, 'awsCodeWhispererNodeSaved')
+            assert.strictEqual(treeItem.description, 'IAM Identity Center Connected')
+            assert.strictEqual(treeItem.collapsibleState, vscode.TreeItemCollapsibleState.Collapsed)
+        })
+    })
+
+    describe('getChildren', function () {
+        afterEach(function () {
+            sinon.restore()
+        })
+
+        it('should get correct child nodes if user is not connected', function () {
+            const node = codewhispererNode
+            const children = node.getChildren()
+            const ssoSignInNode = children.find(c => c.resource.id == 'aws.codeWhisperer.sso')
+            const learnMorenNode = children.find(c => c.resource.id == 'aws.codeWhisperer.learnMore')    
+
+            assert.strictEqual(children.length, 2)
+            assert.ok(ssoSignInNode)
+            assert.ok(learnMorenNode)
+        })   
+    })
+})

src/test/codewhisperer/service/inlineCompletionService.test.ts

@@ -6,8 +6,8 @@
 import * as vscode from 'vscode'
 import * as assert from 'assert'
 import * as sinon from 'sinon'
-import { InlineCompletionService } from '../../../codewhisperer/service/inlineCompletionService'
-import { createMockTextEditor, resetCodeWhispererGlobalVariables } from '../testUtil'
+import { InlineCompletionService, CWInlineCompletionItemProvider } from '../../../codewhisperer/service/inlineCompletionService'
+import { createMockTextEditor, resetCodeWhispererGlobalVariables, createMockDocument } from '../testUtil'
 import { ReferenceInlineProvider } from '../../../codewhisperer/service/referenceInlineProvider'
 import { RecommendationHandler } from '../../../codewhisperer/service/recommendationHandler'
 import * as codewhispererSdkClient from '../../../codewhisperer/client/codewhisperer'
@@ -93,6 +93,8 @@ describe('inlineCompletionService', function () {
                 { content: "\n\t\tconsole.log('Hello world!');\n\t}" },
                 { content: '' },
             ]
+
+            assert.ok(RecommendationHandler.instance.recommendations.length > 0)
             await InlineCompletionService.instance.clearInlineCompletionStates(createMockTextEditor())
             assert.strictEqual(ReferenceInlineProvider.instance.refs.length, 0)
             assert.strictEqual(RecommendationHandler.instance.recommendations.length, 0)
@@ -142,3 +144,36 @@ describe('inlineCompletionService', function () {
         })
     })
 })
+
+describe('CWInlineCompletionProvider', function () {
+    beforeEach(function () {
+        resetCodeWhispererGlobalVariables()
+    })
+
+    describe('provideInlineCompletionItems', function () {
+        beforeEach(function () {
+            resetCodeWhispererGlobalVariables()
+        })
+
+        afterEach(function () {
+            sinon.restore()
+        })
+
+        it('should return undefined if position is before RecommendationHandler start pos', async function () {
+            RecommendationHandler.instance.startPos = new vscode.Position(1, 1)
+            const position = new vscode.Position(0, 0)
+            const document = createMockDocument()
+            const fakeContext = {triggerKind: 0, selectedCompletionInfo: undefined}
+            const token = new vscode.CancellationTokenSource().token
+            const provider = new CWInlineCompletionItemProvider(0, 0)
+            const result = await provider.provideInlineCompletionItems(
+                document,
+                position,
+                fakeContext,
+                token
+            )
+          
+            assert.ok(result === undefined)
+        })
+    })
+})