etsy-deployinator 1.0.2 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWRmY2ZlZDEzOTQ5YjJiY2YwOGNiN2RmZjFlNzY1ZDkyOWFhYTNiZA==
-  data.tar.gz: !binary |-
-    YjE2MjYwOGUyOTRmYzI1MmI0Y2RkMjQ3ZGQzOTYyZjZkYzYyOGY3Yg==
+SHA1:
+  metadata.gz: f825a038dbf37c774aada076bb6d5c16185ed23e
+  data.tar.gz: df3bcfdc241bb68177693fa2a3603510844dd989
 SHA512:
-  metadata.gz: !binary |-
-    MzExZmU1Y2JlNjY5ZTg2ZWM2ZWVmZDU1NjNmMjM0NmEyNTZkZjg1OTUwZTAy
-    NDBiYWM5OTkwYjYyZGQ4MjhiYTliOWJmNDU2YTEzNjFmMmRlOWRiYzMyNzdj
-    Y2E5MGU5Zjc2M2ExMmU2NjU0ZjRmZDVhNDZjZDM0NWY2ZGZmM2I=
-  data.tar.gz: !binary |-
-    ZTQ5OWJiNzNkZmQzNzJmOTI1ZTkzMjFmNzNjMzBkZDIxNjhmN2Y0YWVmYjkw
-    NjlhODNjZjc4YzQ4MDgxOWQzYmY1NjdmNzA5NGU2NDEwNzg5NTY5MTFmNzYy
-    YjZmODRmMTE5ZTYwMjA4ZmY4MjY2OTI1NzQ3ZDk0YzczZmVhYWY=
+  metadata.gz: 8a63d5192abcbc7d262f61ef706713988e74c1080111329c0c6fe28781214ec82b441e7e06f6a7fc79e31b371384597f263a3a814f40296c3c846e600b28b2d9
+  data.tar.gz: 21122e91e6b8a87f49c69bb567c4c8a710359f467d98498e65de600e43937c3905cef52c5e13cbd388a2c5514f0d4c06e58cae9bc688492bb0cbce121ab2682b

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+vendor/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+before_install:
+  - gem update bundler

data/Gemfile

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

data/README.md

@@ -2,8 +2,8 @@
 _________               ______                _____                 _____
 ______  /_____ ________ ___  /______ _____  _____(_)_______ ______ ___  /_______ ________
 _  __  / _  _ \___  __ \__  / _  __ \__  / / /__  / __  __ \_  __ `/_  __/_  __ \__  ___/
-/ /_/ /  /  __/__  /_/ /_  /  / /_/ /_  /_/ / _  /  _  / / // /_/ / / /_  / /_/ /_  / 
-\__,_/   \___/ _  .___/ /_/   \____/ _\__, /  /_/   /_/ /_/ \__,_/  \__/  \____/ /_/ 
+/ /_/ /  /  __/__  /_/ /_  /  / /_/ /_  /_/ / _  /  _  / / // /_/ / / /_  / /_/ /_  /
+\__,_/   \___/ _  .___/ /_/   \____/ _\__, /  /_/   /_/ /_/ \__,_/  \__/  \____/ /_/
                 /_/                   /____/             Deploy with style!
 </pre>
 
@@ -28,9 +28,9 @@ Deployinator is a deployment framework extracted from Etsy. We've been using it
 ## Stacks
 Deployments are grouped by "stacks". You might have a "web" and "search" stack.
 
-Each of those stacks might have different deployment environments, such as "staging" or "production". 
+Each of those stacks might have different deployment environments, such as "staging" or "production".
 
-You can map a button to each of these environments,  to create multi-stage pushes within each stack. 
+You can map a button to each of these environments,  to create multi-stage pushes within each stack.
 
 ## Installation
 
@@ -55,13 +55,14 @@ you can skip the bundler steps.
 - Run the following command to make deployinator gem's rake tasks available to you:
 
 ```sh
+    $ shopt -s xpg_echo
     $ echo "require 'deployinator'\nload 'deployinator/tasks/initialize.rake' " > Rakefile
 ```
 
 - Create a binstub for the deploy log tailing backend:
 
 ```sh
-    bundle install --binstubs deployinator
+    bundle binstub etsy-deployinator
 ```
 
 - Initialize the project directory by running the following command replacing ___Company___ with the name of your company/organization. This must start with a capital letter.
@@ -116,14 +117,14 @@ underscores but if you forget the rake task will convert from camelcase for you.
     $ bundle exec shotgun --host localhost -p 7777 config.ru
 ```
 
-- You will probably want a robust server like apache to handle production traffic. 
+- You will probably want a robust server like apache to handle production traffic.
 
 - The `config/base.rb` file is the base config for the application. Replace all
 occurences of ___test_stack___ with the name you chose above. Also the example
 below uses a git repository of http://github.com/etsy/deployinator, feel free to
 replace this with your specific repository
 
-```ruby                                                                                                         
+```ruby
 Deployinator.app_context['test_stack_config'] = {
    :prod_host               => "localhost",
    :checkout_path           => "/tmp/deployinator_dev/"
@@ -232,7 +233,7 @@ For example you could wrap your capistrano deploy:
     run_cmd %Q{cap deploy}
 
 
-#### log_and_stream 
+#### log_and_stream
 
 Output information to the log file, and the streaming output handler.
 The real time output console renders HTML so you should use markup here.
@@ -241,7 +242,7 @@ The real time output console renders HTML so you should use markup here.
 
 #### log_and_shout
 
-Output an announcement message with build related information.  
+Output an announcement message with build related information.
 Also includes hooks for Email.
 
     log_and_shout({
@@ -348,8 +349,20 @@ To set these simple override the methods in your view class. For example:
 This can be done on a global layout that extends the gem's default layout or on
 a stack by stack basis in their own view.
 
+### Maintenance mode
+Deployinator has a setting for maintenance mode, which is mostly useful if you
+have major changes that affect all stacks and you want to make sure no deploys
+are going on while you make the change. In order to enable it, you have to set
+`Deployinator.maintenance_mode = true`. This will make all pages for anyone
+not in `Deployinator.admin_groups` go to `/maintenance`. As a Deployinator
+admin you can then still deploy stacks and use the app.
+
+On the maintenance page Deployinator will show the value of
+`Deployinator.maintenance_contact` as the place to get help in case you need
+any or are confused about maintenance mode.
+
 ## Hacking on the gem
-If you find issues with the gem, or would like to play around with it, you can check it out from git and start hacking on it. 
+If you find issues with the gem, or would like to play around with it, you can check it out from git and start hacking on it.
 First tell bundler to use your local copy instead by running:
 ```sh
     $ bundle config local.deployinator /path/to/DeployinatorGem
@@ -359,6 +372,30 @@ Next, on every code change, you can install from the checked out gem by running
     $ bundle install --no-deployment && bundle install --deployment
 ```
 
+### Stats dashboard
+The `/stats` page pulls from `log/deployinator.log` to show a graph of deployments per day for each stack over time. By default, it shows all stacks. To blacklist or whitelist certain stacks, update `config/base.rb` with:
+```rb
+  Deployinator.stats_included_stacks = ['my_whitelisted_stack', 'another_whitelisted_stack']
+  Deployinator.stats_ignored_stacks = ['my_stack_to_ignore', 'another_stack_to_ignore']
+  Deployinator.stats_extra_grep = 'Production deploy' # filter out log entries matching this string
+```
+
+Whitelisting stacks or applying a custom extra grep can help speed up graph rendering when you have a large log file.
+
+If at some point you change the name of a stack, you can group the old log entries with the new by adding the following to `config/base.rb`:
+
+```rb
+ Deployinator.stats_renamed_stacks = [
+   {
+     :previous_stack => {
+       :stack => [ "old_stack_name" ]
+     },
+     :new_name => "new_stack_name"
+   }
+ ]
+```
+
+
 ### Contributing
 
 1. Fork it

data/Rakefile

@@ -1,4 +1,3 @@
-
 require 'rake/testtask'
 require 'rdoc/task'
 require 'bundler/gem_tasks'

data/bin/deployinator-tailer.rb

@@ -54,8 +54,8 @@ EM.run do
         if stack && @@channels.key?(stack)
           @@channels[stack].unsubscribe(session_id)
           @@channels_count[stack] -= 1
-          if @@channels_count[stack] == 0
-            @@tailers[stack].close
+          if @@channels_count[stack] == 0 && @@tailers.has_key?(stack)
+            @@tailers[stack].close 
             @@tailers.delete(stack)
           end
         end

data/deployinator.gemspec

@@ -20,14 +20,18 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_development_dependency "mocha", "~> 0.14"
+  gem.add_development_dependency "test-unit", ">= 3"
 
   gem.add_runtime_dependency "rake", "~> 10", ">= 10.3.2"
   gem.add_runtime_dependency "json", "~> 1.8"
   gem.add_runtime_dependency "mustache", "~> 0.99"
+  # pony pulls in mail >2.0. mail 3.0 needs ruby 2 or greater. to maintain ruby 1.9 compat we're pinning mail here
+  gem.add_runtime_dependency "mail", "2.6.3"
   gem.add_runtime_dependency "pony", "~> 1.5"
   gem.add_runtime_dependency "tlsmail", "~> 0.0"
   gem.add_runtime_dependency "eventmachine", "~> 1.0", ">= 1.0.4"
-  gem.add_runtime_dependency "eventmachine-tail", "~> 0.6", ">= 0.6.4"
+  gem.add_runtime_dependency "eventmachine-tail", "~> 0.6", ">= 0.6.5"
   gem.add_runtime_dependency "em-websocket", "~> 0.5", ">= 0.5.1"
   gem.add_runtime_dependency "sinatra", "~> 1.4", ">=1.4.3"
+  gem.add_runtime_dependency "celluloid", "~> 0.16"
 end

data/lib/deployinator.rb

@@ -54,10 +54,27 @@ module Deployinator
     attr_accessor :admin_groups
     @admin_groups = []
 
+    attr_accessor :maintenance_mode
+
+    attr_accessor :maintenance_contact
+
     # the controller class. defaults to Deployinator::Controller
     # if you override this it should be a subclass of Deployinator::Controller
     attr_accessor :deploy_controller
 
+    # include stacks in /stats
+    attr_accessor :stats_included_stacks
+
+    # exclude stacks in /stats, even if present in stats_included_stacks
+    attr_accessor :stats_ignored_stacks
+
+    # filter log entries in /stats
+    attr_accessor :stats_extra_grep
+
+    # list of configurations for grouping historical / renamed stacks in /stats
+    attr_accessor :stats_renamed_stacks
+    @@stats_renamed_stacks = []
+
     def initialize
       @stack_plugins = {}
       @global_plugins = []
@@ -101,12 +118,14 @@ end
 Deployinator.root_dir = Dir.pwd
 Deployinator.app_context = {}
 Deployinator.admin_groups = []
+Deployinator.maintenance_mode = false
+Deployinator.maintenance_contact = "admin@deployinator.example.com"
 Deployinator.global_plugins = []
 Deployinator.log_file = Deployinator.root(["log", "development.log"])
 Deployinator.log_path = Deployinator.root(["log", "deployinator.log"])
 Deployinator.timing_log_path = Deployinator.root(["log", "deployinator-timing.log"])
 Deployinator.git_sha_length = "10"
-Deployinator.default_user = `whoami`
+Deployinator.default_user = `/usr/bin/whoami`
 Deployinator.stack_tailer_port = 7778
 Deployinator.github_host = 'github.com'
 Deployinator.app_context['context'] = 'dev'

data/lib/deployinator/app.rb

@@ -12,6 +12,8 @@ require 'deployinator/views/log'
 require 'deployinator/views/run_logs'
 require 'deployinator/views/log_table'
 require 'deployinator/views/deploys_status'
+require 'deployinator/views/stats'
+require 'deployinator/views/maintenance'
 
 module Deployinator
   class DeployinatorApp < Sinatra::Base
@@ -41,12 +43,32 @@ module Deployinator
       register_plugins(nil)
       init(env)
       @disabled_override = params[:override].nil? ? false : true
+      pass if [
+        "/maintenance",
+        "/css/maintenance.css",
+        "/images/maintenance.gif",
+        "/static/css/style.css"
+      ].include? request.path_info
+      if Deployinator.maintenance_mode == true && !is_admin?
+        redirect "/maintenance"
+      end
+    end
+
+    before do
     end
 
     get '/' do
         mustache Deployinator::Views::Index
     end
 
+    get '/stats' do
+        mustache Deployinator::Views::Stats
+    end
+
+    get '/maintenance' do
+        mustache Deployinator::Views::Maintenance
+    end
+
     get '/run_logs/view/:log' do
       template = open("#{File.dirname(__FILE__)}/templates/stream.mustache").read
       template.gsub!("{{ yield }}", "{{{yield}}}")
@@ -95,17 +117,6 @@ module Deployinator
       git_head_rev(params[:stack]).chomp
     end
 
-    get '/:thing' do
-      @stack = params[:thing]
-      @params = params
-      register_plugins(@stack)
-      begin
-        mustache @stack
-      rescue Errno::ENOENT
-        pass
-      end
-    end
-
     get '/:stack/remove-lock' do
       stack = params[:stack]
       unlock_pushes(stack) if can_remove_stack_lock?
@@ -129,6 +140,10 @@ module Deployinator
       send_file "#{File.dirname(__FILE__)}/static/css/highlight.css"
     end
 
+    get '/css/maintenance.css' do
+      send_file "#{File.dirname(__FILE__)}/static/css/maintenance.css"
+    end
+
     get '/js/flot/jquery.flot.min.js' do
       send_file "#{File.dirname(__FILE__)}/static/js/flot/jquery.flot.min.js"
     end
@@ -149,6 +164,14 @@ module Deployinator
       send_file "#{File.dirname(__FILE__)}/static/js/jquery.timed_bar.js"
     end
 
+    get '/js/stats_load.js' do
+      send_file "#{File.dirname(__FILE__)}/static/js/stats_load.js"
+    end
+
+    get '/images/maintenance.gif' do
+      send_file "#{File.dirname(__FILE__)}/static/images/maintenance.gif"
+    end
+
     get '/deploys_status' do
         mustache Deployinator::Views::DeploysStatus
     end
@@ -172,6 +195,7 @@ module Deployinator
     # the background.
     post '/deploys/?' do
       params[:username] = @username
+      params[:groups] = @groups
       params[:block] = Proc.new { |line| foo = line }
       deploy_running = is_deploy_active?(params[:stack], params[:stage])
 
@@ -180,7 +204,7 @@ module Deployinator
         return 403
       end
 
-      fork {
+      pid = fork {
         Signal.trap("HUP") { exit }
         Deployinator.setup_logging
         $0 = get_deploy_process_title(params[:stack], params[:stage])
@@ -188,6 +212,7 @@ module Deployinator
         d = controller.new
         d.run(params)
       }
+      Process.detach(pid)
       200
     end
 
@@ -200,5 +225,21 @@ module Deployinator
 
       200
     end
+
+    get '/:thing' do
+      @stack = params[:thing]
+
+      unless Deployinator.get_stacks.include?(@stack)
+        raise "No such stack #{@stack}"
+      end
+
+      @params = params
+      register_plugins(@stack)
+      begin
+        mustache @stack
+      rescue Errno::ENOENT
+        pass
+      end
+    end
   end
 end

data/lib/deployinator/controller.rb

@@ -29,6 +29,7 @@ module Deployinator
       @deploy_start_time = Time.now.to_i
       @start_time = Time.now.to_i
       @username = args[:username]
+      @groups = args[:groups]
       @host     = `hostname -s`
       @stack = args[:stack]
       @method = args[:method]
@@ -37,7 +38,7 @@ module Deployinator
 
       # This gets the runlog output on the console; is used by log_and_stream
       @block = args[:block] || Proc.new do |output|
-        $stdout.write output.gsub!(/(<[^>]*>)|\n|\t/s) {" "}
+        $stdout.write output.gsub!(/(<[^>]*>)|\n|\t/m) {" "}
         $stdout.write "\n"
       end
     end
@@ -102,7 +103,11 @@ module Deployinator
       deploy_instance = deploy_class.new(options)
       deploy_instance.register_plugins(options[:stack])
 
-      deploy_instance.lock_pushes(options[:stack], options[:username], options[:method])
+      locked = deploy_instance.lock_pushes(options[:stack], options[:username], options[:method])
+
+      unless locked
+        return deploy_instance
+      end
 
       @start_time = Time.now
       deploy_instance.log_and_stream "Push started at #{@start_time.to_i}\n"
@@ -115,7 +120,7 @@ module Deployinator
         state = deploy_instance.send(options[:method], options)
       rescue Exception => e
         deploy_instance.log_error("There was an exception during this deploy. Aborted!", e)
-        deploy_instance.raise_event(:deploy_error)
+        deploy_instance.raise_event(:deploy_error, {:exception => e})
       end
 
       if state.nil? || !state.is_a?(Hash)

data/lib/deployinator/helpers.rb

@@ -75,11 +75,37 @@ module Deployinator
     #
     # Returns nothing
     def log_and_stream(output)
-      write_file output, @filename if @filename
+      write_file output, runlog_filename if runlog_filename
       return @block.call(output) unless @block.nil?
       ""
     end
 
+    # gives the filename to send runlog to based on whether we are in the main thread or not
+    # We do this because we want to be able to use log_and_stream seamlessly in a
+    # parallel thread. So, all log_and_stream calls in all but the main thread will
+    # log to a seaparate file
+    # output - String filename to log to
+    def runlog_filename(name=nil)
+      if @filename
+        if Thread.main == Thread.current
+          @filename
+        elsif Thread.current[:logfile_name]
+          Thread.current[:logfile_name]
+        elsif name
+          Thread.current[:logfile_name] = runlog_thread_filename(name)
+          Thread.current[:logfile_name]
+        else
+          raise 'Logfile name not defined in thread. Expecting name parameter to be passed in.'
+        end
+      end
+    end
+
+    # gives us the filename to log to in thread
+    # output - String filename for thread
+    def runlog_thread_filename(name)
+      @filename + '-' + name.to_s
+    end
+
     # Run external command with timing information
     # streams and logs the output of the command as well
     # If the command fails, it is retried some number of times
@@ -343,7 +369,7 @@ module Deployinator
       end
     end
 
-    # Public: gets the contes from a cache file if it hasn't expired
+    # Public: gets the contents from a cache file if it hasn't expired
     #
     # Paramaters:
     #    cache_file: path to a cache file
@@ -370,14 +396,30 @@ module Deployinator
       end
     end
 
+    # Public: writes the supplied contents to the cache file, ensuring that
+    # encoding is correct
+    #
+    # Parameters:
+    #    cache_file: path to the cache file
+    #    content: the data to write to the file
+    #
+    # Returns nothing
+    def write_to_cache(cache_file, contents)
+      File.open(cache_file, 'w:UTF-8') do |f|
+        f.write(contents.force_encoding('UTF-8'))
+      end
+    end
+
     def lock_pushes(stack, who, method)
-      log_and_stream("LOCKING #{stack}")
+      log_and_stream("LOCKING #{stack}<br>")
       if lock_info = push_lock_info(stack)
-        return log_and_stream("Pushes locked by #{lock_info[:who]} - #{lock_info[:method]}")
+        log_and_stream("Pushes locked by #{lock_info[:who]} - #{lock_info[:method]}<br>")
+        return false
       end
 
       dt = Time.now.strftime("%m/%d/%Y %H:%M")
       log_string_to_file("#{who}|#{method}|#{dt}", push_lock_path(stack))
+      return true
     end
 
     def unlock_pushes(stack)
@@ -424,16 +466,19 @@ module Deployinator
 
     # Public: wrap a block into a timeout
     #
-    # seconds     - timeout in seconds
-    # description - optional description for logging (default:"")
-    # &block      - block to call
+    # seconds         - timeout in seconds
+    # description     - optional description for logging (default:"")
+    # throw_exception - options param to throw exception back up stack
+    # quiet           - optional boolean for logging as a big red warning using the stderr div class
+    # extra_opts      - optional hash to pass along to plugins
+    # &block          - block to call
     #
     # Example
     #   with_timeout(20){system("curl -s http://google.com")}
     #   with_timeout 30 do; system("curl -s http://google.com"); end
     #
     # Returns nothing
-    def with_timeout(seconds, description=nil,  &block)
+    def with_timeout(seconds, description=nil, throw_exception=false, quiet=false, extra_opts={}, &block)
       begin
         Timeout.timeout(seconds) do
           yield
@@ -443,13 +488,22 @@ module Deployinator
         info += " for #{description}" unless description.nil?
         # log and stream if log filename is not undefined
         if (/undefined/ =~ @filename).nil?
-          log_and_stream "<div class=\"stderr\">#{info}</div>"
+          if quiet
+            log_and_stream "#{info}<br>"
+          else
+            log_and_stream "<div class=\"stderr\">#{info}</div>"
+          end
         end
         state = {
           :seconds => seconds,
-          :info => info
+          :info => info,
+          :stack => stack,
+          :extra_opts => extra_opts
         }
         raise_event(:timeout, state)
+        if throw_exception
+          raise e
+        end
         ""
       end
     end
@@ -492,7 +546,7 @@ module Deployinator
       raise "Must have stack" unless options[:stack]
 
       options[:env] ||= "PROD"
-      options[:nice_env] = nicify_env(options[:env])
+      options[:nice_env] ||= nicify_env(options[:env])
       options[:user] ||= @username
       options[:start] = @start_time unless options[:start] || ! @start_time
 
@@ -548,7 +602,7 @@ module Deployinator
       # stack should be the last part of the log line from the last pipe to the end
       # modified this to take into account the run_log entry at the end
       unless stacks.empty? && env.empty?
-        grep = "| egrep '#{env}.*\\|\(#{stacks.join("|")}\)(|(\\||$))?'"
+        grep = "| egrep '#{env}.*\\|\(#{stacks.join("|")}\)\\|'"
       end
 
       # extra grep does another filter to the line, needed to get CONFIG PRODUCTION
@@ -600,11 +654,53 @@ module Deployinator
       log_msg = e.nil? ? msg : "#{msg} (#{e.message})"
       log_and_stream "<div class=\"stderr\">#{log_msg}</div>"
       if !e.nil?
-        log_and_stream e.backtrace.inspect
+        begin
+          template = open("#{File.dirname(__FILE__)}/templates/exception.mustache").read
+
+          regex = /(?<file>.*?):(?<line>\d+):.*?`(?<method>.*)'/
+          context = e.backtrace.map do |line|
+            match = regex.match(line)
+            {
+              :file => match['file'],
+              :line => match['line'],
+              :method => match['method']
+            }
+          end
+
+          output = Mustache.render(template, {:exceptions => context})
+          log_and_stream output
+        rescue
+          log_and_stream e.backtrace.inspect
+        end
       end
       # This is so we have something in the log if/when this fails
       puts log_msg
     end
 
+    # Public: helper method to check if the current user is part of
+    # an group. This method let's you pass in groups for explicitness and
+    # testing but will fall back on @group and Deployinator.admin_groups.
+    #
+    # Param:
+    #  user_groups  - groups a user is part of
+    #  admin_groups - admin groups
+    #
+    # Returns true if the current user is part of and admin group and false
+    # otherwise
+    def is_admin?(user_groups=nil, admin_groups=nil)
+      user_groups  ||= @groups
+      admin_groups ||= Deployinator.admin_groups
+
+      return false if user_groups.nil?
+      return false if admin_groups.nil?
+
+      intersected_groups = user_groups & admin_groups
+
+      # if we found an intersection between admin and user groups, the current
+      # user is an admin
+      return (intersected_groups.length > 0)
+
+    end
+
   end
 end