Chef_Solo_Nodes 0.3.0 → 0.4.1

data/README.md

@@ -2,8 +2,31 @@
 Chef\_Solo\_Nodes
 ===============
 
-Provides two functions: Chef\_Solo\_Nodes(), Chef\_Solo\_IPs()
+Parse files from "nodes/\*.json" to help you integrate your Chef-Solo
+nodes with Capistrano, Knife-Solo, SSH, etc.
 
+The .json file can optionally define any of the following attributes:
+
+  * "ipaddress" - If not defined, file name used: node/[FILE\_NAME].json
+  * "user" || "login"
+  * "port"
+
+Example: node/Machine\_Name.json
+--------------------------------
+    
+    { 
+       "ipaddress": "localhost", 
+       "port": 2222, 
+       "user": "vagrant",
+       "roles": ["dev"],
+       "run_list": [ "recipe[...]", "recipe[....]"]
+    }
+
+Implementation
+--------------
+
+Most of the action is in
+[less than 100 lines of code.](https://github.com/da99/Chef_Solo_Nodes/blob/master/lib/Chef_Solo_Nodes.rb)
 
 Installation
 -----------
@@ -13,68 +36,105 @@ Installation
 Usage: Ruby
 ----------
 
+Provides two functions: Chef\_Solo\_Nodes(), Chef\_Solo\_IPs(). 
+You can pass them an optional role name to filter the nodes.
+
     require "Chef_Solo_Nodes"
 
-    Chef_Solo_Nodes() # ===> [ Hash, Hash ]
+    Chef_Solo_Nodes()            # ===> [ Hash, Hash ]
     Chef_Solo_Nodes('role_name') # ===> [ Hash, Hash ]
-    Chef_Solo_IPs('db') # ===> [ String, String ]
+    Chef_Solo_IPs('db')          # ===> [ "hostname", "user@hostname:port" ]
+
+If the argument is an Array, it will treat each element as a 
+file path to a JSON file:
+
+    paths  = [ "node/FILE_1.json", "node/FILE_2.json" ]
+    Chef_Solo_Nodes paths
+    Chef_Solo_IPs   paths
+
 
 Usage: Capistrano
 ----------------
 
     require "Chef_Solo_Nodes"
     role :app, *Chef_Solo_IPs('app')
-    role :db, *Chef_Solo_IPs('db')
+    role :db,  *Chef_Solo_IPs('db')
 
-Usage: CAP\_IP
---------------------
+Equivalent to:
 
-    $ CAP_IP file_name 
-    127.0.0.1  
-    # Read from nodes/file_name.json
+    role :app, "user@host:port", "192.0.0.42"
+    role :db,  "super.secret.base"
 
-    $ CAP_IP file_with_port
-    127.0.0.1:2222
+Usage: Shell
+------------
+
+Provides 2 executables: IP and SSH
+
+All they do is print out to standard output.  They are meant to
+generate arguments for other programs:
+
+    $ ping -c 3 $( IP --no-user file_name )
+    ping -c 3 my.ip.address
+
+    $ ssh $( SSH file_name )
+    ssh -p 2222 user@ip.address
 
-    $ CAP_IP file_with_user_and_port
-    vagrant@127.0.0.1:2222 
+    $ knife prepare $( SSH file_name )
+    knife prepare -p 4567 user@ip.address
+
+**Tip:** the last example above uses
+[knife-solo](https://github.com/matschaffer/knife-solo).
+
+Usage: Errors for IP, SSH
+-------------------------
+
+If the file name does not exist:
+
+    $ IP  missing_file
+    $ SSH missing_file
+    xx.xx.xx.xx
+    # exit status = 1
 
 Usage: IP
 --------------------
 
-The user is excluded in the final print out, unlike with CAP\_IP.
+    $ IP file_name 
+    # Parses "nodes/file_name.json"
+    
+Depending on whether the attributes exist, the results could take
+any form of the following:
 
-    $ IP file_with_user_and_port
+    127.0.0.1  
     127.0.0.1:2222
-    # Read from nodes/file_with_user_and_port.json
-    
-    $ IP file_with_no_port
-    127.0.0.1
+    user@127.0.0.1:2222 
 
-Usage: SSH
+Usage: IP --no-user
 --------------------
+Removes the **user@** part of the address:
 
-    $ SSH file_name
+    $ IP --no-user file_name
     127.0.0.1
-    # Read from nodes/file_name.json
 
-    $ SSH file_with_specified_user_or_login
-    vagrant@127.0.0.1
+Usage: SSH
+--------------------
 
-    $ SSH file_with_specified_port
-    -p 2222 vagrant@127.0.0.1
+    $ SSH file_name
+    # Parses "nodes/file_name.json"
 
-    $ ssh $( SSH vagrant )
-    ssh -p 2222 vagrant@127.0.0.1
+Depending on whether the attributes exist, the results could take
+any form of the following:
 
-    # Using knife-solo: https://github.com/matschaffer/knife-solo 
-    $ knife prepare $( SSH file_name )
-    knife prepare -p 2222 vagrant@localhost
+    127.0.0.1
+    user@127.0.0.1
+    -p 2222 user@127.0.0.1
 
-Implementation
---------------
+**Note:** SSH does not take any other options/arguments except for the file name.
 
-It's easier to understand if you see the code. 
-[It's just one page long.](https://github.com/da99/Chef_Solo_Nodes/blob/master/lib/Chef_Solo_Nodes.rb)
+Run Tests
+---------
 
+    git clone git@github.com:da99/Chef_Solo_Nodes.git
+    cd Chef_Solo_Nodes
+    bundle update
+    bundle exec bacon spec/main.rb
 

data/bin/IP

@@ -1,16 +1,20 @@
 #!/usr/bin/env ruby
 require "Chef_Solo_Nodes"
+require "trollop"
+
+opts = Trollop::options do
+  opt :no_user, "Avoid printing any user/login value", :default=>false
+end
 
 n = Chef_Solo_IPs(Dir.glob("nodes/#{ARGV.first}.json")).first
 
-unless n
+if !n
   print 'xx.xx.xx.xx'
   exit 1
 end
 
 uri = URI.parse("ssh://#{n}")
 
+print "#{uri.user}@" if uri.user && !opts[:no_user]
 print "#{uri.host}"
-if uri.port
-  print ":#{uri.port}"
-end
+print ":#{uri.port}" if uri.port

data/lib/Chef_Solo_Nodes.rb

@@ -15,7 +15,7 @@ def Chef_Solo_Nodes role_or_paths = '*'
   
   if role_or_paths.is_a?(Array)
     role = '*'
-    files = role_or_paths
+    files = role_or_paths.map { |path| File.expand_path(path) }
   else
     role = role_or_paths.to_s
     files = Dir.glob("nodes/*.json")
@@ -51,4 +51,3 @@ def Chef_Solo_IPs *args
   }
 end
 
-

data/lib/Chef_Solo_Nodes/version.rb

@@ -1,3 +1,3 @@
 class Chef_Solo_Nodes
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/spec/tests/IP.rb

@@ -20,12 +20,29 @@ describe "IP" do
     }
   end
 
-  it "does not include user if specified" do
+  it "includes user if specified" do
     chdir {
-      `bundle exec IP "with_user"`.should == "localhost"
+      `bundle exec IP "with_user"`.should == "RjD2@localhost"
+    }
+  end
+
+  it "includes login if specified" do
+    chdir {
+      `bundle exec IP "with_login"`.should == "log_RjD2@localhost"
+    }
+  end
+
+  it "excludes user if --no-user is specified" do
+    chdir {
+      `bundle exec IP --no-user "with_user"`.should == "localhost"
+    }
+  end
+
+  it "excludes login if --no-user is specified" do
+    chdir {
+      `bundle exec IP --no-user "with_login"`.should == "localhost"
     }
   end
-  
   
 end # === IP
 

data/spec/tests/SSH.rb

@@ -32,7 +32,7 @@ describe "SSH" do
     }
   end
 
-  it "adds user if \"user\" is specified" do
+  it "adds user if \"login\" is specified" do
     chdir {
       `SSH "with_login"`.should == "log_RjD2@localhost"
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Chef_Solo_Nodes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-19 00:00:00.000000000 Z
+date: 2012-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
@@ -96,7 +96,6 @@ description: ! "\n    Use with Chef-Solo.  Grabs node info as array of Hashes or
 email:
 - i-hate-spam-45671204@mailinator.com
 executables:
-- CAP_IP
 - IP
 - SSH
 extensions: []
@@ -108,7 +107,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/CAP_IP
 - bin/IP
 - bin/SSH
 - lib/Chef_Solo_Nodes.rb
@@ -124,7 +122,6 @@ files:
 - spec/data/nodes/with_user.json
 - spec/helper.rb
 - spec/main.rb
-- spec/tests/CAP_IP.rb
 - spec/tests/Chef_Solo_IPs.rb
 - spec/tests/Chef_Solo_Nodes.rb
 - spec/tests/IP.rb

data/bin/CAP_IP

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-require "Chef_Solo_Nodes"
-
-n = Chef_Solo_IPs(Dir.glob("nodes/#{ARGV.first}.json")).first
-
-unless n
-  print 'xx.xx.xx.xx'
-  exit 1
-end
-
-print n

data/spec/tests/CAP_IP.rb

@@ -1,31 +0,0 @@
-
-describe "CAP_IP" do
-  
-  it "prints xx.xx.xx.xx if file is not found" do
-    chdir {
-      `CAP_IP not.found.json`.should == "xx.xx.xx.xx"
-    }
-  end
-
-  it "exists with 1 if not found" do
-    chdir {
-      `CAP_IP not.found.json`
-      $?.exitstatus.should == 1
-    }
-  end
-  
-  it "returns only one result" do
-    chdir {
-      `bundle exec CAP_IP "*"`.should == "freemont"
-    }
-  end
-
-  it "includes user if specified" do
-    chdir {
-      `bundle exec CAP_IP "with_user"`.should == "RjD2@localhost"
-    }
-  end
-  
-  
-end # === IP
-