ops 1.0.0.pre → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a2c4cc3db903a62379145de252980257d0f9116
-  data.tar.gz: 097364bd5ae78bbc864132377d3ccd27a5d0575d
+  metadata.gz: c5858a2e0dde21d89b70cb34b9e96ca51829443c
+  data.tar.gz: d502e55582d6d4ff4b027c7f5dc507c2f1816da4
 SHA512:
-  metadata.gz: 6f07d97daec0091594c703442587814e703fb7c8f9f9562cb03e521cb2ba21df64757150c02ebd86e388677afe530a757d2f80f0f1978ad828cca3fe4aed2d02
-  data.tar.gz: 1432a8c961924d408d6269819967fc86b82d78485689192a8c90c684c3d1b6576bd709f37ad7135980d6a2f66b59288ca3d992b09561f49ce1c119c7763bee80
+  metadata.gz: eb1b3cafc156a9da0719726ca846d84c74d1ab2da4fd0689573a640515878413538d33688f113a1d25fa2a9d8360fb4d4b9933ce640281ad8178ff4639fabff4
+  data.tar.gz: f70c5bcdb1be85cf20d36064a72035301f75a2f1bef054838924c710915e27691dc25200c5bd816d370543fea98c88a1138217f8b3fdf32e2fae877c617071d4

data/README.md

@@ -1,9 +1,22 @@
-Ops
-===
+# Ops
+This gem provides standardized support for obtaining environment, version, and heartbeat information from Sinatra or Rails-based web applications.
 
 [![Code Climate](https://codeclimate.com/github/primedia/ops.png)](https://codeclimate.com/github/primedia/ops)
+[![Build Status](https://travis-ci.org/rentpath/ops.svg?branch=master)](https://travis-ci.org/rentpath/ops)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Installation](#installation)
+  - [For Rails apps:](#for-rails-apps)
+  - [For Sinatra apps:](#for-sinatra-apps)
+- [Adding Custom Heartbeats](#adding-custom-heartbeats)
+- [The Configuration Service Adapter (Optional)](#the-configuration-service-adapter-optional)
+  - [Running tests](#running-tests)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-This gem provides standardized support for obtaining environment, version, and heartbeat information from Sinatra or Rails-based web applications.
 
 **You will likely want to block or restrict access to the following routes:**
 
@@ -27,7 +40,7 @@ This gem replaces the now-deprecated [ops_routes](https://github.com/rentpath/op
 Installation
 ------------
 
-### For Rails 3 apps:
+### For Rails apps:
 
 1. Add the gem to your project's Gemfile:
     ```ruby
@@ -40,6 +53,7 @@ Installation
     Ops.setup do |config|
       config.file_root = Rails.root
       config.environment = Rails.env
+      config.repo_name = 'my_repository_name'
       config.config_service_adapter = something_that_responds_to_call # optional
     end
     ```
@@ -79,8 +93,8 @@ Installation
     ```ruby
     # Implementation within rack cascade:
     run Rack::Cascade.new([
-      NewHomeGuide,
-      ListingSearch::App,
+      MyApp,
+      MySearch::App,
       Ops.rack_app('/ops')
     ])
     ```
@@ -98,7 +112,10 @@ Ops.add_heartbeat :mysql do
 end
 ```
 
-The mysql example shown above would be accessed at ops/heartbeat/mysql. The heartbeat page will return a `200 ‘OK’` as long as the provided block returns true. If an error is raised, the heartbeat does not exist, or the block returns a falsey value, a `500` will be returned instead.
+The mysql example shown above would be accessed at ops/heartbeat/mysql.
+The heartbeat page will return a `200 ‘OK’` as long as the provided block returns true.
+If an error is raised, the heartbeat does not exist, or the block returns a falsey value,
+a `500` will be returned instead.
 
 
 ## The Configuration Service Adapter (Optional)
@@ -124,3 +141,6 @@ Proc.new { |_| { key: 'value' } }
 
 Then just provide your "callable" per the installation instructions above.
 
+### Running tests
+
+    script/test

data/lib/ops.rb

@@ -11,10 +11,9 @@ module Ops
     end
 
     def rack_app(path)
-      Rack::Builder.new {
+      Rack::Builder.new do
         map(path) { run Ops.new }
-      }.to_app
+      end.to_app
     end
   end
 end
-

data/lib/ops/config.rb

@@ -1,6 +1,6 @@
 module Ops
   class Config
-    def initialize(data={})
+    def initialize(data = {})
       @data = {}
       update!(data)
     end
@@ -16,16 +16,16 @@ module Ops
     end
 
     def []=(key, value)
-      if value.class == Hash
-        @data[key.to_sym] = Config.new(value)
-      else
-        @data[key.to_sym] = value
-      end
+      @data[key.to_sym] = if value.class == Hash
+                            Config.new(value)
+                          else
+                            value
+                          end
     end
 
-    def method_missing(sym, *args)
+    def method_missing(sym, *args) # rubocop:disable Style/MethodMissing
       if sym.to_s =~ /(.+)=$/
-        self[$1] = args.first
+        self[Regexp.last_match(1)] = args.first
       else
         self[sym]
       end

data/lib/ops/heartbeat.rb

@@ -23,13 +23,10 @@ module Ops
     end
 
     def check(name)
-      begin
-        return heartbeats[name.to_sym].call
-      rescue Exception => e
-        # print stacktrace for error raised by executing block
-        puts "Exception: #{e}\n#{e.backtrace[2..-1].join("\n")}" unless heartbeats[name.to_sym].nil?
-        return false
-      end
+      return heartbeats[name.to_sym].call
+    rescue StandardError => e
+      puts "Error: #{e}\n#{e.backtrace[2..-1].join("\n")}" unless heartbeats[name.to_sym].nil?
+      return false
     end
   end
 

data/lib/ops/revision.rb

@@ -1,63 +1,121 @@
-require 'yaml'
-
 module Ops
   class Revision
-    attr_reader :file_root
+    attr_writer :branch_source
 
-    def initialize(new_headers={}, opts = Ops.config)
+    def initialize(new_headers = {}, opts = Ops.config)
       @file_root = opts.file_root.to_s # convert to string in case they pass us a Pathname
       @environment = opts.environment
       @headers = new_headers
     end
 
-    def environment
-      @environment
+    def version_or_branch
+      @version ||= if version_file?
+                     chomp(version_file).gsub('^{}', '')
+                   elsif development? && branch_source.call =~ /^\* (.*)$/
+                     Regexp.last_match(1)
+                   else
+                     'Unknown (VERSION file is missing)'
+                   end
     end
 
-    def headers
-      @headers.select{|k,v| k.match(/^[-A-Z_].*$/) }
+    def previous_versions
+      @previous_versions ||= get_previous_by_time
     end
 
-    def info
-      @info ||= build_info.merge(deploy_info)
+    def get_previous_by_time
+      get_previous_versions.sort_by { |a| a[:time] }
     end
 
-    def previous_info
-      @previous_info ||= previous_build_info.merge(previous_deploy_info)
+    def get_previous_versions
+      Dir["#{path}/../*"].each_with_object([]) do |dir, array|
+        next if dir =~ /#{current_dir}$/
+        version, revision = File.join(dir, 'VERSION'), File.join(dir, 'REVISION')
+        array << stats_hash(version: version, revision: revision) if File.exist?(version) && File.exist?(revision)
+      end
     end
 
-    private
+    def path
+      File.absolute_path file_root
+    end
 
-    def build_info
-      info_from_file('BUILD-INFO')
+    def current_dir
+      file_root.split('/').last
     end
 
-    def previous_build_info
-      info_from_file('PREVIOUS-BUILD-INFO')
+    def stats_hash(files)
+      { version:  get_version(files[:version]),
+        revision: get_revision(files[:revision]),
+        time:     get_time(files[:revision]) }
     end
 
-    def deploy_info
-      info_from_file('DEPLOY-INFO')
+    def get_version(file)
+      chomp(file).gsub('^{}', '')
     end
 
-    def previous_deploy_info
-      info_from_file('PREVIOUS-DEPLOY-INFO')
+    def get_revision(file)
+      chomp file
     end
 
-    def info_from_file(name)
-      if file_exists?(name)
-        parse_info_file(name)
-      else
-        {name.downcase.gsub('-', '_') => "No #{name} file found"}
-      end
+    def chomp(file)
+      File.read(file).chomp
     end
 
-    def parse_info_file(filename)
-      YAML.load(File.read(File.join(file_root, filename))) if file_exists?(filename)
+    def get_time(file)
+      File.stat(file).mtime
     end
 
-    def file_exists?(file_name)
-      File.exist?(File.join(file_root, file_name))
+    attr_reader :file_root
+
+    attr_reader :environment
+
+    def development?
+      environment == 'development'
+    end
+
+    def version_file
+      @version_file ||= File.join(file_root, 'VERSION')
+    end
+
+    def version_file?
+      File.exist? version_file
+    end
+
+    def revision_file
+      @revision_file ||= File.join(file_root, 'REVISION')
+    end
+
+    def revision_file?
+      File.exist? revision_file
+    end
+
+    def deploy_date
+      @deploy_date ||= if version_file?
+                         get_time version_file
+                       elsif development?
+                         'Live'
+                       else
+                         'Unknown (VERSION file is missing)'
+                       end
+    end
+
+    def last_commit
+      @last_commit ||= if revision_file?
+                         chomp revision_file
+                       elsif development? && `git show` =~ /^commit (.*)$/
+                         Regexp.last_match(1)
+                       else
+                         'Unknown (REVISION file is missing)'
+                       end
+    end
+
+    def headers
+      @headers.select { |k, v| k.match(/^[-A-Z_].*$/) }
+    end
+
+    private
+
+    def branch_source
+      @branch_source ||= -> { `git branch` }
     end
   end
 end

data/lib/ops/server.rb

@@ -1,22 +1,30 @@
 require 'sinatra/base'
-require 'sinatra/respond_to'
 require 'ops/server/helpers'
 require 'json'
 
 module Ops
   class Server < Sinatra::Base
-    Server.register Sinatra::RespondTo
-    dir = File.dirname(File.expand_path(__FILE__))
-    set :views,  "#{dir}/server/views"
+    dir = File.dirname(File.expand_path('', __FILE__))
+    set :views, "#{dir}/server/views"
+    # set :views, File.dirname(File.expand_path('/../server/views', __FILE__))
 
     helpers Ops::Helpers
 
     def request_headers
-      env.each_with_object({}) { |(k,v), headers| headers[k] = v }
+      env.each_with_object({}) { |(k, v), headers| headers[k] = v }
     end
 
-    def jsonified_version(version, headers)
-      JSON.generate({info: @version.info, previous_info: @version.previous_info, headers: @headers})
+    def jsonified_version(version, previous_versions, headers)
+      JSON.generate(
+        version: version.version_or_branch,
+        revision: version.last_commit,
+        previous_versions: previous_versions,
+        headers: headers
+      )
+    end
+
+    def json_request?
+      !!Array(params['format'] || request.accept).detect { |f| f.to_s =~ /json/ }
     end
 
     get '/env/?' do
@@ -24,14 +32,17 @@ module Ops
       erb :env
     end
 
-    get '/version/?' do
+    get '/version/?:format?', provides: %i(html json) do
       @version = Revision.new(request_headers)
+      @previous_versions = @version.previous_versions
       @headers = @version.headers
 
-      respond_to do |wants|
-        wants.html { erb :version }
-        wants.json { jsonified_version(@version, @headers) }
+      if json_request?
+        content_type 'application/json'
+        return jsonified_version(@version, @previous_versions, @headers)
       end
+
+      erb :version
     end
 
     get '/heartbeat/?' do
@@ -62,4 +73,3 @@ module Ops
     end
   end
 end
-

data/lib/ops/server/helpers.rb

@@ -1,6 +1,6 @@
 module Ops
   module Helpers
-    GITHUB_ORG_LINK = 'https://github.com/rentpath'
+    GITHUB_ORG_LINK = 'https://github.com/rentpath'.freeze
 
     def hostname
       @hostname ||= `/bin/hostname` || 'Unknown'
@@ -25,22 +25,14 @@ module Ops
       github_link 'commit', commit
     end
 
-    def github_link(resource, subresource)
-      "<a href='#{GITHUB_ORG_LINK}/#{app_name}/#{resource}/#{subresource}'>#{subresource}</a>" unless subresource =~ /^Unknown/
+    def repo_name
+      Ops.config[:repo_name] || app_name
     end
 
-    def print_detail(object, indent = 0)
-      output = ""
-      if object.kind_of? Hash
-        output << "{\n"
-        output << object.collect { |key, value|
-          "  " * indent + "  #{print_detail key} => #{print_detail value, indent+1}"
-        }.join(",\n") << "\n"
-        output << "  " * indent + "}"
-      else
-        output << object.inspect
+    def github_link(resource, subresource)
+      unless subresource =~ /^Unknown/
+        "<a href='#{GITHUB_ORG_LINK}/#{repo_name}/#{resource}/#{subresource}'>#{subresource}</a>"
       end
-      output
     end
   end
 end

data/lib/ops/server/views/version.erb

@@ -0,0 +1,76 @@
+<div class="container">
+  <div class="spacer"></div>
+  <div id="version">
+    <div class="label">
+      <%= "#{app_name} Version" %>
+    </div>
+    <div class="value">
+      <%= version_link @version.version_or_branch %>
+    </div>
+  </div>
+  <div class="spacer"></div>
+  <div id="date">
+    <div class="label">Date Deployed</div>
+    <div class="value"><%= @version.deploy_date %></div>
+  </div>
+  <div class="spacer"></div>
+  <div id="commit">
+    <div class="label">Last Commit</div>
+    <div class="value">
+      <%= commit_link(@version.last_commit)%>
+    </div>
+  </div>
+  <div class="spacer"></div>
+  <div id="host">
+    <div class="label">Host</div>
+    <div class="value"><%= hostname %></div>
+  </div>
+  <div class="spacer"></div>
+  <div id="environment">
+    <div class="label">Environment</div>
+    <div class="value"><%= @version.environment %></div>
+  </div>
+  <div class="spacer"></div>
+  <div id="previous_versions">
+    <div class="label">Previous Versions</div>
+    <div class="value">
+      <% unless @previous_versions.empty? %>
+        <table>
+          <tr class="header">
+            <td>Time</td>
+            <td>Version</td>
+            <td>Commit</td>
+          </tr>
+          <% @previous_versions.each_with_index do |version, i| %>
+            <tr class="<%= i%2==0 ? 'even' : nil %>">
+              <td>
+                <%= version[:time].strftime('%x %X') %>
+              </td>
+              <td>
+                <%= version_link(version[:version]) %>
+              </td>
+              <td>
+                <%= commit_link(version[:revision]) %>
+              </td>
+            </tr>
+          <% end %>
+        </table>
+      <% end %>
+    </div>
+  </div>
+  <div class="spacer"></div>
+  <div id="headers">
+    <div class="label">Headers</div>
+    <div class="value">
+      <table>
+        <% @headers.sort_by{ |h| h.first }.each_with_index do |(header, value), i| %>
+          <tr class="<%= i%2==0 ? 'even' : nil %>">
+            <td><%= header %></td>
+            <td><%= value %></td>
+          </tr>
+        <% end %>
+      </table>
+    </div>
+  </div>
+  <div class="clear"></div>
+</div>