rouster 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddfb8d54a1eb8670b64d6638c81866bc49764af6
+  data.tar.gz: 3b4f207c05540dc6daa16cfe29d46948b8ff3aab
+SHA512:
+  metadata.gz: 2878c4b222c5ff88a77db0a88ae5102752f6fcdb31fe7613cdba71f8c51b4228db33f0e4a9c34aa62e184f43e0b183fb66cb5574843673c009d12d32f18b35f5
+  data.tar.gz: 910cd5e1519e3de2f0c759799a04d8dce487e97d8c29f456061a75cf63e9cbae97023ecd8feeb5e047165d1f22c5e80be88f6be61fa9ddfd7d3d233108292415

data/.gitignore

@@ -0,0 +1,6 @@
+doc/*
+.vagrant
+*.box
+*.swp
+*tmp*
+*.gem

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2012, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+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.
+Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER 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.

data/README.md

@@ -0,0 +1,175 @@
+Rouster
+======
+
+```rb
+Rouster.is_a?('abstraction layer for controlling Vagrant virtual machines')
+=> true
+```
+
+Rouster was conceived as the missing piece needed to functionally test Puppet manifests: while RSpec is nice (and _much_ faster), compiling a catalog and applying it are 2 distinct operations.
+
+```rb
+app = Rouster.new(:name => 'app' )
+app.up()
+
+p app.run('/sbin/service puppet once -t', 2)
+# or p app.run_puppet('master', { :expected_exitcode => 2}), if you've required 'rouster/puppet'
+
+app.destroy()
+```
+
+The first implementation of Rouster was in Perl, called [Salesforce::Vagrant](http://github.com/forcedotcom/SalesforceVagrant). Salesforce::Vagrant is functional, but new functionality may or may not be ported back.
+
+## Requirements
+
+* [Ruby](http://rubylang.org), version 2.0+ (best attempt made to support 1.8.7 and 1.9.3 as well)
+* [Vagrant](http://vagrantup.com), version 1.0.5+
+
+Note: Vagrant itself requires VirtualBox or VMWare Fusion (1.0.3+)
+
+Note: Rouster should work exactly the same on Windows as it does on \*nix and OSX (minus rouster/deltas.rb functionality, at least currently),
+but no real testing has been done to confirm this. Please file issues as appropriate.
+
+### From-source installation (latest)
+
+```sh
+git clone https://github.com/chorankates/rouster.git
+cd rouster
+rake buildgem
+gem install rouster-<version>.gem
+```
+
+### pre-built gem installation (stable)
+
+[RubyGems](http://rubygems.org/gems/rouster)
+[![Gem Version](https://badge.fury.io/rb/rouster.png)](http://badge.fury.io/rb/rouster)
+
+```sh
+gem install rouster
+```
+
+## Using Rouster
+
+Rouster supports many of the vagrant faces:
+* destroy()
+* suspend()
+* status()
+* up()
+
+All Rouster workers also support:
+* get()
+* put()
+* rebuild()
+* restart()
+* run()
+
+And depending on which pieces of rouster you 'require':
+
+* rouster/deltas
+  * get_groups()
+  * get_packages()
+  * get_ports()
+  * get_services()
+  * get_users()
+
+* rouster/puppet
+  * facter()
+  * get_catalog()
+  * get_puppet_errors()
+  * get_puppet_notices()
+  * parse_catalog()
+  * remove_existing_certs()
+  * run_puppet()
+
+* rouster/testing
+  * validate_file()
+  * validate_group()
+  * validate_package()
+  * validate_service()
+  * validate_user()
+
+* rouster/tests
+  * is_dir?()
+  * is_executable?()
+  * is_file?()
+  * is_group?()
+  * is_in_file?()
+  * is_in_path?()
+  * is_package?()
+  * is_port_active?()
+  * is_port_open?()
+  * is_process_running?())
+  * is_readable?()
+  * is_service?()
+  * is_service_running?()
+  * is_user?()
+  * is_user_in_group?()
+  * is_writeable?()
+
+These additional methods are added to the Rouster object via class extension.
+
+### basic instantiation and usage
+
+```rb
+require 'rouster'
+
+# the value for the 'name' attribute should be a name shown when you execute `vagrant status`
+app = Rouster.new(:name => 'app')
+
+# equivalent to `vagrant up app`
+app.up()
+
+# STD(OUT|ERR) of this is available in app.get_output()
+app.run('cat /etc/hosts')
+app.put('new-foo', '/tmp/foo')
+app.get('/tmp/foo')
+
+app.destroy()
+```
+
+### functional puppet test
+
+```rb
+require 'rouster'
+require 'rouster/puppet'
+require 'test/unit'
+
+class TestPuppetRun < Test::Unit::TestCase
+
+  def setup
+    @ppm = Rouster.new(:name => 'ppm', :verbose => 4)
+    @app = Rouster.new(:name => 'app')
+  end
+
+  def test_it
+
+    workers = [@ppm, @app]
+
+    workers.each do |w|
+      # tear them down and build back up for clean run
+      w.destroy()
+      w.up()
+
+      #res = w.run('puppet agent -t --environment development', 2)
+      assert_raises_nothing do
+        res = w.run_puppet('master', { :expected_exitcode => 2 })
+      end
+      assert_match(/Finished catalog/, res, "output contains 'Finished catalog'")
+    end
+  end
+
+  def teardown
+    @ppm.destroy()
+    @app.destroy()
+  end
+
+end
+```
+
+
+## Base Methods
+
+```rb
+irb(main):003:0> (Rouster.new(:name => 'app').methods - Object.methods).sort
+=> [:_run, :_vm, :check_key_permissions, :connect_ssh_tunnel, :deltas, :destroy, :dir, :exitcode, :facter, :facts, :file, :generate_unique_mac, :get, :get_catalog, :get_groups, :get_output, :get_packages, :get_ports, :get_puppet_errors, :get_puppet_notices, :get_services, :get_ssh_info, :get_users, :is_available_via_ssh?, :is_dir?, :is_executable?, :is_file?, :is_group?, :is_in_file?, :is_in_path?, :is_package?, :is_passthrough?, :is_port_active?, :is_port_open?, :is_process_running?, :is_readable?, :is_service?, :is_service_running?, :is_user?, :is_user_in_group?, :is_writeable?, :log, :os_type, :output, :parse_catalog, :parse_ls_string, :passthrough, :put, :rebuild, :remove_existing_certs, :restart, :run, :run_puppet, :sshkey, :status, :sudo, :suspend, :traverse_up, :up, :uses_sudo?, :vagrantfile, :verbosity]
+```

data/Rakefile

@@ -0,0 +1,65 @@
+require sprintf('%s/%s', File.dirname(File.expand_path(__FILE__)), 'path_helper')
+require 'rubygems'
+require 'rake/testtask'
+
+task :buildgem do
+  sh 'gem build rouster.gemspec'
+end
+
+task :default do
+  sh 'ruby test/basic.rb'
+end
+
+task :demo do
+  sh 'ruby examples/demo.rb'
+end
+
+task :doc do
+  sh 'rdoc --line-numbers lib/*'
+end
+
+task :examples do
+  Dir['examples/**/*.rb'].each do |example|
+	  sh "ruby #{example}"
+	end
+end
+
+task :reek do
+  sh "reek lib/**/*.rb"
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'unit'
+  t.libs << 'lib'
+  t.test_files = FileList['test/unit/**/test_*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'functional'
+  t.libs << 'lib'
+  t.test_files = FileList['test/functional/**/test_*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'deltas'
+  t.libs << 'lib'
+  t.test_files = FileList['test/functional/deltas/test_*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'puppet'
+  t.libs << 'lib'
+  t.test_files = FileList['test/puppet/test*.rb']
+  t.verbose = true
+end
+

data/Vagrantfile

@@ -0,0 +1,23 @@
+# stripped down example piab Vagrantfile for rouster
+
+box_url  = 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box'
+box_name = 'centos6'
+boxes    = [:ppm, :app]
+
+Vagrant::Config.run do |config|
+  boxes.each do |box|
+    config.vm.define box do |worker|
+
+      worker.vm.box            = box_name
+      worker.vm.box_url        = box_url
+      worker.vm.host_name      = box.to_s
+      worker.vm.network        :hostonly, sprintf('10.0.1.%s', rand(253).to_i + 1)
+      worker.ssh.forward_agent = true
+
+      if box.to_s.eql?('ppm') and File.directory?('../puppet')
+        worker.vm.share_folder('puppet', '/etc/puppet/', '../puppet/')
+      end
+
+    end
+  end
+end

data/examples/bootstrap.rb

@@ -0,0 +1,113 @@
+require sprintf('%s/../%s', File.dirname(File.expand_path(__FILE__)), 'path_helper')
+
+require 'rouster'
+require 'rouster/puppet'
+require 'rouster/tests'
+
+app = Rouster.new(:name => 'app', :verbosity => 4, :sudo => true)
+ppm = Rouster.new(:name => 'ppm', :verbosity => 1, :sudo => true)
+
+# passthrough boxes do not need to specify a name
+# commented out currently because passthrough is not MVP
+#lpt = Rouster.new(:passthrough => 'local', :verbosity => 4)
+#rpt = Rouster.new(:passthrough => 'remote', :verbosity => 4, :sshkey => '~/.ssh/id_dsa')
+
+workers = [app]
+
+workers.each do |w|
+  p '%s config: ' % w.name
+  p w
+
+  p 'status: %s' % w.status()
+  p 'upping the box'
+  w.up()
+
+  p sprintf('%s status: %s', w.name, w.status())
+  p sprintf('%s available via ssh: %s', w.name, w.is_available_via_ssh?())
+
+  p 'suspending the box'
+  w.suspend()
+
+  p sprintf('%s status: %s', w.name, w.status())
+  p sprintf('%s available via ssh: %s', w.name, w.is_available_via_ssh?())
+
+  p 'bringing the box back'
+  w.up()
+
+  p sprintf('%s status: %s', w.name, w.status())
+  p sprintf('%s available via ssh: %s', w.name, w.is_available_via_ssh?())
+
+  ## expected success
+  p sprintf('is_dir?(/tmp): %s', w.is_dir?('/tmp'))
+  p sprintf('is_exectuable?(/sbin/service: %s', w.is_executable?('/sbin/service'))
+  p sprintf('is_file?(/etc/hosts): %s', w.is_file?('/etc/hosts'))
+  p sprintf('is_group?(root): %s', w.is_group?('root'))
+  p sprintf('is_in_file?(/etc/hosts, puppet): %s', w.is_in_file?('/etc/hosts', 'puppet'))
+  p sprintf('is_in_path?(ping): %s', w.is_in_path?('ping'))
+  p sprintf('is_package?(libpcap): %s', w.is_package?('libpcap'))
+  p sprintf('is_port_open?(9999): %s', w.is_port_open?(9999))
+  p sprintf('is_port_active?(22): %s', w.is_port_active?(22))
+  p sprintf('is_process_running?(sshd): %s', w.is_process_running?('sshd'))
+  p sprintf('is_readable?(/etc/hosts): %s', w.is_readable?('/etc/hosts'))
+  p sprintf('is_service?(iptables): %s', w.is_service?('iptables'))
+  p sprintf('is_service_running?(iptables): %s', w.is_service_running?('iptables'))
+  p sprintf('is_user?(root): %s', w.is_user?('root'))
+  p sprintf('is_writeable?(/etc/hosts): %s', w.is_writeable?('/etc/hosts'))
+
+  ## expected failure
+  p sprintf('is_dir?(/dne): %s', w.is_dir?('/dne'))
+  p sprintf('is_executable?(fizzybang): %s', w.is_executable?('fizzybang'))
+  p sprintf('is_file?(/dne/fizzy): %s', w.is_file?('/dne/fizzy'))
+  p sprintf('is_group?(three-amigos): %s', w.is_group?('three-amigos'))
+  p sprintf('is_in_file?(/etc/hosts, this content is not there): %s', w.is_in_file?('/etc/hosts', 'this content is not there'))
+  p sprintf('is_in_file?(/dne/fizzy, this file is not there): %s', w.is_in_file?('/dne/fizzy', 'this file is not there'))
+  p sprintf('is_in_path?(fizzy): %s', w.is_in_path?('fizzy'))
+  p sprintf('is_package?(fizzybang): %s', w.is_package?('fizzybang'))
+  p sprintf('is_port_open?(123, udp): %s', w.is_port_open?(123, 'udp'))
+  p sprintf('is_port_open?(22): %s', w.is_port_open?(22))
+  p sprintf('is_process_running?(fizzy): %s', w.is_process_running?('fizzy'))
+  p sprintf('is_readable?(/dne/fizzy): %s', w.is_readable?('/dne/fizzy'))
+  p sprintf('is_service?(syslogd): %s', w.is_service?('syslogd'))
+  p sprintf('is_service_running?(smartd): %s', w.is_service_running?('smartd'))
+  p sprintf('is_user?(toor): %s', w.is_user?('toor'))
+  #p sprintf('is_writable?(/etc/hosts): %s', w.is_writeable?('/etc/hosts')) # running as sudo, so everything is writeable -- can we test this with a file in a path that DNE?
+
+  # put a file on the box and then bring it back
+  w.put(__FILE__, '/tmp/foobar')
+  w.get('/tmp/foobar', 'foobar_from_piab_host.tmp')
+
+  # output should be the same
+  p sprintf('%s uname -a via run:    %s', w.name, w.run('uname -a'))
+  p sprintf('%s uname -a via output: %s', w.name, w.get_output())
+
+  begin
+    p sprintf('%s fizzy:    %s', w.name, w.run('fizzy'))
+  rescue => e
+    p e
+  end
+
+  begin
+    p sprintf('%s ls /dne/  %s', w.name, w.run('ls /dne/'))
+  rescue => e
+    p e
+  end
+
+  p sprintf('%s ls /dne/ expected exit code 2: %s', w.name, w.run('ls /dne/', 2))
+
+  # tear the box down
+  p 'destroying the box'
+  w.destroy()
+
+  p sprintf('%s status: %s', w.name, w.status())
+  p sprintf('%s available via ssh: %s', w.name, w.is_available_via_ssh?())
+
+  # bring it back again
+  p 'upping the box again'
+  w.up()
+
+  p sprintf('%s status: %s', w.name, w.status())
+  p sprintf('%s available via ssh: %s', w.name, w.is_available_via_ssh?())
+
+end
+
+exit

data/examples/demo.rb

@@ -0,0 +1,71 @@
+require sprintf('%s/../%s', File.dirname(File.expand_path(__FILE__)), 'path_helper')
+
+require 'rouster'
+require 'rouster/tests'
+
+@app = Rouster.new(:name => 'app', :sudo => true, :verbosity => 3)
+@app.up()
+
+# get list of packages
+before_packages = @app.get_packages()
+
+# need this if not on vpn
+@app.run('wget http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm')
+@app.run('wget http://rpms.famillecollet.com/enterprise/remi-release-6.rpm')
+@app.run('rpm -Uvh remi-release-6*.rpm epel-release-6*.rpm', [0,2])
+@app.run('yum makecache')
+
+# install new package
+@app.run('yum -y install httpd')
+print @app.get_output()
+
+# get list of packages
+after_packages = @app.get_packages(false)
+
+# look for files specific to new pacakge
+p sprintf('delta of before/after packages: %s', after_packages.keys() - before_packages.keys())
+p sprintf('/var/www exists: %s', @app.is_dir?('/var/www'))
+p sprintf('/etc/httpd/conf/httpd.conf: %s', @app.file('/etc/httpd/conf/httpd.conf'))
+
+# look for port state changes
+httpd_off_ports = @app.get_ports()
+
+@app.run('service httpd start')
+httpd_on_ports = @app.get_ports()
+p sprintf('while httpd is running, is_port_active?(80): %s', @app.is_port_active?(80, 'tcp', true))
+p sprintf('delta of before/after ports: %s', httpd_on_ports['tcp'].keys() - httpd_off_ports['tcp'].keys())
+
+# look for groups/users created
+p sprintf('apache group created? %s', @app.is_group?('apache'))
+p sprintf('apache user created?  %s', @app.is_user?('apache'))
+
+# look at is_process_running / is_service / is_service_running
+is_service = @app.is_service?('httpd')
+is_service_running = @app.is_service_running?('httpd')
+is_process_running = @app.is_process_running?('httpd')
+p sprintf('is_service?(httpd) %s', is_service)
+p sprintf('is_service_running?(httpd) %s', is_service_running)
+p sprintf('is_process_running?(httpd) %s', is_process_running)
+
+@app.run('service httpd stop')
+is_service_running = @app.is_service_running?('httpd')
+p sprintf('is_service_running?(httpd) %s', is_service_running)
+p sprintf('when httpd is stopped, is_port_active(80): %s', @app.is_port_active?(80))
+
+# get a conf file, modify it, send it back, restart service
+tmp_filename = sprintf('/tmp/httpd.conf.%s', Time.now.to_i)
+
+@app.get('/etc/httpd/conf/httpd.conf', tmp_filename)
+
+## this should be smoother..
+@app._run(sprintf("sed -i 's/Listen 80/Listen 1234/' %s", tmp_filename))
+@app.put(tmp_filename)
+@app.run("mv #{File.basename(tmp_filename)} /etc/httpd/conf/httpd.conf") # the ssh tunnel runs under the vagrant user
+
+@app.run('service httpd start')
+is_service_running = @app.is_service_running?('httpd')
+p sprintf('is_service_running?(httpd): %s', is_service_running)
+p sprintf('after modification and restart, is_port_active?(1234): %s', @app.is_port_active?(1234))
+p sprintf('after modification and restart, is_port_active?(80): %s', @app.is_port_active?(80))
+
+@app._run(sprintf('rm %s', tmp_filename))