Merge pull request #2103 from codebar/fix-up-docker

matyikriszta · web-flow · commit d736feda06f7 · 2024-08-05T20:34:31.000-07:00
Fix up Docker config and README instructions so setting up the project via Docker works once again
diff --git a/Dockerfile b/Dockerfile
@@ -3,11 +3,11 @@ FROM ruby:3.2.2
 # Default node version on apt is old. This makes sure a recent version is installed
 # This step also runs apt-get update
 RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
-RUN apt-get install -y --force-yes build-essential libpq-dev nodejs
+RUN apt-get update
+RUN apt-get install -y --force-yes build-essential libpq-dev nodejs chromium chromium-driver
 
 WORKDIR /planner
 
-COPY Gemfile Gemfile.lock ./
-RUN bundle install --jobs 4
-
 COPY . ./
+
+RUN bundle install --jobs 4
diff --git a/README.md b/README.md
@@ -61,43 +61,39 @@ from a command prompt in your project folder:
 
 **Note:** If when starting the application with Docker you get the error `UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte` this may be because you created the `.env`-file using PowerShell. This can be solved by deleting that file and creating a new one using a bash shell (for example Git Bash).
 
-### 3. Install and set up the environment
+### 3. Install and set up the environment using docker
 
-We recommend using Docker to install and run the application. However alternatively if you prefer, [you can install directly to your system environment instead](https://github.com/codebar/planner/blob/master/native-installation-instructions.md).
+We recommend using Docker to install and run the application. However alternatively if you prefer, [you can install directly to your system environment instead](./native-installation-instructions.md).
 
-#### Install using Docker
+Before you start, you will need to have Docker installed and running. You can [download it from the Docker website](https://docker.com/). Once downloaded, install and start the Docker application.
 
-Before you start, you will need to have Docker installed and running. You can [download it from the Docker website](https://docker.com/).
+Run `bin/dup` to build and create the docker container. This will also set up the Rails application within the container and start the container. You will only have to run this command once. After initial setup, use `bin/dstart` to start an existing container - using `bin/dup` will recreate an existing container and reset the database.
 
-The current Dockerfile and docker-compose were closely copied from [the Docker guide](https://docs.docker.com/compose/rails/).
+### 4. Start the app
 
-1. Run `bin/dbuild` to build and setup the docker environment.
-2. Run `bin/drake` to run all the tests and make sure everything works.
+Run `bin/dserver` to start the Rails server.
 
-**Note:** If you are using Windows, you can run `bin/dbuild` using Git Bash.
+*If you have previously stopped the container, you will have to first start the container using `bin/dstart`.
 
-### 4. Run the tests
+This should run a process which starts a server in a Docker container on your computer. This process won't finish - you'll know the server is ready when it stops doing anything and displays a message like this:
+```
+Rails 4.2.11 application starting in development on http://localhost:3000
+```
 
-Run `bin/drake` to run all the tests and make sure everything works.
-You can also use `bin/drails` and `bin/dspec` to run specific rails and rspec commands via docker.
+(Optional) Note that to be able to use the page as an admin, you must first give yourself admin privileges. Make sure you have started your app and signed up as an user on your locally running app. Then run the script `bin/dadmin <your email>`.
 
-#### Running single tests/test files
+**You can now view the app at http://localhost:3000**
 
-If you just want to run a single test file you can pass the path to the file, either using `rspec` or via the `SPEC` variable with `rake`:
-```bash
-bundle exec rspec <path to test>
-bundle exec rake SPEC=<path to test>
-```
+You can stop the server when you're finished by typing `Ctrl + C`.
 
-This can also be used with specific line number (running only that one test), for example:
-```bash
-bundle exec rspec spec/features/admin/manage_workshop_attendances_spec.rb:42
-bundle exec rake SPEC=spec/features/admin/manage_workshop_attendances_spec.rb:42
-```
+### 5. Run the tests
+
+Run `bin/drspec` to run all the tests.
 
-These also work with the corresponding `bin/dspec` and `bin/drake` commands.
+This command passes any additional arguments into `rspec` in the docker container, so you can run individual tests with `bin/drspec PATH_TO_TEST` and run a single test case in a file with `bin/drspec PATH_TO_TEST:LINE_NUMBER`
 
 #### Running JavaScript enabled feature tests with a visible browser
+
 There are a small number of feature tests marked with `js: true` which use
 headless Chrome. These can be hard to work with without being able to see what is
 actually happening in the browser. To spin up a visible browser, pass
@@ -109,20 +105,18 @@ CHROME_HEADLESS=false bundle exec rspec
 
 Running JavaScript enabled tests with a visible browser currently doesn't work with Docker.
 
-### 5. Start the app
-
-Run `bin/dstart` to start the app.
-
-This should run a process which starts a server in a Docker container on your computer. This process won't finish - you'll know the server is ready when it stops doing anything and displays a message like this:
-```
-Rails 4.2.11 application starting in development on http://localhost:3000
-```
-
-(Optional) Note that to be able to use the page as an admin, you must first give yourself admin privileges. Make sure you have started your app and signed up as an user on your locally running app. Then run a script `bin/dadmin <your email>`.
-
-**You can now view the app at http://localhost:3000**
-
-You can stop the server when you're finished by typing `Ctrl + C`.
+### Available Docker commands
+
+- `bin/dup`: `docker-compose up --build -d --wait && rake db:drop db:create db:migrate db:seed db:test:prepare`. Rebuilds and boots up a new container, and then initialize the Rails database.
+- `bin/dstart`: `docker-compose start`. Starts the existing container.
+- `bin/dserver`: `docker-compose exec web make serve`. Runs the Rails server. Use this instead of `bin/drails server` to make it bind to the correct IP addresses to allow the server to be viewable outside the container.
+- `drails`: `docker-compose exec web rails $@`. Runs rails within the container.
+- `drspec`: `docker-compose exec web rspec $@`. Runs rspec within the container.
+- `drake`: `docker-compose exec web rake $@`. Runs rake inside the container.
+- `dexec`: `docker-compose exec web bash`. Runs a bash shell inside the container.
+- `dadmin`: Gives the the last user (or the one with a given email) the admin role
+- `bin/dstop`: `docker-compose stop`. Stops container but does not remove it
+- `bin/ddown`: `docker-compose down`. Stops and destroy a container.
 
 ## Front-end framework
 
diff --git a/bin/dadmin b/bin/dadmin
@@ -1,11 +1,9 @@
 #!/usr/bin/env bash
 set -e
 
-docker-compose up -d web
-
 if [ $# -gt 0 ]
 then
-  docker-compose exec web rails runner "Member.find_by(email: '$@').add_role(:admin)"
+  docker compose exec web rails runner "Member.find_by(email: '$@').add_role(:admin)"
 else
-  docker-compose exec web rails runner "Member.last.add_role(:admin)"
+  docker compose exec web rails runner "Member.last.add_role(:admin)"
 fi
diff --git a/bin/dbuild b/bin/dbuild
diff --git a/bin/ddown b/bin/ddown
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker compose down
diff --git a/bin/dexec b/bin/dexec
@@ -2,5 +2,4 @@
 
 set -e
 
-docker-compose up -d web
-docker-compose exec web bash
+docker compose exec web bash
diff --git a/bin/drails b/bin/drails
@@ -2,4 +2,4 @@
 
 set -e
 
-docker-compose run --rm web rails "$@"
+docker compose exec web rails $@
diff --git a/bin/drake b/bin/drake
@@ -2,18 +2,4 @@
 
 set -e
 
-function cleanup {
-  # capture exit code
-  code=$?
-  echo "cleaning up"
-
-  # ignore errors
-  set +e
-  docker-compose down
-
-  exit $code
-}
-
-trap cleanup EXIT
-
-docker-compose run --rm web rake $@
+docker compose exec web rake $@
diff --git a/bin/drspec b/bin/drspec
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker compose exec web rspec $@
diff --git a/bin/drun b/bin/drun
diff --git a/bin/dserver b/bin/dserver
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker compose exec web make serve
diff --git a/bin/dspec b/bin/dspec
diff --git a/bin/dstart b/bin/dstart
@@ -2,5 +2,4 @@
 
 set -e
 
-docker-compose up -d
-echo "Started."
+docker compose start
diff --git a/bin/dstop b/bin/dstop
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker compose stop
diff --git a/bin/dup b/bin/dup
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker compose up --build --wait
+docker compose exec web bash -c "rake db:drop db:create db:migrate db:seed db:test:prepare"
+
+echo "Started."
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,4 +1,3 @@
-version: '2'
 services:
   db:
     image: postgres

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +#!/usr/bin/env bash
++
 +set -e
++
 +docker compose down
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`set -e`
`4`	`4`
`5`		`-docker-compose run --rm web rails "$@"`
	`5`	`+docker compose exec web rails $@`