kuber_kit 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41f8c55add7e426b80fa74ec7f39b2af312e9d8bc94ffc412d6046d228af1bcf
-  data.tar.gz: 55f2921894f99cd9aa68a868c87c0059e59e2405355154015571cc5d8676575c
+  metadata.gz: f0a62cde1e86bf987531722246cf273df2b4aeea6cad29e5de11ea768d725ecc
+  data.tar.gz: 8d6563f57469cf82bddf0cc4fc8c916317c353145e6a321eca8dc6f5d10a6af2
 SHA512:
-  metadata.gz: 13312d069ddfbddbd5972b2fbdc3e87970e366dfb2bb12caa94ac76979ecf511c92887c17567c521846648cf10a6e2c725d20baa0d2739ee5288d2497fbd6817
-  data.tar.gz: f9d35c210a01f77f3083a6ac2a92c9452ce3d26703d941fac175b78d4838fc0dca6d63eb5fe1de0b3bae1135a8ed1276601044193ce814677191747712f1fead
+  metadata.gz: 828accbdd1ce45d263a3a835d4ff5b7431e535f4ea214f4b2ae31765d2092e0825d8b317c887919a0974b6a2cdd0636fc36086e3cf578088029d191ac3598811
+  data.tar.gz: 9b33cacce0e6afa653270bb944999fdc43e41ef296a7ed03371024304367604741f8142fe9440a115056118c4094bbf4e45d69db1f99367f76b40f071d2bbc78

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+**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
 

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -109,9 +109,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/cli.rb

@@ -177,7 +177,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/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
 
@@ -44,7 +44,7 @@ class KuberKit::Shell::Commands::DockerCommands
     if status
       command_parts << "--filter=\"status=#{status}\""
     end
-    command_parts << "--filter=\"name=#{container_name}\""
+    command_parts << "--filter=\"name=^/#{container_name}$\""
 
     shell.exec!(command_parts.join(" "))
   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.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuber_kit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Iskander Khaziev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2023-01-09 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
@@ -398,7 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Docker Containers Build & Deployment
 test_files: []