torquebox-remote-deployer 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.idea

data/LICENSE.txt

@@ -0,0 +1,23 @@
+#--
+# The MIT License
+#
+# Copyright (c) 2007-2008 Sun Microsystems, Inc.
+#
+# 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.md

@@ -0,0 +1,60 @@
+# torquebox-remote-deployer
+
+The torquebox-remote-deployer is a Ruby Gem for deploying TorqueBox `.knob` files to a remote TorqueBox server.  It
+allows you to deploy your entire application as a single file, but still be able to run Rake and other jobs on the
+server.
+
+## How to Use It
+
+First, you'll need to set up your TorqueBox application for Rake.
+Then run `gem install torquebox-remote-deployer` or add the gem to your `Gemfile`:
+
+    gem "torquebox-remote-deployer"
+
+Once the Gem is installed, you'll have a few new Rake tasks:
+
+    rake torquebox:remote:deploy              # Deploy the local archive file t...
+    rake torquebox:remote:exec[cmd]           # Execute Ruby commands against t...
+    rake torquebox:remote:stage               # Upload this application to the ...
+    rake torquebox:remote:stage:check         # Verify that the archive file ma...
+    rake torquebox:remote:stage:deploy        # Deploy the staged archive file ...
+    rake torquebox:remote:undeploy            # Undeploy the archive file to th...
+
+Before using these, you'll need to configure your remote server by creating a `config/torquebox_remote.rb` file in your project.
+This file will be similar to `config/torquebox.rb` in its format, but the directives are different.
+You'll need to configure it like this:
+
+    TorqueBox::RemoteDeploy.configure do
+      torquebox_home "/opt/torquebox"
+      hostname "localhost"
+      port "2222"
+      user "vagrant"
+      key "#{ENV["GEM_HOME"]}/gems/vagrant-0.8.7/keys/vagrant"
+      sudo true
+    end
+
+Of course, fill in the values with your own server information.
+Then you can stage your application on the remote server with this command:
+
+    $ rake torquebox:remote:stage
+
+This will create a Knob file, copy it to the remote server, and explode it to a location where commands can be run from
+its root directory; like this:
+
+    $ rake torquebox:remote:exec["bundle install --path vendor/bundle"]
+
+Now you can to do more useful things like running migrations:
+
+    $ rake torquebox:remote:exec["rake db:migrate RAILS_ENV=production"]
+
+After the `exec` tasks are complete, you can deploy the Knob to the TorqueBox server.
+
+    $ rake torquebox:remote:deploy
+
+This task works just like the `torquebox:deploy:archive` task, but remotely.
+
+## TODO
+
+*  Make it friendly to remote Windows targets (already works on Windows source machines).
+*  Support deploying to mutliple servers (config would look like multi-hosts in a Vagrantfile)
+*  Support deploying over FTP or SFTP in addition to SCP/SSH.

data/lib/torquebox-remote-deployer.rb

@@ -0,0 +1 @@
+require 'torquebox/rake/tasks/remote'

data/lib/torquebox/rake/tasks/remote.rb

@@ -0,0 +1,47 @@
+require 'rake'
+require 'torquebox/deploy_utils'
+require 'torquebox/remote_deploy_utils'
+
+namespace :torquebox do
+  namespace :remote do
+
+    desc "Upload this application to the remote server as an archive file"
+    task :stage => ["torquebox:archive"] do
+      archive_name = TorqueBox::DeployUtils.archive_name
+      TorqueBox::RemoteDeployUtils.stage(archive_name)
+    end
+
+    desc "Execute Ruby commands against the staged archive file"
+    task :exec, [:cmd] do |t, args|
+      cmd = args[:cmd]
+      archive_name = TorqueBox::DeployUtils.archive_name
+      TorqueBox::RemoteDeployUtils.exec_ruby(archive_name, cmd)
+    end
+
+    desc "Deploy the local archive file to the remote TorqueBox server"
+    task :deploy do
+      archive_name = TorqueBox::DeployUtils.archive_name
+      TorqueBox::RemoteDeployUtils.deploy(archive_name)
+    end
+
+    namespace :stage do
+      desc "Deploy the staged archive file to the remote TorqueBox server"
+      task :deploy do
+        archive_name = TorqueBox::DeployUtils.archive_name
+        TorqueBox::RemoteDeployUtils.deploy_from_stage(archive_name)
+      end
+
+      desc "Verify that the archive file made it here intact"
+      task :check do
+        archive_name = TorqueBox::DeployUtils.archive_name
+        # TODO: checksum local and on server
+      end
+    end
+
+    desc "Undeploy the archive file to the remote TorqueBox server"
+    task :undeploy do
+      archive_name = TorqueBox::DeployUtils.archive_name
+      TorqueBox::RemoteDeployUtils.undeploy(archive_name)
+    end
+  end
+end

data/lib/torquebox/remote_deploy_utils.rb

@@ -0,0 +1,147 @@
+require "net/ssh"
+require "net/scp"
+
+module TorqueBox
+  module RemoteDeployUtils
+    class << self
+
+      def stage(archive_file)
+        with_config(archive_file) do |config, app_name|
+          cleanup_stage(config, archive_file, app_name)
+          prepare_stage(config, app_name)
+          stage_archive(config, archive_file)
+          unjar_staged_archive(config, archive_file, app_name)
+        end
+      end
+
+      def deploy(archive_file)
+        with_config(archive_file) do |config, app_name|
+          scp_upload(config, archive_file, "#{config.torquebox_home}/jboss/standalone/deployments/")
+          do_deploy(config, app_name)
+        end
+      end
+
+      def deploy_from_stage(archive_file)
+        with_config(archive_file) do |config, app_name|
+          ssh_exec(config, "cp #{config.torquebox_home}/stage/#{app_name}.knob #{config.torquebox_home}/jboss/standalone/deployments")
+          do_deploy(config, app_name)
+        end
+      end
+
+      def undeploy(archive_file)
+        with_config(archive_file) do |config, app_name|
+          ssh_exec(config, "rm -f #{config.torquebox_home}/jboss/standalone/deployments/#{app_name}.knob*")
+        end
+      end
+
+      def exec_ruby(archive_file, cmd)
+        with_config(archive_file) do |config, app_name|
+          ssh_exec(config, "cd #{config.torquebox_home}/stage/#{app_name}",
+                   "export PATH=$PATH:#{config.torquebox_home}/jruby/bin",
+                   "#{config.torquebox_home}/jruby/bin/jruby -S #{cmd}")
+        end
+      end
+
+      private
+
+      def prefix(config)
+        config.sudo ? "sudo" : p
+      end
+
+      def do_deploy(config, app_name)
+        ssh_exec(config, "touch #{config.torquebox_home}/jboss/standalone/deployments/#{app_name}.knob.dodeploy")
+      end
+
+      def app_name(archive_file)
+        File.basename(archive_file, ".knob")
+      end
+
+      def unjar_staged_archive(config, archive_file, app_name)
+        ssh_exec(config, "cd #{config.torquebox_home}/stage/#{app_name} && #{prefix(config)}jar -xf ../#{archive_file}")
+      end
+
+      def stage_archive(config, archive_file)
+        scp_upload(config, archive_file, "#{config.torquebox_home}/stage/#{File.basename(archive_file)}")
+      end
+
+      def cleanup_stage(config, archive_file, app_name)
+        ssh_exec(config, "rm -f #{config.torquebox_home}/stage/#{archive_file}")
+        ssh_exec(config, "rm -rf #{config.torquebox_home}/stage/#{app_name}")
+      end
+
+      def prepare_stage(config, app_name)
+        ssh_exec(config, "mkdir -p #{config.torquebox_home}/stage/#{app_name}")
+      end
+
+      def with_config(archive_file)
+        yield read_config, app_name(archive_file)
+      end
+
+      def ssh_exec(config, *cmd)
+        Net::SSH.start(config.hostname, config.user, :port => config.port, :keys => [config.key]) do |ssh|
+          ssh.exec(cmd.map { |c| "#{prefix(config)} #{c}" }.join("\n"))
+        end
+      end
+
+      def scp_upload(config, local_file, remote_file)
+        Net::SCP.upload!(config.hostname, config.user, local_file, remote_file,
+                         :ssh => {:port => config.port, :keys => [config.key]}
+        ) do |ch, name, sent, total|
+          print "\rCopying #{name}: #{sent}/#{total}"
+        end
+        print "\n"
+      end
+
+      def read_config
+        eval(File.read("config/torquebox_remote.rb")).config
+      end
+    end
+  end
+
+  class RemoteDeploy
+    def self.configure(&blk)
+      new(blk)
+    end
+
+    def initialize(blk)
+      @config = RemoteConfig.new
+      instance_eval &blk
+    end
+
+    attr_reader :config
+
+    def hostname(h)
+      @config.hostname = h
+    end
+
+    def port(p)
+      @config.port = p
+    end
+
+    def user(u)
+      @config.user = u
+    end
+
+    def key(k)
+      @config.key = k
+    end
+
+    def torquebox_home(tbh)
+      @config.torquebox_home = tbh
+    end
+
+    def sudo(sudo)
+      @config.sudo = sudo
+    end
+  end
+
+  class RemoteConfig
+    attr_accessor :hostname, :port, :user, :key, :torquebox_home, :sudo
+
+    def initialize
+      @user = "torquebox"
+      @torquebox_home = "/opt/torquebox"
+      @sudo = false
+    end
+  end
+end

data/torquebox-remote-deployer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "torquebox-remote-deployer"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joe Kutner"]
+  s.email       = ["jpkutner@gmail.com"]
+  s.homepage    = "https://github.com/jkutner/torquebox-remote-deployer"
+  s.summary     = %q{Deploy Knob files to a remote server with ease.}
+  s.description = %q{This utility allows you to deploy a Torquebox Knob file to a remote server}
+
+  s.rubyforge_project = "torquebox-remote-deployer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "jruby-openssl"
+  s.add_dependency "net-ssh"
+  s.add_dependency "net-scp"
+  s.add_dependency "rake"
+  s.add_dependency "torquebox-rake-support"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: torquebox-remote-deployer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Joe Kutner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-18 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: jruby-openssl
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: net-ssh
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: net-scp
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: torquebox-rake-support
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id005
+description: This utility allows you to deploy a Torquebox Knob file to a remote server
+email: 
+  - jpkutner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - LICENSE.txt
+  - README.md
+  - lib/torquebox-remote-deployer.rb
+  - lib/torquebox/rake/tasks/remote.rb
+  - lib/torquebox/remote_deploy_utils.rb
+  - torquebox-remote-deployer.gemspec
+homepage: https://github.com/jkutner/torquebox-remote-deployer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: torquebox-remote-deployer
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Deploy Knob files to a remote server with ease.
+test_files: []
+