teleport 1.0.0 → 1.0.1

data/Gemfile

@@ -1,3 +1,2 @@
 source "http://rubygems.org"
-
 gemspec

data/README.md

@@ -13,7 +13,7 @@ At the moment Teleport supports **Ubuntu 10.04/10.10/11.04 with Ruby 1.8.7, 1.9.
 1. Install Teleport on your local machine.
 
     ```
-    $ sudo gem install teleport --pre
+    $ sudo gem install teleport
     ```    
     
 1. Create a `Telfile` config file. Here's a simple example. Note that we actually define two machines, `server_app1` and `server_db1`:

data/Rakefile

@@ -1,10 +1,58 @@
 require "bundler"
-require "rake/rdoctask"
+require "bundler/setup"
 
-Bundler::GemHelper.install_tasks
+require "rake"
+require "rdoc/task"
+require "rspec"
+require "rspec/core/rake_task"
 
-Rake::RDocTask.new do |rdoc|
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require "teleport/version"
+
+#
+# gem
+#
+
+task :gem => :build
+task :build do
+  system "gem build --quiet teleport.gemspec"
+end
+
+task :install => :build do
+  system "sudo gem install --quiet teleport-#{Teleport::VERSION}.gem"
+end
+
+task :release => :build do
+  system "git tag -a #{Teleport::VERSION} -m 'Tagging #{Teleport::VERSION}'"
+  system "git push --tags"
+  system "gem push teleport-#{Teleport::VERSION}.gem"
+end
+
+#
+# rspec
+#
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = %w(--color --tty)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new("spec:unit") do |spec|
+  spec.pattern = "spec/unit/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new("spec:end") do |spec|
+  spec.pattern = "spec/end*_spec.rb"
+end
+
+#
+# rdoc
+#
+
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
   rdoc.title = "teleport #{Teleport::VERSION}"
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
+
+task :default => :spec

data/lib/teleport.rb

@@ -4,4 +4,5 @@ require "teleport/util"
 require "teleport/config"
 require "teleport/mirror"
 require "teleport/install"
+require "teleport/infer"
 require "teleport/main"

data/lib/teleport/config.rb

@@ -2,11 +2,10 @@ module Teleport
   # This class parses Telfile, and includes DSL and the models.
   class Config
     RUBIES = ["1.9.2", "REE", "1.8.7"]
-    PATH = "Telfile"
 
-    attr_accessor :user, :ruby, :roles, :servers, :apt, :packages, :callbacks, :dsl
+    attr_accessor :user, :ruby, :ssh_options, :roles, :servers, :apt, :packages, :callbacks, :dsl
     
-    def initialize
+    def initialize(file = "Telfile")
       @roles = []
       @servers = []
       @apt = []
@@ -14,7 +13,7 @@ module Teleport
       @callbacks = { }
 
       @dsl = DSL.new(self)
-      @dsl.instance_eval(File.read(PATH), PATH)
+      @dsl.instance_eval(File.read(file), file)
 
       @user ||= Util.whoami
       @ruby ||= RUBIES.first
@@ -95,6 +94,12 @@ module Teleport
         @config.user = v
       end
 
+      def ssh_options(v)
+        raise "ssh_options called twice" if @config.ssh_options
+        raise "ssh_options must be an Array" if !v.is_a?(Array)        
+        @config.ssh_options = v
+      end
+
       def role(name, options = {})
         raise "role #{name.inspect} defined twice" if @config.roles.any? { |i| i.name == name }
         @config.roles << Role.new(name, options)

data/lib/teleport/infer.rb

@@ -0,0 +1,349 @@
+require "set"
+
+# Many, many thanks to Blueprint!
+# https://github.com/devstructure/blueprint
+
+module Teleport
+  class Infer
+    include Util
+
+    # Copyright 2011 DevStructure. All rights reserved.
+    #
+    # Redistribution and use in source and binary forms, with or without
+    # modification, are permitted provided that the following conditions are
+    # met:
+    #
+    #     1.  Redistributions of source code must retain the above copyright
+    #         notice, this list of conditions and the following disclaimer.
+    #
+    #     2.  Redistributions in binary form must reproduce the above
+    #         copyright notice, this list of conditions and the following
+    #         disclaimer in the documentation and/or other materials provided
+    #         with the distribution.
+    #
+    # THIS SOFTWARE IS PROVIDED BY DEVSTRUCTURE ``AS IS'' AND ANY EXPRESS
+    # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    # DISCLAIMED. IN NO EVENT SHALL DEVSTRUCTURE OR CONTRIBUTORS BE LIABLE
+    # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+    # THE POSSIBILITY OF SUCH DAMAGE.
+    #
+    # The views and conclusions contained in the software and documentation
+    # are those of the authors and should not be interpreted as representing
+    # official policies, either expressed or implied, of DevStructure.
+    #
+    # (for MD5SUMS)
+    
+    MD5SUMS = {
+      '/etc/adduser.conf' => ['/usr/share/adduser/adduser.conf'],
+      '/etc/apparmor.d/tunables/home.d/ubuntu' =>
+      ['2a88811f7b763daa96c20b20269294a4'],
+      '/etc/apt/apt.conf.d/00CDMountPoint' =>
+      ['cb46a4e03f8c592ee9f56c948c14ea4e'],
+      '/etc/apt/apt.conf.d/00trustcdrom' =>
+      ['a8df82e6e6774f817b500ee10202a968'],
+      '/etc/chatscripts/provider' => ['/usr/share/ppp/provider.chatscript'],
+      '/etc/default/console-setup' =>
+      ['0fb6cec686d0410993bdf17192bee7d6',
+       'b684fd43b74ac60c6bdafafda8236ed3',
+       '/usr/share/console-setup/console-setup'],
+      '/etc/default/grub' => ['ee9df6805efb2a7d1ba3f8016754a119',
+                              'ad9283019e54cedfc1f58bcc5e615dce'],
+      '/etc/default/irqbalance' => ['7e10d364b9f72b11d7bf7bd1cfaeb0ff'],
+      '/etc/default/keyboard' => ['06d66484edaa2fbf89aa0c1ec4989857'],
+      '/etc/default/locale' => ['164aba1ef1298affaa58761647f2ceba',
+                                '7c32189e775ac93487aa4a01dffbbf76'],
+      '/etc/default/rcS' => ['/usr/share/initscripts/default.rcS'],
+      '/etc/environment' => ['44ad415fac749e0c39d6302a751db3f2'],
+      '/etc/hosts.allow' => ['8c44735847c4f69fb9e1f0d7a32e94c1'],
+      '/etc/hosts.deny' => ['92a0a19db9dc99488f00ac9e7b28eb3d'],
+      '/etc/initramfs-tools/modules' =>
+      ['/usr/share/initramfs-tools/modules'],
+      '/etc/inputrc' => ['/usr/share/readline/inputrc'],
+      '/etc/iscsi/iscsid.conf' => ['6c6fd718faae84a4ab1b276e78fea471'],
+      '/etc/kernel-img.conf' => ['f1ed9c3e91816337aa7351bdf558a442'],
+      '/etc/ld.so.conf' => ['4317c6de8564b68d628c21efa96b37e4'],
+      '/etc/networks' => ['/usr/share/base-files/networks'],
+      '/etc/nsswitch.conf' => ['/usr/share/base-files/nsswitch.conf'],
+      '/etc/pam.d/common-account' => ['9d50c7dda6ba8b6a8422fd4453722324'],
+      '/etc/pam.d/common-auth' => ['a326c972f4f3d20e5f9e1b06eef4d620'],
+      '/etc/pam.d/common-password' => ['9f2fbf01b1a36a017b16ea62c7ff4c22'],
+      '/etc/pam.d/common-session' => ['e2b72dd3efb2d6b29698f944d8723ab1'],
+      '/etc/pam.d/common-session-noninteractive' =>
+      ['508d44b6daafbc3d6bd587e357a6ff5b'],
+      '/etc/ppp/chap-secrets' => ['faac59e116399eadbb37644de6494cc4'],
+      '/etc/ppp/pap-secrets' => ['698c4d412deedc43dde8641f84e8b2fd'],
+      '/etc/ppp/peers/provider' => ['/usr/share/ppp/provider.peer'],
+      '/etc/profile' => ['/usr/share/base-files/profile'],
+      '/etc/python/debian_config' => ['7f4739eb8858d231601a5ed144099ac8'],
+      '/etc/rc.local' => ['10fd9f051accb6fd1f753f2d48371890'],
+      '/etc/rsyslog.d/50-default.conf' =>
+      ['/usr/share/rsyslog/50-default.conf'],
+      '/etc/security/opasswd' => ['d41d8cd98f00b204e9800998ecf8427e'],
+      '/etc/sgml/xml-core.cat' => ['bcd454c9bf55a3816a134f9766f5928f'],
+      '/etc/shells' => ['0e85c87e09d716ecb03624ccff511760'],
+      '/etc/ssh/sshd_config' => ['e24f749808133a27d94fda84a89bb27b',
+                                 '8caefdd9e251b7cc1baa37874149a870'],
+      '/etc/sudoers' => ['02f74ccbec48997f402a063a172abb48'],
+      '/etc/ufw/after.rules' => ['/usr/share/ufw/after.rules'],
+      '/etc/ufw/after6.rules' => ['/usr/share/ufw/after6.rules'],
+      '/etc/ufw/before.rules' => ['/usr/share/ufw/before.rules'],
+      '/etc/ufw/before6.rules' => ['/usr/share/ufw/before6.rules'],
+      '/etc/ufw/ufw.conf' => ['/usr/share/ufw/ufw.conf']
+    }
+
+    NEW_FILES_WITHIN = %w(cron.d logrotate.d rsyslog.d init)
+    CHECKSUM_FILES = %w(bash.bashrc environment inputrc rc.local ssh/ssh_config ssh/sshd_config)
+    
+    def initialize
+      @telfile = []
+
+      if fails?("grep -q Ubuntu /etc/lsb-release")
+        fatal "Sorry, --infer can only run on an Ubuntu machine."
+      end
+      
+      append "#" * 72
+      append "# Telfile inferred from #{`hostname`.strip} at #{Time.now}"
+      append "#" * 72
+      append
+      
+      user
+      ruby
+      apt
+      packages
+      files
+
+      banner "Done!"
+      $stderr.puts
+      @telfile.each { |i| puts i }
+    end
+
+    def append(s = nil)
+      @telfile << (s || "")
+    end
+
+    def user
+      append "user #{`whoami`.strip.inspect}"
+    end
+
+    def ruby
+      version = `ruby --version`
+      ruby = nil
+      case version
+      when /Ruby Enterprise Edition/ then ruby = "REE"
+      when /1\.8\.7/ then ruby = "1.8.7"
+      when /1\.9\.2/ then ruby = "1.9.2"
+      end
+      append "ruby #{ruby.inspect}" if ruby
+    end
+
+    def apt
+      banner "Calculating apt sources and keys..."
+      list = run_capture_lines("cat /etc/apt/sources.list /etc/apt/sources.list.d/*.list")
+      list = list.grep(/^deb /).sort
+      list.each do |line|
+        if line =~ /^deb http:\/\/(\S+)\s+(\S+)/
+          source, dist = $1, $2
+          file = source.chomp("/").gsub(/[^a-z0-9.-]/, "_")
+          file = "/var/lib/apt/lists/#{file}_dists_#{dist}_Release"
+          next if !File.exists?(file)
+
+          verify = run_capture("gpgv --keyring /etc/apt/trusted.gpg #{file}.gpg #{file} 2>&1")
+          key = verify[/key ID ([A-Z0-9]{8})$/, 1]
+          next if key == "437D05B5" # canonical key
+          append "apt #{line.inspect}, :key => #{key.inspect}"
+        end
+      end
+    end
+
+    def packages
+      banner "Looking for interesting packages..."      
+      @packages = Apt.new.added
+      if !@packages.empty?
+        append
+        append "# Note: You should read this package list very carefully and remove"
+        append "# packages that you don't want on your server."
+        append
+        append "packages %w(#{@packages.join(" ")})"
+      end
+    end
+
+    def files
+      banner "Looking for interesting files..."            
+      files = []
+
+      # read checksums from dpkg status
+      conf = { }
+      File.readlines("/var/lib/dpkg/status").each do |line|
+        if line =~ /^ (\S+) ([0-9a-f]{32})/
+          conf[$1] = $2
+        end
+      end
+
+      # look for changed conf files
+      $stderr.puts "  scanning conf files from interesting packages..."
+      @packages.each do |pkg|
+        list = run_capture_lines("dpkg -L #{pkg}")
+        list = list.select { |i| i =~ /^\/etc/ }.sort
+        list = list.select { |i| File.file?(i) }
+        list = list.select { |i| conf[i] && conf[i] != md5sum(i) }
+        files += list
+      end
+
+      # look for new files in NEW_FILES_WITHIN
+      dirs = NEW_FILES_WITHIN.map { |i| "/etc/#{i}" }
+      dirs.sort.each do |dir|
+        $stderr.puts "  scanning #{dir} for new files..."
+        list = Dir["#{dir}/*"].sort
+        list = list.select { |i| !MD5SUMS[i] }
+        list = list.select { |i| fails?("dpkg -S #{i}") }
+        files += list
+      end
+      
+      # now look for changed files from CHECKSUM_FILES
+      scan = CHECKSUM_FILES.map { |i| "/etc/#{i}" }
+      scan = scan.select { |i| File.file?(i) }
+      scan.each do |i|
+        new_sum = md5sum(i)
+        if old_sum = MD5SUMS[i]
+          match = old_sum.any? do |sum|
+            sum = md5sum(sum) if sum =~ /^\//
+            new_sum == sum
+          end
+          files << i if !match
+        elsif old_sum = conf[i]
+          files << i if new_sum != old_sum
+        end
+      end
+      files = files.sort
+
+      if !files.empty?
+        append
+        append "#" * 72
+        append "# Also, I think these should be included in files/"
+        append "#" * 72
+        append
+        files.each { |i| append "# #{i}" }
+        append
+        append "# You can do that with this magical command:"
+        append "#"
+        append "# mkdir files && cd files && tar cf - #{files.join(" ")} | tar xf -"
+      end
+    end
+
+    class Apt
+      include Util
+
+      BLACKLIST = /^(linux-|grub-|cloud-init)/
+      
+      Package = Struct.new(:name, :status, :deps, :base, :parents)
+
+      def initialize
+        @packages = nil
+        @map = nil
+      end
+
+      def packages
+        if !@packages
+          # run dpkg
+          lines = run_capture_lines("dpkg-query '-f=${Package}\t${Status}\t${Pre-Depends},${Depends},${Recommends}\t${Essential}\t${Priority}\n' -W")
+          @packages = lines.map do |line|
+            name, status, deps, essential, priority = line.split("\t")
+            deps = deps.gsub(/\([^)]+\)/, "")
+            deps = deps.split(/[,|]/)
+            deps = deps.map(&:strip).select { |i| !i.empty? }.sort
+            base = false
+            base = true if essential == "yes"
+            base = true if priority =~ /^(important|required|standard)$/
+            Package.new(name, status, deps, base, [])
+          end
+
+          # calculate ancestors
+          @packages.each do |pkg|
+            pkg.deps.each do |i|
+              if d = self[i]
+                d.parents << pkg.name
+              end
+            end
+          end
+          @packages.each do |pkg|
+            pkg.parents = pkg.parents.sort.uniq
+          end
+        end
+        
+        @packages
+      end
+
+      def [](name)
+        if !@map
+          @map = { }
+          packages.each { |i| @map[i.name] = i }
+        end
+        @map[name]
+      end
+
+      def base_packages
+        packages.select { |i| i.base }.map(&:name)    
+      end
+
+      def ignored_packages
+        list = packages.select { |i| i.base }.map(&:name)
+        list += %w(grub-pc installation-report language-pack-en language-pack-gnome-en linux-generic-pae linux-server os-prober ubuntu-desktop ubuntu-minimal ubuntu-standard wireless-crda)
+        dependencies(list)
+      end
+
+      def dependencies(list)
+        check = list
+        while !check.empty?
+          check = check.map do |i|
+            if pkg = self[i]
+              pkg.deps
+            end
+          end
+          check = check.compact.flatten.uniq.sort
+          check -= list
+          list += check
+        end
+        list.sort
+      end
+
+      def added
+        # calculate raw list
+        ignored = Set.new(ignored_packages)
+        list = packages.select do |i|
+          i.status == "install ok installed" && !ignored.include?(i.name)
+        end
+        list = list.map(&:name)
+
+        # now calculate parents
+        roots = []
+        check = list
+        while !check.empty?
+          check = check.map do |i|
+            if pkg = self[i]
+              if !pkg.parents.empty?
+                pkg.parents
+              else
+                roots << pkg.name
+                nil
+              end
+            end
+          end
+          check = check.compact.flatten.uniq.sort
+          check -= list
+          list += check
+        end
+
+        # blacklist
+        roots = roots.reject { |i| i =~ BLACKLIST }
+        
+        roots.sort
+      end
+    end
+  end
+end

