devkitkat 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45003b239d330518c51308aec36f8f04c18dc36f3599f2c33482ee354bb76f16
-  data.tar.gz: b09492e98b456d7afd6ba31720509c1c5ae22b7516532443661e2a7efa5132eb
+  metadata.gz: 19d4a68e881590b167d09fb7564e53f0e6b337386ad4de76043d4ed5c1d8d3ab
+  data.tar.gz: 5d1150ee9dcdd3820b60d8f460da8d69ed9eef314f13626da409d8481e78d7e3
 SHA512:
-  metadata.gz: f0ca0b9427f4176b02c8e15d8df4a2a12a2b4e1f265cfb6cae875ac4d422e33407ea2eb503285c47015f5df76245f352a59f7bc5cfa35fea3a886b86595aec8f
-  data.tar.gz: 2ffb303ad8506c435fda82b563e26c03877e4eaa20a4ebf4c84a43314041daf969b6406b4a132886a48df6f254ef8c217c4e897e418c6af7af7bacdca7762c8b
+  metadata.gz: eee0fd0f5ab8ebea39250f607ec29871f2f860305d601a1c161caf87c5b97066a6f26cecc019bd88797e9a6210b7a678b1eac793422d308b40fdfba2ce5a669b
+  data.tar.gz: 5c133cd5b4d58a45711ee7192b39980a0519e5d786377674d2399ff0f43b57f8dc4cb72044ba2c0b3bfb535d6e38b47f72ca4e19158a3c04845e885aa4918eac

data/Gemfile.lock

@@ -1,36 +1,37 @@
 PATH
   remote: .
   specs:
-    devkitkat (0.1.21)
+    devkitkat (0.1.22)
       activesupport (~> 6.0.0)
       colorize (~> 0.8.1)
       docker-api (~> 1.34.2)
       parallel (~> 1.17.0)
       pry (~> 0.12.2)
       pry-nav
+      require_all (~> 3.0.0)
       ruby-progressbar (~> 1.10.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     coderay (1.1.2)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     docker-api (1.34.2)
       excon (>= 0.47.0)
       multi_json
-    excon (0.68.0)
-    i18n (1.7.0)
+    excon (0.73.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.12.2)
+    minitest (5.14.0)
     multi_json (1.14.1)
     parallel (1.17.0)
     pry (0.12.2)
@@ -38,7 +39,8 @@ GEM
       method_source (~> 0.9.0)
     pry-nav (0.3.0)
       pry (>= 0.9.10, < 0.13.0)
-    rake (10.5.0)
+    rake (12.3.3)
+    require_all (3.0.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -56,9 +58,9 @@ GEM
       rspec (>= 3.0)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -66,7 +68,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   devkitkat!
-  rake (~> 10.0)
+  rake (~> 12.3.3)
   rspec (~> 3.0)
   rspec-temp_dir (~> 1.1.0)
 

data/README.md

@@ -264,11 +264,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 **Execute only fast tests**
 
-`bundle exec rspec /home/shinya/workspace/devkitkat/spec/devkitkat_spec.rb -t ~slow`
+`bundle exec rspec -t ~slow`
 
 **Execute only slow tests**
 
-`bundle exec rspec /home/shinya/workspace/devkitkat/spec/devkitkat_spec.rb -t slow`
+`bundle exec rspec -t slow`
 
 ## Contributing
 

data/bin/devkitkat

@@ -3,4 +3,4 @@ require 'bundler/setup' if ENV['DEVKITKAT_DEBUG']
 require "devkitkat"
 require 'pry'
 
-Devkitkat::Main.new.execute
+Devkitkat::Main.execute

data/devkitkat.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-temp_dir", "~> 1.1.0"
   spec.add_runtime_dependency "pry", "~> 0.12.2"
@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "ruby-progressbar", "~> 1.10.1"
   spec.add_runtime_dependency "colorize", "~> 0.8.1"
   spec.add_runtime_dependency "docker-api", "~> 1.34.2"
+  spec.add_runtime_dependency "require_all", "~> 3.0.0"
 end

data/lib/devkitkat/command.rb

@@ -1,3 +1,5 @@
+require 'optparse'
+
 module Devkitkat
   class Command
     attr_reader :options, :script, :target, :args
@@ -28,18 +30,14 @@ module Devkitkat
       options[:quiet]
     end
 
-    def tmp_dir
-      File.join(kit_root, '.devkitkat')
-    end
-
-    def create_tmp_dir
-      FileUtils.mkdir_p(tmp_dir)
-    end
-
     def kit_root
       options[:root_path] || Dir.pwd
     end
 
+    def name
+      script.tr('-', '_')
+    end
+
     private
 
     def option_parser

data/lib/devkitkat/config.rb

@@ -1,9 +1,10 @@
+require 'yaml'
+
 module Devkitkat
   class Config
     DEVKITKAT_FILE_NAME = '.devkitkat.yml'
     HIDDEN_SERVICES = %w[system]
     DEFAULT_APPLICATION_NAME = 'devkitkat'
-    DEFAULT_IMAGE = 'registry.gitlab.com/dosuken123/thin-gdk/thin-gdk-monolith:master'
 
     attr_reader :devkitkat_yml, :kit_root
 
@@ -18,34 +19,46 @@ module Devkitkat
 
     def resolve!(target, exclude: nil)
       services = if target.nil? || target == 'system'
-                   %w[system]
-                 elsif target == 'all'
-                   all_services
-                 elsif group = find_group(target)
-                   services_for_group(group)
-                 elsif services = find_comma_separated_services(target)
+                  %w[system]
+                elsif target == 'all'
+                  all_services
+                elsif group = find_group(target)
+                  services_for_group(group)
+                elsif services = find_comma_separated_services(target)
                   services
-                 elsif service = find_service(target)
-                   [service]
-                 else
-                   raise_error(target)
-                 end
+                elsif service = find_service(target)
+                  [service]
+                else
+                  raise_error(target)
+                end
 
       services = services - exclude if exclude
 
       services
     end
 
-    def environment_type
-      if devkitkat_yml.key?('image')
-        'docker'
-      else
-        'local'
-      end
+    def machine_driver
+      devkitkat_yml.dig('machine', 'driver') || 'none'
+    end
+
+    def machine_location
+      devkitkat_yml.dig('machine', 'location') || 'local'
+    end
+
+    def machine_image
+      devkitkat_yml.dig('machine', 'image')
+    end
+
+    def machine_extra_hosts
+      devkitkat_yml.dig('machine', 'extra_hosts')
+    end
+
+    def machine_network_mode
+      devkitkat_yml.dig('machine', 'network_mode')
     end
 
-    def image
-      devkitkat_yml.fetch('image', DEFAULT_IMAGE)
+    def extra_write_accesses
+      devkitkat_yml.dig('machine', 'extra_write_accesses')
     end
 
     def application

data/lib/devkitkat/processor.rb

@@ -0,0 +1,48 @@
+require 'parallel'
+
+module Devkitkat
+  class Processor
+    attr_reader :services, :config, :command
+
+    def initialize(services, command, config)
+      @services = services
+      @command = command
+      @config = config
+    end
+
+    def execute
+      results = []
+
+      print_log_paths
+
+      if services.count == 1
+        # If the target is only one, it could be console access (TTY)
+        # so we can't run in parallel.
+        results << services.first.execute
+      else
+        results = Parallel.map(services, progress: 'Executing', in_processes: 8) do |service|
+          service.execute.tap do |success|
+            raise Parallel::Kill unless success
+          end
+        end
+      end
+
+      results&.all? { |result| result == true } || terminate_process_group!
+    end
+
+    private
+
+    def terminate_process_group!
+      pgid = Process.getpgid(Process.pid)
+
+      Process.kill('TERM', -pgid)
+    end
+
+    def print_log_paths
+      return if command.interactive? || command.quiet?
+
+      log_paths = services.map(&:log_path)
+      puts %Q{See the log at \n#{log_paths.join("\n")}}
+    end
+  end
+end

data/lib/devkitkat/service/concerns/service_initializer.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/module/delegation'
+
+module Devkitkat
+  class Service
+    module Concerns
+      module ServiceInitializer
+        attr_reader :service
+
+        delegate :config, :command, to: :service
+
+        def initialize(service)
+          @service = service
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/driver/base.rb

@@ -0,0 +1,23 @@
+module Devkitkat
+  class Service
+    class Driver
+      class Base
+        include Concerns::ServiceInitializer
+
+        PreparationError = Class.new(StandardError)
+
+        def prepare
+          raise NotImplementedError
+        end
+
+        def cleanup
+          raise NotImplementedError
+        end
+
+        def execute(script_file)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/driver/docker/container.rb

@@ -0,0 +1,163 @@
+module Devkitkat
+  class Service
+    class Driver
+      class Docker < Base
+        class Container
+          include Concerns::ServiceInitializer
+
+          ROOT_IN_CONTAINER = '/devkitkat'
+
+          attr_reader :container
+
+          def start
+            if @container = find
+              container.start
+            else
+              @container = create
+              container.start
+              create_host_user
+            end
+          end
+
+          def stop
+            raise 'Container has not started yet' unless container
+
+            container.stop
+          end
+
+          def exec(cmds, params = {})
+            params.merge!(user: user_name)
+            safe_exec(cmds, params)
+          end
+
+          def exec_as_host(cmds, params = {})
+            safe_exec(cmds, params)
+          end
+
+          private
+
+          def safe_exec(cmds, params)
+            params.merge!(wait: 604800) # Default timeout is 1 minute, so setting 1 week instead
+            stdout_messages, stderr_messages, exit_code =
+              container.exec(cmds, params)
+
+            if exit_code != 0 || command.debug?
+              puts "#{self.class.name} - #{__callee__}: stdout_messages: #{stdout_messages} stderr_messages: #{stderr_messages} exit_code: #{exit_code}"
+            end
+
+            exit_code == 0 ? true : false
+          rescue ::Docker::Error::ConflictError => e
+            puts "#{self.class.name} - #{__callee__}: #{e.message}"
+            false
+          end
+
+          def image
+            config.machine_image
+          end
+
+          def name
+            @name ||=
+              "#{config.application}-#{service.name}-#{Digest::SHA1.hexdigest(command.kit_root)[8..12]}"
+          end
+
+          def find
+            ::Docker::Container.get(name)
+          rescue ::Docker::Error::NotFoundError
+            nil
+          end
+
+          def create
+            ::Docker::Container.create(create_parameter)
+          end
+
+          def create_parameter
+            params = {
+              'Cmd' => %w[tail -f],
+              'Image' => image,
+              'name' => name,
+              'HostConfig' => {
+                'Binds' => all_mounts
+              }
+            }
+
+            if service.port
+              params.deep_merge!(
+                'ExposedPorts' => { "#{service.port}/tcp" => {} },
+                'HostConfig' => {
+                  'PortBindings' => {
+                    "#{service.port}/tcp" => [{ 'HostPort' => service.port.to_s }]
+                  }
+                }
+              )
+            end
+
+            if config.machine_extra_hosts
+              params.deep_merge!('HostConfig' => { 'ExtraHosts' => config.machine_extra_hosts })
+            end
+
+            if config.machine_network_mode
+              params.deep_merge!('HostConfig' => { 'NetworkMode' => config.machine_network_mode })
+            end
+
+            params
+          end
+
+          def all_mounts
+            config.all_services.map do |service_name|
+              service = Service.new(service_name, config, command)
+
+              FileUtils.mkdir_p(service.dir)
+
+              if self.service.name == service_name || service.system? || allowed_by_extra_write_accesses?(service)
+                "#{service.dir}:#{ROOT_IN_CONTAINER}/services/#{service.name}"
+              else
+                "#{service.dir}:#{ROOT_IN_CONTAINER}/services/#{service.name}:ro"
+              end
+            end
+          end
+
+          def allowed_by_extra_write_accesses?(service)
+            config.extra_write_accesses&.any? do |access|
+              from, _, to = access.split(':')
+              self.service.name == from && service.name == to
+            end
+          end
+
+          def user_name
+            'devkitkat'
+          end
+
+          def group_id
+            @group_id ||= `id -u`.delete("\n")
+          end
+
+          def user_id
+            @user_id ||= `id -g`
+          end
+
+          def create_host_user
+            prepare!(['addgroup', '--gid', group_id, user_name])
+
+            prepare!(['adduser',
+              '--uid', user_id,
+              '--gid', group_id,
+              '--shell', '/bin/bash',
+              '--home', ROOT_IN_CONTAINER,
+              '--gecos', '',
+              '--disabled-password',
+              user_name])
+
+            prepare!(['chown', "#{user_name}:#{user_name}", ROOT_IN_CONTAINER])
+            prepare!(['chown', '-R', "#{user_name}:#{user_name}", "#{ROOT_IN_CONTAINER}/services/#{service.name}"])
+          end
+
+          def prepare!(cmds, params = {})
+            unless exec_as_host(cmds, params)
+              raise Driver::Base::PreparationError, "Failed to execute command in container. cmds: #{cmds}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/driver/docker/image.rb

@@ -0,0 +1,33 @@
+module Devkitkat
+  class Service
+    class Driver
+      class Docker < Base
+        class Image
+          include Concerns::ServiceInitializer
+
+          def pull
+            image_exist? || pull_image
+          end
+
+          private
+
+          def pull_image
+            puts "Pulling image #{image}..."
+            ::Docker::Image.create('fromImage' => image)
+            puts "Pulled image #{image}..."
+          end
+
+          def image_exist?
+            ::Docker::Image.get(image)
+          rescue
+            false
+          end
+
+          def image
+            config.machine_image
+          end
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/driver/docker.rb

@@ -0,0 +1,45 @@
+require 'docker'
+require_relative 'docker/container'
+require_relative 'docker/image'
+
+module Devkitkat
+  class Service
+    class Driver
+      class Docker < Base
+        def prepare
+          image.pull
+          container.start
+        end
+
+        def execute(script_file)
+          new_path = rewrite_root_path!(script_file)
+
+          container.exec([new_path])
+        end
+
+        def cleanup
+          container.stop
+        end
+
+        private
+
+        def rewrite_root_path!(script_file)
+          content = File.read(script_file)
+          new_content = content.gsub(command.kit_root, Container::ROOT_IN_CONTAINER)
+          File.write(script_file, new_content)
+
+          relative_path = script_file.delete_prefix(command.kit_root)
+          File.join(Container::ROOT_IN_CONTAINER, relative_path)
+        end
+
+        def container
+          @container ||= Container.new(service)
+        end
+
+        def image
+          @image ||= Image.new(service)
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/driver/none.rb

@@ -0,0 +1,19 @@
+module Devkitkat
+  class Service
+    class Driver
+      class None < Base
+        def prepare
+          # no-op
+        end
+
+        def cleanup
+          # no-op
+        end
+
+        def execute(script_file)
+          system(script_file)
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/executor/logger.rb

@@ -0,0 +1,22 @@
+module Devkitkat
+  class Service
+    class Executor
+      class Logger
+        include Concerns::ServiceInitializer
+
+        def to_script
+          "exec > #{service.log_path} 2>&1"
+        end
+
+        def available?
+          !command.interactive?
+        end
+
+        def new_file
+          FileUtils.rm_f(service.log_path)
+          FileUtils.mkdir_p(service.log_dir)
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/executor/scripter.rb

@@ -0,0 +1,48 @@
+module Devkitkat
+  class Service
+    class Executor
+      class Scripter
+        include Concerns::ServiceInitializer
+
+        SCRIPT_HEADER = <<~EOS
+          #!/bin/bash
+        EOS
+
+        def file_path
+          File.join(service.dir, "script-#{service.name}-#{command.script}")
+        end
+
+        def new_file
+          delete_file
+          create_file
+
+          yield
+        ensure
+          delete_file
+        end
+
+        def write(cmd)  
+          File.open(file_path, 'a') do |stream|
+            stream.write(cmd + "\n")
+          end
+        end
+
+        private
+
+        def create_file
+          ensure_service_root_dir
+          File.write(file_path, SCRIPT_HEADER)
+          File.chmod(0777, file_path)
+        end
+
+        def delete_file
+          FileUtils.rm_f(file_path)
+        end
+
+        def ensure_service_root_dir
+          FileUtils.mkdir_p(service.root_dir)
+        end
+      end
+    end
+  end
+end