bcome 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 391c30036acc6805542513ea6b230e87a4fe0ef5
-  data.tar.gz: 5ccd09087b73458c84d96d848387d0a40fc9e8ad
+  metadata.gz: da26ecc8e341d6c26a8b7243903ccfb64bb90627
+  data.tar.gz: 91d217becd8fa055b38b85fcc205efa85728911e
 SHA512:
-  metadata.gz: dfcb18cf3e673189a9d19daae240dc2e4943a27c69c1c7d7c4ac8f40ec362f36348d5ffd95097858fe46a862898fafe711c5551c404df9016c3be29dc4dcc06d
-  data.tar.gz: b2e0175e9e9a6ff23a1644024ad2f473e680911bed014e3c66d5cffd6587ca2c74091ace88bb36a81bbd6e2386d9aa208ac211c30b457e41cecdb159c7465ae7
+  metadata.gz: 08e3ea167a7bfd6a46fd00ca59d428ea46d8257a1c2dbed0c1e7e7f25d9bef25dfee264dc46e280c64ee74c069a2c9ba8bd1196af836cd4afc5ca91e7222b181
+  data.tar.gz: 1e097242ea3a069ebf5a80212d5817c87a92b170d7233bc06dda3804dcb0addd3fdf4082fbb1ee5b86bff6a91b87a260f963f769586a599811d2c26fee5e8413

data/documentation/interactive_mode.md

@@ -0,0 +1,36 @@
+# Interactive mode
+
+## Overview
+
+Interactive mode lets you interact transparently from the shell with every machine at an Estate level, platform level, or with selections of machines (or all) at an environment level.
+
+Put simply: One shell to control any number of machines, with input & output inline.
+
+### Use case example
+
+You have a platform named "wbz", and an environment named "prod", and you wish to interact with the application servers:
+
+#### Enter the shell
+
+```
+  > bundle exec bcome wbz:prod
+```
+
+#### Pick the machines you want 
+
+Add all machines
+
+```
+ >  add!
+```
+
+Or just add the ones you want (hit 'menu' if you're unsure how to work with machine selections)
+
+```
+  > add [app_server1, app_server2, app_server3, ...]
+```
+
+And then enter interctive mode
+```
+  > interactive
+```

data/lib/bcome/version.rb

@@ -1,3 +1,3 @@
 module Bcome
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/interactive/interactive_session_halt.rb

@@ -0,0 +1,4 @@
+module Bcome::Interactive
+  class SessionHalt < RuntimeError
+  end
+end

data/lib/interactive/session.rb

@@ -0,0 +1,42 @@
+module Bcome::Interactive
+  class Session
+
+    class << self
+      def run(irb_session)
+        irb_pre_session_return_format = irb_session.conf.return_format
+        session_end_message = "\ninteractive session ended".success
+        begin
+          session = ::Bcome::Interactive::Session.new(irb_session)
+          irb_session.conf.return_format = ""
+          system("clear")
+          session.prompt
+        rescue ::Bcome::Interactive::SessionHalt
+          irb_session.conf.return_format = irb_pre_session_return_format
+          puts session_end_message
+        end
+      end
+    end
+
+    attr_reader :responses, :irb_session
+
+    def initialize(irb_session)
+      @irb_session = irb_session
+      @responses = {}
+    end
+
+    def prompt
+      item = ::Bcome::Interactive::SessionItem::TransparentSsh.new(self)  
+      print item.start_message
+      process_item(item)
+    end
+
+    def process_item(item)
+      begin
+        item.do
+      rescue 
+        raise ::Bcome::Interactive::SessionHalt.new
+      end
+    end
+
+  end
+end

data/lib/interactive/session_item/base.rb

@@ -0,0 +1,30 @@
+module Bcome::Interactive::SessionItem
+  class Base
+
+    def initialize(session)
+      @session = session
+      @irb_session = @session.irb_session
+    end
+
+    def bcome_identifier  
+      @irb_session.become_identifier
+    end
+
+    def irb_session
+      @session.irb_session
+    end
+
+    def options
+      @session.options
+    end
+
+    def set_response_on_session
+      @session.responses[@key] = @response
+    end
+
+    def do(*params)
+      raise "Should be overidden"
+    end
+
+  end
+end

data/lib/interactive/session_item/transparent_ssh.rb

@@ -0,0 +1,82 @@
+module Bcome::Interactive::SessionItem
+  class TransparentSsh < ::Bcome::Interactive::SessionItem::Base
+
+    END_SESSION_KEY = "\\q"
+    HELP_KEY = "\\?"   
+    LIST_KEY = "\\l"
+
+    def do
+      input = get_input
+      raise ::Bcome::Interactive::SessionHalt.new if exit?(input)
+      if show_menu?(input)
+        show_menu
+      elsif list_machines?(input)
+        list_machines
+      else
+        execute_on_machines(input)
+      end
+      send(:do)
+    end
+
+    def show_menu
+      system("clear") ; print start_message
+    end
+
+    def start_message
+      warning = "\nCommands entered here will be executed on every machine in your selection.".danger
+      second_warning = "\nUse with CAUTION.".danger
+      info = "\n\n\\l list machines\n\\q to quit\n\\? this message".informational                                                             
+    
+      return "#{warning}#{second_warning}#{info}\n"
+    end
+
+    def terminal_prompt
+      "#{bcome_identifier}>\s" + "interactive\s>\s".command   # high voltage
+    end
+
+    def valid_response(response)
+      a = response.gsub("\s", "").downcase
+      valid_responses.include?(response)
+    end
+
+    def exit?(input)
+      input == END_SESSION_KEY
+    end
+
+    def show_menu?(input)
+      input == HELP_KEY
+    end
+ 
+    def list_machines?(input)
+      input == LIST_KEY 
+    end
+ 
+    def get_input
+      return ::Readline.readline("\n#{terminal_prompt}", true).squeeze(" " ).to_s
+    end
+
+    def execute_on_machines(user_input)
+      machines.pmap {|machine|
+        machine.run(user_input)
+      }
+    end
+
+    def list_machines
+      listed = "\n#{machines.collect(&:identifier).join(", ")}\n"
+      print listed.friendly
+    end
+
+    def machines
+      @machines ||= has_selected_machines? ? selected_machines : @irb_session.machines
+    end
+
+    def has_selected_machines?
+      selected_machines.is_a?(Array) && selected_machines.any?
+    end
+
+    def selected_machines
+      @selections ||= @irb_session.instance_variable_get(:@objects)
+    end
+
+  end
+end

data/lib/stack/base.rb

@@ -9,6 +9,10 @@ module ::Bcome::Stack
       node.machines
     end
 
+    def interactive
+      ::Bcome::Interactive::Session.run(self)
+    end
+
     def self.const_missing(constant_name)
       ## Hook for direct access to stack level resources by constant name where
       ## cd ServerName should yield the same outcome as cd "ServerName" or cd :ServerName does
@@ -111,7 +115,8 @@ module ::Bcome::Stack
         { :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"'},
-        { :command => "machines", :description => "Return all servers below the current level to the console. These objects can be manipulated directly" }
+        { :command => "machines", :description => "Return all servers below the current level to the console. These objects can be manipulated directly" },
+        { :command => "interactive", :description => "Enter an interactive where you may transparently interact with all the machines in your selection at once" },
       ]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcome
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Guillaume Roderick (Webzakimbo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -143,6 +143,7 @@ files:
 - documentation/images/direct_cmd_execution.png
 - documentation/images/direct_ssh.png
 - documentation/installation.md
+- documentation/interactive_mode.md
 - documentation/usage.md
 - filters/ec2_filter.rb
 - lib/bcome.rb
@@ -160,6 +161,10 @@ files:
 - lib/helpers/instance_command.rb
 - lib/helpers/instance_ssh.rb
 - lib/helpers/selections.rb
+- lib/interactive/interactive_session_halt.rb
+- lib/interactive/session.rb
+- lib/interactive/session_item/base.rb
+- lib/interactive/session_item/transparent_ssh.rb
 - lib/nodes/base.rb
 - lib/nodes/environment.rb
 - lib/nodes/estate.rb