Dockerfile and Github Action (#576)

* Update Dockerfile to match rails
* Add Github Action to build Dockerfile

Author: justin808

.controlplane/Dockerfile

@@ -1,39 +1,69 @@
-FROM ruby:3.1.2
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.1.2
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
 
-RUN apt-get update
+# Install packages needed to build gems and node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential curl git libpq-dev libvips node-gyp pkg-config python-is-python3
 
-# install node and yarn
-RUN curl -sL https://deb.nodesource.com/setup_18.x | bash
-RUN apt-get install -y nodejs
-RUN npm install -g yarn
+# Install JavaScript dependencies
+# Make sure NODE_VERSION matches the node version in .nvmrc and package.json
+ARG NODE_VERSION=18.13.0
+ARG YARN_VERSION=1.22.19
+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
 
+# Rails app lives here
 WORKDIR /app
 
-# install ruby gems
-COPY Gemfile* ./
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development test"
 
-RUN bundle config set without 'development test' && \
-    bundle config set with 'staging production' && \
-    bundle install --jobs=3 --retry=3
 
-# install node packages
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+
+# Install node modules
 COPY package.json yarn.lock ./
-RUN yarn install
+RUN yarn install --frozen-lockfile
+
+# Copy application code
+COPY . .
+
+# Final stage for app image
+FROM base
 
-COPY . ./
+# Install packages needed for deployment
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libvips postgresql-client && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
 
-ENV RAILS_ENV=production
-ENV NODE_ENV=production
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /app /app
 
+ENV RAILS_ENV=production \
+    NODE_ENV=production \
+    SECRET_KEY_BASE=NOT_USED_NON_BLANK
 # compiling assets requires any value for ENV of SECRET_KEY_BASE
-ENV SECRET_KEY_BASE=NOT_USED_NON_BLANK
 
 RUN yarn res:build
-RUN rails react_on_rails:locale
-RUN rails assets:precompile
+RUN bin/rails react_on_rails:locale
+RUN bin/rails assets:precompile
 
 # add entrypoint
 COPY .controlplane/entrypoint.sh ./
 ENTRYPOINT ["/app/entrypoint.sh"]
 
-CMD ["rails", "s"]
+CMD ["rails", "server"]

.controlplane/entrypoint.sh

@@ -1,5 +1,7 @@
-#!/bin/sh
+#!/bin/bash -e
 # Runs before the main command
+# This script is unique to this demo project as it ensures the database and redis are ready before running the rails server
+
 
 wait_for_service()
 {
@@ -18,8 +20,13 @@ echo " -- Waiting for services"
 wait_for_service $(echo $DATABASE_URL | sed -e 's|^.*@||' -e 's|/.*$||')
 wait_for_service $(echo $REDIS_URL | sed -e 's|redis://||' -e 's|/.*$||')
 
-echo " -- Preparing database"
-rails db:prepare
+# If running the rails server then create or migrate existing database
+if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then
+  echo " -- Preparing database"
+  ./bin/rails db:prepare
+fi
 
 echo " -- Finishing entrypoint.sh, executing '$@'"
+
+# Run the main command
 exec "$@"

.github/workflows/deploy-to-control-plane.yml

@@ -20,7 +20,7 @@ env:
   CPLN_TOKEN: ${{secrets.CPLN_TOKEN}}
 
 jobs:
-  deploy-to-control-plane:
+  build-image-for-control-plane:
     runs-on: ubuntu-latest
 
     steps:
@@ -39,28 +39,15 @@ jobs:
           cpln --version
           gem install cpl -v 1.1.2
 
-      - name: setup-control-plane-tools-staging
-        run: |
-          cpln profile create default --token ${{ secrets.CPLN_TOKEN_STAGING }} --org ${{ secrets.CPLN_TOKEN_STAGING }} --gvc ${{ secrets.APP_NAME_STAGING }}
-          cpln image docker-login
-
       - name: Set Short SHA
         id: vars
         run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
 
-      - name: Get short SHA
-        id: short_sha
-        run: echo "SHORT_SHA=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+      - name: cpl profile
+        run: |
+          cpln profile update default --token ${CPLN_TOKEN}
 
-      - name: Containerize and push image
+      - name: cpl build-image
         run: |
-          cpl build-image -a ${{ secrets.APP_NAME_STAGING }} --commit ${env.SHORT_SHA::7}
-#      # Containerize and push the application to the org's private image repository. The tag is the short SHA of the commit.
-#      - name: Containerize application and push image
-#        shell: bash
-#        run: |
-#          cpln profile update default --token ${CPLN_TOKEN}
-#          cpln image docker-login
-#          cpln image build --name ${CPLN_IMAGE}:${{steps.vars.outputs.sha_short}} --dockerfile ./Dockerfile --push
-##
-##  build-and-push:
+          cpln image docker-login
+          cpl build-image -a ${{ secrets.APP_NAME_STAGING }} --commit ${{steps.vars.outputs.sha_short}}

.overcommit.yml

@@ -0,0 +1,33 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  RuboCop:
+#    enabled: true
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

Dockerfile

@@ -5,8 +5,6 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby "3.1.2"
 
-gem "cpl", "~>1.1.2"
-
 gem "react_on_rails", "13.4.0"
 gem "shakapacker", "7.1.0"
 

Gemfile

@@ -116,11 +116,6 @@ GEM
       term-ansicolor (~> 1.6)
       thor (>= 0.20.3, < 2.0)
       tins (~> 1.16)
-    cpl (1.1.2)
-      debug (~> 1.7.1)
-      dotenv (~> 2.8.1)
-      psych (~> 5.1.0)
-      thor (~> 1.2.1)
     crass (1.0.6)
     database_cleaner (2.0.2)
       database_cleaner-active_record (>= 2, < 3)
@@ -135,7 +130,6 @@ GEM
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    dotenv (2.8.1)
     drb (2.1.1)
       ruby2_keywords
     erubi (1.12.0)
@@ -429,7 +423,6 @@ DEPENDENCIES
   capybara-screenshot
   coffee-rails
   coveralls_reborn (~> 0.25.0)
-  cpl (~> 1.1.2)
   database_cleaner
   debug (>= 1.0.0)
   factory_bot_rails