Added docker support for debugging #2298

mk0sojo · 2018-01-27T21:55:07Z

First shot at debugging the web app in a docker containers (one for the app and one for SQL server). This is the steps to try this out:

Download and install Git, Docker and Editor or IDE (e.g. VS Code).
Make sure Docker is set up to use Linux containers (if running on Windows) and got 4 GB memory or more allocated to run SQL Server (set in Preferences).
Fork and clone repository
Open terminal or Powershell
Cd to the AlreadyApp directory and type “docker-compose up”. This will take some time the first time it runs as it will download ASP.Net core and SQL Server base images.
Open a browser and navigate to localhost:8000

The main remaining issue is after changing anything in the project the whole project is restored, build and nom packages are installed (even if it is just a change to a HTML file)

Will try to solve it, but please let me know what you think so far. I have only tried it on a Mac so far but it “should” work on Windows as well.

jonparker · 2018-01-29T13:01:45Z

@mk0sojo That's awesome work. Hopefully this will make it much easier for people to get started.
Have you tested debugging with VS code or Visual Studio?

mk0sojo · 2018-01-30T06:25:17Z

@jonparker Still needs to add a better debugging experience and need to speed up the restore / build process a bit.
Will look into it a bit more.

mk0sojo · 2018-02-03T15:38:25Z

@jonparker @MisterJames Added support for debugging in VS Code and tried to speed up the build time a bit.
To try:

Clone repo
In AllreadyApp folder run docker-compose up
When done open another terminal and type docker ps. allreadyweb and allreadysqlserver should be running
Open the AllreadyApp folder in VS Code. Go to the debug tab and press play (or just F5). Brake points should now work

The only (known) limitation is that it is not possible to edit an HTML or CSS file without rebuilding.

Let me know what you think.

jonparker · 2018-02-03T15:56:09Z

That's great. Have you heard of docker-sync? It allows for you to build within the container while having the files checked out on the host.

http://docker-sync.io

mk0sojo · 2018-02-04T14:03:05Z

