error_agency-docker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c15090368cdb7f05997649fc30b8b5ba503e9074d0bd632668884d9aabd720d1
+  data.tar.gz: 07cdaf4a149e8a9cdbeb320bee00e50de20e9152eea1480835983553813916d7
+SHA512:
+  metadata.gz: b5ab5420644d64d838d449935e329b0125fa2502d9a7089a7a276610177bc8b6527b8684e14ce1bbeda9a24e504f0fc561748b8dc8ee238e90bcd76d5127d332
+  data.tar.gz: da4f0c9722239ce029881475cfc2f4f6a4979c23ac6307418d75ef8ef8342362da3ccb81e31b48bed0552af3c99f44a9ece86e673936d2ed35b03ae9ed94e6b7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in error_agency-docker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Error Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# ErrorAgency::Docker
+
+A Rails generator to add docker configurations to your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'error_agency-docker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install error_agency-docker
+
+## Usage
+
+### Development Environment
+Run `rails g error_agency:docker:development_environment` to set up docker configs for development.
+
+The following optional switches add more containers or change behaviour:
+
+`--elasticsearch` - add an elasticsearch container
+`--elasticsearch-version` - defaults to 6.2.4
+`--headless-chrome` - add a headless chrome container for selenium tests
+`--mysql-version` - defaults to 5.6
+`--ruby-version` - defaults to 6.2.5 
+
+Requires Rails 5 or 6.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/errorstudio/error_agency-docker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "error_agency/docker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/error_agency-docker.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "error_agency/docker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "error_agency-docker"
+  spec.version       = ErrorAgency::Docker::VERSION
+  spec.authors       = ["Ed Jones", "Paul Hendrick", "Sean Hawkridge"]
+  spec.email         = ["ed@error.agency", "paul@error.agency", "sean@error.agency"]
+
+  spec.summary       = "A Rails generator for docker configurations"
+  spec.homepage      = "https://github.com/errorstudio/error_agency-docker"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/errorstudio/error_agency-docker.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "rails", ">= 5", "<= 7"
+end

data/lib/error_agency/docker.rb

@@ -0,0 +1,8 @@
+require "error_agency/docker/version"
+
+module ErrorAgency
+  module Docker
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/error_agency/docker/version.rb

@@ -0,0 +1,5 @@
+module ErrorAgency
+  module Docker
+    VERSION = "0.1.0"
+  end
+end

data/lib/generators/error_agency/docker/development_environment_generator.rb

@@ -0,0 +1,53 @@
+module ErrorAgency
+  module Docker
+    class DevelopmentEnvironmentGenerator < Rails::Generators::Base
+
+      desc "Install files for running Rails in docker containers, in development."
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :build, type: :boolean, desc: "Build the docker images after running the generator", default: false
+      class_option :mysql, type: :boolean, desc: "Generate docker configs for MySQL. Installs by default.", default: true
+      class_option :redis, type: :boolean, desc: "Generate docker configs for Redis. Installs by default.", default: true
+      class_option :mailhog, type: :boolean, desc: "Generate docker configs for Mailhog. Installed by default.", default: true
+      class_option :elasticsearch, type: :boolean, desc: "Generate docker configs for Elasticsearch. NOT installed by default.", default: false
+      class_option :headless_chrome, type: :boolean, desc: "Generate configs for headless Chrome. NOT installed by default."
+      class_option :ruby_version, type: :string, desc: "Define the Ruby version to use", default: "2.6.5"
+      class_option :elasticsearch_version, type: :string, desc: "Define the Elasticsearch version to use", default: "6.2.4"
+      class_option :mysql_version, type: :string, desc: "Define the MySQL version to use", default: "5.6"
+
+
+      def create_docker_compose
+        @mysql = options[:mysql]
+        @redis = options[:redis]
+        @elasticsearch = options[:elasticsearch]
+        @mailhog = options[:mailhog]
+        @mysql_version = options[:mysql_version]
+
+        template "docker_compose.yml.erb", "docker-compose.yml"
+      end
+
+      def create_rails_base
+        @ruby_version = options[:ruby_version]
+
+        template "rails_base/Dockerfile.erb", "config/docker/rails_base/Dockerfile"
+        template "rails_base/entrypoint.sh.erb", "config/docker/rails_base/entrypoint.sh"
+      end
+
+      def create_elasticsearch
+        if options[:elasticsearch]
+          @elasticsearch_version = options[:elasticsearch_version]
+          template "elasticsearch/Dockerfile.erb", "config/docker/elasticsearch/Dockerfile"
+        end
+      end
+
+      def build_images
+        if options[:build]
+          system "docker-compose build"
+        end
+      end
+
+
+    end
+  end
+end

data/lib/generators/error_agency/docker/templates/docker_compose.yml.erb

