bcome 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f232736b42afc8eb14ae4df636a3b7b6eccb7d0e
-  data.tar.gz: f260940851ea03b9d2bfdfd863883468958cf8fc
+  metadata.gz: f8b43a40c66431c8282e710e49721519ae9cdd22
+  data.tar.gz: 6aab609acf080f4686b1ebceb016cd7162877579
 SHA512:
-  metadata.gz: 02936421eec97fdeeddc3318adea9d7ae7e5b591164130f90b1ecf7a6e10a544374b260f047bc2309ce8087e4f5adec43b287d4c4b06af0057e0cb83f546492a
-  data.tar.gz: bf8b6c1262e05bf9201538f4d8c478d09bae2248477c0338cd4df26471885640baf10626d9172fd09cdc6344913acaab99fd9feb02e49681eb462d8b136c8add
+  metadata.gz: f1583a06db19ab8874ce7b3b985e3366ff74dcfffe4a7162db5c502d3582ee1b1a5328dc9f061caf863ca38d74e913d38114c9f73804616c4cef8cce10321fc4
+  data.tar.gz: 8d671a6476db8a8ed65da10b25a0201da57d4c66ab270b75f5bb6a921d7351bdb1a2e27f2ffe317f2c7bd07f0fe96a9a7ce6d71e7b40ce554149c6a6baa2d95d

data/documentation/usage.md

@@ -16,7 +16,7 @@ or, if with bundler
   > bundle exec bcome
 ```
 
-### Entering the shell and jumping to a quick link contexct
+### Entering the shell and jumping to a quick link context
 
 ```
   > cd /your/installed/bcome/application/directory
@@ -119,17 +119,21 @@ e.g. remove 'identifier', OR remove ['array', 'of','identifiers']
 > selections
 - Show all added resources.
 
-> rsync
-- Rsync files to all selected resources.
-e.g. rsync 'localpath', 'remotepath'
+> put
+- Uploads files to all selected resources. Uses Rsync, and so copies recursively
+e.g. put 'localpath', 'remotepath'
+
+> get
+- Downloads files from all remote resources down to local. Does so using Rsync, and so is recursive.
+- A 'downloads' directory will be created in your project directory, within which downloaded files are stored.
+e.g. get 'remotepath'
 
 > run
 - Execute a command on all selected resources
 e.g. run 'command'
 
-> scp
-- SCP files up to all selected resources
-e.g. scp ['array','of', 'file', 'paths'], 'remote_path'
+> sudo
+- Enters 'sudo' mode, resulting in 'get' or 'put' commands being execute remotely using 'sudo'. This assumes that you have passwordless sudo setup on each respective remote host.
 
 ### Instance level commands
 
@@ -156,26 +160,22 @@ e.g. workon 'identifier'
 - Execute a shell command on your local machine.
 e.g. local "command"
 
-> rsync
-- Rsync files.
-e.g. rsync 'localpath', 'remotepath'
+> put
+- Uploads files. Uses Rsync, and so copies recursively
+e.g. put 'localpath', 'remotepath'
+
+> get
+- Downloads files to local. Does so using Rsync, and so is recursive.
+- A 'downloads' directory will be created in your project directory, within which downloaded files are stored.
+e.g. get 'remotepath'
 
 > run
 - Execute a command.
 e.g. run 'command'
 
-> scp
-- SCP files.
-e.g. scp ['array','of', 'file', 'paths'], 'remote_path'
+> sudo
+- Enters 'sudo' mode, resulting in 'get' or 'put' commands being execute remotely using 'sudo'. This assumes that you have passwordless sudo setup on the remote host.
 
 > ssh
 - Initiate an SSH connection.
 
-
-
-
-
-
-
-
-

data/lib/bcome.rb

@@ -5,5 +5,8 @@ require 'aws-sdk'
 require 'net/scp'
 require 'net/ssh/proxy/command'
 require 'fog'
+require 'require_all'
+
+require_all "#{File.dirname(__FILE__)}/../lib"
+require_all "#{File.dirname(__FILE__)}/../filters"
 
-Dir[File.dirname(__FILE__) + "/**/*.rb"].each {|file| require file }

data/lib/bcome/version.rb

@@ -1,3 +1,3 @@
 module Bcome
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/become_object.rb

