feat: Create command to run analysis vscode command via CLI/terminal #2368

mm-broadcom · 2024-07-02T12:40:57Z

Adds a new command to the command palette such that the user can easily trigger the analysis from the CLI. Handles both the Java and Native versions of the server along with saved and unsaved files.

How Has This Been Tested?

Functionality:

Open VS code with a cobol file open as the active file/editor
Press F1 to open the command palette
Type "cobol analysis" and select that command
Select either "Java" or "Native"
Press enter, see the output in the terminal window at the bottom. (Default UI location)

Tests created:

Cobol Analysis - Java: Tests when the user would have selected "Java" as the environment
Cobol Analysis - Native: Tests when the user would have selected "Native" as the environment
Cobol Analysis - Undefined Type: Tests when the user would have backed out of the command without selecting anything
Cobol Analysis - Save temp file: Tests what happens when the user tries to run the command on an unsaved file.
Various functions to test/determine functionality.

Checklist:

Each of my commits contains one meaningful change
I have performed rebase of my branch on top of the development
I have performed a self-review of my own code
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have checked my code and corrected any misspellings

Initial analysis CLI command which runs uses the Java backend in the CLI.

Added prompting so the user can choose between java and native builds to run. Initial start on supporting copybook config files as well.

Added temp/unsaved file support.

Added documentation for the various functions that were created while developing this feature.

Add multi-step UI input allowing the user to cancel out without the code moving onwards. Utilized a portion of Microsoft's vscode extension sample for QuickInput implementation. The license there is MIT, may need to add it to the extension's license file as well. Link: https://github.com/microsoft/vscode-extension-samples/tree/main/quickinput-sample

…ysis-vscode-command

Fixed function access

Due to changes of what is being requested, copybook support was commented out.

Removed fs-temp, replaced it with the VSCodeAPI to handle the file system for writing temporary files elsewhere for analysis.

Initial, working, version of a unit test for the RunAnalysisCLI class.

Expanded tests with more "expect" calls and also support for when the user tries to call it with native functionality.

Simplified/streamlined the UI code due to no longer needing a copybook handling step. Added more unit tests.

Add unit test for saving a temporary file.

…ysis-vscode-command

Fix build issue due to Prettier throwing an error.

Add more unit tests to increase coverage of branches and functions.

clients/cobol-lsp-vscode-extension/package-lock.json

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

Ran prettier

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

slavek-kucera · 2024-07-03T07:52:08Z

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

+  protected buildJavaCommand(currentFileLocation: string) {
+    const extensionFolder: string | undefined =
+      this.getExtensionPath() + "/server/jar/server.jar";
+
+    if (extensionFolder && currentFileLocation !== "") {
+      return (
+        'java -jar "' +
+        extensionFolder +
+        '" ' +
+        this.buildAnalysisCommandPortion(currentFileLocation)
+      );
+    }
+
+    return "";
+  }
+
+  /**
+   * Provides the portion of the command from "analysis" onwards.
+   * Is the same for both the Java and Native builds.
+   * @param currentFileLocation - Location of the main cobol file being analyzed.
+   * @protected
+   */
+  protected buildAnalysisCommandPortion(currentFileLocation: string) {
+    const copyBookCommand = `-cf=${
+      this.copybookConfigLocation === ""
+        ? "."
+        : '"' + this.copybookConfigLocation + '"'
+    }`;
+
+    return 'analysis -s "' + currentFileLocation + '" ' + copyBookCommand;
+  }


How seriously do we want to handle escaping in the command sent to the shell? @VitGottwald
Backslashes, percentage in windows shell, both $(pwd) and `pwd` are valid filenames both on linux and windows.

We generate the file name. So the only problem is the path to the folder provided by VS Code. And that depends on install location. So I would start with what is needed for standard install locations on windows/linux/mac.

Fixed saving temp files for analysis, addressed concerns raised in the PR, updated unit tests

Adds functionality to find or create a temp folder. If it exists, delete any files within. This is only ever used by the extension. Even in the result of the `context.globalStorageUri` being compromised, the inclusion of the `/tempAnalysisFiles` folder off of a given directory will stop unintended deletions.

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

clients/cobol-lsp-vscode-extension/src/__tests__/commands/RunAnalysisCLITest.spec.ts

Simplified the temp folder creation and improved the unit tests.

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

Co-authored-by: slavek-kucera <53339291+slavek-kucera@users.noreply.github.com>

Wrap the map function used to delete files with a `promise.all`.

…mm-broadcom/che-che4z-lsp-for-cobol into run-CLI-analysis-vscode-command

clients/cobol-lsp-vscode-extension/src/__tests__/commands/RunAnalysisCLITest.spec.ts

Cleaned up the tests to be more streamlined per suggestions on PR.

…ysis-vscode-command

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

clients/cobol-lsp-vscode-extension/src/__tests__/commands/RunAnalysisCLITest.spec.ts

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

Handle unsaved/remote files the same by saving the current text editor's contents to a local file first.

VitGottwald

LGTM. Please, add the option to disable diagnostics in the CLI analysis in the PR where that option is added.

Thank you!

mm-broadcom · 2024-07-11T16:28:33Z

Will do so once this PR is merged in. Should not take too long for me to implement. The PR Vit is referring to add the option to is #2379.

mm-broadcom added 15 commits June 24, 2024 08:39

Initial Analysis CLI command

7e8b2e2

Initial analysis CLI command which runs uses the Java backend in the CLI.

Add prompts, native builds, start copybook support

a8398d6

Added prompting so the user can choose between java and native builds to run. Initial start on supporting copybook config files as well.