It looks like it could be usefull, my only concern is that it looks a bit complicated to install (on windows in particular https://github.com/EugenMayer/docker-sync/wiki/docker-sync-on-Windows). I'm not sure if that is any better than the installation instructions we currently have running everything locally? On our codathons, is there any particular step that users find difficult or is it just the number of steps?

tony-ho · 2018-02-20T13:04:00Z

@mk0sojo I tested this on Windows and there was an issue with the line endings in AllReadyApp/entrypoint.sh:

allreadyweb | ../../entrypoint.sh: line 2: $'\r': command not found 
: invalid option/../entrypoint.sh: line 3: set: - 
allreadyweb | set: usage: set [-abefhkmnptuvxBCHP] [-o option-name] [--] [arg ...] 
allreadyweb | ../../entrypoint.sh: line 12: syntax error: unexpected end of file 
allreadyweb exited with code 2

The cause was the bash script being checked with the Windows line-ending, \r\n. When run on Linux inside the Docker container, the \r breaks the script.

The issue is described is more detail here:
https://techblog.dorogin.com/case-of-windows-line-ending-in-bash-script-7236f056abe

The solution is to configure .gitattributes to convert bash script line endings to LF on checkout so it will retain the Unix line-endings regardless of operating system.

I've made this change to a clone of your branch here:
https://github.com/tony-ho/allReady/tree/issue-branch-2247

I also rewrote the Docker connection string logic. Instead of using the ALLREADY_DOCKER_DEBUG environment variable to conditionally set Docker-specific connection strings, the connection strings can be passed as environment variables via docker-compose.yml. These will override the values in appSettings.json.

Let me know if and how you want to merge these changes.

mk0sojo · 2018-02-21T08:59:15Z

@tony-ho Thanks for the feedback and testing it on Windows. The changes to the connection string logic looks great as well. Let me know if you have any more feedback.

MisterJames · 2018-02-21T21:15:15Z

This is great stuff.

I'd like to merge this in, do we need another commit @mk0sojo for those line endings?

mk0sojo · 2018-02-22T21:11:07Z

@MisterJames I have added @tony-ho changes to the pull request so it should be ok to merge now.

mk0sojo · 2018-03-11T12:52:27Z

@MisterJames Is there anything else missing here before it can be merged?

gparlakov

@mk0sojo
I realize this is a bit old and seems forgotten by the maintainers. Still:
I've been working on similar idea for the past couple of days. Then this PR. I think some value could be added by tweaking some of the changes. Please see comments. I could do the changes but wanted to get your feedback before that.

gparlakov · 2019-05-05T20:12:48Z

AllReadyApp/Web-App/AllReady/Dockerfile.debug

@@ -0,0 +1,12 @@
+FROM microsoft/aspnetcore-build:2.0


@mk0sojo This whole dockerfile seems to do nothing more than just install the vs debugger and then on startup just keep the process running. What purpose does it serve?

gparlakov · 2019-05-05T20:14:47Z

AllReadyApp/Web-App/AllReady/Dockerfile

+RUN gulp clean && gulp min
+EXPOSE 80/tcp
+RUN chmod +x ../../entrypoint.sh
+CMD /bin/bash ../../entrypoint.sh


Suggested change

CMD /bin/bash ../../entrypoint.sh

CMD /bin/bash "dotnet ef database update && dotnet AllReady.dll"

Instead of having a whole separate file (entrypoint.sh) I believe we could just simply chain the migration and the app start. That we we can drop the .sh file and also the end-of-line issues discussed in the PR comments.

gparlakov · 2019-05-05T20:16:18Z

AllReadyApp/Web-App/AllReady/Startup.cs

@@ -169,7 +169,7 @@ public IServiceProvider ConfigureServices(IServiceCollection services)

            //Hangfire
            services.AddHangfire(configuration => configuration.UseSqlServerStorage(Configuration["Data:HangfireConnection:ConnectionString"]));
-
+            
            services.AddScoped<IAllReadyUserManager, AllReadyUserManager>();


This file seems to only have whitespace changes - perhaps it could be excluded/rolled-back from the PR (i.e. github checkout origin/master -- AllReadyApp/Web-App/AllReady/Startup.cs)

gparlakov · 2019-05-05T20:21:17Z

AllReadyApp/docker-compose.yml

+        ports:
+            - "8000:80"
+        depends_on:
+            - db


Since the db container takes a bit of time to spin up, I'd suggest adding

restart: on-failure

So that docker could retry starting the app if the db is not yet up and running.

gparlakov · 2019-05-05T20:22:02Z

AllReadyApp/docker-compose.yml

+            ACCEPT_EULA: "Y"
+
+volumes:
+    sql-server-data:


Also I could not see where is the logic that actually creates the database table AllReady like done in the appveyor run script

allReady/appveyor.yml

Lines 46 to 47 in 37833fc

- ps: cd (Join-Path $env:APPVEYOR_BUILD_FOLDER "AllReadyApp\Web-App\AllReady")

- ps: sqlcmd -S "(local)\SQL2016" -Q "Use [master]; CREATE DATABASE [AllReady]"

for example

gparlakov · 2019-05-05T20:22:50Z

AllReadyApp/entrypoint.sh

+>&2 echo "SQL Server is starting up"
+sleep 1
+done
+


This file seems to only run the migration and does not actually start the app. i.e. dotnet AllReady.dll is nowhere to be seen...

Added docker support for debugging

f2986c9

Added debuging with VS code and faster build

c4ad825

Moving docker connection strings and fixing line endings in windows@

6f62f37

gparlakov reviewed May 5, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added docker support for debugging #2298

Added docker support for debugging #2298

mk0sojo commented Jan 27, 2018

jonparker commented Jan 29, 2018

mk0sojo commented Jan 30, 2018

mk0sojo commented Feb 3, 2018

jonparker commented Feb 3, 2018

mk0sojo commented Feb 4, 2018

tony-ho commented Feb 20, 2018

mk0sojo commented Feb 21, 2018

MisterJames commented Feb 21, 2018

mk0sojo commented Feb 22, 2018

mk0sojo commented Mar 11, 2018

gparlakov left a comment •

edited

gparlakov May 5, 2019

gparlakov May 5, 2019

gparlakov May 5, 2019

gparlakov May 5, 2019

gparlakov May 5, 2019

gparlakov May 5, 2019

	CMD /bin/bash ../../entrypoint.sh
	CMD /bin/bash "dotnet ef database update && dotnet AllReady.dll"

	- ps: cd (Join-Path $env:APPVEYOR_BUILD_FOLDER "AllReadyApp\Web-App\AllReady")
	- ps: sqlcmd -S "(local)\SQL2016" -Q "Use [master]; CREATE DATABASE [AllReady]"

Added docker support for debugging #2298

Are you sure you want to change the base?

Added docker support for debugging #2298

Conversation

mk0sojo commented Jan 27, 2018

jonparker commented Jan 29, 2018

mk0sojo commented Jan 30, 2018

mk0sojo commented Feb 3, 2018

jonparker commented Feb 3, 2018

mk0sojo commented Feb 4, 2018

tony-ho commented Feb 20, 2018

mk0sojo commented Feb 21, 2018

MisterJames commented Feb 21, 2018

mk0sojo commented Feb 22, 2018

mk0sojo commented Mar 11, 2018

gparlakov left a comment • edited

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov May 5, 2019

Choose a reason for hiding this comment

gparlakov left a comment •

edited