ghost 0.2.8 → 0.3.0

data/lib/ghost/ssh_config.rb

@@ -0,0 +1,110 @@
+module Ghost
+  class SshConfigDuplicateError < StandardError; end
+
+  class SshConfig
+    @@ssh_config = "#{ENV['HOME']}/.ssh/config"
+
+    attr_accessor :host, :hostname, :user, :port
+    alias :to_s :host
+
+    def initialize(host, hostname, user, port)
+      @host = host
+      @hostname = hostname
+      @user = user
+      @port = port
+    end
+
+    class << self
+      protected :new
+
+      def list
+        lines = File.read(@@ssh_config).split("\n")
+
+        entries = []
+        current_entry = []
+
+        lines << ""
+        lines.each do |line|
+          if line.strip.empty?
+            entries << parse(current_entry) if current_entry.any?
+            current_entry = []
+          else
+            current_entry << line
+          end
+        end
+
+        entries
+      end
+
+      def add(args)
+        host = args[:host]
+        hostname = args[:hostname]
+        user = args[:user] || "root"
+        port = args[:port] || "22"
+
+        force = args[:force]
+
+        if find_by_host(host).nil? || force
+          delete(host)
+
+          new_config = SshConfig.new(host, hostname, user, port)
+
+          configs = list
+          configs << new_config
+
+          write(configs)
+
+          new_config
+        else
+          raise SshConfigDuplicateError, "Can not overwrite existing record"
+        end
+      end
+
+      def find_by_host(host)
+        list.find { |c| c.host == host }
+      end
+
+      def empty!
+        write([])
+      end
+
+      def delete(host)
+        configs = list
+        configs = configs.delete_if { |c| c.host == host }
+        write(configs)
+      end
+
+      def write(configs)
+        hosts = []
+
+        configs.sort! { |a,b| a.host <=> b.host }
+        configs.each do |c|
+          hosts << "Host #{c.host}"
+          hosts << "  HostName #{c.hostname}"
+          hosts << "  User #{c.user}" if c.user
+          hosts << "  Port #{c.port}" if c.port
+          hosts << ""
+        end
+
+        File.open(@@ssh_config, 'w') {|f| f.print hosts.join("\n") }
+      end
+
+      def parse(config)
+        host = config.first[/Host (.*)/, 1]
+        config_hash = {}
+
+        config[1..-1].each do |entry|
+          entry.strip!
+          next if entry.empty?
+          key, value = entry.strip.split(" ")
+          config_hash[key.downcase] = value
+        end
+
+        SshConfig.new(host,
+          config_hash['hostname'], config_hash['user'],
+          config_hash['port'])
+      end
+
+    end
+  end
+end

data/spec/etc_hosts_spec.rb

@@ -2,154 +2,189 @@ require 'ghost/linux-host'
 
 $hosts_file   = File.expand_path(File.join(File.dirname(__FILE__), "etc_hosts"))
 
-describe Host do
+describe Ghost::Host do
   before(:all) do
-    class Host
+    class Ghost::Host
       @@hosts_file = $hosts_file
     end
   end
   before { `touch #{$hosts_file.inspect}` }
   after  { `rm -f #{$hosts_file.inspect}` }
-  
+
   it "has an IP" do
     hostname = 'ghost-test-hostname.local'
 
-    Host.add(hostname)
-    host = Host.list.first
+    Ghost::Host.add(hostname)
+    host = Ghost::Host.list.first
     host.ip.should eql('127.0.0.1')
 
-    Host.empty!
+    Ghost::Host.empty!
 
     ip = '169.254.23.121'
-    host = Host.add(hostname, ip)
+    host = Ghost::Host.add(hostname, ip)
     host.ip.should eql(ip)
   end
 
   it "has a hostname" do
     hostname = 'ghost-test-hostname.local'
 
-    Host.add(hostname)
-    host = Host.list.first
+    Ghost::Host.add(hostname)
+    host = Ghost::Host.list.first
     host.hostname.should eql(hostname)
 
-    Host.empty!
+    Ghost::Host.empty!
 
     ip = '169.254.23.121'
