deployto 0.9.0

data/README.md

@@ -0,0 +1,27 @@
+# deploytool
+
+Deployment tool for Platform-as-a-Service providers, with special support for multi-stage deploys (e.g. for staging environments).
+
+Platforms currently supported:
+* Efficient Cloud Platforms
+
+Platform support planned:
+* Heroku
+* Cloud Foundry Platforms
+
+## Deploying a Ruby on Rails app
+
+    gem install deploytool
+    deploy add production portfolio.heroku.com
+    deploy add staging portfolio.vcap.me
+    deploy production
+
+## Config file
+
+deploy keeps a local config file .deployrc within the top-level sourcecode directory (determined by location of .git directory).
+
+## Legalese
+
+_Copyright 2011, Efficient Cloud Ltd.
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/bin/deploy

@@ -0,0 +1,26 @@
+#!/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 'logger'
+require 'rubygems'
+require 'deploytool'
+require 'deploytool/command'
+
+$logger = Logger.new STDOUT
+$logger.formatter = proc do |severity, datetime, progname, msg|
+  next if severity == "DEBUG"
+  if severity == "ERROR"
+    "ERROR: #{msg}\n"
+  else
+    "#{msg}\n"
+  end
+end
+HighLine.track_eof = false
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+DeployTool::Command.run(command, args)

data/lib/deploytool/command.rb

@@ -0,0 +1,108 @@
+class DeployTool::Command
+  COMMANDS = ["to", "logs", "import", "export", "config"]
+  
+  def self.run(command, args)
+    change_to_toplevel_dir!
+    
+    DeployTool::Config.load(".deployrc")
+    
+    if command == "help"
+      puts "Deploytool Usage Instructions"
+      puts ""
+      puts "Add a target:"
+      puts "  deploy add production app1@demo.efficientcloud.com"
+      puts "  deploy add staging myapp.heroku.com"
+      puts "  deploy add failover api.cloudfoundry.com"
+      puts ""
+      puts "Deploy the current directory to the target:"
+      puts "  deploy to production"
+    elsif command == "add"
+      if args[0].nil?
+        puts "ERROR: Missing target name."
+        puts ""
+        puts "Use \"deploy help\" if you're lost."
+        exit
+      end
+      if args[1].nil?
+        puts "ERROR: Missing target specification."
+        puts ""
+        puts "Use \"deploy help\" if you're lost."
+        exit
+      end
+      unless target = DeployTool::Target.find(args[1])
+        puts "ERROR: Couldn't find provider for target \"#{args[1]}\""
+        puts ""
+        puts "Use \"deploy help\" if you're lost."
+        exit
+      end
+      DeployTool::Config[args[0]] = target.to_h
+    elsif command == "list"
+      puts "Registered Targets:"
+      DeployTool::Config.all.each do |target_name, target|
+        target = DeployTool::Target.from_config(target)
+        puts "  %s%s" % [target_name.ljust(15), target.to_s]
+      end
+    else
+      args.unshift command unless command == "to"
+      target_name = args[0]
+      
+      unless (target = DeployTool::Config[target_name]) && !target.nil? && target.size > 0
+        puts "ERROR: Couldn't find target: #{target_name}"
+        puts ""
+        puts "Use \"deploy help\" if you're lost."
+        exit
+      end
+      
+      opts = {}
+      opts[:timing] = true if args.include?("--timing")
+
+      target = DeployTool::Target.from_config(target)
+      begin
+        target.push(opts)
+      rescue => e
+        puts e
+        exit 2
+      end
+    end
+    
+    DeployTool::Config.save
+  rescue Net::HTTPServerException => e
+    $logger.info "ERROR: HTTP call returned %s %s" % [e.response.code, e.response.message]
+    if target
+      $logger.debug "\nTarget:"
+      target.to_h.each do |k, v|
+        next if k.to_sym == :password
+        $logger.debug "  %s = %s" % [k, v]
+      end
+    end
+    $logger.debug "\nBacktrace:"
+    $logger.debug "  " + e.backtrace.join("\n  ")
+    $logger.debug "\nResponse:"
+    e.response.each_header do |k, v|
+      $logger.debug "  %s: %s" % [k, v]
+    end
+    $logger.debug "\n  " + e.response.body.gsub("\n", "\n  ")
+    $logger.info "\nPlease run again with \"--debug\" and report the output at http://bit.ly/deploytool-new-issue"
+    exit 2
+  end
+  
+  # Tries to figure out if we're running in a subdirectory of the source,
+  # and switches to the top-level if that's the case
+  def self.change_to_toplevel_dir!
+    indicators = [".git", "Gemfile", "LICENSE", "test"]
+    
+    timeout = 10
+    path = Dir.pwd
+    begin
+      indicators.each do |indicator|
+        next unless File.exists?(File.join(path, indicator))
+        
+        $logger.debug "Found correct top-level directory %s, switching working directory." % [path] unless path == Dir.pwd
+        Dir.chdir path
+        return
+      end
+    end until (path = File.dirname(path)) == "/" || (timeout -= 1) == 0
+
+    $logger.debug "DEBUG: Couldn't locate top-level directory (traversed until %s), falling back to %s" % [path, Dir.pwd]
+  end
+end

data/lib/deploytool/config.rb

@@ -0,0 +1,21 @@
+require 'inifile'
+
+class DeployTool::Config
+  def self.all
+    @@configfile.to_h
+  end
+  def self.[](section)
+    @@configfile[section]
+  end
+  def self.[]=(section, value)
+    @@configfile[section] = value
+  end
+  
+  def self.load(filename)
+    @@configfile = IniFile.load(filename)
+  end
+  
+  def self.save
+    @@configfile.save unless @@configfile.to_h.empty?
+  end
+end

data/lib/deploytool/target/cloudfoundry.rb

@@ -0,0 +1,31 @@
+class DeployTool::Target::CloudFoundry < DeployTool::Target
+  def self.parse_target_spec(target_spec)
+    app_name, server = target_spec.split('.', 2)
+    return false if server.nil? or app_name.nil?
+    # Test through multiple versions of API server URLs
+    [target_spec, 'api.' + target_spec, 'api.' + server].each do |api_server|
+      begin
+        if get_json_resource("http://%s/info" % api_server)['name'] == "vcap"
+          app_name = nil if server.gsub('api.') == api_server.gsub('api.')
+          return [app_name, api_server]
+        end
+      rescue => e
+        $logger.debug "Exception: %s\n%s" % [e.message, e.backtrace.join("\n")]
+      end
+    end
+    false
+  end
+  
+  def self.matches?(target_spec)
+    return true if parse_target_spec(target_spec)
+  end
+  
+  def initialize(options)
+    # FIXME
+  end
+  
+  def self.create(target_spec)
+    app_name, api_server = parse_target_spec(target_spec)
+    CloudFoundry.new('api_server' => api_server, 'app_name' => app_name)
+  end
+end

data/lib/deploytool/target/efficientcloud/api_client.rb

@@ -0,0 +1,146 @@
+require 'rexml/document'
+require 'addressable/uri'
+require 'net/http'
+require 'net/http/post/multipart'
+require 'fileutils'
+require 'tempfile'
+require 'zip'
+
+class DeployTool::Target::EfficientCloud
+  class ApiClient
+    attr_reader :server, :app_id, :email, :password
+    def initialize(server, app_id, email, password)
+      @app_id = app_id
+      @server = server
+      @email = email
+      @password = password
+    end
+    
+    def call(method, method_name, data = {})
+      url = Addressable::URI.parse("http://#{@server}/api/cli/v1/apps/#{@app_id}/#{method_name}")
+      data = data.merge(:email => @email, :password => @password)
+      if method == :post
+        res = Net::HTTP.start(url.host, url.port) do |http|
+          http.request Net::HTTP::Post::Multipart.new(url.path, data)
+        end
+      else
+        url.query_values = data
+        res = Net::HTTP.get_response(url)
+      end
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        res.body
+      else  
+        res.error!
+      end
+    end
+    
+    def upload
+      appfiles = Dir.glob('**/*', File::FNM_DOTMATCH).reject {|f| File.directory?(f) || f[/(^|\/).{1,2}$/] || f[/^.git\//] || f[/^.deployrc$/] || f[/(^|\/).DS_Store$/] }
+      
+      # Construct a temporary zipfile
+      tempfile = Tempfile.open("ecli-upload.zip")
+      Zip::ZipOutputStream.open(tempfile.path) do |z|
+        appfiles.each do |appfile|
+          z.put_next_entry appfile
+          z.print IO.read(appfile)
+        end
+      end
+      
+      puts "-----> Uploading %s code tarball..." % human_filesize(tempfile.path)
+      initial_response = call :post, 'upload', {:code => UploadIO.new(tempfile, "application/zip", "ecli-upload.zip")}
+      doc = REXML::Document.new initial_response
+      doc.elements["code/code-token"].text
+    rescue Net::HTTPServerException => e
+      case e.response
+      when Net::HTTPNotFound
+        $logger.error "Application app%d.%s couldn't be found." % [@app_id, @server.gsub('api.', '')]
+      when Net::HTTPUnauthorized
+        $logger.error "You're not authorized to update app%d.%s." % [@app_id, @server.gsub('api.', '')]
+      else
+        raise e
+      end
+      $logger.info "\nPlease check the controlpanel for update instructions."
+      exit 2
+    end
+    
+    def deploy(code_token)
+      initial_response = call :post, 'deploy', {:code_token => code_token}
+      doc = REXML::Document.new initial_response
+      deploy_token = doc.elements["deploy/token"].text
+      deploy_token
+    end
+
+    def save_timing_data(data)
+      File.open('deploytool-timingdata-%d.json' % (Time.now), 'w') do |f|
+        f.puts data.to_json
+      end
+    end
+
+    def deploy_status(deploy_token, opts)
+      start = Time.now
+      timing = []
+      previous_status = nil
+      print "-----> Started deployment '%s'" % deploy_token
+      
+      while true
+        sleep 1
+        resp = call :get, 'deploy_status', {:deploy_token => deploy_token}
+        doc = REXML::Document.new resp
+        
+        if doc.elements["deploy/message"].nil?
+          puts resp
+          puts "...possibly done."
+          break
+        end
+        if doc.elements["deploy/message"].text == 'nojob'
+          puts "\n-----> FINISHED after %d seconds!" % (Time.now-start)
+          break
+        end
+        
+        status = doc.elements["deploy/message"].text.gsub('["', '').gsub('"]', '')
+        if previous_status != status
+          case status
+          when "build"
+            puts "\n-----> Building/updating virtual machine..."
+          when "deploy"
+            print "-----> Copying virtual machine to app hosts"
+          when "publishing"
+            print "\n-----> Updating HTTP gateways"
+          when "cleanup"
+            print "\n-----> Removing old deployments"
+          end
+          previous_status = status
+        end
+        
+        logs = doc.elements["deploy/logs"].text rescue nil
+        if logs
+          puts "" if status != "build" # Add newline after the dots
+          puts logs
+          timing << [Time.now-start, status, logs]
+        else
+          timing << [Time.now-start, status]
+          if status == 'error'
+            if logs.nil? or logs.empty?
+              raise "ERROR after %d seconds!" % (Time.now-start)
+            end
+          elsif status != "build"
+            print "."
+            STDOUT.flush
+          end
+        end
+      end
+    ensure
+      save_timing_data timing if opts[:timing]
+    end
+    
+    def human_filesize(path)
+      size = File.size(path)
+      units = %w{B KB MB GB TB}
+      e = (Math.log(size)/Math.log(1024)).floor
+      s = "%.1f" % (size.to_f / 1024**e)
+      s.sub(/\.?0*$/, units[e])
+    end
+  end
+end
+

data/lib/deploytool/target/efficientcloud.rb

@@ -0,0 +1,68 @@
+require 'highline'
+
+class DeployTool::Target::EfficientCloud < DeployTool::Target
+  SUPPORTED_API_VERSION = 1
+  def self.parse_target_spec(target_spec)
+    server, app_id = target_spec.split('@').reverse
+    if app_id.nil?
+      app_id = server.split('.', 2).first
+    end
+    [server, 'api.' + server, 'api.' + server.split('.', 2).last].each do |api_server|
+      begin
+        return [app_id.gsub('app', '').to_i, api_server] if check_version(api_server)
+      rescue => e
+        puts e
+      end
+    end
+    nil
+  end
+  
+  def self.matches?(target_spec)
+    return true if parse_target_spec(target_spec)
+  end
+  
+  def to_h
+    {:type => "EfficientCloud", :api_server => @api_client.server, :app_id => @api_client.app_id, :email => @api_client.email, :password => @api_client.password}
+  end
+  
+  def to_s
+    "app%s@%s (EFC-based platform)" % [@api_client.app_id, @api_client.server]
+  end
+  
+  def initialize(options)
+    @api_server = options['api_server']
+    @api_client = ApiClient.new(options['api_server'], options['app_id'], options['email'], options['password'])
+  end
+
+  def self.check_version(api_server)
+    begin
+      info = get_json_resource("http://%s/info" % api_server)
+    rescue => e
+      $logger.debug "Exception: %s\n%s" % [e.message, e.backtrace.join("\n")]
+      return false
+    end
+    return false unless info && info['name'] == "efc"
+
+    if info['api_version'] > SUPPORTED_API_VERSION
+      $logger.error "This version of deploytool is outdated.\nThis server requires at least API Version #{info['api_version']}."
+    end
+    return true
+  end
+
+  def self.create(target_spec)
+    $logger.info "Please specify your controlpanel login information"
+    email =    HighLine.new.ask("E-mail:   ")
+    password = HighLine.new.ask("Password: ") {|q| q.echo = "*" }
+    app_id, api_server = parse_target_spec(target_spec)
+    EfficientCloud.new('api_server' => api_server, 'app_id' => app_id, 'email' => email, 'password' => password)
+  end
+  
+  def push(opts)
+    self.class.check_version(@api_server)
+    code_token = @api_client.upload
+    deploy_token = @api_client.deploy(code_token)
+    @api_client.deploy_status(deploy_token, opts) # Blocks till deploy is done
+  end
+end
+
+require 'deploytool/target/efficientcloud/api_client'

data/lib/deploytool/target/heroku.rb

@@ -0,0 +1,30 @@
+class DeployTool::Target::Heroku < DeployTool::Target
+  def self.matches?(target_spec)
+    target_spec[/(^|\.)heroku\.com$/]
+  end
+  
+  def to_h
+    {:type => "Heroku", :app_name => @app_name}
+  end
+  
+  def to_s
+    "%s.heroku.com (Heroku)" % [@app_name]
+  end
+  
+  def initialize(options)
+    @app_name = options['app_name']
+  end
+  
+  def self.create(target_name)
+    app_name = target_name.gsub('.heroku.com', '')
+    # TODO: Require current directory to be a git repository
+    # TODO: Ask for app name if app name is nil or www
+    puts `heroku create #{app_name}`
+    Heroku.new('app_name' => app_name)
+  end
+  
+  def push(opts)
+    puts `git push -f git@heroku.com:#{@app_name}.git master`
+    $?.exitstatus
+  end
+end

data/lib/deploytool/target.rb

@@ -0,0 +1,64 @@
+require 'json'
+
+class Module
+  def track_subclasses
+    instance_eval %{
+        def self.known_subclasses
+          @__deploytool_subclasses
+        end
+        
+        def self.add_known_subclass(s)
+          superclass.add_known_subclass(s) if superclass.respond_to?(:inherited_tracking_subclasses)
+          (@__deploytool_subclasses ||= []) << s
+        end
+        
+        def self.inherited_tracking_subclasses(s)
+          add_known_subclass(s)
+          inherited_not_tracking_subclasses(s)
+        end
+        alias :inherited_not_tracking_subclasses :inherited
+        alias :inherited :inherited_tracking_subclasses
+    }
+  end
+end
+
+class DeployTool::Target
+  track_subclasses
+  
+  def self.find(target_spec)
+    known_subclasses.each do |klass|
+      next unless klass.matches?(target_spec)
+      return klass.create(target_spec)
+    end
+    nil
+  end
+  
+  def self.from_config(config)
+    known_subclasses.each do |klass|
+      next unless klass.to_s.split('::').last == config['type']
+      return klass.new(config)
+    end
+    nil
+  end
+  
+  def self.get_json_resource(url)
+    res = nil
+    begin
+      timeout(5) do
+        res = Net::HTTP.get_response(Addressable::URI.parse(url))
+      end
+    rescue Timeout::Error
+      $logger.debug "Calling '%s' took longer than 5s, skipping" % [url, res.code, res.body]
+      return nil
+    end
+    if res.code != '200'
+      $logger.debug "Calling '%s' returned %s, skipping" % [url, res.code, res.body]
+      return nil
+    end
+    JSON.parse(res.body)
+  end
+end
+
+(Dir.glob(File.dirname(__FILE__)+'/target/*.rb') - [__FILE__]).sort.each do |f|
+  require 'deploytool/target/' + File.basename(f)
+end

data/lib/deploytool/version.rb

@@ -0,0 +1,3 @@
+module DeployTool
+  VERSION = "0.9.0"
+end

data/lib/deploytool.rb

@@ -0,0 +1,4 @@
+module DeployTool; end
+
+require 'deploytool/config'
+require 'deploytool/target'

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+require 'deploytool'
+require 'logger'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+
+$logger = Logger.new File.expand_path('../spec.log', __FILE__)
+$logger.formatter = proc { |severity, datetime, progname, msg|
+  "#{severity} #{datetime.strftime("%Y-%m-%d %H:%M:%S")}: #{msg}\n"
+}

data/spec/target_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe DeployTool::Target do
+  context "Target selection" do
+    before do
+      stub.any_instance_of(HighLine).ask do |q, |
+        if q[/E-mail/]
+          "demo@efficientcloud.com"
+        elsif q[/Password/]
+          "demo"
+        else
+          nil
+        end
+      end
+      
+      # TODO: Mock HTTP get method
+    end
+    
+    ["api.cloudfoundry.com", "cloudfoundry.com", "awesomeapp.cloudfoundry.com"].each do |target_spec| #, "api.cloud.1and1.com", "cloud.1and1.com", "awesomeapp.cloud.1and1.com"].each do
+      it "should detect #{target_spec} as a CloudFoundry target" do
+        DeployTool::Target.find(target_spec).class.should == DeployTool::Target::CloudFoundry
+      end
+    end
+    
+    ["app10000@api.srv.io", "app10000@srv.io", "app10000@app123.srv.io", "app10000.srv.io"].each do |target_spec|
+      it "should detect #{target_spec} as an Efficient Cloud target" do
+        DeployTool::Target.find(target_spec).class.should == DeployTool::Target::EfficientCloud
+      end
+    end
+    
+    ["heroku.com", "awesomeapp.heroku.com"].each do |target_spec|
+      it "should detect #{target_spec} as an Heroku target" do
+        DeployTool::Target.find(target_spec).class.should == DeployTool::Target::Heroku
+      end
+    end
+    
+    ["gandi.net", "1and1.com"].each do |target_spec|
+      it "should return an error with #{target_spec} as target" do
+        DeployTool::Target.find(target_spec).class.should == NilClass
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: deployto
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Efficient Cloud Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: inifile
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: zip
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: heroku
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Deployment tool with support for multiple Platform-as-a-Service providers.
+email: hello@platformdirectory.com
+executables: 
+- deploy
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- bin/deploy
+- lib/deploytool.rb
+- lib/deploytool/command.rb
+- lib/deploytool/config.rb
+- lib/deploytool/target.rb
+- lib/deploytool/target/cloudfoundry.rb
+- lib/deploytool/target/efficientcloud.rb
+- lib/deploytool/target/efficientcloud/api_client.rb
+- lib/deploytool/target/heroku.rb
+- lib/deploytool/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/target_spec.rb
+homepage: http://platformdirectory.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Multi-platform deployment tool.
+test_files: []
+