Debug support #858

bjorkstromm · 2016-05-01T19:12:10Z

Solves #114

WIP Debug support. Currently only supports Stable version of Roslyn, the Nightly should be a no brainer, but I wanted to discuss this more in detail before implementing.

Done:

Added support for --debug (short -d) argument
Added Debug command + all that jazz
Added DebugScriptHost, which waits for a debugger to be attached
Added RoslynDebugSession, which compiles the cake-script and emits the dll + pdb to a memorystream which is loaded and executed.

I'm not sure about the Roslyn Session and SessionFactory implementations. Refactored out the common bits, but still feels kind of wierd? Any suggestions on this before proceeding with the Nightly version of Roslyn.

ALSO Still lacks Unit Tests, some bits should be refactored to allow testing, e.g. DebugScriptHost..

HOWTO:

launch cake.exe with -debug flag. cake.exe cakefile.cake -debug
Process will stop in prior to executing script and report Attach debugger to process XYZ to continue
Open Visual Studio, open the cake file, add a breakpoint.
Open Debug > Attach to Process... and attach to process with PID reported in step 2.
Enjoy debugging...
- Sometimes VS will fail and report "Source not found", if this is the case, close the open cake-file and then from the call stack window right click on the first row and select "Go to source". This should open the source file and everything is fine :) Don't know why VS behaves like this, breakpoint hits, but it can't open source when it's already open.
- Another nice way is to add System.Diagnostics.Debugger.Break(); to the line where you would like the debugger to break. In this case you can completely skip opening the file in VS, the debugging session will open it automatically once breakpoint is hit.

patriksvensson · 2016-05-02T09:09:47Z

@mholo65

Great job! 👍

Would it be possible to Rename the RoslynSessionFactory to DefaultRoslynSessionFactory and RoslynSession to DefaultRoslynSession, and after that rename AbstractRoslynSessionFactory to just RoslynSessionFactory and AbstractRoslynSession to RoslynSession.

public sealed class DefaultRoslynSessionFactory : RoslynSessionFactory { }
public sealed class DebugRoslynSessionFactory : RoslynSessionFactory { }

public sealed class DefaultRoslynSession : RoslynSession { }
public sealed class DebugRoslynSession : RoslynSession { }

Not sure that Default is a better prefix, but I'm really not a fan of the Abstract prefix.

@gep13 @devlead: Any input on naming?

bjorkstromm · 2016-05-02T15:09:53Z

Thanx! Default/Debug sounds better than current naming. Will wait and see what the others have to say about naming.

Another thing that cane to mind. What about adding #break pre-processor directive that would inject System.Diagnostics.Debugger.Break();? That could be a separate PR though.

devlead · 2016-05-02T15:16:55Z

@mholo65 +1 on naming 👍 Any thoughts @gep13?

New preprocessors should as you suggest be part of separate PR, so we keep this one as focused as possible.

bjorkstromm · 2016-05-02T16:44:16Z

Would you also like to have debug support for experimental (nightly) version of Roslyn as separate PR? It is not yet implemented in this PR.

patriksvensson · 2016-05-02T20:38:42Z

@mholo65 I think debug support for experimental Roslyn could be a part of this PR.

devlead · 2016-05-02T20:59:48Z

I agree with @patriksvensson, would be great with support for experimental in this pr too.

bjorkstromm · 2016-05-02T21:04:13Z

@patriksvensson @devlead Thanks. I'll fix the naming, add experimental roslyn support and add some unit tests. I'll probably have it by the end of this week.

gep13 · 2016-05-03T06:47:01Z

Sorry for not replying sooner, had a couple things on...

Yes, I agree with the suggested naming. I really like the idea of the #debug pre processor as well, I think that will help during debugging sessions, but I agree that this should be a separate PR.

This really is great work @mholo65! This is going to make a lot of people very happy! 👍

bjorkstromm · 2016-05-04T08:44:33Z

src/Cake/Scripting/Roslyn/RoslynScriptEngine.cs

-        private readonly RoslynScriptSessionFactory _stableFactory;
-        private readonly RoslynNightlyScriptSessionFactory _nightlyFactory;
+        private readonly RoslynSessionFactory _stableFactory;
+        private readonly RoslynNightlySessionFactory _nightlyFactory;


@patriksvensson hmm, maybe I should keep Script in the new name. RoslynNightlySession sounds ratherh kinky 😄

@mholo65 Lol 😄 Keep the Script 😉

