dockerfile-rails 1.5.14 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe17ee50b4f27de006bd75e0c810a0dcc0340676c79888729039e2bce7394d3
-  data.tar.gz: 135cf712dcd44282a8255460288045078450fe809dd24413aa510eb2a5505a69
+  metadata.gz: 1a7a5c96358c0e7974364e0b23c6a6b15542c05e67c352b917c36619d7bf8618
+  data.tar.gz: 69df0f5095152bf72c20ec9b9607d2597b10225a9e7da584785c2ab147d619a7
 SHA512:
-  metadata.gz: 152a64e964d12c90dd9f723cfcc5a22f8676eca1aed835de5f829fb851b67075521115eeb24d5f72f4ec2482954a4bc3739c5f9f0b3594a167bf05af65f3da80
-  data.tar.gz: 76579f910905786f5b1c38320f3efce47accebd5d3e829a16e6cec5aa3a32ac609a3b9c4137f66f4d299ed3b32c4acda9643db32f1ac0825b187c501bea1cfdf
+  metadata.gz: d57bfbad64083ec22060f19ba971d3ab71383a1111cefc2a053b01cd670ef2b8652702b802e1ec6670e07dd93a19a46e534e22ed12b775913ed2042b8377a3e1
+  data.tar.gz: e7e6b18c708121fd4c9e7aaadff5c05a32e291e139ffdb4c72f1d8fe0eaaf8b9ca9bd93a742d112fd119d634c08f3ddcce89c21db38560073f462ab9e3e09447

data/README.md

@@ -34,6 +34,7 @@ different contents.  If both are specified, `--force` takes precedence.
 
 ### Runtime Optimizations:
 