Add temp/unsaved file support

3175a07

Added temp/unsaved file support.

Added documentation

4514a5b

Added documentation for the various functions that were created while developing this feature.

Merge remote-tracking branch 'upstream/development' into run-CLI-anal…

dddfad4

…ysis-vscode-command

Fixed function access

c6f5fb6

Fixed function access

Remove copybook support

c754939

Due to changes of what is being requested, copybook support was commented out.

Remove fs-temp, replace with VSCode API

e0f3eb6

Removed fs-temp, replaced it with the VSCodeAPI to handle the file system for writing temporary files elsewhere for analysis.

Initial Unit Test

9f31e77

Initial, working, version of a unit test for the RunAnalysisCLI class.

Expanded tests to include native call

2e993b9

Expanded tests with more "expect" calls and also support for when the user tries to call it with native functionality.

Simplified UI code, more unit tests

1a6d4eb

Simplified/streamlined the UI code due to no longer needing a copybook handling step. Added more unit tests.

Add Temp File Test

4f52896

Add unit test for saving a temporary file.

Merge remote-tracking branch 'upstream/development' into run-CLI-anal…

8a2f528

…ysis-vscode-command

Ran Prettier to fix format

b474d08

Fix build issue due to Prettier throwing an error.

VitGottwald requested review from slavek-kucera and ishche July 2, 2024 13:07

More unit tests

f8ce8d3

Add more unit tests to increase coverage of branches and functions.

slavek-kucera requested changes Jul 2, 2024

View reviewed changes

mm-broadcom added 2 commits July 2, 2024 12:08

Update package-lock.json

1bf16af

Fix dangling promise

6ca8d1f

mm-broadcom requested a review from slavek-kucera July 2, 2024 16:17

Ran prettier

6b0dfba

Ran prettier

slavek-kucera reviewed Jul 3, 2024

View reviewed changes

mm-broadcom added 3 commits July 3, 2024 11:47

Fixed temp file analysis, addressed PR requests

ce956ae

Fixed saving temp files for analysis, addressed concerns raised in the PR, updated unit tests

Use joinPath over string concatenation

c73d9f2

Update RunAnalysisCLITest.spec.ts

1a937f2

mm-broadcom requested a review from slavek-kucera July 3, 2024 16:18

slavek-kucera reviewed Jul 4, 2024

View reviewed changes

Simplified temp folder creation, better tests

eb4723c

Simplified the temp folder creation and improved the unit tests.

mm-broadcom requested a review from slavek-kucera July 5, 2024 12:59

Fixed Temp file unit test

8494062

slavek-kucera reviewed Jul 8, 2024

View reviewed changes

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts Outdated Show resolved Hide resolved

mm-broadcom and others added 3 commits July 8, 2024 08:20

Update clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts

d807b8b

Co-authored-by: slavek-kucera <53339291+slavek-kucera@users.noreply.github.com>

Wrap Map in Promise.all

597f962

Wrap the map function used to delete files with a `promise.all`.

Merge branch 'run-CLI-analysis-vscode-command' of https://github.com/…

453f33a

…mm-broadcom/che-che4z-lsp-for-cobol into run-CLI-analysis-vscode-command

mm-broadcom requested a review from slavek-kucera July 8, 2024 12:29

slavek-kucera reviewed Jul 8, 2024

View reviewed changes

Cleaned up tests

b245637

Cleaned up the tests to be more streamlined per suggestions on PR.

mm-broadcom requested a review from slavek-kucera July 8, 2024 13:08

Ran prettier

3f8fd6e

slavek-kucera approved these changes Jul 8, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/development' into run-CLI-anal…

7496cd6

…ysis-vscode-command

ishche removed their request for review July 10, 2024 08:03

ishche reviewed Jul 10, 2024

View reviewed changes

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts Outdated Show resolved Hide resolved

slavek-kucera reviewed Jul 10, 2024

View reviewed changes

clients/cobol-lsp-vscode-extension/src/__tests__/commands/RunAnalysisCLITest.spec.ts Outdated Show resolved Hide resolved

Update Copyright years

0024b25

VitGottwald reviewed Jul 11, 2024

View reviewed changes

clients/cobol-lsp-vscode-extension/src/commands/RunAnalysisCLI.ts Show resolved Hide resolved

Make temp file for any non-local source

4745793

Handle unsaved/remote files the same by saving the current text editor's contents to a local file first.

VitGottwald approved these changes Jul 11, 2024

View reviewed changes

VitGottwald merged commit eb2ae64 into eclipse-che4z:development Jul 11, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create command to run analysis vscode command via CLI/terminal #2368

feat: Create command to run analysis vscode command via CLI/terminal #2368

mm-broadcom commented Jul 2, 2024 •

edited

Loading

slavek-kucera Jul 3, 2024 •

edited

Loading

VitGottwald Jul 3, 2024

VitGottwald left a comment

mm-broadcom commented Jul 11, 2024

feat: Create command to run analysis vscode command via CLI/terminal #2368

feat: Create command to run analysis vscode command via CLI/terminal #2368

Conversation

mm-broadcom commented Jul 2, 2024 • edited Loading

How Has This Been Tested?

Checklist:

slavek-kucera Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

VitGottwald Jul 3, 2024

Choose a reason for hiding this comment

VitGottwald left a comment

Choose a reason for hiding this comment

mm-broadcom commented Jul 11, 2024

mm-broadcom commented Jul 2, 2024 •

edited

Loading

slavek-kucera Jul 3, 2024 •

edited

Loading