-    Host.add(hostname, ip)
+    Ghost::Host.add(hostname, ip)
     host.hostname.should eql(hostname)
   end
-  
+
   describe ".list" do
     it "returns an array" do
-      Host.list.should be_instance_of(Array)
+      Ghost::Host.list.should be_instance_of(Array)
     end
 
-    it "contains instances of Host" do
-      Host.add('ghost-test-hostname.local')
-      Host.list.first.should be_instance_of(Host)
+    it "contains instances of Ghost::Host" do
+      Ghost::Host.add('ghost-test-hostname.local')
+      Ghost::Host.list.first.should be_instance_of(Ghost::Host)
     end
-    
+
     it "gets all hosts on a single /etc/hosts line" do
-      example = "127.0.0.1\tproject_a.local\t\t\tproject_b.local   project_c.local"
-      File.open($hosts_file, 'w') {|f| f << example}
-      hosts = Host.list
-      hosts.should have(3).items
-      hosts.map{|h|h.ip}.uniq.should == ['127.0.0.1']
-      hosts.map{|h|h.host}.sort.should == %w[project_a.local project_b.local project_c.local]
-      Host.add("project_d.local")
-      Host.list.should have(4).items
+      example = <<-EoEx
+              127.0.0.1      localhost.localdomain
+              # ghost start
+                 123.123.123.1     project_a.local\t\tproject_b.local   project_c.local
+                 127.0.0.1         local.bb
+              # ghost end
+      EoEx
+      File.open($hosts_file, 'w') {|f| f << example.gsub!(/^\s*/, '')}
+      hosts = Ghost::Host.list
+      hosts.should have(4).items
+      hosts.map{|h|h.ip}.uniq.sort.should == ['123.123.123.1', '127.0.0.1']
+      hosts.map{|h|h.host}.sort.should == %w[local.bb project_a.local project_b.local project_c.local]
+
+      Ghost::Host.add("project_d.local")
+      Ghost::Host.list.should have(5).items
     end
   end
-  
+
+
+  it "does not change hosts files outside of control tokens" do
+    f = File.open($hosts_file, 'w')
+    f.write "10.0.0.23 adserver.example.com\n"
+    f.close
+    hosts = Ghost::Host.list
+    hosts.should have(0).items
+
+    hostname = "ghost-test-hostname-b.local"
+    Ghost::Host.add(hostname)
+    Ghost::Host.list.should have(1).items
+
+    hostsfile = File.read($hosts_file)
+    hostsfile.should =~ /^10.0.0.23 adserver.example.com\n/
+  end
+
+  it "adds control tokens to untouched hosts files" do
+    f = File.open($hosts_file, 'w')
+    f.write "10.0.0.23 adserver.example.com\n"
+    f.close
+    hostname = "ghost-test-hostname-b.local"
+    ip = '123.45.67.89'
+    Ghost::Host.add(hostname, ip)
+
+    hostsfile = File.read($hosts_file)
+    hostsfile.should =~ /# ghost start\n#{ip}\s+#{hostname}\n# ghost end/
+  end
+
   describe "#to_s" do
     it "returns hostname" do
       hostname = 'ghost-test-hostname.local'
 
-      Host.add(hostname)
-      host = Host.list.first
+      Ghost::Host.add(hostname)
+      host = Ghost::Host.list.first
       host.to_s.should eql(hostname)
     end
   end
 
   describe "finder methods" do
     before do
-      Host.add('abc.local')
-      Host.add('def.local')
-      Host.add('efg.local', '10.2.2.4')
+      Ghost::Host.add('abc.local')
+      Ghost::Host.add('def.local')
+      Ghost::Host.add('efg.local', '10.2.2.4')
     end
 
-    it "returns valid Host when searching for host name" do
-      Host.find_by_host('abc.local').should be_instance_of(Host)
+    it "returns valid Ghost::Host when searching for host name" do
+      Ghost::Host.find_by_host('abc.local').should be_instance_of(Ghost::Host)
     end
   end
 
   describe ".add" do
-    it "returns Host object when passed hostname" do
-      Host.add('ghost-test-hostname.local').should be_instance_of(Host)
+    it "returns Ghost::Host object when passed hostname" do
+      Ghost::Host.add('ghost-test-hostname.local').should be_instance_of(Ghost::Host)
     end
 
-    it "returns Host object when passed hostname" do
-      Host.add('ghost-test-hostname.local', '10.0.0.2').should be_instance_of(Host)
+    it "returns Ghost::Host object when passed hostname" do
+      Ghost::Host.add('ghost-test-hostname.local', '10.0.0.2').should be_instance_of(Ghost::Host)
     end
 
     it "raises error if hostname already exists and not add a duplicate" do
-      Host.empty!
-      Host.add('ghost-test-hostname.local')
-      lambda { Host.add('ghost-test-hostname.local') }.should raise_error
-      Host.list.should have(1).thing
+      Ghost::Host.empty!
+      Ghost::Host.add('ghost-test-hostname.local')
+      lambda { Ghost::Host.add('ghost-test-hostname.local') }.should raise_error
+      Ghost::Host.list.should have(1).thing
     end
 
     it "overwrites existing hostname if forced" do
       hostname = 'ghost-test-hostname.local'
 
-      Host.empty!
-      Host.add(hostname)
+      Ghost::Host.empty!
+      Ghost::Host.add(hostname)
 
-      Host.list.first.hostname.should eql(hostname)
-      Host.list.first.ip.should eql('127.0.0.1')
+      Ghost::Host.list.first.hostname.should eql(hostname)
+      Ghost::Host.list.first.ip.should eql('127.0.0.1')
 
-      Host.add(hostname, '10.0.0.1', true)
-      Host.list.first.hostname.should eql(hostname)
-      Host.list.first.ip.should eql('10.0.0.1')
+      Ghost::Host.add(hostname, '10.0.0.1', true)
+      Ghost::Host.list.first.hostname.should eql(hostname)
+      Ghost::Host.list.first.ip.should eql('10.0.0.1')
 
-      Host.list.should have(1).thing
+      Ghost::Host.list.should have(1).thing
     end
-    
+
     it "should add a hostname using second hostname's ip" do
       hostname = 'ghost-test-hostname.local'
       alias_hostname = 'ghost-test-alias-hostname.local'
 
-      Host.empty!
+      Ghost::Host.empty!
 
-      Host.add(hostname)
-      Host.add(alias_hostname, hostname)
+      Ghost::Host.add(hostname)
+      Ghost::Host.add(alias_hostname, hostname)
 
-      Host.list.last.ip.should eql(Host.list.first.ip)
+      Ghost::Host.list.last.ip.should eql(Ghost::Host.list.first.ip)
     end
 
     it "should raise SocketError if it can't find hostname's ip" do
-      Host.empty!
-      lambda { Host.add('ghost-test-alias-hostname.google', 'google') }.should raise_error(SocketError)
+      Ghost::Host.empty!
+      lambda { Ghost::Host.add('ghost-test-alias-hostname.google', 'google') }.should raise_error(SocketError)
     end
   end
 
   describe ".empty!" do
     it "empties the hostnames" do
-      Host.add('ghost-test-hostname.local') # add a hostname to be sure
-      Host.empty!
-      Host.list.should have(0).things
+      Ghost::Host.add('ghost-test-hostname.local') # add a hostname to be sure
+      Ghost::Host.empty!
+      Ghost::Host.list.should have(0).things
     end
   end
 
   describe ".delete_matching" do
     it "deletes matching hostnames" do
       keep = 'ghost-test-hostname-keep.local'
-      Host.add(keep)
-      Host.add('ghost-test-hostname-match1.local')
-      Host.add('ghost-test-hostname-match2.local')
-      Host.delete_matching('match')
-      Host.list.should have(1).thing
-      Host.list.first.hostname.should eql(keep)
+      Ghost::Host.add(keep)
+      Ghost::Host.add('ghost-test-hostname-match1.local')
+      Ghost::Host.add('ghost-test-hostname-match2.local')
+      Ghost::Host.delete_matching('match')
+      Ghost::Host.list.should have(1).thing
+      Ghost::Host.list.first.hostname.should eql(keep)
     end
   end
 end

data/spec/ghost_spec.rb

@@ -3,149 +3,149 @@ require 'ghost'
 
 # Warning: these tests will delete all hostnames in the system. Please back them up first
 
-Host.empty!
+Ghost::Host.empty!
+
+describe Ghost::Host, ".list" do
+  after(:each) { Ghost::Host.empty! }
 
-describe Host, ".list" do
-  after(:each) { Host.empty! }
-  
   it "should return an array" do
-    Host.list.should be_instance_of(Array)
+    Ghost::Host.list.should be_instance_of(Array)
   end
-  
-  it "should contain instances of Host" do
-    Host.add('ghost-test-hostname.local')
-    Host.list.first.should be_instance_of(Host)
+
+  it "should contain instances of Ghost::Host" do
+    Ghost::Host.add('ghost-test-hostname.local')
+    Ghost::Host.list.first.should be_instance_of(Ghost::Host)
   end
 end
 
-describe Host do
-  after(:each) { Host.empty! }
-  
+describe Ghost::Host do
+  after(:each) { Ghost::Host.empty! }
+
   it "should have an IP" do
     hostname = 'ghost-test-hostname.local'
-    
-    Host.add(hostname)
-    host = Host.list.first
+
+    Ghost::Host.add(hostname)
+    host = Ghost::Host.list.first
     host.ip.should eql('127.0.0.1')
-    
-    Host.empty!
-    
+
+    Ghost::Host.empty!
+
     ip = '169.254.23.121'
-    host = Host.add(hostname, ip)
+    host = Ghost::Host.add(hostname, ip)
     host.ip.should eql(ip)
   end
-  
+
   it "should have a hostname" do
     hostname = 'ghost-test-hostname.local'
-    
-    Host.add(hostname)
-    host = Host.list.first
+
+    Ghost::Host.add(hostname)
+    host = Ghost::Host.list.first
     host.hostname.should eql(hostname)
-    
-    Host.empty!
-    
+
+    Ghost::Host.empty!
+
     ip = '169.254.23.121'
-    Host.add(hostname, ip)
+    Ghost::Host.add(hostname, ip)
     host.hostname.should eql(hostname)
   end
-  
+
   it ".to_s should return hostname" do
     hostname = 'ghost-test-hostname.local'
-    
-    Host.add(hostname)
-    host = Host.list.first
+
+    Ghost::Host.add(hostname)
+    host = Ghost::Host.list.first
     host.to_s.should eql(hostname)
   end
 end
 
-describe Host, "finder methods" do
-  after(:all) { Host.empty! }
+describe Ghost::Host, "finder methods" do
+  after(:all) { Ghost::Host.empty! }
   before(:all) do
-    Host.add('abc.local')
-    Host.add('def.local')
-    Host.add('efg.local', '10.2.2.4')
+    Ghost::Host.add('abc.local')
+    Ghost::Host.add('def.local')
+    Ghost::Host.add('efg.local', '10.2.2.4')
   end
-  
-  it "should return valid Host when searching for host name" do
-    Host.find_by_host('abc.local').should be_instance_of(Host)
+
+  it "should return valid Ghost::Host when searching for host name" do
+    Ghost::Host.find_by_host('abc.local').should be_instance_of(Ghost::Host)
   end
-  
+
 end
 
-describe Host, ".add" do
-  after(:each) { Host.empty! }
-  
-  it "should return Host object when passed hostname" do
-    Host.add('ghost-test-hostname.local').should be_instance_of(Host)
+describe Ghost::Host, ".add" do
+  after(:each) { Ghost::Host.empty! }
+
+  it "should return Ghost::Host object when passed hostname" do
+    Ghost::Host.add('ghost-test-hostname.local').should be_instance_of(Ghost::Host)
   end
-  
-  it "should return Host object when passed hostname" do
-    Host.add('ghost-test-hostname.local', '10.0.0.2').should be_instance_of(Host)
+
+  it "should return Ghost::Host object when passed hostname" do
+    Ghost::Host.add('ghost-test-hostname.local', '10.0.0.2').should be_instance_of(Ghost::Host)
   end
-  
+
   it "should raise error if hostname already exists and not add a duplicate" do
-    Host.empty!
-    Host.add('ghost-test-hostname.local')
-    lambda { Host.add('ghost-test-hostname.local') }.should raise_error
-    Host.list.should have(1).thing
+    Ghost::Host.empty!
+    Ghost::Host.add('ghost-test-hostname.local')
+    lambda { Ghost::Host.add('ghost-test-hostname.local') }.should raise_error
+    Ghost::Host.list.should have(1).thing
   end
-  
+
   it "should overwrite existing hostname if forced" do
     hostname = 'ghost-test-hostname.local'
-    
-    Host.empty!
-    Host.add(hostname)
-    
-    Host.list.first.hostname.should eql(hostname)
-    Host.list.first.ip.should eql('127.0.0.1')
-    
-    Host.add(hostname, '10.0.0.1', true)
-    Host.list.first.hostname.should eql(hostname)
-    Host.list.first.ip.should eql('10.0.0.1')
-    
-    Host.list.should have(1).thing
+
+    Ghost::Host.empty!
+    Ghost::Host.add(hostname)
+
+    Ghost::Host.list.first.hostname.should eql(hostname)
+    Ghost::Host.list.first.ip.should eql('127.0.0.1')
+
+    Ghost::Host.add(hostname, '10.0.0.1', true)
+    Ghost::Host.list.first.hostname.should eql(hostname)
+    Ghost::Host.list.first.ip.should eql('10.0.0.1')
+
+    Ghost::Host.list.should have(1).thing
   end
-  
+
   it "should add a hostname using second hostname's ip" do
     hostname = 'ghost-test-hostname.local'
     alias_hostname = 'ghost-test-alias-hostname.local'
-    
-    Host.empty!
-    
-    Host.add(hostname)
-    Host.add(alias_hostname, hostname)
-    
-    Host.list.last.ip.should eql(Host.list.first.ip)
+
+    Ghost::Host.empty!
+
+    Ghost::Host.add(hostname)
+    Ghost::Host.add(alias_hostname, hostname)
+
+    Ghost::Host.list.last.ip.should eql(Ghost::Host.list.first.ip)
   end
-  
+
   it "should raise SocketError if it can't find hostname's ip" do
-    Host.empty!
-    lambda { Host.add('ghost-test-alias-hostname.google', 'google') }.should raise_error(SocketError)
+    Ghost::Host.empty!
+    lambda { Ghost::Host.add('ghost-test-alias-hostname.google', 'google') }.should raise_error(SocketError)
   end
 end
 
-describe Host, ".empty!" do
+describe Ghost::Host, ".empty!" do
   it "should empty the hostnames" do
-    Host.add('ghost-test-hostname.local') # add a hostname to be sure
-    Host.empty!
-    Host.list.should have(0).things
+    Ghost::Host.add('ghost-test-hostname.local') # add a hostname to be sure
+    Ghost::Host.empty!
+    Ghost::Host.list.should have(0).things
   end
 end
 
-describe Host, ".delete_matching" do
+describe Ghost::Host, ".delete_matching" do
   it "should delete matching hostnames" do
     keep = 'ghost-test-hostname-keep.local'
-    Host.add(keep)
-    Host.add('ghost-test-hostname-match1.local')
-    Host.add('ghost-test-hostname-match2.local')
-    Host.delete_matching('match')
-    Host.list.should have(1).thing
-    Host.list.first.hostname.should eql(keep)
+    Ghost::Host.add(keep)
+    Ghost::Host.add('ghost-test-hostname-match1.local')
+    Ghost::Host.add('ghost-test-hostname-match2.local')
+    Ghost::Host.delete_matching('match')
+    Ghost::Host.list.should have(1).thing
+    Ghost::Host.list.first.hostname.should eql(keep)
   end
 end
 
 
-describe Host, ".backup and", Host, ".restore" do
+describe Ghost::Host, ".backup and", Ghost::Host, ".restore" do
   it "should return a yaml file of all hosts and IPs when backing up"
   it "should empty the hosts and restore only the ones in given yaml"
 end