@@ -12,6 +12,15 @@ module ::Bcome::BecomeObject
     "#{previous_workspace_object.send(:become_identifier)}> #{identifier}"
   end
 
+
+  def local_download_path
+    "#{Dir.pwd}/downloads#{namespace}" 
+  end
+
+  def namespace
+    "#{previous_workspace_object.send(:namespace)}/#{identifier}"
+  end
+
   def previous_workspace_object=(object)
     @previous_workspace_object = object
   end

data/lib/boot.rb

@@ -22,4 +22,12 @@ class ::Bcome::Boot
     ::START_PROMPT
   end
 
+  def namespace
+    starting_namespace
+  end
+
+  def starting_namespace
+    ""  # Used to determine where to store downloaded file - this is the start point directory, relative to the bcome install directory
+  end
+
 end

data/lib/helpers/command_helper.rb

@@ -1,7 +1,7 @@
 module ::Bcome::CommandHelper
 
-  def run_local(command)
-    puts "(local) > #{command}" if ::VERBOSE
+  def run_local(command, silent = false)
+    puts "(local) > #{command}" if !silent && ::VERBOSE
     system(command)
   end
   alias :local :run_local

data/lib/helpers/environment_ssh.rb

@@ -31,8 +31,8 @@ module ::Bcome::EnvironmentSSH
 
   def execute_scp_upload(files, remote_path, node)
     begin
-      scp = ::Bcome::Scp.new(files, remote_path, proxy, node)
-      scp.upload!
+      scp = ::Bcome::Scp.new(proxy, node)
+      scp.upload!(files, remote_path)
     rescue Net::SSH::AuthenticationFailed
       raise "Could not authenticate connection to #{node.identifier}".failure
     rescue Net::SSH::Disconnect 
@@ -40,5 +40,15 @@ module ::Bcome::EnvironmentSSH
     end
   end        
 
+  def execute_scp_download(remote_path, local_path, node)
+    begin
+      scp = ::Bcome::Scp.new(proxy, node)
+      scp.download!(remote_path, local_path)
+    rescue Net::SSH::AuthenticationFailed
+      raise "Could not authenticate connection to #{node.identifier}".failure
+    rescue Net::SSH::Disconnect
+      raise "SSH connection to #{node.identifier} was disconnected".failure
+    end
+  end   
 
 end

data/lib/helpers/instance_command.rb

@@ -9,19 +9,34 @@ module ::Bcome::InstanceCommand
     @environment.execute_command(commands, self)
   end
 
-  def rsync(local_path, remote_path)
+  def put(local_path, remote_path)
     puts "rsync> #{self.identifier}".informational
     if @environment.ssh_mode_type == ::SSH_DIRECT_MODE_IDENTIFIER
-      rsync_command = "rsync -av #{local_path} #{self.ssh_user}@#{self.ip_address}:#{remote_path}"
+      rsync_command = "rsync #{rsync_is_sudo}-av #{local_path} #{self.ssh_user}@#{self.ip_address}:#{remote_path}"
     else
-      rsync_command = "rsync -av -e \"ssh -A #{self.ssh_user}@#{@environment.bastion_ip_address} ssh -o StrictHostKeyChecking=no\" #{local_path} #{self.ssh_user}@#{self.ip_address}:#{remote_path}"
+      rsync_command = "rsync -av -e \"ssh -A #{self.ssh_user}@#{@environment.bastion_ip_address} ssh -o StrictHostKeyChecking=no\" #{rsync_is_sudo}#{local_path} #{self.ssh_user}@#{self.ip_address}:#{remote_path}"
     end
     run_local(rsync_command)
   end
 
-  def scp(files, remote_path)
-    @environment.execute_scp_upload(files, remote_path, self)
-    return
+  def get(remote_path, local_path = local_download_path)
+    raise "No local path specified" unless local_path
+    raise "No remote_path specified" unless remote_path
+
+    if @environment.ssh_mode_type == ::SSH_DIRECT_MODE_IDENTIFIER
+      rsync_command = "rsync #{rsync_is_sudo} -chavzP #{self.ssh_user}@#{self.ip_address}:#{remote_path} #{local_path}"
+    else
+      rsync_command = "rsync -chavzP -av -e \"ssh -A #{self.ssh_user}@#{@environment.bastion_ip_address} ssh -o StrictHostKeyChecking=no\" #{rsync_is_sudo}#{self.ssh_user}@#{self.ip_address}:#{remote_path} #{local_path}"
+    end
+
+    silent = true
+    local("mkdir -p #{local_path}", silent)
+    run_local(rsync_command)
+    puts "done: files copied to #{local_path}".informational
+  end
+
+  def rsync_is_sudo
+    is_sudo? ? " --rsync-path=\"sudo rsync\" " : ""
   end
 
 end

