bcome 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a686ef98d2ed392ebea901a998bb508e5647f1c6
-  data.tar.gz: 1d45c2e23a9c47e7668ec5d5bc13840c2ac1ee52
+  metadata.gz: 182bfab8bb82f233dc36d0997b8b04d5c338fdbc
+  data.tar.gz: 05f502b57479254e9f8242105950e11cae9a890b
 SHA512:
-  metadata.gz: 36293dd728003d7c64b5355578dfec7d33d00a7e8ab240feb898a6f16d42ab83f1bac9c08b72ba812d813409a3074d8c64302147cbd1ca8b5745956380f8660d
-  data.tar.gz: c6ef2b507110c1ae8222c1b011befa04578b1661053df02c3184ffb028f584e187bc54cd2b2e3857f48d4ca2c8eac6a8190a95416263df38d21c91e441f34cbf
+  metadata.gz: 44c5de8e693ea1a1d7ede4eb64ece7ba5d388a6f3de742fbf234c1a4a17a5bd6845467060084ce019f439cef9e3c7b01fd19e343c56c8abb294598f452b162e5
+  data.tar.gz: 7269b4533caae53f815e80ceb40ac6ca3c4f071a3ea537752b9a5ee9850c7efac12c88d38c101a4c28d5e48c1d16bc48d7cadeb326b3e4bd43a7933bec005861

data/bin/bcome-setup

@@ -26,7 +26,7 @@ gem_install_path = File.dirname(__FILE__)
 conf_example_path = "#{gem_install_path}/../documentation/examples"
 application_path = Dir.pwd
 
-["platform.yml-example","network.yml-example"].each do |example_conf|
+["platform.yml-example","network.yml-example", "functions.yml-example"].each do |example_conf|
   transfer_cmd = "rsync -aq #{conf_example_path}/#{example_conf} #{application_path}/#{config_dir}/#{example_conf}"
   system(transfer_cmd)
 end

data/documentation/examples/functions.yml-example

@@ -0,0 +1,21 @@
+---
+:single_functions:
+  - :description: "Find open files that are open, but have been deleted"
+    :ref: "openfiles"
+    :command: "lsof -nP +L1"
+
+  - :description: "Show free disk space"
+    :ref: "space"
+    :command: "df -h"
+
+  - :description: "Free system memory"
+    :ref: "mem"
+    :command: "free -m"
+
+  - :description: "Find large files in /var"
+    :ref: "large"
+    :command: "du -a /var | sort -n -r | head -n 10"
+
+  - :description: "CPU usage as a percentage" 
+    :ref: "cpu"
+    :command: "cat <(grep 'cpu ' /proc/stat) <(sleep 1 && grep 'cpu ' /proc/stat) | awk -v RS=\"\" '{print ($13-$2+$15-$4)*100/($13-$2+$15-$4+$16-$5)}'"

data/documentation/functions.md

@@ -0,0 +1,28 @@
+## Functions
+
+Functions are shortcuts to SSH commands accessible from the shell that can be executed in sequence over a selection of instances (if you're at the environment level), or on a specific instance, if you're at a node level.
+
+An example functions config can be found in bcome/config/functions.yml-example.  Rename this file to functions.yml and you will have access to the functions within from the shell.
+
+### Example usage
+
+Define the function in the functions.yml config
+
+```
+[...]
+
+  - :description: "Free system memory"
+    :ref: "mem"
+    :command: "free -m"
+
+[...]
+```
+
+Then enter the shell, navigate to an environment level, select the nodes you wish to work on (those on which the function command will be executed), and invoke it:
+
+```
+  bcome> F 'mem'
+
+```
+
+The command will then be invoked on every selected node with the output returned to the shell.

data/documentation/usage.md

@@ -36,9 +36,9 @@ or, if with bundler
 > describe
 - Describe the resource object at the current context.
 
-> workon / w
+> workon / w / cd
 - Select a resource object, and switch to its context.
-e.g. workon 'identifier'
+e.g. cd 'identifier'
 
 > exit
 - Close the current context
@@ -62,9 +62,9 @@ e.g. local "command"
 > describe
 - Describe the resource object at the current context.
 
-> workon / w
+> workon / w / cd
 - Select a resource object, and switch to its context.
-e.g. workon 'identifier' OR w 'identifier'
+e.g. cd 'identifier' OR workon 'identifier' OR w 'identifier'
 
 > exit
 - Close the current context
@@ -88,9 +88,9 @@ e.g. local "command"
 > describe
 - Describe the resource object at the current context.
 
-> workon / w
+> cd / workon / w
 - Select a resource object, and switch to its context.
-e.g. workon 'identifier'
+e.g. cd 'identifier' OR w 'identifier' OR workon 'identifier'
 
 > exit
 - Close the current context

data/lib/bcome/version.rb

@@ -1,3 +1,3 @@
 module Bcome
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/functions.rb

@@ -0,0 +1,70 @@
+module Bcome::Functions
+
+  CONFIGS_PATH = "bcome/config"
+
+  def functions
+    unless cmd_functions
+      puts "You don't yet have any custom functions defined. Have a read of the docs and define some. They're pretty useful.".informational
+    else
+      puts
+      cmd_functions.each_with_index do |cmd_function, i|          
+        puts "#{cmd_function[:ref].informational}"
+        puts "Description: " + cmd_function[:description]
+        puts "Command: > " + cmd_function[:command]
+        puts "USAGE: > F \"#{cmd_function[:ref]}\""
+        puts
+      end 
+    end
+    return
+  end
+
+  def F(reference)
+    if self.is_a?(Bcome::Stack::Environment) && no_selections?
+      puts "You are an an Environment level, and have not selected any nodes to workon.".failure
+    else
+      command = cmd_for_ref(reference)
+      if command
+         puts "#{"Executing command '#{command[:ref]}': ".informational} > #{command[:command].command}" 
+         puts run command[:command]
+      end
+    end
+  end 
+
+  def cmd_for_ref(reference)
+    commands = cmd_functions.select{|command| command[:ref].to_s == reference.to_s }
+    raise "Multiple commands found for reference '#{reference}'. Your functions list is ambiguous.".failure if commands.size > 1
+    unless commands.any?
+      puts "No command found for reference '#{reference}'".failure
+      return nil
+    end
+    return commands.first
+  end
+
+  def cmd_functions
+    return unless has_functions_config?
+    @cmd_functions ||= load_cmd_functions
+  end
+
+  def has_cmd_functions?
+    !cmd_functions.nil?
+  end
+
+  def load_cmd_functions
+    configs = YAML.load_file(cmd_config_path)
+    unless configs.has_key?(:single_functions)
+      raise "Invalid functions configuration. Please check your yaml".failure
+    else
+      return configs[:single_functions]
+    end
+  end
+
+  def cmd_config_path
+    "#{CONFIGS_PATH}/functions.yml"
+  end
+ 
+  def has_functions_config?
+    File.exist?(cmd_config_path)
+  end
+
+
+end

data/lib/helpers/instance_ssh.rb

@@ -40,7 +40,7 @@ module ::Bcome::InstanceSsh
   end
 
   def ssh_key_path
-    "~/.ssh/id_rsa" 
+    return @environment.ssh_key_path ? @environment.ssh_key_path : "~/.ssh/id_rsa" 
   end
 
   def keys

data/lib/helpers/selections.rb

@@ -22,8 +22,12 @@ module ::Bcome::Selections
     return
   end
 
+  def no_selections?
+    !@objects || @objects.empty?
+  end
+
   def put(local_path, remote_path)
-    if !@objects || @objects.empty?
+    if no_selections?
       no_selections_error
       return  
     end
@@ -35,7 +39,7 @@ module ::Bcome::Selections
   end
 
   def get(remote_path)
-    if !@objects || @objects.empty?
+    if no_selections?
       no_selections_error
       return
     end
@@ -90,7 +94,7 @@ module ::Bcome::Selections
   end  
 
   def remove_object(object)
-    return if !@objects || @objects.empty?
+    return if no_selections?
     unless object_in_selections?(object)
       print "\n#{object.identifier} is not within selections\n".headsup
     else
@@ -105,7 +109,7 @@ module ::Bcome::Selections
   end
 
   def selections
-    if !@objects || @objects.empty?
+    if no_selections?
       print "\nNo added nodes.\n".headsup
     else
       print "\nAdded nodes: #{@objects.collect(&:identifier).join(", ")}\n".headsup

data/lib/object.rb

@@ -40,12 +40,13 @@ class Object
     end
   end
   alias :w :workon
+  alias :cd :workon
 
   def menu_items
     [
       { :command => "list / ls", :description => "List all available resources at the current context." },
       { :command => "describe", :description => "Describe the resource object at the current context." },
-      { :command => "workon' / w", :description => "Select a resource object, and switch to its context.", :usage => "workon 'identifier'" },
+      { :command => "cd / workon / w", :description => "Select a resource object, and switch to its context.", :usage => "cd 'identifier'" },
       { :command => "exit", :description => "Return to the previous context" }, 
       { :command => "exit!", :description => "Close all contexts, and exit Become."},
       { :command => "local", :description => "Execute a shell command on your local machine.", :usage => 'local "command"'}

data/lib/stack/environment.rb

@@ -5,6 +5,7 @@ module ::Bcome::Stack
     include ::Bcome::Selections
     include ::Bcome::FogHelper
     include ::Bcome::EnvironmentSSH
+    include ::Bcome::Functions
 
     class << self
       def collection_from_config(parent, configuration)
@@ -34,7 +35,8 @@ module ::Bcome::Stack
         { :command => "run", :description => "Execute a command on all selected resources", :usage => "run 'command'" },
         { :command => "get", :description => "Download from remote from all selected resources (recursive - uses rsync)", :usage => "get 'remote_path'" },
         { :command => "put", :description => "Copy files up to all selected resources (recursive - uses rsync)", :usage => "put 'local_path', 'remote_path'" },
-        { :command => "sudo", :description => "Run 'get' and 'put' in sudo mode (assumes you have passwordless sudo setup)" }
+        { :command => "sudo", :description => "Run 'get' and 'put' in sudo mode (assumes you have passwordless sudo setup)" },
+        { :command => 'functions', :description => "List all available custom functions" }
       ]
     end
   
@@ -55,6 +57,10 @@ module ::Bcome::Stack
     def ssh_nat_user
       return @meta_data[:ssh_mode][:nat_user]
     end
+
+    def ssh_key_path
+      return @meta_data[:ssh_mode][:ssh_key_path]
+    end
   
     def sudo 
       toggle_sudo

data/lib/stack/instance.rb

@@ -4,6 +4,7 @@ module ::Bcome::Stack
     include ::Bcome::BecomeObject
     include ::Bcome::InstanceSsh
     include ::Bcome::InstanceCommand
+    include ::Bcome::Functions
 
     class << self
       def collection_from_fog_data(parent, fog_instances)
@@ -44,7 +45,8 @@ module ::Bcome::Stack
         { :command => "put", :description => "Copy files to remote (recursive - uses rsync)", :usage => "put 'local_path', 'remote_path'" },
         { :command => "get", :description => "Download from remote (recursive - uses rsync).", :usage => "get 'remote_path'"},
         { :command => "ssh", :description => "Initiate an SSH connection." },
-        { :command => "sudo", :description => "Run 'get' and 'put' in sudo mode (assumes you have passwordless sudo setup)" }
+        { :command => "sudo", :description => "Run 'get' and 'put' in sudo mode (assumes you have passwordless sudo setup)" },
+        { :command => 'functions', :description => "List all available custom functions" }
       ]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcome
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Guillaume Roderick (Webzakimbo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -115,8 +115,10 @@ files:
 - bin/bcome
 - bin/bcome-setup
 - documentation/configuration.md
+- documentation/examples/functions.yml-example
 - documentation/examples/network.yml-example
 - documentation/examples/platform.yml-example
+- documentation/functions.md
 - documentation/installation.md
 - documentation/usage.md
 - filters/ec2_filter.rb
@@ -127,6 +129,7 @@ files:
 - lib/command.rb
 - lib/filters/base.rb
 - lib/filters/ec2_filter.rb
+- lib/functions.rb
 - lib/helpers/command_helper.rb
 - lib/helpers/environment_ssh.rb
 - lib/helpers/fog_helper.rb