kaiser 0.6.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8047763773bfe748430378babb51a03b464f203653f65b18c914c9dcc0fc5d
-  data.tar.gz: f5f4f0965aa9cd5f8b54e5812e8f5810cd96db4140bc5efcfb4483b04394cf81
+  metadata.gz: 54e276a77032f484d216acc213a7c9157c8d5afd3c241c95c81c68845cd94dd7
+  data.tar.gz: cd24e7b599320b2c6e6ef94bc2c0fcb27f02f82fa6bbe6fda7919af2de5ce862
 SHA512:
-  metadata.gz: 2c8500f56e296379d71bbde647cc5c55fdb44079d4ebf149ce2791c1b0aff279c590192baa02953d2b8c87c1a335796b84d410786a032aa0ba23ef059398477c
-  data.tar.gz: 1c301bf576a3b1eab3a6fa785b37a9e58afa0c35c2bc9ede6c10bc6bea8a38c87f89fee1817d8dd6938ca32d2d4d667feff7638eeb1f7316b6a203c69be7713c
+  metadata.gz: d24d16515b2832b274adeeda21ecec02295394ad7b093874832cf7af154693fb5a8d0a7975e053fe7ecc0b24b380b8ff4864af1cd0acd95b8cf6343b273e29eb
+  data.tar.gz: e0aa642762fc2b3af586fbb1967c829d959854c645a282e73869713b3385279a2b891baade25f474b547c6d302052cf16450b9ddc08366722d740bf1530db5db

data/README.md

@@ -31,23 +31,30 @@ Simply clone the repo and run
 
 ```
 cd kaiser
+bundle
 docker build -t degica/kaiser . 
 ```
 
 And then add the following line to your `.bashrc` or `.bash_profile`
 
 ```
-alias kaiser='docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v `pwd`:`pwd` -e CONTEXT_DIR="`pwd`" degica/kaiser'
+alias kaiser='docker run --pull=always --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v `pwd`:`pwd` -e CONTEXT_DIR="`pwd`" degicadev/kaiser'
 ```
 
 Or if you use fish
 
 ```
 function kaiser
-  docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v (pwd):(pwd) -e CONTEXT_DIR=(pwd) degica/kaiser $argv
+  docker run --pull=always --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v (pwd):(pwd) -e CONTEXT_DIR=(pwd) degicadev/kaiser $argv
 end
 ```
 
+Confirm it is working by running
+
+```
+kaiser -h
+```
+
 ## Usage
 
 You'll need a Dockerfile and a Kaiserfile. The Kaiserfile should be placed in the project root directory, with contents like this:

data/exe/kaiser

@@ -5,7 +5,6 @@ require 'optimist'
 require 'fileutils'
 require 'yaml'
 require 'json'
-require 'pty'
 require 'erb'
 
 require 'kaiser'

data/lib/kaiser/cli.rb

@@ -8,6 +8,12 @@ module Kaiser
   class Cli
     extend Kaiser::CliOptions
 
+    attr_reader :use_kaiserfile
+
+    def initialize
+      @use_kaiserfile = true
+    end
+
     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.
@@ -19,7 +25,7 @@ module Kaiser
       @out = Config.out
       @info_out = Config.info_out
 
-      @kaiserfile.validate!
+      @kaiserfile.validate! if @use_kaiserfile
     end
 
     # At first I did this in the constructor but the problem with that is Optimist
@@ -37,7 +43,7 @@ module Kaiser
       Optimist.options do
         banner u
 
-        global_opts.each { |o| opt *o }
+        global_opts.each { |o| opt(*o) }
       end
     end
 
@@ -56,12 +62,12 @@ module Kaiser
       # easily use ARGV.shift to access its own subcommands.
       ARGV.shift
 
-      Kaiser::Config.load(Dir.pwd)
+      Kaiser::Config.load(Dir.pwd, use_kaiserfile: cmd.use_kaiserfile)
 
       # 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.
+      # unless they create a Kaiserfile first.
       if opts[:quiet]
         Config.out = File.open(File::NULL, 'w')
         Config.info_out = File.open(File::NULL, 'w')
@@ -104,11 +110,7 @@ module Kaiser
       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}"
+          service.shared_name, service.start_docker_command
         )
       end
     end
@@ -240,6 +242,10 @@ module Kaiser
     end
 
     def attach_app
+      start_services
+
+      puts 'Attaching to app...'
+
       cmd = (ARGV || []).join(' ')
       killrm app_container_name
 
@@ -259,6 +265,8 @@ module Kaiser
         #{app_params}
         kaiser:#{envname}-#{current_branch} #{cmd}".tr("\n", ' ')
 
+      stop_services
+
       Config.out.puts 'Cleaning up...'
     end
 
@@ -390,6 +398,10 @@ module Kaiser
       @services ||= Config.kaiserfile.services.map { |name, info| Service.new(envname, name, info) }
     end
 
+    def force_platform
+      Config.kaiserfile.platform || ''
+    end
+
     def db_port
       Config.config[:envs][envname][:db_port]
     end
@@ -514,6 +526,19 @@ module Kaiser
       end
     end
 
+    def selenium_node_image
+      return ENV['OVERRIDE_SELENIUM_NODE_IMAGE'] unless ENV['OVERRIDE_SELENIUM_NODE_IMAGE'].nil?
+
+      if RUBY_PLATFORM.start_with?('arm64') || RUBY_PLATFORM.start_with?('aarch64')
+        # use the seleniarm image because its more stable in arm procs
+        # somehow the x64 image does not do well under qemu under arm
+        return 'seleniarm/standalone-chromium'
+      end
+
+      # default to x64 image
+      'selenium/standalone-chrome-debug'
+    end
+
     def ensure_setup
       ensure_env
 
@@ -528,15 +553,16 @@ module Kaiser
         "docker run -d
           --name #{Config.config[:shared_names][:redis]}
           --network #{Config.config[:networkname]}
-          redis:alpine"
+          redis:7-alpine"
       )
       run_if_dead(
         Config.config[:shared_names][:chrome],
         "docker run -d
           -p 5900:5900
+          --shm-size='2g'
           --name #{Config.config[:shared_names][:chrome]}
           --network #{Config.config[:networkname]}
-          selenium/standalone-chrome-debug"
+          #{selenium_node_image}"
       )
       run_if_dead(
         Config.config[:shared_names][:nginx],
@@ -574,7 +600,7 @@ module Kaiser
 
     def container_dead?(container)
       x = JSON.parse(`docker inspect #{container} 2>/dev/null`)
-      return true if x.length.zero? || x[0]['State']['Running'] == false
+      x.empty? || x[0]['State']['Running'] == false
     end
 
     def if_container_dead(container)
@@ -585,14 +611,14 @@ module Kaiser
 
     def create_if_volume_not_exist(vol)
       x = JSON.parse(`docker volume inspect #{vol} 2>/dev/null`)
-      return unless x.length.zero?
+      return unless x.empty?
 
       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?
+      return unless x.empty?
 
       CommandRunner.run! Config.out, "docker network create #{net}"
     end
@@ -615,7 +641,7 @@ module Kaiser
 
     def killrm(container)
       x = JSON.parse(`docker inspect #{container} 2>/dev/null`)
-      return if x.length.zero?
+      return if x.empty?
 
       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']

data/lib/kaiser/cmds/set.rb

@@ -21,6 +21,11 @@ module Kaiser
         EOS
       end
 
+      def initialize
+        super
+        @use_kaiserfile = false
+      end
+
       def execute(_opts)
         cmd = ARGV.shift
 

data/lib/kaiser/cmds/shutdown.rb

@@ -14,7 +14,7 @@ module Kaiser
       end
 
       def execute(_opts)
-        Config.config[:shared_names].each do |_, container_name|
+        Config.config[:shared_names].each_value do |container_name|
           killrm container_name
         end
 

data/lib/kaiser/cmds/up.rb

@@ -28,14 +28,27 @@ module Kaiser
         end
       end
 
+      def build_cmd
+        platform_args = ''
+        platform_args = "--platform=#{force_platform}" unless force_platform.empty?
+        build_args = docker_build_args.map { |k, v| "--build-arg #{k}=#{v}" }
+        [
+          'docker build',
+          "-t kaiser:#{envname}-#{current_branch}",
+          "-f #{tmp_dockerfile_name} #{Config.work_dir}",
+          platform_args,
+          build_args.join(' ').to_s
+        ]
+      end
+
       def setup_app
         Config.info_out.puts 'Setting up application'
         File.write(tmp_dockerfile_name, docker_file_contents)
-        build_args = docker_build_args.map { |k, v| "--build-arg #{k}=#{v}" }
-        CommandRunner.run! Config.out, "docker build
-          -t kaiser:#{envname}-#{current_branch}
-          -f #{tmp_dockerfile_name} #{Config.work_dir}
-          #{build_args.join(' ')}"
+
+        CommandRunner.run! Config.out, build_cmd.join("\n\t"), env_vars: {
+          'DOCKER_BUILDKIT' => '1',
+          'BUILDKIT_PROGRESS' => 'plain'
+        }
         FileUtils.rm(tmp_dockerfile_name)
       end
     end

data/lib/kaiser/command_runner.rb

@@ -1,24 +1,28 @@
 # frozen_string_literal: true
 
+require 'pty'
 require 'English'
 
-# This is the command runner
 module Kaiser
-  # Make running easy
+  # This is the command runner
+  # it abstracts away the complicated syntax required to deal with
+  # PTY and to pass the lines programmatically to the host application
+  # as well as to capture the return code at the end.
   class CommandRunner
-    def self.run(out, cmd, &block)
+    def self.run(out, cmd, env_vars: {}, &block)
       out.puts "> #{cmd}"
-      CommandRunner.new(out, cmd).run_command(&block)
+      CommandRunner.new(out, cmd, env_vars).run_command(&block)
     end
 
-    def self.run!(out, cmd, &block)
-      status = run(out, cmd, &block)
+    def self.run!(out, cmd, env_vars: {}, &block)
+      status = run(out, cmd, env_vars: env_vars, &block)
       raise Kaiser::CmdError.new(cmd, status) if status.to_s != '0'
     end
 
-    def initialize(out, cmd)
+    def initialize(out, cmd, env_vars)
       @out = out
       @cmd = cmd.tr "\n", ' '
+      @env_vars = env_vars
     end
 
     def print_and_return_status(status = 0)
@@ -38,7 +42,7 @@ module Kaiser
     end
 
     def run_command(&block)
-      PTY.spawn("#{@cmd} 2>&1") do |stdout, _stdin, pid|
+      PTY.spawn(@env_vars, "#{@cmd} 2>&1") do |stdout, _stdin, pid|
         print_lines(stdout, &block)
         Process.wait(pid)
       end

data/lib/kaiser/config.rb

@@ -12,7 +12,7 @@ module Kaiser
                   :kaiserfile,
                   :config
 
-      def load(work_dir)
+      def load(work_dir, use_kaiserfile: true)
         @work_dir = work_dir
         @config_dir = "#{ENV['HOME']}/.kaiser"
 
@@ -20,7 +20,6 @@ module Kaiser
 
         FileUtils.mkdir_p @config_dir
         @config_file = "#{@config_dir}/config.yml"
-        @kaiserfile = Kaiserfile.new("#{@work_dir}/Kaiserfile")
 
         @config = {
           envnames: {},
@@ -39,8 +38,11 @@ module Kaiser
 
         load_config
 
-        alt_kaiserfile = "#{ENV['HOME']}/kaiserfiles/Kaiserfile.#{@config[:envnames][work_dir]}"
-        @kaiserfile = Kaiserfile.new(alt_kaiserfile) if File.exist?(alt_kaiserfile)
+        if use_kaiserfile
+          @kaiserfile = Kaiserfile.new("#{@work_dir}/Kaiserfile")
+          alt_kaiserfile = "#{ENV['HOME']}/kaiserfiles/Kaiserfile.#{@config[:envnames][work_dir]}"
+          @kaiserfile = Kaiserfile.new(alt_kaiserfile) if File.exist?(alt_kaiserfile)
+        end
 
         @config
       end

data/lib/kaiser/kaiserfile.rb

@@ -76,6 +76,10 @@ module Kaiser
       }
     end
 
+    def force_platform(platform_name)
+      @platform = platform_name
+    end
+
     def expose(port)
       @port = port
     end
@@ -98,10 +102,20 @@ module Kaiser
       @server_type = value
     end
 
-    def service(name, image: name)
+    def service(name,
+                image: name,
+                command: nil,
+                binds: {},
+                env: {})
+
       raise "duplicate service #{name.inspect}" if @services.key?(name)
 
-      @services[name] = { image: image }
+      @services[name] = {
+        image: image,
+        command: command,
+        binds: binds,
+        env: env
+      }
     end
   end
 end

data/lib/kaiser/service.rb

@@ -18,5 +18,43 @@ module Kaiser
     def image
       @service_info[:image]
     end
+
+    def command
+      @service_info[:command].to_s
+    end
+
+    def binds
+      @service_info[:binds] || {}
+    end
+
+    def env
+      @service_info[:env] || {}
+    end
+
+    def start_docker_command
+      envstring = env.map do |k, v|
+        "-e #{k}=#{v}"
+      end.join(' ')
+
+      bindstring = binds.map do |k, v|
+        "-v #{k}:#{v}"
+      end.join(' ')
+
+      commandstring = command
+
+      cmd_array = [
+        'docker run -d',
+        "--name #{shared_name}",
+        "--network #{Config.config[:networkname]}",
+        envstring,
+        bindstring,
+        image,
+        commandstring
+      ]
+
+      cmd_array.filter! { |x| !x.empty? }
+
+      cmd_array.join(' ')
+    end
   end
 end

data/lib/kaiser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kaiser
-  VERSION = '0.6.4'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaiser
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.8.0
 platform: ruby
 authors:
 - David Siaw
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Manage your monsters