rouster 0.41 → 0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05f007fa8cb115a1889737b42c19eb6ab3a1029e
-  data.tar.gz: c58f43def276534730ead0ffb636254805ce8080
+  metadata.gz: 5d74bfb451922e3b85675d75df8eab08adcbb8f1
+  data.tar.gz: 8e16766740fb82932308c8e9ca1ff44e2ece3c70
 SHA512:
-  metadata.gz: 6465a1136c9506cb9f6fd7a7dd46d90eb39d30501ab7162d2f1635bad69a6cb349bfd45eb1d183f19abdd5e214cdca81cf02f6337fd2f7f72093bd343644f7d3
-  data.tar.gz: 88f46d185da9d5f61193ca97651d0a16165c05e2b68871fbfb57dc6a219865054c60218682d90cb0bceaff48319b3511906570aec5597de678dd4e1a6ac0daab
+  metadata.gz: b5149f6ecef16db649b445602383708dc7a2f39b30dc8475edf408286dbe4c60105828af134d1a177e1c5a960e5e4515786798fe31fff351c9c1de604af1847c
+  data.tar.gz: c4b51b717eab079455f3cac15eab60d93c49403b8efe59c1886b0f300e8231143110140d99d3f62bac439cd792768386a5ddbc541a3f2aaa402f3e937feecbc9

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

@@ -22,23 +22,31 @@ The first implementation of Rouster was in Perl, called [Salesforce::Vagrant](ht
 
 ## 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+
-* a usable Vagrantfile
 
 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.
 
-### Easiest installation
+### From-source installation (latest)
 
 ```sh
 git clone https://github.com/chorankates/rouster.git
 cd rouster
 rake buildgem
-gem install Rouster-<version>.gem
+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
 

data/lib/rouster.rb

@@ -11,7 +11,7 @@ require 'rouster/tests'
 class Rouster
 
   # sporadically updated version number
-  VERSION = 0.41
+  VERSION = 0.42
 
   # custom exceptions -- what else do we want them to include/do?
   class FileTransferError    < StandardError; end # thrown by get() and put()
@@ -22,7 +22,7 @@ class Rouster
   class SSHConnectionError   < StandardError; end # thrown by available_via_ssh() -- and potentially _run()
 
   attr_accessor :facts, :sudo, :verbosity
-  attr_reader :cache, :cache_timeout, :deltas, :exitcode, :log, :name, :output, :passthrough, :sshkey, :vagrantfile
+  attr_reader :cache, :cache_timeout, :deltas, :exitcode, :log, :name, :output, :passthrough, :sshkey, :unittest, :vagrantfile
 
   ##
   # initialize - object instantiation
@@ -42,6 +42,7 @@ class Rouster
     @passthrough   = opts[:passthrough].nil? ? false : opts[:passthrough]
     @sshkey        = opts[:sshkey]
     @sshtunnel     = opts[:sshtunnel].nil? ? true : opts[:sshtunnel]
+    @unittest      = opts[:unittest].nil? ? false : opts[:unittest]
     @vagrantfile   = opts[:vagrantfile].nil? ? traverse_up(Dir.pwd, 'Vagrantfile', 5) : opts[:vagrantfile]
     @verbosity     = opts[:verbosity].is_a?(Integer) ? opts[:verbosity] : 4
 
@@ -75,6 +76,7 @@ class Rouster
     end
 
     raise InternalError.new() if @name.nil?
+
     return if opts[:unittest].eql?(true) # quick return if we're a unit test
 
     begin
@@ -83,6 +85,8 @@ class Rouster
       raise InternalError.new()
     end
 
+    ## TODO ensure 'vagrant' is in path
+
     @log.debug('SSH key discovery and viability tests..')
     if @sshkey.nil?
       if @passthrough.eql?(true)

data/lib/rouster/deltas.rb

@@ -7,6 +7,91 @@ require 'rouster/tests'
 # TODO use @cache_timeout to invalidate data cached here
 
 class Rouster
+
+  ##
+  # get_crontab
+  #
+  # runs `crontab -l <user>` and parses output, returns hash:
+  # {
+  #   user => {
+  #     logicalOrderInt => {
+  #       :minute => minute,
+  #       :hour   => hour,
+  #       :dom    => dom, # day of month
+  #       :mon    => mon, # month
+  #       :dow    => dow, # day of week
+  #       :command => command,
+  #     }
+  #   }
+  # }
+  #
+  # the hash will contain integers (not strings) for numerical values -- all but '*'
+  #
+  # parameters
+  # * <user> - name of user who owns crontab for examination -- or '*' to determine list of users and iterate over them to find all cron jobs
+  # * [cache] - boolean controlling whether or not retrieved/parsed data is cached, defaults to true
+  def get_crontab(user='root', cache=true)
+
+    if cache and self.deltas[:crontab].class.eql?(Hash)
+      if self.deltas[:crontab].has_key?(user)
+        return self.deltas[:crontab][user]
+      else
+        # noop fallthrough to gather data to cache
+      end
+    elsif cache and self.deltas[:crontab].class.eql?(Hash) and user.eql?('*')
+      return self.deltas[:crontab]
+    end
+
+    i = 0
+    res = Hash.new
+    users = nil
+
+    if user.eql?('*')
+      users = self.get_users().keys
+    else
+      users = [user]
+    end
+
+    users.each do |u|
+      begin
+        raw = self.run(sprintf('crontab -u %s -l', u))
+      rescue RemoteExecutionError => e
+        # crontab throws a non-0 exit code if there is no crontab for the specified user
+        res[u] ||= Hash.new
+        next
+      end
+
+      raw.split("\n").each do |line|
+        elements = line.split("\s")
+
+        res[u] ||= Hash.new
+        res[u][i] ||= Hash.new
+
+        res[u][i][:minute]  = elements[0]
+        res[u][i][:hour]    = elements[1]
+        res[u][i][:dom]     = elements[2]
+        res[u][i][:mon]     = elements[3]
+        res[u][i][:dow]     = elements[4]
+        res[u][i][:command] = elements[5..elements.size].join(" ")
+      end
+
+      i += 1
+    end
+
+    if cache
+      if ! user.eql?('*')
+        self.deltas[:crontab] ||= Hash.new
+        self.deltas[:crontab][user] ||= Hash.new
+        self.deltas[:crontab][user] = res[user]
+      else
+        self.deltas[:crontab] ||= Hash.new
+        self.deltas[:crontab] = res
+      end
+    end
+
+    return user.eql?('*') ? res : res[user]
+  end
+
   ##
   # get_groups
   #

data/lib/rouster/testing.rb

@@ -48,7 +48,7 @@ class Rouster
   #   * :constrain
   def validate_file(name, expectations, cache=false)
 
-    if expectations[:ensure].nil? and expectations[:exists].nil?
+    if expectations[:ensure].nil? and expectations[:exists].nil? and expectations[:directory].nil? and expectations[:file?].nil?
       expectations[:ensure] = 'file'
     end
 
@@ -66,7 +66,7 @@ class Rouster
       expectations.delete(:constrain)
     end
 
-    properties = (! expectations[:ensure].eql?('file')) ?  self.file(name, cache) : self.dir(name, cache)
+    properties = (expectations[:ensure].eql?('file')) ?  self.file(name, cache) : self.dir(name, cache)
     results = Hash.new()
     local = nil
 
@@ -109,7 +109,7 @@ class Rouster
             if properties[:directory?]
               local = v.to_s.match(/absent|false/).nil?
             else
-              local = true
+              local = ! v.to_s.match(/absent|false/).nil?
             end
           else
             local = false
@@ -557,6 +557,17 @@ class Rouster
     res
   end
 
+  ##
+  # generic_comparator
+  #
+  # powers the 3 argument form of constraint (i.e. 'is_virtual != true', '<package_version> > 3.0', etc)
+  #
+  # should really be an eval{} of some sort (or would be in the perl world)
+  #
+  # parameters
+  # * <comparand1> - left side of the comparison
+  # * <comparator> - comparison to make
+  # * <comparand2> - right side of the comparison
   def generic_comparator(comparand1, comparator, comparand2)
 
     # TODO rewrite this as an eval so we don't have to support everything..

data/lib/rouster/tests.rb

@@ -30,6 +30,11 @@ class Rouster
       return self.deltas[:files][dir]
     end
 
+    if self.unittest and cache
+      # preventing a functional test fallthrough
+      return nil
+    end
+
     begin
       raw = self.run(sprintf('ls -ld %s', dir))
     rescue Rouster::RemoteExecutionError
@@ -104,6 +109,11 @@ class Rouster
       return self.deltas[:files][file]
     end
 
+    if self.unittest and cache
+      # preventing a functional test fallthrough
+      return nil
+    end
+
     begin
       raw = self.run(sprintf('ls -l %s', file))
     rescue Rouster::RemoteExecutionError

data/rouster.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'http://github.com/chorankates/rouster'
   s.summary       = 'Rouster is an abstraction layer for Vagrant'
   s.description   = 'Rouster allows you to programmatically control and interact with your existing Vagrant virtual machines'
+  s.license       = 'BSD 3-Clause'
 
   s.required_rubygems_version = '>= 1.3.6'
   s.rubyforge_project         = 'Rouster'

data/test/functional/deltas/test_get_crontab.rb

@@ -0,0 +1,99 @@
+require sprintf('%s/../../../path_helper', File.dirname(File.expand_path(__FILE__)))
+
+require 'rouster'
+require 'rouster/deltas'
+require 'test/unit'
+
+class TestDeltasGetCrontab < Test::Unit::TestCase
+
+  def setup
+    assert_nothing_raised do
+      @app = Rouster.new(:name => 'app')
+    end
+
+    @app.up()
+
+    ## setup some cronjobs so we have something to look at - and yes, this is hacktastic
+    ['root', 'puppet'].each do | user|
+      tmp = sprintf('/tmp/rouster.tmp.crontab.%s.%s.%s', user, Time.now.to_i, $$)
+      @app.run("echo '0 0 * * * echo #{user}' > #{tmp}")
+      #@app.run("crontab -u #{user} -f #{tmp}") # rhel
+      @app.run("crontab -u #{user} #{tmp}") # centos
+    end
+
+  end
+
+  def test_happy_path
+
+    res = nil
+
+    assert_nothing_raised do
+      res = @app.get_crontab()
+    end
+
+    assert_equal(Hash, res.class)
+    assert_equal(res, @app.deltas[:crontab]['root'])
+    assert_not_nil(@app.deltas[:crontab]['root'])
+
+  end
+
+  def test_happy_path_specified_user
+
+    res = nil
+
+    assert_nothing_raised do
+      res = @app.get_crontab('puppet')
+    end
+
+    assert_equal(Hash, res.class)
+    assert_equal(res, @app.deltas[:crontab]['puppet'])
+    assert_not_nil(@app.deltas[:crontab]['puppet'])
+
+  end
+
+  def test_happy_path_specified_star
+
+    res = nil
+
+    assert_nothing_raised do
+      res = @app.get_crontab('*')
+    end
+
+    assert_equal(Hash, res.class)
+    assert_equal(res, @app.deltas[:crontab])
+    assert_not_nil(@app.deltas[:crontab]['root'])
+    assert_not_nil(@app.deltas[:crontab]['puppet'])
+
+  end
+
+  def test_unhappy_path_non_existent_user
+
+    res = nil
+
+    assert_nothing_raised do
+      res = @app.get_crontab('fizzybang')
+    end
+
+    assert_equal(Hash, res.class)
+    assert_equal(0, res.keys.size)
+
+  end
+
+  def test_happy_path_no_cache
+
+    res = nil
+
+    assert_nothing_raised do
+      res = @app.get_crontab('root', false)
+    end
+
+    assert_equal(Hash, res.class)
+    assert_nil(@app.deltas[:crontab])
+
+  end
+
+  def teardown
+    @app = nil
+  end
+
+end

data/test/functional/test_restart.rb

@@ -36,10 +36,8 @@
       assert_not_equal(original_uptime, new_uptime)
       assert(original_uptime > new_uptime)
 
-
     end
 
-
     def teardown
       # noop
     end

data/test/{functional → unit}/puppet/test_get_puppet_star.rb

@@ -10,7 +10,7 @@ class TestGetPuppetStar < Test::Unit::TestCase
 
   def setup
     assert_nothing_raised do
-      @app = Rouster.new(:name => 'app')
+      @app = Rouster.new(:name => 'app', :unittest => true)
     end
 
     # expose private methods

data/test/unit/testing/test_validate_file.rb

@@ -62,9 +62,8 @@ class TestValidateFile < Test::Unit::TestCase
     assert(@app.validate_file('/etc/hosts', { :owner => 'root' }, true))
     assert(@app.validate_file('/etc/hosts', { :group => 'root' }, true))
 
-    # TODO figure out how to run these in a truly unit-y way, since the data is not present in faked hash, we will fall through to functional testing
-    #assert(@app.validate_file('/etc/fizzbang', { :ensure => 'absent' }, true))
-    #assert(@app.validate_file('/etc/fizzbang', { :ensure => false }, true ))
+    assert(@app.validate_file('/etc/fizzbang', { :ensure => 'absent' }, true))
+    assert(@app.validate_file('/etc/fizzbang', { :ensure => false }, true ))
 
     assert(@app.validate_file('/etc', { :ensure => 'directory' }, true))
     assert(@app.validate_file('/etc', { :ensure => 'dir' }, true))
@@ -100,9 +99,9 @@ class TestValidateFile < Test::Unit::TestCase
     assert_equal(false, @app.validate_file('/etc/hosts', { :size => '100'}, true))
 
     # TODO figure out how to run these in a truly unit-y way, since the data is not present in faked hash, we will fall through to functional testing
-    #assert_equal(false, @app.validate_file('/foo', {}, true))
-    #assert_equal(false, @app.validate_file('/fizzy', { :ensure => 'directory' }, true))
-    #assert_equal(false, @app.validate_file('/bang', { :ensure => 'file' }, true))
+    assert_equal(false, @app.validate_file('/foo', {}, true))
+    assert_equal(false, @app.validate_file('/fizzy', { :ensure => 'directory' }, true))
+    assert_equal(false, @app.validate_file('/bang', { :ensure => 'file' }, true))
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rouster
 version: !ruby/object:Gem::Version
-  version: '0.41'
+  version: '0.42'
 platform: ruby
 authors:
 - Conor Horan-Kates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- LICENSE
 - README.md
 - Rakefile
 - Vagrantfile
@@ -116,13 +117,13 @@ files:
 - path_helper.rb
 - rouster.gemspec
 - test/basic.rb
+- test/functional/deltas/test_get_crontab.rb
 - test/functional/deltas/test_get_groups.rb
 - test/functional/deltas/test_get_packages.rb
 - test/functional/deltas/test_get_ports.rb
 - test/functional/deltas/test_get_services.rb
 - test/functional/deltas/test_get_users.rb
 - test/functional/puppet/test_facter.rb
-- test/functional/puppet/test_get_puppet_star.rb
 - test/functional/test_caching.rb
 - test/functional/test_destroy.rb
 - test/functional/test_dirs.rb
@@ -148,6 +149,7 @@ files:
 - test/puppet/test_apply.rb
 - test/puppet/test_roles.rb
 - test/tunnel_vs_scp.rb
+- test/unit/puppet/test_get_puppet_star.rb
 - test/unit/test_generate_unique_mac.rb
 - test/unit/test_new.rb
 - test/unit/test_parse_ls_string.rb
@@ -159,7 +161,8 @@ files:
 - test/unit/testing/test_validate_service.rb
 - test/unit/testing/test_validate_user.rb
 homepage: http://github.com/chorankates/rouster
-licenses: []
+licenses:
+- BSD 3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []