shuttle-deploy 0.2.0.beta1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTM3MDZmNjBlN2EzYTRkZmRlNDc5OTk1ZWM5MGU0MzhmMGVhZTg2Mg==
+  data.tar.gz: !binary |-
+    NGRkOTVmY2IzYzU3MDZmMTRmNWQ1YzE3MTYzMjk4NGFlZjc4NzdkNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjBhNjhmOGQyNjNjMTA3MDJjNzM3MjcxOTBhMjIzMmJmYmU2YTk2ZmI0MjMz
+    MDM0MTc5YzMwZjlmMTQxNTdmNGQyZjJhOTdlYjRkMWY5ODUwMDJhYjY2MDY5
+    ZjRmYTczN2VhOGYyNjNiNGY5OTc2ZWQ3YWQ0YTI3MDE2MGI1ZjM=
+  data.tar.gz: !binary |-
+    M2RkNzViNGNlZmY2ZWRjMTczOTVhNWFkNmYyMmRiZjQ3ZTE4NmNjNzViNWM3
+    YTVjMGI5ZjViYzhiNjQ0MzUwOGRhZDFlMDFlZmM0MDNiNTJjZGFiZGViMWE4
+    NTA4MTQyMTI4MGZmOGQ1YTYyMjI4ODVmNGYyMzJkNzE0MDAwNjg=

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+Gemfile.lock

data/.magnum.yml

@@ -0,0 +1 @@
+ruby: 1.9.3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2012-2013 Dan Sosedoff.
+
+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

@@ -0,0 +1,230 @@
+# Shuttle
+
+Shuttle is a minimalistic application deployment tool designed for small applications 
+and one-server deployments. Configuration is stored as YAML-encoded file, no need to use ruby code. 
+Operations are performed on SSH connection with target server. 
+
+*Under heavy development*
+
+## Install
+
+Clone repository and run:
+
+```
+rake install
+```
+
+Supported ruby versions:
+
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- 2.0.0
+
+## Structure
+
+Deployment structure is very similar to capistrano.
+
+Application files will be stored in `deploy_to` path that you specify in config. 
+Directory structure:
+
+- `releases` - Main directory to store all application releases
+- `current` - Symbolic link to the latest release
+- `shared` - Shared directory to store assets, configs, etc
+- `scm` - Code repository directory
+- `version` - File that contains current release number
+
+Shared directory structure:
+
+- `tmp` - Temporary files
+- `pids` - Shared process IDs files
+- `log` - Shared log files
+
+## Process
+
+Deployment flow is split into steps:
+
+- Establish connection with target server
+- Prepare application structure. It'll create all required directories or skip if they already exist.
+- Clone repository or check out latest code. Submodules will be automatically updated as well.
+- Switch to specified branch (`master` by default)
+- Create a new release directory and checkout application code
+- Perform strategy-related tasks. 
+- Create a symbolic link to the latest release
+- Clean up old releases (default count: 5)
+
+## Strategies
+
+Available deployment strategies:
+
+- `static`
+- `wordpress`
+- `ruby`
+- `rails`
+- `nodejs`
+
+### Static Strategy
+
+This is a default strategy that does not perform any application-related tasks. 
+Example configuration:
+
+```yaml
+app:
+  name: my-application
+  strategy: static
+  git: git@github.com:my-site.git
+
+target:
+  host: my-host.com
+  user: username
+  password: password
+  deploy_to: /home/deployer/www
+```
+
+### Wordpress Strategy
+
+This strategy is designed to deploy wordpress sites developed as a separate theme. 
+It requires `subversion` installed on the server (will be automatically installed). 
+
+## Deployment Config
+
+Deployment config has a few main sections: `app` and `target`. 
+
+### Application
+
+Application section defines deployment strategy, source code location and other options:
+
+```yml
+app:
+  name: my-app
+  strategy: static
+  git: https://site-url.com/repo.git
+  branch: master
+  keep_releases: 5
+```
+
+Options:
+
+- `name` - Your application name
+- `strategy` - Deployment strategy. Defaults to `static`
+- `git` - Git repository url
+- `branch` - Git repository branch. Defaults to `master`
+- `keep_releases` - Number of releases to keep. Defaults to `10`
+
+You can also use Subversion as a main source:
+
+```yml
+app:
+  svn: http://site-url.com/repo.git
+```
+
+If your repository requires authentication, use url in the following format:
+
+```
+http://username:password@yourdomain.com/project
+```
+
+### Target
+
+Target is a set of remote machine credentials:
+
+```yml
+target:
+  host: yourdomain.com
+  user: deployer
+  password: password
+  deploy_to: /home/deployer/myapp
+```
+
+Options:
+
+- `host` - Remote server host or ip
+- `user` - Remote server user account
+- `password` - Optional password. Use passwordless authentication if possible.
+- `deploy_to` - Primary directory where all releases will be stored
+
+You can also define multiple targets per config if environments does not have any specific 
+configuration settings:
+
+```yml
+targets:
+  production:
+    host: mydomain.com
+    user: deployer
+    deploy_to: /home/production/myapp
+  staging:
+    host: mydomain.com
+    user: deployer
+    deploy_to: /home/staging/myapp
+```
+
+## Usage
+
+To execute a new deploy, simply type (in your project folder):
+
+```
+shuttle deploy
+```
+
+Output will look like this:
+
+```
+Shuttle v0.2.0
+
+-----> Connected to deployer@mysite.com
+-----> Preparing application structure
+-----> Fetching latest code
+-----> Using branch 'master'
+-----> Linking release
+-----> Release v35 has been deployed
+-----> Cleaning up old releases: 1
+
+Execution time: 2s
+```
+
+If using multiple targets in config, you can specify which target to use with:
+
+```
+shuttle staging deploy
+```
+
+Specify a path to config with `-f` flag:
+
+```
+shuttle -f /path/to/config.yml deploy
+```
+
+To run in debug mode, add `-d` flag:
+
+```
+shuttle deploy -d
+```
+
+## Test
+
+To run project test suite execute:
+
+```
+bundle exec rake test
+```
+
+## License
+
+Copyright (c) 2012-2013 Dan Sosedoff.
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/bin/shuttle

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'rubygems'
+require 'optparse'
+require 'shuttle'
+
+config_name = Dir.pwd.split('/').last + ".yml"
+
+options = {
+  :path   => File.join(ENV['HOME'], '.shuttle', config_name),
+  :target => 'production',
+  :log    => false
+}
+
+optparse = OptionParser.new do |opts|
+  opts.on('-v', '--version', 'Show version') do
+    puts "Shuttle version #{Shuttle::VERSION}"
+    exit 0
+  end
+
+  opts.on('-e', '--environment NAME', 'Deployment target environment') do |v|
+    options[:target] = v
+  end
+
+  opts.on('-d', '--debug', 'Enable debugging') do
+    options[:log] = true
+  end
+
+  opts.on('-f', '--file PATH', 'Configuration file path') do |v|
+    options[:path] = v
+  end
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::ParseError => e
+  puts "Error: #{e.message}"
+  exit 1
+end
+
+case ARGV.size
+when 2
+  options[:target] = ARGV.shift
+  command = ARGV.shift
+when 1
+  command = ARGV.shift
+else
+  puts "Command required"
+  exit 1
+end
+
+begin
+  runner = Shuttle::Runner.new(options)
+  runner.execute(command.dup)
+rescue Shuttle::ConfigError => err
+  puts "Error: #{err.message}."
+end

data/examples/rails.yml

