devkitkat 0.1.21 → 0.1.22

data/lib/devkitkat/service.rb

@@ -1,79 +1,26 @@
 # encoding: UTF-8
 
 require 'fileutils'
+require "devkitkat/service/executor"
 
 module Devkitkat
   class Service
     attr_reader :name, :config, :command, :executor
 
-    ScriptError = Class.new(StandardError)
-
     DIVISIONS = %w[src script data cache log example dockerfile].freeze
     SERVICE_PROPERTIES = %w[repo host port]
 
-    SCRIPT_TEMPLATE = <<-EOS
-#!/bin/bash
-set -e
-
-# TODO: Define scripts
-    EOS
-
-    delegate :options, :script, :args, :kit_root, to: :command
-
     def initialize(name, config, command)
       @name, @config, @command = name, config, command
     end
 
     def execute
-      execute!
-
-      true
-    rescue ScriptError => e
-      puts "Failure: #{e}".colorize(:red)
-
-      false
-    end
-
-    def execute!
-      executor.prepare
-
-      inject_global_variables
-      inject_public_variables
-      inject_private_variables
-      setup_logger
-
-      FileUtils.rm_f(log_path)
-      FileUtils.mkdir_p(log_dir)
-
-      method = script.tr('-', '_')
-
-      if File.exist?(script_path)
-        executor.write(%Q{echo "This script is a custom script provided by you."})
-        executor.write(script_path)
-      elsif respond_to?(method, true)
-        executor.write(%Q{echo "This script is a predefined script provided by devkitkat."})
-        executor.write("set -e")
-        send(method)
-      end
-
-      executor.commit.tap do |result|
-        raise ScriptError, process_error_message($?) unless result
-      end
-    ensure
-      executor.cleanup
-    end
-
-    def log_path
-      File.join(log_dir, "#{script}.log")
-    end
-
-    def container_name
-      "#{config.application}-#{name}"
+      Executor.new(self).execute
     end
 
     DIVISIONS.each do |division|
       define_method :"#{division}_dir" do
-        File.join(service_dir, division)
+        File.join(dir, division)
       end
     end
 
@@ -87,178 +34,30 @@ set -e
       end
     end
 
-    def service_dir
-      File.join(kit_root, 'services', name)
+    def root_dir
+      File.join(command.kit_root, 'services')
     end
 
-    def shared_script_dir
-      File.join(script_dir, 'shared')
-    end
-
-    private
-
-    def inject_global_variables
-      config.variables.each do |key, value|
-        executor.write("export #{key}=#{value}")
-      end
-
-      command.variables&.each do |key, value|
-        executor.write("export #{key}=#{value}")
-      end
-
-      executor.write("export DK_ROOT_DIR=#{kit_root}")
-      executor.write("export DK_ENVIRONMENT_TYPE=#{config.environment_type.to_s}")
-      executor.write("export DK_APPLICATION=#{config.application.to_s}")
-    end
-
-    def inject_public_variables
-      all_services.each do |service|
-        executor.write("export DK_#{service.name.upcase}_DIR=#{service.service_dir}")
-
-        DIVISIONS.each do |division|
-          executor.write("export DK_#{service.name.upcase}_#{division.upcase}_DIR=#{service.send("#{division}_dir")}")
-        end
-
-        executor.write("export DK_#{service.name.upcase}_SHARED_SCRIPT_DIR=#{service.shared_script_dir}")
-
-        config.service_hash(service.name).each do |key, value|
-          executor.write("export DK_#{service.name.upcase}_#{key.upcase}=#{value}")
-        end
-      end
-    end
-
-    def inject_private_variables
-      executor.write("export DK_SELF_DIR=#{service_dir}")
-
-      DIVISIONS.each do |division|
-        executor.write("export DK_SELF_#{division.upcase}_DIR=#{send("#{division}_dir")}")
-      end
-
-      config.service_hash(name).each do |key, value|
-        executor.write("export #{key}=#{value}")
-      end
-    end
-
-    def setup_logger
-      return if command.interactive?
-
-      executor.write("exec > #{log_path} 2>&1")
+    def dir
+      File.join(root_dir, name)
     end
 
-    def all_services
-      @all_services ||= config.all_services.map { |service| Service.new(service, config, command) }
+    def log_path
+      File.join(log_dir, "#{command.script}.log")
     end
 
     def script_path
-      File.join(script_dir, script)
+      File.join(script_dir, command.script)
     end
 
     def system?
       name == 'system'
     end
 
-    def process_error_message(exit_code)
-      %Q[The command "#{script}" for "#{name}" exited with non-zero code: #{exit_code}.
-See the log file: #{log_path}]
-    end
-
-    def add_script
-      names = command.args.any? ? command.args : %w[configure unconfigure start]
-
-      FileUtils.mkdir_p(script_dir)
-
-      names.each do |name|
-        file_path = File.join(script_dir, name)
-
-        next if File.exist?(file_path)
-
-        File.write(file_path, SCRIPT_TEMPLATE)
-        File.chmod(0777, file_path)
-      end
-    end
-
-    def add_example
-      names = command.args
-
-      raise ArgumentError, 'Please specify at least one example name' if names.empty?
-
-      FileUtils.mkdir_p(example_dir)
-
-      names.each do |name|
-        file_path = File.join(example_dir, name)
-
-        next if File.exist?(file_path)
-
-        FileUtils.touch(file_path)
-        File.chmod(0777, file_path)
-      end
-    end
-
-    def add_shared_script
-      raise ArgumentError, %Q{Shared script has to be added to "system"} unless name == 'system'
-
-      FileUtils.mkdir_p(script_dir)
-
-      file_path = File.join(script_dir, 'shared')
-
-      return if File.exist?(file_path)
-
-      FileUtils.touch(file_path)
-      File.chmod(0777, file_path)
-    end
-
-    def clone
-      return unless repo_defined?
-
-      cmd = <<-EOS
-if [ -n "$GIT_DEPTH" ]; then
-  git clone #{repo} #{src_dir} --depth $GIT_DEPTH
-else
-  git clone #{repo} #{src_dir}
-fi
-      EOS
-
-      executor.write(cmd)
-    end
-
-    def pull
-      return unless repo_defined?
-
-      executor.write("cd #{src_dir}")
-      executor.write("git checkout master")
-      executor.write("git pull origin master")
-    end
-
-    def clean
-      executor.write("rm -rf #{src_dir}")
-      executor.write("rm -rf #{data_dir}")
-      executor.write("rm -rf #{cache_dir}")
-      executor.write("rm -rf #{log_dir}")
-    end
+    def shared_script_path
+      return unless system?
 
-    def reconfigure
-      unconfigure_path = File.join(script_dir, 'unconfigure')
-      configure_path = File.join(script_dir, 'configure')
-
-      executor.write(unconfigure_path) if File.exist?(unconfigure_path)
-      executor.write(configure_path) if File.exist?(configure_path)
-    end
-
-    def poop
-      executor.write(%Q{echo "💩"})
-    end
-
-    def exec
-      executor.write(%Q{cd #{src_dir}})
-      executor.write(%Q{#{args.join(' ')}})
-    end
-
-    def show_variables
-      executor.write(%Q{export})
-    end
-
-    def executor
-      @executor ||= Executor.new(self)
+      File.join(script_dir, 'shared')
     end
   end
 end

data/lib/devkitkat/version.rb

@@ -1,3 +1,3 @@
 module Devkitkat
-  VERSION = "0.1.21"
+  VERSION = "0.1.22"
 end

data/lib/devkitkat.rb

@@ -1,14 +1,21 @@
 require "devkitkat/version"
-require "devkitkat/main"
-require "devkitkat/executor"
 require "devkitkat/command"
 require "devkitkat/config"
 require "devkitkat/service"
-require 'yaml'
-require 'optparse'
-require 'parallel'
+require "devkitkat/processor"
 require 'colorize'
 require 'active_support/core_ext/array/conversions'
 
 module Devkitkat
+  class Main
+    def self.execute
+      command = Command.new
+      config = Config.new(command.kit_root)
+
+      target_services = config.resolve!(command.target, exclude: command.options[:exclude])
+                              .map { |name| Service.new(name, config, command) }
+
+      Processor.new(target_services, command, config).execute
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devkitkat
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Shinya Maeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.34.2
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Make micro services easy
 email:
 - shinya@gitlab.com
@@ -188,18 +202,33 @@ files:
 - bin/release
 - bin/setup
 - devkitkat.gemspec
-- docs/READ.md
-- docs/config/READ.md
-- docs/machine/READ.md
-- docs/service/READ.md
 - lib/devkitkat.rb
 - lib/devkitkat/command.rb
 - lib/devkitkat/config.rb
-- lib/devkitkat/executor.rb
-- lib/devkitkat/executor/docker.rb
-- lib/devkitkat/executor/local.rb
-- lib/devkitkat/main.rb
+- lib/devkitkat/processor.rb
 - lib/devkitkat/service.rb
+- lib/devkitkat/service/concerns/service_initializer.rb
+- lib/devkitkat/service/driver/base.rb
+- lib/devkitkat/service/driver/docker.rb
+- lib/devkitkat/service/driver/docker/container.rb
+- lib/devkitkat/service/driver/docker/image.rb
+- lib/devkitkat/service/driver/none.rb
+- lib/devkitkat/service/executor.rb
+- lib/devkitkat/service/executor/logger.rb
+- lib/devkitkat/service/executor/scripter.rb
+- lib/devkitkat/service/executor/variables.rb
+- lib/devkitkat/service/predefined_command/add_example.rb
+- lib/devkitkat/service/predefined_command/add_git_ignore.rb
+- lib/devkitkat/service/predefined_command/add_script.rb
+- lib/devkitkat/service/predefined_command/add_shared_script.rb
+- lib/devkitkat/service/predefined_command/base.rb
+- lib/devkitkat/service/predefined_command/clean.rb
+- lib/devkitkat/service/predefined_command/clone.rb
+- lib/devkitkat/service/predefined_command/exec.rb
+- lib/devkitkat/service/predefined_command/poop.rb
+- lib/devkitkat/service/predefined_command/pull.rb
+- lib/devkitkat/service/predefined_command/reconfigure.rb
+- lib/devkitkat/service/predefined_command/show_variables.rb
 - lib/devkitkat/version.rb
 homepage: https://gitlab.com/dosuken123/devkitkat
 licenses:

data/docs/READ.md

@@ -1 +0,0 @@
-# Devkitkat

data/docs/config/READ.md

@@ -1 +0,0 @@
-# Config

data/docs/machine/READ.md

@@ -1 +0,0 @@
-# Machine

data/docs/service/READ.md

@@ -1 +0,0 @@
-# Service

data/lib/devkitkat/executor/docker.rb

@@ -1,154 +0,0 @@
-require 'active_support/core_ext/module/delegation'
-require 'docker'
-
-module Devkitkat
-  class Executor
-    class Docker
-      PreparationError = Class.new(StandardError)
-
-      attr_reader :service, :script_file
-
-      delegate :config, :command, to: :service
-
-      ROOT_IN_CONTAINER = '/devkitkat'
-
-      def initialize(service)
-        @service = service
-      end
-
-      def prepare
-        pull_image unless image_exist?
-        start_container
-        sync_user_with_host
-      end
-
-      def cleanup
-        stop_container
-      end
-
-      def commit(script_file)
-        @script_file = script_file
-
-        rewrite_root_path!
-        new_path = script_path_in_container
-
-        exec([new_path], user: user_name)
-      end
-
-      private
-  
-      def rewrite_root_path!
-        content = File.read(script_file)
-        new_content = content.gsub(command.kit_root, ROOT_IN_CONTAINER)
-        File.write(script_file, new_content)
-      end
-
-      def script_path_in_container
-        relative_path = script_file.delete_prefix(command.kit_root)
-        File.join(ROOT_IN_CONTAINER, relative_path)
-      end
-
-      def log_path_in_container
-        relative_path = service.log_path.delete_prefix(command.kit_root)
-        File.join(ROOT_IN_CONTAINER, relative_path)
-      end
-
-      def docker_image
-        config.image
-      end
-  
-      def container
-        @container ||= ::Docker::Container.create(container_parameter)
-      end
-  
-      def container_parameter
-        params = {
-          'Cmd' => %w[tail -f],
-          'Image' => docker_image,
-          'name' => service.container_name,
-          'HostConfig' => {
-            'Binds' => ["#{command.kit_root}:#{ROOT_IN_CONTAINER}"]
-          }
-        }
-
-        if service.port
-          params.deep_merge!(
-            'ExposedPorts' => { "#{service.port}/tcp" => {} },
-            'HostConfig' => {
-              'PortBindings' => {
-                "#{service.port}/tcp" => [{ 'HostPort' => service.port.to_s }]
-              }
-            }
-          )
-        end
-
-        params
-      end
-
-      def pull_image
-        puts "Pulling image #{docker_image}..."
-        ::Docker::Image.create('fromImage' => docker_image)
-        puts "Pulled image #{docker_image}..."
-      end
-
-      def image_exist?
-        ::Docker::Image.get(docker_image)
-      rescue
-        false
-      end
-
-      def start_container
-        container.start
-      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 exec(cmds, params = {})
-        stdout_messages, stderr_messages, exit_code =
-          container.exec(cmds, params)
-
-        if command.debug?
-          puts "#{self.class.name} - #{__callee__}: stdout_messages: #{stdout_messages} stderr_messages: #{stderr_messages}"
-        end
-
-        exit_code == 0 ? true : false
-      end
-
-      def exec!(cmds, params = {})
-        unless exec(cmds, params)
-          raise PreparationError, "Failed to execute command in container. cmds: #{cmds}"
-        end
-      end
-
-      def sync_user_with_host
-        exec!(['addgroup', '--gid', group_id, user_name])
-
-        exec!(['adduser',
-          '--uid', user_id,
-          '--gid', group_id,
-          '--shell', '/bin/bash',
-          '--home', ROOT_IN_CONTAINER,
-          '--gecos', '',
-          '--disabled-password',
-          user_name])
-
-        exec!(['chown', '-R', "#{user_name}:#{user_name}", ROOT_IN_CONTAINER])
-      end
-  
-      def stop_container
-        # container.stop
-        container.remove(force: true)
-      end
-    end
-  end
-end

data/lib/devkitkat/executor/local.rb

@@ -1,25 +0,0 @@
-module Devkitkat
-  class Executor
-    class Local
-      attr_reader :service
-
-      delegate :config, :command, to: :service
-
-      def initialize(service)
-        @service = service
-      end
-
-      def prepare
-        # no-op
-      end
-
-      def cleanup
-        # no-op
-      end
-
-      def commit(script_file)
-        system(script_file)
-      end
-    end
-  end
-end

data/lib/devkitkat/executor.rb

@@ -1,62 +0,0 @@
-require "devkitkat/executor/docker"
-require "devkitkat/executor/local"
-
-module Devkitkat
-  class Executor
-    attr_reader :service, :scripts
-
-    delegate :config, :command, to: :service
-    delegate :prepare, :cleanup, to: :executor
-
-    SCRIPT_HEADER = <<-EOS
-#!/bin/bash
-    EOS
-
-    def initialize(service)
-      @service = service
-      delete_script_file
-    end
-
-    def write(cmd)
-      ensure_script_file
-
-      File.open(script_file, 'a') do |stream|
-        stream.write(cmd + "\n")
-      end
-    end
-
-    def commit
-      executor.commit(script_file)
-    ensure
-      delete_script_file
-    end
-
-    private
-
-    def executor
-      @executor ||= klass.new(service)
-    end
-
-    def klass
-      Object.const_get("Devkitkat::Executor::#{config.environment_type.capitalize}")
-    end
-
-    def script_file
-      File.join(command.tmp_dir, "script-#{service.name}-#{command.script}")
-    end
-
-    def ensure_script_file
-      create_script_file unless File.exist?(script_file)
-    end
-
-    def create_script_file
-      command.create_tmp_dir
-      File.write(script_file, SCRIPT_HEADER)
-      File.chmod(0777, script_file)
-    end
-
-    def delete_script_file
-      FileUtils.rm_f(script_file)
-    end
-  end
-end

data/lib/devkitkat/main.rb

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