server_remote 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tobias Crawley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,37 @@
+h2. Server Remote
+
+Server Remote is a gem that provides common application server commands over ssh via a script in @script/@ called @remote@.
+
+Currently, it provides the following commands:
+
+* @remote shell@ - same as ssh'ing to the server (this is the default command, so it can be called with just @remote@)
+* @remote console@ - executes a @script/console@ on the server
+* @remote logtail@ - executes @tail -f log/<environment>.log@ on the server
+* @remote cmd <some command>@ executes command on the server, displaying the result. It @cd@'s to the remote app root first.
+* @remote scp <local_file> :<remote_file>@ provides scp. Prefix remote files with ':'
+
+h3. Configuration
+
+Configuration is stored in @config/server_remote.yml@. On installation, a sample file is copied to @APP_ROOT/config/@ (along with @APP_ROOT/script/remote@).  
+
+The configuration file groups configurations into _profiles_. A profile defines the info needed to connect to a server, along with the path to the app and the environment it is running under.  
+
+The default profile is _app_. This can be changed with the @default_profile:@ setting in the config file, and overridden on any call with the @-p profile@ switch. This switch must be the first argument. Example: 
+
+@script/remote -p admin console@
+
+h3. Installation
+
+First, install the gem:
+
+@gem install tobias-server_remote --source http://gems.github.com@
+
+Second, use @server_remotify@ command to create the config and script file in your project:
+
+@server_remotify path_to_app@
+
+If either of the @config/@ or @script/@ dirs do not exist, they will be created for you.
+
+*Note:* this plugin uses the ssh and scp binaries, which must be in your path. I have absolutely no idea if it will work on Windows. 
+ 
+Copyright (c) 2009 Tobias Crawley, released under the MIT license

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/bin/server_remotify

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'server_remote'
+
+if ARGV[0]
+  ServerRemote::InstallTools.install(ARGV[0])
+else
+  $stderr.puts "Usage: #{$0} path_to_app"
+end

data/config/defaults.yml

@@ -0,0 +1,4 @@
+#default settings
+environment: production
+app_path: /mnt/app/current
+tail_initial_lines: 500

data/config/server_remote.yml.sample

@@ -0,0 +1,39 @@
+# Config file for server_remote plugin (http://github.com/tobias/server_remote)
+# Options are grouped into named profiles. 
+
+# The default profile is 'app'. This can be changed here (this is the only
+# top-level configuration option - the rest are within profiles).
+#default_profile: app
+
+# The only required option in a profile is host:. The rest can be pulled from
+# the defaults or inferred by ssh.
+
+# user: Specifies the user to log in as. No default; ssh will assume the 
+# current user.
+
+# keyfile: specifies the path (relative to RAILS_ROOT) to the ssh keyfile. No 
+# default; ssh will ask for a password.
+
+# environment: specifies the rails environment for the app on the server. Applies
+# to the 'console' and 'logtail' commands. Default is 'production'.
+
+# app_path: specifies the path to the app on the server relative to user:'s home 
+# or absolute. Default is '/mnt/app/current/'.
+
+# tail_initial_lines: specifies how many lines the 'logtail' command should show
+# initially. Default is 500.
+
+common: &common
+  keyfile: config/server-key.pem
+  host: server.example.com
+
+# Profiles:
+
+app:
+  <<: *common
+  user: app
+
+admin:
+  <<: *common
+  user: admin
+

data/lib/hash_ext.rb

@@ -0,0 +1,8 @@
+class Hash
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+end

data/lib/server_remote/install_tools.rb

@@ -0,0 +1,28 @@
+module ServerRemote
+  class InstallTools
+
+    def self.install(app_root)
+      app_cfg_dir = File.join(app_root, 'config')
+
+      FileUtils.mkdir(app_cfg_dir) unless File.exists?(app_cfg_dir)
+      
+      cp File.join(GEM_ROOT, 'config', 'server_remote.yml.sample'), File.join(app_cfg_dir, 'server_remote.yml')
+
+      app_script_dir = File.join(app_root, 'script')
+
+      FileUtils.mkdir(app_script_dir) unless File.exists?(app_script_dir)
+      
+      cp File.join(GEM_ROOT, 'script', 'remote'), File.join(app_script_dir, 'remote')
+    end
+
+    private
+    def self.cp(src, dest)
+      if File.exists?(dest)
+        puts "File '#{dest}' exists; skipping\n"
+      else
+        FileUtils.cp src, dest
+      end
+    end
+
+  end
+end

data/lib/server_remote/server_remote.rb

@@ -0,0 +1,230 @@
+require 'rubygems'
+require 'yaml'
+require 'simplecli'
+require 'hash_ext'
+
+module ServerRemote
+  GEM_ROOT = File.join(File.dirname(__FILE__), '..', '..')
+  
+  module Util
+
+    DEFAULT_PROFILE = 'app'
+
+    
+    def default_options_path
+      File.join(*([GEM_ROOT] + %w{config defaults.yml}))
+    end
+    
+    def execute(cmd)
+      print "--> calling '#{cmd}'\n"
+      Kernel.system(cmd)
+    end
+
+    def user_and_host
+      user = "#{config[:user]}@" if config[:user]
+      "#{user}#{config[:host]}"
+    end
+
+    def keyfile_option
+      "-i #{File.join(app_root, config[:keyfile])} " if config[:keyfile]
+    end
+    
+    def ssh_command
+      "ssh -t #{keyfile_option}#{user_and_host}"
+    end
+    
+    def scp_command
+      "scp #{keyfile_option}"
+    end
+
+    def scp_file_argument(arg)
+      if arg and arg[0..0] == ':'
+        user_and_host + arg
+      else
+        arg
+      end
+    end
+    
+    def console_action
+      "./script/console #{config[:environment]}"
+    end
+
+    def cd_to_app_action
+      "cd #{config[:app_path]}"
+    end
+
+    def tail_action
+      "tail -n #{config[:tail_initial_lines]} -f log/#{config[:environment]}.log"
+    end
+
+    def remote_command(args)
+      args = args.join(' ') if args.respond_to?(:join)
+      "#{ssh_command} '#{args}'"
+    end
+
+    def remote_command_in_app(args)
+      args = args.join(' ') if args.respond_to?(:join)
+      remote_command("#{cd_to_app_action};#{args}")
+    end
+    
+    def app_root=(app_root)
+      @app_root = app_root
+    end
+
+    def app_root
+      raise 'app_root not set!' unless @app_root
+      @app_root
+    end
+      
+    def config=(cfg)
+      @config = cfg
+    end
+    
+    def config
+      @config ||= {}
+    end
+
+    def config_path
+      options[:config_path] ? options[:config_path] : File.join(app_root, 'config', 'server_remote.yml')
+    end
+
+    def load_config
+      load_default_config
+      load_app_config(config_path)
+    end
+    
+    def parse_common_args
+      if args.first == '-p'
+        args.shift
+        p = args.shift
+        if p
+          config[:profile] = p
+        else
+          raise "Missing profile argument for -p"
+        end
+      end
+      
+      # get around simplecli's usage call when there are no arguments
+      # instead of calling the default action
+      args << '--nullarg' if args.empty?
+    end
+
+    protected
+
+    def load_app_config(config_path)
+      cfg = YAML.load_file(config_path)
+      self.config[:profile] ||= cfg['default_profile'] || DEFAULT_PROFILE
+      if cfg[config[:profile]]
+        self.config.merge!(cfg[config[:profile]].symbolize_keys)
+      else
+        raise "No profile '#{config[:profile]}' exists in #{config_path}"
+      end      
+    end
+    
+    def load_default_config
+      self.config.merge!(YAML.load_file(default_options_path).symbolize_keys)
+    end
+
+
+  end
+    
+  class Command
+    include SimpleCLI
+    include Util
+    
+    def usage_help
+      "Summary: prints usage message"
+    end
+    
+    def usage
+      puts <<EOH
+Executes commands on a remote server over ssh. Configuration is in:
+#{File.join(app_root, 'config', 'server_remote.yml')}
+
+You can override the profile used with -p profile. The default profile is: #{config[:profile]}
+
+Learn more in the readme:
+#{File.join(GEM_ROOT, 'README.textile')}
+
+EOH
+
+      commands
+    end
+    
+    def shell_help
+      "Summary: executes remote shell"
+    end
+    
+    def shell(*args)
+      execute ssh_command
+    end
+    
+    def console_help
+      'Summary: executes remote console'
+    end
+    
+    def console(*args)
+      execute remote_command_in_app(console_action)
+    end
+    
+    def logtail_help
+      'Summary: executes remote tail -f on the log'
+    end
+    
+    def logtail(*args)
+      execute remote_command_in_app(tail_action)
+    end
+
+    def cmd_help
+      %{
+Summary: executes an arbitrary command on the server after a cd to the app path
+
+usage: #{script_name} cmd <command>
+}
+    end
+
+    def cmd(*args)
+      if args.empty?
+        cmd_help
+      else
+        execute remote_command_in_app(args)
+      end
+    end
+    
+    def scp_help
+       %{
+Summary: copies files over scp (prefix remote files with ':')
+
+usage: #{script_name} scp <file1> <file2>
+
+Example:
+
+#{script_name} scp /local/file :/remote/file executes:
+scp /local/file user@host:/remote/file
+
+Any non colon prefixed arguments will be passed to scp.
+}
+    end
+    
+    def scp(*args)
+      if args.empty?
+        scp_help
+      else
+        execute scp_command + args.collect { |f| scp_file_argument(f) }.join(' ')
+      end
+    end
+    
+    
+    def self.start(app_root, args, options = {})
+      remote = new(args, options.merge(:default => 'shell'))
+      remote.app_root = app_root
+      remote.parse_common_args
+      remote.load_config
+      remote.parse!
+      remote.run
+    end
+
+  end
+
+end
+

data/lib/server_remote.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require File.join(File.dirname(__FILE__), 'server_remote', 'server_remote')
+require File.join(File.dirname(__FILE__), 'server_remote', 'install_tools')
+
+

data/script/remote

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#-*-ruby-*-
+require 'rubygems'
+require 'server_remote'
+
+ServerRemote::Command.start(File.join(File.dirname(__FILE__), '..'), ARGV)
+

data/test/config/config_no_override.yml

@@ -0,0 +1,2 @@
+app:
+  host: test

data/test/config/config_override.yml

@@ -0,0 +1,3 @@
+app:
+  host: test
+  environment: test

data/test/config/defaults.yml

@@ -0,0 +1,3 @@
+#default settings
+environment: production
+app_path: current

data/test/server_remote_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class ServerRemoteTest < Test::Unit::TestCase
+  module ServerRemote::Util
+    def execute(cmd)
+      cmd
+    end
+
+  end
+
+
+  def run_cmd(args = [])
+    ServerRemote::Command.start(TEST_ROOT, args, :config_path => TEST_ROOT + '/config/config_no_override.yml')
+  end
+
+
+  def test_shell_action
+    assert_equal 'ssh -t test', run_cmd
+    assert_equal 'ssh -t test', run_cmd(%w{-p app})
+  end
+  
+  def test_console_action
+    assert_equal "ssh -t test 'cd /mnt/app/current;./script/console production'", run_cmd(%w{console})
+  end
+
+  def test_logtail_action
+    assert_equal "ssh -t test 'cd /mnt/app/current;tail -n 500 -f log/production.log'", run_cmd(%w{logtail})
+  end
+
+  def test_cmd_action
+    assert_match /^Summary:/, run_cmd(%w{cmd})
+    assert_equal "ssh -t test 'cd /mnt/app/current;ls'", run_cmd(%w{cmd ls})
+    assert_equal "ssh -t test 'cd /mnt/app/current;ls -p'", run_cmd(%w{cmd ls -p})
+    assert_equal "ssh -t test 'cd /mnt/app/current;ls'", run_cmd(%w{-p app cmd ls})
+  end
+  
+  def test_scp_action
+    assert_match /^Summary:/, run_cmd(%w{scp})
+    assert_equal "scp test:/remote/file /local/file", run_cmd(%w{scp :/remote/file /local/file})
+    assert_equal "scp test:/remote/file test:/local/file", run_cmd(%w{scp :/remote/file :/local/file})
+  end
+
+end

data/test/server_remote_util_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+require 'pp'
+
+class ServerRemoteUtilTest < Test::Unit::TestCase
+  include ServerRemote::Util
+  attr_accessor :args
+  attr_accessor :options
+
+  def setup
+    self.options = {}
+    self.app_root = TEST_ROOT
+  end
+  
+  def test_load_config_should_load_defaults
+    options[:config_path] = TEST_ROOT + '/config/config_no_override.yml'
+    load_config 
+    assert_equal 'app', config[:profile]
+    assert_equal 'production', config[:environment]
+  end
+
+  def test_load_config_should_override_defaults
+    options[:config_path] = TEST_ROOT + '/config/config_override.yml'
+    load_config 
+    assert_equal 'test', config[:environment]
+  end
+
+  def test_parse_common_args_should_set_profile
+    self.config = {}
+    self.args =  %w{-p profile}
+    parse_common_args
+    assert_equal 'profile', config[:profile]
+  end
+  
+  
+  def test_user_and_host
+    self.config = {:host => 'host'}
+    assert_equal 'host', user_and_host
+
+    self.config[:user] = 'user'
+    assert_equal 'user@host', user_and_host
+  end
+  
+  def test_keyfile_option
+    self.config = {}
+    assert_nil keyfile_option
+
+    self.config[:keyfile] = 'kf'
+    assert_equal "-i #{File.join(TEST_ROOT, 'kf')} ", keyfile_option
+  end
+  
+  def test_remote_command
+    self.config = {:host => 'host'}
+    assert_equal "ssh -t host 'cmd'", remote_command(%w{cmd})
+  end
+
+  def test_remote_command_in_app
+    self.config = {:host => 'host', :app_path => 'path'}
+    assert_equal "ssh -t host 'cd path;cmd'", remote_command_in_app(%w{cmd})
+  end
+
+  def test_scp_command
+    self.config = {}
+    assert_equal 'scp ', scp_command
+    self.config[:keyfile] = 'kf'
+    assert_equal "scp -i #{File.join(TEST_ROOT, 'kf')} ", scp_command
+  end
+  
+  def test_scp_file_argument
+    self.config = {:host => 'host'}
+    assert_equal 'test', scp_file_argument('test')
+    assert_equal 'host:test', scp_file_argument(':test')
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+TEST_ROOT = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'server_remote'
+
+class Test::Unit::TestCase
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: server_remote
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 -04:00
+default_executable: server_remotify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: remi-simplecli
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+    version: 
+description: 
+email: tcrawley@gmail.com
+executables: 
+- server_remotify
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- README.textile
+- VERSION.yml
+- bin/server_remotify
+- config/defaults.yml
+- config/server_remote.yml.sample
+- lib/hash_ext.rb
+- lib/server_remote.rb
+- lib/server_remote/install_tools.rb
+- lib/server_remote/server_remote.rb
+- script/remote
+- test/config/config_no_override.yml
+- test/config/config_override.yml
+- test/config/defaults.yml
+- test/server_remote_test.rb
+- test/server_remote_util_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/tobias/server_remote
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem that provides script/remote to a project for executing remote commands.
+test_files: 
+- test/server_remote_test.rb
+- test/server_remote_util_test.rb
+- test/test_helper.rb