dockman 0.1.3

data/lib/generators/dockman/dockify/skeleton/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Creates all the required files to dockerize this Rails project for Development
+
+Example:
+    rails generate dockman:dockify:skeleton NAME
+
+    This will create:
+    - A `warehouse` folder
+    - An `infra` folder
+    - The `Dockerfile`
+    - `docker-compose` ymls for the main app and the database
+    - A `.dockerignore` file
+    - An `envrc` which holds the ENV vars
+
+    ..and will append some entries to `.gitignore`

data/lib/generators/dockman/dockify/skeleton/skeleton_generator.rb

@@ -0,0 +1,45 @@
+require 'erb'
+module Dockman
+  module Dockify
+    class SkeletonGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_warehouse
+        directory 'warehouse'
+      end
+
+      def copy_infra
+        directory 'infra'
+        if File.exist?('config/database.yml')
+          File.rename('config/database.yml',"config/database.#{Time.now.to_i}.yml")
+        end
+        copy_file 'config/database.yml'
+      end
+
+      def copy_docker_related
+        copy_file 'docker-compose.yml'
+        copy_file 'docker-compose.dbs.yml'
+        copy_file 'Dockerfile'
+        copy_file 'docker-sync.yml'
+        copy_file '.dockerignore'
+        template 'envrc.erb', '.env.development'
+      end
+
+      def ignore_responsibly
+        append_to_file '.gitignore' do <<-IGN
+/warehouse/
+/.docker-sync/
+/.envrc
+        IGN
+        end
+      end
+
+      def create_docker_volumes_and_networks
+        system "docker volume create #{file_name}-web-sync"
+        system "docker volume create #{file_name}-bundle-sync"
+        system "docker network create #{file_name}-nginx-proxy"
+      end
+
+    end
+  end
+end

data/lib/generators/dockman/dockify/skeleton/templates/.dockerignore

