deploy_s3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bb777889b634b9cae981e66a96f1fc990ef07f1
+  data.tar.gz: 4090cec2ab0d3dc45d436dea2ae9b57ad30bb966
+SHA512:
+  metadata.gz: 2de46f99b955502a84b315aa043c5be4d0b34af435c49752d346f8ba0c96f6daf6510d24488f50ed67681534bc04e573ad38196a60a68c3c32da883dbc464702
+  data.tar.gz: 91d879284cb307797b0087d7c024c9c228a5b12fb57b9430e7d130b3d944bdcd50b4bdec206e5ea4082fcde159b20e8b856476fbd93b90b40e4aeb3ac40a18f9

data/.gitignore

@@ -0,0 +1,3 @@
+/*.gem
+/.deploy
+/pkg/

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Stefan Penner and ember-cli contributors
+
+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,32 @@
+# deploy_s3
+
+deploy_s3 evolved out of Movable Ink's deployments, which typically involved capistrano. Over time, the capistrano scripts got heavier and multiple datacenters were added, each with dozens of machines. We used Chef for provisioning, and found that it was impossible to keep capistrano up-to-date with the comings and goings of new machines. A separation was needed.
+
+## The deploy_s3 workflow
+
+The goal of deploy_s3 is to separate deployment into two parts: specifying that a new version of code should be deployed, and actually deploying that code to the machines that need it.
+
+A typical deployment would look like this:
+
+    » ds3 production
+    Attempting to deploy d836d33
+
+    Difference of 6 new commit(s) between de0aed0 and d836d33:
+
+        d836d33 Michael Nutt         8 minutes ago	   ignore our own .deploy
+        9046842 Michael Nutt         8 minutes ago	   make bin executable
+        b2b4038 Michael Nutt         8 minutes ago	   clean up gemspec
+        e57b428 Michael Nutt         18 minutes ago	   refactoring
+        4fba6fa Michael Nutt         26 minutes ago	   add commit comparisons
+        349c4ce Michael Nutt         76 minutes ago	   first pass at sending to s3
+
+    Deploy? ([y]es / [n]o / [g]ithub) : y
+    Deployed d836d33
+
+deploy_s3 relies on a `.deploy` file to tell it where to write the git hash.  Right now it is tied to Amazon S3, but using fog it could send to any cloud provider.
+
+Movable Ink uses Chef to push out new code, and Chef can simply read s3 for the revision to know exactly which version to deploy. This allows newly provisioned machines to get the latest deployed version while not requiring changes to the provisioning system every time the project is updated.
+
+## License
+
+The MIT License. See LICENSE.md.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/bin/ds3

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'deploy_s3'
+rescue LoadError
+  require 'rubygems'
+  require 'deploy_s3'
+end
+
+require 'optparse'
+require 'highline/import'
+require 'colorize'
+
+options = {}
+
+options[:environment] = ARGV.pop
+
+options[:rev] = ENV['REV']
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: ds3 [environment] [options]"
+
+  opts.on("-c", "--config", String, "Location of .deploy configuration file") do |c|
+    options[:config_file] = c
+  end
+
+  opts.on("-r", "--rev", String, "Revision to deploy (can be sha, branch, etc)") do |r|
+    options[:rev] = r
+  end
+end
+optparse.parse!
+
+unless options[:environment]
+  puts "Error: environment required"
+  puts optparse
+  exit 1
+end
+
+deploy = DeployS3::Main.new(options)
+
+if deploy.up_to_date
+  puts "Everything up-to-date (#{deploy.environment.green}: #{deploy.remote_sha.green})"
+  exit 0
+end
+
+if deploy.remote_sha.nil?
+  puts "New deployment: #{deploy.local_sha}"
+else
+  puts "Attempting to deploy #{deploy.local_sha.bold}", ""
+
+  commits = "#{deploy.commit_count} new commit(s)".green
+  puts "Difference of #{commits} between #{deploy.remote_sha} and #{deploy.local_sha}:", ""
+
+  if deploy.commit_count > 0
+    puts deploy.diff.yellow, ""
+  else
+    puts "    There are no new commits.", ""
+  end
+end
+
+if deploy.older_local_sha
+  puts "WARNING: The commit you are deploying is older than what is currently on #{deploy.environment}. Missing commits: ".bold, ""
+  puts deploy.reverse_diff.red
+  puts ""
+end
+
+confirm = ask("Deploy? ([y]es / [n]o / [g]ithub) : ") { |yn| yn.limit = 1, yn.validate = /([yng]|yes|no|github)/i }
+
+case confirm.downcase
+when 'y', 'yes'
+  deploy.run!
+
+  puts "Deployed #{deploy.remote_sha}"
+when 'g', 'github'
+  url = DeployS3::Remote.comparison(deploy.remote_sha, deploy.local_sha)
+  if url
+    if `which open`.size > 0
+      `open #{url}`
+    else
+      puts "  Github: #{url}"
+    end
+  else
+    puts "Unrecognized repository; can't open github"
+    puts "(try `git config --get remote.origin.url`)"
+    exit 1
+  end
+when 'n', 'no'
+  puts "Bye."
+end

data/deploy_s3.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "deploy_s3/version"
+
+Gem::Specification.new do |s|
+  s.name        = "deploy_s3"
+  s.version     = DeployS3::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Nutt"]
+  s.email       = ["michael@movableink.com"]
+  s.homepage    = "https://github.com/movableink/deploy_s3"
+  s.summary     = %q{Writes project deployment hash to s3 file}
+  s.licenses    = "MIT"
+  s.description = %q{Separate out the deployment concerns from your application by using deploy_s3 to write your latest deployed git hash to s3. Then let your provisioning system (for instance, chef + deploy_revision provider) take care of actually deploying new code. deploy_s3 shows diffs between your current branch and the deployed revision.}
+
+  s.add_runtime_dependency "fog", "~> 1.25"
+  s.add_runtime_dependency "highline", "~> 1.6"
+  s.add_runtime_dependency "colorize", "~> 0.7"
+
+  s.add_development_dependency "rspec", "~> 2.5"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/deploy_s3/main.rb

@@ -0,0 +1,91 @@
+require 'fog'
+
+module DeployS3
+  class Main
+    def initialize(options)
+      config_path = options[:config_file] || "./.deploy"
+      @config = options[:config] || YAML::load_file(config_path)
+
+      raise "Missing s3: option in .deploy file" unless @config['s3']
+
+      @path = @config['s3'].split("/")
+      @bucket = @path.shift
+      @options = options
+    end
+
+    def environment
+      @options[:environment]
+    end
+
+    def save_sha
+      directory = connection.directories.get(@bucket)
+      file = directory.files.create(:key => key,
+                                    :body => local_sha)
+      @_remote_sha = nil
+    end
+
+    def run!
+      if @config['before_hook']
+        `#{@config['before_hook']}`
+      end
+
+      save_sha
+
+      if @config['after_hook']
+        `#{@config['after_hook']}`
+      end
+    end
+
+    def connection
+      @_connection ||= Fog::Storage.new(:provider => 'AWS')
+    end
+
+    def remote_sha
+      return @_remote_sha if @_remote_sha
+
+      directory = connection.directories.get(@bucket)
+      file = directory.files.get(key)
+      @_remote_sha = file.body if file
+    end
+
+    def filename
+      [environment, 'sha'].join('.')
+    end
+
+    def key
+      [@path, filename].join("/")
+    end
+
+    def up_to_date
+      local_sha == remote_sha
+    end
+
+    def local_sha
+      rev = @options[:rev] || @config[:branch] || 'head'
+      execute("git rev-parse --verify --short #{rev}").chomp
+    end
+
+    def diff
+      execute "git log --pretty=format:'    %h %<(20)%an %ar\t   %s' -10 #{remote_sha}..#{local_sha}"
+    end
+
+    def reverse_diff
+      execute "git log --pretty=format:'    %h %<(20)%an %ar\t   %s' -10 #{local_sha}..#{remote_sha}"
+    end
+
+    def older_local_sha
+      return false unless remote_sha
+      execute("git merge-base --is-ancestor #{local_sha} #{remote_sha}") && $?.exitstatus == 0
+    end
+
+    def commit_count
+      diff.split("\n").size
+    end
+
+  protected
+
+    def execute(cmd)
+      `#{cmd}`
+    end
+  end
+end

data/lib/deploy_s3/remote.rb

@@ -0,0 +1,18 @@
+module DeployS3
+  class Remote
+    def self.comparison(from, to)
+      origin_url = `git config --get remote.origin.url`.chomp
+
+      github_url = self.github_from_url origin_url
+      "#{github_url}/compare/#{from}...#{to}" if github_url
+    end
+
+    def self.github_from_url(url)
+      if url =~ /git@github.com:(.*?).git/
+        "https://github.com/#{$1}"
+      elsif url =~ /(.*?):\/\/github.com\/(.*?).git/
+        "https://github.com/#{$1}"
+      end
+    end
+  end
+end

data/lib/deploy_s3/version.rb

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

data/lib/deploy_s3.rb

@@ -0,0 +1,3 @@
+require 'deploy_s3/version'
+require 'deploy_s3/main'
+require 'deploy_s3/remote'

data/spec/deploy_s3/main_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe DeployS3::Main do
+  let(:deploy) {
+    DeployS3::Main.new(:environment => 'production',
+                       :config => {'s3' => 'my-bucket/deployments/foo'})
+  }
+
+  describe '#environment' do
+    it 'uses the passed environment' do
+      expect(deploy.environment).to eq('production')
+    end
+  end
+
+  describe '#filename' do
+    it 'computes the filename' do
+      expect(deploy.filename).to eql('production.sha')
+    end
+  end
+
+  describe '#key' do
+    it 'computes the key' do
+      expect(deploy.key).to eq('deployments/foo/production.sha')
+    end
+  end
+
+  describe '#diff' do
+    it 'uses git to find the commits between two shas' do
+      deploy.should_receive(:remote_sha).and_return("remote")
+      deploy.should_receive(:local_sha).and_return("local")
+
+      cmd = "git log --pretty=format:'    %h %<(20)%an %ar\t   %s' -10 remote..local"
+      deploy.should_receive(:execute).with(cmd)
+
+      deploy.diff
+    end
+  end
+
+  describe '#up_to_date' do
+    it 'returns true when shas match' do
+      deploy.should_receive(:remote_sha).and_return("same")
+      deploy.should_receive(:local_sha).and_return("same")
+      expect(deploy.up_to_date).to be_true
+    end
+
+    it 'returns true when shas differ' do
+      deploy.should_receive(:remote_sha).and_return("remote")
+      deploy.should_receive(:local_sha).and_return("local")
+      expect(deploy.up_to_date).to be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'deploy_s3'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: deploy_s3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Nutt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Separate out the deployment concerns from your application by using deploy_s3
+  to write your latest deployed git hash to s3. Then let your provisioning system
+  (for instance, chef + deploy_revision provider) take care of actually deploying
+  new code. deploy_s3 shows diffs between your current branch and the deployed revision.
+email:
+- michael@movableink.com
+executables:
+- ds3
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/ds3
+- deploy_s3.gemspec
+- lib/deploy_s3.rb
+- lib/deploy_s3/main.rb
+- lib/deploy_s3/remote.rb
+- lib/deploy_s3/version.rb
+- spec/deploy_s3/main_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/movableink/deploy_s3
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Writes project deployment hash to s3 file
+test_files:
+- spec/deploy_s3/main_spec.rb
+- spec/spec_helper.rb