dockerfile-rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7730245e044329345b271524027cd640794a3577c4b49d2a2ce47a3cf21c94c4
-  data.tar.gz: 88fe182e5b8ab19d9725391cfaf1c0010e9d89d7cf44a9e3618f680bbe700315
+  metadata.gz: 536685e13e342227e5d6af85e3d778539668bbdab81b5430902ae08286a57c62
+  data.tar.gz: a3155769a131089493ae0682e195f6108dd4c81d03c79c6774ce21af0eda04be
 SHA512:
-  metadata.gz: 411539b040956ad9a1c437437aa36d2ed96a1769354162a2d8e57244c6a5b7dbf7fb1ff45efbd40f86da990b4741c01c6a871c84ac6be735104c4ab8ff39aa17
-  data.tar.gz: 06b7e3ac3225bca70269b8aae26dcb9e2f9846b911416a09f4af6f0be82137eebd7f365bf815e0ff1a6c0783a7b8d082cf1bf5856f9913e90bb349408868d60f
+  metadata.gz: 0547a5c9224213fdab9b99a2ca03e5aa411f086abb723b121561226079968e6da769f9acdf76ee123b1fbd57a64aa7d622c5dc44a48ab05717d9a523322955a1
+  data.tar.gz: 37923bd9eaa647b9ca44433ce374d30e0250799e7078669b180f2ac5734241dc7af757a58b12227de999d78e3d4171ae7e3e9ebbbf828e90f2d71184999fb8c7

data/README.md

@@ -1,3 +1,29 @@
 ## Purpose
 
-Provide Rails generators to produce Dockerfiles and related files.
+Provide Rails generators to produce Dockerfiles and related files.
+
+## Usage
+
+```
+bundle add dockerfile-rails
+bin/rails generate dockerfile
+```
+
+General options:
+
+* `--force` - overwrite existing files
+* `--ci` - include test gems in deployed image
+* `--cache` - use build caching to speed up builds
+* `--parallel` - use multi-stage builds to install gems and node modules in parallel
+* `--compose` - generate a `docker-compose.yml` file
+
+Dependencies:
+
+Generally the dockerfile generator will be able to determine what dependencies you
+are actually using.  But should you be using DATABASE_URL, for example, at runtime
+additional support may be needed:
+
+* `--mysql` - add mysql libraries
+* `--posgresql` - add posgresql libraries
+* `--redis` - add redis libraries
+* `--sqlite3` - add sqlite3 libraries

data/lib/dockerfile-rails/scanner.rb

@@ -18,6 +18,7 @@ module DockerfileRails
       ### ruby gems ###
 
       @gemfile = []
+      @git = false
 
       if File.exist? 'Gemfile.lock'
         parser = Bundler::LockfileParser.new(Bundler.read_file('Gemfile.lock'))
@@ -25,7 +26,9 @@ module DockerfileRails
       end
       
       if File.exist? 'Gemfile'
-        @gemfile += Bundler::Definition.build('Gemfile', nil, []).dependencies.map(&:name)
+        gemfile_definition = Bundler::Definition.build('Gemfile', nil, [])
+        @gemfile += gemfile_definition.dependencies.map(&:name)
+        @git = !gemfile_definition.spec_git_paths.empty?
       end
 
       @sidekiq = @gemfile.include? 'sidekiq'
@@ -62,14 +65,6 @@ module DockerfileRails
       end
 
       @redis = @redis_cable || @redis_cache || @sidekiq
-
-      ### api-only ###
-
-      @apionly = Rails.application.config.api_only
-
-      ### db:prepare ###
-
-      @dbprep = (Rails::VERSION::MAJOR >= 6) ? 'db:prepare' : 'db:migrate'
     end
   end
 end

data/lib/generators/dockerfile_generator.rb

@@ -1,6 +1,30 @@
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
+  class_option :ci, type: :boolean, default: false,
+    desc: 'include test gems in bundle'
+
+  class_option :cache, type: :boolean, default: false,
+    desc: 'use build cache to speed up installs'
+
+  class_option :parallel, type: :boolean, default: false,
+    desc: 'use build stages to install gems and node modules in parallel'
+
+  class_option :compose, type: :boolean, default: false,
+    desc: 'generate a docker-compose.yml file'
+
+  class_option :redit, type: :boolean, default: false,
+    desc: 'include redis libraries'
+
+  class_option :sqlite3, aliases: '--sqlite', type: :boolean, default: false,
+    desc: 'include sqlite3 libraries'
+
+  class_option :postgresql, aliases: '--postgres', type: :boolean, default: false,
+    desc: 'include postgresql libraries'
+
+  class_option :mysql, type: :boolean, default: false,
+    desc: 'include mysql libraries'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
@@ -13,12 +37,23 @@ class DockerfileGenerator < Rails::Generators::Base
 
     template 'docker-entrypoint.erb', 'bin/docker-entrypoint'
     chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
+
+    template 'docker-compose.yml.erb', 'docker-compose.yml'
   end
 
 private
    
   def using_node?
-    File.exist? 'package.json'
+    return @using_node if @using_node != nil
+    @using_node = File.exist? 'package.json'
+  end
+
+  def using_redis?
+    options.redis? or @redis
+  end
+
+  def parallel?
+    using_node? && options.parallel
   end
 
   def keeps?
@@ -31,17 +66,22 @@ private
     packages = %w(build-essential)
 
     # add databases: sqlite3, postgres, mysql
-    packages += %w(pkg-config libpq-dev default-libmysqlclient-dev)
+    packages << 'pkg-config' if options.sqlite3? or @sqlite3
+    packages << 'libpq-dev' if options.postgresql? or @postgresql
+    packages << 'default-libmysqlclient-dev' if options.mysql or @mysql
+
+    # add git if needed to install gems
+    packages << 'git' if @git
 
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis"
+    packages << "redis" if using_redis?
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
     # node support, including support for building native modules
     if using_node?
-      packages += %w(curl node-gyp) # pkg-config already listed above
+      packages += %w(curl node-gyp pkg-config)
 
       # module build process depends on Python, and debian changed
       # how python is installed with the bullseye release.  Below
@@ -63,15 +103,19 @@ private
       end
     end
 
-    packages.sort
+    packages.sort.uniq
   end
 
   def deploy_packages
+    packages = []
+
     # start with databases: sqlite3, postgres, mysql
-    packages = %w(libsqlite3-0 postgresql-client default-mysql-client)
+    packages << 'libsqlite3-0' if options.sqlite3? or @sqlite3
+    packages << 'postgresql-client' if options.postgresql? or @postgresql
+    packages << 'default-mysql-client' if options.mysql or @mysql
 
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis"
+    packages << "redis" if using_redis?
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
@@ -108,6 +152,16 @@ private
     binfixups
   end
 
+  def deploy_database
+    if options.postgresql? or @postgresql
+      'postgresql'
+    elsif options.mysql or @mysql
+      'mysql'
+    else
+      'sqlite3'
+    end
+  end
+
   def node_version
     using_node? and `node --version`[/\d+\.\d+\.\d+/]
   rescue
@@ -127,4 +181,12 @@ private
   def api_only?
     Rails.application.config.api_only
   end
+
+  def dbprep_command
+    if Rails::VERSION::MAJOR >= 6
+      'db:prepare'
+    else
+      'db:migrate'
+    end
+  end
 end

data/lib/generators/templates/Dockerfile.erb

@@ -10,16 +10,31 @@ WORKDIR /rails
 # Set production environment
 ENV RAILS_ENV="production" \
     BUNDLE_PATH="vendor/bundle" \
-    BUNDLE_WITHOUT="development:test"
+    BUNDLE_WITHOUT="<%= options.ci? ? 'test' : 'development:test' %>"
 
+ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
+RUN gem update --system --no-document && \
+    gem install -N bundler -v ${BUNDLER_VERSION}
 
-# Throw-away build stage to reduce size of final image
-FROM base as build
+
+# Throw-away build stage<%= parallel? ? 's' : '' %> to reduce size of final image
+FROM base as <%= parallel? ? 'pre' : '' %>build
 
 # Install packages need to build gems<%= using_node? ? " and node modules" : "" %>
+<% 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 \
+    apt-get update -qq && \
+<% else -%>
 RUN apt-get update -qq && \
+<% end -%>
     apt-get install -y <%= build_packages.join(" ") %>
 
+<% if parallel? -%>
+
+FROM prebuild as node
+
+<% end -%>
 <% if using_node? -%>
 # Install JavaScript dependencies
 ARG NODE_VERSION=<%= node_version %>
@@ -28,15 +43,47 @@ ENV VOLTA_HOME="/usr/local"
 RUN curl https://get.volta.sh | bash && \
     volta install node@$NODE_VERSION yarn@$YARN_VERSION
 
+<% end -%>
+<% if parallel? -%>
+# Install node modules
+COPY package.json yarn.lock ./
+<% 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 -%>
+
+
+FROM prebuild as build
+
 <% end -%>
 # Install application gems
 COPY Gemfile Gemfile.lock ./
-RUN bundle install
+<% 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 clean && \
+    mkdir -p vendor && \
+    bundle config set path vendor && \
+    cp -ar /srv/vendor .
+<% else -%>
+RUN bundle _${BUNDLER_VERSION}_ install
+<% end -%>
 
-<% if using_node? -%>
+<% if parallel? -%>
+asdf
+<% elsif using_node? -%>
 # Install node modules
 COPY package.json yarn.lock ./
+<% 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 -%>
 
 <% end -%>
 # Copy application code
@@ -54,19 +101,31 @@ RUN bundle exec bootsnap precompile --gemfile app/ lib/
 <% end -%>
 <% unless api_only? -%>
 # Precompiling assets for production without requiring secret RAILS_MASTER_KEY
-RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0') ? '=DUMMY' : '_DUMMY=1' %> ./bin/rails assets:precompile
 
 <% end -%>
 
 # Final stage for app image
 FROM base
+<% unless deploy_packages.empty? -%>
 
 # Install packages need for deployment
+<% 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 \
+    apt-get update -qq && \
+    apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %>
+<% else -%>
 RUN apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %> && \
     rm -rf /var/lib/apt/lists /var/cache/apt/archives
+<% end -%>
+<% end -%>
 
 # Copy built application from second stage
+<% if options.ci? -%>
+COPY --from=build /usr/local/bundle /usr/local/bundle
+<% end -%>
 COPY --from=build /rails /rails
 
 # Deployment options

data/lib/generators/templates/docker-compose.yml.erb

@@ -0,0 +1,71 @@
+version: "3.8"
+services:
+  web:
+    build: .
+    ports:
+      - "3000:3000"
+    environment:
+      - RAILS_MASTER_KEY=$RAILS_MASTER_KEY
+<% if using_redis? -%>
+      - REDIS_URL=redis://redis-db:6379
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+      - DATABASE_URL=postgres://root:password@postgres-db/
+<% elsif deploy_database == 'mysql' -%>
+      - DATABASE_URL=mysql2://root:password@mysql-db/
+<% end -%>
+<% if deploy_database == 'sqlite3' -%>
+    volumes:
+      - ./db:/rails/db
+<% end -%>
+<% if using_redis? or deploy_database != 'sqlite3' -%>
+    depends_on:
+<% if using_redis? -%>
+      redis-db:
+        condition: service_started
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+      postgres-db:
+        condition: service_healthy
+<% elsif deploy_database == 'mysql' -%>
+      mysql-db:
+        condition: service_healthy
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+
+  postgres-db:
+    image: postgres
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: password
+    volumes:
+      - ./tmp/db:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: pg_isready
+      interval: 2s
+      timeout: 5s
+      retries: 30
+<% elsif deploy_database == 'mysql' -%>
+
+  mysql-db:
+    image: mysql
+    command:
+      - --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+    volumes:
+      - ./tmp/db:/var/lib/mysql
+    healthcheck:
+      test: mysqladmin ping -h 127.0.0.1 -u root --password=password
+      interval: 2s
+      timeout: 5s
+      retries: 30
+<% end -%>
+<% end -%>
+<% if using_redis? -%>
+
+  redis-db:
+    image: redis
+<% end -%>

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

@@ -2,7 +2,7 @@
 
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
-  ./bin/rails db:prepare
+  ./bin/rails <%= dbprep_command %>
 fi
 
 exec "${@}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sam Ruby
@@ -37,6 +37,7 @@ files:
 - lib/dockerfile-rails/scanner.rb
 - lib/generators/dockerfile_generator.rb
 - lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/node-version.erb