Skip to content

Debugging options #1157

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

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Debugging options #1157

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae2eac4
Added additional entry to Makefile to build & run debugging setup. Ad…
dmytrotsko May 2, 2023
36a23d5
Update Makefile
dmytrotsko May 3, 2023
faf9714
Update Makefile
dmytrotsko May 5, 2023
1a804cd
Requested changes
dmytrotsko Oct 18, 2023
f082df1
Merge branch 'dev' into epidata_debug_setup
dmytrotsko Oct 30, 2023
db1973c
Merge branch 'dev' into epidata_debug_setup
dmytrotsko Jan 10, 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
34 changes: 34 additions & 0 deletions dev/local/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,37 @@ web:
--network delphi-net --name delphi_web_epidata \
delphi_web_epidata >$(LOG_WEB) 2>&1 &

.PHONY=web_debug
web_debug:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.PHONY=web_debug
web_debug:
.PHONY=web_vscodedebug
web_vscodedebug:

rename so its clear that this is specifically for vscode

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should also include a link to your presentation here

@# Stop container if running
@if [ $(WEB_CONTAINER_ID) ]; then\
docker stop $(WEB_CONTAINER_ID);\
fi

@# Setup virtual network if it doesn't exist
@docker network ls | grep delphi-net || docker network create --driver bridge delphi-net

@# Build the web_epidata image
@cd repos/delphi/delphi-epidata; \
docker build -t delphi_web_epidata \
$(M1) \
-f ./devops/Dockerfile .;\
cd -

@# Run the web server
@# MODULE_NAME specifies the location of the `app` variable, the actual WSGI application object to run.
@# see https://github.com/tiangolo/meinheld-gunicorn-docker#module_name
@docker run --rm -p 127.0.0.1:5000:5000 -p 127.0.0.1:5678:5678 \
$(M1) \
--mount type=bind,source=$(CWD)repos/delphi/delphi-epidata/devops/start.sh,target=/start.sh,readonly \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
--mount type=bind,source=$(CWD)repos/delphi/delphi-epidata/devops/start.sh,target=/start.sh,readonly \
`# mount the debuging start script into the container so the webserver uses it ` \
--mount type=bind,source=$(CWD)repos/delphi/delphi-epidata/devops/start_vscodedebug.sh,target=/start.sh,readonly \

to support renaming the local start.sh file and make a note so its clearer as to whats happening

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, im not sure that bash "trick" i used to add an in-line comment will work inside the makefile...

--mount type=bind,source=$(CWD)repos/delphi/delphi-epidata/src/server,target=/app/delphi/epidata/server \
--env "MODULE_NAME=delphi.epidata.server.main" \
--env "SQLALCHEMY_DATABASE_URI=$(sqlalchemy_uri)" \
--env "FLASK_SECRET=abc" --env "FLASK_PREFIX=/epidata" --env "LOG_DEBUG" \
--network delphi-net --name delphi_web_epidata \
delphi_web_epidata >$(LOG_WEB) 2>&1 &


.PHONY=db
db:
@# Stop container if running
Expand Down Expand Up @@ -139,6 +170,9 @@ py:
.PHONY=all
all: db web py

.PHONY=debug
debug: db web_debug py
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.PHONY=debug
debug: db web_debug py
.PHONY=vscodedebug
debug: db web_vscodedebug py


.PHONY=test
test:
@docker run -i --rm --network delphi-net \
Expand Down
18 changes: 18 additions & 0 deletions devops/start.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#! /usr/bin/env sh
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename this file to start_vscodedebug.sh so its not mistaken for a regular 'start' script

set -e

# If there's a prestart.sh script in the /app directory, run it before starting
PRE_START_PATH=/app/prestart.sh
echo "Checking for script in $PRE_START_PATH"
if [ -f $PRE_START_PATH ] ; then
echo "Running script $PRE_START_PATH"
. "$PRE_START_PATH"
else
echo "There is no script $PRE_START_PATH"
fi

export FLASK_APP=delphi.epidata.server.main

pip install debugpy

python -m debugpy --listen 0.0.0.0:5678 --wait-for-client -m flask run -h 0.0.0.0 -p 5000