@@ -0,0 +1,22 @@
+app:
+  name: rails-app
+  strategy: rails
+  git: git@github.com:user/repo.git
+
+target:
+  host: rails-app.com
+  user: deployer
+  password: password
+  deploy_to: /home/deployer/www
+
+rails:
+  environment: production
+  precompile_assets: true
+  start_server: true
+  shared_paths:
+    static_assets: public/static
+
+thin:
+  host: 127.0.0.1
+  port: 9000
+  servers: 5

data/examples/static.yml

@@ -0,0 +1,10 @@
+app:
+  name: sample-site
+  strategy: static
+  git: git@github.com/username/sample-site.git
+
+target:
+  host: sample-site.com
+  user: deployer
+  password: password
+  deploy_to: /home/deployer/www

data/examples/wordpress.yml

@@ -0,0 +1,34 @@
+app:
+  name: sample-site
+  strategy: wordpress
+  git: git@github.com/username/sample-site.git
+  branch: production
+
+target:
+  host: sample-site.com
+  user: deployer
+  password: password
+  deploy_to: /home/deployer/www
+
+wordpress:
+  theme: theme_name
+  site:
+    title: "Site Title"
+    url: "http://sample-site.com"
+    admin_name: "admin"
+    admin_email: "admin@admin.com"
+    admin_password: "password"
+  mysql: 
+    host: 127.0.0.1
+    user: mysql-user
+    password: mysql-password
+    database: mysql-dadtabase
+  plugins:
+    - advanced-custom-fields: git://github.com/elliotcondon/acf.git
+    - be-subpages-widget
+    - contact-form-7
+    - contact-form-7-to-database-extension
+    - featured-page-widget
+    - share-this
+    - twitter-widget-pro
+    - types

data/lib/shuttle/config.rb

@@ -0,0 +1,5 @@
+module Shuttle
+  class Config
+    # TODO
+  end
+end

data/lib/shuttle/deploy.rb

@@ -0,0 +1,58 @@
+module Shuttle
+  class Deploy
+    include Shuttle::Tasks
+    include Shuttle::Helpers
+
+    attr_reader :ssh
+    attr_reader :target
+    attr_reader :environment
+    attr_reader :version
+    attr_reader :config
+
+    def initialize(config, ssh, target, environment)
+      @config      = config
+      @target      = target
+      @ssh         = ssh
+      @environment = environment
+
+      if ssh.file_exists?(version_path)
+        res = ssh.capture("cat #{version_path}")
+        @version = (res.empty? ? 1 : Integer(res) + 1).to_s
+      else
+        @version = 1
+      end
+    end
+
+    def deploy_path(path=nil)
+      [target.deploy_to, path].compact.join('/')
+    end
+
+    def shared_path(path=nil)
+      [deploy_path, 'shared', path].compact.join('/')
+    end
+
+    def current_path(path=nil)
+      [deploy_path, 'current', path].compact.join('/')
+    end
+
+    def version_path
+      deploy_path('version')
+    end
+
+    def release_path(path=nil)
+      [deploy_path, 'releases', version, path].compact.join('/')
+    end
+
+    def scm_path
+      deploy_path('scm')
+    end
+
+    def deploy
+      setup
+      update_code
+      checkout_code
+      link_release
+      cleanup_releases
+    end
+  end
+end

data/lib/shuttle/deployment/nodejs.rb

@@ -0,0 +1,48 @@
+module Shuttle
+  class Nodejs < Shuttle::Deploy
+    def setup
+      if node_installed?
+        log "Using Node.js v#{node_version}, Npm v#{npm_version}"
+      else
+        error "Node.js is not installed."
+      end
+
+      super
+    end
+
+    def deploy
+      setup
+      update_code
+      checkout_code
+      install_dependencies
+      link_release
+      cleanup_releases
+    end
+
+    private
+
+    def node_installed?
+      ssh.run("which node").success?
+    end
+
+    def node_version
+      ssh.run("node -v").output.strip.gsub('v', '')
+    end
+
+    def npm_version
+      ssh.run("npm -v").output.strip
+    end
+
+    def install_dependencies
+      if ssh.file_exists?("#{release_path}/package.json")
+        log "Installing application dependencies"
+
+        result = ssh.run("cd #{release_path} && npm install")
+
+        if result.failure?
+          error "Unable to install dependencies: #{result.output}"
+        end
+      end
+    end
+  end
+end

