Add test debugging feature using omnisharp and vimspector

Author: jpfeiffer16

README.md

@@ -414,6 +414,9 @@ It is possible to run unit tests via OmniSharp-roslyn, with success/failures lis
 " Run the current unit test (the cursor should be on/inside the test method)
 :OmniSharpRunTest
 
+" Debug the current unit test (This will not populate the quickfix list with the result)
+:OmniSharpDebugTest
+
 " Run all unit tests in the current file
 :OmniSharpRunTestsInFile
 

autoload/OmniSharp/actions/test.vim

@@ -3,19 +3,34 @@ set cpoptions&vim
 
 let s:runningTest = 0
 
-function! OmniSharp#actions#test#Run(...) abort
+function! s:BindTest(bufnr, Callback) abort
   if !s:CheckCapabilities() | return | endif
-  let bufnr = a:0 ? a:1 : bufnr('%')
-  if !has_key(OmniSharp#GetHost(bufnr), 'project')
+  if !has_key(OmniSharp#GetHost(a:bufnr), 'project')
     " Initialize the test by fetching the project for the buffer - then call
     " this function again in the callback
-    call OmniSharp#actions#project#Get(bufnr,
-    \ function('OmniSharp#actions#test#Run', [bufnr]))
+    call OmniSharp#actions#project#Get(a:bufnr,
+    \ function('s:BindTest', [a:bufnr, a:Callback]))
     return
   endif
   let s:runningTest = 1
-  call OmniSharp#actions#codestructure#Get(bufnr,
-  \ function('s:RunTest', [function('s:CBRunTest')]))
+  call OmniSharp#actions#codestructure#Get(a:bufnr,
+  \ a:Callback)
+endfunction
+
+function! OmniSharp#actions#test#Run(...) abort
+  let bufnr = a:0 ? a:1 : bufnr('%')
+  call s:BindTest(bufnr, function('s:RunTest', [function('s:CBRunTest')]))
+endfunction
+
+function! OmniSharp#actions#test#Debug(...) abort
+  if !exists('g:vimspector_home')
+    echohl WarningMsg
+    echomsg 'Vimspector required to debug tests'
+    echohl None
+    return
+  endif
+  let bufnr = a:0 ? a:1 : bufnr('%')
+  call s:BindTest(bufnr, function('s:DebugTest', [function('s:CBDebugTest')]))
 endfunction
 
 function! s:CBRunTest(summary) abort
@@ -38,6 +53,15 @@ function! s:CBRunTest(summary) abort
   endif
 endfunction
 
+function! s:CBDebugTest(response) abort
+  if !a:response.Success
+    echohl WarningMsg
+    echomsg 'Error debugging unit test'
+    echomsg a:response.Message
+    echohl None
+  endif
+endfunction
+
 function! OmniSharp#actions#test#RunInFile(...) abort
   if !s:CheckCapabilities() | return | endif
   if a:0 && type(a:1) == type([])
@@ -181,6 +205,66 @@ function! s:RunTestsRH(Callback, bufnr, tests, response) abort
   call a:Callback(summary)
 endfunction
 
