Developing with Containers¶

`cardiacmodelling/ap-nimbus-app-manager`¶

Developing in container¶

If you start a container as follows:

docker run -it --name name-app-manager --net ap-nimbus-network --restart always cardiacmodelling/ap-nimbus-app-manager:<version> bash

You will get a command bash shell inside the container. You can make changes and manually start the app-manager by running /home/appredict/apps/app-manager/kickoff.sh.
In order to try out changes, you can stop the app-manager by stopping kick_off.sh and killing convert.sh and manually restart it after changes have been applied.

Note

If you exit the container it will stop and it will lose the changes made. Instead of exiting the container you can detach with CTRL+P+Q and re-attach with docker attach <ap-nimbus-app-manager container name> (you may eventually need a docker container stop <ap-nimbus-app-manager container name>).

`cardiacmodelling/ap-nimbus-client-direct`¶

Django static file creation¶

Within ap-nimbus-client/client/static there are the static files which the Django UI references, e.g. images, css, js.

The following commands represent an example of how a new minified main-min.js can be generated.

Note : You need to have npm (so you probably need node.js installed - e.g. apt install nodejs npm).

Warning

1. The commands below also modify the version-controlled file npm-shrinkwrap.json, but don’t commit this change!
2. They also fill up node_modules with almost 100Mb of stuff which you really don’t want to be copied into a container! Better to delete the content of this directory before building the container.

user@host:~/git/ap-nimbus-client/client/static> npm install gulp
user@host:~/git/ap-nimbus-client/client/static> ./node_modules/gulp/bin/gulp.js      # <-- reads gulpfile.js
user@host:~/git/ap-nimbus-client/client/static> find ./ -mmin -1 -type f
./css/style-min.css
./build/js/main-min.js

If you’re just wanting to create and use an unminified version of main.js for local testing, you can try the following.

user@host:~/git/ap-nimbus-client/client/static> sed -i "s/noSource: true/noSource: true, ignoreFiles: ['main.js']/g" gulpfile.js
user@host:~/git/ap-nimbus-client/client/static> sed -i "s/main-min/main/g" ../templates/includes/head.html
user@host:~/git/ap-nimbus-client/client/static> ./node_modules/gulp/bin/gulp.js      # <-- reads gulpfile.js
user@host:~/git/ap-nimbus-client/client/static> find ./ -mmin -1 -type f
./css/style-min.css
./build/js/main.js

Django migrations¶

A simplified section for developers unfamiliar with Python, Django and data migrations!

Requirements :

A running postgres db
env vars in your environment.
Derived from docker/env, and containing valid values, particularly db data.
In the commands below I’ve put an env file in ~/git/env (and note that if there are spaces in env var values then you may need to wrap the values in double quotes, e.g. ENVVAR="An env var val")

user@host:~/git/ap-nimbus-client> python3 -m venv ../tmpenv
user@host:~/git/ap-nimbus-client> source ../tmpenv/bin/activate                                        # <-- Activate virtual env
(tmpenv) user@host:~/git/ap-nimbus-client> pip install -r requirements/requirements.txt                # <-- Load python libs into virtual env
(tmpenv) user@host:~/git/ap-nimbus-client> set -a; source ../env; set +a                               # <-- Load env vars (e.g. db host/user/etc) into environment
(tmpenv) user@host:~/git/ap-nimbus-client> python client/manage.py showmigrations                      # <-- Should show migrations on a "per app" basis
# We want to update db records (not alter table properties), so create a templated migration (for the "files" app)
(tmpenv) user@host:~/git/ap-nimbus-client> python client/manage.py makemigrations files --name fix_0005_auto --empty
(tmpenv) user@host:~/git/ap-nimbus-client> nano client/files/migrations/0008_fix_0005_auto.py          # <-- Edit content according to migration
(tmpenv) user@host:~/git/ap-nimbus-client> deactivate                                                  # <-- Leave virtual env
user@host:~/git/ap-nimbus-client>                                                                      # <-- As you were (except vars in your environment, ../env, and ../tmpenv!!)

Developing in container¶

If you start a container using the docker run -d --name name-client .... you can access the running container using, for example :

docker exec -it $(docker inspect --format="{{.Id}}" name-client) /bin/bash

Therein you can access whichever parts of the application the user appredict has been granted access to (which would likely be determined by whatever has been assigned in the container’s /etc/sudoers, as determined by the container Dockerfile).

Developing with Containers¶

cardiacmodelling/ap-nimbus-app-manager¶

Developing in container¶

cardiacmodelling/ap-nimbus-client-direct¶

Django static file creation¶

Django migrations¶

Developing in container¶

`cardiacmodelling/ap-nimbus-app-manager`¶

`cardiacmodelling/ap-nimbus-client-direct`¶