Update spectron app handler to pick VSCode window #744
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright (c) 2018, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * Licensed under the BSD 3-Clause license. | ||
| * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
| import { Extension } from 'vscode'; | ||
| export class MockApexExtension implements Extension<any> { | ||
| constructor() { | ||
| this.id = 'salesforce.salesforcedx-vscode-apex'; | ||
| this.extensionPath = 'extension/local/path'; | ||
| this.isActive = true; | ||
| this.exports = new MockJorje(); | ||
| } | ||
| public id: string; | ||
| public extensionPath: string; | ||
| public isActive: boolean; | ||
| public packageJSON: any; | ||
| public activate(): Thenable<any> { | ||
| return Promise.resolve('activated'); | ||
| } | ||
| public exports: any; | ||
| } | ||
|
|
||
| class MockJorje { | ||
| constructor() {} | ||
| public getLineBreakpointInfo(): Promise<{}> { | ||
| const response = [ | ||
| { | ||
| uri: '/force-app/main/default/classes/A.cls', | ||
| typeref: 'A', | ||
| lines: [2, 5, 6, 7] | ||
| } | ||
| ]; | ||
| return Promise.resolve(response); | ||
| } | ||
|
|
||
| public isLanguageClientReady() { | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright (c) 2018, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * Licensed under the BSD 3-Clause license. | ||
| * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
| import { Extension } from 'vscode'; | ||
| export class MockApexExtension implements Extension<any> { | ||
| constructor() { | ||
| this.id = 'salesforce.salesforcedx-vscode-apex'; | ||
| this.extensionPath = 'extension/local/path'; | ||
| this.isActive = true; | ||
| this.exports = new MockJorje(); | ||
| } | ||
| public id: string; | ||
| public extensionPath: string; | ||
| public isActive: boolean; | ||
| public packageJSON: any; | ||
| public activate(): Thenable<any> { | ||
| return Promise.resolve('activated'); | ||
| } | ||
| public exports: any; | ||
| } | ||
|
|
||
| class MockJorje { | ||
| constructor() {} | ||
| public getLineBreakpointInfo(): Promise<{}> { | ||
| const response = [ | ||
| { | ||
| uri: '/force-app/main/default/classes/A.cls', | ||
| typeref: 'A', | ||
| lines: [2, 5, 6, 7] | ||
| } | ||
| ]; | ||
| return Promise.resolve(response); | ||
| } | ||
|
|
||
| public isLanguageClientReady() { | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -120,15 +120,28 @@ export class SpectronApplication { | |
| private async checkWindowReady(): Promise<any> { | ||
| await this.webclient.waitUntilWindowLoaded(60000); | ||
|
|
||
| // Pick the window that loads VSCode, | ||
| // added code to address Spectron limitation in Windows OS (https://github.com/electron/spectron/issues/60) | ||
| const count = await this.webclient.getWindowCount(); | ||
| if (count > 1) { | ||
| for (let i = 0; i < count; i++) { | ||
| await this.webclient.windowByIndex(i); | ||
| const title = await this.webclient.getTitle(); | ||
|
|
||
| if ( | ||
| process.platform === 'win32' && | ||
|
There was a problem hiding this comment. NodeJs always returns |
||
| title !== '' && | ||
| /Visual Studio Code/.test(title) | ||
|
There was a problem hiding this comment. We could do without this check but wanted to make sure we look for the vscode window in case the empty terminals start returning a title (currently they return an empty title). |
||
| ) { | ||
| break; | ||
| } else if ( | ||
| /bootstrap\/index\.html/.test(await this.webclient.getUrl()) | ||
| ) { | ||
| break; | ||
| } | ||
| } | ||
| } else { | ||
| await this.webclient.windowByIndex(0); | ||
| } | ||
|
|
||
| await this.waitFor(this.spectron.client.getHTML, '.monaco-workbench'); | ||
|
|
@@ -177,8 +190,8 @@ export class SpectronApplication { | |
| await this.screenshot.capture(); | ||
| rej( | ||
| `Could not retrieve the element in ${this.testRetry * | ||
| this.pollTrials * | ||
| this.pollTimeout} seconds. (${JSON.stringify(args)})` | ||
| ); | ||
| break; | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be a basic question, but why is the window that we want in focus during the Spectron test going to be named "...bootstrap/index.html"? Is that a Spectron convention?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That has to do with how spectron loads the vscode window, it's normally a file path that represents the local vscode location being used.
I think the path might've changed with vscode moving to a newer electron version (now we get something like
electron-browser/workbench/workbench.html) but I was only able to test in Windows and Mac OS so I kept this for now.