Chore: Change the settings so the project scanner may work on different setups #13
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
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 |
|---|---|---|
|
|
@@ -42,14 +42,11 @@ export class BitBakeProjectScanner { | |
| private _classes: ElementInfo[] = new Array < ElementInfo >() | ||
| private _includes: ElementInfo[] = new Array < ElementInfo >() | ||
| private _recipes: ElementInfo[] = new Array < ElementInfo >() | ||
| private readonly _outputParser: OutputParser | ||
| private _shouldDeepExamine: boolean = false | ||
| private _pathToBuildFolder: string = 'build' | ||
| private _pathToEnvScript: string = 'oe-init-build-env' | ||
| private _pathToBitbakeFolder: string = 'bitbake' | ||
|
|
||
| constructor (connection: Connection) { | ||
| this._outputParser = new OutputParser(connection) | ||
|
|
@@ -80,48 +77,36 @@ export class BitBakeProjectScanner { | |
| return this._recipes | ||
| } | ||
|
|
||
| get shouldDeepExamine (): boolean { | ||
| return this._shouldDeepExamine | ||
| } | ||
|
|
||
| set shouldDeepExamine (shouldDeepExamine: boolean) { | ||
| this._shouldDeepExamine = shouldDeepExamine | ||
| } | ||
|
|
||
| get pathToBuildFolder (): string { | ||
| return this._pathToBuildFolder | ||
| } | ||
|
|
||
| set pathToBuildFolder (pathToBuildFolder: string) { | ||
| this._pathToBuildFolder = pathToBuildFolder | ||
| } | ||
|
|
||
| get pathToEnvScript (): string { | ||
| return this._pathToEnvScript | ||
| } | ||
|
|
||
| set pathToEnvScript (pathToEnvScript: string) { | ||
| this._pathToEnvScript = pathToEnvScript | ||
| } | ||
|
|
||
| get pathToBitbakeFolder (): string { | ||
| return this._pathToBitbakeFolder | ||
| } | ||
|
|
||
| set pathToBitbakeFolder (pathToBitbakeFolder: string) { | ||
| this._pathToBitbakeFolder = pathToBitbakeFolder | ||
| } | ||
|
|
||
| setProjectPath (projectPath: string): void { | ||
|
|
@@ -299,7 +284,7 @@ export class BitBakeProjectScanner { | |
| let parsingSuccess: boolean = true | ||
|
|
||
| try { | ||
| parsingOutput = this.executeCommandInBitBakeEnvironment('bitbake -p') | ||
idillon-sfl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } catch (error) { | ||
| if (typeof error !== 'string') { | ||
| throw error | ||
|
|
@@ -333,7 +318,7 @@ export class BitBakeProjectScanner { | |
| } | ||
| } | ||
|
|
||
| if (this._shouldDeepExamine) { | ||
| const recipesWithOutPath: ElementInfo[] = this._recipes.filter((obj: ElementInfo): boolean => { | ||
| return obj.path === undefined | ||
| }) | ||
|
|
@@ -400,68 +385,56 @@ export class BitBakeProjectScanner { | |
| } | ||
| } | ||
|
|
||
| private executeCommandInBitBakeEnvironment (command: string): string { | ||
| const scriptContent: string = this.generateBitBakeCommandScriptFileContent(command) | ||
| const pathToScriptFile: string = this._projectPath + '/' + this._pathToBuildFolder | ||
| const scriptFileName: string = pathToScriptFile + '/executeBitBakeCmd.sh' | ||
|
|
||
| if (!fs.existsSync(pathToScriptFile)) { | ||
| fs.mkdirSync(pathToScriptFile) | ||
| } | ||
| fs.writeFileSync(scriptFileName, scriptContent) | ||
| fs.chmodSync(scriptFileName, '0755') | ||
|
|
||
| return this.executeCommand(scriptFileName) | ||
| } | ||
|
|
||
| private executeCommand (command: string): string { | ||
| let stdOutput: string = '' | ||
| try { | ||
| if (this._projectPath !== null) { | ||
| const returnObject = execa.shellSync(command) | ||
| if (returnObject.status === 0) { | ||
| stdOutput = returnObject.stdout | ||
| } else { | ||
| const data: Buffer = fs.readFileSync(command) | ||
| logger.error('error on executing command: ' + data.toString()) | ||
| } | ||
| } | ||
| } catch (error: any) { | ||
|
There was a problem hiding this comment. I'm not sure we should catch the error here because we don't know how to handle it. All callers will also have to check for errors. Error handling should be done at the calling level that can recover, or abort and display an error message. There was a problem hiding this comment. This code is outdated, it does not exist anymore |
||
| logger.error(error) | ||
| } | ||
|
|
||
| return stdOutput | ||
| } | ||
|
|
||
| private generateBitBakeCommandScriptFileContent (bitbakeCommand: string): string { | ||
idillon-sfl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const scriptFileBuffer: string[] = [] | ||
|
|
||
| if (fs.existsSync(this._pathToEnvScript)) { | ||
| logger.info('using env script') | ||
| scriptFileBuffer.push('source ./' + this._pathToEnvScript + ' ' + this._pathToBuildFolder + ' > /dev/null') | ||
| } else { | ||
| logger.info('not using env script') | ||
| scriptFileBuffer.push( | ||
| `export PYTHONPATH=${this._pathToBitbakeFolder}/lib:$PYTHONPATH`, | ||
|
There was a problem hiding this comment. Why is this required? I have not yet encountered cases were I needed to tweak the PATH to run bitbake. This is usually done by oe_init_build_env. There was a problem hiding this comment. It is a fallback in case there is no environment script, so the extension still can attempt to work. Maybe it should just fail? There was a problem hiding this comment. Yes there will always be an environment file for calling bitbake. It is the recommended workflow. There was a problem hiding this comment. Understood. I'll make this work into this PR: #16 |
||
| `export PATH=${this._pathToBitbakeFolder}/bin:$PATH`, | ||
| `cd ${this.pathToBuildFolder}` | ||
| ) | ||
| } | ||
|
|
||
| scriptFileBuffer.push(bitbakeCommand) | ||
|
|
||
| return scriptFileBuffer.join('\n') | ||
| } | ||
| } | ||
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
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.
Maybe we can be more specific than "work properly". The extension highlighting works without for instance. Maybe just "For all the features to be enabled,"
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.
I'd also rephrase "it will make the following assumptions" -> "It will look for it at these default locations"
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.
Lets remove it it in PR #16