+function! s:DebugTest(Callback, bufnr, codeElements) abort
+  let tests = s:FindTests(a:codeElements)
+  let currentTest = s:FindTest(tests)
+  if type(currentTest) != type({})
+    echohl WarningMsg | echom 'No test found' | echohl None
+    let s:runningTest = 0
+    return
+  endif
+  let project = OmniSharp#GetHost(a:bufnr).project
+  let targetFramework = project.MsBuildProject.TargetFramework
+  let opts = {
+  \ 'ResponseHandler': function('s:DebugTestsRH', [a:Callback, a:bufnr, tests]),
+  \ 'Parameters': {
+  \   'MethodName': currentTest.name,
+  \   'TestFrameworkName': currentTest.framework,
+  \   'TargetFrameworkVersion': targetFramework
+  \ },
+  \ 'SendBuffer': 0
+  \}
+  echomsg 'Debugging test ' . currentTest.name
+  call OmniSharp#stdio#Request('/v2/debugtest/getstartinfo', opts)
+endfunction
+
+function! s:DebugTestsRH(Callback, bufnr, tests, response) abort
+  let testhost = [a:response.Body.FileName] + split(substitute(a:response.Body.Arguments, '\"', '', 'g'), ' ')
+  let testhost_job_pid = s:StartTestProcess(testhost)
+  let g:testhost_job_pid = testhost_job_pid
+
+  let host = OmniSharp#GetHost()
+  let s:omnisharp_pre_debug_cwd = getcwd()
+  let new_cwd = fnamemodify(host.sln_or_dir, ':p:h')
+  call vimspector#LaunchWithConfigurations({
+  \  'attach': {
+  \    'adapter': 'netcoredbg',
+  \    'configuration': {
+  \      'request': 'attach',
+  \      'processId': testhost_job_pid
+  \    }
+  \  }
+  \})
+  execute 'tcd '.new_cwd
+
+  call s:LaunchDebuggedTest(a:Callback, testhost_job_pid)
+endfunction
+
+function! s:LaunchDebuggedTest(Callback, pid) abort
+  let opts = {
+  \ 'ResponseHandler': function('s:LaunchDebuggedTestRH', [a:Callback, a:pid]),
+  \ 'Parameters': {
+  \   'TargetProcessId': a:pid
+  \ }
+  \}
+  echomsg 'Launching debugged test'
+  call OmniSharp#stdio#Request('/v2/debugtest/launch', opts)
+endfunction
+
+function! s:LaunchDebuggedTestRH(Callback, pid, response) abort
+  call a:Callback(a:response)
+endfunction
+
 function! s:FindTestsInFiles(Callback, buffers, ...) abort
   call OmniSharp#util#AwaitParallel(
   \ map(copy(a:buffers), {i,b -> function('OmniSharp#actions#codestructure#Get', [b])}),
@@ -284,6 +368,29 @@ function! s:CheckCapabilities() abort
   return 1
 endfunction
 
+function! s:TestProcessClosed(...) abort
+  call OmniSharp#stdio#Request('/v2/debugtest/stop', {})
+  let s:runningTest = 0
+  call vimspector#Reset()
+  execute 'tcd '.s:omnisharp_pre_debug_cwd
+  unlet s:omnisharp_pre_debug_cwd
+endfunction
+
+function! s:StartTestProcess(command) abort
+  if OmniSharp#proc#supportsNeovimJobs()
+    let job = jobpid(jobstart(a:command, {
+      \ 'on_exit': function('s:TestProcessClosed')
+    \ }))
+  elseif OmniSharp#proc#supportsVimJobs()
+    let job = split(job_start(a:command, {
+      \ 'close_cb': function('s:TestProcessClosed')
+    \ }), ' ',)[1]
+  else
+    echohl WarningMsg | echomsg 'Cannot launch test process.' | echohl None
+  endif
+  return job
+endfunction
+
 let &cpoptions = s:save_cpo
 unlet s:save_cpo
 

doc/omnisharp-vim.txt

@@ -563,6 +563,14 @@ convenient user re-mapping. These can be used like so: >
     Run the current unit test. The cursor can be anywhere in the test method.
     If the test fails, the failure message and location will be displayed in
     the quickfix list.
+                                                              *:OmniSharpDebugTest*
+                                                     *<Plug>(omnisharp_debug_test)*
+:OmniSharpDebugTest
+    Debug the current unit test. The cursor can be anywhere in the test method.
+    This uses the Vimspector plugin. You must have Vimpsector installed and 
+    have the +python3 vim feature.
+    When debugging a test, the quickfix list is not populated with the result of
+    the test.
 
                                                        *:OmniSharpRunTestsInFile*
                                             *<Plug>(omnisharp_run_tests_in_file)*

ftplugin/cs/OmniSharp.vim

@@ -47,6 +47,7 @@ command! -buffer -bar OmniSharpRename call OmniSharp#actions#rename#Prompt()
 command! -buffer -nargs=1 OmniSharpRenameTo call OmniSharp#actions#rename#To(<q-args>)
 command! -buffer -bar OmniSharpRepeatCodeAction call OmniSharp#actions#codeactions#Repeat('normal')
 command! -buffer -bar OmniSharpRunTest call OmniSharp#actions#test#Run()
+command! -buffer -bar OmniSharpDebugTest call OmniSharp#actions#test#Debug()
 command! -buffer -bar -nargs=* -complete=file OmniSharpRunTestsInFile call OmniSharp#actions#test#RunInFile(<f-args>)
 command! -buffer -bar OmniSharpSignatureHelp call OmniSharp#actions#signature#SignatureHelp()
 command! -buffer -bar OmniSharpTypeLookup call OmniSharp#actions#documentation#TypeLookup()