ranch-hand 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6810dd022dd993929014b497c21309de90d66a78dfc606216a5e36a621256c8b
-  data.tar.gz: 704ae19d0977277481eb7bd563d82d271dbab936faa0c273e053433eb6d77dc2
+  metadata.gz: 28e355a00dd066ac8d0b0270f59a2a97c25bd28e69066a289aec029db9661fa9
+  data.tar.gz: 56a686da7e0be9a823b75fd7d349d75b7d7cd8c497106d153fe3018f6921ce87
 SHA512:
-  metadata.gz: 31a7c159877709b9c5486dd7dae9a7cf3e9c6df9be3e3b6a58fe17ac5d1c56f42e24aad18218c216b7baa6ae6e3d82e04eeda9db185ea0725219b0761471d15d
-  data.tar.gz: 7fe741b1e01dc48e7c5d62fcf2f2c17e639899ac8daf4ed47b348bcd7c2393a138b778198443790f41b9222ec4bb8569ca3924d7cdc308b4eea4bd568863d159
+  metadata.gz: d7639b1029f2cfb0a415794dd22ca8af87f38a20be8efdb757373a0218ae2fbdbf50f13365985afdd55a0e44fdcce72e6cf40c260d33823f1dd8dafe0ece392b
+  data.tar.gz: be9d54eed465ab6b3bb9b09f845ddb1d514f701076cf9d1f4b601b07fadfad36e2672c74d3b816380ab311ec4d619825ef4b966ebd657d7f4293f92900bd24f8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ranch-hand (0.2.0)
+    ranch-hand (0.3.0)
       gli (~> 2.18)
       pry (~> 0.12.2)
       tty-command (~> 0.8.2)

data/README.md

@@ -1,8 +1,7 @@
 # RanchHand
 
-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/ranch_hand`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Provides an interface between the Rancher CLI and the Kubectl commands to make running commands in pods easier.
+This is particularily useful when using Kubernetes in a development environment.
 
 ## Installation
 
@@ -22,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+RanchHand makes use of the [GLI](https://github.com/davetron5000/gli) (Git Like Interface) gem to create a CLI with features similar to the Git CLI. Run `ranch-hand help` or `ranch-hand command help` for usage information.
 
 ## Development
 
@@ -40,4 +39,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ranch::Hand project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/peregrinator/ranch-hand/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RanchHand project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/peregrinator/ranch-hand/blob/master/CODE_OF_CONDUCT.md).

data/bin/ranch-hand

@@ -2,6 +2,7 @@
 module RanchHandCLI
   require 'gli'
   require 'ranch_hand'
+  require 'pry'
 
   include GLI::App
   # our cli is wrapped in a module (to not pollute the global namespace with GLI methods),
@@ -23,11 +24,18 @@ module RanchHandCLI
   end
 
   desc 'Execs into a running container'
-  arg_name 'namespace'
   command :exec do |c|
-    c.switch [:rm, :remove], negatable: false
-    c.action do |global_options, options, args|
-      RanchHand::KubeCtl.new.exec(args[0], options)
+    c.switch [:g, :group], negatable: false, desc: "Group pods returned so that there is only one from each deployment."
+    c.switch [:rm, :remove], negatable: false, desc: "Used to indicated that you want to remove a previously saved command."
+    c.switch [:r, :repeat], negatable: false, desc: "Repeat the last command ran (against the same pod)."
+    
+    c.flag [:c, :command], desc: "Command to run once (not permanently stored)"
+    c.flag [:f, :filter], desc: "Filter pods returned to those that contain the string provided (negative matches supported). Examples: '-f nginx', '-f -apache'"
+    c.flag [:n, :namespace], required: true, desc: "Namespace against which to retreive pods and run command"
+    c.flag [:p, :pod], desc: "Run command in a specific pod. If used with -g only the pod name can be specified and the command will be run against the first in the group"
+
+    c.action do |global_options, command_options, args|
+      RanchHand::KubeCtl.new.exec(command_options)
     end
   end
 

data/lib/ranch_hand/kube_ctl.rb

@@ -2,19 +2,30 @@ module RanchHand
   class KubeCtl
     include RanchHand::Commands
 
-    def exec(namespace, options={})
-      if options[:rm]
+    def exec(options={})
+      namespace = options.delete(:namespace)
+      
+      if options[:remove]
         remove_command(namespace)
+      elsif options[:repeat]
+        repeat_command(namespace)
+      elsif options[:command]
+        pod = select_pod(namespace, options)
+        run_command(namespace, pod, options[:command])
       else
-        run_command(namespace)
+        choose_command(namespace, options)
       end
     end
 
-    def run_command(namespace)
-      pod = select_pod(namespace)
+    def run_command(namespace, pod, cmd)
+      system("rancher kubectl -n #{namespace} exec -it #{pod} -- #{cmd}")
+    end
+
+    def choose_command(namespace, options={})
+      pod = select_pod(namespace, options)
       type, cmd = select_command(namespace, pod)
       
-      system("rancher kubectl -n #{namespace} exec -it #{pod} -- #{cmd}")
+      run_command(namespace, pod, cmd)
     end
 
     def remove_command(namespace)
@@ -33,13 +44,46 @@ module RanchHand
       storage.set(storage_key, storage.get(storage_key) - Array(cmd))
     end
 
-    def select_pod(namespace)
-      pods = pods(namespace)
-      pod = prompt.enum_select("Which pod?", pods, per_page: 10,
-        default: pods.index(
-          storage.get("exec:#{namespace}:latest:pod")
-        ).to_i + 1
+    def repeat_command(namespace)
+      run_command(
+        namespace,
+        storage.get("exec:#{namespace}:latest:pod"),
+        storage.get("exec:#{namespace}:latest:cmd")
       )
+    end
+
+    def select_pod(namespace, options={})
+      pods = pods(namespace)
+
+      if options[:filter]
+        if options[:filter].start_with?('-')
+          pods = pods.reject{|p| p.match?(/#{options[:filter][1..-1]}/)} 
+        else
+          pods = pods.select{|p| p.match?(/#{options[:filter]}/)} 
+        end
+      end
+      prompt.error("No pods matching filter: '#{options[:filter]}'") and exit if pods.empty?
+
+      if options[:group]
+        pods = pods.group_by{|p| pod_name(p)}.map{|name, pods| pods.first}
+      end
+
+      if options[:pod]
+        if options[:group]
+          pod = pods.select{|p| p.match?(/#{options[:pod]}/)}.first
+        else
+          pod = pods.select{|p| options[:pod] == p}.first
+        end
+
+        prompt.error("No pods match: '#{options[:pod]}'. Did you mean to use the group (-g) switch?") and exit unless pod
+      else
+        pod = prompt.enum_select("Which pod?", pods, per_page: 10,
+          default: pods.index(
+            storage.get("exec:#{namespace}:latest:pod")
+          ).to_i + 1
+        )
+      end
+
       storage.set("exec:#{namespace}:latest:pod", pod)
       pod
     end
@@ -63,6 +107,8 @@ module RanchHand
       unless options[:remove]
         if cmd == "Add command"
           type, cmd = add_command(namespace, pod)
+        elsif cmd == "Run once"
+          type, cmd = nil, run_once(namespace, pod)
         end
 
         # save cmd as latest
@@ -90,6 +136,10 @@ module RanchHand
       [type, cmd]
     end
 
+    def run_once(namespace, pod)
+      prompt.ask('Command:')
+    end
+
     private
 
     def all_commands(namespace, pod, options)
@@ -101,7 +151,7 @@ module RanchHand
       if options[:remove]
         {base: []}
       else
-        {base: ["Add command"]}
+        {base: ["Add command", "Run once"]}
       end
     end
 

data/lib/ranch_hand/version.rb

@@ -1,3 +1,3 @@
 module RanchHand
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ranch-hand
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler