bcome 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f8aea49653325e3411b5f8b00dc2b8e38b41a2
-  data.tar.gz: ad51468750bb88a0f0a64f2adabd12c858e3d450
+  metadata.gz: 01324b7764e93f79ce32699d34d94965d415cebe
+  data.tar.gz: 83ec2d6950806c8296dcbb7973ade7b2f67b7e6e
 SHA512:
-  metadata.gz: e611ac95795681ac544705963c6c6f70fb061716821137cc2912238fd44919e72bfc21b23d9e1514ac730286b74629e591264a86ddd2b834b8420ca7b95495f2
-  data.tar.gz: f17b03b5d9135ac1680a99fd16dabad09747e138638be405d531d54a606ba79ac6392c12188582fc7cf796eb1767f73d432d94cc7791bd99102ec97987dc977e
+  metadata.gz: ee0d1b667b905e6707fb63cd9597ecc68d8dc53544609a05236e3486d87ad500611d13ac9399ede75ecf5e84984c00ec245a5b1962b2a548b5bd457c2101ba5c
+  data.tar.gz: 6ce03cf191a70e15bb9f112f4928a2fcd5a36908f36c70ece2c1144dcf489fea792708f2c3dcf155da430312fa66c42603eea6926b73dbf5bb3e9e5081642d7e

data/bin/bcome

@@ -17,4 +17,12 @@ unless @no_shell
   IRB.irb nil, @context_object
 end
 
+## We're SSH'ing directly to a node, indicated by an 'ssh' key at the end of our context breadcrumb
+# called with, e.g. bcome platform:environment:node_name:ssh
 @ssh_to.node.ssh if @ssh_in && @ssh_to
+
+## We're going to directly execute a command on a node, indicated by the method name  at the end of our context breadcrumb.
+## This works for commands specified in the users own personal framework installation, either from a context command or from an orchestration hook
+## e,g, bcome platform:environment:node_name:bootstrap
+@context_object.send(@direct_execute_method) if @direct_execute_method
+

data/bin/boot.rb

@@ -95,6 +95,19 @@ if quick_contexts.any?
     end
 
     next_context_resource = @context_object.resource_for_identifier(resource_context_key)
+ 
+    # If we can't find our context breadcrumb, the user is perhaps specifying a direct command to be run 
+    # This is used to key into a breadcrumb context object, and then directly execute a custom command (either a context command, or one defined through
+    # orchestration on it).
+    # e.g. you have a context command called 'deploy'. You may want to do the following:
+    # bcome platform:environment:deploy
+    unless next_context_resource && index <= (quick_contexts.size - 1)
+      if @context_object.respond_to_bcome_context_method?(resource_context_key.to_sym)
+        @no_shell = true
+        @direct_execute_method = resource_context_key.to_sym
+        break
+      end
+    end
 
     # Initialize our object namespace, but only from our lowest level namespace object. This
     # ensures that we don't load more than we need. 
@@ -118,5 +131,6 @@ if quick_contexts.any?
   B_PIN = @context_object
   B_PIN.init
 else
+  B_PIN = ESTATE
   ESTATE.init
 end

data/bin/boot_no_shell.rb

@@ -1,4 +1,3 @@
 
-raise "No context for bcome provided" unless ENV['bcome_context']
 @no_shell = true
 load Bcome::Boot.boot_path

data/documentation/configuration.md

@@ -12,6 +12,8 @@ Create your platforms.yml config file in path/to/your/application/bcome/configs
 
 Example configurations can be found in path/to/your/application/bcome/configs/platform.yml-example
 
+* NOTE that you may add any attributes you like onto the platform config: using meta programming, bcome makes these accessible from the shell
+
 ### The network config
 
 The network config defines your environments within bcome - what they are, how they are accessed, and whether you with for Bcome to perform network discovery dynamically from EC2, or whether you have listed a static network list.
@@ -20,6 +22,8 @@ Create your network.yml config file in path/to/your/application/bcome/configs
 
 Example configurations can be found in path/to/your/application/bcome/configs/network.yml-example
 
+* NOTE that you may add any attributes you like onto the network config: using meta programming, bcome makes these accessible from the shell
+
 ### Static network instances config
 
 A static list of servers may be defined if you do not wish to enable dynamic network discovery.

data/documentation/example_non_shell_scripts/examples_script_basic_usage.rb

@@ -0,0 +1,48 @@
+#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+
+### External script example 1
+
+### Jumping to an environment context, and interacting with machines
+### Usage: bcome_context="your_platform_key:your_environment_key" bundle exec ./scriptname.rb
+
+## Loading bcome and accessing the loaded contexct
+require 'bcome'
+load Bcome::Boot.no_shell_boot_path
+current_context = B_PIN.node
+
+raise "Demo script is for an Environment context" unless current_context.is_a?(Bcome::Node::Environment)
+
+puts "You have loaded into a context of type #{current_context.class}, named #{current_context.identifier}\n".magenta
+
+## The 'machines' accessor
+puts "Iterating over servers found at the current context level\n".informational
+machines = current_context.machines
+
+machines.each {|machine|
+  puts "Identifier:".menu_item_cyan  + "\s#{machine.identifier}".informational
+  puts "External interface address:".menu_item_cyan + "\s#{machine.external_network_interface_address}".informational
+  puts "\n"
+}
+
+## Playing with a machine
+puts "\nDoing things with the machines:".magenta
+
+raise "Cannot proceed with demo, no machines found" unless machines.any?
+
+machine = machines.first
+
+## Command execution
+puts "\n\nExecuting a command on #{machine.identifier}".magenta
+command = machine.run("whoami")
+
+## File upload
+puts "\n\nFile upload".magenta
+local_path = "~/Desktop/foo"
+remote_path = "/home/guillaume"
+machine.put(local_path, remote_path)
+
+## File download
+puts "\n\nFile download".magenta
+machine.get(remote_path)
+
+exit 0

data/documentation/example_non_shell_scripts/examples_script_entire_estate.rb

@@ -0,0 +1,44 @@
+#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+
+### External script example 3
+
+### Load up the entire estate, interact with platforms, environments, and then machines
+### Usage: bundle exec ./scriptname.rb 
+
+## Loading bcome and accessing the loaded contexct
+require 'bcome'
+load Bcome::Boot.no_shell_boot_path
+current_context = B_PIN.node
+
+raise "Demo script is for an Platform context" unless current_context.is_a?(Bcome::Node::Estate)
+
+estate = current_context
+
+## Can get the machines from the estate
+all_machines = estate.machines
+
+puts "Estate has #{all_machines.size} machines".informational
+
+platforms = estate.platforms
+
+platforms.each {|platform|
+
+  puts "\nPlatform #{platform.identifier} has #{platform.machines.size} machines".informational
+
+  ### Get all environments
+  environments = platform.environments
+
+  environments.each {|environment|
+    puts "Environment:".magenta + "\s#{environment.identifier}".informational
+
+    #  Machines within this enironment
+    machines = environment.machines
+    machines.each { |machine|
+      puts "Identifier: ".magenta + "\s#{machine.identifier}"
+    }  
+ 
+  }
+
+}
+
+exit 0

data/documentation/example_non_shell_scripts/examples_script_platform_level.rb

@@ -0,0 +1,36 @@
+#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+
+### External script example 2
+
+### Jumping to a platform context, accessing environments
+### Usage: bcome_context="your_platform_key" bundle exec ./scriptname.rb 
+
+## Loading bcome and accessing the loaded contexct
+require 'bcome'
+load Bcome::Boot.no_shell_boot_path
+current_context = B_PIN.node
+
+raise "Demo script is for an Platform context" unless current_context.is_a?(Bcome::Node::Platform)
+
+platform = current_context
+
+## Can get the machines from platform itself
+all_machines = platform.machines
+
+puts "Platform has #{all_machines.size} machines".informational
+
+### Get all environments
+environments = platform.environments
+
+environments.each {|environment|
+  puts "Environment:".magenta + "\s#{environment.identifier}".informational
+
+  #  Machines within this enironment
+  machines = environment.machines
+  machines.each { |machine|
+    puts "Identifier: ".magenta + "\s#{machine.identifier}"
+  }  
+ 
+}
+
+exit 0

data/documentation/examples/network.yml-example

@@ -5,6 +5,7 @@
 # * For SSH access, it is assumed that you are using SSH keys. 
 # * For Jump SSH access, it is assumed that you are using your local user for SSH
 
+### NOTE that you may add any attributes you like onto the network config: using meta programming, bcome makes these accessible from the shell
 
 ###  Example 1: Dynamic network lookup with jump host
 - :network: "project_foo"

data/documentation/examples/platform.yml-example

@@ -1,9 +1,13 @@
+
+### NOTE that you may add any attributes you like onto the platform config: using meta programming, bcome makes these accessible from the shell
+
 ---
 ## Example platforms list. 
 # Platform have environments
 # environments have servers
 - :name: "project_foo"
   :description: "All the Foo environments"
+  :location: "Some information about where this is (optional)"
 - :name: "project_bar"
   :description: "All the Bar environments"
   :quick_contexts:

data/documentation/external_usage.md

@@ -0,0 +1,31 @@
+# External Usage
+
+Bcome may be used for scripting outside of the bcome shell.
+
+This allows for integration with tools such as Capistrano, or for any ad-hoc scripting need.
+
+You may
+
+* Iterate across your entire estate, and script processes over all your machines, irrespective of which platform they are in (i.e. they may live in separate web hosts, with separate credentials etc:  bcome will manage the network connectivity for you.
+
+* Iterate across all environments within a given platform.
+
+* Iterate across all machines with a given environment.
+
+From your scripts, you may execute arbitrary commands on your machines, and access the functionality of the bcome shell.
+
+Example scripts:
+
+### Basic usage
+
+Access machines within an environment, and interact with them
+
+see documentation/example_non_shell_scripts/examples_script_basic_usage.rb
+
+### Jumping to a platform context and interacting with environments (and then the machines within them)
+
+see documentation/example_non_shell_scripts/examples_script_platform_level.rb
+
+### Interacting with your entire estate
+
+see documentation/example_non_shell_scripts/examples_script_entire_estate.rb

data/lib/bcome/version.rb

@@ -1,3 +1,3 @@
 module Bcome
-  VERSION = "0.2.1"
+  VERSION = "0.3.2"
 end

data/lib/become_object.rb

@@ -56,7 +56,7 @@ module ::Bcome::BecomeObject
   end
 
   def resource_for_identifier(identifier)
-    return nil unless resources
+    return nil unless has_sub_nodes? && resources
     matches = resources.select{|resource| resource.identifier.to_sym == identifier.to_sym }
     raise "Retrieved more than one match for #{collection_key} '#{identifier}'. Selection is ambiguous" if matches.size > 1
     return matches.first

data/lib/helpers/selections.rb

@@ -1,4 +1,4 @@
-module ::Bcome::Selections
+module Bcome::Selections
 
   def manage_object(method, resource_identifier = nil)
     unless resource_identifier && resource_identifier.is_a?(String)
@@ -50,23 +50,15 @@ module ::Bcome::Selections
   end
 
   def add(resource_identifier = nil)
-    if resource_identifier.is_a?(Array)
-      resource_identifier.each do |ri|
-        manage_object(:add_object, ri)
-      end
-    else
-      manage_object(:add_object, resource_identifier)
-    end
+    resource_identifier = [resource_identifier] unless resource_identifier.is_a?(Array)
+    resource_identifier.each {|ri| manage_object(:add_object, ri) }
+    puts "\n" + "#{resource_identifier.join(",")} added.".menu_item_cyan + "\n\nType 'selections' or 's' to review your selections.'".menu_item_white
   end
 
   def remove(resource_identifier = nil)
-    if resource_identifier.is_a?(Array)
-      resource_identifier.each do |ri|
-        manage_object(:remove_object, ri)
-      end
-    else
-      manage_object(:remove_object, resource_identifier)
-    end
+    resource_identifier = [resource_identifier] unless resource_identifier.is_a?(Array)
+    resource_identifier.each { |ri| manage_object(:remove_object, ri) }
+    puts "\n Nodes removed.".menu_item_cyan
   end
 
   def add!
@@ -90,7 +82,6 @@ module ::Bcome::Selections
   def add_object(object)
     return if object_in_selections?(object)
     @objects = @objects ? (@objects << object) : [object]
-    puts "\n" + "#{object.identifier} added.".menu_item_cyan + "\sType 'selections' to see currently selections instances.'".menu_item_white
     return
   end  
 
@@ -100,7 +91,6 @@ module ::Bcome::Selections
       puts "\n#{object.identifier} is not within selections".headsup
     else
       @objects = @objects - [object]
-      puts "\n" + "#{object.identifier} removed.".menu_item_cyan + "\sType 'selections' to see currently selections instances.'".menu_item_white
     end
     return
   end
@@ -118,6 +108,7 @@ module ::Bcome::Selections
       puts @objects.collect {|o| o.do_describe }.join + "\n"
     end
   end  
+  alias :s :selections
 
   def no_selections_error 
     puts "No nodes selected".informational

data/lib/patches/string.rb

@@ -34,7 +34,6 @@ class String
       :failure => { :colour => :red },
       :success => { :colour => :green },
       :title => { :colour => :green },
-      :success => { :colour => :green },
       :command => {  :colour => :cyan, :highlight => true },
       :danger => { :colour => :red },
       :warning => { :colour => :orange },

data/lib/render_irb.rb

@@ -5,12 +5,12 @@ class ::Bcome::RenderIrb
       print "\n\sNo resources collections found. Maybe you forgot to add any?".headsup
     else
      print "\n\s"
-     puts "#{parent_collection.to_s.menu_title_green}:".menu_title_green
+     puts "#{parent_collection.to_s.menu_title_green}\n".menu_title_green
      items.each do |item|
         puts "\t*/added".danger + "\n" if item.highlight?
         print item.do_describe
       end
-      print "\n\s\sUse cd [node identifier], e.g. cd \"#{items.first.identifier}\" to work on a given node.\n\n"
+      print "\n\s\sUse cd [node identifier], e.g. cd :#{items.first.identifier} OR cd \"#{items.first.identifier}\" to work on a given node.\n\n"
     end
   end
 

data/lib/stack/base.rb

@@ -9,6 +9,10 @@ module ::Bcome::Stack
       node.machines
     end
 
+    def has_sub_nodes?
+      return true
+    end
+
     ###
     ## Construction & Initialisation
     ##
@@ -21,6 +25,10 @@ module ::Bcome::Stack
       @node ||= construct_node
     end
 
+    def respond_to_bcome_context_method?(method_sym)
+      return (command_for_context(method_sym) || ::Bcome::Orchestrator::Recipe.by_identifier(method_sym.to_s, self)) ? true : false
+    end
+
     def method_missing(method_sym, *arguments, &block)
       if command_for_context = command_for_context(method_sym)
         execute_command_for_context(command_for_context)

data/lib/stack/environment.rb

@@ -31,7 +31,7 @@ module ::Bcome::Stack
         { :command => "add!", :description => "Add all resources from the current context." },
         { :command => "remove", :description => "Remove a resource you no longer with to work on.", :usage => "remove 'identifier', OR remove ['array', 'of','identifiers']" },
         { :command => "clear!", :description => "Remove all selected resources." },
-        { :command => "selections", :description => "Show all added resources." },
+        { :command => "selections", :description => "Show all added resources.", :usage => "selections / s"},
         { :command => "run", :description => "Execute a command on all selected resources", :usage => "run 'command'" },
         { :command => "get", :description => "Download from remote from all selected resources (recursive - uses rsync)", :usage => "get 'remote_path'" },
         { :command => "put", :description => "Copy files up to all selected resources (recursive - uses rsync)", :usage => "put 'local_path', 'remote_path'" },

data/lib/stack/instance.rb

@@ -42,6 +42,10 @@ module ::Bcome::Stack
       node.identifier
     end
 
+    def has_sub_nodes?
+      return false
+    end
+
     ## Commands
     def ssh
       node.ssh

data/lib/stack/platform.rb

@@ -27,10 +27,10 @@ module ::Bcome::Stack
     end
 
     def do_describe
-      description = "\n"
-      description += "\tPlatform Name:".menu_item_cyan + "\s#{identifier.menu_item_green}\n"
+      description = "\tPlatform Name:".menu_item_cyan + "\s#{identifier.menu_item_green}\n"
       description += "\t" + "Description:".menu_item_cyan + "\s#{@meta_data[:description].menu_item_white}" + "\n"
       description += "\t" + "Location:".menu_item_magenta + "\s#{@meta_data[:location].menu_item_white}" + "\n" if @meta_data[:location]
+      description += "\n"
 
       return description
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcome
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Guillaume Roderick (Webzakimbo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -117,9 +117,13 @@ files:
 - bin/boot.rb
 - bin/boot_no_shell.rb
 - documentation/configuration.md
+- documentation/example_non_shell_scripts/examples_script_basic_usage.rb
+- documentation/example_non_shell_scripts/examples_script_entire_estate.rb
+- documentation/example_non_shell_scripts/examples_script_platform_level.rb
 - documentation/examples/functions.yml-example
 - documentation/examples/network.yml-example
 - documentation/examples/platform.yml-example
+- documentation/external_usage.md
 - documentation/functions.md
 - documentation/installation.md
 - documentation/usage.md