rouster 0.57 → 0.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca887947fd8eb61d347ebb19f562d4ab6f79cf79
-  data.tar.gz: 424047f4ad62c0b279baa71d503045096416b37f
+  metadata.gz: d37f795615a19e7523b738d759e48f3e61fdc81c
+  data.tar.gz: 898b4400f00d4675061d9dd5e0716fc9a7ec21ce
 SHA512:
-  metadata.gz: 90856a137433d2c34a2f2f7e3977c748bb8457f96049c0111b650ab6f5e0520380f74406b20b7a274f01bc8c8b1341b5d0c6fd345cec5960db718b76c6b9a55c
-  data.tar.gz: e6f9d8b1400e684cf89451a4ac2d46ace2f3642927a7b70cb666ed03e2475b250c45a82c68174f8ce1cebf252ec2b2ccb07546b69193ecbf2568d3cad3858e18
+  metadata.gz: 7442ac64dc582dbc03be7aaecc9f481ca7f9d1d0c43608faab5ea3f947ae4a696a0ab1c6d2467223b289e09faa762adfbdd24db8e2d5f8949f174f35922a73d4
+  data.tar.gz: 13e407ab375276b8bf8c2054008668d2471e2be685224b3da62424cd6d92ff83ee3ceddadb6e0388db7df715d5ea654753dece45c374d2ce2348b302f3a26c4e

data/.gitignore

@@ -5,3 +5,5 @@ doc/*
 *tmp*
 *.gem
 .rakeTasks
+*raiden*
+.project

data/Gemfile

@@ -0,0 +1,16 @@
+ruby '2.0.0'
+
+source 'https://rubygems.org'
+
+gem 'json'
+gem 'log4r', '~> 1.1.9'
+gem 'net-scp'
+gem 'net-ssh'
+
+group :development do
+  gem 'test-unit', '~> 3.0.0'
+end
+
+group :aws do
+  gem 'fog'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    excon (0.40.0)
+    fog (1.24.0)
+      fog-brightbox
+      fog-core (~> 1.23)
+      fog-json
+      fog-radosgw (>= 0.0.2)
+      fog-sakuracloud (>= 0.0.4)
+      fog-softlayer
+      ipaddress (~> 0.5)
+      nokogiri (~> 1.5, >= 1.5.11)
+    fog-brightbox (0.5.1)
+      fog-core (~> 1.22)
+      fog-json
+      inflecto
+    fog-core (1.24.0)
+      builder
+      excon (~> 0.38)
+      formatador (~> 0.2)
+      mime-types
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+    fog-json (1.0.0)
+      multi_json (~> 1.0)
+    fog-radosgw (0.0.3)
+      fog-core (>= 1.21.0)
+      fog-json
+      fog-xml (>= 0.0.1)
+    fog-sakuracloud (0.1.1)
+      fog-core
+      fog-json
+    fog-softlayer (0.3.20)
+      fog-core
+      fog-json
+    fog-xml (0.1.0)
+      fog-core
+      nokogiri (~> 1.5, >= 1.5.11)
+    formatador (0.2.5)
+    inflecto (0.0.2)
+    ipaddress (0.8.0)
+    json (1.8.1)
+    log4r (1.1.10)
+    mime-types (2.4.1)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    power_assert (0.1.4)
+    test-unit (3.0.2)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fog
+  json
+  log4r (~> 1.1.9)
+  net-scp
+  net-ssh
+  test-unit (~> 3.0.0)

data/README.md

@@ -29,10 +29,24 @@ The first implementation of Rouster was in Perl, called [Salesforce::Vagrant](ht
   * log4r
   * net-scp
   * net-ssh
+  * fog (only if using AWS)
 
 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 local usage (latest)
+
+```sh
+git clone https://github.com/chorankates/rouster.git
+cd rouster
+bundle install # use :aws to pull in fog
+...
+irb(main):001:0> require './path_helper.rb'
+=> true
+irb(main):002:0> require 'rouster'
+=> true
+```
+
 ### From-source installation (latest)
 
 ```sh
@@ -40,6 +54,9 @@ git clone https://github.com/chorankates/rouster.git
 cd rouster
 rake buildgem
 gem install rouster-<version>.gem
+...
+irb(main):001:0> require 'rouster'
+=> true
 ```
 
 ### pre-built gem installation (stable)
@@ -130,6 +147,56 @@ app.get('/tmp/foo')
 app.destroy()
 ```
 
+### advanced instantiation (passthroughs!)
+
+detailed options in ```examples/passthrough.rb``` and ```examples/aws.rb```
+
+since Rouster only requires an SSH connection to control a machine, why stop at Vagrant?
+
+```rb
+require 'rouster'
+require 'rouster/plugins/aws'
+
+# control the machine rouster itself is running on
+local = Rouster.new(:name => 'local', :passthrough => { :type => :local } }
+
+# control a remote machine
+remote = Rouster.new(
+  :name => 'remote',
+  :passthrough => {
+    :type => :remote,
+    :host => 'foo.bar.com',
+    :user => 'keanu',
+    :key  => '/path/to/private/key',
+  }
+
+  :sudo => true, # false by default, enabling requires that sshd is not enforcing 'requiretty'
+)
+
+# control a running EC2 instance
+aws_already_running = Rouster.new(
+  :name => 'cloudy',
+  :passthrough => {
+    :type     => :aws,
+    :instance => 'your-instance-id',
+    :keypair  => 'your-keypair-name',
+  }
+)
+
+# start and control an EC2 instance
+aws_start_me_up = Rouster.new(
+  :name        => 'bgates',
+  :passthrough => {
+    :type            => :aws,
+    :ami             => 'your-ami-id',
+    :security_groups => 'your-security-groups',
+    :key_id          => 'your-aws-key-id',     # defaults to ${AWS_ACCESS_KEY_ID}
+    :secret_key      => 'your-aws-secret-key', # defaults to ${AWS_SECRET_ACCESS_KEY}
+  }
+)
+
+```
+
 ### functional puppet test
 
 ```rb
@@ -173,6 +240,116 @@ 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]
+irb(main):001:0> require './path_helper.rb'
+=> true
+irb(main):002:0> require 'rouster'
+=> true
+irb(main):003:0> pp (Rouster.new(:name => 'app').methods - Object.methods).sort
+=> [
+[:_run,
+ :cache,
+ :cache_timeout,
+ :check_key_permissions,
+ :connect_ssh_tunnel,
+ :deltas,
+ :destroy,
+ :dir,
+ :dirs,
+ :disconnect_ssh_tunnel,
+ :exitcode,
+ :facts,
+ :facts=,
+ :file,
+ :files,
+ :generate_unique_mac,
+ :get,
+ :get_crontab,
+ :get_groups,
+ :get_output,
+ :get_packages,
+ :get_ports,
+ :get_services,
+ :get_ssh_info,
+ :get_users,
+ :halt,
+ :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_symlink?,
+ :is_user?,
+ :is_user_in_group?,
+ :is_vagrant_running?,
+ :is_writeable?,
+ :logger,
+ :os_type,
+ :output,
+ :package,
+ :parse_ls_string,
+ :passthrough,
+ :put,
+ :rebuild,
+ :restart,
+ :retries,
+ :run,
+ :sandbox_available?,
+ :sandbox_commit,
+ :sandbox_off,
+ :sandbox_on,
+ :sandbox_rollback,
+ :sshkey,
+ :status,
+ :suspend,
+ :traverse_up,
+ :unittest,
+ :up,
+ :uses_sudo?,
+ :vagrant,
+ :vagrantbinary,
+ :vagrantfile]
+]
+```
+
+## AWS methods
+```rb
+irb(main):001:0> require './path_helper.rb'
+=> true
+irb(main):002:0> require 'rouster'
+=> true
+irb(main):003:0> require 'rouster/plugins/aws'
+=> true
+irb(main):004:0> pp (Rouster.new(:name => 'aws', :passthrough => { :type => :aws }).methods - Object.methods).sort
+=> [
+...
+ :aws_bootstrap,
+ :aws_connect,
+ :aws_connect_to_elb,
+ :aws_describe_instance,
+ :aws_destroy,
+ :aws_get_ami,
+ :aws_get_hostname,
+ :aws_get_instance,
+ :aws_get_ip,
+ :aws_get_metadata,
+ :aws_get_url,
+ :aws_get_userdata,
+ :aws_status,
+ :ec2,
+ :elb,
+ :elb_connect,
+ :find_ssh_elb,
+ :instance_data,
+...
+]
 ```

data/Rakefile

@@ -24,12 +24,15 @@ task :examples do
 	end
 end
 
+task :vdestroy do
+  sh 'vagrant destroy -f'
+end
+
 task :reek do
-  sh "reek lib/**/*.rb"
+  sh 'reek lib/**/*.rb'
 end
 
-Rake::TestTask.new do |t|
-  t.name = 'test'
+Rake::TestTask.new(:test => :vdestroy) do |t|
   t.libs << 'lib'
   t.test_files = FileList['test/**/test_*.rb']
   t.verbose = true
@@ -42,15 +45,13 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-Rake::TestTask.new do |t|
-  t.name = 'functional'
+Rake::TestTask.new(:functional => :vdestroy) do |t|
   t.libs << 'lib'
   t.test_files = FileList['test/functional/**/test_*.rb']
   t.verbose = true
 end
 
-Rake::TestTask.new do |t|
-  t.name = 'deltas'
+Rake::TestTask.new(:deltas => :vdestroy) do |t|
   t.libs << 'lib'
   t.test_files = FileList['test/functional/deltas/test_*.rb']
   t.verbose = true

data/Vagrantfile

@@ -1,19 +1,34 @@
 # stripped down example piab Vagrantfile for rouster
 
-#box_url = 'http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210.box'
-#box_name = 'ubuntu12'
-box_url  = 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box'
-box_name = 'centos6'
+boxes = {
+  :ppm   => {
+    :box_name => 'centos6',
+    :box_url  => 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box',
+  },
+  :app   => {
+    :box_name => 'centos6',
+    :box_url  => 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box',
+  },
 
-boxes    = [:ppm, :app]
+  :ubuntu12  => {
+      :box_name => 'ubuntu12',
+      :box_url => 'http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210.box',
+  },
+
+  :ubuntu13     => {
+    :box_name => 'ubuntu13',
+    :box_url  => 'http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-1310-x64-virtualbox-puppet.box',
+  },
+
+}
 
 Vagrant::Config.run do |config|
-  boxes.each do |box|
+  boxes.each_pair do |box,hash|
     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.box            = hash[:box_name]
+      worker.vm.box_url        = hash[:box_url]
+      worker.vm.host_name      = hash[:box_name]
       worker.vm.network        :hostonly, sprintf('10.0.1.%s', rand(253).to_i + 2)
       worker.ssh.forward_agent = true
 

data/examples/aws.rb

@@ -0,0 +1,85 @@
+require sprintf('%s/../%s', File.dirname(File.expand_path(__FILE__)), 'path_helper')
+
+require 'rouster'
+require 'plugins/aws' # brings in fog and some helpers
+
+aws_already_running = Rouster.new(
+  :name        => 'aws-already-running',
+  :passthrough => {
+    :type     => :aws,
+    :instance => 'your-instance-id',
+    :key      => sprintf('%s/.ssh/id_rsa-aws', ENV['HOME'])
+  },
+  :verbosity => 1,
+)
+
+a = aws_already_running.run('ls -l /etc/hosts; who')
+
+aws = Rouster.new(
+  :name      => 'aws-testing',
+  :sudo      => false,
+  :passthrough => {
+    # all required settings
+    :type            => :aws,
+    :keypair         => 'your-keypair-name',
+    :security_groups => 'integration-testing',
+    :key             => sprintf('%s/.ssh/id_rsa-aws', ENV['HOME']),
+    :userdata        => 'foo',
+
+    # optional, setting to be explicit
+    :ami                   => 'your-ami-id',
+    :dns_propagation_sleep => 20,
+    :min_count             => 1, # TODO don't know how to actually handle multiple machines.. just do the same thing on all of the hosts?
+    :max_count             => 1,
+    :region                => 'us-west-2',
+    :size                  => 't1.micro',
+    :ssh_port              => 22,
+    :user                  => 'ec2-user',
+
+    :key_id       => ENV['AWS_ACCESS_KEY_ID'],
+    :secret_key   => ENV['AWS_SECRET_ACCESS_KEY'],
+  },
+  :sshtunnel => false,
+  :verbosity => 1,
+)
+
+p "up(): #{aws.up}"
+
+aws_clone = Rouster.new(
+  :name => 'aws-testing-clone',
+  :passthrough => {
+    :type     => :aws,
+    :key      => sprintf('%s/.ssh/id_rsa-aws', ENV['HOME']),
+    :instance => aws.aws_get_instance,
+  },
+  :verbosity => 1,
+)
+
+[ aws, aws_already_running, aws_clone ].each do |a|
+  p "aws_get_ami: #{a.aws_get_ami}"
+  p "aws_get_instance: #{a.aws_get_instance}"
+
+  p "status: #{a.status}"
+  p "aws_status: #{a.aws_status}" # TODO merge this into status
+
+  p "aws_get_ip(:internal, :public): #{a.aws_get_ip(:internal, :public)}"
+  p "aws_get_ip(:internal, :private): #{a.aws_get_ip(:internal, :private)}"
+  p "aws_get_ip(:aws, :public): #{a.aws_get_ip(:aws, :public)}"
+  p "aws_get_ip(:aws, :private): #{a.aws_get_ip(:aws, :private)}"
+
+  p "aws_get_hostname(:internal, :public): #{a.aws_get_hostname(:internal, :public)}"
+  p "aws_get_hostname(:internal, :private): #{a.aws_get_hostname(:internal, :private)}"
+  p "aws_get_hostname(:aws, :public): #{a.aws_get_hostname(:aws, :public)}"
+  p "aws_get_hostname(:aws, :private): #{a.aws_get_hostname(:aws, :private)}"
+
+  p "run(uptime): #{a.run('uptime')}"
+  p "get(/etc/hosts): #{a.get('/etc/hosts')}"
+  p "put(/etc/hosts, /tmp): #{a.put('/etc/hosts', '/tmp')}"
+
+  p "aws_get_userdata: #{a.aws_get_userdata}"
+  p "aws_get_metadata: #{a.aws_get_metadata}"
+
+  p 'DBGZ' if nil?
+end
+
+exit