cl-magic 0.3.0

data/lib/cl/magic/common/kubectl.rb

@@ -0,0 +1,236 @@
+require 'json'
+require 'tty-command'
+require 'tty-prompt'
+require 'cl/magic/common/logging.rb'
+require 'cl/magic/common/parse_and_pick.rb'
+
+#
+# Kubectl config commands
+#
+
+def get_users_kube_config_cmd_path
+  tty_command = TTY::Command.new(printer: :null)
+  command = "grep cmd-path ~/.kube/config | head -n1 | cut -d ':' -f2"
+  out, err = tty_command.run(command)
+  return out.chomp.strip
+end
+
+#
+# Kubectl DESCRIBE commands
+#
+
+def describe_pod(namespace, pod)
+  namespace_option = " --namespace=#{namespace}" if namespace
+  command = "kubectl get pod -ojson #{pod.first} #{namespace_option}"
+  @logger.wait command
+  result = TTY::Command.new(:printer => :null).run(command)
+  return JSON.parse(result.out)
+end
+
+def describe_deployment(namespace, deployment)
+  namespace_option = " --namespace=#{namespace}" if namespace
+  command = "kubectl get deployment.apps -ojson #{deployment.first} #{namespace_option}"
+  @logger.wait command
+  result = TTY::Command.new(:printer => :null).run(command)
+  return JSON.parse(result.out)
+end
+
+def describe_service(namespace, service)
+  namespace_option = " --namespace=#{namespace}" if namespace
+  command = "kubectl get service -ojson #{service.first} #{namespace_option}"
+  @logger.wait command
+  result = TTY::Command.new(:printer => :null).run(command)
+  return JSON.parse(result.out)
+end
+
+#
+# Kubectl GET commands
+#
+
+def get_kubectl_deployments(namespace)
+  namespace_option = namespace ? " --namespace=#{namespace}" : " --all-namespaces"
+  command = "kubectl get -o=wide deployment.apps #{namespace_option}"
+  error_message = "No deployments found"
+  return parse_table_results(command, error_message)
+end
+
+def get_kubectl_pods(namespace, selector)
+  selector_option = " --selector=#{selector}" if selector
+  namespace_option = " --namespace=#{namespace}" if namespace
+  command = "kubectl get pods #{selector_option} #{namespace_option}"
+  error_message = "No pods found"
+  return parse_table_results(command, error_message)
+end
+
+def get_kubectl_services(namespace)
+  namespace_option = " --namespace=#{namespace}" if namespace
+  command = "kubectl get -o=wide services #{namespace_option}"
+  error_message = "Your kubectl has no services; talk to your team about this. :)"
+  return parse_table_results(command, error_message)
+end
+
+def get_kubectl_namespaces()
+  command = "kubectl get namespaces"
+  error_message = "No namespaces found in kubectl context: #{get_current_kubectl_context()}"
+  return parse_table_results(command, error_message)
+end
+
+def get_kubectl_contexts()
+  command = "kubectl config get-contexts"
+  error_message = "Your kubectl has no contexts; talk to your team about this. :)"
+  return parse_table_results(command, error_message)
+end
+
+def get_current_kubectl_context()
+  command = "kubectl config current-context"
+  return TTY::Command.new(:printer => :null).run(command).out.strip.chomp
+end
+
+def get_current_kubectl_namespace()
+  command = "kubectl config view --minify --output 'jsonpath={..namespace}'; echo"
+  return TTY::Command.new(:printer => :null).run(command).out.strip.chomp
+end
+
+def get_containers_on_pod(namespace, pod_name)
+  command = "kubectl get pods #{pod_name} -o jsonpath='{.spec.containers[*].name}' --namespace #{namespace}"
+  return TTY::Command.new(:printer => :null).run(command).out.strip.chomp.split(' ').collect {|v|[v]}
+end
+
+#
+# Kubectl pickers
+#
+
+def pick_kubectl_context(selected_context=nil)
+
+  prev_context = get_current_kubectl_context()
+
+  # pick content
+  if selected_context.nil?
+    selected_context = TTY::Prompt.new(interrupt: :exit).select("Which context?", filter: true, per_page: 20) do |menu|
+      get_kubectl_contexts().each do |context|
+        if context[0]=="*"
+          menu.default context[1]
+          menu.choice context[1], context[1]
+        else
+          menu.choice context[0], context[0]
+        end
+      end
+    end
+  end
+
+  # change context
+  if selected_context != prev_context
+    command = "kubectl config use-context #{selected_context}"
+    @logger.wait command
+    TTY::Command.new(:printer => :null).run(command)
+  end
+
+  return selected_context
+end
+
+def pick_kubectl_deployment(options)
+  deploments = get_kubectl_deployments(options[:namespace]).collect {|o| o.values_at(0,-1)}
+  deployment = pick_single_result(deploments, "Which deployment?", options[:deployment_name])
+  if deployment.nil? or deployment.last == '<none>'
+    @logger.error "No deployments found"
+    exit(1)
+  end
+  return deployment
+end
+
+def pick_kubectl_namespace(options)
+  namespaces = get_kubectl_namespaces().collect {|o| o.values_at(0)}
+  current_namespace = get_current_kubectl_namespace()
+  return pick_single_result(namespaces, "Which namespace?", options[:namespace], current_namespace)
+end
+
+def pick_kubectl_service(options)
+  services = get_kubectl_services(options[:namespace]).collect {|o| o.values_at(0,-1)}
+  service = pick_single_result(services, "Pick service", options[:service_name])
+  if service.nil? or service.last == '<none>'
+    @logger.error "No services found"
+    exit(1)
+  end
+  return service
+end
+
+def pick_kubectl_pods(deployment, options)
+  selector = deployment.last # last field is a selector
+  pods = get_kubectl_pods(options[:namespace], selector)
+  selected_pods = pick_multiple_result(pods, "Which pods?", options[:pod_names])
+
+  if selected_pods.count == 0
+    @logger.warn "deployment #{deployment.last} has no pods."
+    exit()
+  end
+  return selected_pods
+end
+
+def pick_kubectl_pod(service, options)
+  selector = service.last # last field is a selector
+  pods = get_kubectl_pods(options[:namespace], selector)
+  selected_pod = pick_single_result(pods, "Which pods?", options[:pod_name])
+
+  if selected_pod.nil?
+    @logger.error "service #{service.first} has no pod."
+    exit(1)
+  end
+  return selected_pod
+end
+
+def pick_kubectl_container(pod, options)
+  containers = get_containers_on_pod(options[:namespace], pod.first)
+  container = pick_single_result(containers, "Pick container", options[:container_name])
+  options[:container_name] = container.first
+end
+
+def set_context_namespace_deployment_pod_container_options(options)
+  # set: context and namespace
+  set_context_and_namespace(options)
+
+  # pick: deployment and pod
+  deployment = pick_kubectl_deployment(options)
+  pod = pick_kubectl_pod(deployment, options)
+
+  # set options
+  options[:deployment_name] = deployment.first
+  options[:pod_name] = pod.first
+
+  # set container
+  pick_kubectl_container(pod, options)
+end
+
+def set_context_and_namespace(options)
+  get_ktx(options) if options[:ktx]
+
+  # set: context and namespace
+  if options[:kube_context].nil? and options[:namespace].nil?
+    options[:kube_context] = pick_kubectl_context(options[:kube_context]) if options[:kube_context].nil?
+    options[:namespace] = pick_kubectl_namespace(options).first if options[:namespace].nil? # just the name
+  end
+end
+
+#
+# cl ktx
+#
+KTX_FILEPATH = '.cl-ktx.json'
+
+def set_ktx(options)
+  File.open(KTX_FILEPATH, "w") do |f|
+    f.write({
+      kube_context: options[:kube_context],
+      namespace: options[:namespace],
+    }.to_json)
+  end
+end
+
+def get_ktx(options)
+  if options[:ktx]
+    if(File.exist?(KTX_FILEPATH))
+      file = File.read(KTX_FILEPATH)
+      ktx_hash = JSON.parse(file)
+      options[:kube_context] = ktx_hash['kube_context']
+      options[:namespace] = ktx_hash['namespace']
+    end
+  end
+end

data/lib/cl/magic/common/logging.rb

@@ -0,0 +1,25 @@
+require 'tty-logger'
+
+def get_logger
+  return TTY::Logger.new do |config|
+    config.types = {
+      puts: {level: :info},
+    }
+    config.handlers = [
+      [:console, {
+        styles: {
+          puts: {
+            symbol: "",
+            label: "",
+            color: :black,
+            levelpad: 0
+          },
+        }
+      }]
+    ]
+  end
+end
+
+def write_history(message)
+  File.open("#{Dir.home}/.cl_history", "a") {|f| f.puts message }
+end

data/lib/cl/magic/common/parse_and_pick.rb

@@ -0,0 +1,81 @@
+
+#
+# Parse table results
+#
+# Many commands return
+# * a table of results
+# * the first row being headers
+# * each following row space separated values
+#
+# Lets assume this and parse the results
+#
+
+def parse_table_results(command, error_message, num_headers=1, split=nil, working_dir=nil)
+  results = []
+
+  @logger.puts ""
+  @logger.wait command
+
+  # working directory?
+  command = "cd #{working_dir} && #{command}" if working_dir
+
+  # run command
+  TTY::Command.new(:printer => :null).run(command).each { |line| results << line.split(split) }
+  num_headers.times { results.delete_at(0) } # remove header
+   
+  if not results.any?
+    @logger.error error_message
+    exit(1)
+  end
+  return results
+end
+
+
+#
+# Prompt the user to pick a single result
+# 
+# results - and array of arrays
+# prompt_message - the message for our picker
+# exact - if provided, we'll return whatever matches this exactly
+# default - if provided, the picker will default to this item
+#
+
+def pick_single_result(results, prompt_message, exact=nil, default=nil, selection_index=0)
+  
+  # exact match?
+  results = results.select {|r| r[selection_index] == exact} if exact
+
+  case results.count
+  when 0  # no results?
+    return nil
+  when 1  # one result, just return it
+    return results.first
+  end
+
+  # prompt many results
+  selection = TTY::Prompt.new(interrupt: :exit).select(prompt_message, filter: true, per_page: 20) do |menu|
+    results.each do |result|
+      menu.default result.join(' | ') if result[selection_index] == default
+      menu.choice result.join(' | '), result[selection_index]
+    end
+  end
+  return results.select { |r| r[selection_index]==selection }.first
+end
+
+
+def pick_multiple_result(results, prompt_message, exacts=nil)
+
+  # exact match?
+  return results.select {|r| exacts.split(',').include? r.first} if exacts
+
+  # 0 or 1 result?
+  return results if results.count < 2
+
+  selections = TTY::Prompt.new(interrupt: :exit).multi_select(prompt_message, filter: true, per_page: 20) do |menu|
+    results.each do |result|
+      menu.choice result.join(' | '), result.first
+    end
+  end
+
+  return results.select {|r| selections.include? r.first}
+end

