heroploy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1abe27a12facd2dc9f5efb27cfd5c959186ef25a
+  data.tar.gz: 1e2995fb4cd6a6af47366cda82c7362adcd032c9
+SHA512:
+  metadata.gz: 37e04d64e2abdb2730baeeb28233b25b4471e8b9c1e6000fc3b92e9bb70ede30eaa3f678871baaf8c1e7ac002c23127e21cf84a4efd0c9696ba0ceeb81657d81
+  data.tar.gz: 2e8a442f4431e1b1fbf0b2667033905ac12e927066a309abbe480efe0875cfdc2697a92fb6ac118c10cd254f8dffeb16adb2a8116d43bc7aec69b6ec1fd2a893

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake spec
+  

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heroploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Brunton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Heroploy
+
+[![Build Status](https://travis-ci.org/jbrunton/heroploy.png?branch=master)](https://travis-ci.org/jbrunton/heroploy)
+[![Code Climate](https://codeclimate.com/github/jbrunton/heroploy.png)](https://codeclimate.com/github/jbrunton/heroploy)
+
+A few helpful rake tasks to manage deploying Rails apps to development, staging and production Heroku servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heroploy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroploy
+
+## Usage
+
+Add a .heroploy file in your application's root directory which describes the Heroku apps you will deploy to, and the checks you would like when deploying to each.
+
+For example:
+
+```yaml
+apps:
+  development:
+    heroku: my-app-development
+
+  staging:
+    heroku: my-app-staging
+    checks:
+      pushed: true
+      branch: master
+
+  production:
+    heroku: my-app-production
+    tag: 'RELEASE_%Y%m%dT%H%M%S%z'
+    checks:
+      pushed: true
+      branch: master
+      staged: true
+```
+
+This file:
+* Describes ```development```, ```staging``` and ```production``` deployment rules for three Heroku apps (named ```my-app-development```, ```my-app-staging``` and ```my-app-production``` on Heroku).
+* Allows any branch to be pushed directly to ```development```.
+* Only allows ```master``` to be pushed to ```staging```, and requires all changes to have first been pushed to ```origin```.
+* Only allows deployment to ```production``` if the changes have first been staged on ```staging```.
+
+To deploy to one of these environments, run ```rake heroploy:<environment>:deploy```.  For example:
+
+    rake heroploy:production:deploy
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/heroploy.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroploy"
+  spec.version       = Heroploy::VERSION
+  spec.authors       = ["John Brunton"]
+  spec.email         = ["john_brunton@hotmail.co.uk"]
+  spec.description   = %q{Helpful rake tasks to manage deploying to development, staging and production Heroku servers}
+  spec.summary       = %q{Helpful rake tasks for deploying to Heroku}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/heroploy/deploy_config.rb

@@ -0,0 +1,39 @@
+class ChecksConfig
+  attr_reader :pushed
+  attr_reader :branch
+  attr_reader :staged
+  
+  def initialize(attrs)
+    attrs ||= {}
+    @pushed = attrs['pushed']
+    @branch = attrs['branch']
+    @staged = attrs['staged']
+  end
+end
+
+class AppConfig
+  attr_reader :name
+  attr_reader :remote
+  attr_reader :heroku
+  attr_reader :tag
+  attr_reader :checks
+  
+  def initialize(name, attrs)
+    @name = name
+    @remote = attrs['remote'] || name
+    @heroku = attrs['heroku']
+    @tag = attrs['tag']
+    @checks = ChecksConfig.new(attrs['checks'])
+  end
+end
+
+class DeployConfig
+  attr_reader :apps
+  
+  def initialize(file_name)
+    @apps = YAML::load(File.open(file_name))['apps']
+    @apps.each do |app_name, attrs|
+      @apps[app_name] = AppConfig.new(app_name, attrs)
+    end
+  end
+end

data/lib/heroploy/git_commands.rb

@@ -0,0 +1,44 @@
+require 'heroploy/shell'
+
+module GitCommands
+  def git_fetch
+    Shell.exec "git fetch"
+  end
+  
+  def current_branch
+    branch = Shell.eval "git rev-parse --abbrev-ref HEAD"
+    branch.strip
+  end
+  
+  def git_push_to_master(remote, local_branch)
+    if ENV['force'] == 'true' then opts = "--force " end
+    Shell.exec "git push #{opts}#{remote} #{local_branch}:master"
+  end
+  
+  def git_remote_exists?(name)
+    remotes = Shell.eval("git remote").strip.split(/\s+/)
+    remotes.include?(name)
+  end
+  
+  def git_remote_has_branch?(remote, branch_name)
+    branches = Shell.eval("git branch -r").strip.split(/\s+/)
+    branches.include?("#{remote}/#{branch_name}")
+  end
+  
+  def git_remote_behind?(remote, remote_branch_name, local_branch_name = nil)
+    if local_branch_name.nil? then local_branch_name = remote_branch_name end
+    !Shell.eval("git log #{remote}/#{remote_branch_name}..#{local_branch_name}").empty?
+  end
+  
+  def git_staged?(remote, local_branch)
+    !git_remote_behind?(remote, 'master', local_branch)
+  end
+  
+  def git_tag(tag, message)
+    Shell.exec("git tag -a #{tag} -m \"#{message}\"")
+  end
+  
+  def git_push_tag(tag)
+    Shell.exec("git push origin #{tag}")
+  end
+end

data/lib/heroploy/heroku_commands.rb

@@ -0,0 +1,17 @@
+require 'heroploy/shell'
+
+module HerokuCommands
+  def heroku_exec(cmd, app_name)
+    Shell.exec "heroku #{cmd} --app #{app_name}"
+  end
+  
+  def heroku_run(cmd, app_name)
+    heroku_exec("run #{cmd}", app_name)
+  end
+  
+  def heroku_migrate(app_name)
+    Bundler.with_clean_env do
+      heroku_run("rake db:migrate", app_name)
+    end
+  end
+end

data/lib/heroploy/shell.rb

@@ -0,0 +1,11 @@
+class Shell
+  extend FileUtils
+  
+  def self.eval(cmd)
+    `#{cmd}`
+  end
+  
+  def self.exec(cmd)
+    sh cmd
+  end
+end

data/lib/heroploy/tasks.rb

@@ -0,0 +1,87 @@
+require 'heroploy/git_commands'
+require 'heroploy/heroku_commands'
+require 'heroploy/deploy_config'
+
+namespace :heroploy do
+  include GitCommands
+  include HerokuCommands
+  
+  desc 'do a git fetch'
+  task :fetch do
+    git_fetch
+  end
+  
+  deploy_config = DeployConfig.new('.heroploy.yml')
+  
+  deploy_config.apps.each do |app_name, config|
+    namespace app_name do
+      namespace :check do
+        desc "check remote exists for #{app_name}"
+        task :remote do
+          remote = config.remote || app_name
+          unless git_remote_exists?(remote)
+            raise "Could not find remote '#{remote}'"
+          end
+        end
+        
+        desc "check changes have been pushed to origin"
+        task :pushed do
+          if config.checks.pushed then
+            branch_name = current_branch
+            unless git_remote_has_branch?('origin', branch_name)
+              raise "Branch #{branch_name} doesn't exist in origin"
+            end
+          
+            if git_remote_behind?('origin', branch_name) then
+              raise "Branch #{branch_name} is behind origin/#{branch_name}"
+            end
+          end
+        end
+
+        desc "check we can deploy to #{app_name} from the current branch"
+        task :branch do
+          if config.checks.branch then
+            unless current_branch == config.checks.branch
+              raise "Cannot deploy branch #{current_branch} to #{app_name}"
+            end
+          end
+        end
+        
+        desc "check the changes have already been staged"
+        task :staged do
+          if config.checks.staged then
+            staging_app_name = config.checks.staged == true ? 'staging' : config.checks.staged
+            unless git_staged?(deploy_config.apps[staging_app_name].remote, current_branch)
+              raise "Changes not yet staged on #{app_name}"
+            end
+          end
+        end
+        
+        desc "do all the checks for #{app_name}"
+        task :all => [:remote, :pushed, :branch, :staged]
+      end
+      
+      desc "push the current branch to master on #{app_name}"
+      task :push do
+        git_push_to_master(config.remote, current_branch)
+      end
+      
+      desc "run database migrations on #{app_name}"
+      task :migrate do
+        heroku_migrate(config.heroku)
+      end
+
+      desc "tag the deployment to #{app_name}"
+      task :tag do
+        if config.tag then
+          tag = DateTime.now.strftime(config.tag)
+          git_tag(tag, "Deployed #{current_branch} to #{app_name}")
+          git_push_tag(tag)
+        end
+      end
+
+      desc "deploy to #{app_name}"
+      task :deploy => ['check:all', :push, :migrate, :tag]
+    end
+  end
+end

data/lib/heroploy/version.rb

@@ -0,0 +1,3 @@
+module Heroploy
+  VERSION = "0.0.1"
+end

data/lib/heroploy.rb

@@ -0,0 +1,6 @@
+require "heroploy/version"
+require File.join(File.dirname(__FILE__), 'railtie.rb') if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+
+module Heroploy
+  # Your code goes here...
+end

data/lib/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Heroploy
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'heroploy/tasks.rb'
+    end
+  end
+end

data/spec/lib/heroploy/git_commands_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe GitCommands do
+  before(:each) do
+    stub_shell
+  end
+  
+  let(:commands) { Object.new.extend(GitCommands) }
+  
+  context "#git_fetch" do
+    it "executes a git fetch" do
+      expect_command("git fetch")
+      commands.git_fetch
+    end
+  end
+  
+  context "#current_branch" do
+    let(:expected_rev_parse_output) { "master\n" }
+
+    it "evaluates git rev-parse to figure out the current branch" do
+      expect_eval("git rev-parse --abbrev-ref HEAD").and_return(expected_rev_parse_output)
+      commands.current_branch
+    end
+    
+    it "trims the output to just the branch name" do
+      expect_eval.and_return(expected_rev_parse_output)
+      expect(commands.current_branch).to eq("master")
+    end
+  end
+  
+  context "#git_push_to_master" do
+    it "pushes the local branch to the remote master" do
+      expect_command("git push my-remote my-branch:master")
+      commands.git_push_to_master("my-remote", "my-branch")
+    end
+    
+    it "appends the --force option if the 'force' ENV variable is set" do
+      expect(ENV).to receive(:[]).and_return('true')
+      expect_command("git push --force my-remote my-branch:master")
+      commands.git_push_to_master("my-remote", "my-branch")
+    end
+  end
+  
+  context "#git_remote_exists?" do
+    it "evaluates git remote to enumerate the available remotes" do
+      expect_eval("git remote")
+      commands.git_remote_exists?("my-remote")
+    end
+    
+    it "returns true if the given remote exists" do
+      expect_eval("git remote").and_return("origin\nstaging\nproduction")
+      expect(commands.git_remote_exists?("staging")).to eq(true)
+    end
+
+    it "returns false if the given remote doesn't exist" do
+      expect_eval("git remote").and_return("origin\nproduction")
+      expect(commands.git_remote_exists?("staging")).to eq(false)
+    end
+  end
+  
+  context "#git_remote_has_branch?" do
+    it "evaluates git branch -r to determine the remote branches" do
+      expect_eval("git branch -r")
+      commands.git_remote_has_branch?("my-remote", "my-branch")
+    end
+    
+    it "returns true if the remote has a branch with the given name" do
+      expect_eval("git branch -r").and_return("  my-remote/my-branch\n  my-remote/other-branch\n")
+      expect(commands.git_remote_has_branch?("my-remote", "my-branch")).to be(true)
+    end
+
+    it "returns false if the remote has no branch with the given name" do
+      expect_eval("git branch -r").and_return("  my-remote/other-branch\n")
+      expect(commands.git_remote_has_branch?("my-remote", "my-branch")).to be(false)
+    end
+  end
+  
+  context "#git_remote_behind?" do
+    it "inspects the git log to see if the remote is ahead" do
+      expect_eval("git log my-remote/my-remote-branch..my-local-branch")
+      commands.git_remote_behind?("my-remote", "my-remote-branch", "my-local-branch")
+    end
+    
+    it "uses the remote branch name as the local branch name if none is supplied" do
+      expect_eval("git log my-remote/my-branch..my-branch")
+      commands.git_remote_behind?("my-remote", "my-branch")
+    end
+    
+    it "returns true if git log returns commits" do
+      expect_eval("git log my-remote/my-remote-branch..my-local-branch").and_return("commit a1b2c3d")
+      expect(commands.git_remote_behind?("my-remote", "my-remote-branch", "my-local-branch")).to eq(true)
+    end
+
+    it "returns false if git log returns no commits" do
+      expect_eval("git log my-remote/my-remote-branch..my-local-branch").and_return("")
+      expect(commands.git_remote_behind?("my-remote", "my-remote-branch", "my-local-branch")).to eq(false)
+    end  
+  end
+  
+  context "#git_staged?" do
+    it "returns true if the remote master is up to date" do
+      expect_eval("git log my-remote/master..my-local-branch").and_return("")
+      expect(commands.git_staged?("my-remote", "my-local-branch")).to eq(true)
+    end
+
+    it "returns false if the remote master is behind" do
+      expect_eval("git log my-remote/master..my-local-branch").and_return("commit a1b2c3d")
+      expect(commands.git_staged?("my-remote", "my-local-branch")).to eq(false)
+    end  
+  end
+  
+  context "#git_tag" do
+    it "creates a tag with the given name and message" do
+      expect_command("git tag -a my-tag -m \"my message\"")
+      commands.git_tag("my-tag", "my message")
+    end
+  end
+end

data/spec/lib/heroploy/heroku_commands_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe HerokuCommands do
+  before(:each) do
+    stub_shell
+  end
+  
+  let(:commands) { Object.new.extend(HerokuCommands) }
+  
+  context "#heroku_exec" do
+    it "executes the heroku command for the given app" do
+      expect_command("heroku help --app my-app")
+      commands.heroku_exec("help", "my-app")
+    end
+  end
+  
+  context "#heroku_run" do
+    it "runs the given command on the heroku server" do
+      expect_command("heroku run rake db:migrate --app my-app")
+      commands.heroku_run("rake db:migrate", "my-app")
+    end
+  end
+  
+  context "#heroku_migrate" do
+    it "runs rake db:migrate on the heroku server" do
+      expect_command("heroku run rake db:migrate --app my-app")
+      commands.heroku_migrate("my-app")
+    end    
+  end
+end

data/spec/lib/heroploy/shell_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Shell do
+  context "#eval" do
+    it "evaluates the given command using backticks" do
+      expect(Shell).to receive(:`).with('date')
+      Shell.eval('date')
+    end
+
+    it "returns the standard output from the shell command" do
+      expected_output = "Sun 19 Jan 2014 01:20:23 GMT\n"
+      expect(Shell).to receive(:`).and_return(expected_output)
+      expect(Shell.eval('date')).to eq(expected_output)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'heroploy/heroku_commands'
+require 'heroploy/git_commands'
+require 'support/shell_support'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  
+  config.include ShellSupport
+end

data/spec/support/shell_support.rb

@@ -0,0 +1,22 @@
+module ShellSupport
+  def stub_shell
+    Shell.stub(:eval).and_return("")
+    Shell.stub(:exec)
+  end
+  
+  def expect_command(cmd = nil)
+    if cmd.nil?
+      expect(Shell).to receive(:exec)
+    else
+      expect(Shell).to receive(:exec).with(cmd)
+    end
+  end
+  
+  def expect_eval(cmd = nil)
+    if cmd.nil?
+      expect(Shell).to receive(:eval)
+    else
+      expect(Shell).to receive(:eval).with(cmd)
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: heroploy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Brunton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: Helpful rake tasks to manage deploying to development, staging and production
+  Heroku servers
+email:
+- john_brunton@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heroploy.gemspec
+- lib/heroploy.rb
+- lib/heroploy/deploy_config.rb
+- lib/heroploy/git_commands.rb
+- lib/heroploy/heroku_commands.rb
+- lib/heroploy/shell.rb
+- lib/heroploy/tasks.rb
+- lib/heroploy/version.rb
+- lib/railtie.rb
+- spec/lib/heroploy/git_commands_spec.rb
+- spec/lib/heroploy/heroku_commands_spec.rb
+- spec/lib/heroploy/shell_spec.rb
+- spec/spec_helper.rb
+- spec/support/shell_support.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Helpful rake tasks for deploying to Heroku
+test_files:
+- spec/lib/heroploy/git_commands_spec.rb
+- spec/lib/heroploy/heroku_commands_spec.rb
+- spec/lib/heroploy/shell_spec.rb
+- spec/spec_helper.rb
+- spec/support/shell_support.rb