mina-traackr 0.3.0

data/lib/mina/ssh_helpers.rb

@@ -0,0 +1,122 @@
+# # Helpers: SSH helpers
+# You don't need to invoke these helpers, they're already invoked automatically.
+
+module Mina
+  module SshHelpers
+
+    # ### ssh
+    # Executes a command via SSH.
+    #
+    # Returns nothing usually, but if `{ return: true }` is given, returns the
+    # STDOUT output of the SSH session.
+    #
+    # `options` is a hash of options:
+    #
+    #  - `:pretty` - Prettify the output if true.
+    #  - `:return`  - If set to true, returns the output.
+    #
+    # Example
+    #
+    #     ssh("ls", return: true)
+
+    def ssh(cmd, options={})
+      require 'shellwords'
+
+      cmd = cmd.join("\n")  if cmd.is_a?(Array)
+      script = Shellwords.escape(cmd)
+
+      if options[:return] == true
+        `#{ssh_command} -- #{script}`
+
+      elsif simulate_mode?
+        Ssh.simulate(cmd, ssh_command)
+
+      else
+        result = Ssh.invoke(script, self)
+        Ssh.ensure_successful result, self
+      end
+    end
+
+    # ### ssh_command
+    # Returns the SSH command to be executed.
+    #
+    #     set :domain, 'foo.com'
+    #     set :user, 'diggity'
+    #
+    #     puts ssh_command
+    #     #=> 'ssh diggity@foo.com'
+
+    def ssh_command
+      args = domain!.dup
+      args = "#{user}@#{args}" if user?
+      args << " -i #{identity_file}" if identity_file?
+      args << " -p #{port}" if port?
+      args << " -A" if forward_agent?
+      args << " #{ssh_options}"  if ssh_options?
+      args << " -t"
+      "ssh #{args}"
+    end
+
+    # ## Private methods
+    # `ssh` delegates to these.
+
+    module Ssh
+
+      extend self
+
+      # ### Ssh.simulate
+      # __Internal:__ Prints SSH command. Called by `ssh`.
+
+      def simulate(cmd, ssh_command)
+        str = "Executing the following via '#{ssh_command}':"
+        puts "#!/usr/bin/env bash"
+        puts "# #{str}"
+        puts "#"
+
+        puts cmd
+
+        0
+      end
+
+      # ### Ssh.invoke
+      # __Internal:__ Initiates an SSH session with script `script` with given
+      # `term_mode`.  Called by `ssh`.
+
+      def invoke(script, this)
+        term_mode = :"#{this.settings.term_mode}"
+        code = "#{this.ssh_command} -- #{script}"
+
+        # Certain environments can't do :pretty mode.
+        term_mode = :exec  if term_mode == :pretty && !pretty_supported?
+
+        case term_mode
+        when :pretty
+          this.pretty_system(code)
+        when :exec
+          exec code
+        else
+          system code
+          $?.to_i
+        end
+      end
+
+      def pretty_supported?
+        # open4 is not supported under Windows.
+        # https://github.com/nadarei/mina/issues/58
+        require 'rbconfig'
+        ! (RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
+      end
+
+      # ### Ssh.ensure_successful
+      # __Internal:__ Halts the execution if the given result code is not
+      # successful (non-zero).
+
+      def ensure_successful(result, this)
+        this.die result if result.is_a?(Fixnum) && result > 0
+        result
+      end
+
+    end
+
+  end
+end

data/lib/mina/tools.rb

@@ -0,0 +1,20 @@
+module Mina
+  module Tools
+    if IO.respond_to?(:popen4)
+      def self.popen4(*cmd, &blk)
+        IO.popen4 *cmd, &blk
+        $?
+      end
+    else
+      def self.popen4(*cmd, &blk)
+        require 'open4'
+        Open4.popen4 *cmd, &blk
+      end
+    end
+
+    def self.pfork4(*cmd, &blk)
+      require 'open4'
+      Open4.pfork4 *cmd, &blk
+    end
+  end
+end

data/lib/mina/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  def self.version
+    "0.3.0"
+  end
+end

data/lib/mina/whenever.rb

@@ -0,0 +1,27 @@
+# # Modules: Whenever
+# Adds settings and tasks for managing projects with [whenever].
+# [whenever]: http://rubygems.org/gems/whenever
+
+namespace :whenever do
+  desc "Clear crontab"
+  task :clear do
+    queue %{
+      echo "-----> Clear crontab for #{domain}_#{rails_env}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --clear-crontab #{domain}_#{rails_env} --set 'environment=#{rails_env}&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+  desc "Update crontab"
+  task :update do
+    queue %{
+      echo "-----> Update crontab for #{domain}_#{rails_env}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --update-crontab #{domain}_#{rails_env} --set 'environment=#{rails_env}&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+  desc "Write crontab"
+  task :write do
+    queue %{
+      echo "-----> Update crontab for #{domain}_#{rails_env}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --write-crontab #{domain}_#{rails_env} --set 'environment=#{rails_env}&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+end

data/manual/index.md

@@ -0,0 +1,15 @@
+# Welcome to Mina
+
+Really fast deployer and server automation tool.
+
+Mina works really fast because it's a deploy Bash script generator. It
+generates an entire procedure as a Bash script and runs it remotely in the
+server.
+
+Compare this to the likes of Vlad or Capistrano, where each command
+is ran separately on their own SSH sessions. Mina only creates *one* SSH
+session per deploy, minimizing the SSH connection overhead.
+
+    $ gem install mina
+    $ mina
+

data/manual/modules.md

@@ -0,0 +1,2 @@
+Modules
+=======

data/mina.gemspec

@@ -0,0 +1,17 @@
+require './lib/mina/version'
+
+Gem::Specification.new do |s|
+  s.name = "mina-traackr"
+  s.version = Mina.version
+  s.summary = %{Really fast deployer and server automation tool.}
+  s.description = %Q{Really fast deployer and server automation tool.}
+  s.authors = ["Rico Sta. Cruz", "Michael Galero"]
+  s.email = ["rico@nadarei.co", "mikong@nadarei.co"]
+  s.homepage = "http://github.com/nadarei/mina"
+  s.files = `git ls-files`.strip.split("\n")
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
+
+  s.add_dependency "rake"
+  s.add_dependency "open4"
+  s.add_development_dependency "rspec"
+end

data/spec/command_helper.rb

@@ -0,0 +1,52 @@
+# Invokes the main 'mina' command.
+def run_command(*args)
+  out = ''
+  err = ''
+  @result = nil
+
+  if ENV['rake']
+    rake_version = "~> #{ENV['rake'] || '0.9'}.0"
+    script  = %[require 'rubygems' unless Object.const_defined?(:Gem);]
+    script += %[gem 'rake', '#{rake_version}';]
+    script += %[load '#{root('bin/mina')}']
+    cmd = ['ruby', '-e', "#{script}", "--", *args]
+  else
+    cmd = [root('bin/mina'), *args]
+  end
+
+  status =
+    Mina::Tools.popen4(*cmd) do |pid, i, o, e|
+      out = o.read
+      err = e.read
+    end
+
+  @result = status.exitstatus
+
+  @out = out
+  @err = err
+
+  @result
+end
+
+# Invokes the main 'mina' command and ensures the exit status is success.
+def mina(*args)
+  run_command *args
+  if exitstatus != 0 && ENV['verbose']
+    puts stdout
+    puts stderr
+  end
+
+  exitstatus.should == 0
+end
+
+def stdout
+  @out
+end
+
+def stderr
+  @err
+end
+
+def exitstatus
+  @result
+end

data/spec/commands/cleanup_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina deploy:cleanup' command" do
+  before :each do
+    Dir.chdir root('test_env')
+  end
+
+  it "should cleanup old deployments" do
+    3.times { mina 'deploy' }
+
+    mina 'deploy:cleanup'
+
+    Dir["deploy/releases/*"].length.should == 2
+  end
+end

data/spec/commands/command_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina' command in a project" do
+  before :each do
+    Dir.chdir root('test_env')
+  end
+
+  it "should think it's 'mina', not 'rake' (1)" do
+    run_command 'pinkledills'
+    exitstatus.should_not == 0
+    stderr.should include 'mina aborted'
+  end
+
+  it "should think it's 'mina', not 'rake' (1)" do
+    mina '-T'
+    stdout.should include 'mina help'
+    stdout.should include 'mina git:clone'
+  end
+
+  it 'with --version should print the version' do
+    mina '--version'
+    stdout.should include Mina.version
+  end
+
+  it 'with -V should print the version' do
+    mina '-V'
+    stdout.should include Mina.version
+  end
+
+  describe 'without arguments' do
+    before :each do
+      mina
+    end
+
+    it 'should print standard help tasks' do
+      mina
+      stdout.should include 'mina help'
+      stdout.should include 'mina init'
+      stdout.should include 'mina tasks'
+    end
+
+    it 'should print project-specific tasks' do
+      mina
+      stdout.should include 'mina deploy'
+      stdout.should include 'mina restart'
+      stdout.should include 'mina setup'
+    end
+
+    it "should be the same as running 'help'" do
+      previous_out = stdout
+
+      mina 'help'
+      stdout.should == previous_out
+    end
+  end
+
+  it "with 'mina -f' on a non-existing file should fail" do
+    run_command '-f', 'foobar'
+    stderr.should include 'mina aborted'
+    stderr.should include 'No Rakefile found'
+  end
+
+  it "with 'mina tasks' should print tasks" do
+    mina 'tasks'
+
+    stdout.should include('bundle:install')
+    stdout.should include('Install gem dependencies using Bundler')
+    stdout.should include('passenger:restart')
+  end
+end

data/spec/commands/custom_config_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina' command in a project without a deploy.rb" do
+  before :each do
+    Dir.chdir root('spec/fixtures/custom_file_env')
+    FileUtils.rm_rf 'deploy'
+  end
+
+  it 'should fail' do
+    run_command 'deploy', '--simulate'
+    exitstatus.should be > 0
+  end
+
+  it 'should pass if you provide a new rakefile' do
+    mina 'deploy', '--simulate', '-f', 'custom_deploy.rb'
+    stdout.should include 'Creating a temporary build path'
+  end
+end
+

data/spec/commands/deploy_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina' command in a project" do
+  before :each do
+    Dir.chdir root('test_env')
+  end
+
+  describe "to do a simulated deploy" do
+    before :each do
+      mina 'deploy', 'simulate=1'
+    end
+
+    it "should take care of the lockfile" do
+      stdout.should =~ /ERROR: another deployment is ongoing/
+      stdout.should =~ /touch ".*deploy\.lock"/
+      stdout.should =~ /rm -f ".*deploy\.lock"/
+    end
+
+    it "should honor releases_path" do
+      stdout.should include "releases/"
+    end
+
+    it "should symlink the current_path" do
+      stdout.should =~ /ln .*current/
+    end
+
+    it "should include deploy directives" do
+      stdout.should include "bundle exec rake db:migrate"
+    end
+
+    it "should include 'to :build' directives" do
+      stdout.should include "touch build.txt"
+    end
+
+    it "should include 'to :launch' directives" do
+      stdout.should include "touch tmp/restart.txt"
+    end
+  end
+end

data/spec/commands/outside_project_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina' command outside a project" do
+  before :each do
+    Dir.chdir root
+  end
+
+  describe "without arguments" do
+    before :each do
+      mina
+    end
+
+    it 'should print standard help tasks' do
+      stdout.should include('mina help')
+      stdout.should include('mina init')
+      stdout.should include('mina tasks')
+    end
+
+    it "should not print project-specific tasks" do
+      stdout.should_not include('mina deploy')
+      stdout.should_not include('mina restart')
+      stdout.should_not include('mina setup')
+    end
+
+    %w[-h --help].each do |arg|
+      it "should have the same output as 'mina #{arg}'" do
+        @previous_output = stdout
+        mina arg
+        stdout.should == @previous_output
+      end
+    end
+  end
+end
+