kuber_kit 0.3.6 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a2b626e99cbab815d586f4ca2c05796f367f25058502ab7f7b801a0d5191c70
-  data.tar.gz: 281a2179e9e15d017c65d76c95e1ee863e370fa405ac80571747c2bebaca8e2c
+  metadata.gz: 4a8482307f03712fa9621bd81744aa15292d0378a24316c907050ddb1c379981
+  data.tar.gz: 28c6b0a83c41d0e221a62e0c45d034a6ecd28722ecb3e98a65471bcaf206372e
 SHA512:
-  metadata.gz: c755057ec72e897bce215977d2fef6e2b5bd2e72ae6b7bf6bd58774605bed91d22a73dda41a68783ea36e4c1a375eff432db6764ff1295baae243a0a2ca8a7e4
-  data.tar.gz: fbb4da6342592b1f5506911787f763f567804aa71fc975a76650e7b8e04137f10be5062e1bafa7ef89ec8bc1c0d86d53d73b9771cb2a90edc6debd7666c1212d
+  metadata.gz: 9034b084c1eb1db7dd70ad33f067a19e093bdaaf040aa3b65473d5e823570e35480b0915d1b0274a40ffda74c218e7aaa24ee919935bc1424d579e7c7cbf3ec5
+  data.tar.gz: 39bab8853fed26799be1b3b7e1f708be89c82e9082e70c05d5746fd99e11ab52f45a822bfcba572317c6a6128e7fbc823a7b9d9313379a93bc288bf9d7c80ba2

data/.github/workflows/rspec.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Rspec
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kuber_kit (0.3.6)
+    kuber_kit (0.3.11)
       cli-ui
       contracts-lite
       dry-auto_inject

data/README.md

@@ -1,6 +1,6 @@
 # KuberKit
 
-[![Codeship Status for ArtStation/kuber_kit](https://app.codeship.com/projects/1286f0a6-3f90-4c1b-b426-721ed8a6571b/status?branch=master)](https://app.codeship.com/projects/417264)
+[![Rspec](https://github.com/ArtStation/kuber_kit/workflows/Rspec/badge.svg)](https://github.com/ArtStation/kuber_kit/actions?query=workflow%3ARspec)
 
 Solution for building & deploying applications on Kubernetes, written in Ruby.
 

data/TODO.md

@@ -5,4 +5,5 @@
 - allow deploying only services enabled for specific configuration
 - find a way to always deploy some service, e.g. for migrations and env_files
 - template should be able to set default attributes
-- template should be able to depend on image?
+- template should be able to depend on image?
+- cleanup image builds older than some date

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -1,6 +1,4 @@
 class KuberKit::Actions::ConfigurationLoader
-  APP_CONFIG_FILENAME = "config.rb".freeze
-
   include KuberKit::Import[
     "core.registry_store",
     "core.image_store",
@@ -16,13 +14,6 @@ class KuberKit::Actions::ConfigurationLoader
   Contract Hash => Any
   def call(options)
     root_path     = options[:path] || File.join(Dir.pwd, configs.kuber_kit_dirname)
-
-    # require config file first, in case if other dirs are overriden in config
-    config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
-    if File.exists?(config_file_path)
-      require config_file_path
-    end
-
     images_path   = options[:images_path] || File.join(root_path, configs.images_dirname)
     services_path = options[:services_path] || File.join(root_path, configs.services_dirname)
     infra_path    = options[:infra_path]  || File.join(root_path, configs.infra_dirname)
@@ -37,6 +28,8 @@ class KuberKit::Actions::ConfigurationLoader
     logger.info "  Configurations path: #{configurations_path.to_s.yellow}"
     logger.info "  Configuration name: #{configuration_name.to_s.yellow}"
 
+    ui.print_info("Logs", "See logs at: #{configs.log_file_path}")
+
     unless File.exists?(root_path)
       ui.print_warning "WARNING", "KuberKit root path #{root_path} doesn't exist. You may want to pass it --path parameter."
     end

data/lib/kuber_kit/actions/kubectl_logs.rb

@@ -16,7 +16,7 @@ class KuberKit::Actions::KubectlLogs
       pod_name  = ui.prompt("Please select deployment to attach", deploy_options)
     end
 
-    args = ""
+    args = nil
     if options[:follow]
       args = "-f"
     end

data/lib/kuber_kit/cli.rb

@@ -1,6 +1,8 @@
 require 'thor'
 
 class KuberKit::CLI < Thor
+  APP_CONFIG_FILENAME = "config.rb".freeze
+
   class_option :path, :type => :string
   class_option :images_path, :type => :string
   class_option :infra_path, :type => :string
@@ -10,7 +12,7 @@ class KuberKit::CLI < Thor
 
   desc "compile IMAGE_NAMES", "Compile image with IMAGE_NAMES (comma-separated)"
   def compile(image_names_str)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
     
     image_names = image_names_str.split(",").map(&:strip).map(&:to_sym)
 
@@ -35,7 +37,7 @@ class KuberKit::CLI < Thor
   method_option :tags,          :type => :array,    aliases: ["-t"]
   method_option :skip_compile,  :type => :boolean,  aliases: ["-B"]
   def deploy
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       result = KuberKit::Container['actions.service_deployer'].call(
@@ -59,7 +61,7 @@ class KuberKit::CLI < Thor
 
   desc "env ENV_FILE_NAME", "Return content of Env File ENV_FILE_NAME"
   def env(env_file_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.env_file_reader'].call(env_file_name.to_sym, options)
@@ -68,7 +70,7 @@ class KuberKit::CLI < Thor
 
   desc "template TEMPLATE_NAME", "Return content of Template TEMPLATE_NAME"
   def template(template_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.template_reader'].call(template_name.to_sym, options)
@@ -77,7 +79,7 @@ class KuberKit::CLI < Thor
 
   desc "service SERVICE_NAME", "Return content of Service SERVICE_NAME"
   def service(service_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.service_reader'].call(service_name.to_sym, options)
@@ -86,7 +88,7 @@ class KuberKit::CLI < Thor
 
   desc "apply FILE_PATH", "Apply FILE_PATH with kubectl"
   def apply(file_path)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_applier'].call(File.expand_path(file_path), options)
@@ -95,26 +97,26 @@ class KuberKit::CLI < Thor
 
   desc "attach POD_NAME", "Attach to POD_NAME using kubectl"
   def attach(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_attacher'].call(pod_name, options)
     end
   end
 
-  desc "launch console in POD_NAME", "Attach to POD_NAME using kubectl & launch bin/console"
+  desc "console POD_NAME", "Attach to POD_NAME using kubectl & launch bin/console"
   def console(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_console'].call(pod_name, options)
     end
   end
 
-  desc "show logs for POD_NAME", "Show logs for POD_NAME using kubectl"
+  desc "logs POD_NAME", "Show logs for POD_NAME using kubectl"
   method_option :follow,  :type => :boolean,  aliases: ["-f"]
   def logs(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_logs'].call(pod_name, options)
@@ -129,4 +131,16 @@ class KuberKit::CLI < Thor
   def self.exit_on_failure?
     true
   end
+
+  private
+    def setup(options)
+      KuberKit.set_debug_mode(options[:debug])
+
+      # We should load config before loading any bean, to make sure that bean won't be built with default config
+      root_path     = options[:path] || File.join(Dir.pwd, KuberKit::Container['configs'].kuber_kit_dirname)
+      config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
+      if File.exists?(config_file_path)
+        require config_file_path
+      end
+    end
 end

data/lib/kuber_kit/configs.rb

@@ -5,7 +5,7 @@ class KuberKit::Configs
     :image_dockerfile_name, :image_build_context_dir, :image_tag, :docker_ignore_list, :image_compile_dir, 
     :kuber_kit_dirname, :kuber_kit_min_version, :images_dirname, :services_dirname, :infra_dirname, :configurations_dirname,
     :artifact_clone_dir, :service_config_dir, :deployer_strategy, :compile_simultaneous_limit,
-    :additional_images_paths, :deprecation_warnings_disabled
+    :additional_images_paths, :deprecation_warnings_disabled, :log_file_path
   ]
   DOCKER_IGNORE_LIST = [
     'Dockerfile',
@@ -51,6 +51,7 @@ class KuberKit::Configs
     set :compile_simultaneous_limit, 5
     set :additional_images_paths, []
     set :deprecation_warnings_disabled, false
+    set :log_file_path,           "/tmp/kuber_kit.log"
   end
 
   def items

data/lib/kuber_kit/container.rb

@@ -114,7 +114,7 @@ class KuberKit::Container
   end
 
   register "tools.logger" do
-    KuberKit::Container["tools.logger_factory"].create("/tmp/kuber_kit.log")
+    KuberKit::Container["tools.logger_factory"].create()
   end
 
   register "shell.bash_commands" do

data/lib/kuber_kit/core/service.rb

@@ -4,11 +4,11 @@ class KuberKit::Core::Service
   attr_reader :name, :template_name, :tags, :images, :attributes, :deployer_strategy
 
   Contract KeywordArgs[
-    name:             Symbol,
-    template_name:    Symbol,
-    tags:             ArrayOf[Symbol],
-    images:           ArrayOf[Symbol],
-    attributes:       HashOf[Symbol => Any],
+    name:               Symbol,
+    template_name:      Maybe[Symbol],
+    tags:               ArrayOf[Symbol],
+    images:             ArrayOf[Symbol],
+    attributes:         HashOf[Symbol => Any],
     deployer_strategy:  Maybe[Symbol]
   ] => Any
   def initialize(name:, template_name:, tags:, images:, attributes:, deployer_strategy:)

data/lib/kuber_kit/core/service_factory.rb

@@ -1,13 +1,7 @@
 class KuberKit::Core::ServiceFactory
-  AttributeNotSetError = Class.new(KuberKit::Error)
-
   def create(definition)
     service_attrs = definition.to_service_attrs
 
-    if service_attrs.template_name.nil?
-      raise AttributeNotSetError, "Please set template for service using #template method"
-    end
-
     configuration_attributes = KuberKit.current_configuration.service_attributes(service_attrs.name)
     attributes = (service_attrs.attributes || {}).merge(configuration_attributes)
 

data/lib/kuber_kit/service_deployer/strategies/docker.rb

@@ -8,8 +8,9 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
   STRATEGY_OPTIONS = [
     :container_name,
     :image_name,
-    :docker_run_args,
-    :docker_run_command,
+    :detached,
+    :command_name,
+    :command_args,
     :delete_if_exists
   ]
 
@@ -21,9 +22,9 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
       raise KuberKit::Error, "Unknow options for deploy strategy: #{unknown_options}. Available options: #{STRATEGY_OPTIONS}"
     end
     
-    container_name    = strategy_options.fetch(:container_name, service.uri)
-    docker_run_args   = strategy_options.fetch(:docker_run_args, nil)
-    docker_run_command = strategy_options.fetch(:docker_run_command, nil)
+    container_name = strategy_options.fetch(:container_name, service.uri)
+    command_name   = strategy_options.fetch(:command_name, "bash")
+    command_args   = strategy_options.fetch(:command_args, nil)
 
     image_name = strategy_options.fetch(:image_name, nil)
     if image_name.nil?
@@ -36,6 +37,16 @@ class KuberKit::ServiceDeployer::Strategies::Docker < KuberKit::ServiceDeployer:
       docker_commands.delete_container(shell, container_name)
     end
 
-    docker_commands.run(shell, image.remote_registry_url, run_args: docker_run_args, run_command: docker_run_command)
+    command_args = Array(command_args)
+    if container_name
+      command_args << "--name #{container_name}"
+    end
+
+    docker_commands.run(
+      shell, image.remote_registry_url, 
+      command:    command_name,
+      args:       command_args, 
+      detached:   !!strategy_options[:detached]
+    )
   end
 end

data/lib/kuber_kit/service_deployer/strategies/docker_compose.rb

@@ -7,7 +7,9 @@ class KuberKit::ServiceDeployer::Strategies::DockerCompose < KuberKit::ServiceDe
 
   STRATEGY_OPTIONS = [
     :service_name, 
-    :command_name
+    :command_name,
+    :command_args,
+    :detached
   ]
 
   Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
@@ -24,10 +26,13 @@ class KuberKit::ServiceDeployer::Strategies::DockerCompose < KuberKit::ServiceDe
 
     service_name = strategy_options.fetch(:service_name, service.name.to_s)
     command_name = strategy_options.fetch(:command_name, "bash")
+    command_args = strategy_options.fetch(:command_args, nil)
 
     docker_compose_commands.run(shell, config_path, 
-      service:      service_name, 
-      command:      command_name,
+      service:  service_name, 
+      command:  command_name,
+      args:     command_args, 
+      detached: !!strategy_options[:detached]
     )
   end
 end

data/lib/kuber_kit/service_reader/reader.rb

@@ -6,8 +6,14 @@ class KuberKit::ServiceReader::Reader
     "preprocessing.text_preprocessor"
   ]
 
+  AttributeNotSetError = Class.new(KuberKit::Error)
+
   Contract KuberKit::Shell::AbstractShell, KuberKit::Core::Service => Any
   def read(shell, service)
+    if service.template_name.nil?
+      raise AttributeNotSetError, "Please set template for service using #template method"
+    end
+
     template = template_store.get(service.template_name)
 
     context_helper = context_helper_factory.build_service_context(shell, service)

data/lib/kuber_kit/shell/commands/docker_commands.rb

@@ -14,14 +14,19 @@ class KuberKit::Shell::Commands::DockerCommands
     shell.exec!(%Q{docker push #{tag_name}})
   end
 
-  def run(shell, image_name, run_args: nil, run_command: nil)
+  def run(shell, image_name, args: nil, command: nil, detached: false, interactive: false)
     command_parts = []
     command_parts << "docker run"
-    command_parts << run_args if run_args
+    command_parts << "-d" if detached
+    command_parts << Array(args).join(" ") if args
     command_parts << image_name
-    command_parts << run_command if run_command
+    command_parts << command if command
 
-    shell.exec!(command_parts.join(" "))
+    if interactive
+      shell.interactive!(command_parts.join(" "))
+    else
+      shell.exec!(command_parts.join(" "))
+    end
   end
 
   def container_exists?(shell, container_name)

data/lib/kuber_kit/shell/commands/docker_compose_commands.rb

@@ -1,13 +1,17 @@
 class KuberKit::Shell::Commands::DockerComposeCommands
-  def run(shell, path, service:, command:, interactive: false)
+  def run(shell, path, service:, args: nil, command: nil, detached: false, interactive: false)
     command_parts = [
       "docker-compose",
       "-f #{path}",
       "run",
-      service,
-      command
     ]
     
+
+    command_parts << "-d" if detached
+    command_parts << Array(args).join(" ") if args
+    command_parts << service
+    command_parts << command if command
+    
     if interactive
       shell.interactive!(command_parts.join(" "))
     else

data/lib/kuber_kit/shell/local_shell.rb

@@ -76,7 +76,7 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
 
   def recursive_list_files(path, name: nil)
     command = %Q{find -L #{path}  -type f}
-    command += " -name #{name}" if name
+    command += " -name '#{name}'" if name
     exec!(command).split(/[\r\n]+/)
   rescue => e
     if e.message.include?("No such file or directory")

data/lib/kuber_kit/tools/logger_factory.rb

@@ -9,8 +9,12 @@ class KuberKit::Tools::LoggerFactory
     Logger::FATAL  => String::Colors::PURPLE,
   }
 
-  def create(stdout, level = nil)
-    logger = Logger.new(stdout)
+  include KuberKit::Import[
+    "configs",
+  ]
+
+  def create(stdout = nil, level = nil)
+    logger = Logger.new(stdout || configs.log_file_path)
 
     logger.level = level || Logger::DEBUG
 

data/lib/kuber_kit/version.rb

@@ -1,3 +1,3 @@
 module KuberKit
-  VERSION = "0.3.6"
+  VERSION = "0.3.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.11
 platform: ruby
 authors:
 - Iskander Khaziev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts-lite
@@ -145,6 +145,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -293,7 +294,7 @@ homepage: https://github.com/ArtStation/kuber_kit
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -308,8 +309,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: Docker Containers Build & Deployment
 test_files: []