Merge pull request #64 from blocknotes/dev/docker-setup-3

Dev: update Docker setup (3)

Author: blocknotes

.dockerignore

@@ -1,3 +1,17 @@
-Makefile
-MIT-LICENSE
-README.md
+/Makefile
+/MIT-LICENSE
+/Gemfile.lock
+/extra/init.sh
+
+/app
+/bin
+/config
+/coverage
+/db
+/gemfiles
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log
+/spec/dummy/tmp
+/spec/dummy/**/*_spec.rb
+
+/**/*.md

Makefile

@@ -1,38 +1,29 @@
-include .env
+include extra/.env
 
 help:
-	@echo "Main targets: build / up / specs / console / shell"
+	@echo -e "Usage (with DB one value in sqlite / mysql / mssql / postgres):\n  DB=sqlite make up  # to start the base service\n  DB=sqlite make shell  # to enter in a shell\nCheck the Makefile for other commands"
 
-# Docker commands
 build:
 	@rm -f Gemfile.lock
-	@docker compose build
-
-down:
-	@docker compose down
+	@docker compose -f extra/docker-compose.yml build --build-arg DB_TEST=${DB} app_with_${DB}
 
 up: build
-	@docker compose up
-
-cleanup:
-	docker compose rm -f
-	docker image rm -f ${COMPOSE_PROJECT_NAME}-app
+	@docker compose -f extra/docker-compose.yml up app_with_${DB}
 
-# App commands
-server: build
-	COMMAND="bin/rails s -b 0.0.0.0 -p 4000" docker compose up
+shell:
+	@docker compose -f extra/docker-compose.yml exec app_with_${DB} bash
 
-specs: build
-	COMMAND="bin/rspec" docker compose up
+specs:
+	@docker compose -f extra/docker-compose.yml exec app_with_${DB} bin/rspec --fail-fast
 
-appraisal_update: build
-	COMMAND="bin/appraisal update" docker compose up
+server:
+	@docker compose -f extra/docker-compose.yml exec app_with_${DB} bin/rails s -b 0.0.0.0 -p ${SERVER_PORT}
 
-lint: build
-	COMMAND="bin/rubocop" docker compose up
+appraisal_update:
+	@docker compose -f extra/docker-compose.yml exec app_with_${DB} bin/appraisal update
 
-console:
-	docker compose exec -e "PAGER=more" app bin/rails console
+lint:
+	@docker compose -f extra/docker-compose.yml exec app_with_${DB} bin/rubocop
 
-shell:
-	docker compose exec -e "PAGER=more" app bash
+cleanup:
+	@docker compose -f extra/docker-compose.yml down -v --rmi local --remove-orphans

bin/rails

@@ -1,15 +1,12 @@
 #!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails gems
-# installed from the root of your application.
 
-ENV['DB_TEST'] ||= 'postgres'
-ENV['RAILS_ENV'] ||= 'test'
+ENV['DB_TEST'] ||= 'sqlite'
+ENV['RAILS_ENV'] ||= 'development'
 
 ENGINE_ROOT = File.expand_path('..', __dir__)
 ENGINE_PATH = File.expand_path('../lib/active_storage_db/engine', __dir__)
 APP_PATH = File.expand_path("../spec/dummy/config/application", __dir__)
 
-# Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 

docker-compose.yml

@@ -2,3 +2,5 @@ COMPOSE_PROJECT_NAME=active_storage_db
 
 UID=1000
 GID=1000
+
+SERVER_PORT=4000

.env extra/.env.env renamed to extra/.env

@@ -1,35 +1,28 @@
 ARG RUBY_IMAGE=ruby:3
 FROM ${RUBY_IMAGE}
 
-ARG DB_TEST=sqlite
-ARG RAILS_VERSION
-ARG UID
-
-ENV DB_TEST=$DB_TEST
-ENV DEVEL=1
-ENV PROJECT_PATH=/app
-ENV RAILS_ENV=development
-ENV RAILS_VERSION=$RAILS_VERSION
-
 ENV DEBIAN_FRONTEND=noninteractive
+ENV DEVEL=1
 ENV LANG=C.UTF-8
 
 RUN apt-get update -qq
-RUN apt-get install -yqq --no-install-recommends build-essential nano pkg-config
+RUN apt-get install -yqq --no-install-recommends build-essential nano netcat-traditional pkg-config
 RUN apt-get install -yqq --no-install-recommends freetds-dev libmariadb-dev libpq-dev libvips42 libyaml-dev sqlite3
 
 RUN gem install bundler -v 2.5.23
 RUN echo 'gem: --no-document' > /etc/gemrc
 
+ARG UID
 RUN useradd -u $UID --shell /bin/bash app 
-RUN mkdir /app_deps && mkdir -p /home/app
+
+RUN mkdir -p /home/app
 RUN chown -R app:app /home/app
 RUN chown -R app /usr/local/bundle 
 
+ARG RAILS_VERSION
+ENV RAILS_VERSION=$RAILS_VERSION
+
 WORKDIR /app
 COPY . /app
 RUN bundle install
-RUN bin/rails db:create db:migrate db:test:prepare
 RUN chown -R app:app /app/spec/dummy/db
-
-ENTRYPOINT ["extra/entrypoint.sh"]

extra/Dockerfile

@@ -5,26 +5,26 @@ There 3 ways to interact with this project:
 1) Using Docker:
 
 ```sh
-# Run build the dummy app image/container:
-make build
-# Run rails server on the dummy app:
+# Set the test DB driver (mysql / mssql / postgres / sqlite)
+export DB=sqlite
+# Start the base service (in the test dummy app):
+make up
+# With the base service started, start the Rails server (default port 4000):
 make server
-# Enter in a Rails console (with the dummy app started):
-make console
-# Enter in a shell (with the dummy app started):
+# With the base service started, enter in a shell:
 make shell
 
-# Run the test suite:
+# With the base service started, run the test suite:
 make specs
-# Run the linter on the project:
+# With the base service started, run the linter on the project:
 make lint
 
 # Remove container and image:
 make cleanup
 # For more commands please check the Makefile
 
-# To use a different Ruby version:
-RUBY=3.0 make build
+# To use a different db, Ruby and Rails:
+DB=postgres RUBY=3.4 RAILS=7.2 make up
 ```
 
 2) Using Appraisal:

extra/development.md

@@ -0,0 +1,81 @@
+services:
+  app: &app
+    build:
+      context: ..
+      dockerfile: extra/Dockerfile
+      args:
+        # Debian-based Ruby image:
+        RUBY_IMAGE: ruby:${RUBY:-3.2}-slim
+        RAILS_VERSION: ${RAILS:-}
+        UID: ${UID}
+    user: ${UID}:${GID}
+    ports:
+      - ${SERVER_PORT}:${SERVER_PORT}
+    working_dir: /app
+    volumes:
+      - ..:/app
+    stdin_open: true
+    tty: true
+    command: ${COMMAND:-extra/init.sh}
+
+  mssql:
+    image: mcr.microsoft.com/mssql/server:2022-latest
+    platform: linux/amd64
+    environment:
+      ACCEPT_EULA: Y
+      SA_PASSWORD: Pa%%w0rd
+
+  mysql:
+    image: mysql
+    platform: linux/amd64
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+
+  postgres:
+    image: postgres
+    environment:
+      POSTGRES_PASSWORD: password
+
+  app_with_mysql:
+    <<: *app
+    environment:
+      DB_TEST: mysql
+      DB_PORT: 3306
+      MYSQL_DB_HOST: mysql
+      MYSQL_DB_NAME: test_db
+      MYSQL_DB_USERNAME: root
+      MYSQL_DB_PASSWORD: password
+    depends_on:
+      - mysql
+
+  app_with_mssql:
+    <<: *app
+    environment:
+      DB_TEST: mssql
+      DB_PORT: 1433
+      MSSQL_DB_HOST: mssql
+      MSSQL_DB_NAME: test_db
+      MSSQL_DB_USERNAME: sa
+      MSSQL_DB_PASSWORD: Pa%%w0rd
+    depends_on:
+      - mssql
+
+  app_with_postgres:
+    <<: *app
+    environment:
+      DB_TEST: postgres
+      DB_PORT: 5432
+      PG_DB_HOST: postgres
+      PG_DB_NAME: test_db
+      PG_DB_USERNAME: postgres
+      PG_DB_PASSWORD: password
+    depends_on:
+      - postgres
+
+  app_with_sqlite:
+    <<: *app
+    environment:
+      DB_TEST: sqlite
+    volumes:
+      - ..:/app
+      - /app/spec/dummy/db

extra/docker-compose.yml

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# Wait the DB
+if [ "$DB_TEST" != "sqlite" ]; then
+    while ! nc -z $DB_TEST $DB_PORT </dev/null
+    do echo "Waiting for DB ($DB_TEST)..." && sleep 3; done
+    echo "DB is now available!"
+fi
+
+# Setup database
+bin/rails db:reset db:test:prepare
+
+#
+sh