bcome 1.4.0 → 2.0.0

data/lib/objects/node/inventory/base.rb

@@ -30,7 +30,7 @@ module Bcome
         end
 
         def enabled_menu_items
-          super + %i[ssh]
+          super + %i[ssh tags]
         end
 
         def menu_items
@@ -38,14 +38,20 @@ module Bcome
           base_items[:ssh] = {
             description: 'ssh directly into a resource',
             usage: 'ssh identifier',
-            console_only: true
+            console_only: true,
+            group: :ssh
+          }
+
+          base_items[:tags] = {
+            description: 'print out server tags/labels',
+            group: :informational
           }
 
           base_items
         end
 
         def resources
-          @resources ||= ::Bcome::Node::Resources::Inventory.new
+          @resources ||= ::Bcome::Node::Resources::Inventory.new(self)
         end
 
         def ssh(identifier = nil)

data/lib/objects/node/inventory/defined.rb

@@ -6,7 +6,7 @@ module Bcome
       class Defined < ::Bcome::Node::Inventory::Base
         include ::Bcome::LoadingBar::Handler
 
-        MACHINES_CACHE_PATH = 'machines-cache.yml'
+        MACHINES_CACHE_PATH = 'static-cache.yml'
 
         attr_reader :dynamic_nodes_loaded
 
@@ -17,15 +17,22 @@ module Bcome
         end
 
         def enabled_menu_items
-          super + %i[save reload]
+          super + %i[cache reload]
         end
 
         def menu_items
           base_items = super.dup
 
+          base_items[:cache] = {
+            description: 'Cache the current tree state',
+            console_only: false,
+            group: :miscellany
+          }
+
           base_items[:reload] = {
-            description: "Restock this inventory from remote (hit 'save' after to persist)",
-            console_only: true
+            description: "Restock this inventory from remote (hit 'cache' after to persist)",
+            console_only: true,
+            group: :miscellany
           }
           base_items
         end
@@ -40,7 +47,9 @@ module Bcome
           cached_machines = raw_static_machines_from_cache
 
           if cached_machines&.any?
-            wrap_indicator type: :basic, title: 'Loading' + "\sCACHE".bc_blue.bold + "\s" + namespace.to_s.underline, completed_title: '' do
+            print "\n"
+            title = 'Loading' + "\sCACHE".bc_orange.bold + "\s" + namespace.to_s.underline
+            wrap_indicator type: :basic, title: title, completed_title: '' do
               cached_machines.each do |server_config|
                 resources << ::Bcome::Node::Server::Static.new(views: server_config, parent: self)
               end
@@ -57,13 +66,7 @@ module Bcome
           "#{::Bcome::Node::Factory::CONFIG_PATH}/#{MACHINES_CACHE_PATH}"
         end
 
-        def mark_as_cached!
-          data = ::Bcome::Node::Factory.instance.load_estate_config
-          data[namespace.to_sym][:load_machines_from_cache] = true
-          ::Bcome::Node::Factory.instance.rewrite_estate_config(data)
-        end
-
-        def save
+        def cache
           @answer = ::Bcome::Interactive::Session.run(self,
                                                       :capture_input, terminal_prompt: 'Are you sure you want to cache these machines (saving will overwrite any previous selections) [Y|N] ? ')
 
@@ -79,8 +82,7 @@ module Bcome
             File.open(machines_cache_path, 'w') do |file|
               file.write data.to_yaml
             end
-            mark_as_cached!
-            puts "\nMachines have been cached for node #{namespace}".informational
+            puts "\nMachines have been cached to #{machines_cache_path} for node #{namespace}".informational
           else
             puts 'Nothing saved'.warning
           end
@@ -106,7 +108,8 @@ module Bcome
 
         def load_nodes
           set_static_servers
-          load_dynamic_nodes unless @load_machines_from_cache
+          load_dynamic_nodes unless resources.any?
+          nodes_loaded!
         end
 
         def load_dynamic_nodes

data/lib/objects/node/inventory/merge.rb

@@ -12,7 +12,15 @@ module Bcome
         end
 
         def nodes_loaded?
-          true
+          !contributing_inventories.collect(&:nodes_loaded?).include?(false)
+        end
+
+        def load_nodes
+          contributing_inventories.each do |inventory|
+            inventory.load_nodes unless inventory.nodes_loaded?
+          end
+
+          resources
         end
 
         def contributing_inventories

data/lib/objects/node/inventory/subselect.rb

@@ -20,7 +20,8 @@ module Bcome
 
           base_items[:reload] = {
             description: 'Restock this inventory from remote',
-            console_only: true
+            console_only: true,
+            group: :miscellany
           }
           base_items
         end
@@ -34,7 +35,7 @@ module Bcome
         end
 
         def do_set_resources
-          ::Bcome::Node::Resources::SubselectInventory.new(parent_inventory: parent_inventory, filters: filters)
+          ::Bcome::Node::Resources::SubselectInventory.new(origin_inventory: self, parent_inventory: parent_inventory, filters: filters)
         end
 
         def nodes_loaded?
@@ -42,8 +43,7 @@ module Bcome
         end
 
         def filters
-          # Flex point for filters, as obviously we need to support more than just ec2 filtering eventually
-          @views[:filters] || {}
+          @views[:sub_filter] || @views[:filters] || {}
         end
 
         def reload
@@ -65,6 +65,8 @@ module Bcome
         end
 
         def load_parent_inventory
+          raise ::Bcome::Exception::Generic, "Missing 'subselect_from' attribute on inventory-subselect with config #{@views}" unless @views[:subselect_from]
+
           parent_crumb = @views[:subselect_from]
           parent = ::Bcome::Node::Factory.instance.bucket[parent_crumb]
           raise Bcome::Exception::CannotFindSubselectionParent, "for key '#{parent_crumb}'" unless parent

data/lib/objects/node/meta_data_factory.rb

@@ -16,7 +16,7 @@ module Bcome::Node::LocalMetaDataFactory
   end
 
   def raw_metadata
-    has_parent? ? parent.raw_metadata.merge(metadata_for_namespace) : metadata_for_namespace
+    has_parent? ? parent.raw_metadata.deep_merge(metadata_for_namespace) : metadata_for_namespace
   end
 
   def metadata_for_namespace

data/lib/objects/node/meta_data_loader.rb

@@ -30,7 +30,7 @@ module Bcome::Node
     end
 
     def prompt_for_decryption_key
-      decryption_key_prompt = 'Enter your metadata decryption key: '.informational
+      decryption_key_prompt = 'Enter your Metadata key: '.informational
 
       print "\n#{decryption_key_prompt}"
       @decryption_key = STDIN.noecho(&:gets).chomp
@@ -62,7 +62,7 @@ module Bcome::Node
 
         begin
           filedata = load_file_data_for(filepath)
-          all_meta_data.deep_merge!(filedata)
+          all_meta_data.deep_merge!(filedata) if filedata.is_a?(Hash)
         rescue Psych::SyntaxError => e
           raise Bcome::Exception::InvalidMetaDataConfig, "Error: #{e.message}"
         end

data/lib/objects/node/resources/inventory.rb

@@ -2,7 +2,26 @@
 
 module Bcome::Node::Resources
   class Inventory < Bcome::Node::Resources::Base
+    def initialize(inventory)
+      @inventory = inventory
+      super
+    end
+
+    def set_overrides(inventory, node)
+      override_server_identifier(inventory, node)
+      node.set_network_configuration_overrides
+    end
+
+    def override_server_identifier(inventory, node)
+      if inventory.override_server_identifier?
+        node.identifier =~ /#{inventory.override_identifier}/
+        node.update_identifier(Regexp.last_match(1)) if Regexp.last_match(1)
+      end
+    end
+
     def <<(node)
+      set_overrides(@inventory, node)
+
       if existing_node = for_identifier(node.identifier)
         if existing_node.static_server? && node.dynamic_server?
           # We've got a duplicate, but we'll treat the remote node as authoritative

data/lib/objects/node/resources/merged.rb

@@ -5,34 +5,43 @@ module Bcome::Node::Resources
     def initialize(config)
       super
       @inventory = config[:inventory]
+      @nodes = []
       run_select
     end
 
     def run_select
-      @inventory.contributing_inventories.each { |inventory| inventory.load_nodes unless inventory.nodes_loaded? }
-      @nodes = @inventory.contributing_inventories.collect { |inv| inv.resources.nodes }.flatten.collect(&:clone)
+      @inventory.contributing_inventories.each do |inventory|
+        raise ::Bcome::Exception::Generic, "#{inventory.namespace} is not an inventory, and cannot be merged." unless inventory.is_a?(::Bcome::Node::Inventory::Base)
 
-      @nodes.map do |node|
-        node.add_list_attributes(origin: :origin_namespace)
+        inventory.load_nodes unless inventory.nodes_loaded?
       end
 
+      contributing_nodes = @inventory.contributing_inventories.collect { |inv| inv.resources.nodes }.flatten
+      dup_nodes(contributing_nodes)
+
       @nodes
     end
 
-    def update_nodes
-      new_set = []
+    def dup_nodes(contributing_nodes)
+      contributing_nodes.each do |original_node|
+        # Duplicate the node, setting its origin inventory to this one, and
+        # resetting its ssh_driver to the original node's driver.
+        new_node = original_node.dup_with_new_parent(@inventory)
+        set_overrides(@inventory, new_node)
+        new_node.ssh_driver = original_node.ssh_driver
+
+        # Rename the node as contributing inventories may provide duplicate node names
+        rename_node_for_merged_inventory(original_node, new_node)
 
-      @nodes.collect do |node|
-        new_node = node.dup_with_new_parent(@inventory)
-        if @inventory.override_server_identifier?
-          new_node.identifier =~ /#{@inventory.override_identifier}/
-          new_node.update_identifier(Regexp.last_match(1)) if Regexp.last_match(1)
-        end
         # Register the new node with the registry
         ::Bcome::Registry::Loader.instance.set_command_group_for_node(new_node)
-        new_set << new_node
+
+        @nodes << new_node
       end
-      @nodes = new_set
+    end
+
+    def rename_node_for_merged_inventory(original_node, new_node)
+      new_node.identifier = original_node.namespace.gsub(':', '_')
     end
   end
 end

data/lib/objects/node/resources/sub_inventory.rb

@@ -24,10 +24,7 @@ module Bcome::Node::Resources
 
       @nodes.collect do |node|
         new_node = node.dup_with_new_parent(inventory)
-        if inventory.override_server_identifier?
-          new_node.identifier =~ /#{inventory.override_identifier}/
-          new_node.update_identifier(Regexp.last_match(1)) if Regexp.last_match(1)
-        end
+        set_overrides(inventory, new_node)
 
         # Register the new node with the registry
         ::Bcome::Registry::Loader.instance.set_command_group_for_node(new_node)
@@ -53,11 +50,15 @@ module Bcome::Node::Resources
     end
 
     def tag_filters
-      filters[:by_tag] || filters[:by_label] || {}
+      filters[:by_tag] || filters[:by_label] || filters
     end
 
     def parent_inventory
       @config[:parent_inventory]
     end
+
+    def origin_inventory
+      @config[:origin_inventory]
+    end
   end
 end

data/lib/objects/node/server/base.rb

@@ -1,7 +1,4 @@
 # frozen_string_literal: true
-
-require 'awesome_print'
-
 module Bcome::Node::Server
   class Base < Bcome::Node::Base
     attr_reader :origin_object_id
@@ -12,14 +9,21 @@ module Bcome::Node::Server
       @origin_object_id = object_id
     end
 
+    def is_same_machine?(other)
+      origin_object_id == other.origin_object_id
+    end
+
     def host
       raise 'Should be overidden'
     end
 
-    # override a server namespace's parameters. This enables features such as specific SSH parameters for a specific server, e.g. my use case was a
-    # single debian box within an ubuntu network, where I needed to access the machine with the 'admin' rather 'ubuntu' username.
     def set_view_attributes
       super
+    end
+
+    # Override a server's namespace parameters. Enabled features such as specific SSH config for a particular server, i.e. overidding that of it's parent
+    #  inventory namespace.
+    def set_network_configuration_overrides
       overridden_attributes = ::Bcome::Node::Factory.instance.machines_data_for_namespace(namespace.to_sym)
       overridden_attributes.each do |override_key, override_value|
         singleton_class.class_eval do
@@ -30,6 +34,10 @@ module Bcome::Node::Server
       end
     end
 
+    def local_network?
+      defined?(local_network) && local_network
+    end
+
     def dup_with_new_parent(new_parent)
       new_node = clone
       new_node.update_parent(new_parent)
@@ -44,6 +52,10 @@ module Bcome::Node::Server
       data_print_from_hash(cloud_tags.data, 'Tags')
     end
 
+    def tags_h
+      cloud_tags.data
+    end
+
     def cloud_tags
       @generated_tags ||= do_generate_cloud_tags
     end
@@ -82,34 +94,39 @@ module Bcome::Node::Server
     end
 
     def enabled_menu_items
-      (super + %i[get ssh tags pseudo_tty tunnel]) - %i[enable disable enable! disable!]
+      (super + %i[get ssh tags pseudo_tty tunnel]) - %i[workon enable disable enable! disable!]
     end
 
     def menu_items
       base_items = super.dup
       base_items[:tags] = {
-        description: 'print out remote EC2 tags'
+        description: 'print out server tags/labels',
+        group: :informational
       }
       base_items[:ssh] = {
-        description: 'initiate an ssh connection to this server'
+        description: 'initiate an ssh connection to this server',
+        group: :ssh
       }
       base_items[:get] = {
         description: 'Download a file or directory',
         console_only: false,
         usage: 'get "/remote/path", "/local/path"',
-        terminal_usage: 'get "/remote/path" "/local/path"'
+        terminal_usage: 'get "/remote/path" "/local/path"',
+        group: :file
       }
       base_items[:pseudo_tty] = {
         description: 'Invoke a pseudo-tty session',
         console_only: false,
         usage: 'pseudo_tty "your command"',
-        terminal_usage: 'pseudo_tty "your command"'
+        terminal_usage: 'pseudo_tty "your command"',
+        group: :ssh
       }
       base_items[:tunnel] = {
         description: 'Create a Tunnel over SSH',
         console_only: false,
         usage: 'tunnel(local_port, destination_port)',
-        terminal_usage: 'tunnel local_port destination_port'
+        terminal_usage: 'tunnel local_port destination_port',
+        group: :ssh
       }
 
       base_items
@@ -186,17 +203,13 @@ module Bcome::Node::Server
     end
 
     def print_ping_result(ping_result = { success: true })
-      result = {
-        namespace => {
-          'connection' => ping_result[:success] ? 'success' : 'failed',
-          'ssh_config' => ssh_driver.pretty_ssh_config
-        }
-      }
-
-      result[namespace]['error'] = ping_result[:error].message if !ping_result[:success] && ping_result[:error]
-      colour = ping_result[:success] ? :green : :red
+      result_string = ping_result[:success] ? 'success'.success : 'failed'.error
 
-      ap(result, indent: -2, color:  { hash: colour, symbol: colour, string: colour, keyword: colour, variable: colour, array: 'cyan' })
+      pretty_ping_result = "\n#{namespace.bc_cyan}:\s#{result_string.bold}\n"
+      pretty_ping_result += "Error:\s".bc_cyan + "#{ping_result[:error].message.bc_red}\n" if !ping_result[:success] && ping_result[:error]
+      # pretty_ping_result += ping_result[:backtrace] if ping_result[:backtrace]
+      pretty_ping_result += "config:\s".bc_cyan + JSON.pretty_generate(ssh_driver.pretty_ssh_config)
+      puts pretty_ping_result
     end
 
     def add_list_attributes(attrs)
@@ -223,7 +236,7 @@ module Bcome::Node::Server
     end
 
     def cache_data
-      d = { identifier: identifier }
+      d = { identifier: @original_identifier }
       d[:internal_ip_address] = internal_ip_address if internal_ip_address
       d[:public_ip_address] = public_ip_address if public_ip_address
       d[:description] = description if description

data/lib/objects/node/server/dynamic/ec2.rb

@@ -9,7 +9,6 @@ module Bcome::Node::Server::Dynamic
 
       def new_from_fog_instance(fog_instance, parent)
         identifier = fog_instance.tags['Name']
-        identifier = override_identifier(parent, identifier)
 
         params = {
           identifier: identifier,

data/lib/objects/node/server/dynamic/gcp.rb

@@ -9,7 +9,6 @@ module Bcome::Node::Server::Dynamic
 
       def new_from_gcp_instance(gcp_instance, parent)
         identifier = gcp_instance.name
-        identifier = override_identifier(parent, identifier)
 
         ## For now we support only the first network interface
         first_interface = gcp_instance.network_interfaces.first