factorylabs-auto_tagger 0.1.1

data/features/deployment.feature

@@ -0,0 +1,29 @@
+Feature: Deployment
+  In order to get auto-tagging goodness
+  As a ruby and git ninja
+  I want cap to do all the work for me
+
+  Scenario: user deploys with single file deploy.rb with 3 stages
+    Given a three-stage app using single deploy file
+    And a ci tag
+    When I deploy to staging
+    Then a tag should be added to git
+
+  Scenario: user deploys with single file deploy.rb with no stages
+    Given a one-stage app using single deploy file with the following environments:
+      |production  |
+    When I deploy
+    Then a "production" tag should be added to git
+
+  Scenario: user deploys with single file deploy.rb stages with dashes in the name
+    Given a one-stage app using single deploy file with the following environments:
+      |staging            |
+      |secret-production  |
+    When I deploy to secret-production
+    Then a "secret-production" tag should be added to git
+
+  Scenario: user deploys with cap-ext multistage
+    Given a three-stage app using cap-multistage
+    And a ci tag
+    When I deploy to staging
+    Then a tag should be added to git

data/features/step_definitions/autotag_steps.rb

@@ -0,0 +1,41 @@
+Given /^a repo$/ do
+  puts
+  helpers = StepHelpers.new
+  helpers.create_git_repo
+  helpers.create_app
+  @tags = helpers.tags
+  puts
+end
+
+When /^I run autotag with no arguments$/ do
+  puts
+  helpers = StepHelpers.new
+  @output = helpers.run_autotag
+  @tags = helpers.tags
+  puts
+end
+
+When /^I run autotag with "([^\"]*)"$/ do |args|
+  puts
+  helpers = StepHelpers.new
+  @output = helpers.run_autotag(args)
+  @tags = helpers.tags
+  puts
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  @output.should =~ /#{Regexp.escape(text)}/
+end
+
+Then /^no tags should be created$/ do
+  @tags.strip.should == ""
+end
+
+Then /^a "([^\"]*)" tag should be added to git$/ do |stage|
+  helpers = StepHelpers.new
+  helpers.tags.starts_with?(stage).should be_true
+end
+
+Then /^a "([^\"]*)" tag should be created$/ do |prefix|
+  @tags.strip.split("\n").any?{|tag| tag.starts_with?("demo")}.should be_true
+end

data/features/step_definitions/deployment_steps.rb

@@ -0,0 +1,53 @@
+Given /^a three-stage app using single deploy file$/ do
+  puts
+  helpers = StepHelpers.new
+  helpers.create_app_with_single_deploy_file([:ci, :staging, :production])
+  puts
+  @tags = helpers.tags
+end
+
+Given /^a one\-stage app using single deploy file with the following environments:$/ do |table|
+  puts
+  helpers = StepHelpers.new
+  helpers.create_app_with_single_deploy_file table.raw.map(&:first)
+  puts
+  @tags = helpers.tags
+end
+
+Given /^a three-stage app using cap-multistage$/ do
+  puts
+  helpers = StepHelpers.new
+  helpers.create_app_with_cap_ext_multistage
+  puts
+  @tags = helpers.tags
+end
+
+Given /^a ci tag$/ do
+  puts
+  helpers = StepHelpers.new
+  helpers.autotag("ci")
+  @tags = helpers.tags
+  puts
+end
+
+When /^I deploy to (.*)$/ do |environment|
+  puts
+  helpers = StepHelpers.new
+  helpers.deploy(environment)
+  puts
+end
+
+When /^I deploy$/ do
+  puts
+  helpers = StepHelpers.new
+  helpers.deploy
+  puts
+end
+
+Then /^a tag should be added to git$/ do
+  puts
+  helpers = StepHelpers.new
+  new_tags = helpers.tags
+  @tags.length.should < new_tags.length
+  puts
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'spec'
+require 'erb'
+require 'etc'
+require 'activesupport'
+
+Before do
+  StepHelpers.new.reset
+end

data/features/support/step_helpers.rb

