mina 0.3.8 → 1.0.0.beta1

data/spec/lib/mina/configuration_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Mina::Configuration do
+  let(:config) { Class.new(Mina::Configuration).instance }
+  let(:key) { config.fetch(:key, :default) }
+
+  describe '#set' do
+    it 'sets by value' do
+      config.set(:key, :value)
+      expect(key).to eq :value
+    end
+
+    it 'sets by block' do
+      config.set(:key) { :value }
+      expect(key).to eq :value
+    end
+  end
+
+  describe '#fetch' do
+    it 'returns the default value if key not set' do
+      expect(key).to eq :default
+    end
+
+    it 'returns ENV value if set' do
+      ENV['key'] = 'env'
+      expect(key).to eq 'env'
+      ENV['key'] = nil
+    end
+  end
+
+  describe '#set?' do
+    it 'returns true if key is set' do
+      config.set(:key, :value)
+      expect(config.set?(:key)).to be true
+    end
+
+    it 'returns false if key is not set' do
+      expect(config.set?(:key)).to be false
+    end
+  end
+
+  describe '#ensure!' do
+    it 'does not raise error if key is set' do
+      config.set(:key, :value)
+      expect { config.ensure!(:key) }.to_not raise_error
+    end
+
+    it 'raises an error if key is not set' do
+      expect { config.ensure!(:key) }.to raise_error(StandardError)
+    end
+  end
+end

data/spec/lib/mina/helpers/internal_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Mina::Helpers::Internal do
+  class DummyInternalHelper
+    include Mina::DSL
+    include Mina::Helpers::Internal
+  end
+
+  let(:helper) { DummyInternalHelper.new }
+
+  describe '#deploy_script' do
+    before { Mina::Configuration.instance.set(:deploy_script, 'data/deploy.sh.erb') }
+
+    it 'returns whole script' do
+      expect(helper.deploy_script {}).to_not be_empty
+    end
+  end
+
+  describe '#erb' do
+    it 'returns whole script' do
+      expect(helper.erb('data/deploy.sh.erb')).to_not be_empty
+    end
+  end
+
+  describe '#echo_cmd' do
+    context 'when not verbose' do
+      it 'reuturns unedited code' do
+        expect(helper.echo_cmd('ls -al')).to eq('ls -al')
+      end
+    end
+
+    context 'when verbose' do
+      before { Mina::Configuration.instance.set(:verbose, true) }
+
+      it 'modifies code' do
+        expect(helper.echo_cmd('ls -al')).to eq("echo \\$\\ ls\\ -al &&\nls -al")
+      end
+
+      it 'does not modify code if ignore_verbose is true' do
+        expect(helper.echo_cmd('ls -al', ignore_verbose: true)).to eq('ls -al')
+      end
+    end
+  end
+
+  describe '#indent' do
+    it 'indents code' do
+      expect(helper.indent(4, 'ls -al')).to eq('    ls -al')
+    end
+  end
+end

data/spec/lib/mina/helpers/output_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Mina::Helpers::Output do
+  class DummyOutputHelper
+    include Mina::Helpers::Output
+  end
+
+  let(:helper) { DummyOutputHelper.new }
+
+  describe '#print_line' do
+    it 'prints normally' do
+      out, _err = capture_io do
+        helper.print_line('ls -al')
+      end
+      expect(out).to eq("       ls -al\n")
+    end
+
+    it 'prints comment' do
+      out, _err = capture_io do
+        helper.print_line('-> ls -al')
+      end
+      expect(out).to eq("\e[32m----->\e[0m ls -al\n")
+    end
+
+    it 'prints error' do
+      out, _err = capture_io do
+        helper.print_line('! ls -al')
+      end
+      expect(out).to eq(" \e[33m!\e[0m     \e[31mls -al\e[0m\n")
+    end
+
+    it 'prints command' do
+      out, _err = capture_io do
+        helper.print_line('$ ls -al')
+      end
+      expect(out).to eq("       \e[36m$\e[0m \e[36mls -al\e[0m\n")
+    end
+  end
+
+  describe '#print_stderr' do
+    it 'prints stderr' do
+      out, _err = capture_io do
+        helper.print_stderr('ls -al')
+      end
+      expect(out).to eq("       \e[31mls -al\e[0m\n")
+    end
+  end
+end

data/spec/lib/mina/runner_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Mina::Runner do
+  let(:instance) { Mina::Configuration.instance }
+
+  describe '#initialize' do
+    it 'raises an error if execution mode is not set' do
+      instance.remove(:execution_mode)
+      expect { Mina::Runner.new(nil, nil) }.to raise_error('You must specify execution mode')
+    end
+
+    it 'raises an error when run on windows and pretty print' do
+      instance.set(:execution_mode, :pretty)
+      allow(Gem::Platform.local).to receive(:os).and_return(:windows)
+      expect { Mina::Runner.new(nil, nil) }.to raise_error('Unsuported execution mode (pretty on windows)')
+    end
+
+    it 'sets execution mode to printer if simulate is true' do
+      instance.set(:execution_mode, :pretty)
+      instance.set(:simulate, :true)
+      expect(Mina::Runner.new(nil, nil).execution_mode).to eq(:printer)
+      instance.remove(:simulate)
+    end
+  end
+
+  describe '#run' do
+    it 'runs the commands on a backend' do
+      instance.set(:execution_mode, :printer)
+      runner = Mina::Runner.new(['ls -al'], :local)
+      out, _err = capture_io do
+        runner.run
+      end
+      expect(out).to eq("\\[\\\"ls\\ -al\\\"\\]\n")
+    end
+  end
+end

data/spec/lib/mina_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Mina
+  describe Application do
+    let(:app) { Application.new }
+  end
+end

data/spec/spec_helper.rb

@@ -1,28 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'mina'
-require 'rake'
+require 'rspec'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  config.order = 'random'
-  config.seed = '12345'
-end
+  config.include RunHelper
 
-class RakeScope
-  include Rake::DSL  if Rake.const_defined?(:DSL)
-  include Mina::Helpers
-  include Mina::SshHelpers
-  include Mina::LocalHelpers
-end
+  config.raise_errors_for_deprecations!
+  config.order = 'random'
 
-def rake(&blk)
-  if block_given?
-    @scope ||= RakeScope.new
-    @scope.instance_eval &blk
+  config.after(:each) do
+    Mina::Configuration.instance.reset!
   end
-
-  @scope
 end
-
-def root(*a)
-  File.join File.expand_path('../../', __FILE__), *a
-end
-

data/spec/support/run_helper.rb

@@ -0,0 +1,36 @@
+module RunHelper
+  def flags(*sets)
+    sets.each do |set|
+      ARGV.clear
+      @exit = catch(:system_exit) { command_line(*set) }
+    end
+    yield(subject.options) if block_given?
+  end
+
+  def command_line(*options)
+    options.each { |opt| ARGV << opt }
+    subject.define_singleton_method(:exit) do |*_args|
+      throw(:system_exit, :exit)
+    end
+    subject.run
+    subject.options
+  end
+
+  def capture_io
+    require 'stringio'
+
+    orig_stdout = $stdout
+    orig_stderr = $stderr
+    captured_stdout = StringIO.new
+    captured_stderr = StringIO.new
+    $stdout = captured_stdout
+    $stderr = captured_stderr
+
+    yield
+
+    return captured_stdout.string, captured_stderr.string
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+end

data/tasks/mina/bundler.rb

@@ -0,0 +1,15 @@
+require 'mina/default'
+
+set :bundle_bin, 'bundle'
+set :bundle_path, 'vendor/bundle'
+set :bundle_withouts, 'development:test'
+set :bundle_options, -> { "--without #{fetch(:bundle_withouts)} --path '#{fetch(:bundle_path)}' --deployment" }
+set :shared_dirs, fetch(:shared_dirs, []).push(fetch(:bundle_path))
+
+namespace :bundle do
+  desc 'Install gem dependencies using Bundler.'
+  task install: :environment do
+    comment 'Installing gem dependencies using Bundler'
+    command "#{fetch(:bundle_bin)} install #{fetch(:bundle_options)}"
+  end
+end

data/tasks/mina/chruby.rb

@@ -0,0 +1,19 @@
+set :chruby_path, '/etc/profile.d/chruby.sh'
+
+task :chruby, :env do |_, args|
+  unless args[:env]
+    print_error "Task 'chruby' needs a Ruby version as an argument."
+    print_error "Example: invoke :'chruby[ruby-1.9.3-p392]'"
+    die
+  end
+
+  comment "chruby to version: '#{args[:env]}'"
+  command %(
+    if [[ ! -s "#{fetch(:chruby_path)}" ]]; then
+      echo "! chruby.sh init file not found"
+      exit 1
+    fi
+  )
+  command "source #{fetch(:chruby_path)}"
+  command "chruby '#{args[:env]}' || exit 1"
+end

data/tasks/mina/default.rb

@@ -0,0 +1,36 @@
+task :environment do
+end
+
+task run_commands: :environment do
+  commands.run(:remote) unless commands.queue.empty?
+end
+
+task debug_configuration_variables: :environment do
+  if fetch(:debug_configuration_variables)
+    puts
+    puts '------- Printing current config variables -------'
+    configuration.variables.each do |key, value|
+      puts "#{key.inspect} => #{value.inspect}"
+    end
+  end
+end
+
+desc 'Runs a command in the server.'
+task :run, [:command] => [:environment] do |_, args|
+  ensure!(:deploy_to)
+  command = args[:command]
+
+  unless command
+    puts "You need to provide a command. Try: mina 'run[ls -la]'"
+    exit 1
+  end
+
+  in_path fetch(:deploy_to) do
+    command command
+  end
+end
+
+desc 'Open an ssh session to the server and cd to deploy_to folder'
+task ssh: :environment do
+  exec ssh_command + " 'cd #{deploy_to} && exec \$SHELL'"
+end

data/tasks/mina/deploy.rb

@@ -0,0 +1,85 @@
+require 'mina/default'
+
+set :releases_path, -> { "#{fetch(:deploy_to)}/releases" }
+set :shared_path, -> { "#{fetch(:deploy_to)}/shared" }
+set :current_path, -> { "#{fetch(:deploy_to)}/current" }
+set :lock_file, 'deploy.lock'
+set :deploy_script, 'data/deploy.sh.erb'
+set :keep_releases, 5
+set :execution_mode, :pretty
+
+namespace :deploy do
+  desc 'Forces a deploy unlock.'
+  task force_unlock: :environment do
+    comment 'Unlocking'
+    command "rm -f '#{fetch(:deploy_to)}/#{fetch(:lock_file)}'"
+  end
+
+  desc 'Links paths set in :shared_dirs and :shared_files.'
+  task link_shared_paths: :environment do
+    comment 'Symlinking shared paths'
+
+    fetch(:shared_dirs, []).each do |linked_dir|
+      command %(mkdir -p #{File.dirname("./#{linked_dir}")})
+      command "rm -rf './#{linked_dir}'"
+      command "ln -s '#{fetch(:shared_path)}/#{linked_dir}' './#{linked_dir}'"
+    end
+
+    fetch(:shared_files, []).each do |linked_path|
+      command "ln -s '#{fetch(:shared_path)}/#{linked_path}' './#{linked_path}'"
+    end
+  end
+
+  desc 'Clean up old releases.'
+  task cleanup: :environment do
+    ensure!(:keep_releases)
+    ensure!(:deploy_to)
+
+    comment "Cleaning up old releases (keeping #{fetch(:keep_releases)})"
+    in_path "#{fetch(:releases_path)}" do
+      command 'count=`ls -1 | sort -rn | wc -l`'
+      command "remove=$((count > #{fetch(:keep_releases)} ? $count - #{fetch(:keep_releases)} : 0))"
+      command 'ls -1 | sort -rn | tail -n $remove | xargs rm -rf {}'
+    end
+  end
+end
+
+# TODO: Test this
+#   desc 'Rollbacks the latest release'
+#   task rollback: :environment do
+#     comment "Rolling back to previous release for instance: #{fetch(:domain)}"
+#
+#     # Delete existing sym link and create a new symlink pointing to the previous release
+#     comment 'Creating new symlink from the previous release: '
+#     command "ls -Art '#{fetch(:releases_path)}' | sort | tail -n 2 | head -n 1"
+#     command "ls -Art '#{fetch(:releases_path)}' | sort | tail -n 2 | head -n 1 | xargs -I active ln -nfs '#{fetch(:releases_path)}/active' '#{fetch(:current_path)}'"
+#
+#     # Remove latest release folder (current release)
+#     comment 'Deleting current release: '
+#     command "ls -Art '#{fetch(:releases_path)}' | sort | tail -n 1"
+#     command "ls -Art '#{fetch(:releases_path)}' | sort | tail -n 1 | xargs -I active rm -rf '#{fetch(:releases_path)}/active'"
+#   end
+# end
+
+desc 'Sets up a site.'
+task setup: :environment do
+  ensure!(:deploy_to)
+
+  comment "Setting up #{fetch(:deploy_to)}"
+  command "mkdir -p '#{fetch(:deploy_to)}'"
+  command "chown -R `whoami` '#{fetch(:deploy_to)}'"
+  command "chmod g+rx,u+rwx '#{fetch(:deploy_to)}'"
+  command "mkdir -p '#{fetch(:releases_path)}'"
+  command "chmod g+rx,u+rwx '#{fetch(:releases_path)}'"
+  command "mkdir -p '#{fetch(:shared_path)}'"
+  command "chmod g+rx,u+rwx '#{fetch(:shared_path)}'"
+
+  in_path "#{fetch(:shared_path)}" do
+    fetch(:shared_dirs, []).each do |linked_dir|
+      command "mkdir -p '#{linked_dir}'"
+      command "chmod g+rx,u+rwx '#{linked_dir}'"
+    end
+  end
+
+  command "tree '#{fetch(:deploy_to)}' || ls -al '#{fetch(:deploy_to)}'"
+end

data/tasks/mina/git.rb

@@ -0,0 +1,36 @@
+require 'mina/default'
+
+set :branch, 'master'
+
+namespace :git do
+  desc 'Clones the Git repository to the release path.'
+  task clone: :environment do
+    ensure!(:repository)
+    ensure!(:deploy_to)
+    if set?(:commit)
+      comment "Using git commit '#{fetch(:commit)}'"
+      command "git clone '#{fetch(:repository)}' . --recursive"
+      command "git checkout -b current_release '#{fetch(:commit)}' --force"
+    else
+      command %(if [ ! -d "#{fetch(:deploy_to)}/scm/objects" ]; then
+          echo "-----> Cloning the Git repository"
+          #{echo_cmd %[git clone "#{fetch(:repository)}" "#{fetch(:deploy_to)}/scm" --bare]}
+        else
+          echo "-----> Fetching new git commits"
+          #{echo_cmd %[(cd "#{fetch(:deploy_to)}/scm" && git fetch "#{fetch(:repository)}" "#{fetch(:branch)}:#{fetch(:branch)}" --force)]}
+        fi &&
+        echo "-----> Using git branch '#{fetch(:branch)}'" &&
+        #{echo_cmd %[git clone "#{fetch(:deploy_to)}/scm" . --recursive --branch "#{fetch(:branch)}"]}), quiet: true
+    end
+
+    comment 'Using this git commit'
+    command 'git rev-parse HEAD > .mina_git_revision'
+    command "git --no-pager log --format='%aN (%h):%n> %s' -n 1"
+    command 'rm -rf .git'
+  end
+
+  task revision: :environment do
+    ensure!(:deploy_to)
+    command "cat #{fetch(:current_path)}/.mina_git_revision"
+  end
+end