kaiser 0.0.0 → 0.6.0

data/lib/kaiser/cli.rb

@@ -0,0 +1,625 @@
+# frozen_string_literal: true
+
+require 'kaiser/command_runner'
+
+module Kaiser
+  # The commandline
+  class Cli
+    extend Kaiser::CliOptions
+
+    def set_config
+      # This is here for backwards compatibility since it can be used in Kaiserfiles.
+      # It would be a good idea to deprecate this and make it more abstract.
+      @work_dir = Config.work_dir
+      @config_dir = Config.work_dir
+      @config_file = Config.config_file
+      @kaiserfile = Config.kaiserfile
+      @config = Config.config
+      @out = Config.out
+      @info_out = Config.info_out
+
+      @kaiserfile.validate!
+    end
+
+    # At first I did this in the constructor but the problem with that is Optimist
+    # will parse the entire commandline for the first Cli command registered.
+    # That means no matter what you call -h or --help on, it will always return the help
+    # for the first subcommand. Fixed this by only running define_options when
+    # a command is run. We can't just run the constructor at that point because
+    # we need each Cli class to be constructed in the beginning so we can add their
+    # usage text to the output of `kaiser -h`.
+    def define_options(global_opts = [])
+      # We can't just call usage within the options block because that actually shifts
+      # the scope to Optimist::Parser. We can still reference variables but we can't
+      # call instance methods of a Kaiser::Cli class.
+      u = usage
+      Optimist.options do
+        banner u
+
+        global_opts.each { |o| opt *o }
+      end
+    end
+
+    def self.register(name, klass)
+      @subcommands ||= {}
+      @subcommands[name] = klass.new
+    end
+
+    def self.run_command(name, global_opts)
+      cmd = @subcommands[name]
+      opts = cmd.define_options(global_opts + cmd.class.options)
+
+      # The define_options method has stripped all arguments from the cli so now
+      # all that we're left with in ARGV are the subcommand to be run and possibly
+      # its own subcommands. We remove the subcommand here so each subcommand can
+      # easily use ARGV.shift to access its own subcommands.
+      ARGV.shift
+
+      Kaiser::Config.load(Dir.pwd)
+
+      # We do all this work in here instead of the exe/kaiser file because we
+      # want -h options to output before we check if a Kaiserfile exists.
+      # If we do it in exe/kaiser, people won't be able to check help messages
+      # unless they create a Kaiserfile firest.
+      if opts[:quiet]
+        Config.out = File.open(File::NULL, 'w')
+        Config.info_out = File.open(File::NULL, 'w')
+      elsif opts[:verbose] || Config.always_verbose?
+        Config.out = $stderr
+        Config.info_out = Kaiser::AfterDotter.new(dotter: Kaiser::Dotter.new)
+      else
+        Config.out = Kaiser::Dotter.new
+        Config.info_out = Kaiser::AfterDotter.new(dotter: Config.out)
+      end
+
+      cmd.set_config
+
+      cmd.execute(opts)
+    end
+
+    def self.all_subcommands_usage
+      output = ''
+
+      @subcommands.each do |name, klass|
+        name_s = name.to_s
+
+        output += "#{name_s}\n"
+        output += name_s.gsub(/./, '-')
+        output += "\n"
+        output += klass.usage
+        output += "\n\n"
+      end
+
+      output
+    end
+
+    def stop_app
+      Config.info_out.puts 'Stopping application'
+      killrm app_container_name
+      stop_services
+    end
+
+    def start_services
+      services.each do |service|
+        Config.info_out.puts "Starting service: #{service.name}"
+        run_if_dead(
+          service.shared_name,
+          "docker run -d
+            --name #{service.shared_name}
+            --network #{Config.config[:networkname]}
+            #{service.image}"
+        )
+      end
+    end
+
+    def stop_services
+      services.each do |service|
+        Config.info_out.puts "Stopping service: #{service.name}"
+        killrm service.shared_name
+      end
+    end
+
+    private
+
+    def ensure_db_volume
+      create_if_volume_not_exist db_volume_name
+    end
+
+    def setup_db
+      ensure_db_volume
+      start_db
+      return if File.exist?(default_db_image)
+      return unless db_present?
+
+      # Some databases keep state around, best to clean it.
+      stop_db
+      delete_db_volume
+      start_db
+
+      Config.info_out.puts 'Provisioning database'
+      killrm "#{envname}-apptemp"
+      CommandRunner.run! Config.out, "docker run -ti
+        --rm
+        --name #{envname}-apptemp
+        --network #{Config.config[:networkname]}
+        #{app_params}
+        kaiser:#{envname}-#{current_branch} #{db_reset_command}"
+
+      save_db('default')
+    end
+
+    def save_db(name)
+      return unless db_present?
+
+      killrm db_container_name
+      save_db_state_from container: db_volume_name, to_file: db_image_path(name)
+      start_db
+    end
+
+    def load_db(name)
+      return unless db_present?
+
+      check_db_image_exists(name)
+      killrm db_container_name
+      CommandRunner.run Config.out, "docker volume rm #{db_volume_name}"
+      delete_db_volume
+      create_if_volume_not_exist db_volume_name
+      load_db_state_from file: db_image_path(name), to_container: db_volume_name
+      start_db
+    end
+
+    def check_db_image_exists(name)
+      return if File.exist?(db_image_path(name))
+
+      Optimist.die 'No saved state exists with that name'
+    end
+
+    def save_db_state_from(container:, to_file:)
+      Config.info_out.puts 'Saving database state'
+      File.write(to_file, '')
+      CommandRunner.run Config.out, "docker run --rm
+        -v #{container}:#{db_data_directory}
+        -v #{to_file}:#{to_file}
+        ruby:alpine
+        tar cvjf #{to_file} #{db_data_directory}"
+    end
+
+    def load_db_state_from(file:, to_container:)
+      Config.info_out.puts 'Loading database state'
+      CommandRunner.run Config.out, "docker run --rm
+        -v #{to_container}:#{db_data_directory}
+        -v #{file}:#{file}
+        ruby:alpine
+        tar xvjf #{file} -C #{db_data_directory}
+          --strip #{db_data_directory.scan(%r{/}).count}"
+    end
+
+    def stop_db
+      return unless db_present?
+
+      Config.info_out.puts 'Stopping database'
+      killrm db_container_name
+    end
+
+    def start_db
+      return unless db_present?
+
+      Config.info_out.puts 'Starting up database'
+      run_if_dead db_container_name, "docker run -d
+        -p #{db_port}:#{db_expose}
+        -v #{db_volume_name}:#{db_data_directory}
+        --name #{db_container_name}
+        --network #{network_name}
+        #{db_params}
+        #{db_image}
+        #{db_commands}"
+      wait_for_db unless db_waitscript.nil?
+    end
+
+    def delete_db_volume
+      CommandRunner.run Config.out, "docker volume rm #{db_volume_name}"
+    end
+
+    def current_branch_db_image_dir
+      "#{Config.config_dir}/databases/#{envname}/#{current_branch}"
+    end
+
+    def db_image_path(name)
+      if name.start_with?('./')
+        path = "#{`pwd`.chomp}/#{name.sub('./', '')}"
+        Config.info_out.puts "Database image path is: #{path}"
+        return path
+      end
+      FileUtils.mkdir_p current_branch_db_image_dir
+      "#{current_branch_db_image_dir}/#{name}.tar.bz"
+    end
+
+    def default_db_image
+      db_image_path('default')
+    end
+
+    def attach_app
+      cmd = (ARGV || []).join(' ')
+      killrm app_container_name
+
+      attach_mounts = Config.kaiserfile.attach_mounts
+      volumes = attach_mounts.map { |from, to| "-v #{`pwd`.chomp}/#{from}:#{to}" }.join(' ')
+
+      system "docker run -ti
+        --name #{app_container_name}
+        --network #{network_name}
+        --dns #{ip_of_container(Config.config[:shared_names][:dns])}
+        --dns-search #{http_suffix}
+        -p #{app_port}:#{app_expose}
+        -e DEV_APPLICATION_HOST=#{envname}.#{http_suffix}
+        -e VIRTUAL_HOST=#{envname}.#{http_suffix}
+        -e VIRTUAL_PORT=#{app_expose}
+        #{volumes}
+        #{app_params}
+        kaiser:#{envname}-#{current_branch} #{cmd}".tr("\n", ' ')
+
+      Config.out.puts 'Cleaning up...'
+    end
+
+    def start_app
+      start_services
+
+      Config.info_out.puts 'Starting up application'
+      killrm app_container_name
+      CommandRunner.run! Config.out, "docker run -d
+        --name #{app_container_name}
+        --network #{network_name}
+        --dns #{ip_of_container(Config.config[:shared_names][:dns])}
+        --dns-search #{http_suffix}
+        -p #{app_port}:#{app_expose}
+        -e DEV_APPLICATION_HOST=#{envname}.#{http_suffix}
+        -e VIRTUAL_HOST=#{envname}.#{http_suffix}
+        -e VIRTUAL_PORT=#{app_expose}
+        #{app_params}
+        kaiser:#{envname}-#{current_branch}"
+      wait_for_app
+    end
+
+    def tmp_waitscript_name
+      "#{Config.config_dir}/#{envname}-dbwaitscript"
+    end
+
+    def tmp_dockerfile_name
+      "#{Config.config_dir}/#{envname}-dockerfile"
+    end
+
+    def tmp_db_waiter
+      "#{envname}-dbwait"
+    end
+
+    def tmp_file_container
+      "#{envname}-tmpfiles"
+    end
+
+    def tmp_file_volume
+      "#{envname}-tmpfiles-vol"
+    end
+
+    def run_blocking_script(image, params, script, &block)
+      killrm tmp_db_waiter
+      killrm tmp_file_container
+
+      create_if_volume_not_exist tmp_file_volume
+
+      CommandRunner.run! Config.out, "docker create
+        -v #{tmp_file_volume}:/tmpvol
+        --name #{tmp_file_container} alpine"
+
+      File.write(tmp_waitscript_name, script)
+
+      CommandRunner.run! Config.out, "docker cp
+        #{tmp_waitscript_name}
+        #{tmp_file_container}:/tmpvol/wait.sh"
+
+      CommandRunner.run!(
+        Config.out,
+        "docker run --rm -ti
+          --name #{tmp_db_waiter}
+          --network #{network_name}
+          -v #{tmp_file_volume}:/tmpvol
+          #{params}
+          #{image} sh /tmpvol/wait.sh",
+        &block
+      )
+    ensure
+      killrm tmp_file_container
+      FileUtils.rm(tmp_waitscript_name)
+    end
+
+    def wait_for_app
+      return unless server_type == :http
+
+      Config.info_out.puts 'Waiting for server to start...'
+
+      http_code_extractor = "curl -s -o /dev/null -I -w \"\%<http_code>s\" http://#{app_container_name}:#{app_expose}"
+      unreachable_test = "#{http_code_extractor} | grep -q 000"
+
+      # This waitscript runs until curl returns a non-unreachable status code
+      # and then checks to see if its 200. If its not, it will raise an error.
+      wait_script = <<-SCRIPT
+        apk update
+        apk add curl
+        while #{unreachable_test}; do
+            echo 'o'
+            sleep 1
+        done
+        echo '#{http_code_extractor}'
+        echo $(#{http_code_extractor})
+        if [ "$(#{http_code_extractor})" != "200" ]; then
+          echo $(#{http_code_extractor})
+        else
+          echo '!'
+        fi
+      SCRIPT
+      run_blocking_script('alpine', '', wait_script) do |line|
+        # This script gets run every line that gets output.
+        # The '!' exclamation mark means success
+        # Three numbers means a status code has been returned
+        # If curl returns an error status the script will cut out and
+        # the app container died error will be displayed.
+        raise Kaiser::Error, "Failed with HTTP status: #{line}" if line =~ /^[0-9]{3}$/ && line != '200'
+
+        if line != '!' && container_dead?(app_container_name)
+          raise Kaiser::Error,
+                'App container died. Run `kaiser logs` to see why.'
+        end
+      end
+
+      Config.info_out.puts 'Started successfully!'
+    end
+
+    def wait_for_db
+      return unless db_present?
+
+      Config.info_out.puts 'Waiting for database to start...'
+      run_blocking_script(db_image, db_waitscript_params, db_waitscript)
+      Config.info_out.puts 'Started.'
+    end
+
+    def network_name
+      Config.config[:networkname]
+    end
+
+    def services
+      @services ||= Config.kaiserfile.services.map { |name, info| Service.new(envname, name, info) }
+    end
+
+    def db_port
+      Config.config[:envs][envname][:db_port]
+    end
+
+    def db_expose
+      Config.kaiserfile.database[:port]
+    end
+
+    def db_params
+      eval_template Config.kaiserfile.database[:params]
+    end
+
+    def db_image
+      platform = ''
+      platform = "--platform #{Config.kaiserfile.database[:platform]}" if Config.kaiserfile.database[:platform]&.length
+
+      image = Config.kaiserfile.database[:image]
+      "#{platform} #{image}"
+    end
+
+    def db_present?
+      db_image != 'none'
+    end
+
+    def db_commands
+      eval_template Config.kaiserfile.database[:commands]
+    end
+
+    def db_data_directory
+      Config.kaiserfile.database[:data_dir]
+    end
+
+    def server_type
+      Config.kaiserfile.server_type
+    end
+
+    def db_waitscript
+      eval_template Config.kaiserfile.database[:waitscript]
+    end
+
+    def db_waitscript_params
+      eval_template Config.kaiserfile.database[:waitscript_params]
+    end
+
+    def docker_file_contents
+      eval_template Config.kaiserfile.docker_file_contents
+    end
+
+    def docker_build_args
+      Config.kaiserfile.docker_build_args
+    end
+
+    def app_params
+      eval_template Config.kaiserfile.params
+    end
+
+    def db_reset_command
+      eval_template Config.kaiserfile.database_reset_command
+    end
+
+    def eval_template(value)
+      ERB.new(value).result(binding)
+    end
+
+    def app_port
+      Config.config[:envs][envname][:app_port]
+    end
+
+    def app_expose
+      Config.kaiserfile.port
+    end
+
+    def db_volume_name
+      "#{envname}-database"
+    end
+
+    def app_container_name
+      "#{envname}-app"
+    end
+
+    def db_container_name
+      "#{envname}-db"
+    end
+
+    def current_branch
+      `git branch | grep \\* | cut -d ' ' -f2`.chomp.gsub(/[^\-_0-9a-z]+/, '-')
+    end
+
+    def ensure_env
+      return unless envname.nil?
+
+      Optimist.die('No environment? Please use kaiser init <name>')
+    end
+
+    def http_suffix
+      Config.config[:http_suffix] || 'lvh.me'
+    end
+
+    def copy_keyfile(file)
+      if Config.config[:cert_source][:folder]
+        CommandRunner.run! Config.out, "docker run --rm
+          -v #{Config.config[:shared_names][:certs]}:/certs
+          -v #{Config.config[:cert_source][:folder]}:/cert_source
+          alpine cp /cert_source/#{file} /certs/#{file}"
+
+      elsif Config.config[:cert_source][:url]
+        CommandRunner.run! Config.out, "docker run --rm
+          -v #{Config.config[:shared_names][:certs]}:/certs
+          alpine wget #{Config.config[:cert_source][:url]}/#{file}
+            -O /certs/#{file}"
+      end
+    end
+
+    def prepare_cert_volume!
+      create_if_volume_not_exist Config.config[:shared_names][:certs]
+      return unless Config.config[:cert_source]
+
+      %w[
+        chain.pem
+        crt
+        key
+      ].each do |file_ext|
+        copy_keyfile("#{http_suffix}.#{file_ext}")
+      end
+    end
+
+    def ensure_setup
+      ensure_env
+
+      setup if network.nil?
+
+      create_if_network_not_exist Config.config[:networkname]
+      if_container_dead Config.config[:shared_names][:nginx] do
+        prepare_cert_volume!
+      end
+      run_if_dead(
+        Config.config[:shared_names][:redis],
+        "docker run -d
+          --name #{Config.config[:shared_names][:redis]}
+          --network #{Config.config[:networkname]}
+          redis:alpine"
+      )
+      run_if_dead(
+        Config.config[:shared_names][:chrome],
+        "docker run -d
+          -p 5900:5900
+          --name #{Config.config[:shared_names][:chrome]}
+          --network #{Config.config[:networkname]}
+          selenium/standalone-chrome-debug"
+      )
+      run_if_dead(
+        Config.config[:shared_names][:nginx],
+        "docker run -d
+          -p 80:80
+          -p 443:443
+          -v #{Config.config[:shared_names][:certs]}:/etc/nginx/certs
+          -v /var/run/docker.sock:/tmp/docker.sock:ro
+          --privileged
+          --name #{Config.config[:shared_names][:nginx]}
+          --network #{Config.config[:networkname]}
+          jwilder/nginx-proxy"
+      )
+      run_if_dead(
+        Config.config[:shared_names][:dns],
+        "docker run -d
+          --name #{Config.config[:shared_names][:dns]}
+          --network #{Config.config[:networkname]}
+          --privileged
+          -v /var/run/docker.sock:/docker.sock:ro
+          davidsiaw/docker-dns
+          --domain #{http_suffix}
+          --record :#{ip_of_container(Config.config[:shared_names][:nginx])}"
+      )
+    end
+
+    def ip_of_container(containername)
+      networkname = ".NetworkSettings.Networks.#{Config.config[:networkname]}.IPAddress"
+      `docker inspect -f '{{#{networkname}}}' #{containername}`.chomp
+    end
+
+    def network
+      `docker network inspect #{Config.config[:networkname]} 2>/dev/null`
+    end
+
+    def container_dead?(container)
+      x = JSON.parse(`docker inspect #{container} 2>/dev/null`)
+      return true if x.length.zero? || x[0]['State']['Running'] == false
+    end
+
+    def if_container_dead(container)
+      return unless container_dead?(container)
+
+      yield if block_given?
+    end
+
+    def create_if_volume_not_exist(vol)
+      x = JSON.parse(`docker volume inspect #{vol} 2>/dev/null`)
+      return unless x.length.zero?
+
+      CommandRunner.run! Config.out, "docker volume create #{vol}"
+    end
+
+    def create_if_network_not_exist(net)
+      x = JSON.parse(`docker inspect #{net} 2>/dev/null`)
+      return unless x.length.zero?
+
+      CommandRunner.run! Config.out, "docker network create #{net}"
+    end
+
+    def run_if_dead(container, command)
+      if_container_dead container do
+        Config.info_out.puts "Starting up #{container}"
+        killrm container
+        CommandRunner.run Config.out, command
+      end
+    end
+
+    def envname
+      Config.config[:envnames][Config.work_dir]
+    end
+
+    def save_config
+      File.write(Config.config_file, Config.config.to_yaml)
+    end
+
+    def killrm(container)
+      x = JSON.parse(`docker inspect #{container} 2>/dev/null`)
+      return if x.length.zero?
+
+      CommandRunner.run Config.out, "docker kill #{container}" if x[0]['State'] && x[0]['State']['Running'] == true
+      CommandRunner.run Config.out, "docker rm #{container}" if x[0]['State']
+    end
+  end
+end

data/lib/kaiser/cli_options.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module CliOptions
+    def option(*option)
+      @options ||= []
+      @options << option
+    end
+
+    def options
+      @options || []
+    end
+  end
+end

data/lib/kaiser/cmds/attach.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module Cmds
+    class Attach < Cli
+      def usage
+        <<~EOS
+          Shuts down the application container and starts it up again with the current directory bind mounted inside. This way the application will run from the source code in the current directory and any edits you make will immediately show up inside the container. This is ideal for development.
+
+          Once the attached container exits (through the use of control+c for example) it will be replaced by a regular non-attached version of the app container.
+
+          USAGE: kaiser attach
+        EOS
+      end
+
+      def execute(_opts)
+        ensure_setup
+        attach_app
+        start_app
+      end
+    end
+  end
+end

data/lib/kaiser/cmds/db_load.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module Cmds
+    class DbLoad < Cli
+      def usage
+        <<~EOS
+          Shuts down the database docker container, *replaces* the database with the backup provided and brings the container up again.
+
+          The database will be restored from a tarball saved as \`~/.kaiser/<ENV_NAME>/<current_github_branch_name>/<DB_BACKUP_FILENAME>.tar.bz\`
+
+          Alternatively you can also load it from your current directory.
+
+          If no database name was provided, the default database stored at \`~/.kaiser/<ENV_NAME>/<current_github_branch_name>/default.tar.bz\` will be used.
+
+          USAGE: kaiser db_load
+                 kaiser db_load DB_BACKUP_FILENAME
+                 kaiser db_load ./my_database.tar.bz
+        EOS
+      end
+
+      def execute(_opts)
+        ensure_setup
+        name = ARGV.shift || 'default'
+        load_db(name)
+      end
+    end
+  end
+end

data/lib/kaiser/cmds/db_reset.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module Cmds
+    class DbReset < Cli
+      def usage
+        <<~EOS
+          Shuts down the database docker container, *replaces* the database with the default database image stored at \`~/.kaiser/<ENV_NAME>/<current_github_branch_name>/default.tar.bz\` and brings the container up again.
+
+          This is the same as running \`kaiser db_load\` with no arguments.
+
+          USAGE: kaiser db_reset
+        EOS
+      end
+
+      def execute(_opts)
+        ensure_setup
+        load_db('default')
+      end
+    end
+  end
+end