@@ -0,0 +1,136 @@
+class StepHelpers
+
+  attr_reader :test_files_dir, :app_dir, :repo_dir
+
+  def initialize
+    @test_files_dir = File.join(Dir.pwd, "test_files")
+    @app_dir  = File.join(test_files_dir, "app")
+    @repo_dir = File.join(test_files_dir, "repo")
+  end
+
+  def reset
+    FileUtils.rm_r(test_files_dir) if File.exists?(test_files_dir)
+    FileUtils.mkdir_p(test_files_dir)
+  end
+
+  def create_git_repo
+    FileUtils.mkdir_p repo_dir
+    `cd #{repo_dir} && git --bare init`
+  end
+
+  def create_app_with_single_deploy_file(environments)
+    create_git_repo
+    create_app
+    capify_app
+    create_single_deploy_file(environments)
+  end
+
+  def run_autotag(args = nil)
+    cmd = "cd #{app_dir} && ../../bin/autotag"
+    cmd += " #{args}" if args
+    `#{cmd}`
+  end
+
+  def create_app_with_cap_ext_multistage
+    create_git_repo
+    create_app
+    capify_app
+    create_cap_ext_multistage_deploy_files
+  end
+
+  def deploy(stage = nil)
+    deploy_command = "cap "
+    deploy_command += "#{stage} " if stage
+    deploy_command += "deploy"
+
+    run_commands [
+      "cd #{app_dir}",
+      "cap deploy:setup",
+      deploy_command
+    ]
+  end
+
+  def autotag(stage)
+    system "cd #{app_dir} && git tag #{stage}/#{Time.now.utc.strftime('%Y%m%d%H%M%S')} && git push origin --tags"
+  end
+
+  def tags
+    system "cd #{app_dir} && git fetch origin --tags"
+    tags = `cd #{app_dir} && git tag`
+    puts tags
+    tags
+  end
+
+  def create_app
+    FileUtils.mkdir_p app_dir
+    run_commands [
+      "cd #{app_dir}",
+      "touch README",
+      "git init",
+      "git add .",
+      %Q{git commit -m "first commit"},
+      "git remote add origin file://#{repo_dir}",
+      "git push origin master"
+    ]
+  end
+
+  private
+
+  def capify_app
+    run_commands [
+      "cd #{app_dir}",
+      "mkdir config",
+      "capify ."
+    ]
+  end
+
+  def create_single_deploy_file(environments)
+    repository = repo_dir
+    deploy_to = File.join(test_files_dir, "deployed")
+    git_location = `which git`.strip
+    user = Etc.getlogin
+
+    path = File.expand_path(File.join(__FILE__, "..", "..", "templates", "deploy.erb"))
+    #puts "TRACE %s:%s" % [__FILE__, __LINE__]
+    #puts path
+    #puts File.exists?(path)
+
+    template = ERB.new File.read(path)
+    output = template.result(binding)
+    File.open(File.join(app_dir, "config", "deploy.rb"), 'w') {|f| f.write(output) }
+  end
+
+  def create_cap_ext_multistage_deploy_files
+    repository = repo_dir
+    deploy_to = File.join(test_files_dir, "deployed")
+    git_location = `which git`.strip
+    user = Etc.getlogin
+    environments = [:ci, :staging, :production]
+
+    path = File.expand_path(File.join(__FILE__, "..", "..", "templates", "cap_ext_deploy.erb"))
+
+    template = ERB.new File.read(path)
+    output = template.result(binding)
+    File.open(File.join(app_dir, "config", "deploy.rb"), 'w') {|f| f.write(output) }
+
+    %w(staging production).each do |stage|
+      create_cap_ext_multistage_deploy_stage_file(stage)
+    end
+  end
+
+  def create_cap_ext_multistage_deploy_stage_file(stage)
+    deploy_subdir = File.join(app_dir, "config", "deploy")
+    FileUtils.mkdir_p deploy_subdir
+
+    template_path = File.expand_path(File.join(__FILE__, "..", "..", "templates", "stage.erb"))
+    template = ERB.new File.read(template_path)
+    output = template.result(binding)
+
+    File.open(File.join(deploy_subdir, "#{stage}.rb"), 'w') {|f| f.write(output) }
+  end
+
+  def run_commands(commands)
+    puts `#{commands.join(" && ")}`
+  end
+
+end

data/features/templates/cap_ext_deploy.erb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "recipes", "release_tagger"))
+
+set :autotagger_stages, [:ci, :staging, :production]
+set :stages, [:staging, :production]
+set :default_stage, :staging
+
+require 'capistrano/ext/multistage'
+
+set :application, "deployed"
+set :user, "<%= user %>"
+set :repository,  "file://<%= repository %>"
+set :scm, :git
+set :scm_command, "<%= git_location %>"
+
+set :deploy_to, "<%= deploy_to %>"
+
+set :run_method, :run
+set :ssh_options, { :forward_agent => true }
+default_run_options[:pty] = true
+
+role :app, "localhost" # => this must be mapped
+
+namespace :deploy do
+  task :restart do
+    puts "restarting..."
+  end
+end
+
+before "deploy:update_code", "release_tagger:set_branch"
+after  "deploy", "release_tagger:create_tag"
+after  "deploy", "release_tagger:write_tag_to_shared"
+after  "deploy", "release_tagger:print_latest_tags"

data/features/templates/deploy.erb

@@ -0,0 +1,34 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "recipes", "release_tagger"))
+
+set :autotagger_stages, ["<%= environments.join('", "') %>"]
+
+set :application, "deployed"
+set :user, "<%= user %>"
+set :repository,  "file://<%= repository %>"
+set :deploy_to, "<%= deploy_to %>"
+set :scm, :git
+set :scm_command, "<%= git_location %>"
+
+set :run_method, :run
+set :ssh_options, { :forward_agent => true }
+default_run_options[:pty] = true
+
+role :app, "localhost" # => this must be mapped
+
+
+namespace :deploy do
+  task :restart do
+    puts "restarting..."
+  end
+end
+
+<% environments.each do |environment| %>
+task "<%= environment %>" do
+  set :stage, "<%= environment %>"
+end
+<% end %>
+
+before "deploy:update_code", "release_tagger:set_branch"
+after  "deploy", "release_tagger:create_tag"
+after  "deploy", "release_tagger:write_tag_to_shared"
+after  "deploy", "release_tagger:print_latest_tags"

data/features/templates/stage.erb

@@ -0,0 +1 @@
+# nothing to see here...

data/geminstaller.yml

@@ -0,0 +1,7 @@
+gems:
+- name: capistrano
+  version: '>= 2.5.3'
+- name: capistrano-ext
+  version: '>= 1.2.1'
+- name: activesupport
+  version: '>= 2.3.2'

data/lib/auto_tagger.rb

@@ -0,0 +1,10 @@
+[
+  'commander',
+  'repository',
+  'tag',
+  'auto_tagger',
+  'stage_manager',
+  'capistrano_helper'
+].each do |file|
+  require File.expand_path(File.join(File.dirname(__FILE__), "auto_tagger", file))
+end

data/lib/auto_tagger/auto_tagger.rb

@@ -0,0 +1,26 @@
+class AutoTagger
+
+  class EnvironmentCannotBeBlankError < StandardError; end
+
+  attr_reader :stage, :repository, :working_directory
+
+  def initialize(stage, path = nil)
+    raise EnvironmentCannotBeBlankError if stage.to_s.strip == ""
+    @working_directory = File.expand_path(path ||= Dir.pwd)
+    @repository = Repository.new(@working_directory)
+    @stage = stage
+  end
+
+  def create_tag(commit = nil)
+    repository.tags.fetch
+    new_tag = repository.tags.create(stage, commit)
+    repository.tags.push
+    new_tag
+  end
+
+  def latest_tag
+    repository.tags.fetch
+    repository.tags.latest_from(stage)
+  end
+
+end

data/lib/auto_tagger/capistrano_helper.rb

@@ -0,0 +1,39 @@
+class CapistranoHelper
+
+  attr_reader :variables, :stage, :working_directory
+
+  def initialize(variables)
+    @stage_manager = StageManager.new(variables[:autotagger_stages])
+    @variables = variables
+    @stage = variables[:stage]
+    @working_directory = variables[:working_directory] || Dir.pwd
+  end
+
+  def previous_stage
+    @stage_manager.previous_stage(stage)
+  end
+
+  def branch
+    if variables.has_key?(:head)
+      variables[:branch]
+    elsif variables.has_key?(:tag)
+      variables[:tag]
+    elsif previous_stage && (latest = AutoTagger.new(previous_stage, working_directory).latest_tag)
+      latest
+    else
+      variables[:branch]
+    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/commander.rb

@@ -0,0 +1,15 @@
+class Commander
+  class << self
+    def execute(path, cmd)
+      `#{command_in_context(path, cmd)}`
+    end
+
+    def execute!(path, cmd)
+      system command_in_context(path, cmd)
+    end
+
+    def command_in_context(path, cmd)
+      "cd #{path} && #{cmd}"
+    end
+  end
+end