Update .gitignore and README.md for CODESYS MCP project. Added entries to .gitignore for VSIX files and VS Code settings. Expanded README to include architecture, components, deployment instructions, and details about the Cursor extension.
This commit is contained in:
56
vscode_codesys_companion/docs/smoke-test.md
Normal file
56
vscode_codesys_companion/docs/smoke-test.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# Companion Extension Smoke Test
|
||||
|
||||
This validates extension + MCP bridge + VM agent integration.
|
||||
|
||||
## 1. Preconditions
|
||||
|
||||
- Windows VM agent is reachable.
|
||||
- `codesys.agentUrl` and `codesys.agentToken` are configured in extension settings.
|
||||
- CODESYS bridge script path resolves correctly.
|
||||
|
||||
Reference operational guide:
|
||||
|
||||
- `../python_scripting/codesys-mcp-bridge-operations.md`
|
||||
|
||||
## 2. Connect + Health
|
||||
|
||||
1. Run `CODESYS: Connect MCP Bridge`.
|
||||
2. Run `CODESYS: Health Check`.
|
||||
3. Confirm status bar shows connected and output logs health response.
|
||||
|
||||
## 3. Project Selection
|
||||
|
||||
1. Run `CODESYS: Select Project`.
|
||||
2. Provide a valid project path.
|
||||
3. Confirm Projects view shows active project.
|
||||
|
||||
## 4. Read Workflows
|
||||
|
||||
1. Run `CODESYS: Read Project Inventory`.
|
||||
2. Run `CODESYS: Read Device I/O`.
|
||||
3. Confirm Jobs view shows `succeeded` for both jobs.
|
||||
|
||||
## 5. Safe Mutation (Dry Run)
|
||||
|
||||
1. Run `CODESYS: Sync Project`.
|
||||
2. Keep dry-run enabled.
|
||||
3. Confirm job success and no errors in Problems view.
|
||||
|
||||
## 6. Build
|
||||
|
||||
1. Run `CODESYS: Build Project`.
|
||||
2. Confirm job success.
|
||||
|
||||
## 7. Optional Deploy
|
||||
|
||||
1. Set `codesys.allowDownloadCommand=true`.
|
||||
2. Run `CODESYS: Download To Device`.
|
||||
3. Validate target confirmation and completion.
|
||||
|
||||
## 8. Failure Signal Check
|
||||
|
||||
1. Intentionally provide bad input (for example invalid project path) to `Read Project Inventory`.
|
||||
2. Confirm failure:
|
||||
- appears in output
|
||||
- appears in Jobs view
|
||||
- appears in Problems panel diagnostics
|
||||
Reference in New Issue
Block a user