data/lib/teleport/install.rb

@@ -51,14 +51,14 @@ module Teleport
       # do we have a server object?
       @server = @config.server(@host)
       if !@server && !@config.servers.empty?
-        fatal "Hm. I couldn't find server #{@host.inspect} in teleport.rb."
+        fatal "Hm. I couldn't find server #{@host.inspect} in Telfile."
       end
 
       @role = nil
       if @server && (role_name = @server.options[:role])
         @role = @config.role(role_name)
         if !@role
-          fatal "Hm. I couldn't find role #{role_name.inspect} in teleport.rb."
+          fatal "Hm. I couldn't find role #{role_name.inspect} in Telfile."
         end
       end
     end
@@ -88,7 +88,13 @@ module Teleport
     end
 
     def _hostname
-      banner "Hostname..."      
+      banner "Hostname..."
+
+      # ipv4?
+      return if @host =~ /^\d+(\.\d+){3}$/
+      # ipv6?
+      return if @host =~ /:/
+      
       old_hostname = `hostname`.strip
       return if old_hostname == @host
       

data/lib/teleport/main.rb

@@ -1,5 +1,4 @@
-require "erb"
-require "getoptlong"
+require "optparse"
 
 module Teleport
   # The main class for the teleport command line.
@@ -9,53 +8,83 @@ module Teleport
 
     TAR = "#{DIR}.tgz"
     
-    attr_accessor :host, :options
-    
     def initialize(cmd = :teleport)
-      opts = GetoptLong.new(
-                            ["--help", "-h", GetoptLong::NO_ARGUMENT]
-                            )
-      opts.each do |opt, arg|
-        case opt
-        when "--help"
-          usage(0)
-        end
-      end
-
-      $stderr = $stdout
+      cli(cmd)
       
-      case cmd
+      case @options[:cmd]
       when :teleport
-        teleport(ARGV.shift)
+        $stderr = $stdout
+        teleport
       when :install
+        $stderr = $stdout
         install
+      when :infer
+        infer
       end
     end
+    
+    # Parse ARGV.
+    def cli(cmd)
+      @options = { }
+      @options[:cmd] = cmd
+      @options[:file] = "Telfile"
+
+      opt = OptionParser.new do |o|
+        o.banner = "Usage: teleport <hostname>"
+        o.on("-f", "--file FILE", "use this file instead of Telfile") do |f|
+          @options[:file] = f
+        end
+        o.on("-i", "--infer", "infer a new Telfile from YOUR machine") do |f|
+          @options[:cmd] = :infer
+        end
+        o.on_tail("-h", "--help", "print this help text") do
+          puts opt
+          exit(0)
+        end
+      end
+      begin
+        opt.parse!
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        puts $!
+        puts opt
+        exit(1)
+      end
 
-    def usage(exit_code)
-      puts "Usage: teleport <hostname>"
-      puts "  --help      print this help text"
-      exit(exit_code)
+      if @options[:cmd] == :teleport
+        # print this error message early, to give the user a hint
+        # instead of complaining about command line arguments
+        if ARGV.length != 1
+          puts opt
+          exit(1)
+        end
+        @options[:host] = ARGV.shift
+      end
     end
 
+    # Read Telfile
     def read_config
-      if !File.exists?(Config::PATH)
-        fatal("Sadly, I can't find #{Config::PATH} here. Please create one.")
+      if !File.exists?(@options[:file])
+        fatal("Sadly, I can't find #{@options[:file]} here. Please create one.")
       end
-      @config = Config.new
+      @config = Config.new(@options[:file])
     end
 
-    def assemble_tgz(host)
+    # Assemble the the tgz before we teleport to the host
+    def assemble_tgz
       banner "Assembling #{TAR}..."
       rm_and_mkdir(DIR)
       
       # gem
       run("cp", ["-r", "#{File.dirname(__FILE__)}/../../lib", GEM])
+      # Telfile, if necessary
+      if @options[:file] != "Telfile"
+        run("cp", [@options[:file], "Telfile"])
+      end
       # data
       run("cp", ["-r", ".", DATA])
       # config.sh
       File.open("#{DIR}/config", "w") do |f|
-        f.puts("CONFIG_HOST='#{host}'")        
+        f.puts("CONFIG_HOST='#{@options[:host]}'")        
         f.puts("CONFIG_RUBY='#{@config.ruby}'")
         f.puts("CONFIG_RUBYGEMS='#{RUBYGEMS}'")        
       end
@@ -63,8 +92,6 @@ module Teleport
       ssh_key = "#{ENV["HOME"]}/.ssh/#{PUBKEY}"
       if File.exists?(ssh_key)
         run("cp", [ssh_key, DIR])
-      else
-        puts "Could not find #{ssh_key} - skipping."
       end
       
       Dir.chdir(File.dirname(DIR)) do
@@ -72,10 +99,16 @@ module Teleport
       end
     end
 
-    def ssh_tgz(host)
+    # Copy the tgz to the host, then run there.
+    def ssh_tgz
       begin
-        banner "scp #{TAR} to #{host}:#{TAR}..."
-        run "scp #{TAR} #{host}:#{TAR}"
+        banner "scp #{TAR} to #{@options[:host]}:#{TAR}..."
+
+        args = []
+        args += @config.ssh_options if @config.ssh_options        
+        args << TAR
+        args << "#{@options[:host]}:#{TAR}"
+        run("scp", args)
 
         cmd = [
                "cd /tmp",
@@ -84,27 +117,37 @@ module Teleport
                "sudo tar xfpz #{TAR}",
                "sudo #{DIR}/gem/teleport/run.sh"
               ]
-        banner "ssh to #{host} and run..."
-        run("ssh", [host, cmd.join(" && ")])
+        banner "ssh to #{@options[:host]} and run..."
+
+        args = []
+        args += @config.ssh_options if @config.ssh_options
+        args << @options[:host]
+        args << cmd.join(" && ")
+        run("ssh", args)
       rescue RunError
         fatal("Failed!")
       end
       banner "Success!"
     end
 
-    def teleport(host)
+    # Teleport to the host.
+    def teleport
       read_config
-      usage(1) if !host
-      assemble_tgz(host)
-      ssh_tgz(host)
+      assemble_tgz
+      ssh_tgz
     end
 
+    # We're running on the host - install!
     def install
       Dir.chdir(DATA) do
         read_config
       end
       Install.new(@config)
     end
-    
+
+    # try to infer a new Telfile based on the current machine
+    def infer
+      Infer.new
+    end
   end
 end

data/lib/teleport/mirror.rb

@@ -31,8 +31,12 @@ module Teleport
         copy_metadata(path, tmp)
         path = tmp
       end
-      
-      cp_if_necessary(path, dst, user_for_file(dst), mode_for_file(dst))
+
+      if !File.symlink?(path)
+        cp_if_necessary(path, dst, user_for_file(dst), mode_for_file(dst))
+      else
+        ln_if_necessary(File.readlink(path), dst)
+      end
     end
 
     # Install directory from the teleport data directory into the

data/lib/teleport/run.sh

@@ -90,15 +90,15 @@ function install_ruby_ree() {
 #
 
 # are we on Ubuntu?
-if ! uname -a | grep -q Ubuntu ; then
+if ! grep -q Ubuntu /etc/lsb-release ; then
   fatal "Teleport only works with Ubuntu"
 fi
 
 # which version?
 . /etc/lsb-release
-case $($DISTRIB_RELEASE) in
-  10.* ) ;; # nop
-  11.04) ;; # nop
+case $DISTRIB_RELEASE in
+  10.*  ) ;; # nop
+  11.04 ) ;; # nop
   *)
     banner "warning - Ubuntu $DISTRIB_RELEASE hasn't been tested with Teleport yet"
 esac

data/lib/teleport/util.rb

@@ -1,4 +1,5 @@
 require "cgi"
+require "digest/md5"
 require "etc"
 require "fileutils"
 
@@ -56,7 +57,7 @@ module Teleport
     end
 
     # Run a command, raise an error upon failure. The output is
-    # capture as a string and returned.
+    # captured as a string and returned.
     def run_capture(command, *args)
       if !args.empty?
         args = args.flatten.map { |i| shell_escape(i) }.join(" ")
@@ -72,6 +73,13 @@ module Teleport
       result
     end
 
+    # Run a command and split the result into lines, raise an error
+    # upon failure. The output is captured as an array of strings and
+    # returned.
+    def run_capture_lines(command, *args)
+      run_capture(command, args).split("\n")
+    end
+
     # Run a command but don't send any output to $stdout/$stderr.
     def run_quietly(command, *args)
       if !args.empty?
@@ -304,7 +312,18 @@ module Teleport
       end
       false
     end
-    
+
+    # Calculate the md5 checksum for a file
+    def md5sum(path)
+      digest, buf = Digest::MD5.new, ""
+      File.open(path) do |f|
+        while f.read(4096, buf)
+          digest.update(buf)
+        end
+      end
+      digest.hexdigest
+    end
+
     private
 
     # Returns true if verbosity is turned on.

data/lib/teleport/version.rb

@@ -1,4 +1,4 @@
 module Teleport
   # Gem version
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/end_to_end_spec.rb

@@ -0,0 +1,39 @@
+require "erb"
+require "spec_helper"
+
+describe "a new ec2 instance" do
+  ec2
+
+  telfile do
+    <<EOF
+user "gub"
+ruby "1.8.7"
+ssh_options ["-o", "User=ubuntu", "-o", "StrictHostKeyChecking=no", "-o", "IdentityFile=#{ENV["TELEPORT_SSH_KEY"]}"]
+
+role :master, :packages => %w(nginx)
+server "#{$ec2_ip_address}", :role => :master, :packages => %w(strace)
+packages %w(atop)
+
+before_install do
+  puts "BEFORE_INSTALL"
+end
+
+after_install do
+  puts "AFTER_INSTALL"
+  run "touch /tmp/gub.txt"
+end
+EOF
+  end
+
+  it "installs properly" do
+    ARGV.clear
+    ARGV << $ec2_ip_address
+    Teleport::Main.new
+  end
+
+  it "installs again" do
+    ARGV.clear
+    ARGV << $ec2_ip_address
+    Teleport::Main.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+SUPPORT = "#{File.dirname(__FILE__)}/support"
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH << File.dirname(__FILE__)
+$LOAD_PATH << SUPPORT
+
+require "awesome_print"
+require "rspec"
+require "teleport"
+
+Dir["#{SUPPORT}/*.rb"].each { |i| require File.basename(i) }
+
+TELDIRS = "#{File.dirname(__FILE__)}/teldirs"
+
+RSpec.configure do |config|
+  config.extend Support::Telfile  
+  config.extend Support::Ec2
+
+  ec2_configured = Support::Ec2.configured?
+  warn(Support::Ec2.message) if !ec2_configured
+
+  config.filter_run_excluding(:config => lambda { |value|
+    return true if value == :ec2 && !ec2_configured
+  })
+end

