dockerfile-rails 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf2a81e905971b1372422667990588003a30836174b539622aab105a84da0a3b
-  data.tar.gz: 54719c03a535654284006637b1ed1d29ae418c3686d7ecc773eaf510d75268ea
+  metadata.gz: 98b182ee88ad6c1ba34edb41778c9d59dd329eefb6b199ede26697ded174aedb
+  data.tar.gz: 94e946801bc23ae53ce8ba8a4c7f8129a58e04aad1db4b9cf05bc5d43b22cebb
 SHA512:
-  metadata.gz: b45fb087b5fed35931979b86ab5399af2a0406bba06eecbb3c6130272af1b429cb83a4f9d5fa8909e3b3d72ae124303ccff4fbe8b14ab3a2c4c57029e5057794
-  data.tar.gz: b022381f3e9a3639583345bebbf525ae67468c49f37ba8a659cc6ca14b4304865126c837d51935b5cad06cab50df00397b08aafd5a7595b40e93d056ffeb17b2
+  metadata.gz: f20bb484ad3637c100cf2ff9a786404a686e961db71dbfdc1d48d0b33ea461c8031bb2ddacc05ebd3857aaa5d318fe2d49c2ecc21cd760b1fa08fac9e963a28f
+  data.tar.gz: 80f23221cf71777312e57165a23b93a165feae6db3af97ac8c836e71295493ff952ca34f36e2a190f392508fb0e8a92b56a42c090262076063d75b386b96be56

data/DEMO.md

@@ -11,7 +11,7 @@ echo 'Rails.application.routes.draw { root "rails/welcome#index" }' > config/rou
 bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 docker buildx build . -t rails-demo
-docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-demo
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) --rm rails-demo
 ```
 
 # Demo 2 - Neofetch
@@ -45,7 +45,7 @@ EOF
 bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile --add neofetch colorized-logs
 docker buildx build . -t rails-demo
-docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-demo
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) --rm rails-demo
 ```
 
 Add `--load` to the `buildx` command if you want to save the image to local Docker.
@@ -187,7 +187,7 @@ bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 
 docker buildx build . -t rails-demo
-docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-demo
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) --rm rails-demo
 ```
 
 # Demo 5 - Bunding Javascript (esbuild)
@@ -307,7 +307,7 @@ bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 
 docker buildx build . -t rails-demo
-docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-demo
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) --rm rails-demo
 ```
 
 # Demo 6 - Grover / puppeteer / Chromium
@@ -337,5 +337,5 @@ EOF
 bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 docker buildx build . -t rails-demo
-docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-demo
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) --rm rails-demo
 ```

data/README.md

@@ -36,11 +36,12 @@ 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-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).
 
 ### Add a Database:
 
@@ -77,9 +78,15 @@ Options are saved between runs into `config/dockerfile.yml`.  To invert a boolea
 
 ## Testing
 
-The current testing strategy is to run `rails new` and `generate dockerfile` with various configurations and compare the generated artifacts with expected results.  `ARG` values in `Dockerfiles` are masked before comparison.
+A single invocation of `rake test:all` will run all of the tests defined.  dockerfile-rails has are three types of tests:
 
-Running all tests, or even a single individual test can be done as follows:
+  * `rake test:rubocop` runs [rubocop](https://github.com/rubocop/rubocop) using the same options as the Rails codebase.
+  * `rake test:system` creates a new esbuild application, generates a dockerfile, builds and runs it.  As this is time consuming, only one application is tested this way at this time, and a `--javascript` example was selected as it exercises a large portion of the features.
+  * `rake test` runs integration tests, as described below
+
+The current integration testing strategy is to run `rails new` and `generate dockerfile` with various configurations and compare the generated artifacts with expected results.  `ARG` values in `Dockerfiles` are masked before comparison.
+
+Running all integration tests, or even a single individual test can be done as follows:
 
 ```
 rake test

data/Rakefile

@@ -16,4 +16,31 @@ namespace :test do
     ENV["TEST_CAPTURE"] = "true"
     Rake::Task[:test].invoke
   end
+
+  task :rubocop do
+    sh "rubocop"
+  end
+
+  task :system 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"
+      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} system:test"
+    end
+  ensure
+    rm_rf "test/tmp/system_test"
+  end
+
+  task all: %w(test:rubocop test test:system)
 end

data/lib/generators/dockerfile_generator.rb

@@ -14,6 +14,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "fullstaq" => false,
     "jemalloc" => false,
     "label" => {},
+    "lock" => true,
     "mysql" => false,
     "nginx" => false,
     "parallel" => false,
@@ -67,6 +68,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
     desc: "include test gems in bundle"
 
+  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'
 
@@ -214,7 +218,7 @@ class DockerfileGenerator < Rails::Generators::Base
       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))
@@ -252,7 +256,7 @@ private
 
   def platform
     if options.platform
-      "--platform #{options.platform} "
+      "--platform=#{options.platform} "
     else
       ""
     end
@@ -293,16 +297,49 @@ private
   end
 
   def install_gems
+    ENV["BUNDLE_IGNORE_MESSAGES"] = "1"
+
+    gemfile = IO.read("Gemfile")
+
     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
+
+    # 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
+
+    unless gemfile == IO.read("Gemfile")
+      system "bundle install --quiet"
+    end
+
+    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
 
@@ -352,9 +389,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"
 
@@ -400,9 +434,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"
 
@@ -447,10 +478,13 @@ private
   def base_env
     env = {
       "RAILS_ENV" => "production",
-      "BUNDLE_PATH" => "vendor/bundle",
       "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 -%>
@@ -30,13 +30,12 @@ ARG <%= base_args.map {|key, value| "#{key}=#{value.inspect}"}.join(" \\\n    ")
 # Set production environment
 ENV <%= base_env.join(" \\\n    ") %>
 
-# Update gems and preinstall the desired version of bundler
-ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
+# Update gems and bundler
 RUN gem update --system --no-document && \
-<% if options.ci? -%>
+<% if options.ci? and options.lock? -%>
     gem install -N irb reline && \
 <% end -%>
-    gem install -N bundler -v ${BUNDLER_VERSION}
+    gem install -N bundler
 
 <% unless base_requirements.empty? -%>
 # Install packages needed to install <%= base_requirements %>
@@ -83,12 +82,12 @@ ENV <%= build_env.join(" \\\n    ") %>
 
 <% end -%>
 # Install application gems
-COPY Gemfile Gemfile.lock ./
+COPY 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 && \
     bundle config set path /srv/vendor && \
-    bundle _${BUNDLER_VERSION}_ install && \
+    bundle install && \
 <% if depend_on_bootsnap? -%>
     bundle exec bootsnap precompile --gemfile && \
 <% end -%>
@@ -98,7 +97,7 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
     cp -ar /srv/vendor .
 
 <% else -%>
-RUN bundle _${BUNDLER_VERSION}_ install<% if depend_on_bootsnap? -%> && \
+RUN bundle install<% if depend_on_bootsnap? -%> && \
     bundle exec bootsnap precompile --gemfile<% end %>
 
 <% end -%>
@@ -170,7 +169,8 @@ USER rails:rails
 
 <% end -%>
 <% unless options.precompile == "defer" -%>
-# Copy built application from previous stage
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
 COPY --from=build <% unless run_as_root? %>--chown=rails:rails <% end %>/rails /rails
 <% if api_client_dir -%>
 

data/lib/generators/templates/_install_node.erb

@@ -15,18 +15,19 @@ ARG YARN_VERSION=<%= yarn_version %>
 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 && \
-    npm install -g yarn@$YARN_VERSION && \
-    rm -rf /tmp/node-build-master
 <% end -%>
 <% if yarn_version -%>
 <% if yarn_version < '2' -%>
-RUN npm install -g yarn@$YARN_VERSION
+<% if node_version -%>   <% else %>RUN<% end %> npm install -g yarn@$YARN_VERSION<% if node_version -%> && \<% end %>
 <% else -%>
 <% if (node_version.split('.').map(&:to_i) <=> [16,10,0]) < 0 -%>
-RUN npm i -g corepack && \
+    npm i -g corepack && \
 <% else -%>
-RUN corepack enable && \
+    corepack enable && \
+<% end -%>
+    corepack prepare yarn@$YARN_VERSION --activate<% if node_version -%> && \<% end %>
 <% end -%>
-    corepack prepare yarn@$YARN_VERSION --activate
 <% end -%>
+<% if node_version -%>
+    rm -rf /tmp/node-build-master
 <% end -%>

data/lib/generators/templates/_npm_install.erb

@@ -1,12 +1,8 @@
 # Install node modules
 COPY <%=sources.join(' ') %> .
 <% if sources.join.include? 'yarn' -%>
-<% if options.cache? -%>
-RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
-    YARN_CACHE_FOLDER=/root/.yarn yarn install
-<% else -%>
-RUN yarn install
-<% end -%>
+RUN <% if options.cache? -%>--mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
+    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 \

data/lib/generators/templates/dockerignore.erb

@@ -20,10 +20,12 @@
 <% if keeps? -%>
 !/log/.keep
 !/tmp/.keep
+<% end -%>
 
 # Ignore pidfiles, but keep the directory.
 /tmp/pids/*
 !/tmp/pids/
+<% if keeps? -%>
 !/tmp/pids/.keep
 <% end -%>
 

metadata

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