devkitkat 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "devkitkat"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/devkitkat

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "devkitkat"
+require 'pry'
+
+Devkitkat::Main.new.execute

data/bin/fast_rspec

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rspec -t ~slow

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/devkitkat.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "devkitkat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "devkitkat"
+  spec.version       = Devkitkat::VERSION
+  spec.authors       = ["Shinya Maeda"]
+  spec.email         = ["shinya@gitlab.com"]
+
+  spec.summary       = "Make micro services easy"
+  spec.description   = "Make micro services easy"
+  spec.homepage      = "https://gitlab.com/dosuken123/devkitkat"
+  spec.license       = "MIT"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "devkitkat"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-temp_dir", "~> 1.1.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "pry-nav"
+  spec.add_runtime_dependency "activesupport", "~> 6.0.0"
+  spec.add_runtime_dependency "parallel", "~> 1.17.0"
+  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"
+end

data/docs/READ.md

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

data/docs/config/READ.md

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

data/docs/machine/READ.md

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

data/docs/service/READ.md

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

data/lib/devkitkat.rb

@@ -0,0 +1,14 @@
+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 'colorize'
+require 'active_support/core_ext/array/conversions'
+
+module Devkitkat
+end

data/lib/devkitkat/command.rb

@@ -0,0 +1,65 @@
+module Devkitkat
+  class Command
+    attr_reader :options, :script, :target, :args
+
+    def initialize
+      @options = {}
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: devkitkat <script> <target> [options]"
+
+        opts.on("-p", "--path PATH", "The root path of the .devkitkat.yml") do |v|
+          options[:root_path] = v
+        end
+
+        opts.on("-e", "--exclude SERVICE", "Exclude serviced from the specified target") do |v|
+          options[:exclude] ||= []
+          options[:exclude] << v
+        end
+
+        opts.on("-e", "--env-var VARIABLE", "additional environment variables") do |v|
+          options[:variables] ||= {}
+          options[:variables].merge!(Hash[*v.split('=')])
+        end
+
+        opts.on("-d", "--depth DEPTH", "Git depth for pull/fetch") do |v|
+          options[:git_depth] = v
+        end
+
+        opts.on("-r", "--remote REMOTE", "Git remote") do |v|
+          options[:git_remote] = v
+        end
+
+        opts.on("-b", "--branch BRANCH", "Git branch") do |v|
+          options[:git_branch] = v
+        end
+
+        opts.on("-t", "--tty", "TTY mode. In this mode, log won't be emitted.") do |v|
+          options[:tty] = v
+        end
+      end.parse!
+
+      @script, @target, *@args = ARGV
+    end
+
+    def tty?
+      options[:tty]
+    end
+
+    def variables
+      options[:variables]
+    end
+
+    def tmp_dir
+      File.join(kit_root, 'tmp')
+    end
+
+    def create_tmp_dir
+      FileUtils.mkdir_p(tmp_dir)
+    end
+
+    def kit_root
+      Dir.pwd # TODO: root_path
+    end
+  end
+end

data/lib/devkitkat/config.rb

@@ -0,0 +1,87 @@
+module Devkitkat
+  class Config
+    DEVKITKAT_FILE_NAME = '.devkitkat.yml'
+    HIDDEN_SERVICES = %w[system]
+
+    attr_reader :devkitkat_yml, :kit_root
+
+    def initialize(kit_root)
+      @kit_root = kit_root
+      @devkitkat_yml = load_config
+    end
+
+    def all_services
+      services + HIDDEN_SERVICES
+    end
+
+    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 service = find_service(target)
+                   [service]
+                 else
+                   raise ArgumentError, "The target name #{target} couldn't be resolved"
+                 end
+
+      services = services - exclude if exclude
+
+      services
+    end
+
+    def environment_type
+      devkitkat_yml.dig('environment', 'type') || 'local'
+    end
+
+    def environment_image
+      devkitkat_yml.dig('environment', 'image')
+    end
+
+    def application
+      devkitkat_yml.fetch('application', '')
+    end
+
+    def variables
+      devkitkat_yml.fetch('variables', {})
+    end
+
+    def service_hash(name)
+      devkitkat_yml.dig('services', name) || {}
+    end
+
+    private
+
+    def services
+      devkitkat_yml['services']&.keys || []
+    end
+
+    def groups
+      devkitkat_yml['groups']&.keys || []
+    end
+
+    def services_for_group(group)
+      devkitkat_yml.dig('groups', group) || []
+    end
+
+    def find_group(target)
+      groups.find { |group| group == target }
+    end
+
+    def find_service(target)
+      services.find { |service| service == target }
+    end
+
+    def load_config
+      File.read(config_path).yield_self do |content|
+        YAML.load(content)
+      end
+    end
+
+    def config_path
+      File.join(kit_root, DEVKITKAT_FILE_NAME)
+    end
+  end
+end

data/lib/devkitkat/executor.rb

@@ -0,0 +1,63 @@
+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
+set -e
+    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/executor/docker.rb

@@ -0,0 +1,97 @@
+require 'active_support/core_ext/module/delegation'
+require 'docker'
+
+module Devkitkat
+  class Executor
+    class Docker
+      attr_reader :service, :script_file
+
+      delegate :config, :command, to: :service
+
+      def initialize(service)
+        @service = service
+      end
+
+      def prepare
+        start_container
+      end
+
+      def cleanup
+        stop_container
+      end
+
+      def commit(script_file)
+        @script_file = script_file
+
+        rewrite_root_path!
+        new_path = script_path_in_container
+
+        container.exec([new_path])
+      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.environment_image
+      end
+  
+      def container
+        @container ||= ::Docker::Container.create(container_parameter)
+      end
+  
+      def container_parameter
+        # TODO: Speicfy users otherwise the created files are owned by root
+        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 root_in_container
+        "/devkitkat"
+      end
+
+      def start_container
+        container.start
+      end
+  
+      def stop_container
+        container.stop
+        container.remove
+      end
+    end
+  end
+end

data/lib/devkitkat/executor/local.rb

@@ -0,0 +1,25 @@
+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