dockerfile-rails 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8dc8b1f01f52091af8e9cb3322db265d96698e80fc203bfc570135efd69cb06
-  data.tar.gz: 6054ee7cb322ed79092c6205cce1969b7ab9ad1d868113024845d90bb52d4448
+  metadata.gz: a56568105d5613dd366d84227a550dcdbc3f1f71460330772aa32c128ce5b922
+  data.tar.gz: 7b8539f3fb1ef2b26a29a9f33d7dccd825e433ddfdbc7034f6828118764f596f
 SHA512:
-  metadata.gz: 938d057a8f5faf7cca766898b5f6406a379bf90c1fc6116c05759e38a7d7439efdad941855a8cdf4029cc9aadd0131d7463a855e702fe8a69b7746250e1bfbd5
-  data.tar.gz: 4be1203c6fa6176c867dae6ef78511aa5e0a3c9943958430a8b77ba04cbb5368371d4ea3e100d4a037946cfd0f94ee7ced7425a1464bfe75450a3c1cc8703dbc
+  metadata.gz: ae18c0c80988fd501ffa053f31752f73e2d6c8d94784b701bda85e5c1e7a01c5d0d12c48f9b8f1f6cf3c2f5a4bb718d1f5648a686bc5e819e09021c03c8c5de4
+  data.tar.gz: 3d4731ad7b9cc8b81c48fdb58a8324eee1c0b999a64cbe3fe27f2bde84afab6f7f7d83d09f5a40f6c829acfc8e235405e7126d6648e69282d4d68ec8e24436b3

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

@@ -77,9 +77,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

@@ -214,7 +214,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))
@@ -293,6 +293,8 @@ private
   end
 
   def install_gems
+    ENV["BUNDLE_IGNORE_MESSAGES"] = "1"
+
     if options.postgresql? || @postgresql
       system "bundle add pg" unless @gemfile.include? "pg"
     end
@@ -304,6 +306,22 @@ private
     if options.redis? || using_redis?
       system "bundle add redis" unless @gemfile.include? "redis"
     end
+
+    # 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
 
   def base_packages
@@ -447,7 +465,7 @@ private
   def base_env
     env = {
       "RAILS_ENV" => "production",
-      "BUNDLE_PATH" => "vendor/bundle",
+      "BUNDLE_DEPLOYMENT" => "1",
       "BUNDLE_WITHOUT" => options.ci? ? "development" : "development:test"
     }
 

data/lib/generators/templates/Dockerfile.erb

@@ -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? -%>
     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 -%>
@@ -164,11 +163,14 @@ RUN groupadd -f -g $GID rails && \
     useradd -u $UID -g $GID rails<% else -%>
 RUN useradd rails<% end -%><% if options.nginx? %> && \
     chown rails:rails /var/lib/nginx /var/log/nginx/*<% end %>
+<% unless options.swap -%>
 USER rails:rails
+<% end -%>
 
 <% 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 --frozen-lockfile
 <% else -%>
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-npm-cache,target=/root/.npm \

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

@@ -1,13 +1,23 @@
 #!/bin/bash -e
 
 <% if options.swap -%>
-# allocate swap space
-fallocate -l <%= options.swap %> /swapfile
-chmod 0600 /swapfile
-mkswap /swapfile
-echo 10 > /proc/sys/vm/swappiness
-swapon /swapfile
-echo 1 > /proc/sys/vm/overcommit_memory
+<% if run_as_root? -%>
+<% @space = "" -%>
+<% else -%>
+<% @space = "  " -%>
+if [ $UID -eq 0 ]; then
+<% end -%>
+<%= @space %># allocate swap space
+<%= @space %>fallocate -l <%= options.swap %> /swapfile
+<%= @space %>chmod 0600 /swapfile
+<%= @space %>mkswap /swapfile
+<%= @space %>echo 10 > /proc/sys/vm/swappiness
+<%= @space %>swapon /swapfile
+<%= @space %>echo 1 > /proc/sys/vm/overcommit_memory
+<% unless run_as_root? -%>
+  exec su rails $0 $@
+fi
+<% end -%>
 
 <% end -%>
 <% if options.prepare -%>

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.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails