rouster 0.5 → 0.7

checksums.yaml

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

data/.gitignore

@@ -3,4 +3,7 @@ doc/*
 *.box
 *.swp
 *tmp*
-*.gem
+*.gem
+.rakeTasks
+*raiden*
+.project

data/.reek

@@ -0,0 +1,63 @@
+---
+
+Attribute:
+  enabled: false
+
+# so judgy.. and without context
+BooleanParameter:
+  enabled: false
+
+ControlParameter:
+  enabled: false
+
+DataClump:
+  min_clump_size: 4
+
+DuplicateMethodCall:
+  enabled: false
+
+# this is not a real thing
+FeatureEnvy:
+  enabled: false
+
+# this should have understanding of non-required parameters
+LongParameterList:
+  max_params: 5
+
+NestedIterators:
+  max_allowed_nesting: 3
+
+# you don't know my life
+NilCheck:
+  enabled: false
+
+# more lacking context judgement - when _would_ you be ok with '!' ?
+PrimaDonnaMethod:
+  enabled: false
+
+# this feels a bit arbitrary.. maybe would make more sense if was an average
+TooManyStatements:
+  max_statements: 30
+
+# see above
+TooManyInstanceVariables:
+  max_instance_variables: 20
+
+# see above
+TooManyMethods:
+  max_methods: 20
+
+# i don't name my exceptions specifically. that doesn't make me a bad person.
+UncommunicativeVariableName:
+  accept: /^[a|b|e|f|g|h|i|j|k|l|m|p|r|s|u|v]$/
+
+# or my comparators in ~sort() functions
+## https://github.com/troessner/reek/issues/886
+UncommunicativeParameterName:
+  accept:
+    - a
+    - b
+
+# got dinged for using class variables.. how else would you use self.startup?
+exclude_paths:
+  - test/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+
+notifications:
+  email: false
+
+bundler_args: --without test --jobs 3 --retry 3
+script: bundle exec rake test:unit build
+

data/Gemfile

@@ -0,0 +1,17 @@
+ruby '2.0.0'
+
+source 'https://rubygems.org'
+
+gem 'json'
+gem 'log4r', '~> 1.1.9'
+gem 'net-scp'
+gem 'net-ssh'
+gem 'rake', '= 10.4.2'
+
+group :development do
+  gem 'test-unit', '~> 3.0.0'
+  gem 'reek', '= 3.10.2'
+end
+
+gem 'fog', '= 1.24.0', :groups => [:aws, :openstack]
+

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    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)
+    ice_nine (0.11.2)
+    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)
+    parser (2.3.3.0)
+      ast (~> 2.2)
+    power_assert (0.1.4)
+    rainbow (2.1.0)
+    rake (10.4.2)
+    reek (3.10.2)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3, >= 2.3.0.6)
+      rainbow (~> 2.0)
+    test-unit (3.0.2)
+      power_assert
+    thread_safe (0.3.5)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fog (= 1.24.0)
+  json
+  log4r (~> 1.1.9)
+  net-scp
+  net-ssh
+  rake (= 10.4.2)
+  reek (= 3.10.2)
+  test-unit (~> 3.0.0)
+
+RUBY VERSION
+   ruby 2.0.0p648
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -1,6 +1,8 @@
 Rouster
 ======
 
+[![build status](https://travis-ci.org/chorankates/rouster.svg)](https://travis-ci.org/chorankates/rouster) [![Gem Version](https://badge.fury.io/rb/rouster.svg)](https://rubygems.org/gems/rouster)
+
 ```rb
 Rouster.is_a?('abstraction layer for controlling Vagrant virtual machines')
 => true
@@ -24,12 +26,29 @@ The first implementation of Rouster was in Perl, called [Salesforce::Vagrant](ht
 
 * [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+)
+* Gems
+  * json
+  * log4r
+  * net-scp
+  * net-ssh
+  * fog (only if using AWS or OpenStack)
 
 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
@@ -37,13 +56,13 @@ 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)
 
-[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
 ```
@@ -127,6 +146,89 @@ app.get('/tmp/foo')
 app.destroy()
 ```
 
+### advanced instantiation (passthroughs!)
+
+detailed options in ```examples/passthrough.rb```, ```examples/aws.rb``` and ```examples/openstack.rb```
+
+since Rouster only requires an SSH connection to control a machine, why stop at Vagrant?
+
+```rb
+require 'rouster'
+require 'rouster/plugins/aws'
+require 'rouster/plugins/openstack'
+
+# 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}
+  }
+)
+
+# create a remote OpenStack instance
+ostack = Rouster.new(
+  :name      => 'ostack-testing',
+  :passthrough => {
+    :type                => :openstack,
+    :openstack_auth_url  => 'http://hostname.domain.com:5000/v2.0/tokens',
+    :openstack_username  => 'some_console_user',
+    :openstack_tenant    => 'tenant_id',
+    :user                => 'some_ssh_userid', 
+    :keypair             => 'keypair_name',
+    :image_ref           => 'c0340afb-577d-4db6-1234-aebdd6d1838f',
+    :flavor_ref          => '547d9af5-096c-44a3-1234-7d23162556b8',
+    :openstack_api_key   => 'some_api_key',
+    :key                 => '/path/to/private/key.pem',
+  },
+  :sudo => true, # false by default, enabling requires that sshd is not enforcing 'requiretty'
+)
+
+# control a running OpenStack instance
+openstack_already_running = Rouster.new(
+  :name      => 'ostack-copy',
+  :passthrough => {
+    :type                => :openstack,
+    :openstack_auth_url  => 'http://hostname.domain.com:5000/v2.0/tokens',
+    :openstack_username  => 'some_console_user',
+    :openstack_tenant    => 'tenant_id',
+    :user                => 'ssh_user',
+    :keypair             => 'keypair_name',
+    :instance            => 'your-instance-id',
+  },
+)
+
+```
+
 ### functional puppet test
 
 ```rb
@@ -170,6 +272,130 @@ 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,
+...
+]
+```
+
+## Openstack methods
+
+```rb
+[
+  :ostack_connect,
+  :ostack_describe_instance,
+  :ostack_destroy,
+  :ostack_get_instance_id,
+  :ostack_get_ip,
+  :ostack_status,
+  :ostack_up
+]
 ```