magistrate_monitor 0.1.0 → 0.2.0

data/README.md

@@ -1,15 +1,15 @@
-= Magistrate Monitor
+# Magistrate Monitor
 
 MagistrateMonitor is a frontend to the Magistrate gem that allows the gem to check in with the status of its workers and to receive commands from
 the frontend user (such as enable/disable and start/stop workers)
 
-== Installation
+## Installation
 
-=== Standalone Sinatra
+### Standalone Sinatra
 MagistrateMonitor will run as a standalone Sinatra app.  It will use ActiveRecord for the DB connection.  Create a config/database.yml file
 with your connection details.  Then run rake db:migrate as normal.  Then you can start the app with rackup or your other preferred method.
 
-=== Mounting in Rails 3.x
+### Mounting in Rails 3.x
 MagistrateMonitor will mount in a Rails 3.x app very easily.  
 
 1. Add the gem to your Gemfile: `gem 'magistrate_monitor`
@@ -18,7 +18,7 @@ MagistrateMonitor will mount in a Rails 3.x app very easily.
 
     mount MagistrateMonitor::Server => '/magistrate'
 
-=== Mounting the application in rails 2.3.*
+### Mounting the application in rails 2.3.*
 
 Create a new folder in app called metal. Add the file magistrate_monitor_web.rb with:
   
@@ -37,7 +37,7 @@ Create a new folder in app called metal. Add the file magistrate_monitor_web.rb
   
 This will route all requests to /magistrate_monitor to the magistrate_monitor rack app
 
-== Contributing to magistrate_monitor
+## Contributing to magistrate_monitor
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -47,10 +47,10 @@ This will route all requests to /magistrate_monitor to the magistrate_monitor ra
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Drew Blas. See LICENSE.txt for further details.
 
-== Acknowledgements
+## Acknowledgements
 
 Thanks to Matthew Deiter's healthy gem for the example of building this as a rack app (since I couldn't get 3.1 mountable engines to work)

data/lib/public/css/application.css

@@ -20,4 +20,9 @@ td{
   padding: 0.4em;
   margin: 0.4em;
   border: 1px solid blue;
+}
+
+pre{
+  margin: 0;
+  display: inline;
 }

data/lib/server.rb

@@ -2,6 +2,7 @@ require 'sinatra/base'
 require 'sinatra-activerecord'
 
 require 'supervisor'
+require 'awesome_print'
 
 module MagistrateMonitor
   class Server < Sinatra::Base
@@ -10,8 +11,24 @@ module MagistrateMonitor
     set :views,  "#{dir}/views"
     set :public, "#{dir}/public"
     set :static, true
-        
-    get '/', :provides => 'html' do
+    
+    set :basic_auth_credentials, lambda {
+      config_file = File.join('config', 'magistrate.yml')
+      if File.exist?( config_file )
+        config = File.open(config_file) { |file| YAML.load(file) }
+        if config['http_username'] && config['http_password']
+          [config['http_username'], config['http_password']]
+        end
+      end
+    }
+    
+    if basic_auth_credentials && ENV['RACK_ENV'] != 'test'
+      use Rack::Auth::Basic do |username, password|
+        [username, password] == basic_auth_credentials
+      end
+    end
+    
+    get '/' do
       @supervisors = Supervisor.order('name ASC').all
       normalize_status_data!
       
@@ -19,10 +36,16 @@ module MagistrateMonitor
     end
     
     get '/supervisors/:name' do
-      @supervisor = Supervisor.find_by_name params[:name]
+      @supervisor = Supervisor.find_by_name! params[:name]
       erb :show
     end
     
+    post '/supervisors/:name/delete' do
+      @supervisor = Supervisor.find_by_name! params[:name]
+      @supervisor.destroy
+      redirect url('/')
+    end
+    
     # Responds with the latest databag instructions for the supervisor
     get '/api/status/:name' do
       @supervisor = Supervisor.find_or_create_by_name params[:name]
@@ -42,23 +65,22 @@ module MagistrateMonitor
       content_type :json
       ActiveSupport::JSON.encode( {:status => 'Ok'} )
     end
-    
-    # These should not be gets
-    # But I'd like to get this working before I go about making the links to POST
-    get '/set/:supervisor_name/:worker_name/:action' do
+
+    post '/set/:supervisor_name/:worker_name/:action' do
       @supervisor = Supervisor.find_or_create_by_name params[:supervisor_name]
       
       @supervisor.set_target_state!(params[:action], params[:worker_name])
-      redirect url_for('/')
+      redirect url('/')
     end
     
     helpers do
-      def url_for(path)
-        "#{request.env['SCRIPT_NAME']}/#{path}"
-      end
+      # def url_for(path)
+      #   root = request.env['SCRIPT_NAME'].chomp('/')
+      #   "#{root}/#{path}"
+      # end
       
       def url_for_worker(supervisor, name, action)
-        url_for("set/#{supervisor.name}/#{name}/#{action}")
+        url("/set/#{supervisor.name}/#{name}/#{action}")
       end
 
       def normalize_status_data!

data/lib/supervisor.rb

@@ -9,19 +9,17 @@ module MagistrateMonitor
     # All supervisors have a status that is a hash
     # If it has something else for whatever reason, the real object is put in a hash under the 'status' key
     def normalize_status_data!
-      self.status ||= {}
+      self.status ||= {}      
+      self.status['workers'] ||= {}
       
-      unless self.status.is_a?(Hash)
-        self.status = { 'data-error' => self.status.inspect }
-      end
-      
-      self.status.each do |k,v|
+      self.status['workers'].each do |k,v|
         unless v.is_a?(Hash)
           v = {'state' => v.inspect }
         end
       end
       
-      self.databag ||= {'workers' => {}}
+      self.databag ||= {}
+      self.databag['workers'] ||= {}
     end
     
     def set_target_state!(action, worker)

data/lib/views/index.erb

@@ -5,39 +5,42 @@
     <tr>
       <th>Supervisor</th>
       <th>Worker</th>
+      <th>pid</th>
       <th>State</th>
-      <th>Client Target State</th>
-      <th>Server Target State</th>
+      <th>Supervisor Target State</th>
+      <th>Monitor Target State</th>
       <th colspan="3">Actions</th>
     </tr>
   </thead>
   
   <% @supervisors.each do |supervisor| %>
     <tr>
-      <th><a href="<%= url_for "supervisors/#{supervisor.name}" %>"><%= supervisor.name %></a><br>
+      <th><a href="<%= url "/supervisors/#{supervisor.name}" %>"><%= supervisor.name %></a><br>
           <%= supervisor.last_checkin_at %></th>
       <th colspan="7"> - </th>
+      <td><a href="<%= url "/supervisors/#{supervisor.name}/delete" %>" data-confirm="Are you sure?" data-method="post" rel="nofollow">Delete</a><br>
     </tr>
-    <% supervisor.status.each do |k,v| %>
+    <% supervisor.status['workers'].each do |k,v| %>
       <tr>
         <th> - </th>
         <th><%= k %></th>
+        <td><%= v['pid'] %></td>
         <td><%= v['state'] %></td>
         <td><%= v['target_state']%></td>
         <td><%= supervisor.databag['workers'][k]['target_state'] if supervisor.databag['workers'].is_a?(Hash) && supervisor.databag['workers'][k].is_a?(Hash) %></td>
         <td>
           <% if v['state'] != 'running' %>
-            <a href="<%= url_for_worker(supervisor, k, 'running') %>">Run</a>
+            <a href="<%= url_for_worker(supervisor, k, 'running') %>" data-method="post" rel="nofollow">Run</a>
           <% end %>
         </td>
         <td>
           <% if v['state'] != 'stopped' %>
-            <a href="<%= url_for_worker(supervisor, k, 'stopped') %>">Stop</a>
+            <a href="<%= url_for_worker(supervisor, k, 'stopped') %>" data-method="post" rel="nofollow">Stop</a>
           <% end %>
         </td>
         <td>
           <% if v['state'] != 'unmonitored' %>
-            <a href="<%= url_for_worker(supervisor, k, 'unmonitored') %>">Unmonitor</a>
+            <a href="<%= url_for_worker(supervisor, k, 'unmonitored') %>" data-method="post" rel="nofollow">Unmonitor</a>
           <% end %>
         </td>
       </tr>

data/lib/views/layout.erb

@@ -7,8 +7,8 @@
 
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-	<link rel="stylesheet" href="<%= url_for('/css/style.css') %>">
-	<link rel="stylesheet" href="<%= url_for('/css/application.css') %>">
+	<link rel="stylesheet" href="<%= url('css/style.css') %>">
+	<link rel="stylesheet" href="<%= url('css/application.css') %>">
 
 </head>
 <body>
@@ -25,7 +25,7 @@
 	</footer>
 </div> <!--! end of #container -->
 
-<script src="/js/application.js"></script>
+<script src="<%= url '/js/application.js' %>"></script>
 
 </body>
 </html>

data/lib/views/show.erb

@@ -3,12 +3,12 @@
 <% if @supervisor %>
   <h3>Status from supervisor</h3>
   <p><pre>
-    <%= @supervisor.status.inspect %>
+    <%= @supervisor.status.ai(:html => true) %>
   </pre></p>
   
   <h3>Databag to be sent to supervisor</h3>
   <p><pre>
-    <%= @supervisor.databag.inspect %>
+    <%= @supervisor.databag.ai(:html => true) %>
   </pre></p>
 <% else %>
   No supervisor by the name <%= params[:name] %>

data/spec/server_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe "MagistrateMonitor::Server" do
+  include Rack::Test::Methods
+  
+  # Eventually could be replaced with fixtures, but we only need this one
+  before(:all) do
+    MagistrateMonitor::Supervisor.delete_all
+    @supervisor = MagistrateMonitor::Supervisor.create :name => 'foo'
+    @supervisor.normalize_status_data!
+    @supervisor.set_target_state!('running', 'worker1')
+  end
+
+  it "should respond to /" do
+    get '/'
+    last_response.should be_ok
+  end
+  
+  it 'should get a supervisor' do
+    get '/supervisors/foo'
+    last_response.should be_ok
+  end
+  
+  it 'should delete a supervisor' do
+    supervisor = MagistrateMonitor::Supervisor.create :name => 'bar'
+    
+    post '/supervisors/bar/delete'
+    last_response.status.should == 302
+  end
+  
+  context 'api' do
+    it 'should provide the databag' do
+      get '/api/status/foo'
+      
+      last_response.should be_ok
+      last_response.body.should == ActiveSupport::JSON.encode(@supervisor.databag)
+    end
+    
+    it 'should record the incoming status' do
+      status = {'workers' => {'worker2' => {'state' => 'running'}}}
+      post '/api/status/bar', :status => ActiveSupport::JSON.encode( status )
+      
+      last_response.should be_ok
+
+      s = MagistrateMonitor::Supervisor.find_by_name 'bar'
+      s.status.should == status
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,21 @@
+ENV['RACK_ENV'] = 'test'
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
 require 'magistrate_monitor'
+require 'rspec'
+
+require 'rack/test'
+
+def app
+  @app ||= MagistrateMonitor::Server
+end
+
+# set test environment
+app.set :environment, :test
+# set :run, false
+# set :raise_errors, true
+# set :logging, false
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
@@ -10,4 +24,6 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.mock_with :rspec
   config.color_enabled = true
+#  config.use_transactional_examples = true
+
 end

data/spec/supervisor_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+require "supervisor"
+
+describe "Supervisor" do
+  before(:each) do
+    MagistrateMonitor::Supervisor.delete_all
+  end
+  
+  it 'should save to the DB successfully' do
+    supervisor = MagistrateMonitor::Supervisor.new :name => 'foo'
+    supervisor.save.should be_true
+  end
+  
+  it 'should set a target state with a blank databag' do
+    supervisor = MagistrateMonitor::Supervisor.new :name => 'foo'
+    supervisor.set_target_state!('running', 'worker1')
+    supervisor.reload
+    
+    supervisor.databag['workers']['worker1']['target_state'].should == 'running'
+  end
+  
+  it 'should set target state multiple times successfully' do
+    supervisor = MagistrateMonitor::Supervisor.new :name => 'foo'
+    supervisor.set_target_state!('running', 'worker1')
+    supervisor.set_target_state!('stopped', 'worker1')
+    supervisor.reload
+    
+    supervisor.databag['workers']['worker1']['target_state'].should == 'stopped'
+  end
+  
+  it 'should normalize the initial data' do
+    supervisor = MagistrateMonitor::Supervisor.new :name => 'foo'
+    
+    supervisor.normalize_status_data!
+    
+    supervisor.databag.should be_a(Hash)
+    supervisor.status.should be_a(Hash)
+    supervisor.databag['workers'].should be_a(Hash)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: magistrate_monitor
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Drew Blas
@@ -91,9 +91,23 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: rack-test
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -105,11 +119,11 @@ dependencies:
         - 6
         version: 1.2.6
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: activerecord
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -120,11 +134,11 @@ dependencies:
         - 0
         version: "3.0"
   type: :runtime
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -135,7 +149,23 @@ dependencies:
         - 0
         version: "3.0"
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id010
 description: Receives checkins from the magistrate gem and sends back commands
 email: drew.blas@gmail.com
 executables: []