torquebox-remote-deployer 0.1.0 → 0.1.1

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
-.idea
+.idea
+tmp

data/lib/torquebox/remote_deploy_utils.rb

@@ -1,44 +1,66 @@
 require "net/ssh"
 require "net/scp"
 
+require 'tempfile'
+
 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)
+          # no need to stage if we are local. we'll just run from the app dir
+          unless config.local
+            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
       end
 
       def deploy(archive_file)
         with_config(archive_file) do |config, app_name|
-          scp_upload(config, archive_file, "#{config.torquebox_home}/jboss/standalone/deployments/")
+          scp_upload(config, archive_file, "#{config.jboss_home}/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")
+          unless config.local
+            ssh_exec(config, "cp #{config.torquebox_home}/stage/#{app_name}.knob #{config.jboss_home}/standalone/deployments")
+          else
+            scp_upload(config, archive_file, "#{config.jboss_home}/standalone/deployments/")
+          end
           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*")
+          unless config.local
+            ssh_exec(config, "rm -f #{config.jboss_home}/standalone/deployments/#{app_name}-knob.yml*")
+            ssh_exec(config, "rm -f #{config.jboss_home}/standalone/deployments/#{app_name}.knob")
+          else
+            FileUtils.rm("#{config.jboss_home}/standalone/deployments/#{app_name}-knob.yml*")
+            FileUtils.rm("#{config.jboss_home}/standalone/deployments/#{app_name}.knob")
+          end
         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}")
+          unless config.local
+            # TODO set RACK_ENV based on env var, and default to production
+            ssh_exec(config, "cd #{config.torquebox_home}/stage/#{app_name}",
+                     "export PATH=$PATH:#{config.torquebox_home}/jruby/bin",
+                     "export RAILS_ENV=production",
+                     "export RACK_ENV=production",
+                     "#{config.torquebox_home}/jruby/bin/jruby -S #{cmd}")
+          else
+            # not sure what to do here yet
+          end
         end
       end
 
@@ -49,7 +71,25 @@ module TorqueBox
       end
 
       def do_deploy(config, app_name)
-        ssh_exec(config, "touch #{config.torquebox_home}/jboss/standalone/deployments/#{app_name}.knob.dodeploy")
+        # TODO set RACK_ENV based on env var, and default to production
+        knob_yml = <<-YAML
+        application:
+          root: #{config.jboss_home}/standalone/deployments/#{app_name}.knob
+        environment:
+          RACK_ENV: production
+          RAILS_ENV: production
+        YAML
+
+        unless config.local
+          knob_yml_file = Tempfile.new("#{app_name}-knob.yml")
+          knob_yml_file.write(knob_yml)
+          knob_yml_file.rewind
+          scp_upload(config, knob_yml_file.path, "#{config.jboss_home}/standalone/deployments/#{app_name}-knob.yml")
+          ssh_exec(config, "touch #{config.jboss_home}/standalone/deployments/#{app_name}-knob.yml.dodeploy")
+        else
+          # todo copy temp file to somewhere
+          File.open("#{config.jboss_home}/standalone/deployments/#{app_name}-knob.yml.dodeploy", "w") {}
+        end
       end
 
       def app_name(archive_file)
@@ -70,11 +110,17 @@ module TorqueBox
       end
 
       def prepare_stage(config, app_name)
-        ssh_exec(config, "mkdir -p #{config.torquebox_home}/stage/#{app_name}")
+        unless config.local
+          ssh_exec(config, "mkdir -p #{config.torquebox_home}/stage/#{app_name}")
+        else
+          FileUtils.mkdir_p("#{config.torquebox_home}/stage/#{app_name}")
+        end
       end
 
       def with_config(archive_file)
-        yield read_config, app_name(archive_file)
+        read_config.each do |config|
+          yield config, app_name(archive_file)
+        end
       end
 
       def ssh_exec(config, *cmd)
@@ -84,16 +130,21 @@ module TorqueBox
       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}"
+        unless config.local
+          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"
+        else
+          FileUtils.cp(local_file, remote_file)
         end
-        print "\n"
       end
 
       def read_config
-        eval(File.read("config/torquebox_remote.rb")).config
+        config_file = ENV["CONFIG_FILE"] || ENV["config_file"] || "config/torquebox_remote.rb"
+        eval(File.read(config_file)).configurations
       end
     end
   end
@@ -105,11 +156,17 @@ module TorqueBox
 
     def initialize(blk)
       @config = RemoteConfig.new
+      @configs = []
       instance_eval &blk
     end
 
     attr_reader :config
 
+    def configurations
+      # evenually, we should merge the base @config settings into the @configs
+      @configs.empty? ? [@config] : @configs
+    end
+
     def hostname(h)
       @config.hostname = h
     end
@@ -130,18 +187,39 @@ module TorqueBox
       @config.torquebox_home = tbh
     end
 
+    def jboss_home(jbh)
+      @config.jboss_home = jbh
+    end
+
     def sudo(sudo)
       @config.sudo = sudo
     end
+
+    def local(l)
+      @config.local = l
+    end
+
+    def host(&block)
+      @configs << RemoteDeploy.new(block).config
+    end
   end
 
   class RemoteConfig
-    attr_accessor :hostname, :port, :user, :key, :torquebox_home, :sudo
+    attr_accessor :hostname, :port, :user, :key, :torquebox_home, :sudo, :local
+
+    def jboss_home=(jbh)
+      @jboss_home = jbh
+    end
+
+    def jboss_home
+      @jboss_home || "#{@torquebox_home}/jboss"
+    end
 
     def initialize
       @user = "torquebox"
       @torquebox_home = "/opt/torquebox"
       @sudo = false
+      @local = false
     end
   end
 end

data/spec/fixtures/local_torquebox_remote.rb

@@ -0,0 +1,5 @@
+TorqueBox::RemoteDeploy.configure do
+  torquebox_home "#{File.expand_path("tmp/torquebox", File.dirname(__FILE__))}"
+  hostname "localhost"
+  local true
+end

data/spec/fixtures/multihost_torquebox_remote.rb

@@ -0,0 +1,18 @@
+TorqueBox::RemoteDeploy.configure do
+  host do
+    torquebox_home "/my/tb/dir"
+    jboss_home "/my/jboss/dir"
+    hostname "1.2.3.4"
+    port "2222"
+    user "torquebox"
+    key "~/.ssh/id_rsa.pub"
+    sudo true
+  end
+
+  host do
+    hostname "4.4.4.4"
+    port "22"
+    user "deploy"
+    key "~/.ssh/torquebox.pub"
+  end
+end

data/spec/fixtures/myapp.knob

@@ -0,0 +1 @@
+this is not really a knob file

data/spec/fixtures/simple_torquebox_remote.rb

@@ -0,0 +1,7 @@
+TorqueBox::RemoteDeploy.configure do
+  torquebox_home "/opt/torquebox"
+  hostname "localhost"
+  port "2222"
+  user "torquebox"
+  key "~/.ssh/id_rsa.pub"
+end

data/spec/remote_deploy_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe TorqueBox::RemoteDeploy do
+  describe ".configure" do
+    context "defaults" do
+      subject do
+        TorqueBox::RemoteDeploy.configure do
+          hostname "1.2.3.4"
+          port "2222"
+          user "torquebox"
+          key "~/.ssh/id_rsa.pub"
+        end
+      end
+
+      it "has one configurations" do
+        subject.configurations.size.should == 1
+        subject.config.should == subject.configurations[0]
+      end
+
+      it "has hostname 1.2.3.4" do
+        subject.config.hostname.should == "1.2.3.4"
+      end
+
+      it "has port 2222" do
+        subject.config.port.should == "2222"
+      end
+
+      it "has user torquebox" do
+        subject.config.user.should == "torquebox"
+      end
+
+      it "has key '~/.ssh/id_rsa.pub'" do
+        subject.config.key.should == "~/.ssh/id_rsa.pub"
+      end
+
+      it "has torquebox_home '/opt/torquebox'" do
+        subject.config.torquebox_home.should == "/opt/torquebox"
+      end
+
+      it "has jboss_home '/opt/torquebox/jboss'" do
+        subject.config.jboss_home.should == "/opt/torquebox/jboss"
+      end
+
+      it "has sudo false" do
+        subject.config.sudo.should == false
+      end
+    end
+
+    context "overrides" do
+      subject do
+        TorqueBox::RemoteDeploy.configure do
+          torquebox_home "/my/tb/dir"
+          jboss_home "/my/jboss/dir"
+          hostname "1.2.3.4"
+          port "2222"
+          user "torquebox"
+          key "~/.ssh/id_rsa.pub"
+          sudo true
+        end
+      end
+
+      it "has one configurations" do
+        subject.configurations.size.should == 1
+        subject.config.should == subject.configurations[0]
+      end
+
+      it "has hostname 1.2.3.4" do
+        subject.config.hostname.should == "1.2.3.4"
+      end
+
+      it "has port 2222" do
+        subject.config.port.should == "2222"
+      end
+
+      it "has user torquebox" do
+        subject.config.user.should == "torquebox"
+      end
+
+      it "has key '~/.ssh/id_rsa.pub'" do
+        subject.config.key.should == "~/.ssh/id_rsa.pub"
+      end
+
+      it "has torquebox_home '/my/tb/dir'" do
+        subject.config.torquebox_home.should == "/my/tb/dir"
+      end
+
+      it "has jboss_home '/my/jboss/dir'" do
+        subject.config.jboss_home.should == "/my/jboss/dir"
+      end
+
+      it "has sudo true" do
+        subject.config.sudo.should == true
+      end
+    end
+
+    context "multiple hosts" do
+      subject do
+        TorqueBox::RemoteDeploy.configure do
+          host do
+            torquebox_home "/my/tb/dir"
+            jboss_home "/my/jboss/dir"
+            hostname "1.2.3.4"
+            port "2222"
+            user "torquebox"
+            key "~/.ssh/id_rsa.pub"
+            sudo true
+          end
+
+          host do
+            hostname "4.4.4.4"
+            port "22"
+            user "deploy"
+            key "~/.ssh/torquebox.pub"
+          end
+        end
+      end
+
+      it "has one configurations" do
+        subject.configurations.size.should == 2
+      end
+
+      it "has correct config" do
+        test_config(subject.configurations[0])
+        test_config(subject.configurations[1])
+      end
+
+      def test_config(configuration)
+        if configuration.hostname == "4.4.4.4"
+          configuration.torquebox_home.should == "/opt/torquebox"
+        elsif configuration.hostname == "1.2.3.4"
+          configuration.torquebox_home.should == "/my/tb/dir"
+        else
+          fail
+        end
+      end
+    end
+  end
+end

