mina-traackr 0.3.0

data/spec/commands/real_deploy_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'command_helper'
+require 'fileutils'
+require 'tmpdir'
+
+describe "Invoking the 'mina' command in a project", :ssh => true do
+  before :each do
+    @path = Dir.mktmpdir
+    Dir.chdir @path
+
+    FileUtils.mkdir_p './config'
+    FileUtils.cp root('test_env/config/deploy.rb'), './config/deploy.rb'
+    FileUtils.rm_rf './deploy'
+    FileUtils.mkdir_p './deploy'
+  end
+
+  # after :each do
+  #   FileUtils.rm_rf @path
+  # end
+
+  it 'should set up and deploy fine' do
+    print "[setup]" if ENV['verbose']
+    mina 'setup', '--verbose'
+    File.directory?('deploy').should be_true
+    File.directory?('deploy/releases').should be_true
+    File.directory?('deploy/shared').should be_true
+    File.exists?('deploy/last_version').should be_false
+    File.exists?('deploy/deploy.lock').should be_false
+
+    print "[deploy 1]" if ENV['verbose']
+    mina 'deploy', '--verbose'
+    stdout.should include "-----> Creating a temporary build path"
+    stdout.should include "rm -rf .git"
+    stdout.should include "mkdir -p"
+    File.exists?('deploy/last_version').should be_true
+    File.exists?('deploy/deploy.lock').should be_false
+    File.directory?('deploy/releases').should be_true
+    File.directory?('deploy/releases/1').should be_true
+    File.exists?('deploy/releases/1/README.md').should be_true
+    File.directory?('deploy/releases/2').should be_false
+    File.exists?('deploy/current').should be_true
+    File.read('deploy/last_version').strip.should == '1'
+    File.exists?('deploy/current/build.txt').should be_true
+    File.exists?('deploy/current/tmp/restart.txt').should be_true
+
+    # And again, to test out sequential versions and stuff
+    print "[deploy 2]" if ENV['verbose']
+    mina 'deploy'
+    stdout.should_not include "rm -rf .git"
+    stdout.should_not include "mkdir -p"
+    File.directory?('deploy/releases/2').should be_true
+    File.read('deploy/last_version').strip.should == '2'
+  end
+end

data/spec/commands/ssh_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'command_helper'
+
+describe "Invoking the 'mina' command in a project" do
+
+  it "should build ssh command even with frozen String as a domain" do
+    ENV['simulate'] = 'true'
+    rake {
+      set :domain, 'localhost'.freeze
+      ssh("ls")
+    }
+  end
+
+end

data/spec/commands/verbose_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'command_helper'
+require 'shellwords'
+
+describe "Invoking the 'mina' command in a project" do
+  before :each do
+    Dir.chdir root('test_env')
+  end
+
+  it 'should echo commands in verbose mode' do
+    mina 'deploy', '--verbose', '--simulate'
+
+    stdout.should include %[echo #{Shellwords.escape('$ git')}]
+  end
+
+  it 'should not echo commands when not in verbose mode' do
+    mina 'deploy', '--simulate'
+
+    stdout.should_not include %[echo #{Shellwords.escape('$ git')}]
+  end
+end

data/spec/dsl/invoke_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Mina' do
+  it '#invoke should work' do
+
+    rake {
+      task :clone do
+        queue 'git clone'
+      end
+    }
+
+    2.times {
+      rake { invoke :clone }
+    }
+
+    rake.commands.should == ['git clone']
+  end
+
+  it '#invoke should work with :reenable option' do
+
+    rake {
+      task :pull do
+        queue 'git pull'
+      end
+    }
+
+    2.times {
+      rake { invoke :pull, :reenable => true }
+    }
+
+    rake.commands.should == ['git pull', 'git pull']
+  end
+end

data/spec/dsl/queue_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'Mina' do
+  it '#invoke should work' do
+    rake {
+      task :hello do
+        @hello = 'world'
+      end
+      invoke :hello
+    }
+    rake.instance_variable_get(:@hello).should == 'world'
+  end
+
+  it '#queue should work' do
+    rake {
+      queue 'sudo service nginx restart'
+    }
+
+    rake.commands.should == ['sudo service nginx restart']
+  end
+
+  it '#queue should work with multiple commands' do
+    rake {
+      queue 'echo Restarting'
+      queue 'sudo service nginx restart'
+    }
+
+    rake.commands.should == ['echo Restarting', 'sudo service nginx restart']
+  end
+
+  it '#queue should work inside tasks' do
+    rake {
+      task :restart do
+        queue 'echo Restarting'
+        invoke :'passenger:restart'
+      end
+
+      namespace :passenger do
+        task :restart do
+          queue 'touch tmp/restart.txt'
+        end
+      end
+    }
+
+    rake { invoke :restart }
+
+    rake.commands.should == ['echo Restarting', 'touch tmp/restart.txt']
+  end
+end

data/spec/dsl/settings_in_rake_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'Settings in rake tasks' do
+  it '#set should work' do
+    rake { set :domain, 'localhost' }
+
+    rake.domain.should == 'localhost'
+    rake.settings.domain.should == 'localhost'
+  end
+
+  it '#settings ||= should work' do
+    rake {
+      set :version, '2'
+      settings.version ||= '3'
+    }
+
+    rake.settings.version.should == '2'
+    rake.version.should == '2'
+  end
+
+  it '#settings with lambdas should work' do
+    rake {
+      set :version, '42'
+      set :path, lambda { "/var/www/#{version}" }
+    }
+
+    rake.path.should == "/var/www/42"
+    rake.path?.should be_true
+  end
+
+  it '#settings with a bang should work' do
+    expect {
+      rake {
+        set :path, lambda { "/var/www/#{version!}" }
+      }
+      rake.path
+    }.to raise_error(Mina::Error, /version/)
+  end
+end

data/spec/dsl/settings_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe 'Settings' do
+  describe 'instances' do
+    before :each do
+      @settings = Mina::Settings.new
+    end
+
+    it 'setting/getting should work' do
+      @settings.domain = '192.168.1.1'
+      @settings.domain.should == '192.168.1.1'
+    end
+
+    it 'question mark should work' do
+      @settings.deploy_to = '/var/www/there'
+      @settings.deploy_to?.should be_true
+      @settings.foobar?.should be_false
+    end
+
+    it 'question mark should work with nils' do
+      @settings.deploy_to = nil
+      @settings.deploy_to?.should be_true
+      @settings.foobar?.should be_false
+    end
+
+    it '||= should work (1)' do
+      @settings.x = 2
+      @settings.x ||= 3
+      @settings.x.should == 2
+    end
+
+    it '||= should work (2)' do
+      @settings.x ||= 3
+      @settings.x.should == 3
+    end
+
+    it 'lambdas should work' do
+      @settings.path = lambda { "/var/www/#{@settings.version}" }
+      @settings.version = '3'
+
+      @settings.path?.should be_true
+      @settings.path.should == "/var/www/3"
+    end
+
+    it 'bangs should check for settings' do
+      expect { @settings.non_existent_setting! }.to raise_error(Mina::Error, /non_existent_setting/)
+    end
+
+    it 'bangs should return settings' do
+      @settings.version = 4
+      @settings.version!.should == 4
+    end
+  end
+end
+

data/spec/dsl/to_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Mina' do
+  it '#to should work' do
+    rake {
+      task :deploy do
+        queue 'git clone'
+
+        to :restart do
+          queue 'touch tmp/restart.txt'
+        end
+      end
+    }
+
+    rake { invoke :deploy }
+
+    rake.commands.should == ['git clone']
+    rake.commands(:restart).should == ['touch tmp/restart.txt']
+  end
+end

data/spec/fixtures/custom_file_env/custom_deploy.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+FileUtils.mkdir_p "#{Dir.pwd}/deploy"
+
+require 'mina/git'
+
+set :domain, 'localhost'
+set :deploy_to, "#{Dir.pwd}/deploy"
+set :repository, "#{Dir.pwd}"
+
+desc "Deploys."
+task :deploy do
+  deploy do
+    invoke :'git:clone'
+  end
+end

data/spec/fixtures/empty_env/config/deploy.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+FileUtils.mkdir_p "#{Dir.pwd}/deploy"
+
+require 'mina/git'
+
+set :domain, 'localhost'
+set :deploy_to, "#{Dir.pwd}/deploy"
+set :repository, "#{Dir.pwd}"
+
+desc "Deploys."
+task :deploy do
+  deploy do
+    invoke :'git:clone'
+  end
+end

data/spec/helpers/output_helper_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'Output Helpers' do
+  before :each do
+    @out = Object.new
+    @out.send :extend, Mina::OutputHelpers
+
+    allow(@out).to receive(:print_stdout)
+    allow(@out).to receive(:print_status)
+    allow(@out).to receive(:print_error)
+    allow(@out).to receive(:print_command)
+    allow(@out).to receive(:print_clear)
+  end
+
+  it 'print_str to stdout' do
+    @out.print_str "Hello there\n"
+
+    expect(@out).to have_received(:print_stdout).with("Hello there\n")
+  end
+
+  it 'print_str to status' do
+    @out.print_str "-----> Getting password"
+
+    expect(@out).to have_received(:print_status).with("Getting password")
+  end
+
+  it 'print_str to status (2)' do
+    @out.print_str "-> Getting password"
+
+    expect(@out).to have_received(:print_status).with("Getting password")
+  end
+
+  it 'print_str to error' do
+    @out.print_str "! Something went wrong"
+
+    expect(@out).to have_received(:print_error).with("Something went wrong")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'mina'
+require 'rake'
+
+class RakeScope
+  include Rake::DSL  if Rake.const_defined?(:DSL)
+  include Mina::Helpers
+  include Mina::SshHelpers
+end
+
+def rake(&blk)
+  if block_given?
+    @scope ||= RakeScope.new
+    @scope.instance_eval &blk
+  end
+
+  @scope
+end
+
+def root(*a)
+  File.join File.expand_path('../../', __FILE__), *a
+end

data/support/Readme-footer.md

@@ -0,0 +1,32 @@
+
+Acknowledgements
+----------------
+
+© 2012-2013, Nadarei. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+Mina is authored and maintained by [Rico Sta. Cruz][rsc] and [Michael 
+Galero][mg] with help from its [contributors][c]. It is sponsored by our 
+startup, [Nadarei][nd].
+
+ * [Nadarei](http://nadarei.co) (nadarei.co)
+ * [Github](http://github.com/nadarei) (@nadarei)
+
+Rico:
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+Michael:
+
+ * [My website][mg] (michaelgalero.com)
+ * [Github](http://github.com/mikong) (@mikong)
+
+[rsc]: http://ricostacruz.com
+[mg]:  http://devblog.michaelgalero.com/
+[c]:   http://github.com/nadarei/mina/contributors
+[nd]:  http://nadarei.co
+[issues]: https://github.com/nadarei/mina/issues
+[trello]: https://trello.com/board/mina/4fc8b3023d9c9a4d72e573e6
+

data/support/Readme-header.md

@@ -0,0 +1,17 @@
+# 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
+
+[![Status](https://secure.travis-ci.org/nadarei/mina.png?branch=master)](http://travis-ci.org/nadarei/mina) [![Version](https://badge.fury.io/rb/mina.png)](http://badge.fury.io/rb/mina)
+

data/support/guide.md

@@ -0,0 +1,297 @@
+
+User guide
+==========
+
+Setting up a project
+--------------------
+
+Let's deploy a project using Mina.
+
+### Step 1: Create a config/deploy.rb
+
+In your project, type `mina init` to create a sample of this file.
+
+    $ mina init
+    Created config/deploy.rb.
+
+This is just a Rake file with tasks! See [About deploy.rb](#about-deployrb) for 
+more info on what *deploy.rb* is. You will want to at least configure your
+server:
+
+~~~ ruby
+# config/deploy.rb
+set :user, 'username'
+set :domain, 'your.server.com'
+set :deploy_to, '/var/www/flipstack.com'
+...
+~~~
+
+### Step 2: Set up your server
+
+Make a directory in your server called `/var/www/flipstack.com` (in *deploy_to*)
+change it's ownership to the correct user.
+
+    $ ssh username@your.server.com
+
+    # Once in your server, create the deploy folder:
+    ~@your.server.com$ mkdir /var/www/flipstack.com
+    ~@your.server.com$ chown -R username /var/www/flipstack.com
+
+### Step 3: Run 'mina setup'
+
+Back at your computer, do `mina setup` to set up the [folder 
+structure](#directory_structure) in this path. This will connect to your server 
+via SSH and create the right directories.
+
+    $ mina setup
+    -----> Creating folders... done.
+
+See [directory structure](#directory_structure) for more info.
+
+### Step 4: Deploy!
+
+Use `mina deploy` to run the `deploy` task defined in *config/deploy.rb*.
+
+    $ mina deploy
+    -----> Deploying to 2012-06-12-040248
+           ...
+           Lots of things happening...
+           ...
+    -----> Done.
+
+About deploy.rb
+---------------
+
+The file `deploy.rb` is simply a Rakefile invoked by Rake. In fact, `mina` is
+mostly an alias that invokes Rake to load `deploy.rb`.
+
+~~~ ruby
+# Sample config/deploy.rb
+set :domain, 'your.server.com'
+
+task :restart do
+  queue 'sudo service restart apache'
+end
+~~~
+
+As it's all Rake, you can define tasks that you can invoke using `mina`. In this
+example, it provides the `mina restart` command.
+
+The magic of Mina is in the new commands it gives you.
+
+The `queue` command queues up Bash commands to be ran on the remote server.
+If you invoke `mina restart`, it will invoke the task above and run the queued
+commands on the remote server `your.server.com` via SSH.
+
+See [the command queue](#the-command-queue) for more information on the *queue*
+command.
+
+The command queue
+-----------------
+
+At the heart of it, Mina is merely sugar on top of Rake to queue commands
+and execute them remotely at the end. Take a look at this minimal *deploy.rb*
+configuration:
+
+~~~ ruby
+# config/deploy.rb
+set :user, 'john'
+set :domain, 'flipstack.com'
+
+task :logs do
+  queue 'echo "Contents of the log file are as follows:"'
+  queue "tail -f /var/log/apache.log"
+end
+~~~
+
+Once you type `mina logs` in your terminal, it invokes the *queue*d commands
+remotely on the server using the command `ssh john@flipstack.com`.
+
+~~~ sh
+$ mina logs --simulate
+# Execute the following commands via
+# ssh john@flipstack.com:
+#
+echo "Contents of the log file are as follows:"
+tail -f /var/log/apache.log
+~~~
+
+Subtasks
+--------
+
+Mina provides the helper `invoke` to invoke other tasks from a
+task.
+
+~~~ ruby
+# config/deploy.rb
+task :down do
+  invoke :maintenance_on
+  invoke :restart
+end
+
+task :maintenance_on
+  queue 'touch maintenance.txt'
+end
+
+task :restart
+  queue 'sudo service restart apache'
+end
+~~~
+
+In this example above, if you type `mina down`, it simply invokes the other
+subtasks which queues up their commands. The commands will be ran after
+everything.
+
+Directory structure
+-------------------
+
+The deploy procedures make the assumption that you have a folder like so:
+
+    /var/www/flipstack.com/     # The deploy_to path
+     |-  releases/              # Holds releases, one subdir per release
+     |   |- 1/
+     |   |- 2/
+     |   |- 3/
+     |   '- ...
+     |-  shared/                # Holds files shared between releases
+     |   |- logs/               # Log files are usually stored here
+     |   `- ...
+     '-  current/               # A symlink to the current release in releases/
+
+It also assumes that the `deploy_to` path is fully writeable/readable for the
+user we're going to SSH with.
+
+Deploying
+---------
+
+Mina provides the `deploy` command which *queue*s up a deploy script for
+you.
+
+~~~ ruby
+# config/deploy.rb
+set :domain, 'flipstack.com'
+set :user, 'flipstack'
+set :deploy_to, '/var/www/flipstack.com'
+set :repository, 'http://github.com/flipstack/flipstack.git'
+
+task :deploy do
+  deploy do
+    # Put things that prepare the empty release folder here.
+    # Commands queued here will be ran on a new release directory.
+    invoke :'git:clone'
+    invoke :'bundle:install'
+
+    # These are instructions to start the app after it's been prepared.
+    to :launch do
+      queue 'touch tmp/restart.txt'
+    end
+
+    # This optional block defines how a broken release should be cleaned up.
+    to :clean do
+      queue 'log "failed deployment"'
+    end
+  end
+end
+~~~
+
+It works by capturing the *queue*d commands inside the block, wrapping them
+in a deploy script, then *queue*ing them back in.
+
+### How deploying works
+
+Here is an example of a deploy! (Note that some commands have been simplified
+to illustrate the point better.)
+
+### Step 1: Build it
+
+The deploy process builds a new temp folder with instructions you provide.
+In this example, it will do `git:clone` and `bundle:install`.
+
+    $ mina deploy --verbose
+    -----> Creating the build path
+           $ mkdir tmp/build-128293482394
+    -----> Cloning the Git repository
+           $ git clone https://github.com/flipstack/flipstack.git . -n --recursive
+           Cloning... done.
+    -----> Installing gem dependencies using Bundler
+           $ bundle install --without development:test
+           Using i18n (0.6.0)
+           Using multi_json (1.0.4)
+           ...
+           Your bundle is complete! It was installed to ./vendor/bundle
+
+### Step 2: Move it to releases
+
+Once the project has been built, it will be moved to `releases/`. A symlink
+called `current/` will be created to point to the active release.
+
+    $
+    -----> Moving to releases/4
+           $ mv "./tmp/build-128293482394" "releases/4"
+    -----> Symlinking to current
+           $ ln -nfs releases/4 current
+
+### Step 3: Launch it
+
+Invoke the commands queued up in the `to :launch` block. These often
+commands to restart the webserver process. Once this in complete, you're done!
+
+    $
+    -----> Launching
+           $ cd releases/4
+           $ sudo service nginx restart
+    -----> Done. Deployed v4
+
+### What about failure?
+
+If it fails at any point, the release path will be deleted. If any commands are
+queued using the `to :clean` block, they will be ran. It will be as if nothing
+happened. Lets see what happens if a build fails:
+
+    $
+    -----> Launching
+           $ cd releases/4
+           $ sudo service nginx restart
+           Starting nginx... error: can't start service
+    -----> ERROR: Deploy failed.
+    -----> Cleaning up build
+           $ rm -rf tmp/build-128293482394
+    -----> Unlinking current
+           $ ln -nfs releases/3 current
+           OK
+
+Command line options
+--------------------
+
+Basic usage:
+
+    $ mina [OPTIONS] [TASKS] [VAR1=val VAR2=val ...]
+
+### Options
+
+* `-v` / `--verbose` - This will show commands being done on the server. Off by
+  default.
+
+* `-S` / `--simulate` - This will not invoke any SSH connections; instead, it
+  will simply output the script it builds.
+
+* `-t` / `--trace` - Show backtraces when errors occur.
+
+* `-f FILE` - Use a custom deploy.rb configuration.
+
+* `-V` / `--version` - Shows the current version.
+
+### Tasks
+
+There are many tasks available. See the [tasks reference](tasks/index.html), or 
+type `mina tasks`.
+
+### Variables
+
+You may specify additional variables in the `KEY=value` style, just like Rake.
+You can add as many variables as needed.
+
+    $ mina restart on=staging
+
+    # This sets the ENV['on'] variable to 'staging'.
+