bcome 0.7.0 → 1.0.0

data/lib/objects/interactive/session_item/base.rb

@@ -0,0 +1,36 @@
+module Bcome::Interactive::SessionItem
+  class Base
+    def initialize(session, init_data)
+      @session = session
+      @init_data = init_data
+    end
+
+    def bcome_identifier
+      node.namespace
+    end
+
+    def node
+      @session.node
+    end
+
+    def options
+      @session.options
+    end
+
+    def set_response_on_session
+      @session.responses[@key] = @response
+    end
+
+    def do(*_params)
+      raise 'Should be overidden'
+    end
+
+    def has_start_message?
+      true
+    end
+
+    def get_input(message = terminal_prompt)
+      ::Readline.readline("\n#{message}", true).squeeze('').to_s
+    end
+  end
+end

data/lib/objects/interactive/session_item/capture_input.rb

@@ -0,0 +1,20 @@
+module Bcome::Interactive::SessionItem
+  class CaptureInput < ::Bcome::Interactive::SessionItem::Base
+    def do
+      action
+    end
+
+    def terminal_prompt
+      "\n" + @init_data[:terminal_prompt].informational
+    end
+
+    def action
+      input = get_input
+      input.empty? ? get_input : input
+    end
+
+    def has_start_message?
+      false
+    end
+  end
+end

data/lib/objects/interactive/session_item/transparent_ssh.rb

@@ -0,0 +1,111 @@
+module Bcome::Interactive::SessionItem
+  class TransparentSsh < ::Bcome::Interactive::SessionItem::Base
+    END_SESSION_KEY = '\\q'.freeze
+    HELP_KEY = '\\?'.freeze
+    LIST_KEY = '\\l'.freeze
+
+    DANGER_CMD = "rm\s+-r|rm\s+-f|rm\s+-fr|rm\s+-rf|rm".freeze
+
+    def machines
+      node.server? ? [node] : node.machines
+    end
+
+    def do
+      puts ''
+      open_ssh_connections
+      show_menu
+      puts ''
+      list_machines
+      action
+    end
+
+    def action
+      input = get_input
+
+      if exit?(input)
+        close_ssh_connections
+        return
+      end
+
+      if show_menu?(input)
+        show_menu
+      elsif list_machines?(input)
+        list_machines
+      elsif command_may_be_unwise?(input)
+        handle_the_unwise(input)
+      else
+        execute_on_machines(input)
+      end
+      action
+    end
+
+    def show_menu
+      warning = "\n\sCommands entered here will be executed on " + 'EVERY'.underline + ' machine in your selection.'
+      second_warning = "\n\n\s" + 'Use with CAUTION.'.warning
+      info = "\n\n\s\\l list machines\n\s\\q to quit\n\s\\? this message".informational
+      puts "#{warning}#{second_warning}#{info}\n"
+    end
+
+    def handle_the_unwise(input)
+      if prompt_for_confirmation('Command may be dangerous to run on all machines. Are you sure you want to proceed? [Y|N] > '.error)
+        execute_on_machines(input)
+      end
+    end
+
+    def command_may_be_unwise?(input)
+      input =~ /#{DANGER_CMD}/
+    end
+
+    def prompt_for_confirmation(message)
+      answer = get_input(message)
+      prompt_for_confirmation(message) unless %w[Y N].include?(answer)
+      answer == 'Y'
+    end
+
+    def start_message; end
+
+    def terminal_prompt
+      ">\s".bold.terminal_prompt
+    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 open_ssh_connections
+      ::Bcome::Ssh::ConnectionHandler.connect(node, show_progress: true)
+      system('clear')
+    end
+
+    def close_ssh_connections
+      node.close_ssh_connections
+    end
+
+    def indicate_failed_nodes(unconnected_nodes)
+      unconnected_nodes.each do |node|
+        puts "\s\s - #{node.namespace}".bc_cyan
+      end
+    end
+
+    def list_machines
+      puts "\n"
+      machines.each do |machine|
+        puts "\s- #{machine.namespace}"
+      end
+    end
+
+    def execute_on_machines(user_input)
+      machines.pmap do |machine|
+        machine.run(user_input)
+      end
+    end
+  end
+end

data/lib/objects/modules/context.rb

@@ -0,0 +1,13 @@
+module Bcome::Context
+  def is_current_context?
+    ::Bcome::Workspace.instance.object_is_current_context?(self)
+  end
+
+  def irb_workspace=(workspace)
+    @irb_workspace = workspace
+  end
+
+  def previous_irb_workspace=(workspace)
+    @previous_workspace = workspace
+  end
+end

data/lib/objects/modules/registry_management.rb

@@ -0,0 +1,14 @@
+module Bcome::Node::RegistryManagement
+  def user_command_wrapper
+    @user_command_wrapper ||= ::Bcome::Registry::CommandList.instance.group_for_node(self)
+  end
+
+  def registry
+    command_group = user_command_wrapper
+    if command_group && command_group.has_commands?
+      command_group.pretty_print
+    else
+      puts "\nYou have no registry commands configured for this namespace.\n".warning
+    end
+  end
+end

data/lib/objects/modules/ui_output.rb

@@ -0,0 +1,9 @@
+module Bcome::UiOutput
+  def output_error(string)
+    no_console_output(string.error)
+  end
+
+  def no_console_output(string)
+    puts "\t\n#{string}\n\n"
+  end
+end

data/lib/objects/modules/workspace_commands.rb

@@ -0,0 +1,198 @@
+module Bcome::WorkspaceCommands
+  def ls(active_only = false)
+    puts "\n\n" + visual_hierarchy.hierarchy + "\n"
+    puts "\t" + "Available #{list_key}s:".title + "\n\n"
+
+    iterate_over = active_only ? @resources.active : @resources
+
+    if iterate_over.any?
+      iterate_over.sort_by(&:identifier).each do |resource|
+        is_active = @resources.is_active_resource?(resource)
+        puts resource.pretty_description(is_active)
+        puts "\n"
+      end
+    else
+      puts "\tNo resources found".informational
+    end
+
+    new_line
+    nil
+  end
+
+  def lsa
+    show_active_only = true
+    ls(show_active_only)
+  end
+
+  def interactive
+    ::Bcome::Interactive::Session.run(self, :interactive_ssh)
+  end
+
+  def tree
+    puts "\nTree view\n".title
+    tab = ''
+    parents.reverse.each do |p|
+      print_tree_view_for_resource(tab, p)
+      tab = "#{tab}\t"
+    end
+    print_tree_view_for_resource(tab, self)
+    list_in_tree("#{tab}\t", resources)
+    print "\n"
+  end
+
+  def parents
+    ps = []
+    ps << [parent, parent.parents] if has_parent?
+    ps.flatten
+  end
+
+  def list_in_tree(tab, resources)
+    resources.sort_by(&:identifier).each do |resource|
+      next if resource.parent && !resource.parent.resources.is_active_resource?(resource)
+      resource.load_nodes if resource.inventory? && !resource.nodes_loaded?
+      print_tree_view_for_resource(tab, resource)
+      list_in_tree("#{tab}\t", resource.resources)
+    end
+  end
+
+  def print_tree_view_for_resource(tab, resource)
+    separator = '-'
+    tree_item = tab.to_s + separator.resource_key + " #{resource.type.resource_key} \s#{resource.identifier.resource_value}"
+    tree_item += ' (empty set)' if !resource.server? && !resource.resources.has_active_nodes?
+    puts tree_item
+  end
+
+  def cd(identifier)
+    if resource = resources.for_identifier(identifier)
+      if resource.parent.resources.is_active_resource?(resource)
+        ::Bcome::Workspace.instance.set(current_context: self, context: resource)
+      else
+        puts "\nCannot enter context - #{identifier} is disabled. To enable enter 'enable #{identifier}'\n".error
+      end
+    else
+      raise Bcome::Exception::InvalidBreadcrumb, "Cannot find a node named '#{identifier}'"
+      puts "#{identifier} not found"
+    end
+  end
+
+  def run(*raw_commands)
+    raise Bcome::Exception::MethodInvocationRequiresParameter, "Please specify commands when invoking 'run'" if raw_commands.empty?
+    results = {}
+
+    ::Bcome::Ssh::ConnectionHandler.connect(self, {})
+
+    machines.pmap do |machine|
+      commands = machine.do_run(raw_commands)
+      results[machine.namespace] = commands
+    end
+    results
+  end
+
+  def ping
+    ::Bcome::Ssh::ConnectionHandler.connect(self, is_ping: true)
+  end
+
+  def pretty_description(is_active = true)
+    desc = ''
+    list_attributes.each do |key, value|
+      next unless respond_to?(value) || instance_variable_defined?("@#{value}")
+      attribute_value = send(value)
+      next unless attribute_value
+
+      desc += "\t"
+      desc += is_active ? key.to_s.resource_key : key.to_s.resource_key_inactive
+      desc += "\s" * (12 - key.length)
+      attribute_value = value == :identifier ? attribute_value.underline : attribute_value
+      desc += is_active ? attribute_value.resource_value : attribute_value.resource_value_inactive
+      desc += "\n"
+      desc = desc unless is_active
+    end
+    desc
+  end
+
+  def back
+    exit
+  end
+
+  def disable(*ids)
+    ids.each { |id| resources.do_disable(id) }
+  end
+
+  def enable(*ids)
+    ids.each { |id| resources.do_enable(id) }
+  end
+
+  def clear!
+    # Clear any disabled selection at this level and at all levels below
+    resources.clear!
+    resources.each(&:clear!)
+    nil
+  end
+
+  def workon(*ids)
+    resources.disable!
+    ids.each { |id| resources.do_enable(id) }
+    puts "\nYou are now working on '#{ids.join(', ')}\n".informational
+  end
+
+  def disable!
+    resources.disable!
+    resources.each(&:disable!)
+    nil
+  end
+
+  def enable!
+    resources.enable!
+    resources.each(&:enable!)
+    nil
+  end
+
+  ## Helpers --
+
+  def resource_identifiers
+    resources.collect(&:identifier)
+  end
+
+  def is_node_level_method?(method_sym)
+    respond_to?(method_sym) || method_is_available_on_node?(method_sym)
+  end
+
+  def method_missing(method_sym, *arguments)
+    unless method_is_available_on_node?(method_sym)
+      raise NameError, "NameError: undefined local variable or method '#{method_sym}'"
+    end
+
+    if resource_identifiers.include?(method_sym.to_s)
+      method_sym.to_s
+    elsif instance_variable_defined?("@#{method_sym}")
+      instance_variable_get("@#{method_sym}")
+    else
+      command = user_command_wrapper.command_for_console_command_name(method_sym)
+      command.execute(self, arguments)
+    end
+  end
+
+  def method_in_registry?(method_sym)
+    ::Bcome::Registry::CommandList.instance.command_in_list?(self, method_sym)
+  end
+
+  def method_is_available_on_node?(method_sym)
+    resource_identifiers.include?(method_sym.to_s) || instance_variable_defined?("@#{method_sym}") || method_in_registry?(method_sym) || respond_to?(method_sym)
+  end
+
+  def visual_hierarchy
+    tabs = 0
+    hierarchy = ''
+    tree_descriptions.each { |d| hierarchy += "#{"\s\s\s" * tabs}|- #{d}\n"; tabs += 1; }
+    hierarchy
+  end
+
+  def tree_descriptions
+    d = parent ? parent.tree_descriptions + [description] : [description]
+    d.flatten
+  end
+
+  def new_line
+    puts "\n"
+  end
+end

data/lib/objects/modules/workspace_menu.rb

@@ -0,0 +1,128 @@
+module Bcome::WorkspaceMenu
+  def menu
+    print "\n\n"
+    puts "#{mode} menu".title + "\sfor #{self.class} #{namespace}".resource_value + "\n\n"
+    enabled_menu_items.each_with_index do |menu_item, _index|
+      item = menu_items[menu_item]
+      next if !::Bcome::System::Local.instance.in_console_session? && item[:console_only]
+      puts tab_spacing + menu_item.to_s.resource_key + item_spacing(menu_item) + (menu_items[menu_item][:description]).to_s.resource_value
+      if item[:usage] || item[:terminal_usage]
+        usage_string = ::Bcome::System::Local.instance.in_console_session? ? item[:usage] : "bcome #{keyed_namespace.empty? ? '' : "#{keyed_namespace}:"}#{item[:terminal_usage]}"
+        puts tab_spacing + ("\s" * menu_item_spacing_length) + 'usage: '.instructional + usage_string
+      end
+      puts "\n"
+    end
+
+    nil
+  end
+
+  def mode
+    ::Bcome::System::Local.instance.in_console_session? ? 'Console' : 'Terminal'
+  end
+
+  def item_spacing(item)
+    "\s" * (menu_item_spacing_length - item.length)
+  end
+
+  def menu_item_spacing_length
+    16
+  end
+
+  def tab_spacing
+    "\s" * 3
+  end
+
+  def menu_items
+    {
+      ls: {
+        description: 'list all available resources',
+        console_only: false
+      },
+      lsa: {
+        description: 'list all active resources',
+        console_only: true
+      },
+      workon: {
+        description: 'work on specific resources only, inactivating all others from this selection',
+        usage: 'workon identifier1, identifier2 ...',
+        console_only: true
+      },
+      disable: {
+        description: 'remove a resource from this selection',
+        usage: 'disable identifier1, identifier2 ...',
+        console_only: true
+      },
+      enable: {
+        description: 're-enable a resource within this selection',
+        usage: 'enable identifier1, identifier2 ...',
+        console_only: true
+      },
+      enable!: {
+        description: 'enable all resources within this selection',
+        console_only: true
+      },
+      disable!: {
+        description: 'disable all resources within this selection',
+        console_only: true
+      },
+      run: {
+        description: 'execute a command to be run over ssh against all active resources',
+        usage: "run 'command1', 'command2', ...",
+        console_only: false,
+        terminal_usage: "run 'command1' 'command2' ..."
+      },
+      interactive: {
+        description: 'enter an interactive command session for all active resources',
+        console_only: false
+      },
+      tree: {
+        description: 'print a tree view for all resources and their sub-resources',
+        console_only: false
+      },
+      ping: {
+        description: 'ping all resources to test connectivity',
+        console_only: false
+      },
+      put: {
+        description: 'upload a file or directory using scp',
+        usage: "put 'local/path','remote/path'",
+        console_only: false,
+        terminal_usage: "put 'local/path' 'remote/path'"
+      },
+      rsync: {
+        description: 'upload a file or directory using rsync (faster)',
+        usage: "rsync 'local/path','remote/path'",
+        console_only: false,
+        terminal_usage: "rsync 'local/path' 'remote/path'"
+      },
+      get: {
+        description: 'download a file',
+        usage: "get 'remote/path', 'local/path'",
+        console_only: false,
+        terminal_usage: "get 'remote/path' 'local/path"
+      },
+      cd: {
+        description: 'enter the namespace for a resource from this selection',
+        usage: 'cd identifier',
+        console_only: true
+      },
+      save: {
+        description: 'Save the current tree state',
+        console_only: true
+      },
+      meta: {
+        description: 'Print out all metadata related to this node'
+      },
+      registry: {
+        description: 'List all user defined commands present in your registry, and available to this namespace',
+        console_only: false
+      },
+      execute_script: {
+        description: 'execute a bash script',
+        console_only: false,
+        usage: 'execute_script "script_name"',
+        terminal_usage: 'execute_script script_name'
+      }
+    }
+  end
+end