containers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10eb220c07fba010dcc7f06bfbece1feef00f33f7521ea6c64422e0158d5f4b2
+  data.tar.gz: fc61199216e1aa3fe368d5a26b98b775a31cf3ac0a6723fae29c25d0fe5f9912
+SHA512:
+  metadata.gz: 9d597a36e082a8d692de221f41e60d07a38bb509cf08e56d47123178ee680bd46af86f8981b57aef772772a4da587976c5894da36f943127ec5b259d50cd6d07
+  data.tar.gz: 50dc68c00349412c3f74a799a0c47b054dea7cdd8d078a9c87987a3d79b2f84d42fbd6540414ccb00b5757b6bfcea09ccce1dd09b688b8769e473fbca4d1f040

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in containers.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    containers (0.1.0)
+      rainbow (~> 3.1.1)
+      thor (~> 1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    async (2.0.3)
+      console (~> 1.10)
+      io-event (~> 1.0.0)
+      timers (~> 4.1)
+    async-http (0.56.6)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+      traces (~> 0.4.0)
+    async-http-faraday (0.11.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.33.0)
+      async
+    async-pool (0.3.10)
+      async (>= 1.25)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    console (1.15.3)
+      fiber-local
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.4.0)
+      faraday (>= 0.8)
+    faraday-net_http (2.0.3)
+    fiber-local (1.0.0)
+    github_changelog_generator (1.16.4)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-event (1.0.9)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    multi_json (1.15.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.6)
+    protocol-http1 (0.14.4)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    ruby_jard (0.3.1)
+      byebug (>= 9.1, < 12.0)
+      pry (~> 0.13.0)
+      tty-screen (~> 0.8.1)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    thor (1.2.1)
+    timers (4.3.3)
+    traces (0.4.1)
+    tty-screen (0.8.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  containers!
+  github_changelog_generator (~> 1.16.4)
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  ruby_jard (~> 0.3.1)
+
+BUNDLED WITH
+   2.3.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Hopsoft
+
+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,24 @@
+# Containers
+
+## TODOs
+
+### Questions to prompt on generate
+
+- [ ] container logging?
+- [ ] admin tooling?
+
+#### Punt on these for now
+
+```
+containers generate compose
+containers add anycable
+containers remove anycable
+```
+
+- [ ] sinatra?
+- [ ] rails?
+- [ ] anycable?
+- [ ] actioncable?
+- [ ] caching? (redis)
+- [ ] background jobs?
+  - [ ] backend? (sidekiq, ...)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/containers.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/containers/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "containers"
+  gem.version = Containers::VERSION
+  gem.authors = ["Hopsoft"]
+  gem.email = ["natehop@gmail.com"]
+
+  gem.summary = "Manage local development environments with Docker"
+  gem.description = "Manage local development environments with Docker"
+  gem.homepage = "https://github.com/hopsoft/containers"
+  gem.license = "MIT"
+  gem.required_ruby_version = ">= 2.6.0"
+
+  # gem.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  gem.metadata["homepage_uri"] = gem.homepage
+  gem.metadata["source_code_uri"] = gem.homepage
+  gem.metadata["changelog_uri"] = "#{gem.homepage}/CHANGELOG.md"
+
+  # 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.
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  gem.bindir = "exe"
+  gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rainbow", "~> 3.1.1"
+  gem.add_dependency "thor", "~> 1.2.1"
+
+  gem.add_development_dependency "github_changelog_generator", "~> 1.16.4"
+  gem.add_development_dependency "ruby_jard", "~> 0.3.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/containers

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "containers"
+
+Containers::CLI.start(ARGV)

data/lib/containers/cli.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "thor"
+require "rainbow"
+require_relative "./generator"
+
+module Containers
+  class CLI < Thor
+    COMMAND_PREFIX = "▶"
+
+    alias_method :execute, :exec
+
+    desc "generate", "Commands used to generate files for the project"
+    subcommand "generate", Generator
+
+    desc "up", "Brings up the environment defined in docker-compose.yml"
+    def up(*args)
+      execute_command "docker compose up -d #{args.join " "}"
+    end
+
+    desc "down", "Tears down the environment defined in docker-compose.yml"
+    def down(*args)
+      execute_command "docker compose down #{args.join " "}"
+    end
+
+    desc "list", "Lists all containers for this project"
+    method_option :detailed, type: :boolean, aliases: "-d", desc: "List detailed container information"
+    method_option :service, type: :boolean, aliases: "-s", desc: "List container service names"
+    def list(*args)
+      return execute_command "docker ps -a | grep #{project_name}" if options[:detailed]
+
+      if options[:service]
+        command = "containers list -f"
+        puts_command "#{command} | #{Rainbow("(strip project name)").green.faint}"
+        list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(COMMAND_PREFIX) }
+        puts list.map { |item| item.gsub(/\A#{project_name}-|\s/, "") }.sort.join("\n")
+        return
+      end
+
+      command = "containers list -d"
+      puts_command "#{command} | #{Rainbow("(strip docker details)").green.faint}"
+      list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(COMMAND_PREFIX) }
+      puts list.map { |item| item.split(" ").last.strip }.sort.join("\n")
+    end
+
+    desc "inspect", "Inspects a container"
+    method_option :container, type: :string, aliases: "-c", required: true, desc: "The short name for the container"
+    def inspect(*args)
+      execute_command "docker inspect #{args.join " "} #{project_name}-#{options[:container]}"
+    end
+
+    desc "attach", "Attaches to a running container"
+    method_option :container, type: :string, aliases: "-c", required: true, desc: "The short name for the container"
+    def attach(*args)
+      execute_command "docker attach #{project_name}-#{options[:container]} #{args.join " "}"
+    end
+
+    desc "exec", "Executes a command in a container"
+    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
+    def exec(*args)
+      options[:container] = "shell" if options[:container].to_s.strip == ""
+      execute_command "docker exec -it #{project_name}-#{options[:container]} #{args.join " "}"
+    end
+
+    desc "tail", "Tails container logs"
+    method_option :container, type: :array, aliases: "-c", required: true, desc: "The short name for the container (also supports a list of names)"
+    def tail(*args)
+      args << "--since 5m" unless args.include?("--since")
+      execute_command "docker compose logs #{args.join " "} -f #{options[:container].join " "}"
+    end
+
+    desc "start", "Starts container(s)"
+    method_option :container, type: :string, aliases: "-c", desc: "The short name for the container"
+    def start(*args)
+      return execute_command "docker start #{args.join " "} #{project_name}-#{options[:container]}" if options[:container]
+      container_names.each { |c| execute_command "docker start #{args.join " "} #{c}", replace_current_process: false }
+    end
+
+    desc "stop", "Stops container(s)"
+    method_option :container, type: :string, aliases: "-c", desc: "The short name for the container"
+    def stop(*args)
+      return execute_command "docker stop #{args.join " "} #{project_name}-#{options[:container]}" if options[:container]
+      container_names.each { |c| execute_command "docker stop #{args.join " "} #{c}", replace_current_process: false }
+    end
+
+    desc "restart", "Restarts container(s)"
+    method_option :container, type: :array, aliases: "-c", desc: "A list of container short names"
+    def restart(*args)
+      containers = options[:container] || container_names
+      containers.each { |c| execute_command "docker restart #{args.join " "} #{c}", replace_current_process: false }
+    end
+
+    desc "bash", "Starts a bash shell"
+    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
+    def bash(*args)
+      execute_command "containers exec -c #{options[:container]} bash #{args.join " "}"
+    end
+
+    desc "bundle", "Runs the bundle command"
+    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
+    def bundle(*args)
+      execute_command "containers exec -c #{options[:container]} bundle #{args.join " "}"
+    end
+
+    desc "yarn", "Runs the yarn command"
+    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
+    def yarn(*args)
+      execute_command "containers exec -c #{options[:container]} yarn #{args.join " "}"
+    end
+
+    desc "rails", "Runs the Rails command"
+    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
+    def rails(*args)
+      execute_command "containers bundle -c #{options[:container]} exec rails #{args.join " "}"
+    end
+
+    private
+
+    def container_names
+      `containers list -f`.split("\n")
+    end
+
+    def project_name
+      squish(File.basename(Dir.pwd)).gsub(/\s|_/, "-")
+    end
+
+    def squish(string)
+      string.gsub(/\s+/, " ").strip
+    end
+
+    def execute_command(command, replace_current_process: true)
+      command = squish(command)
+      puts_command command
+      replace_current_process ? execute(command) : puts(`#{command}`)
+    end
+
+    def puts_command(command)
+      puts "#{Rainbow(COMMAND_PREFIX).green.faint} #{Rainbow(command).green.bright}"
+    end
+  end
+end

data/lib/containers/generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "erb"
+
+class Generator < Thor
+  desc "dockerfile", "Creates a Dockerfile for the project"
+  def dockerfile
+    path = File.expand_path("Dockerfile")
+
+    continue = if File.exist?(path)
+      ask("#{Rainbow("Dockerfile already exists").red} Overwrite?", default: "Y").to_s.upcase == "Y"
+    else
+      true
+    end
+
+    return unless continue
+
+    ruby_version = ask("What Ruby version does this project use?", default: "3.1.2").to_s
+    File.write path, render("Dockerfile", ruby_version: ruby_version)
+  end
+
+  desc "compose", "Creates a docker-compose.yml file for the project"
+  def compose
+  end
+
+  private
+
+  def root_path
+    File.expand_path(File.join(__dir__, "..", ".."))
+  end
+
+  def template(name)
+    ERB.new(File.read(File.join(root_path, "lib/containers/templates/#{name}.erb")))
+  end
+
+  def render(template_name, vars = {})
+    view = Struct.new(*vars.keys).new(*vars.values).instance_eval { binding }
+    template(template_name).result view
+  end
+end

data/lib/containers/templates/Dockerfile.erb

@@ -0,0 +1,26 @@
+FROM ruby:<%= ruby_version %>-alpine
+
+RUN apk add --no-cache --update \
+ack \
+bash \
+build-base \
+cloc \
+curl \
+git \
+htop \
+less \
+libc6-compat \
+libsass \
+linux-headers \
+nodejs \
+npm \
+postgresql-client \
+postgresql-dev \
+redis \
+tzdata \
+vim \
+yarn
+
+RUN gem install bundler
+
+CMD tail -f /dev/null

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

@@ -0,0 +1,217 @@
+version: "3.9"
+
+# Ports exposed on the host machine
+#
+# Note: These can be overridden with environment variables
+#
+# - PORT_RAILS=3000 ...... The primary Rails web application
+# - PORT_ANYCABLE=3001 ... The AnyCable server
+# - PORT_LOGS=3002 ....... Web interface for viewing all Docker container logs
+
+x-default-env: &default_env
+  BUNDLE_PATH: /bundle
+  EDITOR: /usr/bin/vim
+
+x-default-app: &default_app
+  build: .
+  image: <%= organization_name %>/<%= project_name %>
+  working_dir: /<%= project_name %>
+  tty: true
+  stdin_open: true
+  env_file: .env
+  environment:
+    <<: *default_env
+  networks:
+    - main
+  volumes:
+    - ./:/<%= project_name %>:cached
+    - bundle:/bundle:delegated
+    - node_modules:/<%= project_name %>/node_modules:delegated
+
+networks:
+  main:
+
+# TODO: dump pg database then rename db -> postgres
+volumes:
+  bundle:
+  db:
+  node_modules:
+  redis_cable:
+  redis_cache:
+  redis_queue:
+
+services:
+  # ----------------------------------------------------------------------------
+  # Postgres - Primary database server
+  # ----------------------------------------------------------------------------
+  postgres:
+    image: postgres:13.4-alpine3.14
+    container_name: <%= project_name %>-postgres
+    restart: unless-stopped
+    environment:
+      POSTGRES_PASSWORD: password
+    networks:
+      - main
+    expose:
+      - 5432
+    volumes:
+      - db:/var/lib/postgresql/data:delegated
+
+  # ----------------------------------------------------------------------------
+  # Redis - ActionCable datastore
+  # ----------------------------------------------------------------------------
+  redis_cable:
+    image: redis:6.2.6-alpine3.14
+    container_name: <%= project_name %>-redis-cable
+    restart: unless-stopped
+    networks:
+      - main
+    expose:
+      - 6379
+    volumes:
+      - redis_cable:/data:delegated
+      - ./config/redis-queue.conf:/usr/local/etc/redis/redis.conf:cached
+
+  # ----------------------------------------------------------------------------
+  # Redis - Cache datastore
+  # ----------------------------------------------------------------------------
+  redis_cache:
+    image: redis:6.2.6-alpine3.14
+    container_name: <%= project_name %>-redis-cache
+    restart: unless-stopped
+    networks:
+      - main
+    expose:
+      - 6379
+    volumes:
+      - redis_cache:/data:delegated
+      - ./config/redis-cache.conf:/usr/local/etc/redis/redis.conf:cached
+
+  # ----------------------------------------------------------------------------
+  # Redis - Queue datastore
+  # ----------------------------------------------------------------------------
+  redis_queue:
+    image: redis:6.2.6-alpine3.14
+    container_name: <%= project_name %>-redis-queue
+    restart: unless-stopped
+    networks:
+      - main
+    expose:
+      - 6379
+    volumes:
+      - redis_queue:/data:delegated
+      - ./config/redis-queue.conf:/usr/local/etc/redis/redis.conf:cached
+
+  # ----------------------------------------------------------------------------
+  # Shell - Intended for tinkering and running misc commands
+  # ----------------------------------------------------------------------------
+  shell:
+    <<: *default_app
+    container_name: <%= project_name %>-shell
+    command: /bin/bash -c "tail -f /dev/null"
+
+  # ----------------------------------------------------------------------------
+  # JavaScript - Builds JavaScript assets
+  # ----------------------------------------------------------------------------
+  js:
+    <<: *default_app
+    container_name: <%= project_name %>-js
+    command: /bin/bash -c "yarn && yarn build --watch"
+
+  # ----------------------------------------------------------------------------
+  # CSS - Builds CSS stylesheet assets
+  # ----------------------------------------------------------------------------
+  css:
+    <<: *default_app
+    container_name: <%= project_name %>-css
+    command: /bin/bash -c "yarn build:css --watch"
+    depends_on:
+      - js
+
+  # ----------------------------------------------------------------------------
+  # Rails - The primary Rails web application
+  # ----------------------------------------------------------------------------
+  web:
+    <<: *default_app
+    container_name: <%= project_name %>-web
+    command: >
+      /bin/bash -c "bundle &&
+                    rm -f tmp/pids/server.pid &&
+                    touch tmp/caching-dev.txt &&
+                    bin/rails log:clear &&
+                    bin/rails db:create db:migrate &&
+                    bin/rails s --binding=0.0.0.0 --port=3000"
+    environment:
+      <<: *default_env
+    ports:
+      - ${PORT_RAILS_WEB:-3000}:3000
+    depends_on:
+      - postgres
+      - redis_cable
+      - redis_cache
+      - redis_queue
+      - js
+      - css
+
+  # ----------------------------------------------------------------------------
+  # Rails - Sidekiq worker for: config/sidekiq.yml
+  # ----------------------------------------------------------------------------
+  worker:
+    <<: *default_app
+    container_name: <%= project_name %>-worker
+    command: /bin/bash -c "bin/rails log:clear &&
+                           bundle exec sidekiq -C config/sidekiq.yml"
+    depends_on:
+      - web
+
+  # ----------------------------------------------------------------------------
+  # Anycable - Web socket server
+  # ----------------------------------------------------------------------------
+  anycable_ws:
+    image: anycable/anycable-go:1.2
+    container_name: <%= project_name %>-anycable-ws
+    restart: unless-stopped
+    environment:
+      ANYCABLE_HOST: "0.0.0.0"
+      ANYCABLE_REDIS_URL: redis://redis_cable:6379/0
+      ANYCABLE_RPC_HOST: anycable_rpc:50051
+      ANYCABLE_DEBUG: 1
+    networks:
+      - main
+    ports:
+      - ${PORT_ANYCABLE:-3001}:8080
+    depends_on:
+      - redis_cable
+
+  # ----------------------------------------------------------------------------
+  # Anycable - Web socket gRPC server (bridge to ws server)
+  # ----------------------------------------------------------------------------
+  anycable_rpc:
+    <<: *default_app
+    container_name: <%= project_name %>-anycable-rpc
+    restart: unless-stopped
+    environment:
+      <<: *default_env
+      ANYCABLE_REDIS_URL: redis://redis_cable:6379/0
+      ANYCABLE_RPC_HOST: 0.0.0.0:50051
+      ANYCABLE_DEBUG: 1
+    networks:
+      - main
+    command: /bin/bash -c "bundle exec anycable"
+    depends_on:
+      - anycable_ws
+      - web
+
+  # ----------------------------------------------------------------------------
+  # Dozzle - Realtime log viewer for docker containers
+  #          https://github.com/amir20/dozzle
+  # ----------------------------------------------------------------------------
+  logs:
+    image: amir20/dozzle
+    container_name: <%= project_name %>-logs
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    ports:
+      - ${PORT_LOGS:-3004}:8080
+    restart: unless-stopped
+    command: "--filter name=<%= project_name %>*"