data/lib/cl/magic/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cl
+  module Magic
+    VERSION = "0.3.0"
+  end
+end

data/lib/cl/magic.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "magic/version"
+
+module Cl
+  module Magic
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: cl-magic
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Don Najd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse-subcommand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- dnajd7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/cl
+- bin/console
+- bin/setup
+- cl-magic.gemspec
+- lib/cl/magic.rb
+- lib/cl/magic/cl
+- lib/cl/magic/cl-auth
+- lib/cl/magic/cl-aws-okta-auth
+- lib/cl/magic/cl-aws-okta-env
+- lib/cl/magic/cl-dk
+- lib/cl/magic/cl-envkey
+- lib/cl/magic/cl-gc-sql
+- lib/cl/magic/cl-gc-tags
+- lib/cl/magic/cl-glab-commit
+- lib/cl/magic/cl-history
+- lib/cl/magic/cl-kube-cp
+- lib/cl/magic/cl-kube-deployment
+- lib/cl/magic/cl-kube-ktx
+- lib/cl/magic/cl-kube-logs
+- lib/cl/magic/cl-kube-restart
+- lib/cl/magic/cl-kube-search
+- lib/cl/magic/cl-kube-search-all
+- lib/cl/magic/cl-kube-ssh
+- lib/cl/magic/cl-poll
+- lib/cl/magic/cl-sandbox
+- lib/cl/magic/cl-vault
+- lib/cl/magic/common/common_options.rb
+- lib/cl/magic/common/gcloud.rb
+- lib/cl/magic/common/kubectl.rb
+- lib/cl/magic/common/logging.rb
+- lib/cl/magic/common/parse_and_pick.rb
+- lib/cl/magic/version.rb
+homepage: https://gitlab.com/beesbot/cl-magic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://gitlab.com/beesbot/cl-magic
+  source_code_uri: https://gitlab.com/beesbot/cl-magic
+  changelog_uri: https://gitlab.com/beesbot/cl-magic
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Magic tools for a turnkey developer experience
+test_files: []