Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section for Debugging in VSCode #466

Merged
merged 3 commits into from
Nov 23, 2023
Merged

Add section for Debugging in VSCode #466

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f264110
Add section for Debugging in VSCode
rishinair11 Mar 11, 2023
c818832
Merge branch 'main' into patch-1
rishinair11 Aug 30, 2023
efd1fcf
Merge branch 'main' into patch-1
kensipe Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,33 @@ After the correct controller-gen version is installed. All future builds will w

After running this command, CLI will be available in `bin/kubectl-kuttl` and you can invoke the command for example like this `bin/kubectl-kuttl version` (no need to install it as `kubectl` plugin).

### Debugging in VSCode

Click Run > Add Configuration... to open the `launch.json` file. Add below configuration objects to specify the necessary sample tests and assertions in the `args[]`.

```json
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "KUTTL Debug",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "${workspaceFolder}/cmd/kubectl-kuttl/main.go",
"args": [
"test",
"sample",
"--config=${workspaceFolder}/cmd/kubectl-kuttl/<sample_tests_dir_to_run_with_kuttl>"
]
}
]
}
```

### Testing

Use `make all` to run all available tests.
Expand Down