New implementation for TEST.SUBPROGRAM autocompletion #195

Den1552 · 2024-09-06T11:46:28Z

Summary:

This implementation should provide an autocompletion list for TEST.SUBPROGRAM without using the fake TEST.VALUE line described in #170.

Explanation:

In order to get the autocompletion list for TEST.SUBPROGRAM, we need the <unit> from TEST.UNIT.
This is retrieved with getNearest() in tstCompletion.ts.
This <unit> is sent as an additional parameter to the Python logic.
In processSubprogramLines() (tstUtilities.py), we use this <unit> to retrieve, with getFunctions(), the autocompletion list of all the functions in this unit from the DataAPI.
At the end, we add SUBPROGRAM-specific autocompletions like <<INIT>>, <<COMPOUND>>, <<coded_tests_driver>>.

Basically, the implementation works. However, we need to answer some questions:

Questions:

Passing this argument into getChoiceDataFromPython is straightforward, but how about the "server-side" autocompletion retrieval in getChoiceDataFromServer()?

vector-vscode-vcast/server/pythonUtilities.ts

Line 101 in 2992c9e

export async function getChoiceDataFromServer(
What about the SUBPROGRAM-specific autocompletions (<<INIT>>, <<COMPOUND>>, coded_tests_driver)?
Is it all right to add them like that in processSubprogramLines(), or should this also be retrieved from the DataAPI somehow?

## Summary Enhanced `launch.json.example` by adding a new debugger configuration for VectorCAST unit tests.

## Summary Added tests to get back to 100% coverage. ## Changed - Added exports to functions in `vcast-server-test.ts `to enable testing - Enhanced test for `transmitCommand()`

moved some of the common functions and global objects there.

when we ping. Now that we have this version, we check that the extension vcast version matches the server when we initialize. Made the extension version computation a stand-alone function Only compute the extension version once on startup and when the extension option for vcast installation changes. Only missing piece is to send the update the LSP with the server state

enviro data server and not. This allows the auto-complete stuff to work seemlessly

## Summary `serverIsAlive()` now requires a `text` field in the response. Since we mock the server fetch, I added a text field including `clicast-path` so that the split operation does not fail. https://github.com/vectorgrp/vector-vscode-vcast/blob/3d64e64ad7b1c88837de7b48c19666e102c60ac7/src-common/vcastServer.ts#L143

johnpaliotta

Some very quick comments ...
Seems like some improvements could be made!

Thanks.

johnpaliotta · 2024-09-10T20:33:25Z

python/testEditorInterface.py

@@ -33,7 +33,7 @@ def main():
    # We get here when the user types a "." or ":"

    # argv has the name of the script as arg 1 and then user args
-    if len(sys.argv) == 4:
+    if ((len(sys.argv) == 4) or (len(sys.argv) == 5)):


@aytey
These are very quick comments, as it is the end of the day and I don't have time to look at this thoroughly

This is not good, the check for 4 was to validate that the number of args was correct for the call, just slapping 5 here makes no sense, and also invalidates the else below which says 3 args are expected.

Refactored to argument parser in 78bf51f .

johnpaliotta · 2024-09-10T20:33:52Z

python/testEditorInterface.py

+        additionalParams = None
+
+        if(len(sys.argv) == 5):
+            # Additional autocompletion params


Do not write comments like this, what is saved in arg5?

johnpaliotta · 2024-09-10T20:34:36Z

python/testEditorInterface.py

@@ -52,7 +58,7 @@ def main():
                choiceData = choiceDataType()

        elif mode == "choiceList-tst":
-            choiceData = processTstLine(enviroName, inputLine)
+            choiceData = processTstLine(enviroName, inputLine, additionalParams)


I don't even understand what is being done here yet but adding a new parameter cannot be the best way to do this

I thought this would be the best way since

I need the unit to get all the functions for the TEST.SUBPROGRAM with getFunctions().

The changes are not really huge

I brainstormed some ideas in the notes here:
#193

I initially implemented Idea 1) because I believed it was the best option. However, if you'd like, I can review it again.

johnpaliotta · 2024-09-10T20:38:50Z

python/tstUtilities.py

@@ -417,6 +417,29 @@ def processRequirementLines(api, pieces, triggerCharacter):

    return returnData

+def processSubprogramLines(api, pieces, triggerCharacter, additionalParams):


Ok so if you are only using this to pass the unit name, then change all of the parameter names etc to unitName, not additionalParams. Additionally additionalParams is a bad name because there is only one right?

At the moment, we would only need the <unit>, but I thought to make it as an object so that for future implementations I can simply add new params to this JSON.

I changed it now to be only unit. In case we will need more, I could enhance it.

johnpaliotta · 2024-09-10T20:44:30Z

python/testEditorInterface.py

@@ -43,6 +43,12 @@ def main():
        # Contents of the line from the editor so far


You probably did not want to tear this completely apart but I would probably convert this to use argparse now and have named parameters like --mode, --enviroName, --inputLine, --unit etc. and make unit optional, the others required.

(if it turns out we need unitName ... which it might)

Refactored to argument parser in 78bf51f .

johnpaliotta · 2024-09-10T20:45:57Z

server/tstCompletion.ts

