capistrano-ssh-helpers 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem 'capistrano'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (2.12.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    git (1.2.5)
+    highline (1.6.12)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.5.2)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  capistrano
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Huiming Teo
+
+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.rdoc

@@ -0,0 +1,53 @@
+= capistrano-ssh-helpers
+
+Provides a set of helper tasks related to SSH.
+
+== Install
+  gem install 'capistrano-ssh-helpers'
+
+For bundler, add it into your Gemfile
+
+  gem 'capistrano-ssh-helpers'
+
+== Usage
+You can include all helpers in config/deploy.rb:
+
+  require 'capistrnao-ssh-helpers' # includes all helper tasks
+
+Or only include a specific helper:
+
+  require 'capistrano-ssh-helpers/git_host'
+
+== Helpers
+
+=== git_host
+
+Add a check to ensure Git SSH host is verified on remote server.
+
+The check is added to deploy:check, when :scm is set to :git and 
+:repository looks like a ssh path/url.
+
+
+=== forward_agent
+
+Add a check to ensure local SSH agent has identity key.
+
+The check is added to deploy:check when ssh_options[:forward_agent]
+is enabled.
+
+
+== Contributing to capistrano-ssh-helpers
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Huiming Teo. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "capistrano-ssh-helpers"
+  gem.homepage = "http://github.com/teohm/capistrano-ssh-helpers"
+  gem.license = "MIT"
+  gem.summary = %Q{Capistrano helper tasks related to SSH.}
+  gem.description = %Q{Capistrano helper tasks related to SSH.}
+  gem.email = "teohuiming@gmail.com"
+  gem.authors = ["Huiming Teo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "capistrano-ssh-helpers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/capistrano-ssh-helpers.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "capistrano-ssh-helpers"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Huiming Teo"]
+  s.date = "2012-06-05"
+  s.description = "Capistrano helper tasks related to SSH."
+  s.email = "teohuiming@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "capistrano-ssh-helpers.gemspec",
+    "lib/capistrano-ssh-helpers.rb",
+    "lib/capistrano-ssh-helpers/ext/local_dependency.rb",
+    "lib/capistrano-ssh-helpers/ext/remote_dependency.rb",
+    "lib/capistrano-ssh-helpers/forward_agent.rb",
+    "lib/capistrano-ssh-helpers/git_host.rb"
+  ]
+  s.homepage = "http://github.com/teohm/capistrano-ssh-helpers"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Capistrano helper tasks related to SSH."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/capistrano-ssh-helpers.rb

@@ -0,0 +1,2 @@
+require 'capistrano-ssh-helpers/forward_agent'
+require 'capistrano-ssh-helpers/git_host'

data/lib/capistrano-ssh-helpers/ext/local_dependency.rb

@@ -0,0 +1,28 @@
+require 'capistrano/recipes/deploy/local_dependency'
+
+Capistrano::Deploy::LocalDependency.class_eval do
+
+  # Run a command and check the output.
+  def run_cmd(command, expect, match_is_success=true, message=nil)
+    expect = Regexp.new(Regexp.escape(expect.to_s)) unless expect.is_a?(Regexp)
+
+    @configuration.logger.debug "executing \"#{command}\"" 
+    output = `#{command} 2>&1`
+    @configuration.logger.trace "[local] #{output}"
+
+    is_matched = output =~ expect
+
+    @success = if match_is_success
+      is_matched ? true : false
+    else
+      is_matched ? false : true
+    end
+    
+    unless @success
+      @message = "#{message} (local)"
+    end
+    self
+  end
+
+end
+

data/lib/capistrano-ssh-helpers/ext/remote_dependency.rb

@@ -0,0 +1,39 @@
+require 'capistrano/recipes/deploy/remote_dependency'
+
+Capistrano::Deploy::RemoteDependency.class_eval do
+  def run_cmd(command, expect, match_is_success=true, message=nil, options={})
+    expect = Regexp.new(Regexp.escape(expect.to_s)) unless expect.is_a?(Regexp)
+
+    output_per_server = {}
+    try("#{command} ", options) do |ch, stream, out|
+      output_per_server[ch[:server]] ||= ''
+      output_per_server[ch[:server]] += out
+    end 
+
+    # It is possible for some of these commands to return a status != 0
+    # (for example, rake --version exits with a 1). For this check we
+    # just care if the output matches, so we reset the success flag.
+    @success = true
+
+    errored_hosts = []
+    output_per_server.each_pair do |server, output|
+      if match_is_success
+        next if output =~ expect
+      else
+        next unless output =~ expect
+      end
+      errored_hosts << server
+    end
+
+    if errored_hosts.any?
+      @hosts = errored_hosts.join(', ')
+      output = output_per_server[errored_hosts.first]
+      default_message = "the output #{output.inspect} from #{command.inspect} did not match #{expect.inspect}"
+      @message = message || default_message
+      @success = false
+    end
+
+    self
+  end
+end
+

data/lib/capistrano-ssh-helpers/forward_agent.rb

@@ -0,0 +1,30 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+    abort "capistrano-checks requires Capistrano 2"
+end
+
+require 'capistrano-ssh-helpers/ext/local_dependency'
+
+Capistrano::Configuration.instance.load do
+  namespace :deploy do
+    namespace :forward_agent do
+
+      desc <<-DESC
+        Add check to ensure local SSH agent has identity key.
+
+        The check is added to deploy:check, when ssh_options[:forward_agent]
+        is set to true.
+      DESC
+      task :check do
+        if ssh_options[:forward_agent]
+          depend :local, :run_cmd, 'ssh-add -l',
+            /no identities/, false,
+            "Local SSH agent has no key. To add key: 'ssh-add -K' or 'ssh-add -K private_key_file'"
+        end
+      end #task
+
+    end
+  end
+
+  before 'deploy:check', 'deploy:forward_agent:check'
+
+end

data/lib/capistrano-ssh-helpers/git_host.rb

@@ -0,0 +1,41 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+    abort "capistrano-checks requires Capistrano 2"
+end
+
+require 'capistrano-ssh-helpers/ext/remote_dependency'
+
+Capistrano::Configuration.instance.load do
+  namespace :deploy do
+    namespace :git_host do
+
+      desc <<-DESC
+        Add check to ensure Git SSH host is verified on remote server.
+        
+        The check is added to deploy:check, when :scm is set to :git
+        and :repository looks like a ssh path/url.
+      DESC
+      task :check do
+        return unless scm == :git
+
+        LIKE_SSH_HOST = /^([^@]+@[^:]+):.*$/
+        LIKE_SSH_URL  = %r[^(ssh://[^/]+).*$]
+
+        repo_url = fetch(:repository, '')
+        ssh_host = if repo_url =~ LIKE_SSH_HOST
+                     $1
+                   elsif repo_url =~ LIKE_SSH_URL
+                     $1
+                   end
+
+        if ssh_host
+          depend :remote, :run_cmd, "ssh #{ssh_host}",
+            /Host key verification failed/, false,
+            "Git SSH host is not verified. To verify as known host, run this on server: 'ssh #{ssh_host}'"
+        end
+      end # task
+
+    end
+  end
+
+  before 'deploy:check', 'deploy:git_host:check'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-ssh-helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Huiming Teo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Capistrano helper tasks related to SSH.
+email: teohuiming@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- capistrano-ssh-helpers.gemspec
+- lib/capistrano-ssh-helpers.rb
+- lib/capistrano-ssh-helpers/ext/local_dependency.rb
+- lib/capistrano-ssh-helpers/ext/remote_dependency.rb
+- lib/capistrano-ssh-helpers/forward_agent.rb
+- lib/capistrano-ssh-helpers/git_host.rb
+homepage: http://github.com/teohm/capistrano-ssh-helpers
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3162970074738685013
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Capistrano helper tasks related to SSH.
+test_files: []