@@ -0,0 +1,54 @@
+.git
+.gitignore
+README.md
+
+#
+# OS X
+#
+.DS_Store
+.AppleDouble
+.LSOverride
+# Icon must end with two \r
+Icon
+# Thumbnails
+._*
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+#
+# Rails
+#
+.env
+.env.sample
+*.rbc
+capybara-*.html
+log
+tmp
+db/*.sqlite3
+db/*.sqlite3-journal
+public/system
+coverage/
+spec/tmp
+**.orig
+
+.bundle
+
+.ruby-version
+.ruby-gemset
+
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+vendor/assets/bower_components
+*.bowerrc
+bower.json
+/warehouse/
+/.docker-sync/
+/.envrc

data/lib/generators/dockman/dockify/skeleton/templates/Dockerfile

@@ -0,0 +1,48 @@
+FROM ruby:2.5.1
+RUN apt-get update && \
+  apt-get install --no-install-recommends -y \
+  build-essential \
+  git-core \
+  libxml2 \
+  libxml2-dev \
+  libxslt1-dev \
+  nodejs \
+  imagemagick \
+  libmagickcore-dev \
+  libmagickwand-dev \
+  libpq-dev \
+  inetutils-ping \
+  tzdata \
+  libpq-dev \
+  ca-certificates \
+  unzip \
+# The entries below are used for capybara testing.
+# Uncomment accordingly
+#  libicu-dev \
+#  qt5-default \
+#  libqt5webkit5-dev \
+#  gstreamer1.0-plugins-base \
+#  gstreamer1.0-tools \
+#  gstreamer1.0-x \
+#  xvfb \
+#  xauth \
+#  openjdk-8-jre \
+  wget --fix-missing && \
+  rm -rf /var/lib/apt/lists/*
+
+RUN mkdir /app
+RUN mkdir -p /root/.ssh/
+
+WORKDIR /app
+
+RUN ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+ENV GEM_HOME /bundle
+ENV PATH $GEM_HOME/bin:$PATH
+ENV BUNDLE_PATH /bundle
+ENV BUNDLE_BIN /bundle/bin/
+RUN gem install bundler   && bundle config --global path "$GEM_HOME"   && bundle config --global bin "$GEM_HOME/bin" && bundle config --global build.puma --with-opt-dir=/usr/local
+RUN curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-6.4.2-amd64.deb
+RUN dpkg -i filebeat-6.4.2-amd64.deb
+RUN echo "deb http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main" > /etc/apt/sources.list.d/pgdg.list && wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && apt-get update && apt-get install -y postgresql-client-10 && rm -rf /var/lib/apt/lists/*
+RUN gem install debase -v "0.2.3.beta2"
+RUN gem install ruby-debug-ide -v "0.7.0.beta6"

data/lib/generators/dockman/dockify/skeleton/templates/config/database.yml

@@ -0,0 +1,89 @@
+# PostgreSQL. Versions 9.1 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On OS X with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On OS X with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  database: <%= ENV.fetch("DB_NAME") %>_development
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  username: <%= ENV.fetch("DB_USER") %>
+
+  # The password associated with the postgres role (username).
+  password: <%= ENV.fetch("DB_PASS") %>
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  host: <%= ENV.fetch("DB_HOST") %>
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  port: <%= ENV.fetch("DB_PORT") %>
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: <%= ENV.fetch("DB_NAME") %>_test
+  username: <%= ENV.fetch("DB_USER") %>
+  password: <%= ENV.fetch("DB_PASS") %>
+  host: <%= ENV.fetch("DB_HOST") %>
+  port: <%= ENV.fetch("DB_PORT") %>
+
+# As with config/secrets.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  database: <%= ENV.fetch("DB_NAME") %>_production
+  username: <%= ENV.fetch("DB_USER") %>
+  password: <%= ENV['DB_PASS'] %>

data/lib/generators/dockman/dockify/skeleton/templates/docker-compose.dbs.yml

@@ -0,0 +1,71 @@
+version: '3.6'
+
+services:
+  nginx:
+    image: jwilder/nginx-proxy
+    ports:
+      - "${PUMA_DEV_PORT}:80"
+    volumes:
+      - "/etc/nginx/conf.d"
+      - "/etc/nginx/vhost.d"
+      - "/usr/share/nginx/html"
+      - "/var/run/docker.sock:/tmp/docker.sock:ro"
+    environment:
+      - VIRTUAL_PROTO=http
+    networks:
+      - proxy-tier
+
+  postgres:
+    image: 'postgres:10.3-alpine'
+    volumes:
+      - './warehouse/pg/data:/var/lib/postgresql/data'
+      - './warehouse/pg-dumps:/root'
+    expose:
+      - ${DB_PORT}
+    environment:
+      - POSTGRES_USER=${PG_USER}
+      - POSTGRES_PASSWORD=${PG_PASSWORD}
+      # - POSTGRES_DB=template1
+      - VIRTUAL_PORT=${DB_PORT}
+      - VIRTUAL_HOST=pg.${COMPOSE_PROJECT_NAME}.test
+    networks:
+      - proxy-tier
+
+  pgadmin:
+    image: dpage/pgadmin4
+    expose:
+      - '80'
+    volumes:
+      - './warehouse/pgadmin:/var/lib/pgadmin'
+    environment:
+      - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEF_EMAIL}
+      - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEF_PASSWORD}
+      - VIRTUAL_HOST=pgadmin.${COMPOSE_PROJECT_NAME}.test
+      - VIRTUAL_PORT=80
+      # ports:
+      # - "7072:80"
+    networks:
+      - proxy-tier
+
+  hasura:
+    image: hasura/graphql-engine:v1.0.0-alpha28
+    expose:
+      - '8080'
+      # ports:
+      # - "8080:8080"
+    networks:
+      - proxy-tier
+    environment:
+      - HASURA_GRAPHQL_DATABASE_URL=postgres://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}_development
+      - VIRTUAL_HOST=hasura.${COMPOSE_PROJECT_NAME}.test
+      - VIRTUAL_PORT=8080
+      - HASURA_GRAPHQL_ENABLE_CONSOLE=true
+#    volumes:
+#      - ./infra/scripts/wait-for:/root/wait-for
+#    command: sh -c '/root/wait-for ${DB_HOST}:${DB_PORT} -t 5 -- /bin/graphql-engine serve'
+#    depends_on:
+#      - ${DB_HOST}
+networks:
+  proxy-tier:
+    external: true
+    name: "${COMPOSE_PROJECT_NAME}-nginx-proxy"

data/lib/generators/dockman/dockify/skeleton/templates/docker-compose.yml

@@ -0,0 +1,65 @@
+version: '3.6'
+services:
+  web:
+    build: .
+    command: infra/scripts/wait-for-it.sh ${DB_HOST}:${DB_PORT} -t 120 -- infra/scripts/start-dev.sh
+    volumes:
+      - "project-web-sync:/app:nocopy"
+      - "project-bundle-sync:/bundle:nocopy"
+    expose:
+      - "7000"
+    environment:
+      VIRTUAL_HOST: web.${COMPOSE_PROJECT_NAME}.test
+      VIRTUAL_PORT: 7000
+      DB_USER: ${DB_USER}
+      DB_PASS: ${DB_PASS}
+      DB_HOST: ${DB_HOST}
+      DB_NAME: ${DB_NAME}
+      DB_PORT: ${DB_PORT}
+      PG_USER: ${PG_USER}
+      PG_PASSWORD: ${PG_PASSWORD}
+      RAILS_ENV: development
+      #     RAILS_LOG_TO_STDOUT: "true"
+#      DEBUG_MODE: "on"
+    ports:
+      - "26168"
+      - "1234:1234"
+    tty: true
+    stdin_open: true
+    networks:
+      - proxy-tier
+
+  guard:
+    build: .
+    command: bundle exec guard --no-bundler-warning --no-interactions
+    volumes:
+      - "project-bundle-sync:/bundle:nocopy"
+      - "project-web-sync:/app:nocopy"
+    environment:
+      VIRTUAL_HOST: web.${COMPOSE_PROJECT_NAME}.test
+      VIRTUAL_PORT: 7000
+      DB_USER: ${DB_USER}
+      DB_PASS: ${DB_PASS}
+      DB_HOST: ${DB_HOST}
+      DB_NAME: ${DB_NAME}
+      DB_PORT: ${DB_PORT}
+      PG_USER: ${PG_USER}
+      PG_PASSWORD: ${PG_PASSWORD}
+      RAILS_ENV: development
+    tty: true
+    stdin_open: true
+    networks:
+      - proxy-tier
+
+volumes:
+  project-web-sync:
+    external: true
+    name: ${COMPOSE_PROJECT_NAME}-web-sync
+  project-bundle-sync:
+    external: true
+    name: ${COMPOSE_PROJECT_NAME}-bundle-sync
+
+networks:
+  proxy-tier:
+    external: true
+    name: "${COMPOSE_PROJECT_NAME}-nginx-proxy"

data/lib/generators/dockman/dockify/skeleton/templates/docker-sync.yml

@@ -0,0 +1,7 @@
+version: '2'
+syncs:
+  ${COMPOSE_PROJECT_NAME}-web-sync:
+    src: '.'
+    sync_excludes: ['.idea', '.sass-cache', 'sass', 'sass-cache', 'composer.json' , 'bower.json', 'package.json', 'Gruntfile*', 'bower_components', 'node_modules', '.gitignore', '.git', 'log','.envrc','.env.development', 'tmp/cache', 'tmp/storage','warehouse','vendor/bundle']
+  ${COMPOSE_PROJECT_NAME}-bundle-sync:
+    src: './warehouse/bundle'

data/lib/generators/dockman/dockify/skeleton/templates/envrc.erb

@@ -0,0 +1,27 @@
+# Those values will be used in the Rail's project database.yml
+export DB_PASS="Passw0rd"
+export DB_USER=<%= file_name %>_user
+
+# This points to the name of the container; do not change unless you understand what this means
+export DB_HOST=postgres
+export DB_PORT=5432
+export DB_NAME=<%= file_name %>
+
+# You need to have a local development server like puma-dev (it will also work with pow, but it is deprecated, you have been warned)
+export PUMA_DEV_PORT=24633
+
+# This is the prefix of any container name that will be created via docker and docker-compose
+# You need to make sure that this is unique among all your docker projects
+# THIS IS IMPORTANT!
+export COMPOSE_PROJECT_NAME=<%= file_name %>
+
+# This is the Postgres admin user
+export PG_USER=postgres
+export PG_PASSWORD=postgres
+export PG_MAINTENANCE_DB=template1
+
+# Credentials for the pgadmin4 application
+export PGADMIN_DEF_EMAIL=myemail@example.com
+export PGADMIN_DEF_PASSWORD="Passw0rd"
+
+# alias compdbs="COMPOSE_PROJECT_NAME=oss-dbs comp -f docker-compose.dbs.yml"

data/lib/generators/dockman/dockify/skeleton/templates/infra/scripts/create_db_user.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+PGPASSWORD="$PG_PASSWORD" psql -v ON_ERROR_STOP=1 --username "$PG_USER" -h "$DB_HOST" -c "CREATE USER $DB_USER PASSWORD '$DB_PASS' CREATEDB CREATEROLE INHERIT LOGIN;" &> /dev/null
+
+#psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" -d "$POSTGRES_DB" <<-EOSQL
+#    CREATE USER "$PG_USER" PASSWORD "$PG_PASSWORD" CREATEDB CREATEROLE INHERIT LOGIN;
+#    ALTER DATABASE "$DB_NAME" OWNER TO "$DB_USER";
+#EOSQL
+
+# The below has been removed from above

data/lib/generators/dockman/dockify/skeleton/templates/infra/scripts/init-user-db.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" -c "CREATE USER $DB_USER PASSWORD '$DB_PASS' CREATEDB CREATEROLE INHERIT LOGIN;" &> /dev/null
+#<<-EOSQL
+#    CREATE USER docker;
+#    CREATE DATABASE docker;
+#    GRANT ALL PRIVILEGES ON DATABASE docker TO docker;
+#EOSQL

data/lib/generators/dockman/dockify/skeleton/templates/infra/scripts/start-dev.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+bundle check || bundle install
+
+#until PGPASSWORD=nopass psql -h "db" -U "myamsix_returns" -d "myamsix_abstract" -c '\q'; do
+#  >&2 echo "Postgres is unavailable - sleeping"
+#  sleep 1
+#done
+#
+#>&2 echo "Postgres is up - executing command"
+
+if bin/rails db:migrate:status &> /dev/null; then
+  bin/rails db:migrate
+else
+  bin/rails db:setup
+fi
+
+if [ -z "${DEBUG_MODE}" ]; then
+   rm -rf tmp/pids/* && bundle exec rails server --port 7000 --binding 0.0.0.0 -e development
+ else
+   rm -rf tmp/pids/* && bundle exec rdebug-ide --key-value --evaluation-timeout 10 --evaluation-control --time-limit 100 --memory-limit 0 --rubymine-protocol-extensions --host 0.0.0.0 --port 1234 --dispatcher-port 26168 -- bin/rails server -b 0.0.0.0 -p 7000 -e development
+fi

data/lib/generators/dockman/dockify/skeleton/templates/infra/scripts/validate-migrated

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+if rails db:migrate:status &> /dev/null; then
+  rails db:migrate
+else
+  rails db:setup
+fi

data/lib/generators/dockman/dockify/skeleton/templates/infra/scripts/wait-for

@@ -0,0 +1,79 @@
+#!/bin/sh
+
+TIMEOUT=15
+QUIET=0
+
+echoerr() {
+  if [ "$QUIET" -ne 1 ]; then printf "%s\n" "$*" 1>&2; fi
+}
+
+usage() {
+  exitcode="$1"
+  cat << USAGE >&2
+Usage:
+  $cmdname host:port [-t timeout] [-- command args]
+  -q | --quiet                        Do not output any status messages
+  -t TIMEOUT | --timeout=timeout      Timeout in seconds, zero for no timeout
+  -- COMMAND ARGS                     Execute command with args after the test finishes
+USAGE
+  exit "$exitcode"
+}
+
+wait_for() {
+  for i in `seq $TIMEOUT` ; do
+    nc -z "$HOST" "$PORT" > /dev/null 2>&1
+
+    result=$?
+    if [ $result -eq 0 ] ; then
+      if [ $# -gt 0 ] ; then
+        exec "$@"
+      fi
+      exit 0
+    fi
+    sleep 1
+  done
+  echo "Operation timed out" >&2
+  exit 1
+}
+
+while [ $# -gt 0 ]
+do
+  case "$1" in
+    *:* )
+    HOST=$(printf "%s\n" "$1"| cut -d : -f 1)
+    PORT=$(printf "%s\n" "$1"| cut -d : -f 2)
+    shift 1
+    ;;
+    -q | --quiet)
+    QUIET=1
+    shift 1
+    ;;
+    -t)
+    TIMEOUT="$2"
+    if [ "$TIMEOUT" = "" ]; then break; fi
+    shift 2
+    ;;
+    --timeout=*)
+    TIMEOUT="${1#*=}"
+    shift 1
+    ;;
+    --)
+    shift
+    break
+    ;;
+    --help)
+    usage 0
+    ;;
+    *)
+    echoerr "Unknown argument: $1"
+    usage 1
+    ;;
+  esac
+done
+
+if [ "$HOST" = "" -o "$PORT" = "" ]; then
+  echoerr "Error: you need to provide a host and port to test."
+  usage 2
+fi
+
+wait_for "$@"