data/spec/support/ec2.rb

@@ -0,0 +1,115 @@
+require "AWS"
+
+# spin up a fresh ec2 instance
+module Support
+  module Ec2
+    AMI_10_04 = "fbbf7892"
+    AMI_10_10 = "08f40561"
+    AMI_11_04 = "68ad5201"
+    KEYPAIR = "teleport"
+    GROUP = "teleport"
+
+    AMI = "ami-#{AMI_10_04}"
+
+    def self.configured?
+      ENV["TELEPORT_ACCESS_KEY_ID"] && ENV["TELEPORT_SECRET_ACCESS_KEY"] && ENV["TELEPORT_SSH_KEY"]
+    end
+
+    def self.message
+      <<EOF
+------------------------------------------------------------------------
+If you want to test against EC2, do the following:
+
+1. Create a "teleport" keypair on EC2.
+2. Set the TELEPORT_ACCESS_KEY_ID, TELEPORT_SECRET_ACCESS_KEY and
+   TELEPORT_SSH_KEY environment variables.
+
+End-to-end tests that rely on EC2 will be skipped in the meantime.
+------------------------------------------------------------------------
+EOF
+    end
+
+    #
+    # specs call this
+    #
+
+    def ec2
+      controller = nil
+      before(:all) do
+        if ENV["TELEPORT_IP"]
+          $ec2_ip_address = ENV["TELEPORT_IP"]
+        else
+          controller = Controller.new
+          controller.stop
+          $ec2_ip_address = controller.start
+        end
+      end
+      after(:all) do
+        controller.stop if controller
+      end
+    end
+
+    #
+    # this controller class does all the work
+    # 
+
+    class Controller
+      def initialize
+        raise "not configured" if !Support::Ec2::configured?
+        @ec2 = AWS::EC2::Base.new(:access_key_id => ENV["TELEPORT_ACCESS_KEY_ID"], :secret_access_key => ENV["TELEPORT_SECRET_ACCESS_KEY"])
+      end
+      
+      def start
+        puts "Running new ec2 instance..."
+        # setup security group and allow ssh
+        begin
+          @ec2.create_security_group(:group_name => GROUP, :group_description => GROUP)
+        rescue AWS::InvalidGroupDuplicate
+          # ignore
+        end
+        @ec2.authorize_security_group_ingress(:group_name => GROUP, :ip_protocol => "tcp", :from_port => 22, :to_port => 22)        
+
+        # create the instance
+        @ec2.run_instances(:image_id => AMI, :instance_type => "m1.large", :key_name => KEYPAIR, :security_group => GROUP)
+
+        # wait for the new instance to start
+        puts "Waiting for ec2 instance to start..."
+        while true
+          sleep 3
+          instance = describe_instances.first
+          status = instance["instanceState"]["name"]
+          puts "  #{instance["instanceId"]}: #{status}"
+          break if status == "running"
+        end
+
+        # return the ip address
+        ip = instance["ipAddress"]
+        puts "  #{instance["instanceId"]}: #{ip}"
+        puts "  sleeping to give ssh a chance to start..."
+        sleep 10
+        ip
+      end
+
+      def stop
+        puts "Terminating existing ec2 instances..."
+        ids = describe_instances.map { |i| i["instanceId"] }
+        if !ids.empty?
+          puts "  terminate: #{ids.join(" ")}"
+          @ec2.terminate_instances(:instance_id => ids)
+        end
+      end
+
+      def describe_instances
+        list = []
+        hash = @ec2.describe_instances
+        if hash = hash["reservationSet"]
+          list = hash["item"].map { |i| i["instancesSet"]["item"] }.flatten
+        end
+        # cull stuff we don't care about
+        list = list.select { |i| i["keyName"] == KEYPAIR }
+        list = list.select { |i| i["instanceState"]["name"] !~ /terminated|shutting-down/ }
+        list
+      end
+    end
+  end
+end

data/spec/support/exit_code.rb

@@ -0,0 +1,29 @@
+# http://stackoverflow.com/questions/5118745/is-systemexit-a-special-kind-of-exception
+
+module ExitCodeMatchers
+  RSpec::Matchers.define :exit_with_code do |code|
+    actual = nil
+    match do |block|
+      begin
+        block.call
+      rescue SystemExit => e
+        actual = e.status
+      end
+      actual && actual == code
+    end
+    failure_message_for_should do |block|
+      "expected block to call exit(#{code}) but exit" +
+        (actual.nil? ? " not called" : "(#{actual}) was called")
+    end
+    failure_message_for_should_not do |block|
+      "expected block not to call exit(#{code})"
+    end
+    description do
+      "expect block to call exit(#{code})"
+    end    
+  end  
+end
+
+RSpec.configure do |config|
+  config.include(ExitCodeMatchers)
+end

data/spec/support/telfile.rb

@@ -0,0 +1,25 @@
+# run inside a specific dir
+module Support
+  module Telfile
+    TMP = "/tmp/teleport_spec"
+
+    def telfile(contents = nil, &block)
+      pwd = nil
+      before(:all) do
+        pwd = Dir.pwd
+        `rm -rf #{TMP} && mkdir -p #{TMP}`
+        Dir.chdir(TMP)
+        File.open("Telfile", "w") do |f|
+          if block
+            contents = block.call
+          end
+          f.puts(contents)
+        end
+      end
+      
+      after(:all) do
+        Dir.chdir(pwd)
+      end
+    end
+  end
+end

data/spec/unit/teleport/config_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Teleport::Config do
+  context "with a blank Telfile" do
+    telfile("")
+
+    let(:config) do
+      Teleport::Config.new
+    end
+    it "defaults to the current username" do
+      config.user.should == `whoami`.strip      
+    end
+    it "defaults to the first vm in RUBIES" do
+      config.ruby.should == Teleport::Config::RUBIES.first
+    end
+  end
+
+  context "with a simple Telfile" do
+    telfile do
+      <<EOF
+user "somebody"
+ruby "1.8.7"
+
+role :master, :packages => %w(nginx)
+role :slave, :packages => %w(memcached)
+server "one", :role => :master, :packages => %w(strace)
+server "two", :role => :slave, :packages => %w(telnet)
+packages %w(atop)
+apt "blah blah blah", :key => "123"
+
+before_install do
+  puts "before_install running"
+end
+
+after_install do
+  puts "after_install running"
+end
+EOF
+      end
+    
+    let(:config) do
+      Teleport::Config.new
+    end
+    it "has the master role" do
+      config.role(:master).name.should == :master
+      config.role(:master).packages.should == %w(nginx)
+    end
+    it "has server one" do
+      config.server("one").name.should == "one"
+      config.server("one").packages.should == %w(strace)
+    end
+    it "has default packages" do
+      config.packages.should == %w(atop)
+    end
+    it "has callbacks" do
+      config.callbacks[:before_install].should_not == nil
+      config.callbacks[:after_install].should_not == nil      
+    end
+    it "has an apt line" do
+      config.apt.first.line.should == "blah blah blah"
+      config.apt.first.options[:key].should == "123"      
+    end
+  end
+end

data/teleport.gemspec

@@ -1,4 +1,5 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+
 require "teleport/version"
 
 Gem::Specification.new do |s|
@@ -8,11 +9,17 @@ Gem::Specification.new do |s|
   s.authors     = ["Adam Doppelt"]
   s.email       = ["amd@gurge.com"]
   s.homepage    = "http://github.com/rglabs/teleport"  
-  s.summary     = %Q{Teleport - opinionated Ubuntu server setup with Ruby.}
-  s.description = %Q{Easy Ubuntu server setup via teleportation.}
+  s.summary     = "Teleport - opinionated Ubuntu server setup with Ruby."
+  s.description = "Easy Ubuntu server setup via teleportation."
 
   s.rubyforge_project = "teleport"
 
+  s.add_development_dependency("amazon-ec2")
+  s.add_development_dependency("awesome_print")
+  s.add_development_dependency("rake")  
+  s.add_development_dependency("rdoc", ["~> 3.9"])  
+  s.add_development_dependency("rspec", ["~> 2.6"])
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: teleport
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Adam Doppelt
@@ -15,10 +15,81 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-03 00:00:00 -07:00
+date: 2011-08-10 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amazon-ec2
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 9
+        version: "3.9"
+  requirement: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  requirement: *id005
+  prerelease: false
 description: Easy Ubuntu server setup via teleportation.
 email: 
 - amd@gurge.com
@@ -38,12 +109,19 @@ files:
 - lib/teleport.rb
 - lib/teleport/config.rb
 - lib/teleport/constants.rb
+- lib/teleport/infer.rb
 - lib/teleport/install.rb
 - lib/teleport/main.rb
 - lib/teleport/mirror.rb
 - lib/teleport/run.sh
 - lib/teleport/util.rb
 - lib/teleport/version.rb
+- spec/end_to_end_spec.rb
+- spec/spec_helper.rb
+- spec/support/ec2.rb
+- spec/support/exit_code.rb
+- spec/support/telfile.rb
+- spec/unit/teleport/config_spec.rb
 - teleport.gemspec
 has_rdoc: true
 homepage: http://github.com/rglabs/teleport