hell 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "jeweler"
+end
+
+
+gem 'capistrano'
+gem 'json'
+
+gem 'sinatra'
+gem 'sinatra-contrib'
+gem 'thin'
+gem 'websocket'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jose Diaz-Gonzalez
+
+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.markdown

@@ -0,0 +1,108 @@
+# Hell
+
+An interactive web ui for Capistrano that also provides a json api
+
+![http://cl.ly/image/0R2H1J0t0c35](http://cl.ly/image/0R2H1J0t0c35/s10e11_480.jpg)
+
+## Requirements
+
+- Ruby 1.9.2
+- Bundler
+
+## Installation
+
+Simply add `hell` as a dependency in your Gemfile:
+
+	source 'http://rubygems.org'
+	source 'http://gems.github.com'
+
+	gem 'hell'
+
+And then run the following in your app directory:
+
+	bundle install
+
+## Usage
+
+Once installed, you'll want to run the `hell` binary:
+
+	hell
+
+Note that if you have multiple capistrano versions installed for multiple repositories, you may need to instead use:
+
+	bundle exec hell
+
+Then open `localhost:4567` in your browser to get an interactive interface around your capistrano recipes.
+
+### Running commands
+
+Hell provides an autocompleted list of all capistrano tasks you have setup, and you can run this against a specific environment as necessary. By default, hell will start the command in the background, and then use an `EventSource` to read the generated logfile.
+
+When you run a task, that task is added to your history so that you may re-read the logs at a later date, as well as re-run the tasks as necessary. This history is done using `localstorage`, and as such is not shared amongst different users of your application.
+
+Note that Hell does not provide persistence of generated tasks, nor does it perform locking of individual tasks. For now, suggest using tools such as [Logstash](http://logstash.net/) to persist the logs, and using locking techniques within your capistrano tooling instead.
+
+
+### Capistrano as an API
+
+Inspired by Github's internal [Heaven](https://github.com/blog/1241-deploying-at-github) app, Hell provides a simple, rest-like json api around Capistrano. XML-RPC implementation to come.
+
+Available endpoints:
+
+- `/tasks`: List all available tasks
+- `/tasks/search/:pattern`: Search for a given, non-regex pattern
+- `/tasks/:name/background`: Kicks off the execution of a task in the background and writes the output to a log file. Will respond with an id for future log file recovery.
+- `/tasks/:name/exists`: Checks if a task exists
+- `/tasks/:name/execute`: Kicks off the execution of a task and responds with the results using the sinatra streaming api. EventSource-compatible.
+- `/logs/:id/tail`: Using the id provided by `/tasks/:name/background`, will start a sinatra stream on the log file in question.
+- `/logs/:id/view`: Using the id provided by `/tasks/:name/background`, will output the current contents of a logfile. Useful for later recovery of the logs through the web api.
+
+Note that the current response is subject to change, and as such is not documented, though we will attempt to augment rather than change them.
+
+### Configuration
+
+The following environment variables are available for your use:
+
+- `HELL_APP_ROOT`: Path from which capistrano should execute. Defaults to `Dir.pwd`.
+- `HELL_ENVIRONMENTS`: Comma-separated list of environments, Default: `production,staging`.
+- `HELL_REQUIRE_ENV`: Whether or not to require specifying an environment. Default: `1`.
+- `HELL_LOG_PATH`: Path to which logs should be written to. Defaults to `Dir.pwd + '/log'`.
+- `HELL_BASE_DIR`: Base directory to use in web ui. Useful for subdirectories. Defaults to `/`.
+- `HELL_SENTINEL_STRINGS`: Sentinel string used to denote the end of a task run. Defaults to `Hellish Task Completed`.
+
+## TODO
+
+* ~~Finish the execute task so that it sends output to the browser~~
+* ~~Figure out where/how to store deploy logs on disk~~
+* ~~Blacklist tasks from being displayed~~
+* ~~Add support for environment variables~~
+* ~~Add support for deployment environments~~
+* ~~Add support for ad-hoc deploy callbacks~~
+* Save favorite commands as buttons
+* Save defaults in a cookie
+* Use a slide-up element for task output
+* Add optional task locking so that deploys cannot interfere with one-another
+* Add ability to use pusher instead of sinatra streaming
+
+## License
+
+Copyright (c) 2012 Jose Diaz-Gonzalez
+
+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/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hell"
+  gem.homepage = "http://github.com/seatgeek/hell"
+  gem.license = "MIT"
+  gem.summary = %Q{A web interface and api wrapper around Capistrano}
+  gem.description = %Q{Hell is an open source web interface that exposes a set of capistrano recipes as a json api, for usage within large teams}
+  gem.email = "jose@seatgeek.com"
+  gem.authors = ["Jose Diaz-Gonzalez"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hell #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/hell

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+begin
+  require 'hell/app.rb'
+rescue LoadError => e
+  require 'rubygems'
+  path = File.expand_path '../../lib', __FILE__
+  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
+  require 'hell/app.rb'
+end
+
+Hell::App.run!

data/lib/hell/app.rb

@@ -0,0 +1,128 @@
+#!/bin/env ruby
+
+require 'sinatra'
+require 'sinatra/base'
+require 'sinatra/json'
+require 'sinatra/streaming'
+
+require 'json'
+require 'securerandom'
+require 'websocket'
+
+HELL_DIR = Dir.pwd
+APP_ROOT = ENV.fetch('HELL_APP_ROOT', HELL_DIR)
+ENVIRONMENTS = ENV.fetch('HELL_ENVIRONMENTS', 'production,staging').split(',')
+BLACKLIST = ['invoke', 'shell', 'internal:ensure_env', 'internal:setup_env']
+REQUIRE_ENV = ENV.fetch('HELL_REQUIRE_ENV', '1') == '1'
+HELL_LOG_PATH = ENV.fetch('HELL_LOG_PATH', File.join(HELL_DIR, 'log'))
+HELL_BASE_DIR = ENV.fetch('HELL_BASE_DIR', '/')
+SENTINEL_STRINGS = ENV.fetch('HELL_SENTINEL_STRINGS', 'Hellish Task Completed').split(',')
+
+require 'hell/lib/monkey_patch'
+require 'hell/lib/helpers'
+
+
+module Hell
+  class App < Sinatra::Base
+    helpers Sinatra::JSON
+    helpers Sinatra::Streaming
+    helpers Hell::Helpers
+
+    cap = Capistrano::CLI.parse(["-T"])
+
+    set :public_folder, File.join(File.expand_path('..', __FILE__), 'public')
+    set :root, HELL_DIR
+    set :server, :thin
+    set :static, true
+    set :views, File.join(File.expand_path('..', __FILE__), 'views')
+
+    configure :production, :development do
+      enable :logging
+    end
+
+    get '/' do
+      @tasks = cap.task_index.keys
+      @require_env = REQUIRE_ENV
+      @www_base_dir = HELL_BASE_DIR
+      @environments = ENVIRONMENTS
+      erb :index
+    end
+
+    get '/tasks' do
+      tasks = cap.task_index
+      json tasks
+    end
+
+    get '/tasks/search/:pattern' do
+      tasks = cap.task_index(params[:pattern])
+      json tasks
+    end
+
+    get '/tasks/:name/exists' do
+      tasks = cap.task_index(params[:name], {:exact => true})
+      response = { :exists => !tasks.empty?, :task => params[:name]}
+      json response
+    end
+
+    get '/tasks/:name/background' do
+      tasks, original_cmd = verify_task(cap, params[:name])
+      verbose = ""
+      verbose = "LOGGING=debug" if params[:verbose] == true
+
+      task_id = run_in_background!("bundle exec cap -l STDOUT %s %s" % [original_cmd, verbose]) unless tasks.empty?
+      response = {}
+      response[:status] = tasks.empty? ? 404 : 200,
+      response[:message] = tasks.empty? ? "Task not found" : "Running task in background",
+      response[:task_id] = task_id unless tasks.empty?
+      json response
+    end
+
+    get '/logs/:id/tail' do
+      content_type "text/event-stream"
+      if valid_log params[:id]
+        _stream_success("tail -f %s" % File.join(HELL_LOG_PATH, params[:id] + ".log"))
+      else
+        _stream_error("log file '#{params[:id]}' not found")
+      end
+    end
+
+    get '/logs/:id/view' do
+      log_path = File.join(HELL_LOG_PATH, params[:id] + ".log")
+      logger.info log_path
+      ansi_escape(File.read(log_path))
+    end
+
+    get '/tasks/:name/execute' do
+      tasks, original_cmd = verify_task(cap, params[:name])
+      content_type "text/event-stream"
+      if tasks.empty?
+        _stream_error("cap task '#{original_cmd}' not found")
+      else
+        _stream_success("bundle exec cap -l STDOUT #{original_cmd} LOGGING=debug 2>&1", {:prepend => true})
+      end
+    end
+
+    def _stream_error(message)
+      stream do |out|
+        out << "event: start\ndata:\n\n" unless out.closed?
+        out << "data: " + ws_message("<p>#{message}</p>") unless out.closed?
+        out << "event: end\ndata:\n\n" unless out.closed?
+        out.close
+      end
+    end
+
+    def _stream_success(command, opts = {})
+      opts = {:prepend => false}.merge(opts)
+      stream do |out|
+        out << "event: start\ndata:\n\n" unless out.closed?
+        out << "data: " + ws_message("<p>#{command}</p>") unless out.closed? or opts[:prepend] == false
+        IO.popen(command, 'rb') do |io|
+          io.each do |line|
+            process_line(line, out, io)
+          end
+        end
+        close_stream(out)
+      end
+    end
+  end
+end

data/lib/hell/config.ru

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby
+require './app'
+
+run Hell::App

data/lib/hell/lib/helpers.rb

@@ -0,0 +1,119 @@
+module Hell
+  class TailDone < StandardError; end
+
+  module Helpers
+    def escape_to_html(data)
+      {
+        1 => :nothing,
+        2 => :nothing,
+        4 => :nothing,
+        5 => :nothing,
+        7 => :nothing,
+        8 => :backspace,
+        30 => "#303030",
+        31 => "#D10915",
+        32 => "#53A948",
+        33 => "#CD7D3D",
+        34 => "#3582E0",
+        35 => :magenta,
+        36 => "#30EFEF",
+        37 => :white,
+        40 => :nothing,
+        41 => :nothing,
+        43 => :nothing,
+        44 => :nothing,
+        45 => :nothing,
+        46 => :nothing,
+        47 => :nothing,
+      }.each do |key, value|
+        if value == :nothing
+          data.gsub!(/\e\[#{key}m/,"<span>")
+        elsif value == :backspace
+          data.gsub!(/.[\b]/, '')
+        else
+          data.gsub!(/\e\[#{key}m/,"<span style=\"color:#{value}\">")
+        end
+      end
+      data.gsub!(/\e\[0m/, '</span>')
+      data.gsub!(/\e\[0/, '</span>')
+      # data.gsub!(' ', '&nbsp;')
+      data
+    end
+
+    def ansi_escape(message)
+      escape_to_html(utf8_dammit(message))
+    end
+
+    def ws_message(message)
+      message = {:message => ansi_escape(message)}.to_json + "\n\n"
+    end
+
+    def process_line(line, out, io)
+      begin
+        out << "data: " + ws_message(line) unless out.closed?
+        raise TailDone if SENTINEL_STRINGS.any? { |w| line =~ /#{w}/ }
+      rescue
+        Process.kill("KILL", io.pid)
+      end
+    end
+
+    def close_stream(out)
+      out << "event: end\ndata:\n\n" unless out.closed?
+      out.close
+    end
+
+    def run_in_background!(background_cmd)
+      log_file = Time.now.to_i.to_s + '.' + SecureRandom.hex(2)
+      cmd = [
+        "cd #{APP_ROOT}",
+        "echo '#{background_cmd}' >> #{HELL_LOG_PATH}/#{log_file}.log 2>&1",
+        "#{background_cmd} >> #{HELL_LOG_PATH}/#{log_file}.log 2>&1",
+        "echo 'Hellish Task Completed' >> #{HELL_LOG_PATH}/#{log_file}.log 2>&1",
+      ].join(" && ")
+      system("sh -c \"#{cmd}\" &")
+
+      # Wait up to three seconds in case of server load
+      i = 0
+      while i < 3
+        i += 1
+        break if File.exists?(File.join(HELL_LOG_PATH, log_file + ".log"))
+        sleep 1
+      end
+
+      log_file
+    end
+
+    def verify_task(cap, name)
+      original_cmd = name.gsub('+', ' ')
+      cmd = original_cmd.split(' ')
+      cmd.shift if ENVIRONMENTS.include?(cmd.first)
+      cmd = cmd.join(' ')
+
+      tasks = cap.task_index(cmd, {:exact => true})
+      return tasks, original_cmd
+    end
+
+    def valid_log(id)
+      File.exists?(File.join(HELL_LOG_PATH, id + ".log"))
+    end
+
+    def utf8_dammit(s)
+      # Converting ASCII-8BIT to UTF-8 based domain-specific guesses
+      if s.is_a? String
+        begin
+          # Try it as UTF-8 directly
+          cleaned = s.dup.force_encoding('UTF-8')
+          unless cleaned.valid_encoding?
+            # Some of it might be old Windows code page
+            cleaned = s.encode( 'UTF-8', 'Windows-1252' )
+          end
+          s = cleaned
+        rescue EncodingError
+          # Force it to UTF-8, throwing out invalid bits
+          s.encode!('UTF-8', :invalid => :replace, :undef => :replace)
+        end
+        s
+      end
+    end
+  end
+end