zilkey-auto_tagger 0.0.6 → 0.0.7

data/README.md

@@ -1,3 +1,7 @@
+# IMPORTANT NOTE
+
+This gem is still in it's infancy, and lots of things might change.  Since this creates and pushes tags to your git repository, please use with caution.
+
 # AutoTagger
 
 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.
@@ -45,21 +49,21 @@ Example `config/deploy.rb` file:
 
     require 'release_tagger'
 
-    # The :stages variable is required
-    set :stages, [:ci, :staging, :production]
+    # The :autotagger_stages variable is required
+    set :autotagger_stages, [:ci, :staging, :production]
 
     # The :working_directory variable is optional, and defaults to Dir.pwd
     # :working_directory can be an absolute or relative path
     set :working_directory, "../../"
 
     task :production do
-      # In each of your environments that need auto-branch setting, you need to set :current_stage
-      set :current_stage, :production
+      # In each of your environments that need auto-branch setting, you need to set :stage
+      set :stage, :production
     end
 
     task :staging do
-      # If you do not set current_stage, it will not auto-set your branch
-      # set :current_stage, :staging
+      # If you do not set stage, it will not auto-set your branch
+      # set :stage, :staging
     end
 
     # You need to add the before/ater callbacks yourself
@@ -68,7 +72,18 @@ Example `config/deploy.rb` file:
     after  "deploy", "release_tagger:write_tag_to_shared"
     after  "deploy", "release_tagger:print_latest_tags"
 
-### `release_tagger:set_branch`
+### Cpistano-ext multistage support
+
+If you use capistano-ext multistage, you can use auto_tagger.
+
+    set :autotagger_stages, [:ci, :staging, :production]
+    set :stages, [:staging, :production]
+    set :default_stage, :staging
+    require 'capistrano/ext/multistage'
+
+When you deploy, autotagger will auto-detect your current stage.
+
+### release_tagger:set_branch
 
 This task sets the git branch to the latest tag from the previous stage.  Assume you have the following tags in your git repository:
 
@@ -78,7 +93,7 @@ This task sets the git branch to the latest tag from the previous stage.  Assume
 
 And the following stages in your capistrano file:
 
-    set :stages, [:ci, :staging, :production]
+    set :autotagger_stages, [:ci, :staging, :production]
 
 The deployments would look like this:
 
@@ -96,19 +111,19 @@ If you add `before "deploy:update_code", "release_tagger:set_branch"`, you can j
     
 and the branch will be set for you automatically.
 
-### `release_tagger:create_tag`
+### release_tagger:create_tag
 
 This cap task creates a new tag, based on the latest tag from the previous environment.  
 
 If there is no tag from the previous stage, it creates a new tag from the latest commit in your _working directory_.
 
-### `release_tagger:print_latest_tags`
+### release_tagger:print_latest_tags
 
 This task reads the git version from the text file in shared:
 
     cap staging release_tagger:read_tag_from_shared
 
-### `release_tagger:print_latest_tags`
+### release_tagger:print_latest_tags
 
 This task takes the latest tag from each environment and prints it to the screen.  You can add it to your deploy.rb like so:
 
@@ -125,9 +140,34 @@ This will produce output like:
      ** staging    staging/20090331050908         8031807feb5f4f99dd83257cdc07081fa6080cba some commit message
      ** production production/20090331050917      8031807feb5f4f99dd83257cdc07081fa6080cba some commit message
 
+## Running tests:
+
+You must be able to ssh into your box via localhost (remote login).  To make this easier, add your own key to your own account:
+
+    cat ~/.ssh/id_rsa.pub >>~/.ssh/authorized_keys
+    
+To ensure that this has worked, try this:
+
+    ssh localhost
+    
+If it asks you for a password, you've done something wrong.
+
+To run the specs, execute:
+
+    spec spec/
+    
+To run the cucumber features, execute:
+
+    cucumber features/
+
 ## Acknowledgments
 
-Special thanks to Brian Takita for the original recipes, and to Mike Dalessio for his git fu.
+Special thanks to 
+
+ * Brian Takita for the original recipes
+ * Mike Dalessio for his git fu
+ * Chad Wooley for his feature ideas
+ * Tim Holahan for his QA
 
 ## Links
 

data/lib/auto_tagger/capistrano_helper.rb

@@ -1,16 +1,16 @@
 class CapistranoHelper
 
-  attr_reader :variables, :current_stage, :working_directory
+  attr_reader :variables, :stage, :working_directory
 
   def initialize(variables)
-    @stage_manager = StageManager.new(variables[:stages])
+    @stage_manager = StageManager.new(variables[:autotagger_stages])
     @variables = variables
-    @current_stage = variables[:current_stage]
+    @stage = variables[:stage]
     @working_directory = variables[:working_directory] || Dir.pwd
   end
 
   def previous_stage
-    @stage_manager.previous_stage(current_stage)
+    @stage_manager.previous_stage(stage)
   end
 
   def branch
@@ -36,4 +36,4 @@ class CapistranoHelper
     entries
   end
 
-end
+end

data/lib/auto_tagger/commander.rb

@@ -7,10 +7,9 @@ class Commander
     def execute!(path, cmd)
       system command_in_context(path, cmd)
     end
-    
+
     def command_in_context(path, cmd)
       "cd #{path} && #{cmd}"
     end
   end
 end
-

data/lib/auto_tagger/repository.rb

@@ -13,7 +13,7 @@ class Repository
     elsif ! File.exists?(path)
       raise NoSuchPathError
     elsif ! File.exists?(File.join(path, ".git"))
-      raise InvalidGitRepositoryError 
+      raise InvalidGitRepositoryError
     else
       @path = path
     end
@@ -22,15 +22,15 @@ class Repository
   def ==(other)
     other.is_a?(Repository) && other.path == path
   end
-  
+
   def tags
     @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
@@ -38,5 +38,5 @@ class Repository
   def run!(cmd)
     Commander.execute!(path, cmd) || raise(GitCommandFailedError)
   end
-  
+
 end

data/lib/auto_tagger/stage_manager.rb

@@ -5,19 +5,19 @@ class StageManager
       "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 
+
+  def previous_stage(stage)
+    if stage
+      index = stages.index(stage) - 1
+      stages[index] if index > -1
     end
   end
-  
-end
+
+end

data/lib/auto_tagger/tag.rb

@@ -1,21 +1,21 @@
 # git --no-pager log --pretty=oneline -1
 # git tag -a -m 'Successful continuous integration build on #{timestamp}' #{tag_name}"
 class Tag
-  
+
   attr_reader :repository
-  
+
   def initialize(repository)
     @repository = repository
   end
-  
+
   def find_all
     repository.run("git tag").split("\n")
   end
-  
+
   def fetch
     repository.run! "git fetch origin --tags"
   end
-  
+
   def latest_from(stage)
     find_all.select{|tag| tag =~ /^#{stage}/}.sort.last
   end
@@ -23,7 +23,7 @@ class Tag
   def push
     repository.run! "git push origin --tags"
   end
-    
+
   def create(stage, commit = nil)
     tag_name = name_for(stage)
     cmd = "git tag #{tag_name}"
@@ -31,11 +31,11 @@ class Tag
     repository.run! cmd
     tag_name
   end
-  
+
   private
-  
+
   def name_for(stage)
     "%s/%s" % [stage, Time.now.utc.strftime('%Y%m%d%H%M%S')]
   end
-  
-end
+
+end

data/recipes/release_tagger.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "auto_ta
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :release_tagger do
     desc %Q{
-      Sets the branch to the latest tag from the previous stage.  
+      Sets the branch to the latest tag from the previous stage.
       Use -Shead=true to set the branch to master, -Stag=<tag> to specify the tag explicitly.
     }
     task :set_branch do
@@ -40,16 +40,15 @@ Capistrano::Configuration.instance(:must_exist).load do
       end
     end
 
-    desc %Q{Creates a tag using the current_stage variable}
+    desc %Q{Creates a tag using the stage variable}
     task :create_tag, :roles => :app do
-      if variables[:current_stage]
-        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)
+      if variables[:stage]
+        previous_tag = AutoTagger.new(StageManager.new(autotagger_stages).previous_stage(stage), Dir.pwd).latest_tag
+        tag_name = AutoTagger.new(variables[: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)."
+        logger.info "AUTO TAGGER WARNING: skipping auto-creation of tag.  Please specify :stage to enable auto-creation of tags (like set :stage, :ci)."
       end
     end
   end
 end
-

data/spec/auto_tagger/auto_tagger_spec.rb

@@ -1,6 +1,9 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe AutoTagger do
+  before(:each) do
+    stub(Dir).pwd { File.join(File.dirname(__FILE__), '..', '..') }
+  end
 
   describe ".new" do
     it "blows up if you don't pass an stage" do
@@ -8,7 +11,7 @@ describe AutoTagger do
         AutoTagger.new(nil)
       end.should raise_error(AutoTagger::EnvironmentCannotBeBlankError)
     end
-    
+
     it "sets the stage when it's passed" do
       AutoTagger.new("ci").stage.should == "ci"
     end
@@ -40,7 +43,7 @@ describe AutoTagger do
       mock(Commander).execute!("/foo", "git fetch origin --tags") {true}
       mock(Commander).execute!("/foo", "git tag ci/#{timestamp}") {true}
       mock(Commander).execute!("/foo", "git push origin --tags")  {true}
-      
+
       AutoTagger.new("ci", "/foo").create_tag
     end
 
@@ -53,17 +56,17 @@ describe AutoTagger do
       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)
       mock(Time).now.once {time}
       timestamp = time.utc.strftime('%Y%m%d%H%M%S')
       mock(File).exists?(anything).twice { true }
       mock(Commander).execute!(anything, anything).times(any_times) {true}
-      
+
       AutoTagger.new("ci", "/foo").create_tag.should == "ci/#{timestamp}"
     end
   end
@@ -74,9 +77,9 @@ describe AutoTagger do
 
       mock(Commander).execute!("/foo", "git fetch origin --tags") {true}
       mock(Commander).execute("/foo", "git tag") { "ci_01" }
-      
+
       AutoTagger.new("ci", "/foo").latest_tag
     end
   end
-  
+
 end

data/spec/auto_tagger/capistrano_helper_spec.rb

@@ -12,25 +12,25 @@ describe CapistranoHelper do
 
   describe "#variables" do
     it "returns all variables" do
-      CapistranoHelper.new({:stages => [:bar]}).variables.should == {:stages => [:bar]}
+      CapistranoHelper.new({:autotagger_stages => [:bar]}).variables.should == {:autotagger_stages => [: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"
+      CapistranoHelper.new({:autotagger_stages => [:bar], :working_directory => "/foo"}).working_directory.should == "/foo"
     end
-    
+
     it "defaults to Dir.pwd if it's not set, or it's nil" do
       mock(Dir).pwd { "/bar" }
-      CapistranoHelper.new({:stages => [:bar]}).working_directory.should == "/bar"
+      CapistranoHelper.new({:autotagger_stages => [:bar]}).working_directory.should == "/bar"
     end
   end
 
-  describe "#current_stage" do
+  describe "#stage" do
     it "returns the hashes' current stage value" do
-      CapistranoHelper.new({:stages => [:bar], :current_stage => :bar}).current_stage.should == :bar
-      CapistranoHelper.new({:stages => [:bar]}).current_stage.should be_nil
+      CapistranoHelper.new({:autotagger_stages => [:bar], :stage => :bar}).stage.should == :bar
+      CapistranoHelper.new({:autotagger_stages => [:bar]}).stage.should be_nil
     end
   end
 
@@ -45,7 +45,7 @@ describe CapistranoHelper do
 
       variables = {
         :working_directory => "/foo",
-        :stages => [:ci, :staging, :production]
+        :autotagger_stages => [:ci, :staging, :production]
       }
       histories = CapistranoHelper.new(variables).release_tag_entries
       histories.length.should == 3
@@ -59,7 +59,7 @@ describe CapistranoHelper do
     describe "with :head and :branch specified" do
       it "returns master" do
         variables = {
-          :stages => [:bar],
+          :autotagger_stages => [:bar],
           :head => nil,
           :branch => "foo"
         }
@@ -70,7 +70,7 @@ describe CapistranoHelper do
     describe "with :head specified, but no branch specified" do
       it "returns master" do
         variables = {
-          :stages => [:bar],
+          :autotagger_stages => [:bar],
           :head => nil
         }
         CapistranoHelper.new(variables).branch.should == nil
@@ -80,7 +80,7 @@ describe CapistranoHelper do
     describe "with :branch specified" do
       it "returns the value of branch" do
         variables = {
-          :stages => [:bar],
+          :autotagger_stages => [:bar],
           :branch => "foo"
         }
         CapistranoHelper.new(variables).branch.should == "foo"
@@ -90,8 +90,8 @@ describe CapistranoHelper do
     describe "with a previous stage with a tag" do
       it "returns the latest tag for the previous stage" do
         variables = {
-          :stages => [:foo, :bar],
-          :current_stage => :bar,
+          :autotagger_stages => [:foo, :bar],
+          :stage => :bar,
           :branch => "master",
           :working_directory => "/foo"
         }
@@ -105,8 +105,8 @@ describe CapistranoHelper do
     describe "with no branch and a previous stage with no tag" do
       it "returns nil" do
         variables = {
-          :stages => [:foo, :bar],
-          :current_stage => :bar,
+          :autotagger_stages => [:foo, :bar],
+          :stage => :bar,
           :working_directory => "/foo"
         }
         tagger = Object.new
@@ -119,8 +119,8 @@ describe CapistranoHelper do
     describe "with no branch and previous stage" do
       it "returns nil" do
         variables = {
-          :stages => [:bar],
-          :current_stage => :bar
+          :autotagger_stages => [:bar],
+          :stage => :bar
         }
         CapistranoHelper.new(variables).previous_stage.should be_nil
         CapistranoHelper.new(variables).branch.should == nil

data/spec/auto_tagger/commander_spec.rb

@@ -7,7 +7,7 @@ describe Commander do
       Commander.execute("/foo", "ls")
     end
   end
-  
+
   describe "system" do
     it "executes and doesn't return anything" do
       mock(Commander).system("cd /foo && ls")

data/spec/auto_tagger/stage_manager_spec.rb

@@ -1,7 +1,7 @@
 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
@@ -26,5 +26,5 @@ describe StageManager do
     end
   end
 
-  
+
 end

data/spec/auto_tagger/tag_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Tag do
-  
+
   before(:each) do
     @repository = Object.new
   end
@@ -11,7 +11,7 @@ describe Tag do
       Tag.new(@repository).repository.should == @repository
     end
   end
-  
+
   describe "#find_all" do
     it "returns an array of tags" do
       mock(@repository).run("git tag") { "ci_01\nci_02" }
@@ -23,7 +23,7 @@ describe Tag do
       Tag.new(@repository).find_all.should be_empty
     end
   end
-  
+
   describe "#latest_from" do
     before do
       @tag = Tag.new(@repository)
@@ -61,6 +61,6 @@ describe Tag do
       mock(@repository).run!("git tag #{tag_name}")
       Tag.new(@repository).create("ci").should == tag_name
     end
-  end    
-  
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zilkey-auto_tagger
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jeff Dean