data/lib/helpers/selections.rb

@@ -22,29 +22,28 @@ module ::Bcome::Selections
     return
   end
 
-  def rsync(local_path, remote_path)
+  def put(local_path, remote_path)
     if !@objects || @objects.empty?
       no_selections_error
       return  
     end
+
     @objects.each do |object|
-      object.rsync(local_path, remote_path)
+      object.put(local_path, remote_path)
     end
     return
   end
 
-  def scp(files, remote_path)
+  def get(remote_path)
     if !@objects || @objects.empty?
       no_selections_error
       return
     end
-
-    return unless @objects
     @objects.each do |object|
-      object.scp(files, remote_path)
-    end 
+      object.get(remote_path)
+    end
     return
-  end  
+  end
 
   def add(resource_identifier = nil)
     if resource_identifier.is_a?(Array)

data/lib/object.rb

@@ -14,7 +14,21 @@ class Object
   def become(object)
     BECOME.set(object, self)
   end
-  
+ 
+  def toggle_sudo
+    @sudo = @sudo.nil? ? true : (@sudo ? false : true)
+    puts "sudo #{sudo_state.informational}"
+    return
+  end
+
+  def is_sudo?
+    @sudo
+  end
+ 
+  def sudo_state
+    is_sudo? ? "on" : "off"
+  end
+
   def workon(identifier)
     resource = resource_for_identifier(identifier)
 
@@ -32,7 +46,7 @@ class Object
       { :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 => "exit", :description => "Close the current context" },
+      { :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"'}
     ]
@@ -62,7 +76,7 @@ class Object
   def set_irb_prompt(conf)
     conf[:PROMPT][:CUSTOM] = {
       :PROMPT_N => "\e[1m:\e[m ",
-      :PROMPT_I => "\e[1m#{BECOME.irb_prompt} >\e[m ",
+      :PROMPT_I => "\e[1m#{BECOME.irb_prompt} #{is_sudo? ? " sudo ".danger : ""}>\e[m ", # high voltage
       :PROMPT_C => "\e[1m#{BECOME.irb_prompt} >\e[m ",
       :RETURN => ::VERBOSE ? "%s \n" : "\n"
     }

data/lib/patches/string.rb

@@ -16,6 +16,10 @@ class String
     self.friendly
   end
 
+  def danger
+    self.colorize(:white).on_red
+  end
+
   def friendly
     self.colorize(:black).on_green
   end 

data/lib/scp.rb

@@ -1,18 +1,29 @@
 class ::Bcome::Scp
 
-  def initialize(files, remote_path, proxy, node)
-    @files = files
+   def initialize(proxy, node)
     @proxy = proxy
     @node = node
-    @remote_path = remote_path
   end
 
-  def upload!
+  def download!(remote_path, local_path = @node.local_download_path)
+    local("mkdir -p #{local_path}", true)
+    ::Net::SCP.start(@node.ip_address, @node.ssh_user, { :proxy => @proxy, :keys => @node.keys, :paranoid => false }) do |scp|
+      scp.download!(remote_path, local_path, { :recursive => true, :preserve => true, :verbose => true }) do |cha, name, received, total|
+        pct = received / total.to_f
+        cnt = ( 72 * pct ).ceil
+        print "%-72s %.2f%%\r" % [ ("#" * cnt), ( pct * 100 ) ]
+      end
+    end
+    puts "done: files copied to #{local_path}".informational
+  end
+
+  def upload!(files, remote_path)
     puts "scp> #{@node.identifier}".informational
     ::Net::SCP.start(@node.ip_address, @node.ssh_user, { :proxy => @proxy, :keys => @node.keys, :paranoid => false }) do |scp|
-      @files.each do |local_path|
+      files = files.is_a?(Array) ? files : [files]
+      files.each do |local_path|
         name_old = ""