data/spec/remote_deploy_utils_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe TorqueBox::RemoteDeployUtils do
+
+  before(:each) do
+    @util = TorqueBox::RemoteDeployUtils
+  end
+
+  describe ".stage" do
+    it "stages one host" do
+      ENV["config_file"] = File.join(File.dirname(__FILE__), "fixtures/simple_torquebox_remote.rb")
+      @util.stub(:ssh_exec)
+      @util.should_receive(:scp_upload).with(anything(), "myapp.knob", "/opt/torquebox/stage/myapp.knob")
+      @util.stage("myapp.knob")
+    end
+
+    it "stages two hosts" do
+      ENV["config_file"] = File.join(File.dirname(__FILE__), "fixtures/multihost_torquebox_remote.rb")
+      @util.stub(:ssh_exec)
+      @util.should_receive(:scp_upload).with(anything(), "myapp.knob", "/my/tb/dir/stage/myapp.knob")
+      @util.should_receive(:scp_upload).with(anything(), "myapp.knob", "/opt/torquebox/stage/myapp.knob")
+      @util.stage("myapp.knob")
+    end
+
+    context "local" do
+      it "stages" do
+        ENV["config_file"] = File.join(File.dirname(__FILE__), "fixtures/local_torquebox_remote.rb")
+        @util.stage("myapp.knob")  # does nothing
+      end
+    end
+  end
+
+  describe ".deploy" do
+    context "local" do
+      before do
+        FileUtils.mkdir_p(deploy_dir)
+      end
+
+      after do
+        FileUtils.remove_dir("#{File.dirname(__FILE__)}/../tmp/torquebox", true)
+      end
+
+      it "deploys" do
+        ENV["config_file"] = File.join(File.dirname(__FILE__), "fixtures/local_torquebox_remote.rb")
+        @util.deploy(File.join(File.dirname(__FILE__), "fixtures/myapp.knob"))
+        File.exists?("#{deploy_dir}/myapp.knob").should == true
+        File.exists?("#{deploy_dir}/myapp.knob.dodeploy").should == true
+      end
+
+      def deploy_dir
+        "#{File.dirname(__FILE__)}/../tmp/torquebox/jboss/standalone/deployments/"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'java'
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'torquebox-remote-deployer'

data/torquebox-remote-deployer.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "torquebox-remote-deployer"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Joe Kutner"]
   s.email       = ["jpkutner@gmail.com"]

metadata

@@ -2,7 +2,7 @@
 name: torquebox-remote-deployer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
   - Joe Kutner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-18 00:00:00 Z
+date: 2012-03-24 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: jruby-openssl
@@ -83,6 +83,13 @@ files:
   - lib/torquebox-remote-deployer.rb
   - lib/torquebox/rake/tasks/remote.rb
   - lib/torquebox/remote_deploy_utils.rb
+  - spec/fixtures/local_torquebox_remote.rb
+  - spec/fixtures/multihost_torquebox_remote.rb
+  - spec/fixtures/myapp.knob
+  - spec/fixtures/simple_torquebox_remote.rb
+  - spec/remote_deploy_spec.rb
+  - spec/remote_deploy_utils_spec.rb
+  - spec/spec_helper.rb
   - torquebox-remote-deployer.gemspec
 homepage: https://github.com/jkutner/torquebox-remote-deployer
 licenses: []
@@ -107,9 +114,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: torquebox-remote-deployer
-rubygems_version: 1.8.9
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Deploy Knob files to a remote server with ease.
-test_files: []
-
+test_files: 
+  - spec/fixtures/local_torquebox_remote.rb
+  - spec/fixtures/multihost_torquebox_remote.rb
+  - spec/fixtures/myapp.knob
+  - spec/fixtures/simple_torquebox_remote.rb
+  - spec/remote_deploy_spec.rb
+  - spec/remote_deploy_utils_spec.rb
+  - spec/spec_helper.rb