bcome 0.7.0 → 1.0.0

data/lib/objects/node/attributes.rb

@@ -0,0 +1,47 @@
+module Bcome::Node::Attributes
+  ## -- Attributes --
+
+  def identifier
+    @identifier
+  end
+
+  def description
+    @description
+  end
+
+  def type
+    @type
+  end
+
+  def ssh_driver
+    @ssh_driver ||= ::Bcome::Ssh::Driver.new(ssh_data, self)
+  end
+
+  def ssh_data
+    instance_var_name = '@ssh_settings'
+    recurse_hash_data_for_instance_var(instance_var_name, :ssh_data)
+  end
+
+  def network_driver
+    return nil if !network_data || (network_data.is_a?(Hash) && network_data.empty?)
+    @network_driver ||= ::Bcome::Driver::Bucket.instance.driver_for_network_data(network_data)
+    @network_driver
+  end
+
+  def filters
+    instance_var_name = '@ec2_filters'
+    recurse_hash_data_for_instance_var(instance_var_name, :filters)
+  end
+
+  def network_data
+    instance_var_name = '@network'
+    recurse_hash_data_for_instance_var(instance_var_name, :network_data)
+  end
+
+  def recurse_hash_data_for_instance_var(instance_var_name, parent_key)
+    instance_data = instance_variable_defined?(instance_var_name) ? instance_variable_get(instance_var_name) : {}
+    instance_data ||= {}
+    instance_data = parent.send(parent_key).merge(instance_data) if has_parent?
+    instance_data
+  end
+end

data/lib/objects/node/base.rb

@@ -0,0 +1,248 @@
+module Bcome::Node
+  class Base
+
+    include Bcome::Context
+    include Bcome::WorkspaceCommands
+    include Bcome::Node::Attributes
+    include Bcome::WorkspaceMenu
+    include Bcome::Node::LocalMetaDataFactory
+    include Bcome::Node::RegistryManagement
+ 
+    DEFAULT_IDENTIFIER = "bcome"
+
+    def self.const_missing(constant)
+      ## Hook for direct access to node level resources by constant name where
+      ## cd ServerName should yield the same outcome as cd "ServerName"
+      set_context  = ::IRB.CurrentContext.workspace.main
+      return (set_context.resource_for_identifier(constant.to_s)) ? constant.to_s : super
+    end
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+      @identifier = nil
+      @description = nil
+      @views = params[:views]
+      @parent = params[:parent]
+      @type = params[:type]
+      @metadata = {}
+
+      set_view_attributes if @views
+      validate_attributes
+      ::Bcome::Registry::Loader.instance.set_command_group_for_node(self)
+    end
+
+    def bootstrap?
+      false
+    end
+
+    def collection?
+      false
+    end
+
+    def inventory?
+      false
+    end
+
+    def server?
+      false
+    end
+
+    def enabled_menu_items
+      [:ls, :lsa, :workon, :enable, :disable, :enable!, :disable!, :run, :tree, :ping, :put, :rsync, :cd, :meta, :registry, :interactive, :execute_script] 
+    end
+
+    def has_proxy?
+      ssh_driver.has_proxy?
+    end
+
+    def proxy
+      ssh_driver.proxy
+    end
+   
+    # TODO - why not do these in parallel?
+    def scp(local_path, remote_path)
+      resources.active.each do |resource|
+        resource.put(local_path, remote_path)
+      end
+      return
+    end
+
+    def rsync(local_path, remote_path)
+      resources.active.each do |resource|
+        resource.rsync(local_path, remote_path)
+      end   
+      return
+    end
+
+    def put(local_path, remote_path)
+      resources.active.each do |resource|
+        resource.put(local_path, remote_path)
+      end
+      return
+    end
+
+    def execute_script(script_name)
+      results = {}
+      machines.pmap do |machine|
+        command = machine.execute_script(script_name)
+        results[machine.namespace] = command
+      end
+      results
+    end
+ 
+    def validate_attributes
+      validate_identifier 
+      raise ::Bcome::Exception::MissingDescriptionOnView.new(@views.inspect) if requires_description? && !@description
+      raise ::Bcome::Exception::MissingTypeOnView.new(@views.inspect) if requires_type? && !@type
+    end
+
+    def validate_identifier
+      @identifier = DEFAULT_IDENTIFIER if is_top_level_node? && !@identifier && !is_a?(::Bcome::Node::Server::Base)
+      raise ::Bcome::Exception::MissingIdentifierOnView.new(@views.inspect) unless @identifier
+      raise ::Bcome::Exception::InvalidIdentifier.new("'#{@identifier}' contains whitespace") if @identifier =~ /\s/
+    end
+
+    def requires_description?
+      true
+    end
+
+    def requires_type?
+      true
+    end
+
+    def no_nodes?
+      !resources || resources.empty?
+    end
+
+    def nodes_loaded?
+      resources.any?
+    end
+   
+    def resources
+      @resources ||= ::Bcome::Node::Resources::Base.new
+    end
+
+    def list_key
+      :view
+    end
+
+    def invoke(method_name, arguments = [])
+      if method_is_available_on_node?(method_name)
+        if respond_to?(method_name)        
+          # Invoke a method on node that's defined by the system
+          begin
+            if arguments && arguments.any?
+              send(method_name, *arguments)
+            else
+              send(method_name)
+            end
+          rescue ArgumentError => e
+            raise ::Bcome::Exception::ArgumentErrorInvokingMethodFromCommmandLine.new method_name + "error message - #{e.message}"
+          end
+        else
+          # Invoke a user defined (registry) method
+          command = user_command_wrapper.command_for_console_command_name(method_name.to_sym)
+          command.execute(self, arguments)
+        end
+      else
+        # Final crumb is neither a node level context nor an executable method on the penultimate node level context
+        raise ::Bcome::Exception::InvalidBreadcrumb.new("Method '#{method_name}' is not available on bcome node of type #{self.class}, at namespace #{namespace}")
+      end
+    end
+
+    def resource_for_identifier(identifier)
+      resources.for_identifier(identifier)
+    end
+
+    def recurse_resource_for_identifier(identifier)
+      resource = resource_for_identifier(identifier)
+      return resource ? resource : (has_parent? ? parent.recurse_resource_for_identifier(identifier) : nil)
+    end
+
+    def prompt_breadcrumb
+      "#{has_parent? ? "#{parent.prompt_breadcrumb}> " : "" }#{ is_current_context? ? (has_parent? ? identifier.terminal_prompt : identifier) : identifier}" 
+    end
+
+    def namespace
+      "#{ parent ? "#{parent.namespace}:" : "" }#{identifier}"
+    end
+
+    def keyed_namespace
+      splits = namespace.split(":") ; 
+      splits[1..splits.size].join(":")
+    end
+
+    def has_parent?
+      !@parent.nil?
+    end
+
+    def is_top_level_node?
+      !has_parent?
+    end 
+
+    def list_attributes
+      { 
+        "Identifier": :identifier,
+        "Description": :description,
+        "Type": :type
+      }
+    end
+
+    def close_ssh_connections
+      machines.pmap do |machine|
+        machine.close_ssh_connection
+      end
+      return
+    end
+
+    def open_ssh_connections
+      machines.pmap do |machine|
+        machine.open_ssh_connection unless machine.has_ssh_connection?
+      end
+      return
+    end
+
+    def execute_local(command)
+      puts "(local) > #{command}"
+      system(command)
+    end
+
+    def data_print_from_hash(data, heading)
+      puts "\n#{heading.title}"
+      puts ""
+
+      if data.keys.any?
+        data.each do |key, value|
+          puts "#{key.to_s.resource_key}: #{value.to_s.informational}"
+        end
+      else
+        puts "No values found".warning
+      end
+      puts ""
+    end
+
+    private
+
+    def set_view_attributes
+      @views.keys.each do |view_attribute_key|
+        next if view_attributes_to_skip_on_setup.include?(view_attribute_key)
+        instance_variable_set("@#{view_attribute_key}", @views[view_attribute_key])
+      end
+    end
+
+    def view_attributes_to_skip_on_setup
+      [: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/
+      nil
+    end
+
+  end
+end

data/lib/objects/node/cache_handler.rb

@@ -0,0 +1,24 @@
+module Bcome::Node
+  class CacheHandler
+    def initialize(inventory_node)
+      @inventory_node = inventory_node
+    end
+
+    def do_cache_nodes!
+      @inventory_node.load_nodes unless @inventory_node.nodes_loaded?
+      all_nodes = @inventory_node.resources.active
+      write_to_in_memory_cache!(all_nodes) if all_nodes.any?
+    end
+
+    def write_to_in_memory_cache!(nodes)
+      @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
+    end
+
+    def dynamic_nodes_to_cache_hash(nodes)
+      nodes.collect(&:cache_data)
+    end
+  end
+end

data/lib/objects/node/collection.rb

@@ -0,0 +1,51 @@
+module Bcome::Node
+  class Collection < ::Bcome::Node::Base
+    def self.to_s
+      'collection'
+    end
+
+    def inventories
+      inv = []
+      @resources.active.each do |r|
+        inv << if r.inventory?
+                 r
+               else
+                 r.inventories
+               end
+      end
+      inv.flatten
+    end
+
+    def filter_duplicates(original_set)
+      instance_lookup = []
+      filtered_set = []
+      original_set.each do |server|
+        unless instance_lookup.include?(server.origin_object_id)
+          filtered_set << server
+          instance_lookup << server.origin_object_id
+        end
+      end
+      filtered_set
+    end
+
+    def machines
+      set = []
+      @resources.active.each do |resource|
+        if resource.inventory?
+          resource.load_nodes unless resource.nodes_loaded?
+          set << resource.resources.active
+        else
+          set << resource.machines
+        end
+      end
+
+      set.flatten!
+
+      filter_duplicates(set)
+    end
+
+    def collection?
+      true
+    end
+  end
+end

data/lib/objects/node/factory.rb

@@ -0,0 +1,108 @@
+module Bcome::Node
+  class Factory
+    include Singleton
+
+    attr_reader :estate
+
+    CONFIG_PATH = 'bcome'.freeze
+    DEFAULT_CONFIG_NAME = 'networks.yml'.freeze
+    INVENTORY_KEY = 'inventory'.freeze
+    COLLECTION_KEY = 'collection'.freeze
+    SUBSELECT_KEY = 'inventory-subselect'.freeze
+    BCOME_RC_FILENAME = '.bcomerc'.freeze
+
+    def bucket
+      @bucket ||= {}
+    end
+
+    def init_tree
+      @estate = create_node(estate_config)
+      @estate
+    end
+
+    def config_path
+      "#{CONFIG_PATH}/#{config_file_name}"
+    end
+
+    def config_file_name
+      @config_file_name ||= ENV['CONF'] ? ENV['CONF'] : DEFAULT_CONFIG_NAME
+    end
+
+    def create_tree(context_node, views)
+      views.each { |config| create_node(config, context_node) }
+    end
+
+    def reformat_config(config)
+      conf = ::Bcome::ConfigFactory.new
+      config.each do |crumb, data|
+        validate_view(crumb, data)
+        crumbs = Bcome::Parser::BreadCrumb.parse(crumb)
+        conf.add_crumbs(crumbs, data)
+      end
+      conf.flattened
+    end
+
+    def create_node(config, parent = nil)
+      raise Bcome::Exception::InvalidNetworkConfig, 'missing config type' unless config[:type]
+
+      klass = klass_for_view_type[config[:type]]
+
+      raise Bcome::Exception::InvalidNetworkConfig, "invalid config type #{config[:type]}" unless klass
+
+      node = klass.new(views: config, parent: parent)
+      create_tree(node, config[:views]) if config[:views] && config[:views].any?
+      parent.resources << node if parent
+
+      bucket[node.keyed_namespace] = node
+
+      node
+    end
+
+    def validate_view(breadcrumb, data)
+      unless data && data[:type]
+        raise Bcome::Exception::InvalidNetworkConfig, "Missing namespace type for for namespace '#{breadcrumb}'"
+      end
+
+      unless is_valid_view_type?(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(', ')}"
+      end
+    end
+
+    def klass_for_view_type
+      {
+        COLLECTION_KEY => ::Bcome::Node::Collection,
+        INVENTORY_KEY => ::Bcome::Node::Inventory::Defined,
+        SUBSELECT_KEY => ::Bcome::Node::Inventory::Subselect
+      }
+    end
+
+    def is_valid_view_type?(view_type)
+      klass_for_view_type.keys.include?(view_type)
+    end
+
+    def estate_config
+      @estate_config ||= reformat_config(load_estate_config)
+    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
+      return config
+    rescue ArgumentError, Psych::SyntaxError => e
+      raise Bcome::Exception::InvalidNetworkConfig, 'Invalid yaml in config' + e.message
+    rescue Errno::ENOENT
+      raise Bcome::Exception::DeprecationWarning if is_running_deprecated_configs?
+      raise Bcome::Exception::MissingNetworkConfig, config_path
+    end
+
+    def is_running_deprecated_configs?
+      File.exist?("bcome/config/platform.yml")
+    end
+
+  end
+end