gep13 · 2016-05-04T09:27:51Z

@mholo65 quick random question... will the debugger within say VSCode also be able to attach to this, in the same way as you can with Visual Studio?

bjorkstromm · 2016-05-04T10:32:17Z

@gep13 haven't tried that. But I could investigate.

Edit
@gep13 coreclr-debug (in omnisharp-vscode) gave no luck. Do you know if it's even possible to debug full framework programs in VS Code?

MDbg worked like a charm. Too bad nobody has created an extension for it in VSCode.

bjorkstromm · 2016-05-06T19:41:37Z

src/Cake/Scripting/DebugScriptHost.cs

+        {
+            var strategy = new DefaultExecutionStrategy(_log);
+            var message = "Attach debugger to process {0} to continue";
+            var pid = System.Diagnostics.Process.GetCurrentProcess().Id;


@patriksvensson any wishes for abstracting this in order to unit test?

bjorkstromm · 2016-05-09T21:12:41Z

@patriksvensson I think I'm confident enough to remove the [WIP] tag now 😄

//cc @devlead @gep13

gep13 · 2016-05-09T21:50:55Z

Damn! Really looking forward to taking a look at this, and having a play!

@mholo65 on a side note, did you take a look at using VSCode as the debugger? Is that going to work, or is additional work required? Cheers!

bjorkstromm · 2016-05-10T09:15:57Z

@gep13 I checked up on VSCode debugging and unfortunately it won't work until Cake is ported to .NET Core as the Omnisharp VSCode Debugger uses CLRDBG which is designed for .NET Core.

However, the .NET Framework Command-Line Debugger, MDbg works like a charm. But this debugger is unfortunately not available as an extension for VSCode.

A third alternative is the Mono debugger, which may work. I'm currently not in a position to test that as I'm lacking an environment atm. (read not supported on Windows)

bjorkstromm · 2016-05-10T09:25:01Z

@gep13 and forget the third alternative as we don't do the Roslyn dance on Linux/Mac and this PR doesn't implement debugging support for Mono...

patriksvensson · 2016-05-10T10:32:33Z

@mholo65 Awesome work! Really impressed. Will take a closer look at it tonight when I'm off work.

@gep13 Have you seen the Mono debug adapter? https://github.com/Microsoft/vscode-mono-debug

devlead · 2016-05-12T09:05:30Z

src/Cake/Scripting/Roslyn/Nightly/DebugRoslynNightlyScriptSessionFactory.cs

+
+namespace Cake.Scripting.Roslyn.Nightly
+{
+    using Core.IO;


Any special reason this isn't by the other using statements above? If not move up so all in one place.

bjorkstromm · 2016-05-12T21:04:35Z

ping @devlead @patriksvensson @gep13 fixed, rebased and squashed!

patriksvensson · 2016-05-12T21:07:22Z

@mholo65 Looks good to me! 😄

@devlead Will you take lead on this?

devlead · 2016-05-12T21:15:14Z

@patriksvensson agree 👍 Just waiting for CI to complete.

bjorkstromm · 2016-05-12T21:35:20Z

@devlead seems like Travis osx build is stalled.. :(

devlead · 2016-05-12T21:39:21Z

@mholo65 I've restarted the Travis build.

devlead · 2016-05-12T22:14:47Z

@mholo65 This is now merged 👍 Big thanks for your contribution!

@cake-build/team FYI 1/2 travis builds didn't complete(the Mac build - restarted 4 times), all other CI success and tested locally, so took decision to merge anyway.

bjorkstromm · 2016-05-13T06:26:17Z

@devlead Thank You! It was a pleasure doing this PR 😄

DamianReeves · 2016-05-26T12:52:02Z

Is there any plans on producing a write-up on using this feature. At this point debug support and intellisense are the only things blocking me from adopting cake as my go to build tool.

bjorkstromm · 2016-05-26T12:54:52Z

@DamianReeves yes, there's an issue here cake-build/website#83 to track this.

devlead · 2016-05-26T18:29:50Z

@mholo65 @DamianReeves there will likely be an intro blog post too shortly.

patriksvensson · 2016-05-26T22:12:18Z

@DamianReeves A blog post have been posted about this: http://cakebuild.net/blog/2016/05/debug-cake-file

gep13 · 2016-05-27T06:43:38Z

@DamianReeves said...
At this point debug support and intellisense are the only things blocking me from adopting cake as my go to build tool.

As a point of curiosity, what are you currently using as your build tool?

DamianReeves · 2016-05-27T18:43:57Z

@gep13 I go back and forth between psake and FAKE

patriksvensson added the in progress label May 1, 2016

patriksvensson changed the title ~~WIP: Debug support~~ [WIP] Debug support May 2, 2016

bjorkstromm reviewed May 4, 2016
View reviewed changes

bjorkstromm reviewed May 6, 2016
View reviewed changes

bjorkstromm mentioned this pull request May 6, 2016

Add pre-processor directive which injects Debugger.Break() #869

Closed

bjorkstromm force-pushed the debug-support branch from 0cca74b to 659c665 Compare May 9, 2016 20:54

bjorkstromm changed the title ~~[WIP] Debug support~~ Debug support May 9, 2016

devlead reviewed May 12, 2016
View reviewed changes

bjorkstromm mentioned this pull request May 12, 2016

Add possiblity to launch debugger #876

Closed

Implemented debugging support for roslyn script sessions

f75166c

bjorkstromm force-pushed the debug-support branch from 659c665 to f75166c Compare May 12, 2016 20:58

devlead merged commit f75166c into cake-build:develop May 12, 2016

devlead mentioned this pull request May 12, 2016

Add debugging / troubleshooting documentation section cake-build/website#83

Open

bjorkstromm deleted the debug-support branch May 13, 2016 06:25

devlead mentioned this pull request May 13, 2016

Debugging support #114

Closed

gep13 mentioned this pull request Jun 6, 2016

Add -debug flag #587

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debug support #858

Debug support #858

bjorkstromm commented May 1, 2016 •

edited

Loading

patriksvensson commented May 2, 2016

bjorkstromm commented May 2, 2016

devlead commented May 2, 2016

bjorkstromm commented May 2, 2016

patriksvensson commented May 2, 2016

devlead commented May 2, 2016

bjorkstromm commented May 2, 2016

gep13 commented May 3, 2016

bjorkstromm May 4, 2016

patriksvensson May 4, 2016

gep13 commented May 4, 2016

bjorkstromm commented May 4, 2016 •

edited

Loading

bjorkstromm May 6, 2016

bjorkstromm commented May 9, 2016

gep13 commented May 9, 2016

bjorkstromm commented May 10, 2016

bjorkstromm commented May 10, 2016

patriksvensson commented May 10, 2016

devlead May 12, 2016

bjorkstromm commented May 12, 2016

patriksvensson commented May 12, 2016

devlead commented May 12, 2016

bjorkstromm commented May 12, 2016

devlead commented May 12, 2016

devlead commented May 12, 2016

bjorkstromm commented May 13, 2016

DamianReeves commented May 26, 2016

bjorkstromm commented May 26, 2016

devlead commented May 26, 2016

patriksvensson commented May 26, 2016

gep13 commented May 27, 2016

DamianReeves commented May 27, 2016

Debug support #858

Debug support #858

Conversation

bjorkstromm commented May 1, 2016 • edited Loading

patriksvensson commented May 2, 2016

bjorkstromm commented May 2, 2016

devlead commented May 2, 2016

bjorkstromm commented May 2, 2016

patriksvensson commented May 2, 2016

devlead commented May 2, 2016

bjorkstromm commented May 2, 2016

gep13 commented May 3, 2016

bjorkstromm May 4, 2016

Choose a reason for hiding this comment

patriksvensson May 4, 2016

Choose a reason for hiding this comment

gep13 commented May 4, 2016

bjorkstromm commented May 4, 2016 • edited Loading

bjorkstromm May 6, 2016

Choose a reason for hiding this comment

bjorkstromm commented May 9, 2016

gep13 commented May 9, 2016

bjorkstromm commented May 10, 2016

bjorkstromm commented May 10, 2016

patriksvensson commented May 10, 2016

devlead May 12, 2016

Choose a reason for hiding this comment

bjorkstromm commented May 12, 2016

patriksvensson commented May 12, 2016

devlead commented May 12, 2016

bjorkstromm commented May 12, 2016

devlead commented May 12, 2016

devlead commented May 12, 2016

bjorkstromm commented May 13, 2016

DamianReeves commented May 26, 2016

bjorkstromm commented May 26, 2016

devlead commented May 26, 2016

patriksvensson commented May 26, 2016

gep13 commented May 27, 2016

DamianReeves commented May 27, 2016

bjorkstromm commented May 1, 2016 •

edited

Loading

bjorkstromm commented May 4, 2016 •

edited

Loading