-        scp.upload!(local_path, @remote_path, { :recursive => true }) do |ch, name, sent, total|
+        scp.upload!(local_path, remote_path, { :recursive => true }) do |ch, name, sent, total|
         log_string = "#{name}: #{sent}/#{total}"
         if name_old == name
             STDOUT.write "\r#{log_string}"

data/lib/stack/environment.rb

@@ -31,9 +31,10 @@ module ::Bcome::Stack
         { :command => "remove", :description => "Remove a resource you no longer with to work on.", :usage => "remove 'identifier', OR remove ['array', 'of','identifiers']" },
         { :command => "clear!", :description => "Remove all selected resources." },
         { :command => "selections", :description => "Show all added resources." },
-        { :command => "rsync", :description => "Rsync files to all selected resources.", :usage => "rsync 'localpath', 'remotepath'" },
         { :command => "run", :description => "Execute a command on all selected resources", :usage => "run 'command'" },
-        { :command => "scp", :description => "SCP files up to all selected resources", :usage => "scp ['array','of', 'file', 'paths'], 'remote_path'" },
+        { :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)" }
       ]
     end
   
@@ -51,6 +52,10 @@ module ::Bcome::Stack
       return @meta_data[:ssh_mode][:ssh_user]
     end 
 
+    def sudo 
+      toggle_sudo
+    end
+
     def valid_ssh_modes
       [::SSH_JUMP_MODE_IDENTIFIER, ::SSH_DIRECT_MODE_IDENTIFIER]
     end

data/lib/stack/instance.rb

@@ -40,10 +40,11 @@ module ::Bcome::Stack
 
     def menu_items
       super + [
-        { :command => "rsync", :description => "Rsync files.", :usage => "rsync 'localpath', 'remotepath'" },
         { :command => "run", :description => "Execute a command.", :usage => "run 'command'" },
-        { :command => "scp", :description => "SCP files.", :usage => "scp ['array','of', 'file', 'paths'], 'remote_path'" },
-        { :command => "ssh", :description => "Initiate an SSH connection." }
+        { :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)" }
       ]
     end
 
@@ -51,6 +52,18 @@ module ::Bcome::Stack
       @environment.platform
     end
 
+    def sudo 
+      toggle_sudo
+    end
+
+    def namespace
+      "#{@environment.namespace}/#{identifier}"
+    end
+
+    def is_sudo?
+      super || @environment.is_sudo?
+    end
+
     def responds_to_list?
       false
     end
@@ -80,7 +93,7 @@ module ::Bcome::Stack
     end
 
     def do_describe
-      description = "#{identifier}"
+      description = "#{identifier}#{ is_sudo? ? " MODE: sudo "  : "" }"
       description += "\n\t* Internal IP #{@meta_data[:external_network_interface_address]}"
       description += "\n\t* External IP #{public_ip_address}" if public_ip_address
       description += "\n\t* #{role}" if role 

data/lib/workspace_context.rb

@@ -1,19 +1,17 @@
-class ::Bcome::WorkspaceContext  ## TODO Move to include
+class ::Bcome::WorkspaceContext  
 
   attr_reader :object
 
   def set(object, current_object, spawn = true)
-
     @object = object
     main_context = IRB.conf[:MAIN_CONTEXT]
     @object.main_context = main_context.workspace if main_context
     @object.previous_workspace_object = current_object if current_object
 
-    irb = IRB::Irb.new(IRB::WorkSpace.new(@object))
-
     # Spawn is initiated when a user wants to shift workspace context.
     # We don't spawn whilst setting up the hierarchy for quick contexts 
     spawn_for_object(@object) if spawn
+    return
   end
 
   def spawn_for_object(object)
@@ -33,4 +31,9 @@ class ::Bcome::WorkspaceContext  ## TODO Move to include
   def irb_prompt
     @object ? @object.send(:become_identifier) : start_prompt
   end
+
+  def is_sudo?
+    @object.is_sudo?
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcome
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Guillaume Roderick (Webzakimbo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -86,10 +86,24 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.33.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 description: Provides a console interface for traversing a hierarchy of platforms
   -> environment -> servers, and exposes common administration tools for the managemenent
   either of individual servers, or groups or servers. System is driven from simple
-  configuration, and is extensible. Integrates with AWS EC2 for dynamic network discovery.
+  configuration, and is extensible. Integrates with AWS EC2 for dynamic network discover.
 email:
 - guillaume@webzakimbo.com
 executables: