dpl 0.2.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93221bbb43d418a1d0813b28be7fe51b9831d1d1
+  data.tar.gz: 7fc3ba48af19a3915628e5b8b85b4094205ab7d4
+SHA512:
+  metadata.gz: f349cd28f7099db9283274c761006b35278efda7db13494acdc191692ce7d61f1f2eca6dca00d52fa0c9d24cb3f2a33762c56a5632440da86ac6f7abd12c2827
+  data.tar.gz: a4fe2772182e3d1e45d8c282bafa2b31adf44ca1ad897bfe63fbcdefcd2008e8f749a8d7e360fe0ac674f4a83f2e852ea2290fefab05c319f626cd5e1e1f5676

data/.gitignore

@@ -1 +1,2 @@
-Gemfile.lock
+Gemfile.lock
+.coverage

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby
+  - rbx

data/README.md

@@ -0,0 +1,11 @@
+Deploy tool made for Continuous Deployment.
+
+Usage:
+
+    dpl --provider=heroku --api-key=`heroku auth:token`
+
+Supported providers:
+
+* Heroku
+* Engine Yard (experimental)
+* dotCloud (experimental)

data/Rakefile

@@ -0,0 +1 @@
+task(:default) { ruby '-S rspec' }

data/dpl.gemspec

@@ -15,4 +15,8 @@ Gem::Specification.new do |s|
   s.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_path          = 'lib'
   s.required_ruby_version = '>= 1.8.7'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
 end

data/lib/dpl/cli.rb

@@ -8,7 +8,7 @@ module DPL
     end
 
     OPTION_PATTERN = /\A--([a-z][a-z_\-]*)(?:=(.+))?\z/
-    attr_accessor :options
+    attr_accessor :options, :fold_count
 
     def initialize(*args)
       options = {}
@@ -23,7 +23,8 @@ module DPL
         end
       end
 
-      self.options = default_options.merge(options)
+      self.fold_count = 0
+      self.options    = default_options.merge(options)
     end
 
     def run
@@ -33,6 +34,15 @@ module DPL
       options[:debug] ? raise(error) : die(error.message)
     end
 
+    def fold(message)
+      self.fold_count += 1
+      print "travis_fold:start:dpl.#{fold_count}\r" if options[:fold]
+      puts "\e[33m#{message}\e[0m"
+      yield
+    ensure
+      print "\ntravis_fold:end:dpl.#{fold_count}\r" if options[:fold]
+    end
+
     def default_options
       {
         :app      => File.basename(Dir.pwd),

data/lib/dpl/provider.rb

@@ -11,18 +11,27 @@ module DPL
 
     def self.new(context, options)
       return super if self < Provider
-      name = super.option(:provider).to_s.downcase.gsub(/[^a-z]/, '')
-      raise Error, 'could not find provider %p' % options[:provider] unless name = constants.detect { |c| c.to_s.downcase == name }
-      const_get(name).new(context, options)
+
+      context.fold("Installing deploy dependencies") do
+        name = super.option(:provider).to_s.downcase.gsub(/[^a-z]/, '')
+        raise Error, 'could not find provider %p' % options[:provider] unless name = constants.detect { |c| c.to_s.downcase == name }
+        const_get(name).new(context, options)
+      end
+    end
+
+    def self.experimental(name)
+      puts "", "!!! #{name} support is experimental !!!", ""
     end
 
-    def self.requires(name, version = "> 0")
+    def self.requires(name, options = {})
+      version = options[:version] || '> 0'
+      load    = options[:load]    || name
       gem(name, version)
     rescue LoadError
       system("gem install %s -v %p" % [name, version])
       Gem.clear_paths
     ensure
-      require name
+      require load
     end
 
     def self.pip(name, command = name)
@@ -43,19 +52,21 @@ module DPL
       rm_rf ".dpl"
       mkdir_p ".dpl"
 
-      check_auth
-      check_app
+      context.fold("Preparing deploy") do
+        check_auth
+        check_app
 
-      if needs_key?
-        create_key(".dpl/id_rsa")
-        setup_key(".dpl/id_rsa.pub")
-        setup_git_ssh(".dpl/git-ssh", ".dpl/id_rsa")
+        if needs_key?
+          create_key(".dpl/id_rsa")
+          setup_key(".dpl/id_rsa.pub")
+          setup_git_ssh(".dpl/git-ssh", ".dpl/id_rsa")
+        end
       end
 
-      push_app
+      context.fold("Deploying application") { push_app }
 
       Array(options[:run]).each do |command|
-        run(command)
+        context.fold("Running %p" % command) { run(command) }
       end
     ensure
       remove_key if needs_key?

data/lib/dpl/provider/dot_cloud.rb

@@ -1,12 +1,17 @@
 module DPL
   class Provider
     class DotCloud < Provider
+      experimental "dotCloud"
       pip 'dotcloud'
 
       def check_auth
         system "echo #{option(:api_key)} | dotcloud setup --api-key"
       end
 
+      def check_app
+        `dotcloud connect #{option(:app)}`
+      end
+
       def needs_key?
         false
       end
@@ -16,7 +21,7 @@ module DPL
       end
 
       def run(command)
-        service = option[:instance] || option[:service] || 'www'
+        service = options[:instance] || options[:service] || 'www'
         `dotcloud -A #{option(:app)} #{service} #{command}`
       end
     end

data/lib/dpl/provider/engine_yard.rb

@@ -1,6 +1,8 @@
 module DPL
   class Provider
     class EngineYard < Provider
+      experimental "Engine Yard"
+
       requires 'engineyard'
       requires 'engineyard-cloud-client'
 

data/lib/dpl/provider/heroku.rb

@@ -1,48 +1,16 @@
 module DPL
   class Provider
-    class Heroku < Provider
-      requires 'heroku-api'
-      requires 'rendezvous'
+    module Heroku
+      autoload :Anvil, 'dpl/provider/heroku/anvil'
+      autoload :Git,   'dpl/provider/heroku/git'
 
-      def api
-        @api ||= ::Heroku::API.new(:api_key => option(:api_key)) unless options[:user] and options[:password]
-        @api ||= ::Heroku::API.new(:user => options[:user], :password => options[:password])
-      end
-
-      def check_auth
-        log "authenticated as %s" % api.get_user.body["email"]
-      end
-
-      def check_app
-        info = api.get_app(option(:app)).body
-        options[:git] ||= info['git_url']
-        log "found app #{info['name']}"
-      end
-
-      def setup_key(file)
-        api.post_key File.read(file)
-      end
-
-      def remove_key
-        api.delete_key(option(:key_name))
-      end
-
-      def push_app
-        system "git push #{option(:git)} HEAD:master -f"
-      end
-
-      def run(command)
-        data           = api.post_ps(option(:app), command, :attach => true).body
-        rendezvous_url = data['rendezvous_url']
-        Rendezvous.start(:url => rendezvous_url) unless rendezvous_url.nil?
-      end
+      extend self
 
-      def deploy
-        super
-      rescue ::Heroku::API::Errors::NotFound=> error
-        raise Error, "#{error.message} (wrong app #{options[:app].inspect}?)", error.backtrace
-      rescue ::Heroku::API::Errors::Unauthorized => error
-        raise Error, "#{error.message} (wrong API key?)", error.backtrace
+      def new(context, options)
+        strategy = options[:strategy] || 'anvil'
+        constant = constants.detect { |c| c.to_s.downcase == strategy }
+        raise Error, 'unknown strategy %p' % strategy unless constant
+        const_get(constant).new(context, options)
       end
     end
   end

data/lib/dpl/provider/heroku/anvil.rb

@@ -0,0 +1,49 @@
+module DPL
+  class Provider
+    module Heroku
+      class Anvil < Git
+        requires 'anvil-cli', :load => 'anvil/engine'
+        requires 'excon' # comes with heroku
+        requires 'json'
+
+        def api
+          raise Error, 'anvil deploy strategy only works with api_key' unless options[:api_key]
+          super
+        end
+
+        def needs_key?
+          false
+        end
+
+        def push_app
+          response = Excon.post release_url,
+            :body    => { "slug_url" => slug_url, "description" => "Travis CI deploy" }.to_json,
+            :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+
+          print "\nDeploying slug "
+          while response.status == 202
+            location = response.headers['Location']
+            response = Excon.get("https://:#{option(:api_key)}@cisaurus.heroku.com#{location}")
+            sleep(1)
+            print '.'
+          end
+
+          puts
+          raise Error, 'deploy failed' unless response.status == 200
+        end
+
+        def slug_url
+          @slug_url ||= begin
+            ::Anvil.headers["X-Heroku-User"] = user
+            ::Anvil.headers["X-Heroku-App"]  = option(:app)
+            ::Anvil::Engine.build "."
+          end
+        end
+
+        def release_url
+          "https://:#{option(:api_key)}@cisaurus.heroku.com/v1/apps/#{option(:app)}/release"
+        end
+      end
+    end
+  end
+end

data/lib/dpl/provider/heroku/git.rb

@@ -0,0 +1,55 @@
+module DPL
+  class Provider
+    module Heroku
+      class Git < Provider
+        requires 'heroku-api'
+        requires 'rendezvous'
+
+        def api
+          @api ||= ::Heroku::API.new(:api_key => option(:api_key)) unless options[:user] and options[:password]
+          @api ||= ::Heroku::API.new(:user => options[:user], :password => options[:password])
+        end
+
+        def user
+          @user ||= api.get_user.body["email"]
+        end
+
+        def check_auth
+          log "authenticated as %s" % user
+        end
+
+        def check_app
+          info = api.get_app(option(:app)).body
+          options[:git] ||= info['git_url']
+          log "found app #{info['name']}"
+        end
+
+        def setup_key(file)
+          api.post_key File.read(file)
+        end
+
+        def remove_key
+          api.delete_key(option(:key_name))
+        end
+
+        def push_app
+          system "git push #{option(:git)} HEAD:master -f"
+        end
+
+        def run(command)
+          data           = api.post_ps(option(:app), command, :attach => true).body
+          rendezvous_url = data['rendezvous_url']
+          Rendezvous.start(:url => rendezvous_url) unless rendezvous_url.nil?
+        end
+
+        def deploy
+          super
+        rescue ::Heroku::API::Errors::NotFound => error
+          raise Error, "#{error.message} (wrong app #{options[:app].inspect}?)", error.backtrace
+        rescue ::Heroku::API::Errors::Unauthorized => error
+          raise Error, "#{error.message} (wrong API key?)", error.backtrace
+        end
+      end
+    end
+  end
+end

data/lib/dpl/version.rb

@@ -1,3 +1,3 @@
 module DPL
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/notes/dotcloud.md

@@ -0,0 +1,8 @@
+Destroy and redeploy a service:
+
+```
+dotcloud destroy -A <appname> <stateless service>
+dotcloud deploy latest
+```
+
+https://dotcloud.zendesk.com/requests/23637

data/notes/engine_yard.md

@@ -0,0 +1 @@
+EY has a a special deploy app. Get in touch with Kevin Holler if we don't hear back from them.

data/notes/heroku.md

@@ -0,0 +1,3 @@
+Heroku might send out emails for new deploy keys (doesn't do it for me, but for some others).
+
+Alternative is Anvil, but it's not perfect, as it duplicates a lot of Heroku logic internally (and failed for me in one case).

data/spec/cli_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'dpl/cli'
+
+describe DPL::CLI do
+  describe :options do
+    example { described_class.new.options[:app]                           .should be == File.basename(Dir.pwd) }
+    example { described_class.new(:app => 'foo')            .options[:app].should be == 'foo'                  }
+    example { described_class.new("--app=foo")              .options[:app].should be == 'foo'                  }
+    example { described_class.new("--app")                  .options[:app].should be == true                   }
+    example { described_class.new("--app=foo", "--app=bar") .options[:app].should be == ['foo', 'bar']         }
+
+    example "error handling" do
+      $stderr.should_receive(:puts).with('invalid option "app"')
+      expect { described_class.new("app") }.to raise_error(SystemExit)
+    end
+  end
+
+  describe :run do
+    example "triggers deploy" do
+      provider = stub('provider')
+      DPL::Provider.should_receive(:new).and_return(provider)
+      provider.should_receive(:deploy)
+
+      described_class.run("--provider=foo")
+    end
+
+    example "error handling" do
+      $stderr.should_receive(:puts).with('missing provider')
+      expect { described_class.run }.to raise_error(SystemExit)
+    end
+
+    example "error handling in debug mode" do
+      expect { described_class.run("--debug") }.to raise_error(DPL::Error, 'missing provider')
+    end
+  end
+end

data/spec/provider/heroku_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'heroku-api'
+require 'dpl/provider/heroku'
+
+describe DPL::Provider::Heroku do
+  subject :provider do
+    described_class.new(nil, :app => 'example', :key_name => 'key', :api_key => "foo", :strategy => "git")
+  end
+
+  describe :api do
+    it 'accepts an api key' do
+      api = stub(:api)
+      ::Heroku::API.should_receive(:new).with(:api_key => "foo").and_return(api)
+      provider.api.should be == api
+    end
+
+    it 'accepts a user and a password' do
+      api = stub(:api)
+      provider.options.update(:user => "foo", :password => "bar")
+      ::Heroku::API.should_receive(:new).with(:user => "foo", :password => "bar").and_return(api)
+      provider.api.should be == api
+    end
+  end
+
+  context "with fake api" do
+    let :api do
+      stub "api",
+        :get_user => stub("get_user", :body => { "email" => "foo@bar.com" }),
+        :get_app  => stub("get_app",  :body => { "name"  => "example", "git_url" => "GIT URL" })
+    end
+
+    before do
+      ::Heroku::API.should_receive(:new).and_return(api)
+      provider.api
+    end
+
+    its(:api) { should be == api }
+
+    describe :check_auth do
+      example do
+        provider.should_receive(:log).with("authenticated as foo@bar.com")
+        provider.check_auth
+      end
+    end
+
+    describe :check_app do
+      example do
+        provider.should_receive(:log).with("found app example")
+        provider.check_app
+        provider.options[:git].should be == "GIT URL"
+      end
+    end
+
+    describe :setup_key do
+      example do
+        File.should_receive(:read).with("the file").and_return("foo")
+        api.should_receive(:post_key).with("foo")
+        provider.setup_key("the file")
+      end
+    end
+
+    describe :remove_key do
+      example do
+        api.should_receive(:delete_key).with("key")
+        provider.remove_key
+      end
+    end
+
+    describe :push_app do
+      example do
+        provider.options[:git] = "git://something"
+        provider.should_receive(:system).with("git push git://something HEAD:master -f")
+        provider.push_app
+      end
+    end
+
+    describe :run do
+      example do
+        data = stub("data", :body => { "rendezvous_url" => "rendezvous url" })
+        api.should_receive(:post_ps).with("example", "that command", :attach => true).and_return(data)
+        Rendezvous.should_receive(:start).with(:url => "rendezvous url")
+        provider.run("that command")
+      end
+    end
+
+    describe :deploy do
+      example "not found error" do
+        provider.should_receive(:api) { raise ::Heroku::API::Errors::NotFound.new("the message", nil) }.at_least(:once)
+        expect { provider.deploy }.to raise_error(DPL::Error, 'the message (wrong app "example"?)')
+      end
+
+      example "unauthorized error" do
+        provider.should_receive(:api) { raise ::Heroku::API::Errors::Unauthorized.new("the message", nil) }.at_least(:once)
+        expect { provider.deploy }.to raise_error(DPL::Error, 'the message (wrong API key?)')
+      end
+    end
+  end
+end

data/spec/provider_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'dpl/provider'
+
+describe DPL::Provider do
+  let(:example_provider) { Class.new(described_class)}
+  subject(:provider) { example_provider.new(nil, :app => 'example', :key_name => 'foo', :run => ["foo", "bar"]) }
+
+  before { described_class.const_set(:Example, example_provider) }
+  after { described_class.send(:remove_const, :Example) }
+
+  describe :new do
+    example { described_class.new(nil, :provider => "example") .should be_an(example_provider) }
+    example { described_class.new(nil, :provider => "Example") .should be_an(example_provider) }
+    example { described_class.new(nil, :provider => "exa_mple").should be_an(example_provider) }
+    example { described_class.new(nil, :provider => "exa-mple").should be_an(example_provider) }
+  end
+
+  describe :requires do
+    before do
+      example_provider.should_receive(:require).with("foo")
+    end
+
+    example "installed" do
+      example_provider.should_receive(:gem).with("foo", "~> 1.4")
+      example_provider.requires("foo", :version => "~> 1.4")
+    end
+
+    example "missing" do
+      example_provider.should_receive(:gem).with("foo", "~> 1.4").and_raise(LoadError)
+      example_provider.should_receive(:system).with('gem install foo -v "~> 1.4"')
+      example_provider.requires("foo", :version => "~> 1.4")
+    end
+  end
+
+  describe :pip do
+    example "installed" do
+      example_provider.should_receive(:`).with("which foo").and_return("/bin/foo\n")
+      example_provider.should_not_receive(:system)
+      example_provider.pip("foo")
+    end
+
+    example "missing" do
+      example_provider.should_receive(:`).with("which foo").and_return("")
+      example_provider.should_receive(:system).with("pip install foo")
+      example_provider.pip("foo")
+    end
+  end
+
+  describe :deploy do
+    before do
+      provider.should_receive(:check_auth)
+      provider.should_receive(:check_app)
+      provider.should_receive(:push_app)
+      provider.should_receive(:run).with("foo")
+      provider.should_receive(:run).with("bar")
+    end
+
+    example "needs key" do
+      provider.should_receive(:remove_key)
+      provider.should_receive(:create_key)
+      provider.should_receive(:setup_key)
+      provider.should_receive(:setup_git_ssh)
+      provider.deploy
+    end
+
+    example "does not need key" do
+      provider.stub(:needs_key?, false)
+      provider.deploy
+    end
+  end
+
+  describe :create_key do
+    example do
+      provider.should_receive(:system).with('ssh-keygen -t rsa -N "" -C foo -f thekey')
+      provider.create_key('thekey')
+    end
+  end
+
+  describe :setup_git_ssh do
+    after { FileUtils.rm ENV.delete('GIT_SSH') }
+
+    example do
+      provider.setup_git_ssh('foo', 'bar')
+      ENV['GIT_SSH'].should be == File.expand_path('foo')
+    end
+  end
+
+  describe :log do
+    example do
+      $stderr.should_receive(:puts).with("foo")
+      provider.log("foo")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+
+SimpleCov.start do
+  coverage_dir '.coverage'
+
+  add_filter "/spec/"
+  add_group 'Library', 'lib'
+end

metadata

@@ -1,16 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: dpl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Konstantin Haase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
-dependencies: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: deploy tool abstraction for clients
 email: konstantin.mailinglists@googlemail.com
 executables:
@@ -20,7 +61,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- README.md
+- Rakefile
 - bin/dpl
 - dpl.gemspec
 - lib/dpl/cli.rb
@@ -29,31 +73,43 @@ files:
 - lib/dpl/provider/dot_cloud.rb
 - lib/dpl/provider/engine_yard.rb
 - lib/dpl/provider/heroku.rb
+- lib/dpl/provider/heroku/anvil.rb
+- lib/dpl/provider/heroku/git.rb
 - lib/dpl/version.rb
+- notes/dotcloud.md
+- notes/engine_yard.md
+- notes/heroku.md
+- spec/cli_spec.rb
+- spec/provider/heroku_spec.rb
+- spec/provider_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/rkh/dpl
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: deploy tool
-test_files: []
+test_files:
+- spec/cli_spec.rb
+- spec/provider/heroku_spec.rb
+- spec/provider_spec.rb
+- spec/spec_helper.rb
 has_rdoc: