Merge pull request #62 from blocknotes/dev/docker-setup-2

blocknotes · web-flow · commit 6b13d698b67c · 2025-03-27T09:33:42.000+01:00
Docker: dev setup (2)
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,3 @@
+Makefile
+MIT-LICENSE
+README.md
diff --git a/.env b/.env
@@ -1 +1,4 @@
 COMPOSE_PROJECT_NAME=active_storage_db
+
+UID=1000
+GID=1000
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -13,8 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      DB_TEST: sqlite
-      RAILS_VERSION: '7.1'
+      RUBY_VERSION: '3.0'
 
     steps:
       - name: Install dependencies
diff --git a/.github/workflows/specs_mssql_ruby30.yml b/.github/workflows/specs_mssql_ruby30.yml
@@ -46,7 +46,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_mssql_ruby32.yml b/.github/workflows/specs_mssql_ruby32.yml
@@ -46,7 +46,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_mssql_ruby34.yml b/.github/workflows/specs_mssql_ruby34.yml
@@ -46,7 +46,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_mysql_ruby30.yml b/.github/workflows/specs_mysql_ruby30.yml
@@ -54,7 +54,7 @@ jobs:
         run: sudo /etc/init.d/mysql start
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_mysql_ruby32.yml b/.github/workflows/specs_mysql_ruby32.yml
@@ -54,7 +54,7 @@ jobs:
         run: sudo /etc/init.d/mysql start
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_mysql_ruby34.yml b/.github/workflows/specs_mysql_ruby34.yml
@@ -54,7 +54,7 @@ jobs:
         run: sudo /etc/init.d/mysql start
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_postgres_ruby30.yml b/.github/workflows/specs_postgres_ruby30.yml
@@ -51,7 +51,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_postgres_ruby32.yml b/.github/workflows/specs_postgres_ruby32.yml
@@ -51,7 +51,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_postgres_ruby34.yml b/.github/workflows/specs_postgres_ruby34.yml
@@ -51,7 +51,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_sqlite_ruby32.yml b/.github/workflows/specs_sqlite_ruby32.yml
@@ -34,7 +34,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/.github/workflows/specs_sqlite_ruby34.yml b/.github/workflows/specs_sqlite_ruby34.yml
@@ -34,7 +34,7 @@ jobs:
           bundler-cache: true
 
       - name: Database setup
-        run: bundle exec rails db:create db:migrate
+        run: bin/rails db:reset db:test:prepare
 
       - name: Run tests
-        run: bundle exec rspec --profile
+        run: bin/rspec --profile
diff --git a/Appraisals b/Appraisals
@@ -31,8 +31,6 @@ MATRIX.each do |db, versions|
       appraise "#{db}_ruby#{ruby.delete('.')}_rails#{version.delete('.')}" do
         gem 'pg'
         gem 'rails', "~> #{version}.0"
-
-        gem 'sqlite3', '~> 1.4' if ruby == "3.0"
       end
     end
   end
diff --git a/Gemfile b/Gemfile
@@ -3,8 +3,8 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby_ver = ENV.fetch("RUBY_VERSION", "")
-rails_ver = ENV.fetch("RAILS_VERSION", "")
+ruby_ver = ENV.fetch('RUBY_VERSION', '')
+rails_ver = ENV.fetch('RAILS_VERSION', '')
 
 if ENV['DEVEL'] == '1'
   if !rails_ver.empty?
@@ -31,7 +31,7 @@ gem 'mysql2'
 gem 'pg'
 
 # DB driver: sqlite
-if !rails_ver.empty? && Gem::Version.new(rails_ver) < Gem::Version.new('7.2')
+if !ruby_ver.empty? && Gem::Version.new(ruby_ver) < Gem::Version.new('3.1')
   gem 'sqlite3', '~> 1.4'
 else
   gem 'sqlite3'
diff --git a/Makefile b/Makefile
@@ -1,44 +1,38 @@
+include .env
+
 help:
-	@echo "Main targets: up / down / console / shell"
+	@echo "Main targets: build / up / specs / console / shell"
 
 # Docker commands
-down:
-	docker compose down
-
-up:
-	docker compose up
+build:
+	@rm -f Gemfile.lock
+	@docker compose build
 
-attach:
-	docker compose attach app
+down:
+	@docker compose down
 
-up_attach:
-	docker compose up -d && docker compose attach app
+up: build
+	@docker compose up
 
 cleanup:
-	docker container rm -f active_storage_db_app && docker image rm -f active_storage_db-app
-
-# Rails specific commands
-db_reset:
-	docker compose exec app bin/rails db_reset
+	docker compose rm -f
+	docker image rm -f ${COMPOSE_PROJECT_NAME}-app
 
-console:
-	docker compose exec -e "PAGER=more" app bin/rails console
+# App commands
+server: build
+	COMMAND="bin/rails s -b 0.0.0.0 -p 4000" docker compose up
 
-routes:
-	docker compose exec app bin/rails routes
+specs: build
+	COMMAND="bin/rspec" docker compose up
 
-specs:
-	docker compose exec app bin/rspec --fail-fast
+appraisal_update: build
+	COMMAND="bin/appraisal update" docker compose up
 
-# Other commands
-appraisal_update:
-	docker compose exec app bin/appraisal update
+lint: build
+	COMMAND="bin/rubocop" docker compose up
 
-bundle:
-	docker compose exec app bundle
+console:
+	docker compose exec -e "PAGER=more" app bin/rails console
 
 shell:
 	docker compose exec -e "PAGER=more" app bash
-
-lint:
-	docker compose exec app bin/rubocop
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -7,18 +7,15 @@ services:
       args:
         # Debian-based Ruby image:
         RUBY_IMAGE: ruby:${RUBY:-3.2}-slim
+        RAILS_VERSION: ${RAILS:-}
         UID: ${UID}
-    environment:
-      DB_TEST: sqlite
-      RAILS_VERSION: ${RAILS:-}
-    user: "${UID}:${GID}"
+    user: ${UID}:${GID}
     ports:
-      - '3000:3000'
-    working_dir: '/app'
+      - 4000:4000
+    working_dir: /app
     volumes:
-      - '.:/app'
+      - .:/app
+      - /app/spec/dummy/db
     stdin_open: true
     tty: true
-    entrypoint:
-      - /bin/sh
-      - ./extra/entrypoint.sh
+    command: ${COMMAND:-sh}
diff --git a/extra/Dockerfile b/extra/Dockerfile
@@ -1,22 +1,35 @@
 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 LANG=C.UTF-8
+ENV PROJECT_PATH=/app
 ENV RAILS_ENV=development
+ENV RAILS_VERSION=$RAILS_VERSION
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV LANG=C.UTF-8
 
 RUN apt-get update -qq
-RUN DEBIAN_FRONTEND=noninteractive apt-get install -yqq --no-install-recommends build-essential nano pkg-config \
-  freetds-dev libmariadb-dev libpq-dev libvips42 libyaml-dev sqlite3
+RUN apt-get install -yqq --no-install-recommends build-essential nano 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
 
-RUN useradd -u ${UID} --shell /bin/bash app 
-RUN mkdir -p /home/app && chown -R app:app /home/app
+RUN useradd -u $UID --shell /bin/bash app 
+RUN mkdir /app_deps && mkdir -p /home/app
+RUN chown -R app:app /home/app
 RUN chown -R app /usr/local/bundle 
 
-USER ${UID}
+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"]
diff --git a/extra/development.md b/extra/development.md
@@ -5,20 +5,26 @@ There 3 ways to interact with this project:
 1) Using Docker:
 
 ```sh
-# Run rails server on the dummy app (=> http://localhost:3000 to access to ActiveAdmin):
-make up
+# Run build the dummy app image/container:
+make build
+# Run rails server on the dummy app:
+make server
 # Enter in a Rails console (with the dummy app started):
 make console
 # Enter in a shell (with the dummy app started):
 make shell
-# Run the linter on the project (with the dummy app started):
-make lint
-# Run the test suite (with the dummy app started):
+
+# Run the test suite:
 make specs
+# Run the linter on the project:
+make lint
+
 # Remove container and image:
 make cleanup
-# To try different versions of Ruby/Rails/ActiveAdmin edit docker-compose.yml
 # For more commands please check the Makefile
+
+# To use a different Ruby version:
+RUBY=3.0 make build
 ```
 
 2) Using Appraisal:
@@ -30,7 +36,7 @@ bin/appraisal
 # Run server (or any command):
 bin/appraisal rails s
 # Or with a specific configuration:
-bin/appraisal rails80-activeadmin rails s
+bin/appraisal postgres_ruby32_rails80 rails s
 ```
 
 3) With a local setup:
@@ -44,23 +50,34 @@ bundle update
 bin/rails db:reset
 # Run server (or any command):
 bin/rails s
-# To try different versions of Rails/ActiveAdmin edit extra/dev_setup.sh
+# To try different versions of Rails edit extra/dev_setup.sh
 ```
 
+### Useful commands
+
 Sample code to attach a file:
 
 ```ruby
 # Create a test post in the dummy app
-post = Post.create!(title: "test1")
-post.some_file.attach(io: Rails.root.join("../../README.md").open, filename: "README.md")
+post = Post.last || Post.create!(title: "test1")
+io = Rails.root.join("public/favicon.ico").open
+post.some_file.attach(io:, filename: "favicon.ico")
 ```
 
 ## Releases
 
 ```sh
 # Update lib/active_storage_db/version.rb with the new version
+
 # Update the gemfiles:
-bin/appraisal
+make cleanup
+RUBY=3.0 make appraisal_update
+
+make cleanup
+RUBY=3.2 make appraisal_update
+
+make cleanup
+RUBY=3.4 make appraisal_update
 ```
 
 ## Old dev setup
diff --git a/extra/entrypoint.sh b/extra/entrypoint.sh
@@ -1,8 +1,4 @@
-echo "> Install dependencies"
-rm -f Gemfile.lock && bundle install
+#!/bin/sh
 
-echo "> Run pending migrations"
-cd spec/dummy && bundle exec rails db:migrate
-
-echo "> Start Rails server"
-cd /app && rm -f spec/dummy/tmp/pids/server.pid && bundle exec rails s -b 0.0.0.0
+echo "> Execute command"
+exec "$@"
diff --git a/spec/dummy/config/database.yml b/spec/dummy/config/database.yml
diff --git a/spec/dummy/config/environments/development.rb b/spec/dummy/config/environments/development.rb
diff --git a/spec/dummy/db/schema_development.rb b/spec/dummy/db/schema_development.rb
diff --git a/spec/dummy/db_migrate/20200702202020_create_active_storage_tables.active_storage.rb b/spec/dummy/db_migrate/20200702202020_create_active_storage_tables.active_storage.rb
diff --git a/spec/dummy/db_migrate/20220202010101_create_posts.rb b/spec/dummy/db_migrate/20220202010101_create_posts.rb
diff --git a/spec/dummy/public/favicon.ico b/spec/dummy/public/favicon.ico

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Makefile`
	`2`	`+MIT-LICENSE`
	`3`	`+README.md`