Skip to content

Commit 58a6bdc

Browse files
wenytang-msCopilot
wenytang-ms
and
Copilot
committed
refactor: test plans in repo, CLI from npm package
- Test plans live in vscode-java-pack repo (source of truth for this project) - CLI tool installed from npm: @vscjava/vscode-autotest - Updated test plans with all latest fixes (debug, resolve-type, etc.) - Removed npm package sync steps from workflow Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7854751 commit 58a6bdc

16 files changed

Lines changed: 1020 additions & 46 deletions

‎.github/workflows/e2e-autotest.yml‎

Lines changed: 9 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,13 @@ jobs:
1717
outputs:
1818
matrix: ${{ steps.scan.outputs.matrix }}
1919
steps:
20-
- name: Setup Node.js
21-
uses: actions/setup-node@v4
22-
with:
23-
node-version: 20
24-
25-
- name: Install autotest CLI
26-
run: npm install -g @vscjava/vscode-autotest
20+
- name: Checkout
21+
uses: actions/checkout@v4
2722

2823
- name: Scan test plans
2924
id: scan
3025
run: |
31-
pkg_dir=$(npm root -g)/@vscjava/vscode-autotest
32-
plans=$(ls "$pkg_dir"/test-plans/*.yaml | xargs -I{} basename {} .yaml | grep -v java-fresh-import | jq -R . | jq -sc .)
26+
plans=$(ls test-plans/*.yaml | xargs -I{} basename {} .yaml | grep -v java-fresh-import | jq -R . | jq -sc .)
3327
echo "matrix=$plans" >> "$GITHUB_OUTPUT"
3428
echo "Found plans: $plans"
3529
@@ -45,7 +39,7 @@ jobs:
4539
plan: ${{ fromJson(needs.discover.outputs.matrix) }}
4640

4741
steps:
48-
- name: Checkout vscode-java-pack (for local test-plans overlay)
42+
- name: Checkout
4943
uses: actions/checkout@v4
5044

5145
- name: Checkout vscode-java (test projects)
@@ -87,21 +81,6 @@ jobs:
8781
- name: Install autotest CLI
8882
run: npm install -g @vscjava/vscode-autotest
8983

90-
- name: Sync test plans from npm package
91-
shell: pwsh
92-
run: |
93-
$pkgDir = (npm root -g) + "/@vscjava/vscode-autotest"
94-
# Copy npm package test plans, then overlay with local test-plans (if any)
95-
$targetDir = "test-plans"
96-
if (!(Test-Path $targetDir)) { New-Item -ItemType Directory -Path $targetDir | Out-Null }
97-
Copy-Item "$pkgDir/test-plans/*.yaml" $targetDir -Force
98-
# Local test-plans in repo can override npm package versions
99-
if (Test-Path "test-plans-local") {
100-
Copy-Item "test-plans-local/*.yaml" $targetDir -Force
101-
}
102-
Write-Host "Test plans:"
103-
Get-ChildItem $targetDir -Filter "*.yaml" | ForEach-Object { Write-Host " $($_.Name)" }
104-
10584
- name: Run ${{ matrix.plan }}
10685
shell: pwsh
10786
env:
@@ -125,7 +104,7 @@ jobs:
125104
timeout-minutes: 30
126105

127106
steps:
128-
- name: Checkout vscode-java-pack
107+
- name: Checkout
129108
uses: actions/checkout@v4
130109

131110
- name: Checkout vscode-java
@@ -167,17 +146,6 @@ jobs:
167146
- name: Install autotest CLI
168147
run: npm install -g @vscjava/vscode-autotest
169148

170-
- name: Sync test plans from npm package
171-
shell: pwsh
172-
run: |
173-
$pkgDir = (npm root -g) + "/@vscjava/vscode-autotest"
174-
$targetDir = "test-plans"
175-
if (!(Test-Path $targetDir)) { New-Item -ItemType Directory -Path $targetDir | Out-Null }
176-
Copy-Item "$pkgDir/test-plans/*.yaml" $targetDir -Force
177-
if (Test-Path "test-plans-local") {
178-
Copy-Item "test-plans-local/*.yaml" $targetDir -Force
179-
}
180-
181149
- name: Run ${{ inputs.test_plan }}
182150
shell: pwsh
183151
env:
@@ -220,15 +188,10 @@ jobs:
220188
run: |
221189
mkdir -p test-results
222190
for dir in all-results/results-*/; do
223-
plan=$(basename "$dir" | sed 's/^results-//')
224-
if [ -d "$dir/$plan" ]; then
225-
cp -r "$dir/$plan" "test-results/$plan"
226-
elif [ -d "$dir" ]; then
227-
find "$dir" -name "results.json" -exec dirname {} \; | while read d; do
228-
name=$(basename "$d")
229-
cp -r "$d" "test-results/$name"
230-
done
231-
fi
191+
find "$dir" -name "results.json" -exec dirname {} \; | while read d; do
192+
name=$(basename "$d")
193+
cp -r "$d" "test-results/$name"
194+
done
232195
done
233196
echo "Organized results:"
234197
ls test-results/

‎test-plans/java-basic-editing.yaml‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# Test Plan: Java Basic (from vscode-java-pack.wiki)
2+
#
3+
# Source: wiki Test-Plan.md "Basic" scenario (Steps 1-8)
4+
# Verifies: LS ready → class snippet → Code Action → completion → Organize Imports → Rename
5+
#
6+
# Prerequisites:
7+
# - vscode-java repo cloned locally
8+
# - JDK installed
9+
#
10+
# Usage: autotest run test-plans/java-basic-editing.yaml
11+
12+
name: "Java Basic — Full Scenario (Steps 1-8)"
13+
description: |
14+
Wiki Basic scenario steps 1-8 in a single run:
15+
1-2: Open simple-app, verify LS ready with 2 errors
16+
3: Class snippet to fix Foo.java
17+
4: Code Action to create missing call() method
18+
5: Save all, verify 0 errors
19+
6: Type File code, verify completion
20+
7: Organize Imports (Shift+Alt+O)
21+
8: Rename Symbol (F2)
22+
23+
setup:
24+
extension: "redhat.java"
25+
extensions:
26+
- "vscjava.vscode-java-pack"
27+
vscodeVersion: "stable"
28+
workspace: "../../vscode-java/test/resources/projects/eclipse/simple-app"
29+
timeout: 60
30+
31+
steps:
32+
# ══════════════════════════════════════════════════════════
33+
# Steps 1-5: Diagnostics, Snippet, Code Action
34+
# ══════════════════════════════════════════════════════════
35+
36+
# ── Step 1: Project loaded ──────────────────────────────────
37+
- id: "project-loaded"
38+
action: "wait 5 seconds"
39+
verify: "Project file tree is visible"
40+
41+
# ── Step 2: LS ready + 2 errors ─────────────────────────────
42+
- id: "ls-ready"
43+
action: "waitForLanguageServer"
44+
verify: "Status bar shows Language Server is ready with 2 errors"
45+
verifyProblems:
46+
errors: 2
47+
timeout: 120
48+
49+
# ── Step 3: Class snippet in Foo.java ───────────────────────
50+
- id: "open-foo"
51+
action: "open file Foo.java"
52+
verify: "Foo.java is open in editor"
53+
timeout: 15
54+
55+
- id: "type-class-snippet"
56+
action: "typeAndTriggerSnippet class"
57+
verify: "Class skeleton generated via snippet"
58+
verifyEditor:
59+
contains: "public class Foo"
60+
timeout: 30
61+
62+
- id: "save-foo"
63+
action: "saveFile"
64+
verifyProblems:
65+
errors: 1
66+
timeout: 30
67+
68+
# ── Step 4: Code Action to create call() ────────────────────
69+
- id: "close-all-before-codeaction"
70+
action: "run command Workbench: Close All Editors"
71+
72+
- id: "navigate-to-error"
73+
action: "navigateToError 1"
74+
verify: "Cursor jumped to f.call() error in Bar.java"
75+
76+
- id: "apply-code-action"
77+
action: "applyCodeAction Create method 'call()'"
78+
verify: "Code Action created call() method in Foo.java"
79+
timeout: 15
80+
81+
# ── Step 5: Save all + verify 0 errors ──────────────────────
82+
- id: "save-all-step5"
83+
action: "run command File: Save All"
84+
verify: "All files saved, no compilation errors"
85+
verifyProblems:
86+
errors: 0
87+
timeout: 60
88+
89+
# ══════════════════════════════════════════════════════════
90+
# Steps 6-8: Completion, Organize Imports, Rename
91+
# ══════════════════════════════════════════════════════════
92+
93+
# Close all editors to prevent duplicate tab issues
94+
- id: "close-all-before-step6"
95+
action: "run command Workbench: Close All Editors"
96+
97+
# ── Step 6: Type File code ────────────────────────────────
98+
# Use insertLineInFile so LS properly detects the unresolved File type
99+
- id: "open-app"
100+
action: "open file App.java"
101+
verify: "App.java is open in editor"
102+
timeout: 10
103+
104+
- id: "insert-file-code"
105+
action: "insertLineInFile src/app/App.java 6 File f = new File(\"demo.txt\");"
106+
verifyEditor:
107+
contains: "File f = new File"
108+
verifyProblems:
109+
errors: 1
110+
atLeast: true
111+
timeout: 30
112+
113+
# ── Step 7: Organize Imports (Shift+Alt+O) ──────────────────
114+
- id: "organize-imports"
115+
action: "organizeImports"
116+
verify: "Organize Imports resolved File type"
117+
timeout: 15
118+
119+
# Save all — LS may write the import to a second tab (dual-tab issue on CI)
120+
# Verify via file on disk to bypass dual-tab problem
121+
- id: "save-after-organize"
122+
action: "run command File: Save All"
123+
verify: "App.java on disk contains import java.io.File"
124+
verifyFile:
125+
path: "~/src/app/App.java"
126+
contains: "import java.io.File"
127+
timeout: 10
128+
129+
# ── Step 8: Rename Symbol (F2) ──────────────────────────────
130+
- id: "close-all-before-rename"
131+
action: "run command Workbench: Close All Editors"
132+
133+
- id: "open-foo-for-rename"
134+
action: "open file Foo.java"
135+
verify: "Foo.java is open in editor"
136+
timeout: 10
137+
138+
# Place cursor on "Foo" — use Find to locate the text, then close Find (cursor stays on it)
139+
- id: "find-foo-class"
140+
action: "findText Foo"
141+
142+
- id: "rename-foo-to-foonew"
143+
action: "renameSymbol FooNew"
144+
timeout: 15
145+
146+
# LS renames file to FooNew.java — close stale tab and click renamed file in Explorer
147+
- id: "save-after-rename"
148+
action: "run command File: Save All"
149+
150+
- id: "close-all-after-rename"
151+
action: "run command Workbench: Close All Editors"
152+
153+
- id: "click-foonew-in-explorer"
154+
action: "doubleClick FooNew.java"
155+
verify: "FooNew.java shows renamed class"
156+
verifyEditor:
157+
contains: "public class FooNew"
158+
timeout: 15

‎test-plans/java-debugger.yaml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Test Plan: Debugger for Java (from vscode-java-pack.wiki)
2+
#
3+
# Source: wiki Test-Plan.md "Debugger for Java" scenario
4+
# Verify: Start debug → breakpoint hit → step through → inspect variables → program output
5+
#
6+
# Uses the simple-app project (App.java with a main method)
7+
#
8+
# Prerequisites:
9+
# - vscode-java repo is cloned locally
10+
# - JDK is installed and available
11+
#
12+
# Usage: autotest run test-plans/java-debugger.yaml
13+
14+
name: "Java Debugger — Breakpoint Debugging"
15+
description: |
16+
Corresponds to the Debugger for Java scenario in the wiki Test Plan:
17+
Open the simple-app project, set a breakpoint, start debugging,
18+
and verify breakpoint hit and program output.
19+
20+
setup:
21+
extension: "redhat.java"
22+
extensions:
23+
- "vscjava.vscode-java-pack"
24+
vscodeVersion: "stable"
25+
workspace: "../../vscode-java/test/resources/projects/eclipse/simple-app"
26+
timeout: 60
27+
28+
steps:
29+
# ── Remove files that cause compilation errors ──────────
30+
# simple-app has Bar.java and Foo.java with unresolved references
31+
# Delete them so App.java compiles cleanly for debugging
32+
- id: "delete-bar"
33+
action: "deleteFile src/app/Bar.java"
34+
35+
- id: "delete-foo"
36+
action: "deleteFile src/app/Foo.java"
37+
38+
# ── Wait for LS ready ────────────────────────────────────
39+
- id: "ls-ready"
40+
action: "waitForLanguageServer"
41+
verify: "Status bar shows Java Language Server is ready with no errors"
42+
verifyProblems:
43+
errors: 0
44+
timeout: 120
45+
46+
# ── Open App.java ────────────────────────────────────────
47+
- id: "open-app"
48+
action: "open file App.java"
49+
verify: "App.java file is opened in the editor"
50+
timeout: 15
51+
52+
# ── Set breakpoint ───────────────────────────────────────
53+
# App.java line 5: System.out.println("Hello Java");
54+
- id: "set-breakpoint"
55+
action: "setBreakpoint 5"
56+
verify: "Breakpoint set on line 5"
57+
58+
# ── Start debug session ─────────────────────────────────
59+
- id: "start-debug"
60+
action: "startDebugSession"
61+
verify: "Debug session started, debug toolbar visible"
62+
timeout: 30
63+
64+
# ── Verify breakpoint hit ───────────────────────────────
65+
# wiki: "verify if the breakpoint is hit"
66+
- id: "verify-breakpoint"
67+
action: "wait 10 seconds"
68+
verify: "Breakpoint hit, program paused"
69+
70+
# ── Continue execution ──────────────────────────────────
71+
- id: "continue-debug"
72+
action: "debugStepOver"
73+
verify: "Program continued past breakpoint"
74+
75+
# ── Stop debug ──────────────────────────────────────────
76+
- id: "stop-debug"
77+
action: "stopDebugSession"
78+
verify: "Debug session stopped"

0 commit comments

Comments
 (0)