@@ -0,0 +1,122 @@
+version: '3.5'
+
+services:
+    rails_base: &rails_base
+        build:
+            context: .
+            dockerfile: ./config/docker/rails_base/Dockerfile
+        tmpfs:
+            - /tmp
+        volumes:
+            - .:/app:cached
+            - bundle:/bundle
+            - node_modules:/app/node_modules
+            - packs:/app/public/packs
+            - rails_cache:/app/tmp/cache
+            - ~/.ssh:/root/.ssh
+            - irb_history:/root/irb_history
+            - ./config/docker/web/.irbrc:/root/.irbrc
+        stdin_open: true
+        tty: true
+
+    web:
+        <<: *rails_base
+        ports:
+            - 3000:3000
+        command: rails s -b 0.0.0.0
+        environment:
+            - WEBPACKER_DEV_SERVER_HOST=webpacker
+
+    webpacker:
+        <<: *rails_base
+        ports:
+            - 3035:3035
+        command: ./bin/webpack-dev-server
+        environment:
+            - WEBPACKER_DEV_SERVER_HOST=0.0.0.0
+
+    shell:
+        <<: *rails_base
+        command: bash
+
+    <% if @mysql %>
+    mysql:
+        image: mysql:<%= @mysql_version %>
+        volumes:
+            - ./config/docker/mysql/my.cnf:/etc/mysql/conf.d/my.cnf
+            - db_data:/var/lib/mysql
+            - .:/app:cached
+        environment:
+            - MYSQL_ROOT_PASSWORD=root
+        labels:
+            - maintainer='paul@error.agency'
+        ports:
+            - 3306:3306
+    <% end %>
+
+    <% if @redis %>
+    redis:
+        image: redis:3.2
+        labels:
+            - maintainer='paul@error.agency'
+        ports:
+            - 6379:6379
+    <% end %>
+    <% if @mailhog %>
+    mailhog:
+        command: ["-smtp-bind-addr", "0.0.0.0:2525"]
+        user: root
+        image: mailhog/mailhog
+        ports:
+            - 2525:2525
+            - 8025:8025
+    <% end %>
+
+    <% if @elasticsearch %>
+    elasticsearch:
+        build:
+            context: .
+            dockerfile: ./config/docker/elasticsearch/Dockerfile
+        ports:
+            - "9200:9200"
+            - "8080:8080"
+        environment:
+            # LOGSPOUT: 'ignore'
+            # ES_JAVA_OPTS: '-Xms1024m -Xmx1024m'
+            # bootstrap.memory_lock: 'false'
+            discovery.type: 'single-node'
+        # ulimits:
+        #   memlock:
+        #     soft: -1
+        #     hard: -1
+        #   nofile:
+        #     soft: 262144
+        #     hard: 262144
+        volumes:
+            - es_data:/usr/share/elasticsearch/data
+        healthcheck:
+            test: ["CMD", "curl", "-SsfL", "127.0.0.1:9200/_cat/health?h=status"]
+            interval: 10s
+            timeout: 1s
+            retries: 10
+    <% end %>
+
+    <% if @headless_chrome %>
+    chrome:
+    logging:
+        driver: none
+    ports:
+        - 5900:5900
+    build:
+        context: .
+        shm_size: 2g
+        dockerfile: ./config/docker/chrome/Dockerfile
+    <% end %>
+volumes:
+    bundle:
+    node_modules:
+    rails_cache:
+    packs:
+    db_data:
+    irb_history:
+    <% if @elasticsearch %>es_data:<% end %>

data/lib/generators/error_agency/docker/templates/elasticsearch/Dockerfile.erb

@@ -0,0 +1 @@
+FROM docker.elastic.co/elasticsearch/elasticsearch:<%= @elasticsearch_version %>

data/lib/generators/error_agency/docker/templates/headless_chrome/Dockerfile.erb

@@ -0,0 +1,2 @@
+FROM selenium/standalone-chrome
+LABEL maintainer='ed@error.agency'

data/lib/generators/error_agency/docker/templates/rails_base/Dockerfile.erb

@@ -0,0 +1,31 @@
+FROM ruby:<%= @ruby_version %>
+LABEL maintainer="paul@error.agency"
+
+# Install curl for fetching other apt repos
+RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends apt-transport-https nano gpg
+
+# Add NodeJS repo
+RUN curl -sL https://deb.nodesource.com/setup_8.x | bash -
+
+# Add Yarn repo
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
+
+RUN apt-get update -yqq && apt-get install -yqq --no-install-recommends nodejs yarn
+
+RUN gem update --system && gem install bundler -v '2'
+
+# Configure bundler and PATH
+ENV LANG=C.UTF-8 \
+GEM_HOME=/bundle \
+BUNDLE_JOBS=4 \
+BUNDLE_RETRY=3
+ENV BUNDLE_PATH $GEM_HOME
+ENV BUNDLE_APP_CONFIG=$BUNDLE_PATH \
+BUNDLE_BIN=$BUNDLE_PATH/bin
+ENV PATH /app/bin:$BUNDLE_BIN:$PATH
+
+RUN mkdir -p /app
+
+ENTRYPOINT ["/app/config/docker/web/entrypoint.sh"]
+WORKDIR /app

data/lib/generators/error_agency/docker/templates/rails_base/entrypoint.sh.erb

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+rm -f /app/tmp/pids/server.pid
+exec "$@"

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: error_agency-docker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ed Jones
+- Paul Hendrick
+- Sean Hawkridge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7'
+description: 
+email:
+- ed@error.agency
+- paul@error.agency
+- sean@error.agency
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- error_agency-docker.gemspec
+- lib/error_agency/docker.rb
+- lib/error_agency/docker/version.rb
+- lib/generators/error_agency/docker/development_environment_generator.rb
+- lib/generators/error_agency/docker/templates/docker_compose.yml.erb
+- lib/generators/error_agency/docker/templates/elasticsearch/Dockerfile.erb
+- lib/generators/error_agency/docker/templates/headless_chrome/Dockerfile.erb
+- lib/generators/error_agency/docker/templates/rails_base/Dockerfile.erb
+- lib/generators/error_agency/docker/templates/rails_base/entrypoint.sh.erb
+homepage: https://github.com/errorstudio/error_agency-docker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/errorstudio/error_agency-docker
+  source_code_uri: https://github.com/errorstudio/error_agency-docker.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Rails generator for docker configurations
+test_files: []