+* `--alpine` - use [alpine](https://www.alpinelinux.org/) as base image
 * `--fullstaq` - use [fullstaq](https://fullstaqruby.org/) [images](https://github.com/evilmartians/fullstaq-ruby-docker) on [quay.io](https://quay.io/repository/evl.ms/fullstaq-ruby?tab=tags&tag=latest)
 * `--jemalloc` - use [jemalloc](https://jemalloc.net/) memory allocator
 * `--swap=n` - allocate swap space.  See [falloc options](https://man7.org/linux/man-pages/man1/fallocate.1.html#OPTIONS) for suffixes

data/Rakefile

@@ -42,5 +42,26 @@ namespace :test do
     rm_rf "test/tmp/system_test" unless ENV["TEST_KEEP"]
   end
 
+  task :alpine do
+    rm_rf "test/tmp/system_test"
+    Dir.chdir "test/tmp" do
+      sh "rails new system_test --javascript esbuild"
+      Dir.chdir "system_test"
+      sh "bundle config disable_local_branch_check true"
+      sh "bundle config set --local local.dockerfile-rails #{__dir__}"
+      sh "bundle add dockerfile-rails --group development " +
+        "--git https://github.com/rubys/dockerfile-rails.git"
+      sh "bin/rails generate dockerfile --alpine"
+      cp "#{__dir__}/test/docker-entrypoint", "bin"
+      IO.write "config/routes.rb",
+        'Rails.application.routes.draw {get "/up", to: proc {[200, {}, ["ok"]]}}'
+      sh "docker buildx build . --load -t system:test"
+      key = IO.read("config/master.key")
+      sh "docker run -p 3000:3000 -e RAILS_MASTER_KEY=#{key} --rm system:test"
+    end
+  ensure
+    rm_rf "test/tmp/system_test" unless ENV["TEST_KEEP"]
+  end
+
   task all: %w(test:rubocop test test:system)
 end

data/lib/generators/dockerfile_generator.rb

@@ -8,6 +8,7 @@ class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
   BASE_DEFAULTS = {
+    "alpine" => false,
     "bin-cd" => false,
     "cache" => false,
     "ci" => false,
@@ -39,7 +40,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "sentry" => false,
     "sudo" => false,
     "swap" => nil,
-    "variant" => "slim",
+    "variant" => nil,
     "windows" => false,
     "yjit" => false,
   }.yield_self { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
@@ -52,6 +53,25 @@ class DockerfileGenerator < Rails::Generators::Base
   @@args = { "base" => {}, "build" => {}, "deploy" => {} }
   @@instructions = { "base" => nil, "build" => nil, "deploy" => nil }
 
+  ALPINE_MAPPINGS = {
+    "build-essential" => "build-base",
+    "chromium-sandbox" => "chromium-chromedriver",
+    "default-libmysqlclient-dev" => "mysql-client",
+    "default-mysqlclient" => "mysql-client",
+    "freedts-bin" => "freedts",
+    "libicu-dev" => "icu-dev",
+    "libjemalloc" => "jemalloc-dev",
+    "libjpeg-dev" => "jpeg-dev",
+    "libmagickwand-dev" => "imagemagick-libs",
+    "libsqlite3-0" => "sqlite-dev",
+    "libtiff-dev" => "tiff-dev",
+    "libvips" => "vips-dev",
+    "node-gyp" => "gyp",
+    "pkg-config" => "pkgconfig",
+    "python" => "python3",
+    "python-is-python3" => "python3"
+  }
+
   # load defaults from config file
   if File.exist? "config/dockerfile.yml"
     options = YAML.safe_load(IO.read("config/dockerfile.yml"), symbolize_names: true)[:options]
@@ -146,6 +166,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :registry, type: :string, default: OPTION_DEFAULTS.registry,
     desc: "docker registry to use (example: registry.docker.com/library/)"
 
+  class_option :alpine, type: :boolean, default: OPTION_DEFAULTS.alpine,
+    descr: "use alpine image"
+
   class_option :variant, type: :string, default: OPTION_DEFAULTS.variant,
     desc: "dockerhub image variant (example: slim-bullseye)"
 
@@ -374,6 +397,10 @@ private
     end
   end
 
+  def variant
+    options.variant || (options.alpine ? "alpine" : "slim")
+  end
+
   def run_as_root?
     options.root?
   end
@@ -516,6 +543,10 @@ private
     gems.sort
   end
 
+  def alpinize(packages)
+    packages.map { |package| ALPINE_MAPPINGS[package] || package }.sort.uniq
+  end
+
   def base_packages
     packages = []
     packages += @@packages["base"] if @@packages["base"]
@@ -544,7 +575,13 @@ private
     # Passenger
     packages << "passenger" if using_passenger?
 
-    packages.sort.uniq
+    if options.alpine?
+      packages << "tzdata"
+
+      alpinize(packages)
+    else
+      packages.sort.uniq
+    end
   end
 
   def base_requirements
@@ -610,7 +647,11 @@ private
       end
     end
 
-    packages.sort.uniq
+    if options.alpine?
+      alpinize(packages)
+    else
+      packages.sort.uniq
+    end
   end
 
   def deploy_packages
@@ -659,7 +700,46 @@ private
       packages << "ruby-foreman"
     end
 
-    packages.sort
+    if options.alpine?
+      packages << "sqlite-libs" if @gemfile.include? "sqlite3"
+      packages << "libpq" if @gemfile.include? "pg"
+
+      alpinize(packages)
+    else
+      packages.sort.uniq
+    end
+  end
+
+  def pkg_update
+    if options.alpine?
+      "apk update"
+    else
+      "apt-get update -qq"
+    end
+  end
+
+  def pkg_install
+    if options.alpine?
+      "apk add"
+    else
+      "apt-get install --no-install-recommends -y"
+    end
+  end
+
+  def pkg_cache
+    if options.alpine?
+      { "dev-apk-cache" => "/var/cache/apk" }
+    else
+      { "dev-apt-cache" => "/var/cache/apt", "dev-apt-lib" => "/var/lib/apt" }
+    end
+  end
+
+  def pkg_cleanup
+    if options.alpine?
+      "/var/cache/apk/*"
+    else
+      "/var/lib/apt/lists /var/cache/apt/archives"
+    end
   end
 
   def base_repos
@@ -680,8 +760,8 @@ private
     else
       packages.sort!.uniq!
       unless packages.empty?
-        repos.unshift "apt-get update -qq &&",
-          "apt-get install --no-install-recommends -y #{packages.join(" ")} &&"
+        repos.unshift "#{pkg_update} &&",
+          "#{pkg_install} #{packages.join(" ")} &&"
       end
 
       repos.join(" \\\n    ") + " && \\\n    "
@@ -706,8 +786,8 @@ private
     else
       packages.sort!.uniq!
       unless packages.empty?
-        repos.unshift "apt-get update -qq &&",
-          "apt-get install --no-install-recommends -y #{packages.join(" ")} &&"
+        repos.unshift "#{pkg_update} &&",
+          "#{pkg_install} --no-install-recommends -y #{packages.join(" ")} &&"
       end
 
       repos.join(" \\\n    ") + " && \\\n    "
@@ -717,6 +797,7 @@ private
   def base_env
     env = {
       "RAILS_ENV" => "production",
+      "BUNDLE_PATH" => "/usr/local/bundle",
       "BUNDLE_WITHOUT" => options.ci? ? "development" : "development:test"
     }
 
@@ -734,7 +815,7 @@ private
 
     env.merge! @@vars["base"] if @@vars["base"]
 
-    env.map { |key, value| "#{key}=#{value.inspect}" }
+    env.map { |key, value| "#{key}=#{value.inspect}" }.sort
   end
 
   def build_env

data/lib/generators/templates/Dockerfile.erb

@@ -8,9 +8,9 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 
 <% end -%>
 <% if options.fullstaq -%>
-FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= options.jemalloc ? 'jemalloc-' : '' %><%= options.variant %><% unless options.precompile == "defer" %> as base<% end %>
+FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= options.jemalloc ? 'jemalloc-' : '' %><%= variant %><% unless options.precompile == "defer" %> as base<% end %>
 <% else -%>
-FROM <%= platform %><%= options.registry %>ruby:$RUBY_VERSION-<%= options.variant %><% unless options.precompile == "defer" %> as base<% end %>
+FROM <%= platform %><%= options.registry %>ruby:$RUBY_VERSION-<%= variant %><% unless options.precompile == "defer" %> as base<% end %>
 <% end -%>
 
 <% unless options.label.empty? -%>
@@ -87,6 +87,12 @@ ENV <%= build_env.join(" \\\n    ") %>
 <% end -%>
 # Install application gems
 COPY<% if options.link? %> --link<% end %> Gemfile Gemfile.lock ./
+<% if options.alpine? and deploy_packages.include? 'sqlite-libs' -%>
+# Workaround sqlite/alpine issue: https://github.com/sparklemotion/sqlite3-ruby/issues/434
+RUN bundle config force_ruby_platform true && \
+    bundle config set frozen false && \
+    bundle lock --add-platform ruby
+<% end -%>
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
 <% if private_gemserver_env_variable_name -%>
@@ -116,7 +122,7 @@ RUN --mount=type=secret,id=gemserver_credentials,dst=/kaniko/gemserver_credentia
 RUN bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
     bundle exec bootsnap precompile --gemfile<% end %> && \
 <% end -%>
-    rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
 
 <% end -%>
 <% if using_passenger? -%>
@@ -225,13 +231,23 @@ RUN mkdir /data
 <% user = "rails:rails" -%>
 ARG UID=1000 \
     GID=1000
+<% if options.alpine? -%>
+RUN addgroup --system --gid $GID rails && \
+    adduser --system rails --uid $UID --ingroup rails --home /home/rails --shell /bin/sh rails && \
+<% else -%>
 RUN groupadd -f -g $GID rails && \
     useradd -u $UID -g $GID rails --create-home --shell /bin/bash && \
+<% end -%>
 <% else -%>
 <% user = "1000:1000" -%>
+<% if options.alpine? -%>
+RUN addgroup --system --gid 1000 rails && \
+    adduser --system rails --uid 1000 --ingroup rails --home /home/rails --shell /bin/sh rails && \
+<% else -%>
 RUN groupadd --system --gid 1000 rails && \
     useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
 <% end -%>
+<% end -%>
 <% if options.nginx? -%>
     chown <%= user %> /var/lib/nginx /var/log/nginx/* && \
 <% end -%>

data/lib/generators/templates/_apt_install.erb

@@ -1,12 +1,11 @@
 <% if options.cache? -%>
-RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
-    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
-    <%= repos %>apt-get update -qq && \
-    apt-get install --no-install-recommends -y <%= packages.join(" ") %>
+RUN <%= pkg_cache.map {|name, path| "--mount=type=cache,id=#{name},sharing=locked,target=#{path} \\"}.join("\n    ") %>
+    <%= repos %><%= pkg_update %> && \
+    <%= pkg_install %> <%= packages.join(" ") %>
 <% else -%>
-RUN <%= repos %>apt-get update -qq && \
-    apt-get install --no-install-recommends -y <%= packages.join(" ") %><% if clean %> && \
-    rm -rf /var/lib/apt/lists /var/cache/apt/archives<% end %>
+RUN <%= repos %><%= pkg_update %> && \
+    <%= pkg_install %> <%= packages.join(" ") %><% if clean %> && \
+    rm -rf <%= pkg_cleanup %><% end %>
 <% end -%>
 <% if @sqlserver -%>
  # install freetds required by tiny_tds gem

data/lib/generators/templates/_install_node.erb

@@ -21,10 +21,15 @@ ARG NODE_VERSION=<%= node_version %>
 ARG YARN_VERSION=<%= yarn_version %>
 <% end -%>
 <% if node_version && node_version != 'lts' -%>
+<% if options.alpine? -%>
+RUN curl -sL https://unofficial-builds.nodejs.org/download/release/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-x64-musl.tar.gz | tar xz -C /tmp/ && \
+    cp -rp /tmp/node-v${NODE_VERSION}-linux-x64-musl/* /usr/local/ && \
+<% else -%>
 ENV PATH=/usr/local/node/bin:$PATH
 RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
     /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
 <% end -%>
+<% end -%>
 <% if yarn_version -%>
 <% if yarn_version < '2' -%>
 <% if node_version -%>   <% else %>RUN<% end %> npm install -g yarn@$YARN_VERSION<% if node_version -%> && \<% end %>
@@ -37,7 +42,11 @@ RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz
     corepack prepare yarn@$YARN_VERSION --activate<% if node_version -%> && \<% end %>
 <% end -%>
 <% end -%>
-<% if node_version -%>
+<% if node_version && node_version != 'lts' -%>
+<% if options.alpine? -%>
+    rm -rf /tmp/node-v${NODE_VERSION}-linux-x64-musl
+<% else -%>
     rm -rf /tmp/node-build-master
 <% end -%>
 <% end -%>
+<% end -%>

data/lib/generators/templates/docker-entrypoint.erb

@@ -1,4 +1,8 @@
+<% if options.alpine? -%>
+#!/bin/sh -e
+<% else -%>
 #!/bin/bash -e
+<% end -%>
 
 <% if options.swap && !File.exist?("fly.toml")-%>
 <% if run_as_root? or using_passenger? -%>
@@ -36,6 +40,9 @@ if [ "${*}" == "foreman start --procfile=<%= options.procfile %>" ]; then
 <% elsif procfile.size > 1 -%>
 # If running the production procfile then create or migrate existing database
 if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
+<% elsif procfile.values.first.start_with? "./bin/rails server" -%>
+# If running the rails server then create or migrate existing database
+if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]<% if using_litefs? %> && [ "$FLY_REGION" == "$PRIMARY_REGION" ]<%end%>; then
 <% else -%>
 # If running the rails server then create or migrate existing database
 if [ "${*}" == <%= procfile.values.first.inspect %> <% if using_litefs? %>-a "$FLY_REGION" == "$PRIMARY_REGION" <%end%>]; then

data/lib/generators/templates/dockerignore.erb

@@ -6,14 +6,14 @@
 # Ignore bundler config.
 /.bundle
 
+# Ignore all environment files (except templates).
+/.env*
+!/.env*.erb
+
 # Ignore all default key files.
 /config/master.key
 /config/credentials/*.key
 
-# Ignore all environment files.
-/.env*
-!/.env.example
-
 # Ignore all logfiles and tempfiles.
 /log/*
 /tmp/*

data/lib/generators/templates/node-version.erb

@@ -1 +1 @@
-<%= ENV["NODE_VERSION"] || node_version %>
+<%= ENV["NODE_VERSION"] || node_version %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.14
+  version: 1.6.0
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails