solutious-rudy 0.4.0 → 0.5.0

data/CHANGES.txt

@@ -1,25 +1,24 @@
 RUDY, CHANGES
 
-TODO: Look into RubyGems error
-    /Library/Ruby/Gems/1.8/gems/rake-0.8.3/lib/rake/gempackagetask.rb:13:Warning: Gem::manage_gems is deprecated and will be removed on or after March 2009.
-    rake aborted!
-    RubyGem version error: rdoc(2.4.0 not ~> 2.3.0)
+TODO: Remove aws_sdb
 
-TODO: Remove aws_swb
 
-
-#### 0.4.1 (2009-03-??) ###############################
+#### 0.5.0 (2009-04-??) ###############################
 
 * CHANGE: Recommend keypair config to be in ~/.rudy/config
 * FIX: Rudy now checks for user keys specified by env-role, env, and global
 * FIX: gemspec dependency net-ssh-multi
 * NEW: rerelease command
+* NEW: --nocolor option 
+* NEW: Ruby API
+* NEW: Tests with 65% coverage
+
 
 #### 0.4 (2009-03-12) ###############################
 
 NOTE: This is a significant re-write from 0.3
 
-* CHANGE: Mostly re-written bin/ruby, moving validation to Command classes 
+* CHANGE: Mostly re-written bin/ruby, moving validation to CLI classes 
 * CHANGE: upgrade to Drydock 0.5
 * CHANGE: Moved generic EC2 commands to bin/rudy-ec2
 * CHANGE: Removed ambiguity of pluralized command names.
@@ -58,7 +57,7 @@ NOTE: This is a complete re-write from 0.1
 * NEW: All time references are converted to UTC
 * NEW: Safer "Are you sure?". Number of characters to enter is 
        commiserate with amount of danger.  
-* NEW: Commands: myaddress, addresses, images, instances, 
+* NEW: CLIs: myaddress, addresses, images, instances, 
        disks, connect, copy, stage, backups, volumes
 * NEW: Metadata storage to SimpleDB for disks, backups
 * NEW: Creates EBS volumes based on startup from metadata

data/README.rdoc

@@ -1,13 +1,56 @@
-= Rudy - v0.4 ALPHA!
+= Rudy - v0.5 ALPHA
 
-Rudy is a handy staging and deployment tool for EC2.
+Rudy is a development and deployment tool for Amazon EC2. It's both a command-line tool and Ruby library. Here's an example from both for creating an EC2 security group:
+
+     $ rudy group --create
+
+     rgroup = Rudy::Groups.new
+     rgroup.create
+
+Rudy is a bit different from other EC2 libraries in several ways. 
 
-NOTE: Rudy will be ready for general consumption in Q2 2009.
 
 == Installation
 
-* Soon!
-* ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION' (See net/ssh docs)
+Step 1 (install the gem):
+
+     $ sudo gem install rudy
+     $ sudo gem install solutious-rudy --source http://gems.github.com/
+     $ git clone git://github.com/solutious/rudy.git
+
+Step 2 (initialize your configuration):
+
+     $ rudy generate-config
+     [modify ~/.rudy/config]
+     $ rudy init
+
+Step 3 (get to work with EC2):
+
+     $ rudy group --create
+     $ rudy keypair --create
+     $ rudy instance --create
+
+
+== Dependencies:
+
+* OpenSSH
+* Net::SSH
+* Net::SCP
+* amazon-ec2
+* aws_sdb
+* Drydock
+* Caesars
+* Rye
+
+
+== Common Errors
+
+* "The request signature we calculated does not match the signature you provided."
+  * Check that your Amazon Web Service access key and secret key are correct
+
+* "AWS was not able to validate the provided access credentials"
+  * If it's a new Amazon Accounts, you need to sign up for EC2, SDB, and S3. 
+
 
 == More Info
 
@@ -15,7 +58,6 @@ NOTE: Rudy will be ready for general consumption in Q2 2009.
 * RubyForge[http://rubyforge.org/projects/rudy]
 * Inspiration[http://www.youtube.com/watch?v=CgaiIW5Rzes]
 
-
 == Credits
 
 * Delano Mandelbaum (delano@solutious.com)
@@ -30,7 +72,6 @@ NOTE: Rudy will be ready for general consumption in Q2 2009.
   * Caleb Buxton
   * Colin Brumelle
 
-
 == License
 
 See: LICENSE.txt

data/Rakefile

@@ -2,14 +2,106 @@ require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
 require 'hanna/rdoctask'
+require 'rake/testtask'
+require 'shoulda/tasks'
+require 'rake/runtest'
+require 'monkeyspecdoc'  # http://jgre.org/2008/09/03/monkeyspecdoc/
 require 'fileutils'
 include FileUtils
  
-task :default => :package
+task :default => :test
  
-# SPECS ===============================================================
+# TESTS ===============================================================
  
-# None-yet!
+Rake::TestTask.new(:test_old) do |t|
+  require 'monkeyspecdoc'
+  test_files = FileList['test/**/*_test.rb'] || []
+  t.test_files = test_files
+  t.ruby_opts = ['-rubygems'] if defined? Gem
+  t.verbose = true
+#  t.warning = true
+  
+end
+
+
+namespace :test do
+  desc 'Measures test coverage'
+  task :coverage do
+    rm_f "coverage"
+    rm_f "coverage.data"
+    rcov = "rcov -Itest --aggregate coverage.data -T -x ' rubygems/*,/Library/Ruby/Site/*,gems/*,rcov*'"
+    system("#{rcov} --html test/**/*_test.rb")
+    system("open coverage/index.html") if RUBY_PLATFORM['darwin']
+  end
+  task :list do
+    puts Dir.glob(File.join('test', '**', '*_test.rb'))
+  end
+  
+  # Run individual test groups with: 
+  # rake test:05 
+  # rake test:60
+  # etc...
+  ('00'..'99').each do |group|
+    task group.to_sym do
+      Rake.run_tests "test/#{group}*/*_test.rb"
+    end
+    
+    # And also individual test files
+    # rake test:50:10
+    # etc...
+    ('00'..'99').each do |test|
+      namespace group.to_sym do
+        task test.to_sym do
+          Rake.run_tests "test/#{group}*/{00,#{test}}*_test.rb"
+        end
+      end
+    end
+  end
+end
+
+task :test do
+
+  #all_tests = Dir.glob(File.join('test', '{05,20,50}*', '*_test.rb')) || []
+  #all_tests.sort.each do |file|
+  #  load file
+  #end
+  Rake.run_tests 'test/**/*_test.rb'
+end
+
+
+# From: shoulda/tasks/list_tests.rake
+namespace :shoulda do
+  desc "List the names of the test methods in a specification like format"
+  task :list_fixed do
+    $LOAD_PATH.unshift("test")
+
+    require 'test/unit'
+    require 'rubygems'
+    require 'active_support'
+
+    # bug in test unit.  Set to true to stop from running.
+    Test::Unit.run = true
+
+    test_files = Dir.glob(File.join('test', '**', '*_test.rb'))
+    
+    test_files.each do |file|
+      load file
+      klass = File.basename(file, '.rb').classify
+      #unless Object.const_defined?(klass.to_s)    # => raises: wrong constant name 00SetupTest
+      unless Object.constants.member?(klass.to_s)  # fixed
+        puts "Skipping #{klass} because it doesn't map to a Class"
+        next
+      end
+      klass = klass.constantize
+
+      puts klass.name.gsub('Test', '')
+
+      test_methods = klass.instance_methods.grep(/^test/).map {|s| s.gsub(/^test: /, '')}.sort
+      test_methods.each {|m| puts "  " + m }
+    end
+  end
+end
+
 
 # PACKAGE =============================================================
 
@@ -22,7 +114,11 @@ Rake::GemPackageTask.new(@spec) do |p|
   p.need_tar = true if RUBY_PLATFORM !~ /mswin/
 end
 
-task :release => [ :rdoc, :package ]
+task :release => [ :rdoc, :package ] do
+  $: << File.join(File.dirname(__FILE__), 'lib')
+  require "rudy"
+  abort if Drydock.debug?
+end
 
 task :install => [ :rdoc, :package ] do
 	sh %{sudo gem install pkg/#{name}-#{version}.gem}
@@ -52,17 +148,16 @@ end
 Rake::RDocTask.new do |t|
 	t.rdoc_dir = 'doc'
 	t.title    = @spec.summary
-	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.options << '--line-numbers' <<  '-A cattr_accessor=object'
 	t.options << '--charset' << 'utf-8'
 	t.rdoc_files.include('LICENSE.txt')
 	t.rdoc_files.include('README.rdoc')
 	t.rdoc_files.include('CHANGES.txt')
 	t.rdoc_files.include('bin/*')
-	t.rdoc_files.include('lib/*.rb')
 	t.rdoc_files.include('lib/**/*.rb')
 end
 
-CLEAN.include [ 'pkg', '*.gem', '.config', 'doc' ]
+CLEAN.include [ 'pkg', '*.gem', '.config', 'doc', 'coverage*' ]
 
 
 

data/Rudyfile

@@ -0,0 +1,28 @@
+# Rudyfile -- An example Rudy configuration. 
+#
+#
+# Rudy automatically looks for configuration files in the 
+# following locations:
+#
+#     ~/.rudy/config
+#     ./.rudy/config
+#     /etc/rudy/*.rb
+#     ./.rudy/*.rb
+#     ./Rudyfile
+#     ./config/rudy/*.rb
+#
+# When multuple files are found, the configuration is 
+# NOT OVERRIDDEN. It's ADDED / APPENDED. This means you can 
+# split configuration across many files as you please. 
+#
+# There are three sections: accounts, defaults, machines. 
+# By convention, accounts and defaults go in ~/.rudy/config or ./.rudy/config 
+# We encourage this to help avoid checking in AWS keys into source control.
+
+
+# ---------------------------------------------------------  MACHINES  --------
+# The machines block describes the "physical" characteristics
+# of your environments. 
+machines do
+  
+end

data/bin/ird

@@ -0,0 +1,162 @@
+#!/usr/bin/ruby
+
+# = Interactive Rudy (experimental)
+# 
+# === Not your granparent's deployment tool
+#
+#   See ird -h for usage
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib') # Put our local lib in first place
+
+require 'rubygems' unless defined?(Gem)
+
+# SEE: http://github.com/rubyspec/matzruby/blob/a34130eb7c4ecc164115a59aa1b76c643bd98202/lib/irb/xmp.rb
+# SEE: http://github.com/blackwinter/wirble/tree/master
+require "irb"
+require 'irb/completion'
+
+require 'rudy'
+require 'drydock'
+require 'rudy/cli'
+
+include Readline
+include Drydock
+
+global :A, :accesskey, String, "AWS Access Key"
+global :S, :secretkey, String, "AWS Secret Access Key"
+#global :R, :region, String, "Connect to a specific EC2 region (ie: #{Rudy::DEFAULT_REGION})"
+#global :n, :nocolor, "Disable output colors"
+global :f, :config, String, "Specify another configuration file to read (ie: #{Rudy::RUDY_CONFIG_FILE})"
+global :z, :zone, String, "Connect to a specific EC2 zone (ie: #{Rudy::DEFAULT_ZONE})"
+global :e, :environment, String, "Connect to the specified environment (ie: #{Rudy::DEFAULT_ENVIRONMENT})"
+global :r, :role, String, "Connect to a machine with the specified role (ie: #{Rudy::DEFAULT_ROLE})"
+global :p, :position, String, "Position in the machine in its group (ie: #{Rudy::DEFAULT_POSITION})"
+global :u, :user, String, "Provide a username (ie: #{Rudy::DEFAULT_USER})"
+#global :q, :quiet, "Run with less output"
+#global :v, :verbose, "Increase verbosity of output (i.e. -v or -vv or -vvv)" do
+#  @verbose ||= 0
+#  @verbose += 1
+#end
+global :V, :version, "Display version number" do
+  puts "Rudy version: #{Rudy::VERSION}"
+  exit 0
+end
+
+
+default :interactive
+debug :off
+desc "An interactive REPL for Rudy."
+usage "#{$0} [global options]"
+command :interactive do |obj|
+  
+  @rmach = Rudy::Instances.new(:global => obj.global)
+  @rkey = Rudy::KeyPairs.new(:global => obj.global)
+  @rgrp = Rudy::Groups.new(:global => obj.global)
+  @rvol = Rudy::Volumes.new(:global => obj.global)
+  @radd = Rudy::Addresses.new(:global => obj.global)
+  
+  puts Rudy::CLI.generate_header(@rmach.global, @rmach.config)
+  puts Rudy::Utils.without_indent(%Q`
+  ------------------------------------------------------------
+  Welcome Interactive Rudy! (EXPERIMENTAL)
+  ------------------------------------------------------------
+  
+  `)
+  h
+  
+  # What's the deal with this error message when defining a help method?
+  # => rb: warn: can't alias help from irb_help
+  if __FILE__ == $0
+    IRB.start(__FILE__)
+  else
+    # check -e option
+    if /^-e$/ =~ $0
+      IRB.start(__FILE__)
+    else
+      IRB.start(__FILE__)
+    end
+  end
+  
+end
+
+def h;
+  puts (%Q`
+HELP
+  
+  h             Help (this screen)
+  m             Rudy::Machines instance
+  g             Rudy::Groups instance
+  k             Rudy::KeyPairs instance
+  v             Rudy::Volumes instance
+  a             Rudy::Addresses instance
+  ssh [GROUP]   Connect to a machine
+  example       Start an EC2 instance from scratch.
+  `)
+end
+def example
+  puts (%Q`
+EXAMPLE
+    Start an EC2 instance from scratch.
+    
+    # Create a security group
+    >> g.create
+    => #<Rudy::AWS::EC2::Group @name="stage-app" ...>
+    
+    # Create a keypair (used to login as root)
+    >> k.create
+    => #<Rudy::AWS::EC2::KeyPair @name="key-stage-app" ...>
+    
+    # Start an EC2 machine instance:    
+    >> m.create
+    Instance: i-228def51
+    Waiting for the instance to startup
+    ........It's up!
+    
+    # Login to the new instance
+    >> ssh 
+    
+    All commands in Rudy refer to the global defaults unless
+    otherwise specified. "stage" is the default environment and 
+    "app" is the default role. You can change these with command 
+    line arguments or by modifying the defaults in your Rudy 
+    config file: #{@rmach.config_dirname}
+    
+    You can also specify your own names by providing
+    one as the first argument: g.create 'group5000'.
+    
+    # List instances in stage-app
+    >> m.list :running
+    => [#<Rudy::AWS::EC2::Instance:0x18c5888 ...>]
+    
+    # Print the instance in a human readable way
+    >> puts m.list.first.to_s
+    
+    # Print instance system console output
+    >> puts m.console
+    
+    # Destroy ALL INSTANCES in stage-app
+    >> m.destroy
+  `)
+end
+
+def m; @rmach; end
+def k; @rkey; end
+def g; @rgrp; end
+def v; @rvol; end
+def a; @radd; end
+
+# Change Group
+#def cg(name); end
+
+def ssh(*args)
+  @rmach.switch_user :root
+  @rmach.connect(*args)
+  @rmach.switch_user # back to previous user
+  nil
+end
+
+__END__
+#@rbox = Rye::Box.new('ec2-174-129-173-3.compute-1.amazonaws.com', 'root')
+#@rbox2 = Rye::Box.new('ec2-174-129-173-3.compute-1.amazonaws.com', 'root')
+#@rbox.add_keys('/Users/delano/Projects/git/rudy/.rudy/key-test-app.private')