kuber_kit 1.1.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7172b9ae75ac4a18cbc1c82517b748fe4a089916f6bf56960548357b6b978a6
-  data.tar.gz: 2a21fb1b7d9d2b660a78633161354badd391c39d6c95a252254f3b8af694bc69
+  metadata.gz: b70bdef220e67c9789122ab7eb7ee064dff475174ec1e497b0baf11566da6e1f
+  data.tar.gz: 004b9a6c4e8265f1f3f498b1b42fa35a0447567ef428abef4b571cce635c0cd9
 SHA512:
-  metadata.gz: 24e689ebd9a561abc36b4ecb6d30de8662c29691143f50d05832e95dff27350b70029e98c6c137f3bd94b1d12f7feb42eda0da0f63dc5fdc3ef021a820bcb26f
-  data.tar.gz: 01aa2bc0d0ab6d0791146d3d08f236f246ac03a1b9ea04cca04472aea25adb769edc8c7f8c185df74d57bb355c176458e69ddc0b5af631e3bd01975be10694f1
+  metadata.gz: 1e60b51c8108814fc41f89b41a28732e59a8f5bddb938ee94d8cb765ccc5f2ea3de260aed0a52a212649389814884c40734c7f60fe77502e78e3814821c31790
+  data.tar.gz: 5f165249b8d91cd8bc148f9cc5f3a3a9a57402355c371b30f7f8511fcb6bf8d0650a7ba7a08c072dcba550837e52aced3a1d9cec4959be98c18d5b526678fb29

data/.ruby-version

@@ -1 +1 @@
-2.6.8
+2.7.6

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+**1.2.1**
+- Update shell commands so that STDERR stream won't be merged for commands using the command result.
+- kit sh would also set current default configuration
+- kit get supports "api" ui
+- show sync description (git/local) for artifact sync
+
+**1.2.0**
+- Change minimal ruby version to 3
+
 **1.1.1**
 - Change minimal ruby version to 2.7
 

data/README.md

@@ -19,7 +19,7 @@ Please install specific kuber_kit version, depending on Ruby version.
 | Ruby Version | KuberKit Version |
 | ------------ | ------------ |
 | 2.6 | 1.0.1 |
-| 2.7 | 1.1.1 |
+| 2.7 | 1.1.4 |
 
 ## Usage
 

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -84,6 +84,10 @@ class KuberKit::Actions::ConfigurationLoader
       configuration_name   = first_configurations.configuration_name
     end
 
+    if configuration_store.count > 1 && configuration_name
+      ui.print_info("Configuration", "Using configuration: #{configuration_name.to_s.cyan}")
+    end
+
     if configuration_store.count > 1 && configuration_name.nil?
       options = all_configurations.map(&:configuration_name).map(&:to_s)
       configuration_name = ui.prompt("Please select configuration name (or set it using -C option)", options)
@@ -109,9 +113,9 @@ class KuberKit::Actions::ConfigurationLoader
 
     artifact_task_group = ui.create_task_group
     not_local_artifacts.each do |artifact|
-      artifact_task_group.add("Updating #{artifact.name.to_s.yellow}") do |task|
+      artifact_task_group.add("Updating #{artifact.name.to_s.yellow} [#{artifact.sync_description.cyan}]") do |task|
         artifact_updater.update(local_shell, artifact)
-        task.update_title("Updated #{artifact.name.to_s.green}")
+        task.update_title("Updating #{artifact.name.to_s.green} [#{artifact.sync_description.cyan}]")
       end
     end
     artifact_task_group.wait

data/lib/kuber_kit/actions/kubectl_get.rb

@@ -6,7 +6,7 @@ class KuberKit::Actions::KubectlGet
     "ui"
   ]
 
-  Contract Maybe[String], Hash => Any
+  Contract Maybe[String], Hash => Array
   def call(resource_name, options)
     kubeconfig_path = KuberKit.current_configuration.kubeconfig_path
     deployer_namespace = KuberKit.current_configuration.deployer_namespace
@@ -23,10 +23,10 @@ class KuberKit::Actions::KubectlGet
 
     ui.print_info("Pods", resources.join("\n"))
 
-    true
+    resources
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
     
-    false
+    []
   end
 end

data/lib/kuber_kit/actions/service_deployer.rb

@@ -18,9 +18,10 @@ class KuberKit::Actions::ServiceDeployer
     skip_services:        Maybe[ArrayOf[String]],
     skip_compile:         Maybe[Bool],
     skip_dependencies:    Maybe[Bool],
+    skip_deployment:      Maybe[Bool],
     require_confirmation: Maybe[Bool],
   ] => Any
-  def call(services:, tags:, skip_services: nil, skip_compile: false, skip_dependencies: false, require_confirmation: false)
+  def call(services:, tags:, skip_services: nil, skip_compile: false, skip_dependencies: false, skip_deployment: false, require_confirmation: false)
     deployment_result     = KuberKit::Actions::ActionResult.new()
     current_configuration = KuberKit.current_configuration
 
@@ -66,6 +67,11 @@ class KuberKit::Actions::ServiceDeployer
       return false unless compilation_result && compilation_result.succeeded?
     end
 
+    # Skip service deployment, only compile images.
+    if skip_deployment
+      return deployment_result
+    end
+
     # First deploy initial services. 
     # This feature is used to deploy some services, required for deployment of other services, e.g. env files
     # Note: Initial services are deployed without dependencies

data/lib/kuber_kit/cli.rb

@@ -42,6 +42,7 @@ class KuberKit::CLI < Thor
   method_option :skip_dependencies,     :type => :boolean,  aliases: ["-D"]
   method_option :require_confirmation,  :type => :boolean,  aliases: ["-r"]
   method_option :skip_confirmation,     :type => :boolean,  aliases: ["-R"]
+  method_option :skip_deployment,       :type => :boolean,  aliases: ["-K"]
   def deploy
     setup(options)
 
@@ -57,6 +58,7 @@ class KuberKit::CLI < Thor
         skip_services:        (options[:skip_services] || []).flatten.uniq, 
         skip_compile:         options[:skip_compile] || false,
         skip_dependencies:    options[:skip_dependencies] || false,
+        skip_deployment:      options[:skip_deployment] || false,
         require_confirmation: require_confirmation
       )
     end
@@ -177,7 +179,11 @@ class KuberKit::CLI < Thor
     setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options.merge(load_inventory: false))
-      KuberKit::Container['actions.kubectl_get'].call(pod_name, options)
+      pods = KuberKit::Container['actions.kubectl_get'].call(pod_name, options)
+
+      print_result("Fetched list of pods", result: {
+        pods: pods
+      })
     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, :remote_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, :deploy_simultaneous_limit,
-    :additional_images_paths, :deprecation_warnings_disabled, :log_file_path, :env_file_compile_dir, :shell_launcher_strategy
+    :additional_images_paths, :deprecation_warnings_disabled, :log_file_path, :env_file_compile_dir, :shell_launcher_strategy, :shell_launcher_sets_configration
   ]
   DOCKER_IGNORE_LIST = [
     'Dockerfile',
@@ -59,6 +59,7 @@ class KuberKit::Configs
     set :deprecation_warnings_disabled, false
     set :log_file_path,           File.join(absolute_kuber_kit_path, "deploy.log")
     set :env_file_compile_dir,    File.join(absolute_kuber_kit_path, "env_files")
+    set :shell_launcher_sets_configration, true
   end
 
   def items

data/lib/kuber_kit/core/artifacts/abstract_artifact.rb

@@ -10,4 +10,8 @@ class KuberKit::Core::Artifacts::AbstractArtifact
   def namespace
     raise KuberKit::NotImplementedError, "must be implemented"
   end
+
+  def sync_description
+    raise KuberKit::NotImplementedError, "must be implemented"
+  end
 end

data/lib/kuber_kit/core/artifacts/git.rb

@@ -19,4 +19,8 @@ class KuberKit::Core::Artifacts::Git < KuberKit::Core::Artifacts::AbstractArtifa
     configs = KuberKit::Container['configs']
     "#{configs.artifact_clone_dir}/#{name}"
   end
+
+  def sync_description
+    "#{remote_url}:#{branch}"
+  end
 end

data/lib/kuber_kit/core/artifacts/local.rb

@@ -11,4 +11,8 @@ class KuberKit::Core::Artifacts::Local < KuberKit::Core::Artifacts::AbstractArti
   def cloned_path
     root_path
   end
+
+  def sync_description
+    "local"
+  end
 end

data/lib/kuber_kit/core/context_helper/context_vars.rb

@@ -3,13 +3,18 @@ class KuberKit::Core::ContextHelper::ContextVars
 
   BuildArgUndefined = Class.new(KuberKit::Error)
 
-  def initialize(context_vars, parent_name = nil, parent = nil)
+  def initialize(context_vars, parent_name = nil)
     @context_vars = context_vars
     @parent_name  = parent_name
-    @parent = parent
   end
 
-  def read(*variable_names)
+  def read(*variable_names, default: nil)
+    dig(*variable_names)
+  rescue BuildArgUndefined
+    return default
+  end
+
+  def dig(*variable_names)
     result = self
     variable_names.each do |var|
       result = result.get_variable_value(var)
@@ -18,7 +23,7 @@ class KuberKit::Core::ContextHelper::ContextVars
   end
 
   def variable_defined?(*variable_names)
-    read(*variable_names) 
+    dig(*variable_names)
     return true
   rescue BuildArgUndefined
     return false
@@ -29,7 +34,7 @@ class KuberKit::Core::ContextHelper::ContextVars
       raise ArgumentError.new("context args does not accept any arguments")
     end
 
-    read(name)
+    dig(name)
   end
 
   def to_h
@@ -46,23 +51,16 @@ class KuberKit::Core::ContextHelper::ContextVars
     end
 
     if value.is_a?(Hash)
-      return self.class.new(value, variable_name, self)
+      return self.class.new(value, format_arg(variable_name))
     end
 
     value
   end
 
   private
+    
 
     def format_arg(name)
-      string = [@parent_name, name].compact.join(".")
-      parent = @parent
-
-      while parent do
-        string = [parent.parent_name, string].compact.join(".")
-        parent = parent.parent
-      end
-
-      string
+      [@parent_name, name].compact.join(".")
     end
 end

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

@@ -1,27 +1,27 @@
 require 'time'
 class KuberKit::Shell::Commands::BashCommands
   def rm(shell, path)
-    shell.exec!(%Q{rm "#{path}"})
+    shell.exec!(%Q{rm "#{path}"}, merge_stderr: true)
   end
 
   def rm_rf(shell, path)
-    shell.exec!(%Q{rm -rf "#{path}"})
+    shell.exec!(%Q{rm -rf "#{path}"}, merge_stderr: true)
   end
 
   def cp(shell, source_path, dest_path)
-    shell.exec!(%Q{cp "#{source_path}" "#{dest_path}"})
+    shell.exec!(%Q{cp "#{source_path}" "#{dest_path}"}, merge_stderr: true)
   end
 
   def cp_r(shell, source_path, dest_path)
-    shell.exec!(%Q{cp -r "#{source_path}" "#{dest_path}"})
+    shell.exec!(%Q{cp -r "#{source_path}" "#{dest_path}"}, merge_stderr: true)
   end
 
   def mkdir(shell, path)
-    shell.exec!(%Q{mkdir "#{path}"})
+    shell.exec!(%Q{mkdir "#{path}"}, merge_stderr: true)
   end
 
   def mkdir_p(shell, path)
-    shell.exec!(%Q{mkdir -p "#{path}"})
+    shell.exec!(%Q{mkdir -p "#{path}"}, merge_stderr: true)
   end
 
   def ctime(shell, path)

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

@@ -3,15 +3,15 @@ class KuberKit::Shell::Commands::DockerCommands
     default_args = ["--rm=true"]
     args_list = (default_args + args).join(" ")
 
-    shell.exec!(%Q{docker image build #{build_dir} #{args_list}})
+    shell.exec!(%Q{docker image build #{build_dir} #{args_list}}, merge_stderr: true)
   end
 
   def tag(shell, image_name, tag_name)
-    shell.exec!(%Q{docker tag #{image_name} #{tag_name}})
+    shell.exec!(%Q{docker tag #{image_name} #{tag_name}}, merge_stderr: true)
   end
 
   def push(shell, tag_name)
-    shell.exec!(%Q{docker push #{tag_name}})
+    shell.exec!(%Q{docker push #{tag_name}}, merge_stderr: true)
   end
 
   def run(shell, image_name, args: nil, command: nil, detached: false, interactive: false)
@@ -25,7 +25,7 @@ class KuberKit::Shell::Commands::DockerCommands
     if interactive
       shell.interactive!(command_parts.join(" "))
     else
-      shell.exec!(command_parts.join(" "))
+      shell.exec!(command_parts.join(" "), merge_stderr: true)
     end
   end
 

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

@@ -15,7 +15,7 @@ class KuberKit::Shell::Commands::DockerComposeCommands
     if interactive
       shell.interactive!(command_parts.join(" "))
     else
-      shell.exec!(command_parts.join(" "))
+      shell.exec!(command_parts.join(" "), merge_stderr: true)
     end
   end
 end

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

@@ -1,36 +1,36 @@
 class KuberKit::Shell::Commands::GitCommands
   def get_remote_url(shell, git_repo_path, remote_name: "origin")
-    shell.exec! [
+    shell.exec!([
       "cd #{git_repo_path}",
       "git config --get remote.#{remote_name}.url",
-    ].join(" && ")
+    ].join(" && "), merge_stderr: true)
   rescue KuberKit::Shell::AbstractShell::ShellError
     return nil
   end
 
   def get_version_hash(shell, git_repo_path)
-    shell.exec! [
+    shell.exec!([
       "cd #{git_repo_path}",
       "git rev-parse --short HEAD",
-    ].join(" && ")
+    ].join(" && "), merge_stderr: true)
   end
 
   def download_repo(shell, remote_url:, path:, branch:)
-    shell.exec! [
+    shell.exec!([
       "rm -rf #{path}",
       "mkdir -p #{path}",
       "git clone -b #{branch} --depth 1 #{remote_url} #{path}",
-    ].join(" && ")
+    ].join(" && "), merge_stderr: true)
   end
 
   def force_pull_repo(shell, path:, branch:)
-    shell.exec! [
+    shell.exec!([
       "cd #{path}",
       "git add .",
       "git reset HEAD --hard",
       "git checkout #{branch}",
       "git reset --hard '@{u}'",
       "git pull --force",
-    ].join(" && ")
+    ].join(" && "), merge_stderr: true)
   end
 end

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

@@ -10,8 +10,8 @@ class KuberKit::Shell::Commands::KubectlCommands
     kubeconfig_path: Maybe[Or[
       String, KuberKit::Core::ArtifactPath
     ]],
-    namespace:       Maybe[Or[Symbol, String]],
-    interactive:     Optional[Bool],
+    namespace:              Maybe[Or[Symbol, String]],
+    interactive:            Optional[Bool],
   ] => Any
   def kubectl_run(shell, command_list, kubeconfig_path: nil, namespace: nil, interactive: false)
     command_parts = []

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

@@ -22,7 +22,7 @@ class KuberKit::Shell::Commands::RsyncCommands
       args << "--delete"
     end
 
-    shell.exec!(%Q{rsync -a #{args.join(' ')}})
+    shell.exec!(%Q{rsync -a #{args.join(' ')}}, merge_stderr: true)
   end
 
   private

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

@@ -2,7 +2,7 @@ class KuberKit::Shell::Commands::SystemCommands
   def kill_process(shell, pid)
     # we need to use kill command directly sometimes, 
     # because Process.kill doesn't kill processes created by system() call
-    shell.exec!("kill -9 #{pid}")
+    shell.exec!("kill -9 #{pid}", merge_stderr: true)
     true
   rescue
     false

data/lib/kuber_kit/shell/local_shell.rb

@@ -9,7 +9,9 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
     "ui",
   ]
 
-  def exec!(command, log_command: true)
+  # @merge_stderr: Merge STDERR to the resulting stream. Could be helpful, if we don't want it printed to STDERR. 
+  #                Should be false, if we want to read & use the result of the command.
+  def exec!(command, log_command: true, merge_stderr: false)
     command_number = command_counter.get_number.to_s.rjust(2, "0")
     
     if log_command
@@ -17,7 +19,9 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
     end
 
     result = nil
-    IO.popen(wrap_command_with_pid(command), err: [:child, :out]) do |io|
+    
+    options = merge_stderr ? {err: [:child, :out]} : {}
+    IO.popen(wrap_command_with_pid(command), **options) do |io|
       result = io.read.chomp.strip
     end
 
@@ -88,21 +92,21 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
   end
 
   def delete(file_path)
-    exec!("rm #{file_path}")
+    exec!("rm #{file_path}", merge_stderr: true)
   end
 
   def file_exists?(file_path)
-    exec!("test -f #{file_path} && echo 'true' || echo 'false'", log_command: false) == 'true'
+    exec!("test -f #{file_path} && echo 'true' || echo 'false'", log_command: false, merge_stderr: true) == 'true'
   end
 
   def dir_exists?(dir_path)
-    exec!("test -d #{dir_path} && echo 'true' || echo 'false'", log_command: false) == 'true'
+    exec!("test -d #{dir_path} && echo 'true' || echo 'false'", log_command: false, merge_stderr: true) == 'true'
   end
 
   def recursive_list_files(path, name: nil)
     command = %Q{find -L #{path}  -type f}
     command += " -name '#{name}'" if name
-    exec!(command).split(/[\r\n]+/)
+    exec!(command, merge_stderr: true).split(/[\r\n]+/)
   rescue => e
     if e.message.include?("No such file or directory")
       raise DirNotFoundError.new("Dir not found: #{path}")
@@ -113,7 +117,7 @@ class KuberKit::Shell::LocalShell < KuberKit::Shell::AbstractShell
 
   def list_dirs(path)
     command = %Q{find -L #{path} -maxdepth 0 -type d}
-    exec!(command).split(/[\r\n]+/)
+    exec!(command, merge_stderr: true).split(/[\r\n]+/)
   rescue => e
     if e.message.include?("No such file or directory")
       raise DirNotFoundError.new("Dir not found: #{path}")

data/lib/kuber_kit/shell/ssh_session.rb

@@ -22,7 +22,7 @@ class KuberKit::Shell::SshSession
     @session = nil
   end
 
-  def exec!(command)
+  def exec!(command, merge_stderr: false)
     stdout_data = ''
     stderr_data = ''
     exit_code = nil
@@ -38,6 +38,10 @@ class KuberKit::Shell::SshSession
 
         channel.on_extended_data do |ch,type,data|
           stderr_data += data
+          
+          if merge_stderr
+            stdout_data += data
+          end
         end
 
         channel.on_request('exit-status') do |ch,data|

data/lib/kuber_kit/shell/ssh_shell.rb

@@ -20,14 +20,14 @@ class KuberKit::Shell::SshShell < KuberKit::Shell::LocalShell
     @ssh_session.disconnect if @ssh_session
   end
 
-  def exec!(command, log_command: true)
+  def exec!(command, log_command: true, merge_stderr: false)
     command_number = command_counter.get_number.to_s.rjust(2, "0")
     
     if log_command
       ui.print_debug("SshShell", "#{ssh_session.host.green} > Execute: [#{command_number}]: #{command.to_s.cyan}")
     end
 
-    result = ssh_session.exec!(wrap_command_with_pid(command))
+    result = ssh_session.exec!(wrap_command_with_pid(command), merge_stderr: merge_stderr)
 
     if result && result != "" && log_command
       ui.print_debug("SshShell", "#{ssh_session.host.green} > Finished [#{command_number}] with result: \n#{result.grey}")

data/lib/kuber_kit/shell_launcher/strategies/kubernetes.rb

@@ -17,6 +17,15 @@ class KuberKit::ShellLauncher::Strategies::Kubernetes < KuberKit::ShellLauncher:
       kubectl_commands.set_namespace(shell, deployer_namespace, kubeconfig_path: kubeconfig_path)
     end
 
+    env_vars = [
+      "KUBECONFIG=#{kubeconfig_path}", 
+      "KUBER_KIT_SHELL_CONFIGURATION=#{KuberKit.current_configuration.name}"
+    ]
+
+    if configs.shell_launcher_sets_configration
+      env_vars << "KUBER_KIT_CONFIGURATION=#{KuberKit.current_configuration.name}"
+    end
+
     shell.replace!(env: ["KUBECONFIG=#{kubeconfig_path}", "KUBER_KIT_SHELL_CONFIGURATION=#{KuberKit.current_configuration.name}"])
   end
 end

data/lib/kuber_kit/version.rb

@@ -1,3 +1,3 @@
 module KuberKit
-  VERSION = "1.1.1"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.4
 platform: ruby
 authors:
 - Iskander Khaziev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -382,7 +382,7 @@ homepage: https://github.com/ArtStation/kuber_kit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -397,8 +397,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Docker Containers Build & Deployment
 test_files: []