bcome 1.4.0 → 2.0.0

data/lib/objects/modules/workspace_commands.rb

@@ -13,14 +13,14 @@ module Bcome
         puts "\n\n" + visual_hierarchy.hierarchy + "\n"
         puts "\t" + "Available #{list_key}s:" + "\n\n"
 
-        iterate_over = active_only ? @resources.active : @resources
+        iterate_over = active_only ? resources.active : resources
 
         if iterate_over.any?
 
           iterate_over.sort_by(&:identifier).each do |resource|
             next if resource.hide?
 
-            is_active = @resources.is_active_resource?(resource)
+            is_active = resources.is_active_resource?(resource)
             puts resource.pretty_description(is_active)
 
             puts "\n"
@@ -43,38 +43,12 @@ module Bcome
       ::Bcome::Interactive::Session.run(self, :interactive_ssh)
     end
 
-    def tree
-      puts "\nTree view\n".title
-      tab = ''
-      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)
-        next if resource.hide?
-
-        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)
@@ -124,10 +98,6 @@ module Bcome
       desc
     end
 
-    def back
-      exit
-    end
-
     def disable(*ids)
       ids.each { |id| resources.do_disable(id) }
     end

data/lib/objects/modules/workspace_menu.rb

@@ -4,20 +4,43 @@ module Bcome
   module 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 'COMMAND MENU'.bc_cyan + "\sfor #{self.class} #{namespace}".resource_value
 
-        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]}"
+      grouped_menu_items = menu_items.group_by { |m| m[1][:group] }
+      grouped_menu_items.each do |group_key, items|
+        # If we're not in a console session, we filter out console only methods
+        items = items.reject { |item| item[1][:console_only] } unless ::Bcome::System::Local.instance.in_console_session?
+
+        next if items.empty?
+
+        s_heading = "/ #{menu_group_names[group_key]}"
+        print "\n\n" + tab_spacing + s_heading.upcase.bc_cyan
+        print item_spacing(s_heading) + ("\s" * 110).to_s.bc_cyan.underline
+        print "\n\n"
+        print_menu_items(items)
+      end
+
+      nil
+    end
+
+    def print_menu_items(items)
+      items.each_with_index do |item, _index|
+        key = item[0]
+        config = item[1]
+
+        next if !::Bcome::System::Local.instance.in_console_session? && config[:console_only]
+
+        puts tab_spacing + key.to_s.resource_key + item_spacing(key) + (config[:description]).to_s.resource_value
+        if config[:usage] || config[:terminal_usage]
+          usage_string = if ::Bcome::System::Local.instance.in_console_session?
+                           config[:usage]
+                         else
+                           "bcome #{keyed_namespace.empty? ? '' : "#{keyed_namespace}:"}#{config[:terminal_usage]}"
+                         end
           puts tab_spacing + ("\s" * menu_item_spacing_length) + 'usage: '.instructional + usage_string
         end
         puts "\n"
       end
-
-      nil
     end
 
     def mode
@@ -36,102 +59,144 @@ module Bcome
       "\s" * 3
     end
 
+    def menu_group_names
+      {
+        ssh: 'Ssh',
+        informational: 'Informational',
+        selection: 'Selections',
+        file: 'File & Script',
+        navigation: 'Navigational',
+        miscellany: 'Miscellaneous',
+        command_list: 'Command lists'
+      }
+    end
+
     def menu_items
       {
+        routes: {
+          description: 'Print SSH routing tree',
+          console_only: false,
+          group: :informational
+        },
         ls: {
-          description: 'list all available resources',
-          console_only: false
+          description: 'list all available namespaces',
+          console_only: false,
+          group: :informational
         },
         lsa: {
-          description: 'list all active resources',
-          console_only: true
+          description: 'list all active namespaces',
+          console_only: true,
+          group: :informational
         },
         workon: {
-          description: 'work on specific resources only, inactivating all others from this selection',
+          description: 'work on specific namespaces only, inactivating all others from this selection',
           usage: 'workon identifier1, identifier2 ...',
-          console_only: true
+          console_only: true,
+          group: :selection
         },
         disable: {
-          description: 'remove a resource from this selection',
+          description: 'remove a namespace from this selection',
           usage: 'disable identifier1, identifier2 ...',
-          console_only: true
+          console_only: true,
+          group: :selection
         },
         enable: {
-          description: 're-enable a resource within this selection',
+          description: 're-enable a namespace within this selection',
           usage: 'enable identifier1, identifier2 ...',
-          console_only: true
+          console_only: true,
+          group: :selection
         },
         enable!: {
-          description: 'enable all resources within this selection',
-          console_only: true
+          description: 'enable all namespaces within this selection',
+          console_only: true,
+          group: :selection
         },
         disable!: {
-          description: 'disable all resources within this selection',
-          console_only: true
+          description: 'disable all namespaces within this selection',
+          console_only: true,
+          group: :selection
         },
         run: {
-          description: 'execute a command to be run over ssh against all active resources',
+          description: 'execute a command to be run over ssh against all active namespaces',
           usage: "run 'command1', 'command2', ...",
           console_only: false,
-          terminal_usage: "run 'command1' 'command2' ..."
+          terminal_usage: "run 'command1' 'command2' ...",
+          group: :ssh
         },
         interactive: {
-          description: 'enter an interactive command session for all active resources',
-          console_only: false
+          description: 'enter an interactive command session for all active namespaces',
+          console_only: false,
+          group: :ssh
         },
         tree: {
-          description: 'print a tree view for all resources and their sub-resources',
-          console_only: false
+          description: 'print a tree view for all namespaces and their sub-namespaces',
+          console_only: false,
+          group: :informational
         },
         ping: {
-          description: 'ping all resources to test connectivity',
-          console_only: false
+          description: 'ping all namespaces to test connectivity',
+          console_only: false,
+          group: :ssh
         },
         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'"
+          terminal_usage: "put 'local/path' 'remote/path'",
+          group: :file
         },
         put_str: {
           description: 'Write a file /to/remote/path from a string',
           usage: 'put_str "string" "remote/path"',
           console_only: false,
-          terminal_usage: "put_str '<file contents>', 'remote/path'"
+          terminal_usage: "put_str '<file contents>', 'remote/path'",
+          group: :file
         },
         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"
+          terminal_usage: "rsync 'local/path' 'remote/path'",
+          group: :file
         },
         cd: {
-          description: 'enter the namespace for a resource from this selection',
+          description: 'enter a console session for a child namespace from this selection',
           usage: 'cd identifier',
-          console_only: true
+          console_only: true,
+          group: :navigation
+        },
+        quit: {
+          description: 'Quit out of bcome',
+          usage: 'quit',
+          console_only: true,
+          group: :navigation
         },
-        save: {
-          description: 'Save the current tree state',
-          console_only: true
+        back: {
+          description: 'Go back up a namespace, or quit',
+          usage: 'back',
+          console_only: true,
+          group: :navigation
         },
         meta: {
-          description: 'Print out all metadata related to this node'
+          description: 'Print out all metadata related to this node',
+          group: :informational
         },
         registry: {
           description: 'List all user defined commands present in your registry, and available to this namespace',
-          console_only: false
+          console_only: false,
+          group: :command_list
+        },
+        menu: {
+          description: 'List all available commands',
+          console_only: false,
+          group: :command_list
         },
         execute_script: {
           description: 'execute a bash script',
           console_only: false,
           usage: 'execute_script "script_name"',
-          terminal_usage: 'execute_script script_name'
+          terminal_usage: 'execute_script script_name',
+          group: :ssh
         }
       }
     end

data/lib/objects/node/attributes.rb

@@ -7,6 +7,10 @@ module Bcome::Node::Attributes
     @identifier
   end
 
+  def ssh_driver=(alternative_ssh_driver)
+    @ssh_driver = alternative_ssh_driver
+  end
+
   def ssh_driver
     @ssh_driver ||= ::Bcome::Ssh::Driver.new(ssh_data, self)
   end
@@ -19,6 +23,8 @@ module Bcome::Node::Attributes
     recurse_hash_data_for_instance_key(:network, :network_data)
   end
 
+  # From 2.0.0 onwards, filters can be loaded from the network block only. The older key, 'ec2_filters'
+  #  is retained at this level for backwards compatibility.
   def filters
     recurse_hash_data_for_instance_key(:ec2_filters, :filters)
   end

data/lib/objects/node/base.rb

@@ -8,6 +8,7 @@ module Bcome::Node
     include Bcome::WorkspaceMenu
     include Bcome::Node::LocalMetaDataFactory
     include Bcome::Node::RegistryManagement
+    include Bcome::Tree
 
     def inspect
       "<##{self.class}: #{namespace} @network_driver=#{network_driver}>"
@@ -34,10 +35,13 @@ module Bcome::Node
       @parent = params[:parent]
       @type = params[:type]
       @metadata = {}
+      @nodes_loaded = false
 
       set_view_attributes if @views
       validate_attributes
 
+      @original_identifier = @identifier
+
       ::Bcome::Registry::Loader.instance.set_command_group_for_node(self)
     end
 
@@ -87,6 +91,14 @@ module Bcome::Node
       ssh_driver.proxy
     end
 
+    def proxy_chain
+      ssh_driver.proxy_chain
+    end
+
+    def proxy_chain_link
+      @proxy_chain_link ||= ::Bcome::Ssh::ProxyChainLink.new(self)
+    end
+
     def scoped_resources
       # Active & not hidden
       resources.active.reject(&:hide?)
@@ -117,7 +129,7 @@ module Bcome::Node
 
     def put_str(string, remote_path, connect = true)
       ssh_connect if connect # Initiate connect at highest namespace level
-      scoped_resources.each do |resource|
+      scoped_resources.pmap do |resource|
         resource.put_str(string, remote_path, false)
       end
       nil
@@ -169,7 +181,13 @@ module Bcome::Node
     end
 
     def nodes_loaded?
-      resources.any?
+      # resources.any? # This was buggy:  an inventory may validly contain no resources. This does not mean that we haven't attempted to load them
+      # we no explicitly set a flag for when we've loaded nodes. This will prevents uneccessary lookups over the wire
+      @nodes_loaded
+    end
+
+    def nodes_loaded!
+      @nodes_loaded = true
     end
 
     def resources
@@ -214,7 +232,11 @@ module Bcome::Node
     end
 
     def prompt_breadcrumb
-      "#{has_parent? ? "#{parent.prompt_breadcrumb}> " : ''}#{current_context? ? (has_parent? ? identifier.terminal_prompt : identifier) : identifier}"
+      "#{has_parent? ? "#{parent.prompt_breadcrumb}> " : ''}#{if current_context?
+                                                                has_parent? ? identifier.terminal_prompt : identifier
+                                                              else
+                                                                identifier
+                                                              end}"
     end
 
     def namespace
@@ -244,13 +266,13 @@ module Bcome::Node
 
     def close_ssh_connections
       # For every loaded server, we'll close any lingering ssh connection
-      if resources.any?
+      if @resources&.any?
         resources.pmap do |resource|
           if resource.is_a?(::Bcome::Node::Server::Base)
             resource.close_ssh_connection
           else
             resource.close_ssh_connections
-           end
+          end
         end
       end
       nil
@@ -304,8 +326,6 @@ module Bcome::Node
       [:views]
     end
 
-    private
-
     def to_ary
       # due to my method_missing implementation, the following is required.
       # with thanks to https://tenderlovemaking.com/2011/06/28/til-its-ok-to-return-nil-from-to_ary.html & http://yehudakatz.com/2010/01/02/the-craziest-fing-bug-ive-ever-seen/

data/lib/objects/node/cache_handler.rb

@@ -13,7 +13,7 @@ module Bcome::Node
     end
 
     def write_to_in_memory_cache!(nodes)
-      @inventory_node.views[:load_machines_from_cache] = true
+      # @inventory_node.views[:load_machines_from_cache] = true
       static_server_data = dynamic_nodes_to_cache_hash(nodes)
       @inventory_node.views[:static_servers] = static_server_data
       nil

data/lib/objects/node/factory.rb

@@ -8,7 +8,7 @@ module Bcome::Node
 
     CONFIG_PATH = 'bcome'
     DEFAULT_CONFIG_NAME = 'networks.yml'
-    SERVER_OVERRIDE_CONFIG_NAME = 'machines-data.yml'
+    SERVER_OVERRIDE_CONFIG_NAME = 'server-overrides.yml'
     LOCAL_OVERRIDE_CONFIG_NAME = 'me.yml'
 
     INVENTORY_KEY = 'inventory'
@@ -24,6 +24,7 @@ module Bcome::Node
     end
 
     def init_tree
+      raise ::Bcome::Exception::EmptyNamespaceTree, "no namespaces found in #{config_path}.\n\nPlease refer to the documentation for assistance at https://docs.bcome.com." if estate_config.nil?
       @estate = create_node(estate_config)
       @estate
     end
@@ -55,7 +56,7 @@ module Bcome::Node
     end
 
     def create_node(config, parent = nil)
-      raise Bcome::Exception::InvalidNetworkConfig, 'missing config type' unless config[:type]
+      raise Bcome::Exception::InvalidNetworkConfig, "missing config type for config #{config}" unless config[:type]
 
       klass = klass_for_view_type[config[:type]]
 
@@ -65,6 +66,11 @@ module Bcome::Node
       create_tree(node, config[:views]) if config[:views]&.any?
       parent.resources << node if parent
 
+      # Load inventory resources as early as possible
+      if node.is_a?(Bcome::Node::Inventory::Base)
+        node.load_nodes unless node.nodes_loaded?
+      end
+
       bucket[node.keyed_namespace] = node
 
       node
@@ -73,7 +79,6 @@ module Bcome::Node
     def validate_view(breadcrumb, data)
       raise Bcome::Exception::InvalidNetworkConfig, "Missing namespace type for namespace '#{breadcrumb}'" unless data && data[:type]
 
-
       raise Bcome::Exception::InvalidNetworkConfig, "Invalid View Type '#{data[:type]}' for namespace '#{breadcrumb}'. Expecting View Type to be one of: #{klass_for_view_type.keys.join(', ')}" unless is_valid_view_type?(data[:type])
     end
 
@@ -103,12 +108,6 @@ module Bcome::Node
       machines_data[namespace] || {}
     end
 
-    def rewrite_estate_config(data)
-      File.open(config_path, 'w') do |file|
-        file.write data.to_yaml
-      end
-    end
-
     def load_estate_config
       config = YAML.load_file(config_path).deep_symbolize_keys
       config.deep_merge(local_data)
@@ -134,13 +133,18 @@ module Bcome::Node
     end
 
     def local_data_path
-      "#{CONFIG_PATH}/#{LOCAL_OVERRIDE_CONFIG_NAME}"
+      ENV['ME'] || "#{CONFIG_PATH}/#{LOCAL_OVERRIDE_CONFIG_NAME}"
     end
 
     def load_local_data
       return {} unless File.exist?(local_data_path)
 
-      config = YAML.load_file(local_data_path)
+      begin
+        config = YAML.load_file(local_data_path).deep_symbolize_keys
+      rescue StandardError => e
+        raise ::Bcome::Exception::Generic, "Error parsing configuration file #{local_data_path}"
+      end
+
       return {} if config.nil?
 
       config