zilkey-auto_tagger 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,6 @@
 # AutoTagger
 
-AutoTagger allows you to create a date-stamped tag for each stage of your deployment, and deploy from the last tag from the previous environment.
+AutoTagger is a gem that helps you automatically create a date-stamped tag for each stage of your deployment, and deploy from the last tag from the previous environment.
 
 Let's say you have the following workflow:
 
@@ -10,9 +10,38 @@ Let's say you have the following workflow:
 
 You can use the `autotag` command to tag releases on your CI box, then use the capistrano tasks to auto-tag each release.
 
+## Installation
+
+    gem sources -a http://gems.github.com
+    sudo gem install zilkey-auto_tagger
+
+## Contribute
+
+  * [Tracker Project](http://www.pivotaltracker.com/projects/11988)
+  * [GitHub Repository](http://github.com/zilkey/auto_tagger/tree/master)
+
+## The autotag executable
+
+Installing the gem creates an executable file named autotag, which takes two arguments: the stage, and optionally the path to the git repo:
+
+    $ autotag demo  # => creates a tag like demo/200804041234 in the current directory
+    $ autotag demo . # => same as above
+    $ autotag demo /Users/me/foo # => cd's to /Users/me/foo before creating the tag
+
+Running autotag does the following:
+
+    $ git fetch origin --tags
+    $ git tag <stage>/<timestamp>
+    $ git push origin --tags
+
 ## Capistrano Integration
 
-Example deploy file:
+AutoTagger comes with 2 capistrano tasks: 
+
+  * `release_tagger:set_branch` tries to set the branch to the last tag from the previous environment.
+  * `release_tagger:create_tag` runs autotag for the current stage
+
+Example `config/deploy.rb` file:
 
     require 'release_tagger'
 
@@ -35,7 +64,7 @@ Example deploy file:
 
     # You need to add the before/ater callbacks yourself
     before "deploy:update_code", "release_tagger:set_branch"
-    after  "deploy:update_code", "release_tagger:create_tag"
+    after  "deploy", "release_tagger:create_tag"
 
 Assume you have the following tags in your git repository:
 
@@ -45,32 +74,13 @@ Assume you have the following tags in your git repository:
 
 The deployments would look like this:
 
-    cap staging deploy    # => ci/01
-    cap production deploy # => staging/01
+    cap staging deploy    # => sets branch to ci/01
+    cap production deploy # => sets branch to staging/01
 
 You can override with with the -Shead and -Stag options
 
-    cap staging deploy -Shead=true      # => master
-    cap staging deploy -Stag=staging/01 # => staging/01
-
-## The autotag executable
-
-    autotag -h
-    autotag demo
-    autotag demo .
-    autotag demo /Users/me/foo
-
-## Known Issues
-
-  * DOES NOT work with capistrano ext multi-stage
-  * It will accept invalid tag names (if you specify a tag name with a space, it will blow up when you try to create the tag)
-
-## Things that might be useful
-
-  * Make it possible to define a different remote other than "origin"
-  * Make it possible to define a different default branch other than "master"
-  * Make it work with either cap-ext multistage or single-file deploy.rb files
-  * Make it possible to provide your own tag naming convention (like the PaperClip string interpolation), instead of relying on <prefix>/<timestamp>
+    cap staging deploy -Shead=true      # => sets branch to master
+    cap staging deploy -Stag=staging/01 # => sets branch to staging/01
 
 ## Links
 

data/lib/auto_tagger/auto_tagger.rb

@@ -11,9 +11,9 @@ class AutoTagger
     @stage = stage
   end
 
-  def create_tag
+  def create_tag(commit = nil)
     repository.tags.fetch
-    new_tag = repository.tags.create(stage)
+    new_tag = repository.tags.create(stage, commit)
     repository.tags.push
     new_tag
   end

data/lib/auto_tagger/capistrano_helper.rb

@@ -1,26 +1,16 @@
 class CapistranoHelper
 
-  class NoStagesSpecifiedError < StandardError
-    def message
-      "You must set the :stages variable to an array, like set :stages, [:ci, :demo]"
-    end
-  end
-  
-  attr_reader :variables, :stages, :current_stage, :working_directory
+  attr_reader :variables, :current_stage, :working_directory
 
   def initialize(variables)
-    raise NoStagesSpecifiedError unless variables[:stages]
+    @stage_manager = StageManager.new(variables[:stages])
     @variables = variables
-    @stages = variables[:stages]
     @current_stage = variables[:current_stage]
     @working_directory = variables[:working_directory] || Dir.pwd
   end
 
   def previous_stage
-    if current_stage
-      index = stages.index(current_stage) - 1
-      stages[index] if index > -1 
-    end
+    @stage_manager.previous_stage(current_stage)
   end
 
   def branch
@@ -35,4 +25,15 @@ class CapistranoHelper
     end
   end
 
+  def release_tag_entries
+    entries = []
+    @stage_manager.stages.each do |stage|
+      tagger = AutoTagger.new(stage, working_directory)
+      tag = tagger.latest_tag
+      commit = tagger.repository.commit_for(tag)
+      entries << "#{stage.to_s.ljust(10, " ")} #{tag.to_s.ljust(30, " ")} #{commit.to_s}"
+    end
+    entries
+  end
+
 end

data/lib/auto_tagger/repository.rb

@@ -27,6 +27,10 @@ class Repository
     @tags ||= Tag.new(self)
   end
   
+  def commit_for(tag)
+    Commander.execute(path, "git --no-pager log #{tag} --pretty=oneline -1")
+  end
+  
   def run(cmd)
     Commander.execute(path, cmd)
   end

data/lib/auto_tagger/stage_manager.rb

@@ -0,0 +1,23 @@
+class StageManager
+
+  class NoStagesSpecifiedError < StandardError
+    def message
+      "You must set the :stages variable to an array, like set :stages, [:ci, :demo]"
+    end
+  end
+  
+  attr_reader :stages
+  
+  def initialize(stages)
+    raise NoStagesSpecifiedError unless stages && stages.is_a?(Array)
+    @stages = stages
+  end
+  
+  def previous_stage(current_stage)
+    if current_stage
+      index = stages.index(current_stage) - 1
+      stages[index] if index > -1 
+    end
+  end
+  
+end

data/lib/auto_tagger/tag.rb

@@ -1,3 +1,5 @@
+# git --no-pager log --pretty=oneline -1
+# git tag -a -m 'Successful continuous integration build on #{timestamp}' #{tag_name}"
 class Tag
   
   attr_reader :repository
@@ -22,10 +24,11 @@ class Tag
     repository.run! "git push origin --tags"
   end
     
-  def create(stage)
-    # git tag -a -m 'Successful continuous integration build on #{timestamp}' #{tag_name}"
+  def create(stage, commit = nil)
     tag_name = name_for(stage)
-    repository.run! "git tag #{tag_name}"
+    cmd = "git tag #{tag_name}"
+    cmd += " #{commit}" if commit
+    repository.run! cmd
     tag_name
   end
   

data/lib/auto_tagger.rb

@@ -3,6 +3,7 @@
   'repository',
   'tag',
   'auto_tagger',
+  'stage_manager',
   'capistrano_helper'
 ].each do |file|
   require File.expand_path(File.join(File.dirname(__FILE__), "auto_tagger", file))

data/recipes/release_tagger.rb

@@ -11,15 +11,41 @@ Capistrano::Configuration.instance(:must_exist).load do
         set :branch, branch_name
         logger.info "setting branch to #{branch_name}"
       else
-        logger.info "AUTO TAGGER WARNING: skipping auto-assignment of branch.  Branch will remain the default.}"
+        logger.info "AUTO TAGGER: skipping auto-assignment of branch.  Branch will remain the default.}"
+      end
+    end
+
+    desc %Q{Prints the most current tags from all stages}
+    task :print_latest_tags, :roles => :app do
+      logger.info "AUTO TAGGER: release tag history is:"
+      entries = CapistranoHelper.new(variables).release_tag_entries
+      entries.each do |entry|
+        logger.info entry
+      end
+    end
+
+    desc %Q{Reads the text file with the latest tag from the shared directory}
+    task :read_tag_from_shared, :roles => :app do
+      logger.info "AUTO TAGGER: latest tag deployed to this environment was:"
+      run "cat #{shared_path}/released_git_tag.txt"
+    end
+
+    desc %Q{Writes the tag name to a file in the shared directory}
+    task :write_tag_to_shared, :roles => :app do
+      if exists?(:branch)
+        logger.info "AUTO TAGGER: writing tag to shared text file on remote server"
+        run "echo '#{branch}' > #{shared_path}/released_git_tag.txt"
+      else
+        logger.info "AUTO TAGGER: no branch available.  Text file was not written to server"
       end
     end
 
     desc %Q{Creates a tag using the current_stage variable}
-    task :create_tag do
+    task :create_tag, :roles => :app do
       if variables[:current_stage]
-        tag_name = AutoTagger.new(variables[:current_stage], variables[:working_directory]).create_tag
-        logger.info "created and pushed tag #{tag_name}"
+        previous_tag = AutoTagger.new(StageManager.new(stages).previous_stage(current_stage), Dir.pwd).latest_tag
+        tag_name = AutoTagger.new(variables[:current_stage], variables[:working_directory]).create_tag(previous_tag)
+        logger.info "AUTO TAGGER created tag #{tag_name} from #{previous_tag.inspect}"
       else
         logger.info "AUTO TAGGER WARNING: skipping auto-creation of tag.  Please specify :current_stage to enable auto-creation of tags (like set :current_stage, :ci)."
       end

data/spec/auto_tagger/auto_tagger_spec.rb

@@ -43,6 +43,19 @@ describe AutoTagger do
       
       AutoTagger.new("ci", "/foo").create_tag
     end
+
+    it "allows you to base it off an existing tag or commit" do
+      time = Time.local(2001,1,1)
+      mock(Time).now.once {time}
+      timestamp = time.utc.strftime('%Y%m%d%H%M%S')
+      mock(File).exists?(anything).twice { true }
+
+      mock(Commander).execute!("/foo", "git fetch origin --tags") {true}
+      mock(Commander).execute!("/foo", "git tag ci/#{timestamp} guid") {true}
+      mock(Commander).execute!("/foo", "git push origin --tags")  {true}
+      
+      AutoTagger.new("ci", "/foo").create_tag("guid")
+    end
     
     it "returns the tag that was created" do
       time = Time.local(2001,1,1)

data/spec/auto_tagger/capistrano_helper_spec.rb

@@ -6,7 +6,7 @@ describe CapistranoHelper do
     it "blows up if there are no stages" do
       proc do
         CapistranoHelper.new({})
-      end.should raise_error(CapistranoHelper::NoStagesSpecifiedError)
+      end.should raise_error(StageManager::NoStagesSpecifiedError)
     end
   end
 
@@ -16,12 +16,6 @@ describe CapistranoHelper do
     end
   end
 
-  describe "#stages" do
-    it "returns the hashes' stages value" do
-      CapistranoHelper.new({:stages => [:bar]}).stages.should == [:bar]
-    end
-  end
-
   describe "#working_directory" do
     it "returns the hashes' working directory value" do
       CapistranoHelper.new({:stages => [:bar], :working_directory => "/foo"}).working_directory.should == "/foo"
@@ -40,17 +34,24 @@ describe CapistranoHelper do
     end
   end
 
-  describe "#previous_stage" do
-    it "returns the previous stage if there is more than one stage, and there is a current stage" do
-      CapistranoHelper.new({:stages => [:foo, :bar], :current_stage => :bar}).previous_stage.should == :foo
-    end
-
-    it "returns nil if there is no previous stage" do
-      CapistranoHelper.new({:stages => [:bar], :current_stage => :bar}).previous_stage.should be_nil
-    end
-
-    it "returns nil if there is no current stage" do
-      CapistranoHelper.new({:stages => [:bar]}).previous_stage.should be_nil
+  describe "#release_tag_entries" do
+    it "returns a column-justifed version of all the commits" do
+      mock(Commander).execute("/foo", "git tag").times(any_times) { "ci_01\nstaging_01\nproduction_01" }
+      mock(Commander).execute("/foo", "git --no-pager log ci_01 --pretty=oneline -1") { "guid1" }
+      mock(Commander).execute("/foo", "git --no-pager log staging_01 --pretty=oneline -1") { "guid2" }
+      mock(Commander).execute("/foo", "git --no-pager log production_01 --pretty=oneline -1") { "guid3" }
+      mock(Commander).execute!("/foo", "git fetch origin --tags").times(any_times) { true }
+      mock(File).exists?(anything).times(any_times) {true}
+
+      variables = {
+        :working_directory => "/foo",
+        :stages => [:ci, :staging, :production]
+      }
+      histories = CapistranoHelper.new(variables).release_tag_entries
+      histories.length.should == 3
+      histories[0].should include("ci_01", "guid1")
+      histories[1].should include("staging_01", "guid2")
+      histories[2].should include("production_01", "guid3")
     end
   end
 

data/spec/auto_tagger/stage_manager_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe StageManager do
+  
+  describe ".new" do
+    [nil, ""].each do |value|
+      it "blows up if there are stages == #{value.inspect}" do
+        proc do
+          StageManager.new(value)
+        end.should raise_error(StageManager::NoStagesSpecifiedError)
+      end
+    end
+  end
+
+  describe "#previous_stage" do
+    it "returns the previous stage if there is more than one stage, and there is a current stage" do
+      StageManager.new([:foo, :bar]).previous_stage(:bar).should == :foo
+    end
+
+    it "returns nil if there is no previous stage" do
+      StageManager.new([:bar]).previous_stage(:bar).should be_nil
+    end
+
+    it "returns nil if there is no current stage" do
+      StageManager.new([:bar]).previous_stage(nil).should be_nil
+    end
+  end
+
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zilkey-auto_tagger
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jeff Dean
@@ -36,6 +36,7 @@ files:
 - lib/auto_tagger/capistrano_helper.rb
 - lib/auto_tagger/commander.rb
 - lib/auto_tagger/repository.rb
+- lib/auto_tagger/stage_manager.rb
 - lib/auto_tagger/tag.rb
 - lib/auto_tagger.rb
 - recipes/release_tagger.rb
@@ -45,6 +46,7 @@ files:
 - spec/auto_tagger/capistrano_helper_spec.rb
 - spec/auto_tagger/commander_spec.rb
 - spec/auto_tagger/repository_spec.rb
+- spec/auto_tagger/stage_manager_spec.rb
 - spec/auto_tagger/tag_spec.rb
 - spec/spec_helper.rb
 - MIT-LICENSE