harrison 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.2.0
+-------------------
+- Implemented the ability to purge old releases after a successful deploy.
+
 0.1.0
 -------------------
 - Renamed --pkg_dir option of 'package' task to --destination

data/IDEAS

@@ -1,5 +1,6 @@
 Ideas:
 ------
+[ ] Split deploy into distinct stages (e.g. pre-deploy, deploy, post-deploy) and ensure stage succeeds on each host before attempting next stage.
 [ ] Allow more elaborate hosts config, e.g.: h.hosts = [ { host: '10.16.18.207', tags: %w(util migrate) } ]
 [ ] Some kind of --dry-run option.
 [ ] Allow deploy_via to include alternate user/connection options.
@@ -9,4 +10,3 @@ Ideas:
 [ ] Something like a "status" command that shows what commit is live for env (on each host?)
 [ ] Move artifacts out of pkg/ (and into like pkg/deployed) once they have been deployed? (Some sort of flag for the significant env?)
 [ ] Include branch name in artifact file name.
-[ ] Make --purge the default behavior for the package step.

data/README.md

@@ -2,7 +2,7 @@
 
 Simple artifact-based deployment for web applications.
 
-[![Build Status](https://travis-ci.org/scotje/harrison.svg?branch=master)](https://travis-ci.org/scotje/harrison)
+[![Build Status](https://travis-ci.org/puppetlabs/harrison.svg?branch=master)](https://travis-ci.org/puppetlabs/harrison)
 
 ## Installation
 
@@ -26,7 +26,7 @@ First, create a Harrisonfile in the root of your project. Here's an example:
 # Project-wide Config
 Harrison.config do |h|
   h.project = 'harrison'
-  h.git_src = "git@github.com:scotje/harrison.git"
+  h.git_src = "git@github.com:puppetlabs/harrison.git"
 end
 
 Harrison.package do |h|
@@ -157,12 +157,16 @@ else
 end
 ```
 
+You can use the `--keep` option (or set it in the deploy section of your Harrisonfile) to specify the total number of
+deploys you want to retain on each server after a successful deployment. The default is to keep all previous deploys
+around indefinitely.
+
 There are some additional options available, run `harrison deploy --help` to see everything available.
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/scotje/harrison/fork )
+1. Fork it ( https://github.com/puppetlabs/harrison/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/harrison.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jesse Scott"]
   spec.email         = ["jesse@puppetlabs.com"]
   spec.summary       = %q{Simple artifact-based deployment for web applications.}
-  spec.homepage      = "https://github.com/scotje/harrison"
+  spec.homepage      = "https://github.com/puppetlabs/harrison"
   spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/harrison/deploy.rb

@@ -11,11 +11,13 @@ module Harrison
       self.class.option_helper(:env)
       self.class.option_helper(:base_dir)
       self.class.option_helper(:deploy_via)
+      self.class.option_helper(:keep)
 
       # Command line opts for this action. Will be merged with common opts.
       arg_opts = [
         [ :hosts, "List of remote hosts to deploy to. Can also be specified in Harrisonfile.", :type => :strings ],
         [ :env, "Environment to deploy to. This can be examined in your Harrisonfile to calculate target hosts.", :type => :string ],
+        [ :keep, "Number of recent deploys to keep after a successful deploy. (Including the most recent deploy.) Defaults to keeping all deploys forever.", :type => :integer ],
       ]
 
       super(arg_opts, opts)
@@ -88,12 +90,42 @@ module Harrison
         # Run user supplied deploy code to restart server or whatever.
         super
 
+        # Cleanup old releases if a keep value is set.
+        if (self.keep)
+          cleanup_deploys(self.keep)
+          cleanup_releases
+        end
+
         close(self.host)
       end
 
       puts "Sucessfully deployed #{artifact} to #{hosts.join(', ')}."
     end
 
+    def cleanup_deploys(limit)
+      # Grab a list of deploys to be removed.
+      purge_deploys = self.deploys.sort.reverse.slice(limit..-1) || []
+
+      if purge_deploys.size > 0
+        puts "Purging #{purge_deploys.size} old deploys on #{self.host}, keeping #{limit}..."
+
+        purge_deploys.each do |stale_deploy|
+          remote_exec("cd deploys && rm -f #{stale_deploy}")
+        end
+      end
+    end
+
+    def cleanup_releases
+      # Figure out which releases need to be kept.
+      keep_releases = self.active_releases
+
+      self.releases.each do |release|
+        unless keep_releases.include?(release)
+          remote_exec("cd releases && rm -rf #{release}")
+        end
+      end
+    end
+
     def close(host=nil)
       if host
         @_conns[host].close if @_conns && @_conns[host]
@@ -114,5 +146,20 @@ module Harrison
     def remote_project_dir
       "#{base_dir}/#{project}"
     end
+
+    # Return a sorted list of deploys, unsorted.
+    def deploys
+      remote_exec("cd deploys && ls -1").split("\n")
+    end
+
+    # Return a list of all releases, unsorted.
+    def releases
+      remote_exec("cd releases && ls -1").split("\n")
+    end
+
+    # Return a list of releases with at least 1 deploy pointing to them, unsorted.
+    def active_releases
+      self.deploys.collect { |deploy| remote_exec("cd deploys && basename `readlink #{deploy}`") }.uniq
+    end
   end
 end

data/lib/harrison/version.rb

@@ -1,3 +1,3 @@
 module Harrison
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/unit/harrison/deploy_spec.rb

@@ -121,6 +121,17 @@ describe Harrison::Deploy do
           expect(output).to include('host1', 'host2', 'host3')
         end
 
+        it 'should clean up old releases if passed a --keep option' do
+          instance.keep = 3
+
+          expect(instance).to receive(:cleanup_deploys).with(3)
+          expect(instance).to receive(:cleanup_releases)
+
+          output = capture(:stdout) do
+            instance.run
+          end
+        end
+
         context 'when deploying from a remote artifact source' do
           before(:each) do
             instance.artifact = 'test_user@test_host1:/tmp/test_artifact.tar.gz'
@@ -150,6 +161,39 @@ describe Harrison::Deploy do
       end
     end
 
+    describe '#cleanup_deploys' do
+      before(:each) do
+        allow(instance).to receive(:deploys).and_return([ 'deploy_1', 'deploy_2', 'deploy_3', 'deploy_4', 'deploy_5' ])
+      end
+
+      it 'should remove deploys beyond the passed in limit' do
+        expect(instance).to receive(:remote_exec).with(/rm -f deploy_2/).and_return('')
+        expect(instance).to receive(:remote_exec).with(/rm -f deploy_1/).and_return('')
+
+        output = capture(:stdout) do
+          instance.cleanup_deploys(3)
+        end
+
+        expect(output).to include('purging', 'deploys', 'keeping 3')
+      end
+    end
+
+    describe '#cleanup_releases' do
+      before(:each) do
+        allow(instance).to receive(:releases).and_return([ 'release_1', 'release_2', 'release_3', 'release_4', 'release_5' ])
+        allow(instance).to receive(:active_releases).and_return([ 'release_3', 'release_4', 'release_5' ])
+      end
+
+      it 'should remove inactive releases' do
+        expect(instance).to receive(:remote_exec).with(/rm -rf release_1/).and_return('')
+        expect(instance).to receive(:remote_exec).with(/rm -rf release_2/).and_return('')
+
+        capture(:stdout) do
+          instance.cleanup_releases
+        end
+      end
+    end
+
     describe '#close' do
       before(:each) do
         @test_host1_ssh = double(:ssh, 'closed?' => false)
@@ -204,5 +248,72 @@ describe Harrison::Deploy do
         expect(instance.send(:remote_project_dir)).to include('/test_base_dir', 'test_project')
       end
     end
+
+    describe '#deploys' do
+      it 'should invoke ls in the correct directory on the remote server' do
+        expect(instance).to receive(:remote_exec).with(/deploys.*ls -1/).and_return('')
+
+        instance.send(:deploys)
+      end
+
+      it 'should return an array of deploys' do
+        expect(instance).to receive(:remote_exec).and_return("deploy_1\ndeploy_2\ndeploy_3\n")
+
+        deploys = instance.send(:deploys)
+
+        expect(deploys).to respond_to(:size)
+        expect(deploys.size).to be 3
+      end
+    end
+
+    describe '#releases' do
+      it 'should invoke ls in the correct directory on the remote server' do
+        expect(instance).to receive(:remote_exec).with(/releases.*ls -1/).and_return('')
+
+        instance.send(:releases)
+      end
+
+      it 'should return an array of releases' do
+        expect(instance).to receive(:remote_exec).and_return("release_1\nrelease_2\nrelease_3\n")
+
+        releases = instance.send(:releases)
+
+        expect(releases).to respond_to(:size)
+        expect(releases.size).to be 3
+      end
+    end
+
+    describe '#active_releases' do
+      before(:each) do
+        allow(instance).to receive(:remote_exec).with(/readlink/) do |cmd|
+          "release_" + /`readlink deploy_([0-9]+)`/.match(cmd).captures[0]
+        end
+      end
+
+      it 'should return an array of releases' do
+        expect(instance).to receive(:deploys).and_return([ 'deploy_3', 'deploy_4', 'deploy_5' ])
+
+        active_releases = instance.send(:active_releases)
+
+        expect(active_releases).to respond_to(:size)
+        expect(active_releases.size).to be 3
+      end
+
+      it 'should only return distinct releases' do
+        expect(instance).to receive(:deploys).and_return([ 'deploy_3', 'deploy_4', 'deploy_5', 'deploy_3' ])
+
+        active_releases = instance.send(:active_releases)
+
+        expect(active_releases.size).to be 3
+      end
+
+      it 'should return releases corresponding to given deploys' do
+        expect(instance).to receive(:deploys).and_return([ 'deploy_3' ])
+
+        active_releases = instance.send(:active_releases)
+
+        expect(active_releases).to include('release_3')
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harrison
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -174,7 +174,7 @@ files:
 - spec/unit/harrison/package_spec.rb
 - spec/unit/harrison/ssh_spec.rb
 - spec/unit/harrison_spec.rb
-homepage: https://github.com/scotje/harrison
+homepage: https://github.com/puppetlabs/harrison
 licenses:
 - Apache 2.0
 post_install_message: 
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1749031995180641465
+      hash: 1433589896306598119
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.29