dockerfile-rails 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56568105d5613dd366d84227a550dcdbc3f1f71460330772aa32c128ce5b922
-  data.tar.gz: 7b8539f3fb1ef2b26a29a9f33d7dccd825e433ddfdbc7034f6828118764f596f
+  metadata.gz: e81390f34a7074b21fb4fc08e82b3b378bf40b0bf32529d94a55a3fb8f5b55c1
+  data.tar.gz: 6e83d04de7615de96f75edf66dde5aa8d39624a2e745ae2de796d352559c097e
 SHA512:
-  metadata.gz: ae18c0c80988fd501ffa053f31752f73e2d6c8d94784b701bda85e5c1e7a01c5d0d12c48f9b8f1f6cf3c2f5a4bb718d1f5648a686bc5e819e09021c03c8c5de4
-  data.tar.gz: 3d4731ad7b9cc8b81c48fdb58a8324eee1c0b999a64cbe3fe27f2bde84afab6f7f7d83d09f5a40f6c829acfc8e235405e7126d6648e69282d4d68ec8e24436b3
+  metadata.gz: 16a4fc1e67c1583555b7fdae5af6346c8c2b06503d51b5896a89bd86c55d60e1506a65f50f3b5987f5962c6d14f4cfb1217d379884df168469f18b8f28f76d61
+  data.tar.gz: 031c86b3c27e7c594eef1fc3f653ada551a0fdae2919f753c46a339fdb30e378d7770b2db987acd10d2e0f84c36680a2c6190d5966b19383b36854ebfc6686ff

data/README.md

@@ -36,11 +36,14 @@ bin/rails generate dockerfile
 * `--cache` - use build caching to speed up builds
 * `--parallel` - use multi-stage builds to install gems and node modules in parallel
 
-### Add a Feature:
+### Add/remove a Feature:
 
 * `--ci` - include test gems in deployed image
 * `--compose` - generate a `docker-compose.yml` file
 * `--nginx` - serve static files via [nginx](https://www.nginx.com/).  May require `--root` on some targets to access `/dev/stdout`
+* `--no-link` - don't add [--link](https://docs.docker.com/engine/reference/builder/#copy---link) to COPY statements.  Some tools (like at the moment, [buildah](https://www.redhat.com/en/topics/containers/what-is-buildah)) don't yet support this feature.
+* `--no-lock` - don't add linux platforms, set `BUNDLE_DEPLOY`, or `--frozen-lockfile`.  May be needed at times to work around a [rubygems bug](https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343).
+* `--sudo` - install and configure sudo to enable `sudo -iu rails` access to full environment
 
 ### Add a Database:
 

data/Rakefile

@@ -36,7 +36,7 @@ namespace :test do
         '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} system:test"
+      sh "docker run -p 3000:3000 -e RAILS_MASTER_KEY=#{key} --rm system:test"
     end
   ensure
     rm_rf "test/tmp/system_test"

data/lib/generators/dockerfile_generator.rb

@@ -6,7 +6,7 @@ require_relative "../dockerfile-rails/scanner.rb"
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
-  OPTION_DEFAULTS = {
+  BASE_DEFAULTS = {
     "bin-cd" => false,
     "cache" => false,
     "ci" => false,
@@ -14,6 +14,8 @@ class DockerfileGenerator < Rails::Generators::Base
     "fullstaq" => false,
     "jemalloc" => false,
     "label" => {},
+    "link" => true,
+    "lock" => true,
     "mysql" => false,
     "nginx" => false,
     "parallel" => false,
@@ -24,10 +26,13 @@ class DockerfileGenerator < Rails::Generators::Base
     "redis" => false,
     "root" => false,
     "sqlite3" => false,
+    "sudo" => false,
     "swap" => nil,
     "yjit" => false,
   }.then { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
 
+  OPTION_DEFAULTS = BASE_DEFAULTS.dup
+
   @@labels = {}
   @@packages = { "base" => [], "build" => [], "deploy" => [] }
   @@vars = { "base" => {}, "build" => {}, "deploy" => {} }
@@ -67,6 +72,12 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
     desc: "include test gems in bundle"
 
+  class_option :link, type: :boolean, default: OPTION_DEFAULTS.lock,
+    desc: "use COPY --link whenever possible"
+
+  class_option :lock, type: :boolean, default: OPTION_DEFAULTS.lock,
+    desc: "lock Gemfile/package.json"
+
   class_option :precompile, type: :string, default: OPTION_DEFAULTS.precompile,
     desc: 'if set to "defer", assets:precompile will be done at deploy time'
 
@@ -121,6 +132,8 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :root, type: :boolean, default: OPTION_DEFAULTS.root,
     desc: "Run application as root user"
 
+  class_option :sudo, type: :boolean, default: OPTION_DEFAULTS.sudo,
+    desc: "Install and configure sudo to enable running as rails with full environment"
 
   class_option "add-base", type: :array, default: [],
     desc: "additional packages to install for both build and deploy"
@@ -208,18 +221,27 @@ class DockerfileGenerator < Rails::Generators::Base
 
     template "docker-compose.yml.erb", "docker-compose.yml" if options.compose
 
-    template "dockerfile.yml.erb", "config/dockerfile.yml", force: true
-
     if @gemfile.include?("vite_ruby")
       package = JSON.load_file("package.json")
       unless package.dig("scripts", "build")
         package["scripts"] ||= {}
-        package["scripts"]["build"] ||= "vite build --outDir public"
+        package["scripts"]["build"] = "vite build --outDir public"
 
         say_status :update, "package.json"
         IO.write("package.json", JSON.pretty_generate(package))
       end
     end
+
+    @dockerfile_config = (@dockerfile_config.to_a - BASE_DEFAULTS.to_h.stringify_keys.to_a).to_h
+    %w(packages envs args).each do |key|
+      @dockerfile_config.delete key if @dockerfile_config[key].empty?
+    end
+
+    if !@dockerfile_config.empty?
+      template "dockerfile.yml.erb", "config/dockerfile.yml", force: true
+    elsif File.exist? "config/dockerfile.yml"
+      remove_file "config/dockerfile.yml"
+    end
   end
 
 private
@@ -252,7 +274,7 @@ private
 
   def platform
     if options.platform
-      "--platform #{options.platform} "
+      "--platform=#{options.platform} "
     else
       ""
     end
@@ -295,33 +317,62 @@ private
   def install_gems
     ENV["BUNDLE_IGNORE_MESSAGES"] = "1"
 
+    gemfile = IO.read("Gemfile")
+
+    unless /^\s*source\s/.match?(gemfile)
+      gemfile = %{source "https://rubygems.org"\n} + gemfile
+    end
+
     if options.postgresql? || @postgresql
-      system "bundle add pg" unless @gemfile.include? "pg"
+      system "bundle add pg --skip-install" unless @gemfile.include? "pg"
     end
 
     if options.mysql? || @mysql
-      system "bundle add mysql2" unless @gemfile.include? "mysql2"
+      system "bundle add mysql2 --skip-install" unless @gemfile.include? "mysql2"
     end
 
     if options.redis? || using_redis?
-      system "bundle add redis" unless @gemfile.include? "redis"
+      system "bundle add redis --skip-install" unless @gemfile.include? "redis"
     end
 
-    # ensure linux platform is in the bundle lock
-    current_platforms = `bundle platform`
-    add_platforms = []
+    # https://stackoverflow.com/questions/70500220/rails-7-ruby-3-1-loaderror-cannot-load-such-file-net-smtp/70500221#70500221
+    if @gemfile.include? "mail"
+      %w(net-smtp net-imap net-pop).each do |gem|
+        system "bundle add #{gem} --skip-install --require false" unless @gemfile.include? gem
+      end
+    end
 
-    if !current_platforms.include?("x86_64-linux")
-      add_platforms += ["--add-platform=x86_64-linux"]
+    unless gemfile == IO.read("Gemfile")
+      system "bundle install --quiet"
     end
 
-    if !current_platforms.include?("aarch64-linux") && RUBY_PLATFORM.start_with?("arm64")
-      add_platforms += ["--add-platform=aarch64-linux"]
+    if options.lock?
+      # ensure linux platform is in the bundle lock
+      current_platforms = `bundle platform`
+      add_platforms = []
+
+      if !current_platforms.include?("x86_64-linux")
+        add_platforms += ["--add-platform=x86_64-linux"]
+      end
+
+      if !current_platforms.include?("aarch64-linux") && RUBY_PLATFORM.start_with?("arm64")
+        add_platforms += ["--add-platform=aarch64-linux"]
+      end
+
+      unless add_platforms.empty?
+        system "bundle lock #{add_platforms.join(" ")}"
+      end
     end
+  end
+
+  def base_gems
+    gems = ["bundler"]
 
-    unless add_platforms.empty?
-      system "bundle lock #{add_platforms.join(" ")}"
+    if options.ci? && options.lock? && @gemfile.include?("debug")
+      gems += %w(irb reline) - @gemfile
     end
+
+    gems.sort
   end
 
   def base_packages
@@ -370,9 +421,6 @@ private
     # add git if needed to install gems
     packages << "git" if @git
 
-    # add redis if Action Cable, caching, or sidekiq are used
-    packages << "redis" if options.redis? || using_redis?
-
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? "ruby-vips"
 
@@ -418,9 +466,6 @@ private
     packages << "postgresql-client" if options.postgresql? || @postgresql
     packages << "default-mysql-client" if options.mysql || @mysql
 
-    # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis" if using_redis?
-
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? "ruby-vips"
 
@@ -441,6 +486,9 @@ private
     # nginx
     packages << "nginx" if options.nginx?
 
+    # sudo
+    packages << "sudo" if options.sudo?
+
     packages.sort
   end
 
@@ -465,10 +513,13 @@ private
   def base_env
     env = {
       "RAILS_ENV" => "production",
-      "BUNDLE_DEPLOYMENT" => "1",
       "BUNDLE_WITHOUT" => options.ci? ? "development" : "development:test"
     }
 
+    if options.lock?
+      env["BUNDLE_DEPLOYMENT"] = "1"
+    end
+
     if @@args["base"]
       env.merge! @@args["base"].to_h { |key, value| [key, "$#{key}"] }
     end

data/lib/generators/templates/Dockerfile.erb

@@ -8,7 +8,7 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 
 <% end -%>
 <% if options.fullstaq -%>
-FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= @options.jemalloc ? 'jemalloc-' : '' %>slim<% unless options.precompile == "defer" %> as base<% end %>
+FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= options.jemalloc ? 'jemalloc-' : '' %>slim<% unless options.precompile == "defer" %> as base<% end %>
 <% else -%>
 FROM <%= platform %>ruby:$RUBY_VERSION-slim<% unless options.precompile == "defer" %> as base<% end %>
 <% end -%>
@@ -32,10 +32,7 @@ ENV <%= base_env.join(" \\\n    ") %>
 
 # Update gems and bundler
 RUN gem update --system --no-document && \
-<% if options.ci? -%>
-    gem install -N irb reline && \
-<% end -%>
-    gem install -N bundler
+    gem install -N <%= base_gems.join(" ") %>
 
 <% unless base_requirements.empty? -%>
 # Install packages needed to install <%= base_requirements %>
@@ -82,7 +79,7 @@ ENV <%= build_env.join(" \\\n    ") %>
 
 <% end -%>
 # Install application gems
-COPY Gemfile Gemfile.lock .
+COPY<% if options.link? %> --link<% end %> Gemfile Gemfile.lock ./
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
     bundle config set app_config .bundle && \
@@ -98,7 +95,8 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
 
 <% else -%>
 RUN bundle install<% if depend_on_bootsnap? -%> && \
-    bundle exec bootsnap precompile --gemfile<% end %>
+    bundle exec bootsnap precompile --gemfile<% end %> && \
+    rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
 
 <% end -%>
 <% if parallel? -%>
@@ -110,7 +108,7 @@ COPY --from=node /rails/node_modules /rails/node_modules
 
 <% end -%>
 # Copy application code
-COPY . .
+COPY<% if options.link? %> --link<% end %> . .
 
 <% if depend_on_bootsnap? -%>
 # Precompile bootsnap code for faster boot times
@@ -161,7 +159,7 @@ ARG UID=1000 \
     GID=1000
 RUN groupadd -f -g $GID rails && \
     useradd -u $UID -g $GID rails<% else -%>
-RUN useradd rails<% end -%><% if options.nginx? %> && \
+RUN useradd rails<% end -%> --home /rails --shell /bin/bash<% if options.nginx? %> && \
     chown rails:rails /var/lib/nginx /var/log/nginx/*<% end %>
 <% unless options.swap -%>
 USER rails:rails

data/lib/generators/templates/_apt_install.erb

@@ -6,6 +6,9 @@ RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
 <% else -%>
 RUN <%= repos %>apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= packages.join(" ") %><% if clean %> && \
+<% if packages.include?("sudo") && options.sudo? -%>
+    sed -i 's/env_reset/env_keep="*"/' /etc/sudoers && \
+<% end -%>
     rm -rf /var/lib/apt/lists /var/cache/apt/archives<% end %>
 <% end -%>
 <% if @sqlserver -%>

data/lib/generators/templates/_node_client.erb

@@ -9,5 +9,5 @@ ENV NODE_ENV=production
 <%= render partial: 'npm_install', locals: {sources: api_client_files} %>
 
 # build client application
-COPY <%= api_client_dir %> .
-RUN npm run build
+COPY<% if options.link? %> --link<% end %> <%= api_client_dir %> .
+RUN npm run build

data/lib/generators/templates/_npm_install.erb

@@ -1,8 +1,8 @@
 # Install node modules
-COPY <%=sources.join(' ') %> .
+COPY<% if options.link? %> --link<% end %> <%= sources.join(' ') %> ./
 <% if sources.join.include? 'yarn' -%>
 RUN <% if options.cache? -%>--mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
-    YARN_CACHE_FOLDER=/root/.yarn <% end -%>yarn install --frozen-lockfile
+    YARN_CACHE_FOLDER=/root/.yarn <% end -%>yarn install<% if options.lock? %> --frozen-lockfile<% end %>
 <% else -%>
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-npm-cache,target=/root/.npm \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails