baboon 1.0.9 → 1.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3303b225f210852b4ea5f95e4d981c9a9a33e148
+  data.tar.gz: e71c11a4101e4e1ad5de22f2605f0ab45a9e3c68
+SHA512:
+  metadata.gz: ca0a49f09866a6429fb498022e1f0a4c7c7d398a8e786ea5874ad695a6fba9502896c68df55dec75594e687c7a881e33261643272df9382babe42313733e79c9
+  data.tar.gz: 9c772ded6c4db6f1e70a384b45754c79080a9a193451a6bf9d349d8d4958945e4335d69c483882e2f5e21b48145d1e56e36bd69350b94cb43d3bdeb7ff8e2c76

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 3zOeqgeUoXhK90RsGclfu8NYgrC68fIjb

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.ideas
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+#--profile
+#--format documentation
+#--format EmojiFormatter

data/.ruby-gemset

@@ -0,0 +1 @@
+baboon

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+gem 'thor',             '0.19.1'
+gem 'net-ssh',          '~> 2.6'
+gem 'net-ssh-session',  '0.1.6'
+
+group :test do
+  gem 'rake'
+  gem 'rails'
+  gem 'rspec'
+  gem 'rspec-core'
+  gem 'rspec-mocks'
+  gem 'rspec-rails'
+  gem 'rspec-expectations'
+  gem 'shoulda-matchers'
+  gem 'simplecov'
+  gem 'webmock'
+  gem 'capybara'
+  gem 'faker'
+  gem 'coveralls'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Manelis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,11 +1,13 @@
-# Baboon
-![cardinal](https://alexweb.s3.amazonaws.com/baboon.jpeg)
-
-[![Build Status](https://secure.travis-ci.org/amanelis/baboon.png)](http://travis-ci.org/amanelis/baboon)
-[![Dependency Status](https://gemnasium.com/amanelis/baboon.png)](https://gemnasium.com/amanelis/baboon)
+# Baboon - simple rails deployment.
+![cardinal](https://alexweb.s3.amazonaws.com/baboon.png)
 
 A simple and light weight deployment library for a ruby on rails application 3.0+. No symlinks, no releases, just git and your application. 
 
+<!--[![Build Status](https://secure.travis-ci.org/amanelis/baboon.png)](http://travis-ci.org/amanelis/baboon)-->
+<!--[![Dependency Status](https://gemnasium.com/amanelis/baboon.svg)](https://gemnasium.com/amanelis/baboon)-->
+<!--[![Code Climate](https://codeclimate.com/github/amanelis/baboon.png)](https://codeclimate.com/github/amanelis/baboon)-->
+<!--[![Coverage Status](https://coveralls.io/repos/amanelis/baboon/badge.png?branch=master)](https://coveralls.io/r/amanelis/baboon)-->
+
 
 # How it works
 Baboon is simple. You provide your server addresses, environments, path, repository, username and Baboon does the rest. By running a simple `baboon deploy {env}` it will do all neccessary operations you intend for it to do on a full deploy to a production staging or development server. All you need is a working rails application on a server with a git repository.
@@ -21,25 +23,97 @@ This must be installed under a current rails application. We recommend vendoring
 
 In your Gemfile, then `bundle install`.
 
-	gem 'baboon'
+```rb
+gem 'baboon'
+```
 	
 Now that the gem is installed, run the config generator
 
 	$ rails g baboon:install
 
-This will build a file into your application under `config/initializers/baboon.rb`. Open this file and start editing. Here is an example of the main configuration options:
-
-	Baboon.configure do |config|
-  	  config.application  = 'Vacuum HQ'
-	  config.repository   = 'git@github.com:amanelis/vacuum.git'
-	  config.deploy_path  = '/home/rails/vacuum'
-	  config.deploy_user  = 'rails
-	  config.branch       = 'master'
-	  config.rails_env    = 'production'
-	  config.servers      = ['192.168.1.1', '192.168.1.2']
-	end
+This will build a file into your application under `config/baboon.yml`. Open this file and start editing. Here is an example of the main configuration options:
+```yaml
+baboon:
+  # Give you application a descriptive name, has no effect on the actual
+  # running path or location of your application. Can be different then
+  # what is stored in your scm.
+  application:  'Vacuum HQ'
+
+  # For now, Baboon will determine what scm the remote code is stored 
+  # in based on the scm path. 
+  repository:   'git@github.com:amanelis/vacuum.git'
+
+  # Pass multiple environments in this section. Each environment you 
+  # specify then becomes part of the deploy command: baboon deploy  
+  # {environment}. Below, we have defined two envs of staging and 
+  # production. Add more as needed.
+  environments:
+    # Name each environment to your own standard. Baboon, will use the 
+    # settings defined after the env to to the deploy. This environment 
+    # is named 'staging' -> baboon deploy staging
+    staging:
+      # This is the branch from your scm that Baboon will pull and merge 
+      # code from. The repository is defined in the root node of this 
+      # configuration file.
+      branch: 'staging'
+
+      # Callbacks, pre and post deploy. Specify any command you want 
+      # executed pre and post in blocks below as array elements.
+      callbacks:
+        # These will be run before the code fetch and server restart.
+        before_deploy:
+          - '/etc/init.d/my_service stop'
+          - 'ruby clean_and_free_memory.rb'
+
+        # These will be run after the code fetch and server restart.
+        after_deploy:
+          - '/etc/init.d/my_service start'
+          - 'ruby warm_cache.rb'
+
+      # This is the path on the server where the root of the 
+      # application is stored, not where /public is in terms of a rails
+      # setup.
+      deploy_path: '/home/rails/vacuum'
+ 
+      # This is the user that baboon will use for SSH authentication
+      # into the servers that are defined here. 
+      deploy_user: 'rails'
+
+      # Rails environment that Baboon will run all rake/bundler commands
+      # with.
+      rails_env: 'staging'
+
+      # Custom server restart_command. If your server happens to not respond
+      # `touch tmp/restart.txt` - specify your restart command. Otherwise
+      # default Baboon will try and touch the restart.txt file.
+      restart_command: '/etc/init.d/appache2 restart'
+
+      # These are the host machines that baboon will ssh into on each
+      # deploy. They can be defined as an ip address or a host name
+      servers:
+        - '127.0.0.1'
+        - '127.0.0.2'
+          
+    # You can define as many different environments as needed. 
+    production:
+      branch: 'master'
+      callbacks:
+        before_deploy:
+          - '/etc/init.d/my_service stop'
+        after_deploy:
+          - '/etc/init.d/my_service start'
+      deploy_path: '/home/rails/vacuum'
+      deploy_user: 'rails'
+      rails_env: 'production'
+      restart_command: '/etc/init.d/apache2 restart'
+      servers:
+        - '10.0.0.1'
+        - '10.0.0.2'
+        - '10.0.0.3'
+        - 'production.node1.east.com'
+```	
 	
-These must be properly filled out so baboon can properly make deploys.
+These must be properly filled out so baboon can properly make deploys. One single environment always has a `branch` that baboon will know where to pull the deployable code from. It will assume the `repository` from the root node. For the environment, baboon will need to know what user to login as via the `deploy_user` and where to cd to via the `deploy_path`. Once it knows the location of the app, baboon will need to know what env to run as, hence the `rails_env` setting. The last option is the `servers` collection. Fill as many servers as you would like and baboon will deploy to all for the given env. Asynchronous is the next option we would like to add.
 
 ---
 # Commands
@@ -47,31 +121,31 @@ Once everything is setup you can run `baboon` to see available commands. Start b
 
 	$ baboon configuration
 	
-Once you see and verify your Baboon.configuration you can now go ahead and test a deploy. For now, lets assume you have everything in your config correct and you are deploying to production, run the following command to do a cold deploy:
+For now, lets assume you have everything in your config correct and you are deploying to production, run the following command to do a deploy:
+
+	$ baboon deploy production
+	
+Any other deploy to a different env that you specify in your config file can be done as follows:
 
-	$ baboon deploy
+	$ baboon deploy {environment}
 	
 To view the available servers you have setup in your config file, the following command will tell you which servers are set to be deploy to:
 
-	$ baboon servers
+	$ baboon servers production
 	
 Thats it? Yeah, thats it! You should see your bundle installing and Baboon running all tasks. Custom tasks coming soon.
 
 The next commands that will be realeased with future versions of baboon are:
 
-  baboon setup    # no manually editing of configuration file
-	baboon check 		# checks the server and config file for proper configuration
-	baboon migrate 		# runs pending migrations
-	baboon restart 		# restarts your server
-	baboon rollback 	# rolls back your to your previous commit, info in ./log/baboon.log
-	baboon rake 		# run custom rake tasks on server
-	baboon execute 		# run a single command on the server
-	baboon shell	 	# open a remote shell with the config user
 
----
-# CLI
-
-This is coming very soon…
+  	baboon setup    		# no manually editing of configuration file
+	baboon check 		    # checks the server and config file for proper configuration
+	baboon migrate 		  	# runs pending migrations
+	baboon restart 		  	# restarts your server
+	baboon rollback 	  	# rolls back your to your previous commit, info in ./log/baboon.log
+	baboon rake 			# run custom rake tasks on server
+	baboon execute 			# run a single command on the server
+	baboon shell	 		# open a remote shell with the config user
 
 
 ---
@@ -95,6 +169,12 @@ Multiple server deployments now work.
 #### 1.0.6
 Changed the order of bundle installing on Rails package. Wrote tests for CLI.
 
+#### 1.0.9
+Removed ruby configuration and added configuration by `config/baboon.yml`. More environments.
+
+## Thanks
+I'd like to thank Enrique Ruiz Davila for making the beautiful [Baboon](http://www.behance.net/davila) image. 
+
 ## How to contribute
  
 * Fork the project.

data/Rakefile

@@ -2,9 +2,9 @@
 
 directory '.'
 task :dgem do
-  sh 'rm *.gem'
+  system 'rm *.gem'
 end
 
 task :bgem do
-  sh 'gem build *.gemspec'
+  system 'gem build *.gemspec'
 end

data/baboon.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'baboon/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'baboon'
+  s.version       = Baboon::VERSION.dup
+  s.executables   = %w[ baboon ]
+  s.license       = 'MIT'
+  s.homepage      = 'https://github.com/amanelis/baboon'
+
+  s.authors       = ['Alex Manelis']
+  s.email         = ['amanelis@gmail.com']
+  s.description   = %q{A lite deployment package for rails applications.}
+  s.summary       = %q{Add a configuration file, setup and deploy.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_dependency 'thor',            '~> 0.19.1'
+  s.add_dependency 'net-ssh',         '~> 2.6'
+  s.add_dependency 'net-ssh-session', '~> 0.1.6'
+end

data/lib/baboon.rb

@@ -7,9 +7,9 @@
 
 # Nicely formatted output of the Baboon title
 BABOON_TITLE = "\033[22;31mB\033[22;35ma\033[22;36mb\033[22;32mo\033[01;31mo\033[01;33mn\033[22;37m"
-BABOON_ENVIRONMENT_SETTINGS = ['branch', 'deploy_path', 'deploy_user', 'rails_env', 'servers']
+BABOON_ENVIRONMENT_SETTINGS = ['branch', 'deploy_path', 'deploy_user',
+  'rails_env', 'restart_command', 'servers']
 
-require 'baboon/configuration'
 require 'baboon/cli'
-require 'baboon/logger'
-require 'baboon/version'
+require 'baboon/version'
+require 'yaml'

data/lib/baboon/cli.rb

@@ -1,112 +1,216 @@
 require 'baboon'
-require 'baboon/configuration'
 require 'baboon/util'
 
-require 'find'
 require 'net/ssh'
+require 'net/ssh/session'
+require 'find'
 require 'thor'
 require 'yaml'
 
-module Baboon  
+module Baboon
+  class InvalidConfigurationError < StandardError
+  end
+
   class Cli < Thor
-    # @logger: call an instance of the logger class, use throughout baboon
+    # Name the package output
+    package_name "Baboon"
+
     # @configuration: holds the default baboon configuration set in config file
     # @configuration_file: the exact file location of baboon configuration
-    attr_accessor :configuration, :configuration_file, :stop
+    attr_accessor :configuration, :configuration_file, :errors, :stop
 
     # initialize
     # @param: Array
-    # @ereturn: instance
-    def initialize(*args)
+    # @return: instance
+    def initialize *args
       super
+
+      # Sync stdout for when communicating over ssh channel
       $stdout.sync ||= true
-      
-      # Set our yaml engine
-      YAML::ENGINE.yamler = 'syck'
-      
+
+      # Store any errors here during the process so they can be printed to STDOUT
+      @errors = []
+
       # Attempt to locate the configuration file in the project if it was not set.
-      @configuration_file = Util.locate_file
-      
+      @configuration_file = Util.locate_baboon_configuration_file
+
       # Return if file not found
-      if @configuration_file.nil? ||  @configuration_file == ''
+      if @configuration_file.nil?
         printf "#{BABOON_TITLE}\n"
         printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/baboon.yml\n"
         printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
-        @stop = true  
+        errors << "#initialize: failed to load a valid configuration file, please be sure a proper one is created at config/baboon.yml"
+        @stop = true
         return
       end
-      
+
       # Load the file now that we know its not nil
       @configuration = YAML.load_file(@configuration_file)
-      
+
       # Double check that configuration is setup properly
       if @configuration['baboon'].has_key?('environments')
         @configuration['baboon']['environments'].map do |environment|
           hash = Hash[*environment]
           key  = hash.keys.first
-          
+
           # Must have all defined keys filled out
           unless BABOON_ENVIRONMENT_SETTINGS.collect { |k| hash[key].has_key?(k) }.all?
             printf "#{BABOON_TITLE}\n"
             printf "  \033[22;31mError:\033[22;37m incorrect settings for the \"#{key}\" in config/baboon.yml\n"
             printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
+            errors << "#initialize: incorrect key:val [#{key}:#{k}] pair in config/baboon.yml"
             @stop = true
             return
           end
         end
       end
     end
-    
-    desc "deploy ENVIRONMENT", "Deploys the application to the configured servers."
+
+    desc "deploy [ENVIRONMENT]", "Deploys the application to the configured servers via ssh."
     def deploy environment
-      return if @stop   
-      
-      # Double checked the user typed the correct key
-      unless @configuration['baboon']['environments'].has_key?(environment)
-        printf "#{BABOON_TITLE}\n"
-        printf "  \033[22;31mError:\033[22;37m looks like you typed an incorrect key for an environment you specified in your baboon.yml file\n"
-        printf "  \033[01;32mUsage:\033[22;37m try one of these #{@configuration['baboon']['environments'].keys}\n"
-        @stop = true
-        return
-      end
-      
+      check_configuration(environment)
+
+      raise InvalidConfigurationError.new("Your configuration is invalid, please check if you have misssss spelled something.") if @stop
+
       # Get the current config for this environment
       current_environment_configuration = @configuration['baboon']['environments'][environment]
-      
+
       # Loop through the servers
       current_environment_configuration['servers'].each do |host|
-        printf "Deploying[#{host}]"
-        
+        printf "Deploying[#{host}]\n"
+
         # TODO: add lib of different instruction sets for Play framework, nodejs, etc
         instructions = [
           "cd '#{current_environment_configuration['deploy_path']}' && git fetch",
           "cd '#{current_environment_configuration['deploy_path']}' && git checkout #{current_environment_configuration['branch']}",
           "cd '#{current_environment_configuration['deploy_path']}' && git merge origin/#{current_environment_configuration['branch']}",
-          "cd '#{current_environment_configuration['deploy_path']}' && bundle install --deployment",
-          "cd '#{current_environment_configuration['deploy_path']}' && touch tmp/restart.txt"
+          "cd '#{current_environment_configuration['deploy_path']}' && RAILS_ENV=#{current_environment_configuration['rails_env']} bundle install --deployment --without development test",
+          "cd '#{current_environment_configuration['deploy_path']}' && RAILS_ENV=#{current_environment_configuration['rails_env']} bundle exec rake assets:precompile",
+          "cd '#{current_environment_configuration['deploy_path']}' && RAILS_ENV=#{current_environment_configuration['rails_env']} bundle exec rake db:migrate"
         ]
-        
+
+        if current_environment_configuration.has_key?('restart_command') && !current_environment_configuration['restart_command'].nil?
+          instructions << current_environment_configuration['restart_command']
+        else
+          instructions << "cd '#{current_environment_configuration['deploy_path']}' && touch tmp/restart.txt"
+        end
+
         # Vars for connecting via ssh to the server
-        credentials = { 
-          user: current_environment_configuration['deploy_user'], 
+        credentials = {
+          user: current_environment_configuration['deploy_user'],
           host: host
         }
-        
-        # Start the connection and excute command
-        Net::SSH.start(credentials[:host], credentials[:user]) do |session|
-          instructions.each do |instruction|
-            printf "[#{host}]: #{instruction}\n"
-            session.exec instruction
-            session.loop
+
+        # Initialize the SSH class
+        session = Net::SSH::Session.new(credentials[:host], credentials[:user], nil)
+
+        # Open the session
+        session.open
+
+        # Set the rails_env session if var is present
+        session.export_hash(
+          'RAILS_ENV' => current_environment_configuration['rails_env'],
+          'RACK_ENV'  => current_environment_configuration['rails_env']
+        )
+
+        # Check if user has added the callbacks block
+        can_run_callbacks = current_environment_configuration.has_key?('callbacks')
+
+        # Run pre instructions
+        if can_run_callbacks
+          pre_callbacks = current_environment_configuration['callbacks']['before_deploy']
+
+          if !pre_callbacks.nil? && pre_callbacks.is_a?(Array) && pre_callbacks.count >= 1
+            printf "[\033[36m#{host}\033[0m]: Running pre callbacks...\n"
+            run_commands(host, session, pre_callbacks)
           end
         end
-      end   
-    end # def deploy
+
+        # Execute commands
+        run_commands(host, session, instructions)
+
+        # Run post instructions
+        if can_run_callbacks
+          post_callbacks = current_environment_configuration['callbacks']['after_deploy']
+
+          if !post_callbacks.nil? && post_callbacks.is_a?(Array) && post_callbacks.count >= 1
+            printf "[\033[36m#{host}\033[0m]: Running post callbacks...\n"
+            run_commands(host, session, post_callbacks)
+          end
+        end
+
+        # Close and exit the session
+        begin
+          session.exit
+        rescue => e
+          # Here well want to write to stdout if --debug flag was passed
+        end
+
+        printf "[\033[36m#{host}\033[0m]: \033[32mComplete!\033[0m\n"
+      end
+    end
+
+    desc "fetc", "Fetches a given file from your project's directory"
+    def fetch environment, file
+      current_configuration = @configuration['baboon']['environments'][environment]
+
+      raise InvalidHostError.new("No host found in your configuration, please add one") if current_configuration['servers'].first.nil?
+
+      host = current_configuration['servers'].first
+
+      # Initialize the SSH class
+      session = Net::SSH::Session.new(current_configuration['servers'].first, current_configuration['deploy_user'], nil)
+      session.open
+
+      file_path = file.gsub(/^\//, '')
+      printf "[\033[36m#{host}\033[0m]: Fetching file '#{file_path}'\n"
+      fetch_result = session.run("/bin/cat #{current_configuration['deploy_path']}/#{file_path}")
+      session.exit
+
+      printf "[\033[36m#{host}\033[0m]: Results below.\n"
+      printf fetch_result.output + "\n"
+      printf "[\033[36m#{host}\033[0m]: Complete.\n"
+    end
+
+    desc "ref", "Current git ref HEAD of the running code"
+    def ref
+      current_configuration = @configuration['baboon']['environments'][environment]
+
+
+    end
+
+    desc "rollback", "Rollsback the application to a given state via ssh."
+    def rollback environment
+      puts "This functionality has not been implemented yet, coming soon, I promise :)"
+    end
 
     desc "configuration", "Shows the current configuration for baboon."
-    def configuration    
+    def configuration
       return if @stop
-      puts @configuration.inspect
+      puts @configuration['baboon']['application']
+    end
+
+    desc "version", "Shows the version of Baboon."
+    def version
+      puts Baboon::VERSION
+    end
+
+  private
+
+    def check_configuration(environment)
+      if !@configuration['baboon']['environments'].has_key?(environment)
+        printf "#{BABOON_TITLE}\n"
+        printf "  \033[22;31mError:\033[22;37m looks like you typed an incorrect key for an environment you specified in your baboon.yml file\n"
+        printf "  \033[01;32mUsage:\033[22;37m try one of these #{@configuration['baboon']['environments'].keys}\n"
+        errors << "#deploy: missing {environment} key inside of config/baboon.yml - you need at least 1 environment to deploy."
+        @stop = true
+      end
+    end
+
+    def run_commands(host, session, instructions)
+      session.run_multiple(instructions) do |cmd|
+        printf "[\033[36m#{host}\033[0m]: #{cmd}\n"
+      end
     end
   end
-end
+end