data/lib/shuttle/deployment/php.rb

@@ -0,0 +1,17 @@
+module Shuttle
+  class Php < Shuttle::Deploy
+    def setup
+      unless php_installed?
+        error "Please install PHP first"
+      end
+
+      super
+    end
+
+    private
+
+    def php_installed?
+      ssh.run("which php").success?
+    end
+  end
+end

data/lib/shuttle/deployment/rails.rb

@@ -0,0 +1,116 @@
+module Shuttle
+  class Rails < Shuttle::Deploy
+    include Shuttle::Support::Bundler
+    include Shuttle::Support::Thin
+
+    def rails_env
+      if config.rails && config.rails.environment
+        config.rails.environment
+      else
+        environment
+      end
+    end
+
+    def precompile_assets?
+      config.rails && config.rails.precompile_assets != false
+    end
+
+    def start_server?
+      if config.rails && !config.rails.start_server.nil?
+        config.rails.start_server
+      else
+        true
+      end
+    end
+
+    def setup_bundler
+      if !bundler_installed?
+        log "Bundler is missing. Installing"
+
+        res = ssh.run("sudo gem install bundler")
+        if res.success?
+          log "Bundler v#{bundler_version} installed"
+        else
+          error "Unable to install bundler: #{res.output}"
+        end
+      end
+    end
+
+    def rake(command)
+      res = ssh.run("cd #{release_path} && rake #{command}")
+      if res.failure?
+        error "Unable to run rake command: #{command}. Reason: #{res.output}"
+      end
+    end
+
+    def precompile_assets
+      if precompile_assets?
+        log "Precompiling assets"
+        rake 'assets:precompile'
+      end
+    end
+
+    def deploy
+      ssh.export('RACK_ENV', rails_env)
+      ssh.export('RAILS_ENV', rails_env)
+
+      log "Rails environment is set to #{rails_env}"
+
+      setup
+      setup_bundler
+      update_code
+      checkout_code
+      bundle_install
+      migrate_database
+      precompile_assets
+      link_shared_paths
+      
+      if start_server?
+        thin_restart
+      end
+
+      link_release
+      cleanup_releases
+    end
+
+    def migrate_database
+      return if !ssh.file_exists?(release_path('db/schema.rb'))
+
+      migrate     = true # Will migrate by default
+      schema      = ssh.read_file(release_path('db/schema.rb'))
+      schema_file = shared_path('schema')
+      checksum    = Digest::SHA1.hexdigest(schema)
+
+      if ssh.file_exists?(schema_file)
+        old_checksum = ssh.read_file(schema_file).strip
+        if old_checksum == checksum
+          migrate = false
+        end
+      end
+
+      if migrate == true
+        log "Migrating database"
+        rake 'db:migrate'
+        ssh.run("echo #{checksum} > #{schema_file}")
+      else
+        log "Database migration skipped"
+      end
+    end
+
+    def link_shared_paths
+      ssh.run("mkdir -p #{release_path('tmp')}")
+      ssh.run("rm -rf #{release_path}/log")
+      ssh.run("ln -s #{shared_path('pids')} #{release_path('tmp/pids')}")
+      ssh.run("ln -s #{shared_path('log')} #{release_path('log')}")
+
+      if config.rails
+        if config.rails.shared_paths
+          config.rails.shared_paths.each_pair do |name, path|
+            log "Linking shared path: #{name}"
+            ssh.run("ln -s #{shared_path}/#{name} #{release_path}/#{path}")
+          end
+        end
+      end
+    end
+  end
+end