devkitkat 0.1.26 → 0.1.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc1ec65b940b53a2d04d473ed109dbd6b97256f09ac270f2b59edb607201b310
-  data.tar.gz: c14fa3b11c1fe1fd4e33e92fece3bfa9e5eaf3ad233cb34cf0e5b8dfe2783a10
+  metadata.gz: ace209a03eb21d620b72245e0637ab380faf6a40542a18092bef7d33ed830583
+  data.tar.gz: 7716f985f8fec38aa5f1165d0997df890653bb025e4f0f7dfd45f88f673e8381
 SHA512:
-  metadata.gz: b331ae89d8c5cf523fe51b0b4cc36bad069b7f5750e7b8413ec4f41896ebcded43f680e42dfff6aa44bf4755aabf9d459e1f0c4c1e1243b80977baf787c06750
-  data.tar.gz: 78dcc4f8d93ddb3727c6f9ff254b9a4dd2ef406f7c95f07ae7bd6a216f622dc08b748811f3be5eec5d8822c2570375762d1f99063be2199589682cdc5ace505f
+  metadata.gz: 67ec50212126fe7cd1a30dd90018488421a8dce074828a6fd046803ee9d10019bf188c1eb60975572931b3cb888e5b89000b467cf8774c75d2c05ae380fc6771
+  data.tar.gz: d55adea94edc0e232edbdf07b8d45c6390befaf5ea8effcc138d4c1024aa8928ddc5208e249a0933c6049e8bfd350b3292fc884588595f1d4c07fb8afac23000

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    devkitkat (0.1.25)
+    devkitkat (0.1.33)
       activesupport (~> 6.0.0)
       colorize (~> 0.8.1)
-      docker-api (~> 1.34.2)
+      docker-api (~> 2.0.0)
       parallel (~> 1.17.0)
       pry (~> 0.12.2)
       pry-nav
@@ -14,25 +14,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    coderay (1.1.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    docker-api (1.34.2)
+    docker-api (2.0.0)
       excon (>= 0.47.0)
       multi_json
-    excon (0.73.0)
-    i18n (1.8.2)
+    excon (0.78.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.14.0)
-    multi_json (1.14.1)
+    minitest (5.14.2)
+    multi_json (1.15.0)
     parallel (1.17.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -60,17 +60,17 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.1.4)
   devkitkat!
   rake (~> 12.3.3)
   rspec (~> 3.0)
   rspec-temp_dir (~> 1.1.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -46,6 +46,20 @@ download/prepare services. These are available keys.
 
 There are pre-occupied special keys, please do not use these keys in your config file: `services:system`, `services:self`
 
+### `machine:` key
+
+|Key                                         |Type        |Required|Default|Description|
+|---                                         |---         |---     |---|---|
+|`machine:`                                  |Hash        |No      |-|The machine to run the application|
+|`machine:driver`                            |String      |No      |-|The driver name, one of `none` or `docker`. Default is `none`.|
+|`machine:location`                          |String      |No      |-|The machine location, one of `local` or `remote`. Default is `local`.|
+|`machine:image`                             |String      |No      |-|The docker image used as the machine image.|
+|`machine:extra_hosts`                       |Array<String>|No      |-|Extra hosts to be added to `/etc/hosts` in the machine|
+|`machine:network_mode`                      |String      |No      |-|Docker Network Mode, one of `bridge`, `host`.|
+|`machine:extra_write_accesses`              |Array<String>|No      |-|Extra write access to each service. By default, a service mounts only own directory as read-write and mounts the other service directories as read-only volume. To add extra write access, you specify `'<service-name>:to:<service-name>'`|
+
+
+
 ## Sample `.devkitkat.yml` that runs services in local environment
 
 ```yaml
@@ -60,7 +74,9 @@ services:
 ## Sample `.devkitkat.yml` that runs services in docker containers
 
 ```yaml
-image: ruby:2.6
+machine:
+  driver: docker
+  image: your-dev-machine-image:latest
 
 services:
   web:

data/devkitkat.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = "devkitkat"
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   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"
@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_runtime_dependency "docker-api", "~> 2.0.0"
   spec.add_runtime_dependency "require_all", "~> 3.0.0"
 end

data/lib/devkitkat/command.rb

@@ -46,6 +46,10 @@ module Devkitkat
         opts.separator ""
         opts.separator "Options:"
 
+        opts.on("-d", "--driver", "Machine Driver") do |v|
+          options[:driver] = v
+        end
+
         opts.on("-d", "--debug", "Debug mode") do |v|
           options[:debug] = v
         end
@@ -94,6 +98,8 @@ module Devkitkat
         opts.separator "clean               - Clean the service dir"
         opts.separator "poop                - Poop"
         opts.separator "show-variables      - Show all variables via 'export' command"
+        opts.separator "remove-containers   - Remove all related containers"
+        opts.separator "start-container     - Start a container (dry-run)"
       end
     end
 

data/lib/devkitkat/service.rb

@@ -59,5 +59,9 @@ module Devkitkat
 
       File.join(script_dir, 'shared')
     end
+
+    def machine_driver
+      config.service_hash(name).dig('machine', 'driver')
+    end
   end
 end

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

@@ -84,7 +84,8 @@ module Devkitkat
               'Image' => image,
               'name' => name,
               'HostConfig' => {
-                'Binds' => all_mounts
+                'Binds' => all_mounts,
+                'Privileged' => true
               }
             }
 
@@ -121,7 +122,7 @@ module Devkitkat
               else
                 "#{service.dir}:#{ROOT_IN_CONTAINER}/services/#{service.name}:ro"
               end
-            end
+            end.append('/var/run/docker.sock:/var/run/docker.sock')
           end
 
           def allowed_by_extra_write_accesses?(service)
@@ -162,6 +163,7 @@ module Devkitkat
 
             prepare!(['chown', "#{user_name}:#{user_name}", ROOT_IN_CONTAINER])
             prepare!(['chown', '-R', "#{user_name}:#{user_name}", "#{ROOT_IN_CONTAINER}/services/#{service.name}"])
+            prepare!(['usermod', '-aG', 'docker', user_name])
           end
 
           def prepare!(cmds, params = {})

data/lib/devkitkat/service/executor.rb

@@ -40,9 +40,11 @@ module Devkitkat
         if File.exist?(service.script_path)
           scripter.write(%Q{echo "INFO: This script is a custom script."})
           scripter.write(service.script_path)
+          @machine_driver = command.options[:driver]
         elsif predefined_command_available?
           scripter.write(%Q{echo "INFO: This script is a predefined script in devkitkat."})
           scripter.write(predefined_command.to_script)
+          @machine_driver = predefined_command.machine_driver
         else
           false
         end
@@ -51,6 +53,7 @@ module Devkitkat
       end
 
       def execute!
+        driver = get_driver_klass.new(service)
         driver.prepare
 
         driver.execute(scripter.file_path).tap do |result|
@@ -60,10 +63,6 @@ module Devkitkat
         driver.cleanup
       end
 
-      def driver
-        @driver ||= driver_klass.new(service)
-      end
-
       def scripter
         @scripter ||= Scripter.new(service)
       end
@@ -80,8 +79,10 @@ module Devkitkat
         @predefined_command ||= predefined_command_klass.new(service)
       end
 
-      def driver_klass
-        Object.const_get("Devkitkat::Service::Driver::#{config.machine_driver.camelize}")
+      def get_driver_klass
+        driver = @machine_driver || service.machine_driver || config.machine_driver
+
+        Object.const_get("Devkitkat::Service::Driver::#{driver.camelize}")
       end
 
       def predefined_command_klass

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

@@ -18,9 +18,12 @@ module Devkitkat
         def predefined_global_variables
           variables = []
           variables << "export DK_ROOT_DIR=#{command.kit_root}"
+          variables << "export DK_COMMAND_TARGET=#{command.target}"
           variables << "export DK_MACHINE_DRIVER=#{config.machine_driver.to_s}"
           variables << "export DK_MACHINE_LOCATION=#{config.machine_location.to_s}"
           variables << "export DK_MACHINE_IMAGE=#{config.machine_image.to_s}"
+          variables << "export DK_MACHINE_EXTRA_HOSTS=#{config.machine_extra_hosts&.join(',').to_s}"
+          variables << "export DK_MACHINE_NETWORK_MODE=#{config.machine_network_mode.to_s}"
           variables << "export DK_APPLICATION=#{config.application.to_s}"
           variables
         end
@@ -36,6 +39,8 @@ module Devkitkat
             end
 
             config.service_hash(service.name).each do |key, value|
+              next if value.is_a?(Hash)
+
               variables << "export DK_#{service.name.upcase}_#{key.upcase}=#{value}"
             end
 
@@ -65,6 +70,8 @@ module Devkitkat
 
         def config_service_variables
           config.service_hash(service.name).map do |key, value|
+            next if value.is_a?(Hash)
+
             "export #{key}=#{value}"
           end
         end

data/lib/devkitkat/service/predefined_command/add_example.rb

@@ -26,6 +26,10 @@ fi
         def available?
           true
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/add_git_ignore.rb

@@ -23,6 +23,10 @@ EOL
         def file_path
           File.join(command.kit_root, '.gitignore')
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/add_script.rb

@@ -29,6 +29,10 @@ fi
         def available?
           true
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/add_shared_script.rb

@@ -15,6 +15,10 @@ module Devkitkat
         def available?
           service.system? && !File.exist?(service.shared_script_path)
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

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

@@ -11,6 +11,10 @@ module Devkitkat
         def available?
           raise NotImplementedError
         end
+
+        def machine_driver
+          nil
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/clean.rb

@@ -16,6 +16,10 @@ module Devkitkat
         def available?
           true
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/clone.rb

@@ -19,6 +19,10 @@ module Devkitkat
         def available?
           service.repo_defined?
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/pull.rb

@@ -13,6 +13,10 @@ module Devkitkat
         def available?
           service.repo_defined?
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/remove_containers.rb

@@ -0,0 +1,21 @@
+module Devkitkat
+  class Service
+    class PredefinedCommand
+      class RemoveContainers < Base
+        def to_script
+          <<~EOS
+            docker rm -f $(docker ps -a -f name=#{config.application}-* -q)
+          EOS
+        end
+
+        def available?
+          true
+        end
+
+        def machine_driver
+          'none'
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/service/predefined_command/show_variables.rb

@@ -11,6 +11,10 @@ module Devkitkat
         def available?
           true
         end
+
+        def machine_driver
+          'none'
+        end
       end
     end
   end

data/lib/devkitkat/service/predefined_command/start_container.rb

@@ -0,0 +1,21 @@
+module Devkitkat
+  class Service
+    class PredefinedCommand
+      class StartContainer < Base
+        def to_script
+          <<~EOS
+            tail -f
+          EOS
+        end
+
+        def available?
+          true
+        end
+
+        def machine_driver
+          'docker'
+        end
+      end
+    end
+  end
+end

data/lib/devkitkat/version.rb

@@ -1,3 +1,3 @@
 module Devkitkat
-  VERSION = "0.1.26"
+  VERSION = "0.1.33"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devkitkat
 version: !ruby/object:Gem::Version
-  version: 0.1.26
+  version: 0.1.33
 platform: ruby
 authors:
 - Shinya Maeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.34.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.34.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +228,9 @@ files:
 - 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/remove_containers.rb
 - lib/devkitkat/service/predefined_command/show_variables.rb
+- lib/devkitkat/service/predefined_command/start_container.rb
 - lib/devkitkat/version.rb
 homepage: https://gitlab.com/dosuken123/devkitkat
 licenses:
@@ -249,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Make micro services easy