-    const { stdout } = await execAsync(getCodedTestsSupportCommand, {
-      cwd: enviroPath,
-    });
+  const { stdout, stderr } = await execAsync(getCodedTestsSupportCommand, {


Add a (meaningful) comment

Added in c73e858 .

johnpaliotta · 2024-09-10T20:46:36Z

server/tstCompletion.ts

        );
+        console.log("++++++++++++++++++++++++++++++");


Removed in 78bf51f.

johnpaliotta · 2024-09-10T20:47:16Z

server/tstCompletion.ts

        returnData.extraText = choiceData.extraText;
        returnData.messages = choiceData.messages;
        choiceKind = choiceData.choiceKind;
        // append actual choices to the default INIT and COMPOUND
-        choiceArray = choiceArray.concat(choiceData.choiceList);
+        // choiceArray = choiceArray.concat(choiceData.choiceList);


Why iis this commented out?

I am sorry it was only a Draft so I didn't delete pieces of the "old" code in case you do not like my idea how I solved it. Removed in 78bf51f .

johnpaliotta · 2024-09-10T20:47:23Z

server/tstCompletion.ts

        // <<GLOBAL>> is valid on VALUE lines but not as a function name!
-        choiceArray = filterArray(choiceArray, "<<GLOBAL>>");
+        // choiceArray = filterArray(choiceArray, "<<GLOBAL>>");


Removed in 78bf51f .

Den1552 and others added 17 commits September 3, 2024 07:58

Added unit tests debugger in launch.json.example (#190)

e643e92

## Summary Enhanced `launch.json.example` by adding a new debugger configuration for VectorCAST unit tests.

Merge remote-tracking branch 'origin/main' into clicast_server

4f77e92

Added tests for clicast_server coverage (#189)

54a2b8f

## Summary Added tests to get back to 100% coverage. ## Changed - Added exports to functions in `vcast-server-test.ts `to enable testing - Enhanced test for `transmitCommand()`

Created a new pythonUtilities.py file to replace vTestUtilities.py and

33ce64f

moved some of the common functions and global objects there.

Re-org of code to isolate the clicastInstance processing

ab41d0d

Some re-org and renames

4e04cc6

Only open the dataAPI once for the work we need to do for getEnviroData

d8420ef

Added a completion test for coded mocks

3f08697

Make calls to dataAPI to get the unit test API handle consistent

2cb2dc5

Initial commit to refactor subprogram autocompletion.

d9d321f

Let the language server know when we switch between using the

c89e0af

enviro data server and not. This allows the auto-complete stuff to work seemlessly

Updated assert for server tests

b5a26cc

Update comments

3d64e64

Implemented autocompletion for SUBPROGRAM from idea 1 in #193

b88fe70

Adjusted tests so that they do not fail.

a20f2e3

Den1552 requested a review from Zbigor September 6, 2024 11:46

Den1552 self-assigned this Sep 6, 2024

Den1552 changed the title ~~Refactor subprogram autocompletion unit param~~ Refactor subprogram autocompletion based on #193 Sep 6, 2024

Den1552 changed the title ~~Refactor subprogram autocompletion based on #193~~ Refactor SUBPROGRAM autocompletion based on #193 Sep 6, 2024

Den1552 changed the title ~~Refactor SUBPROGRAM autocompletion based on #193~~ Refactored SUBPROGRAM autocompletion based on #193 Sep 6, 2024

johnpaliotta added 6 commits September 6, 2024 11:49

Found typo in check for failed test

6de0a83

Fixed bug with error codes from executing a test

60dae6e

Comments

9213edb

Fixed a bug with clicast instance management

dbe7dc2

Get rid of TBDs and unused functions

2cc8cce

Comment out server usage for release

9e4bc51

johnpaliotta reviewed Sep 10, 2024

View reviewed changes

johnpaliotta changed the title ~~Refactored SUBPROGRAM autocompletion based on #193~~ New implementation for TEST.SUBPROGRAM autocompletion Sep 10, 2024

Den1552 added 4 commits September 11, 2024 09:42

Addressed PR comments.

78bf51f

Minor refactoring

c73e858

Merge clicast_server into refactor_subprogram_autocompletion_unit_param

68b0921

Refactored argparser.

8bef2b5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New implementation for TEST.SUBPROGRAM autocompletion #195

New implementation for TEST.SUBPROGRAM autocompletion #195

Den1552 commented Sep 6, 2024 •

edited

Loading

johnpaliotta left a comment

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024 •

edited

Loading

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

johnpaliotta Sep 10, 2024

Den1552 Sep 11, 2024

		@@ -417,6 +417,29 @@ def processRequirementLines(api, pieces, triggerCharacter):

		return returnData

		def processSubprogramLines(api, pieces, triggerCharacter, additionalParams):

		@@ -43,6 +43,12 @@ def main():
		# Contents of the line from the editor so far

New implementation for TEST.SUBPROGRAM autocompletion #195

Are you sure you want to change the base?

New implementation for TEST.SUBPROGRAM autocompletion #195

Conversation

Den1552 commented Sep 6, 2024 • edited Loading

Summary:

Explanation:

Questions:

johnpaliotta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Den1552 Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Den1552 commented Sep 6, 2024 •

edited

Loading

Den1552 Sep 11, 2024 •

edited

Loading