taketo 0.0.10 → 0.1.0

data/spec/acceptance/command_spec.rb

@@ -0,0 +1,20 @@
+require 'acceptance_spec_helper'
+
+feature "Run explicit command on remote host" do
+  scenario "Run explicit command on remote" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            host "1.2.3.4"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run --command 'TERM=xterm-256color bash'"
+    exit_status.should be_success
+    stdout.should == %Q{ssh -t 1.2.3.4 "RAILS_ENV=staging TERM=xterm-256color bash"}
+  end
+end
+

data/spec/acceptance/config_dsl_spec.rb

@@ -0,0 +1,277 @@
+require 'acceptance_spec_helper'
+
+feature "Config DSL" do
+  scenario "Reopen config scopes" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            host "1.2.3.4"
+          end
+        end
+      end
+
+      project :slots do
+        environment :staging do
+          server do
+            env :FOO => "bar"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo slots:staging --dry-run"
+    exit_status.should be_success
+    stdout.should =~ %r{ssh -t 1.2.3.4 "(RAILS_ENV=staging FOO=bar|FOO=bar RAILS_ENV=staging) bash"}
+  end
+
+  scenario "Command" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+            command :console do
+              execute "rails c"
+            end
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo slots:staging --dry-run --command console"
+    exit_status.should be_success
+    stdout.should == %Q{ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging rails c"}
+  end
+
+  context "Default command" do
+    background { config_exists <<-CONFIG }
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+
+            default_command :console
+
+            command :console do
+              execute "rails c"
+            end
+          end
+
+          server :s2 do
+            host "2.3.4.5"
+
+            default_command "tmux attach || tmux new-session"
+          end
+        end
+      end
+    CONFIG
+
+    scenario "Explicit default command" do
+      run "taketo slots:staging:s1 --dry-run"
+      exit_status.should be_success
+      stdout.should == %q{ssh -t 1.2.3.4 "RAILS_ENV=staging rails c"}
+    end
+
+    scenario "Default command defined in config" do
+      run "taketo slots:staging:s2 --dry-run"
+      exit_status.should be_success
+      stdout.should == %q{ssh -t 2.3.4.5 "RAILS_ENV=staging tmux attach || tmux new-session"}
+    end
+  end
+
+  scenario "Default location on server" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            location '/var/foo'
+            host "1.2.3.4"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t 1.2.3.4 "cd /var/foo; RAILS_ENV=staging bash"}
+  end
+
+  context "Per-Scope default server config" do
+    background { config_exists <<-CONFIG }
+        default_server_config do
+          env :FOO => 'bar'
+        end
+
+        project :slots do
+          default_server_config do
+            location '/mnt/apps'
+          end
+
+          environment :staging do
+            server :s1 do
+              host "1.2.3.4"
+            end
+          end
+        end
+
+        project :shoes do
+          environment :production do
+            server do
+              host "2.3.4.5"
+            end
+          end
+        end
+    CONFIG
+
+    scenario "Global default server config" do
+      run "taketo shoes --dry-run"
+      exit_status.should be_success
+      stdout.should =~ /ssh -t 2\.3\.4\.5 "(RAILS_ENV=production FOO=bar|FOO=bar RAILS_ENV=production) bash"/
+    end
+
+    scenario "Project default server config" do
+      run "taketo slots --dry-run"
+      stdout.should =~ /ssh -t 1\.2\.3\.4 "cd .mnt.apps; (RAILS_ENV=staging FOO=bar|FOO=bar RAILS_ENV=staging) bash"/
+    end
+  end
+
+  context "Shared server config" do
+    scenario "Simple shared server config" do
+      create_config <<-CONFIG
+        shared_server_config :sc1 do
+          port 9999 #can contain any server config options
+        end
+
+        shared_server_config :sc2 do
+          location "/var/qux"
+        end
+
+        project :slots do
+          environment :staging do
+            server(:s1) { host "1.2.3.4"; include_shared_server_config(:sc1, :sc2) }
+          end
+        end
+      CONFIG
+
+      run "taketo slots:staging:s1 --dry-run"
+      exit_status.should be_success
+      stdout.should == %q{ssh -t -p 9999 1.2.3.4 "cd /var/qux; RAILS_ENV=staging bash"}
+    end
+
+    scenario "Shared server config with arguments" do
+      create_config <<-CONFIG
+        shared_server_config :sc_args1 do |port_num|
+          port port_num
+        end
+
+        shared_server_config :sc_args2 do |projects_root_folder, project_folder|
+          location File.join(projects_root_folder, project_folder)
+        end
+
+        project :slots do
+          environment :staging do
+            server(:s1) do
+              host "1.2.3.4"
+              include_shared_server_config(:sc_args1 => 9999, :sc_args2 => ['/var', 'qux'])
+            end
+          end
+        end
+      CONFIG
+
+      run "taketo slots:staging:s1 --dry-run"
+      exit_status.should be_success
+      stdout.should == %q{ssh -t -p 9999 1.2.3.4 "cd /var/qux; RAILS_ENV=staging bash"}
+    end
+  end
+
+  scenario "Environment variables" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+            env :FOO => "the value"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should =~ %r{ssh -t 1.2.3.4 "cd /var/apps/slots; (RAILS_ENV=staging FOO=the\\ value|FOO=the\\ value RAILS_ENV=staging) bash"}
+  end
+
+  scenario "Unique server alias" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+          end
+
+          server :s2 do
+            global_alias :ss2
+            host "2.3.4.5"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo ss2 --dry-run"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t 2.3.4.5 "RAILS_ENV=staging bash"}
+  end
+
+  scenario "Default destination" do
+    create_config <<-CONFIG
+      default_destination "slots:staging:s2"
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+          end
+          server :s2 do
+            host "2.3.4.5"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should == %Q{ssh -t 2.3.4.5 "RAILS_ENV=staging bash"}
+  end
+
+  scenario "ssh identity file" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            identity_file "/home/gor/.ssh/foo bar"
+            host "2.3.4.5"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t -i /home/gor/.ssh/foo\ bar 2.3.4.5 "RAILS_ENV=staging bash"}
+  end
+
+  scenario "server outside project" do
+    create_config <<-CONFIG
+      server :my_server do
+        host "1.2.3.4"
+      end
+    CONFIG
+
+    run "taketo my_server --dry-run"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t 1.2.3.4 "bash"}
+  end
+
+end

data/spec/acceptance/config_validation_spec.rb

@@ -0,0 +1,109 @@
+require 'acceptance_spec_helper'
+
+feature "Config validation" do
+  scenario "No servers defined" do
+    create_config <<-CONFIG
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("There are no servers. Add some to your config (~/.taketo.rc.rb by default)")
+  end
+
+  scenario "Project has no environments" do
+    create_config <<-CONFIG
+      project :foo do
+      end
+
+      project :bar do
+        environment :baz do
+          server :qux do
+            host '1.2.3.4'
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("Project foo: no environments")
+  end
+
+  scenario "Environment has no servers" do
+    create_config <<-CONFIG
+      project :foo do
+        environment :bar do
+        end
+      end
+
+      project :bar do
+        environment :baz do
+          server :qux do
+            host '1.2.3.4'
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("Environment foo:bar: no servers")
+  end
+
+  scenario "Server has no host defined" do
+    create_config <<-CONFIG
+      project :foo do
+        environment :bar do
+          server do
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("Server foo:bar:default: host is not defined")
+  end
+
+  scenario "Duplicate global server alias" do
+    create_config <<-CONFIG
+      project :foo do
+        environment :bar do
+          server :s1 do
+            host "1.2.3.4"
+            global_alias :a1
+          end
+
+          server :s2 do
+            host "2.3.4.5"
+            global_alias :a1
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("Server foo:bar:s2: global alias 'a1' has already been taken by server foo:bar:s1")
+  end
+
+  scenario "Command without definition" do
+    create_config <<-CONFIG
+      project :foo do
+        environment :bar do
+          server do
+            host "1.2.3.4"
+
+            command :qux do
+            end
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo"
+    exit_status.should_not be_success
+    stderr.should include("Don't know what to execute on command qux")
+  end
+end
+

data/spec/acceptance/connect_to_server_spec.rb

@@ -0,0 +1,60 @@
+require 'acceptance_spec_helper'
+
+feature "connect to server" do
+  scenario "reach server via ssh" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+            user "deployer"
+            location "/var/apps/slots"
+          end
+
+          server :s2 do
+            host "2.3.4.5"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo slots:staging:s1 --dry-run"
+    exit_status.should be_success
+    stdout.should == %Q{ssh -t deployer@1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging bash"}
+  end
+
+  scenario "ssh to the only server" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should == %Q{ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging bash"}
+  end
+
+  scenario "ssh without password" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            identity_file "/home/gor/.ssh/foo bar"
+            host "2.3.4.5"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo --dry-run"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t -i /home/gor/.ssh/foo\ bar 2.3.4.5 "RAILS_ENV=staging bash"}
+  end
+end
+

data/spec/acceptance/error_handling_spec.rb

@@ -0,0 +1,31 @@
+require 'acceptance_spec_helper'
+
+feature "Resolve host error handling" do
+  background { config_exists <<-CONFIG }
+    default_destination "slots:staging:s2"
+    project :slots do
+      environment :staging do
+        server :s1 do
+          host "1.2.3.4"
+        end
+
+        server :s2 do
+          host "2.3.4.5"
+        end
+      end
+    end
+  CONFIG
+
+  scenario "Non-existent location" do
+    run "taketo slots:staging:qqq --dry-run"
+    exit_status.should_not be_success
+    stderr.should include("Can't find server for path slots:staging:qqq")
+  end
+
+  scenario "Ambiguous location" do
+    run "taketo slots:staging --dry-run"
+    exit_status.should_not be_success
+    stderr.should include("There are multiple possible destinations: slots:staging:s1, slots:staging:s2")
+  end
+end
+

data/spec/acceptance/generate_ssh_config_spec.rb

@@ -0,0 +1,44 @@
+require 'acceptance_spec_helper'
+
+feature "Generate SSH config" do
+  background { config_exists <<-CONFIG }
+    project :foo do
+      environment :bar do
+        server do
+          host "bar.foo.com"
+          port 5678
+          user "pivo"
+          identity_file "~/.ssh/id_rsa"
+        end
+      end
+    end
+
+    project :baz do
+      environment :qux do
+        server :bart do
+          global_alias :bazqux
+          host "2.3.4.5"
+        end
+      end
+    end
+  CONFIG
+
+  scenario "Generate ssh config" do
+    run "taketo --generate-ssh-config"
+    exit_status.should be_success
+    stdout.should == <<-SSH_CONFIG.chomp
+Host bar.foo.com
+Hostname bar.foo.com
+Port 5678
+User pivo
+IdentityFile ~/.ssh/id_rsa
+
+Host bazqux
+Hostname 2.3.4.5
+
+Host 2.3.4.5
+Hostname 2.3.4.5
+    SSH_CONFIG
+  end
+end
+

data/spec/acceptance/help_spec.rb

@@ -0,0 +1,74 @@
+require 'acceptance_spec_helper'
+
+feature "Global server alias" do
+  background { config_exists <<-CONFIG }
+    project :foo do
+      environment :bar do
+        server do
+          host "1.2.3.4"
+          port 5678
+          user "pivo"
+          location "/var/apps/vodka"
+        end
+      end
+    end
+
+    project :baz do
+      environment :qux do
+        server :bart do
+          host "2.3.4.5"
+          default_command :console
+          command :console do
+            execute "rails c"
+          end
+          command :killall do
+            execute "killall humans"
+            desc "Kill ALL humans"
+          end
+        end
+      end
+    end
+  CONFIG
+
+  scenario "Unique server alias" do
+    run "taketo --view"
+    exit_status.should be_success
+    stdout.should == <<-CONFIG_OUTLINE.chomp
+
+Project: foo
+  Environment: bar
+    Server: default
+      Host: 1.2.3.4
+      Port: 5678
+      User: pivo
+      Default location: /var/apps/vodka
+      Default command: bash
+      Environment: RAILS_ENV=bar
+
+Project: baz
+  Environment: qux
+    Server: bart
+      Host: 2.3.4.5
+      Default command: rails c
+      Environment: RAILS_ENV=qux
+      Commands:
+        console
+        killall - Kill ALL humans
+    CONFIG_OUTLINE
+  end
+
+  scenario "View particular server config" do
+    run "taketo foo:bar:default --view"
+    exit_status.should be_success
+    stdout.should == <<-CONFIG_OUTLINE.chomp
+Server: default
+  Host: 1.2.3.4
+  Port: 5678
+  User: pivo
+  Default location: /var/apps/vodka
+  Default command: bash
+  Environment: RAILS_ENV=bar
+    CONFIG_OUTLINE
+  end
+end
+

data/spec/acceptance/location_spec.rb

@@ -0,0 +1,21 @@
+require 'acceptance_spec_helper'
+
+feature "Location on remote host" do
+  scenario "Override default location for server through --directory flag" do
+    create_config <<-CONFIG
+      project :slots do
+        environment :staging do
+          server do
+            location '/var/foo'
+            host "1.2.3.4"
+          end
+        end
+      end
+    CONFIG
+
+    run "taketo slots:staging --dry-run --directory /var/www"
+    exit_status.should be_success
+    stdout.should == %q{ssh -t 1.2.3.4 "cd /var/www; RAILS_ENV=staging bash"}
+  end
+end
+

data/spec/acceptance_spec_helper.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'open4'
+
+ENV['PATH'] = "#{File.expand_path('../../bin', __FILE__)}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+ENV['RUBYOPT'] = '-Ilib'
+
+module AcceptanceSpecDSL
+  module Feature
+    def self.extended(base)
+      base.instance_eval do
+        alias :feature :describe
+      end
+    end
+  end
+
+  def self.included(base)
+    base.instance_eval do
+      alias :background :before
+      alias :scenario :it
+      alias :xscenario :xit
+      alias :given :let
+      alias :given! :let!
+    end
+  end
+end
+
+module TaketoAcceptanceSpec
+  DEFAULT_TEST_CONFIG_PATH = "/tmp/taketo_test_cfg.rb".freeze
+
+  attr_reader :stdout, :stderr, :exit_status
+
+  def create_config(config)
+    File.open(DEFAULT_TEST_CONFIG_PATH, "w") do |f|
+      f.write(config)
+    end
+  end
+  alias :config_exists :create_config
+
+  def remove_config
+    if File.exist?(DEFAULT_TEST_CONFIG_PATH)
+      FileUtils.rm(DEFAULT_TEST_CONFIG_PATH)
+    end
+  end
+
+  def run(command)
+    pid, stdin, stdout, stderr = Open4.popen4("#{command} --config #{DEFAULT_TEST_CONFIG_PATH} --debug")
+    @stdout = stdout.read.chomp.freeze
+    @stderr = stderr.read.chomp.freeze
+    _, @exit_status = Process.waitpid2(pid)
+  ensure
+    stdin.close if stdin
+    stdout.close if stdout
+    stderr.close if stderr
+  end
+
+  RSpec.configure do |config|
+    config.after(:each) do
+      @stdout = nil
+      @stderr = nil
+      @exit_status = nil
+      remove_config
+    end
+  end
+end
+
+extend AcceptanceSpecDSL::Feature
+
+RSpec.configure do |c|
+  c.include AcceptanceSpecDSL
+  c.include TaketoAcceptanceSpec
+end