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 debugging support #1006

Closed
wants to merge 7 commits into from
Closed

Add debugging support #1006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
28d0c7c
Add debugging support
jborean93 Nov 3, 2023
8a2d3be
Merge branch 'main' into ansibug
ssbarnea Jan 21, 2024
b8d5a44
chore: auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 21, 2024
0a3ca82
Merge branch 'main' into ansibug
ssbarnea Jan 27, 2024
78b467e
chore: auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 27, 2024
e9fd47b
Merge branch 'main' into ansibug
ssbarnea Jan 29, 2024
1ec0a34
Merge branch 'main' into ansibug
ssbarnea Mar 12, 2024
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
7 changes: 7 additions & 0 deletions .config/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ ajinkyau
akira
alefragnani
alphanums
ALS
Anson
ansibug
autofix
autoupdate
backticks
Expand All @@ -44,6 +47,7 @@ copyfiles
cygwin
cython
dbaeumer
debuggee
dedupe
depcheck
deps
Expand Down Expand Up @@ -100,6 +104,9 @@ priyamsahoo
projectuser
prsahoo
pyparsing
PYTHONBREAKPOINT
PYTHONHOME
PYTHONPATH
reindent
reindented
relogin
Expand Down
225 changes: 224 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
"onCommand:extension.ansible-navigator.run",
"onCommand:extension.ansible-playbook.run",
"onCommand:extension.ansible.vault",
"onCommand:ansible.debugger.pickAnsiblePlaybook",
"onCommand:ansible.debugger.pickAnsibleProcess",
"onLanguage:ansible",
"onLanguage:yaml",
"onCommand:extension.resync-ansible-inventory",
"workspaceContains:tox-ansible.ini"
"workspaceContains:tox-ansible.ini",
"onDebugResolve:ansible"
],
"badges": [
{
Expand Down Expand Up @@ -508,6 +511,29 @@
"order": 0
}
}
},
{
"title": "Debugger",
"properties": {
"ansible.debugger.logFile": {
"type": "string",
"default": "",
"markdownDescription": "Set to enable the debug server logging to the path set.",
"order": 0
},
"ansible.debugger.logLevel": {
"type": "string",
"default": "info",
"enum": [
"info",
"debug",
"warning",
"error"
],
"markdownDescription": "The logging level to configure for the debug server.",
"order": 1
}
}
}
],
"configurationDefaults": {
Expand Down Expand Up @@ -703,6 +729,203 @@
}
}
}
],
"breakpoints": [
{
"language": "ansible"
},
{
"language": "yaml"
}
],
"debuggers": [
{
"type": "ansible",
"label": "Ansible Debug",
"languages": [
"ansible"
],
"variables": {
"PickAnsiblePlaybook": "ansible.debugger.pickAnsiblePlaybook",
"PickAnsibleProcess": "ansible.debugger.pickAnsibleProcess"
},
"configurationAttributes": {
"attach": {
"properties": {
"processId": {
"type": [
"string",
"number"
],
"description": "The process id of the ansible-playbook process to attach to.",
"default": "${command:PickAnsibleProcess}"
},
"address": {
"type": "string",
"description": "The host that is running the ansible-playbook process with the scheme tcp:// or uds://.",
"default": "tcp://remote-host:1234"
},
"useTLS": {
"type": "boolean",
"description": "Wrap the communication socket with TLS to add server verification and encryption to the connection.",
"default": false
},
"tlsVerification": {
"type": "string",
"description": "The TLS verification settings, defaults to verify but can be set to ignore to ignore the verification checks. Can also be set to the path of a file or directory to use as the CA trust store.",
"default": "verify"
},
"tlsCertificate": {
"type": "string",
"description": "",
"default": "The path to a PEM encoded certificate, and optional key, to use for client certificate authentication with TLS. Use tlsKey if the path does not contain the key."
},
"tlsKey": {
"type": "string",
"description": "",
"default": "The path to a PEM encoded key for the certificate used for client certificate authentication with TLS. If encrypted use tlsKeyPassword to supply the password."
},
"tlsKeyPassword": {
"type": "string",
"description": "",
"default": "The password for the client certificate key if it is encrypted."
},
"connectTimeout": {
"type": "float",
"description": "The timeout, in seconds, to wait when trying to attach to the ansible-playbook process.",
"default": 5
},
"pathMappings": {
"$id": "#pathMappings",
"type": "array",
"items": {
"type": "object",
"description": "The remote path prefix the Ansible playbook is running under and the local path prefix it maps to.",
"properties": {
"localRoot": {
"type": "string",
"description": "The local path root prefix this mapping applies to.",
"default": "${workspaceFolder}/"
},
"remoteRoot": {
"type": "string",
"description": "The remote path root prefix this mapping applied to.",
"default": ""
}
},
"required": [
"localRoot",
"remoteRoot"
]
},
"description": "A list of case sensitive path mappings between a local and remote path. Multiple paths can be defined as needed.",
"default": []
}
}
},
"launch": {
"properties": {
"playbook": {
"type": "string",
"description": "The path to the Ansible playbook to launch.",
"default": "${command:PickAnsiblePlaybook}"
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Command line arguments to pass to the ansible-playbook call, excluding the playbook itself.",
"default": []
},
"console": {
"type": "string",
"description": "Where to launch the debug target.",
"default": "integratedTerminal",
"enum": [
"integratedTerminal",
"externalTerminal"
]
},
"cwd": {
"type": "string",
"description": "Absolute path to the working directory of the new ansible-playbook process that is spawned.",
"default": "${workspaceFolder}"
},
"connectTimeout": {
"type": "float",
"description": "The timeout, in seconds, to wait for the new ansible-playbook process to connect back to the debug client before failing.",
"default": 5
},
"logFile": {
"type": "string",
"description": "The path to a file to log the ansibug debuggee logging entries to. Use logLevel to control the verbosity of these logs."
},
"logLevel": {
"type": "string",
"description": "The level of logging to enable on the ansibug debuggee run. This is only enabled if logFile is also set.",
"default": "info",
"enum": [
"info",
"debug",
"warning",
"error"
]
},
"pathMappings": {
"$ref": "#pathMappings"
}
},
"required": [
"playbook"
]
}
},
"configurationSnippets": [
{
"label": "Ansible: Launch new ansible-playbook Process",
"description": "Launch a new ansible-playbook process",
"body": {
"name": "Ansible: Launch ansible-playbook Process",
"type": "ansible",
"request": "launch",
"playbook": "^\"\\${command:PickAnsiblePlaybook}\""
}
},
{
"label": "Ansible: Launch Current File",
"description": "Launch and debug the file in the currently active editor window",
"body": {
"name": "Ansible: Launch Current File",
"type": "ansible",
"request": "launch",
"playbook": "^\"\\${file}\"",
"cwd": "^\"\\${cwd}\""
}
},
{
"label": "Ansible: Attach to local ansible-playbook Process",
"description": "Attach the debugger to a locally running ansible-playbook process",
"body": {
"name": "Ansible: Attach to local ansible-playbook Process",
"type": "ansible",
"request": "attach",
"processId": "^\"\\${command:PickAnsibleProcess}\""
}
},
{
"label": "Ansible: Attach to remote ansible-playbook Process",
"description": "Attach the debugger to a remote ansible-playbook process",
"body": {
"name": "Ansible: Attach to remote ansible-playbook Process",
"type": "ansible",
"request": "attach",
"address": "tcp://target-host:1234"
}
}
],
"initialConfigurations": []
}
]
},
"dependencies": {
Expand Down
41 changes: 41 additions & 0 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ import {

/* local */
import { SettingsManager } from "./settings";
import {
AnsibleDebugConfigurationProvider,
DebuggerManager,
DebuggerCommands,
createAnsibleDebugAdapter,
} from "./features/debugger";
import { AnsiblePlaybookRunProvider } from "./features/runner";
import {
getConflictingExtensions,
Expand Down Expand Up @@ -227,6 +233,41 @@ export async function activate(context: ExtensionContext): Promise<void> {
)
);

// Debugging
const debuggerManager = new DebuggerManager();
context.subscriptions.push(
vscode.debug.registerDebugAdapterDescriptorFactory("ansible", {
createDebugAdapterDescriptor: () => {
return createAnsibleDebugAdapter(extSettings.settings);
},
})
);

context.subscriptions.push(
vscode.debug.registerDebugConfigurationProvider(
"ansible",
new AnsibleDebugConfigurationProvider()
)
);

context.subscriptions.push(
vscode.commands.registerCommand(
DebuggerCommands.PICK_ANSIBLE_PLAYBOOK,
() => {
return debuggerManager.pickAnsiblePlaybook();
}
)
);

context.subscriptions.push(
vscode.commands.registerCommand(
DebuggerCommands.PICK_ANSIBLE_PROCESS,
() => {
return debuggerManager.pickAnsibleProcess();
}
)
);

// Listen for text selection changes
context.subscriptions.push(
vscode.window.onDidChangeTextEditorSelection(async () => {
Expand Down
Loading
Loading