remote_executor 0.4.0 → 0.6.0

data/README.rdoc

@@ -24,17 +24,15 @@ An example may be the next. Launch the command 'hostname' over your production f
 directory into the file ${HOME}/.remoteexecutorrc like this:
   
   ---
-    - :name: 'myFarm'
-      :environment: 'production'
-      :user: admin
+    - :name: 'myFarm.development'
+      :user: 'admin'
       :hosts: 
         - 'myHost1'
         - 'myHost2'
         - 'myHost3'
         - 'myHost4'
-    - :name: 'myFarm'
-      :environment: 'production'
-      :user: admin
+    - :name: 'myFarm.production'
+      :user: 'admin'
       :hosts: 
         - 'myHost1'
         - 'myHost2'
@@ -45,10 +43,13 @@ you need this minimal SSH configuration (${HOME}/.ssh/config) for the example
 
   Host myHost1
     HostName myhost1.example.com
+    
   Host myHost2
     HostName myhost2.example.com
+    
   Host myHost3
     HostName myhost3.example.com
+    
   Host myHost4
     HostName myhost4.example.com
     
@@ -57,7 +58,7 @@ you need this minimal SSH configuration (${HOME}/.ssh/config) for the example
   
 with this line: 
 
-  remote_executor --system=myFarm --environment=production --command='hostname'
+  remote_executor --system=myFarmID --command='hostname'
 
   
 === Configuration

data/bin/remote_executor

@@ -5,19 +5,19 @@ $:.unshift File.join( File.dirname( __FILE__ ), %w[.. lib] )
 require 'rubygems'
 require 'remote_executor'
 
-module CLIApplication
+module RemoteExecutor
+  module CLIApplication
   
-  NAME = "RemoteExecutor"
-  
-  def self.execute
-    RemoteExecutor::Cli::execute( 
-      Choice.choices[:system], 
-      Choice.choices[:environment],
-      Choice.choices[:command]
-    )
-  end
+    def self.run
+      Cli::execute(
+        Choice.choices[:system], 
+        Choice.choices[:environment],
+        Choice.choices[:command]
+      )
+    end
+  end  
 end
 
 ##
 # ::Main::
-CLIApplication.execute
+RemoteExecutor::CLIApplication.run

data/lib/remote_executor.rb

@@ -1,13 +1,7 @@
-begin
-  %w[rubygems yaml singleton choice net/ssh].each { |gem| require gem }
-rescue LoadError => e
-  fail "Some gem dependencies can not be loaded: #{e.message}" 
-end
-
-$:.unshift File.join( File.dirname( __FILE__), 'remote_executor' )
+$:.unshift File.join( File.dirname( __FILE__ ), 'remote_executor' )
 
 begin
-  %w[version config system_config system options_parser cli].each { |lib| require lib }
+  %w[version app options_parser cli config system_config system cli].each { |lib| require lib }
 rescue LoadError => e
   fail "Some lib dependencies can not be loaded: #{e.message}" 
 end

data/lib/remote_executor/app.rb

@@ -0,0 +1,5 @@
+module RemoteExecutor
+  module CLIApplication
+    NAME = "remote_executor"
+  end
+end

data/lib/remote_executor/cli.rb

@@ -1,8 +1,8 @@
-module RemoteExecutor
-  
-  class BadEnvironment < Exception
-  end
-  
+require 'rubygems'
+require 'net/ssh'
+
+
+module RemoteExecutor  
   class Cli
 
     DEFAULT_SSH_OPTIONS = { :config=>true }
@@ -11,14 +11,9 @@ module RemoteExecutor
 
       system = System.new( SystemConfig.instance.find_system( name ) )
       
-      if( system.environment == environment )
-        
-        system.hosts.each do |host|
+      system.hosts.each do |host|
         
-          Net::SSH.start( host, system.user, ssh_options ) { |ssh| ssh.exec( "#{command}" ) }
-        end
-      else
-        raise BadEnvironment.new( "Bad environment: '#{system.environment}' for target: '#{system.name}'..." )
+        Net::SSH.start( host, system.user, ssh_options ) { |ssh| ssh.exec( "#{command}" ) }
       end
     end
   end

data/lib/remote_executor/config.rb

@@ -1,34 +1,53 @@
+require 'rubygems'
+require 'choice'
+require 'yaml'
+require 'app'
+
+
 module RemoteExecutor
   
   class YAMLFileNotFound < Exception
   end
+
+  class ConfigurationNotLoaded < Exception
+  end
+
+  class ConfigurationError < Exception
+  end
   
   class Config
-    
-    ##
-    # Get the default configuration over Choice, environment and user default settings
-    def self.get_config_file( config_key )
+  
+    def load_config( config_file )
       
-      if( Choice.choices[:config] )
-        return Choice.choices[:config] 
-      end
+      @config = YAML.load_file( config_file )
+    rescue Exception => e
+      raise YAMLFileNotFound.new( e.message )
+    end 
       
-      if( environment_var = ENV["#{config_key.upcase}"] )
-        return environment_var
-      end
+    public  
+    def initialize
       
-      if( user_config_file = File.join( "#{ENV['HOME']}", ".#{config_key.downcase}rc" ) )
+      cli_cfn = Choice.choices[:config]
+      if( cli_cfn )
+
+        load_config( cli_cfn )
+      else
+        environment_cfn = ENV[CLIApplication::NAME.upcase]
         
-        return user_config_file if File.exist?( user_config_file )
+        if( environment_cfn && '' != environment_cfn )
+          
+          load_config( environment_cfn )
+        else
+          user_cfn = "#{ENV['HOME']}/.#{CLIApplication::NAME.downcase}rc"
+          
+          if( user_cfn && '' != user_cfn && File.exist?( user_cfn ) )
+            
+            load_config( user_cfn )
+          else
+            raise ConfigurationNotLoaded.new( "Configuration not loaded" )           
+          end
+        end
       end
-      
-      raise YAMLFileNotFound.new( "Configuration not found" )
     end
-    
-    def initialize()
-      @config = YAML.load_file( Config.get_config_file( CLIApplication::NAME ) )
-    rescue Exception => e
-      raise YAMLFileNotFound.new( e.message )
-    end    
   end
 end

data/lib/remote_executor/options_parser.rb

@@ -1,3 +1,7 @@
+require 'rubygems'
+require 'choice'
+
+
 module RemoteExecutor
   Choice.options do
     header ''
@@ -9,13 +13,6 @@ module RemoteExecutor
       desc  'The YAML config file'
     end
   
-    option :environment, :required=>true do
-      short '-e'
-      long  '--environment=value'
-      desc  'The Environment name'
-      valid %w[development preproduction production]
-    end
-
     option :system, :required=>true do
       short '-s'
       long  '--system=value'

data/lib/remote_executor/system.rb

@@ -1,20 +1,15 @@
-module RemoteExecutor
-  
-  class System < Struct.new( :name, :environment, :user, :hosts )
+module RemoteExecutor  
+  class System < Struct.new( :name, :user, :hosts )
     
-    public
     def initialize( params )
       
       unless params && params.class == Hash
         fail "Bad parameters"
       end
       
-      if( params[:name]  &&
-          params[:environment]  &&
-          params[:user] &&
-          params[:hosts]  )
+      if( params[:name] && params[:user] && params[:hosts] )
           
-        super( params[:name], params[:environment], params[:user], params[:hosts] )         
+        super( params[:name], params[:user], params[:hosts] )         
         self
       end
     end

data/lib/remote_executor/system_config.rb

@@ -1,16 +1,20 @@
+require 'singleton'
+require 'config'
+
+
 module RemoteExecutor
   
-  class ConfigurationError < Exception
-  end
-  
   class SystemConfig < Config
     include Singleton
 
     def find_system( system_name )
       
-      @config.each { |system| return system if( system[:name] == system_name ) }
+      @config.each do |system|
+         
+        return system if( system[:name] == system_name )
+      end
       
-      raise ConfigurationError.new( "System: '#{system_name}' not found in #{@config.inspect}" )
+      raise ConfigurationError.new( "System: '#{system_name}' not found" )
     end
   end
 end

data/lib/remote_executor/version.rb

@@ -1,13 +1,14 @@
 module RemoteExecutor  
   module Version
 
-    MAJOR = 0 
-    MINOR = 4 
-    PATCH = 0
-
-    STRING = [MAJOR, MINOR, PATCH ].compact.join( '.' )
+    MAJOR  = 0 
+    MINOR  = 6 
+    PATCH  = 0
+    
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end 
 
-  NAME    = 'remote_executor'
-  VERSION = Version::STRING
+  NAME          = 'remote_executor'
+  VERSION       = Version::STRING
+  COMPLETE_NAME = "#{NAME}-#{VERSION}"
 end

data/test/unit/tc_cli.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join( File.dirname( __FILE__ ), %w[.. .. lib remote_executor] )
+
+require 'test/unit'
+require 'cli'
+
+
+class TC_Cli < Test::Unit::TestCase
+  # def setup
+  # end
+  # 
+  # def teardown
+  # end
+
+  def test_execute
+    true
+  end
+  
+end

data/test/unit/tc_config.rb

@@ -0,0 +1,44 @@
+$:.unshift File.join( File.dirname( __FILE__ ), %w[.. .. lib remote_executor] )
+
+require 'test/unit'
+require 'fileutils'
+require 'config'
+
+
+class TC_Config < Test::Unit::TestCase
+
+  def setup
+    @fixtures_file = '../fixtures/settings.yml'
+    @test_file     = '/tmp/settings.yml'
+    @rc_file       = "#{ENV['HOME']}/.#{RemoteExecutor::CLIApplication::NAME.downcase}rc"
+  end
+  
+  def teardown
+  end
+  
+  def test_initialize()
+    assert_raises( RemoteExecutor::YAMLFileNotFound ) { RemoteExecutor::Config.new( "AppFoo" ) }
+  end
+  
+  def test_initialize_environment
+    
+    FileUtils.cp( @fixtures_file, @test_file )
+    ENV[RemoteExecutor::CLIApplication::NAME.upcase] = @test_file 
+
+    assert_instance_of( RemoteExecutor::Config, RemoteExecutor::Config.new )
+
+    ENV[RemoteExecutor::CLIApplication::NAME.upcase] = "" 
+    FileUtils.rm( @test_file )
+  end
+  
+  def test_initialize_rcfile
+    # File not found
+    assert_raises( RemoteExecutor::ConfigurationNotLoaded ) { RemoteExecutor::Config.new }
+    
+    FileUtils.cp( @fixtures_file, @rc_file )
+    
+    assert_instance_of( RemoteExecutor::Config, RemoteExecutor::Config.new )
+    
+    FileUtils.remove( @rc_file )
+  end  
+end

data/test/unit/tc_system.rb

@@ -0,0 +1,35 @@
+$:.unshift File.join( File.dirname( __FILE__ ), %w[.. .. lib remote_executor] )
+
+require 'test/unit'
+require 'system'
+
+
+class TC_System < Test::Unit::TestCase
+
+  TEST_SYSTEM_NAME  = 'wi.pro'
+  TEST_SYSTEM_USER  = 'root'
+  TEST_SYSTEM_HOSTS = [ 'lr1.wi.pro', 'lr2.wi.pro', 'alf1.wi.pro', 'alf2.wi.pro' ]
+  TEST_PARAMS       = { 
+    :name=>TEST_SYSTEM_NAME, 
+    :user=>TEST_SYSTEM_USER, 
+    :hosts=>TEST_SYSTEM_HOSTS 
+  }
+  
+  def setup
+  end
+
+  def teardown
+  end
+  
+  def test_initialize
+    assert_raise( RuntimeError) { RemoteExecutor::System.new( "foo" ) }
+    
+    test_system = RemoteExecutor::System.new( TEST_PARAMS )
+    
+    assert_instance_of( RemoteExecutor::System, test_system )
+    assert_equal( TEST_SYSTEM_NAME,  test_system.name)
+    assert_equal( TEST_SYSTEM_USER,  test_system.user )
+    assert_equal( TEST_SYSTEM_HOSTS, test_system.hosts )
+  end
+  
+end

data/test/unit/tc_system_config.rb

@@ -0,0 +1,35 @@
+$:.unshift File.join( File.dirname( __FILE__ ), %w[.. .. lib remote_executor] )
+
+require 'test/unit'
+require 'system_config'
+require 'fileutils'
+
+
+class TC_SystemConfig < Test::Unit::TestCase
+ 
+  TEST_GOOD_SYSTEM_ID = 'wi.pro'
+  TEST_SYSTEM_USER    = 'root'
+  TEST_SYSTEM_HOSTS   = [ 'lr1.wi.pro', 'lr2.wi.pro', 'alf1.wi.pro', 'alf2.wi.pro' ]
+  
+  def setup    
+    @fixtures_file = "../fixtures/settings.yml"
+    @test_file     = "/tmp/settings.yml"
+     
+    FileUtils.copy( @fixtures_file, @test_file )    
+    ENV[RemoteExecutor::CLIApplication::NAME.upcase] = @test_file 
+    @system_config = RemoteExecutor::SystemConfig.instance( @test_file )
+  end
+  
+  def teardown
+    FileUtils.remove( @test_file )
+  end
+
+  def test_find_system
+    
+    assert_instance_of( Hash, @system_config.find_system( TEST_GOOD_SYSTEM_ID ))  
+    assert_equal( TEST_GOOD_SYSTEM_ID, @system_config.find_system( TEST_GOOD_SYSTEM_ID )[:name] )
+    assert_equal( TEST_SYSTEM_USER,    @system_config.find_system( TEST_GOOD_SYSTEM_ID )[:user] )
+    assert_equal( TEST_SYSTEM_HOSTS,   @system_config.find_system( TEST_GOOD_SYSTEM_ID )[:hosts] )
+    assert_raise( RemoteExecutor::ConfigurationError ) { @system_config.find_system( 'fooSystem' ) }  
+  end
+end

data/test/unit/ts_all.rb

@@ -0,0 +1,24 @@
+require 'test/unit/testsuite'
+require 'test/unit/ui/console/testrunner'
+require 'tc_config'
+require 'tc_system_config'
+require 'tc_system'
+require 'tc_cli'
+
+
+class TS_RemoteExecutorTests
+  
+  def self.suite
+    suite = Test::Unit::TestSuite.new
+
+    suite << TC_Config.suite
+    suite << TC_SystemConfig.suite
+    suite << TC_System.suite
+    suite << TC_Cli.suite
+
+    return suite
+  end
+end
+
+
+Test::Unit::UI::Console::TestRunner.run( TS_RemoteExecutorTests )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: remote_executor
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 6
   - 0
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Javier Juarez
@@ -26,10 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 1
+        - 0
+        version: 0.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,14 +42,16 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
+        - 2
+        - 0
         - 0
-        version: "0"
+        version: 2.0.0
   type: :runtime
   version_requirements: *id002
 description: A little remote command launcher over SSH connections
-email: javier.juarez_AT_ gmail_DOT_com
+email: javier.juarez_AT_gmail_DOT_com
 executables: 
 - remote_executor
 extensions: []
@@ -57,6 +61,7 @@ extra_rdoc_files:
 files: 
 - bin/remote_executor
 - lib/remote_executor.rb
+- lib/remote_executor/app.rb
 - lib/remote_executor/cli.rb
 - lib/remote_executor/config.rb
 - lib/remote_executor/options_parser.rb
@@ -64,6 +69,11 @@ files:
 - lib/remote_executor/system_config.rb
 - lib/remote_executor/version.rb
 - README.rdoc
+- test/unit/tc_cli.rb
+- test/unit/tc_config.rb
+- test/unit/tc_system.rb
+- test/unit/tc_system_config.rb
+- test/unit/ts_all.rb
 has_rdoc: true
 homepage: http://github.com/jjuarez/remote_executor
 licenses: 
@@ -98,5 +108,9 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A very simple gem that helps to launch remote commands over SSH connections
-test_files: []
-
+test_files: 
+- test/unit/tc_cli.rb
+- test/unit/tc_config.rb
+- test/unit/tc_system.rb
+- test/unit/tc_system_config.rb
+- test/unit/ts_all.rb