podjumper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea343627011964fdee87c79c4df313160cd859f0
-  data.tar.gz: bcae43efa8419d6aaa3931bc3d563b3778f7b35a
+  metadata.gz: 20feea954a12a81227f2ef8bff7f62697a159525
+  data.tar.gz: 8cc529ef8186915511690c17c0b205ef95131bf3
 SHA512:
-  metadata.gz: 0b8a1209c432c93c1903b10260768f9dd45bbbf80b5b7d189ba0cd865aaa80eb419cddbc332c1f231c3a6a83073181461995db921366a6e451755de770694c7a
-  data.tar.gz: 343905c5063e31abcb19034534da29c339f1aefa3341a93d78744aeb2256257c85b264a877ac9affc79fc1dd3cb4e62ae3bc62f2c023504c0c242e9774cd3e7e
+  metadata.gz: 4934b0b9d82315c32bfd67594f6c84caf1eda555c21f097dff57d1432576aac241fa8795d7df6b6868cf4e7c6b779bbeda6724dfc939b1bba2fc8e76a359e13d
+  data.tar.gz: ae7355ddff207b2c07a2192ea29ac3c0d72d90aadfc2be9682906f6ba8dca9031644bbc70f8fdf6606e4f894e21bfeeed3c262efe113a7f9b581c0d38fee4778

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/README.md

@@ -1,8 +1,12 @@
 # Podjumper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/podjumper`. To experiment with that code, run `bin/console` for an interactive prompt.
+Podjumper is a tiny command line tool for handling qa servers on a kubernetes cluster.
+It makes a lof of assumptions of your kubernetes setup. For example, for shorthand commands which
+are documented below it assumes that all pods have a label 'subdomain' and that there is only
+one pod for each unique subdomain label.
 
-TODO: Delete this and the text above, and describe your gem
+This is how podjumper is currently intended to work. More tooling is in development.
+Some basic examples are below.
 
 ## Installation
 
@@ -22,7 +26,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Tailing logs of a QA server
+```ruby
+$ podj logs qa4
+```
+
+List all rake commands remotely
+```ruby
+$ podj exec qa4 'bundle exec rake tasks -T'
+```
 
 ## Development
 
@@ -32,7 +44,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/podjumper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/johndavidmartinez/podjumper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/bin/podj

@@ -1,13 +1,27 @@
 #!/usr/bin/env ruby
 
 require 'gli'
+require 'tty-command'
 require 'podjumper'
 
 include Podjumper
 include GLI::App
 
+using Refinements
+
 version Podjumper::VERSION
 
+desc 'Navigate to a container by picking through namespaces and subdomains.'
+command %i[navigate nav] do |cmd|
+  cmd.action do |global_options, options, args|
+    info = JumpInfo.load(args)
+    puts "Namespace: #{info.namespace}",
+         "Subdomain: #{info.subdomain}",
+         "Pod Name:  #{info.pod_name}",
+         "Container: #{info.container_name}"
+  end
+end
+
 desc 'List things'
 command [:list, :ls] do |l|
   l.desc 'List all avaliable namespaces'
@@ -28,19 +42,29 @@ command [:list, :ls] do |l|
   l.desc 'List all containers in a namespace\'s pod'
   l.command [:containers, :c] do |c|
     c.action do |global_options, options, args|
-      namespace = args[0]
-      subdomain = args[1]
+      info = JumpInfo.load_upto_pod(args)
       filter = /#{args[2]}/
-      puts containers(namespace, subdomain).select { |name| name =~ filter }
+      puts info.pod.container_names.select_regex(filter)
     end
   end
 end
 
-desc 'Jump straight into a rails pod'
-command [:jump] do |j|
-  j.action do |global_options, options, args|
+desc 'Shorthand command runs given command on nearest pod with subdomain label'
+command [:exec] do |j|
+  j.action do |_, _, args|
+    subdomain = args[0]
+    command = args[1...args.length].join(' ')
+    info = JumpInfo.load_rails_from_subdomain(subdomain)
+    Command.new(info).exec(command)
+  end
+end
+
+desc 'Shorthand command tails logs on nearest pod with subdomain label'
+command [:logs] do |l|
+  l.action do |_, _, args|
     subdomain = args[0]
-    puts tty_command(subdomain)
+    info = JumpInfo.load_rails_from_subdomain(subdomain)
+    Command.new(info).logs
   end
 end
 

data/lib/podjumper/command.rb

@@ -0,0 +1,39 @@
+module Podjumper
+  class Command
+    def initialize(info)
+      @namespace = info.namespace
+      @pod       = info.pod_name
+      @container = info.container_name
+    end
+
+    def exec(command)
+      tty = TTY::Command.new
+      tty.run(exec_command(command))
+    end
+
+    def logs
+      tty = TTY::Command.new(printer: :null)
+      tty.run(logs_command) do |out, _|
+        puts out if !ping?(out)
+      end
+    end
+
+    private
+
+    def exec_command(command)
+      "kubectl exec -ti #{@pod} -c #{@container} --namespace #{@namespace} -- #{command}"
+    end
+
+    def logs_command
+      "kubectl logs #{@pod} #{@container} --namespace #{@namespace} -f --since=1s"
+    end
+
+    def ping?(log_line)
+      return ping_matchers.any? { |regex| log_line =~ regex }
+    end
+
+    def ping_matchers
+      [/api\/ping/, /Api::SystemController#ping/, /Completed 200 OK/]
+    end
+  end
+end

data/lib/podjumper/jump_info.rb

@@ -0,0 +1,83 @@
+using Refinements
+
+module Podjumper
+  JumpInfo = Struct.new(:namespace, :pod, :container_name) do
+    def subdomain
+      pod&.subdomain
+    end
+
+    def pod_name
+      pod&.name
+    end
+  end
+
+  class << JumpInfo
+    def load(args)
+      args = args.dup
+      namespace = disambiguate_namespace(args.shift)
+      pod = disambiguate_pod(namespace, args.shift)
+      container = disambiguate_container(pod, args.shift)
+
+      new(namespace, pod, container)
+    end
+
+    def load_upto_pod(args)
+      args = args.dup
+      namespace = disambiguate_namespace(args.shift)
+      pod = disambiguate_pod(namespace, args.shift)
+
+      new(namespace, pod, nil)
+    end
+
+    def load_upto_namespace(args)
+      args = args.dup
+      namespace = disambiguate_namespace(args.shift)
+
+      new(namespace, nil, nil)
+    end
+
+    def load_rails_from_subdomain(subdomain)
+      pod = Pod.find_by_subdomain(subdomain)
+      new(pod.namespace, pod, pod.container('rails'))
+    end
+
+    private
+
+    def disambiguate_namespace(query)
+      disambiguate(namespaces, query: query, title: 'Namespaces')
+    end
+
+    def disambiguate_pod(namespace, query)
+      all_pods = Pod.where(namespace: namespace)
+      subdomains = all_pods.map(&:subdomain).uniq
+      subdomain = disambiguate(subdomains, query: query, title: "Subdomains in namespace #{namespace.inspect}")
+      pods = all_pods.select { |pod| pod.subdomain == subdomain }
+
+      disambiguate(pods, title: "Pods in #{namespace} with subdomain #{subdomain.inspect}", &:name)
+    end
+
+    def disambiguate_container(pod, query)
+      disambiguate(pod.container_names, query: query, title: "Containers in pod #{pod.name.inspect}")
+    end
+
+    def disambiguate(choices, query: nil, title: nil, &choice_name)
+      choice_name ||= :itself
+      matches = matching_choices(choices, query, &choice_name)
+      if matches.count == 1
+        matches.first
+      else
+        puts title if title
+        cli.ask_for_choice(matches, &choice_name)
+      end
+    end
+
+    def matching_choices(choices, query)
+      return choices if query.nil?
+      choices.select { |c| yield(c) =~ /#{query}/ }
+    end
+
+    def cli
+      @cli ||= HighLine.new
+    end
+  end
+end

data/lib/podjumper/pod.rb

@@ -0,0 +1,83 @@
+module Podjumper
+  class Pod
+    def initialize(description)
+      @description = description
+      validate_resource!
+      validate_version!
+    end
+
+    def namespace
+      metadata['namespace']
+    end
+
+    def subdomain
+      labels['subdomain']
+    end
+
+    def name
+      metadata['name']
+    end
+
+    def labels
+      metadata['labels'] || {}
+    end
+
+    def container(name)
+      container_names.find { |container_name| container_name =~ /#{name}/ }
+    end
+
+    def container_names
+      containers.map { |container| container['name'] }
+    end
+
+    def to_h
+      JSON.parse(to_json)
+    end
+
+    def to_json
+      description.to_json
+    end
+
+    private
+
+    attr_reader :description
+
+    def kind
+      description['kind']
+    end
+
+    def api_version
+      description['apiVersion']
+    end
+
+    def metadata
+      description['metadata']
+    end
+
+    def containers
+      description['spec']['containers']
+    end
+
+    def validate_resource!
+      raise "Expected a pod, got #{kind.inspect}" if kind != 'Pod'
+    end
+
+    def validate_version!
+      raise "Invalid API version #{api_version.inspect}" if api_version != 'v1'
+    end
+  end
+
+  class << Pod
+    def where(namespace: nil, subdomain: nil)
+      namespace_flag = namespace ? "-n '#{namespace}'" : '--all-namespaces'
+      subdomain_flag = subdomain ? "-l 'subdomain=#{subdomain}'" : ''
+      json = JSON.parse(`kubectl get pods --output=json #{namespace_flag} #{subdomain_flag}`)
+
+      json['items'].map(&Pod.method(:new))
+    end
+
+    def find_by_subdomain(subdomain)
+      new(JSON.parse(`kubectl get pods --output=json --all-namespaces --selector='subdomain=#{subdomain}'`)['items'].first)
+    end
+  end
+end

data/lib/podjumper/refinements.rb

@@ -14,4 +14,39 @@ module Refinements
       end
     end
   end
+
+  refine HighLine do
+    def ask_for_choice(choices)
+      padding_max = choices.count.to_s.length
+      puts choices.each_with_index.map { |choice, index|
+        index += 1
+        choice = yield choice if block_given?
+        padding = ' ' * (padding_max - index.to_s.length)
+        "#{index}. #{padding}#{choice}"
+      }
+
+      index = ask_for_index(choices.count)
+      return if index.nil?
+
+      choices[index]
+    end
+
+    def ask_for_index(count)
+      answer = ask("Choose from 1..#{count}, or (q)uit...") do |q|
+        q.case = :downcase
+        q.validate = /\A\d+|q\Z/
+      end
+      exit 0 if answer == 'q' # TODO: Safe exit
+      index = Integer(answer)
+      if index < 1
+        puts 'The first choice is 1'
+        ask_for_index(count)
+      elsif index > count
+        puts "The last choice is #{count}"
+        ask_for_index(count)
+      else
+        index - 1
+      end
+    end
+  end
 end

data/lib/podjumper/version.rb

@@ -1,3 +1,3 @@
 module Podjumper
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/podjumper.rb

@@ -1,63 +1,11 @@
+require 'highline'
+require 'json'
 require 'podjumper/version'
 require 'podjumper/refinements'
-require 'json'
+require 'podjumper/pod'
+require 'podjumper/jump_info'
+require 'podjumper/command'
 
 module Podjumper
   using Refinements
-
-  def namespaces
-    `kubectl get namespaces --output=name`
-      .split("\n")
-      .map { |str| str.drop_prefix('namespaces/') }
-  end
-
-  def subdomains(namespace = nil)
-    description = describe_pods(namespace: namespace)
-    description.map do |pod|
-      subdomain = get_subdomain(pod)
-      next unless subdomain
-      namespace = get_namespace(pod)
-      [namespace, subdomain].join('  ')
-    end.compact
-  end
-
-  def containers(namespace, subdomain)
-    description = describe_pods(namespace: namespace, subdomain: subdomain)
-    description.flat_map do |pod|
-      subdomain = get_subdomain(pod)
-      next unless subdomain
-      namespace = get_namespace(pod)
-      container_names(pod).map do |container_name|
-        [namespace, subdomain, container_name].join(' ')
-      end
-    end.compact
-  end
-
-  def describe_pods(namespace: nil, subdomain: nil)
-    namespace_flag = namespace ? "--namespace='#{namespace}'" : '--all-namespaces'
-    subdomain_flag = subdomain ? "--selector='subdomain=#{subdomain}'" : ''
-    JSON.parse(`kubectl get pods --output=json #{namespace_flag} #{subdomain_flag}`)['items']
-  end
-
-  def get_subdomain(pod)
-    return unless pod['metadata'].key?('labels')
-    pod['metadata']['labels']['subdomain']
-  end
-
-  def get_namespace(pod)
-    pod['metadata']['namespace']
-  end
-
-  def container_names(pod)
-    pod['spec']['containers'].map { |container| container['name'] }
-  end
-
-  def tty_command(subdomain)
-    pods = describe_pods
-    pod = pods.select! { |pod| pod&.[]('metadata')&.[]('labels')&.[]('subdomain') == subdomain }.first
-    pod_name = pod['metadata']['name']
-    container = container_names(pod).select_regex(/rails/).first
-    namespace = get_namespace(pod)
-    "kubectl exec -ti #{pod_name} -c #{container} --namespace #{namespace} -- bash"
-  end
 end

data/podjumper.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = ["podj"]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.15"
@@ -35,8 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
 
-  spec.add_dependency "gli", "~> 2.17.1"
-
-  spec.bindir = 'bin'
-  spec.executables << 'podj'
+  spec.add_dependency "gli", "~> 2.17"
+  spec.add_dependency "highline", ">= 1.7"
+  spec.add_dependency "tty-command"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: podjumper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - johndavidmartinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: '2.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
 description: 
 email:
 - johndavidmartinez1@gmail.com
@@ -90,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -102,6 +131,9 @@ files:
 - bin/setup
 - cmd
 - lib/podjumper.rb
+- lib/podjumper/command.rb
+- lib/podjumper/jump_info.rb
+- lib/podjumper/pod.rb
 - lib/podjumper/refinements.rb
 - lib/podjumper/version.rb
 - podjumper.gemspec