torquebox-backstage 0.1.0

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gem "sinatra", "1.1.2"
+gem "rack-flash"
+gem 'haml', '~>3.0'
+gem "jmx", '0.7'
+gem 'json'
+gem 'torquebox', '1.0.0.CR1'
+gem 'tobias-sinatra-url-for'
+gem 'rack-accept'
+
+group :development do
+  gem 'thor'
+  gem 'jeweler'
+  gem 'watchr'
+  gem 'rspec'
+  gem 'rack-test'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    haml (3.0.25)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jmx (0.7)
+    json (1.5.1-java)
+    rack (1.2.1)
+    rack-accept (0.4.3)
+      rack (>= 0.4)
+    rack-flash (0.1.1)
+      rack
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    thor (0.14.6)
+    tilt (1.2.2)
+    tobias-sinatra-url-for (0.2.1)
+      sinatra (>= 0.9.1.1)
+    torquebox (1.0.0.CR1)
+      torquebox-base (= 1.0.0.CR1)
+      torquebox-messaging (= 1.0.0.CR1)
+      torquebox-naming (= 1.0.0.CR1)
+      torquebox-rake-support (= 1.0.0.CR1)
+      torquebox-vfs (= 1.0.0.CR1)
+      torquebox-web (= 1.0.0.CR1)
+    torquebox-base (1.0.0.CR1-java)
+    torquebox-messaging (1.0.0.CR1-java)
+      torquebox-base (= 1.0.0.CR1)
+      torquebox-naming (= 1.0.0.CR1)
+    torquebox-naming (1.0.0.CR1-java)
+    torquebox-rake-support (1.0.0.CR1)
+    torquebox-vfs (1.0.0.CR1-java)
+    torquebox-web (1.0.0.CR1-java)
+    watchr (0.7)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  haml (~> 3.0)
+  jeweler
+  jmx (= 0.7)
+  json
+  rack-accept
+  rack-flash
+  rack-test
+  rspec
+  sinatra (= 1.1.2)
+  thor
+  tobias-sinatra-url-for
+  torquebox (= 1.0.0.CR1)
+  watchr

data/README.md

@@ -0,0 +1,164 @@
+# TorqueBox BackStage #
+
+BackStage is a Sinatra application that when deployed into a TorqueBox 
+server gives you visibility into the apps, queues, topics, message 
+processors, jobs, and services, allowing you to browse settings and stats, 
+and exposes some actions to allow you to change the operational state of 
+the components:
+
+* pause/resume queues and topics
+* stop/start message processors, services, and jobs
+* execute debug ruby code inside a runtime pool
+* view stats on all of the above 
+
+In addition, BackStage allows you to browse messages on a queue, and hides
+some of the underlying complexity of how topics are implemented in HornetQ.
+
+It basically acts as an friendly overlay for JMX, so is very easy to 
+extend if there is more data you want to see. The data/actions that are
+available from BackStage are also available from `/jmx-console` (with
+the exception of queue message browsing), but are more accessible in
+BackStage.
+
+## Authentication ##
+
+By default, access to BackStage is wide open. You can secure it by setting 
+`REQUIRE_AUTHENTICATION: true` in the environment section of `torquebox.yml`:
+
+    environment:
+      REQUIRE_AUTHENTICATION: true
+
+This will enable basic JAAS authentication through TorqueBox. Use the 
+rake task to add usernames and password:
+
+    $ rake torquebox:auth:adduser CREDENTIALS=username:password
+
+## Installation ##
+
+BackStage can either be installed and deployed as a gem, or deployed from the
+application source.
+
+### As A Gem ###
+
+
+First, install the gem:
+
+    jruby -S gem install torquebox-backstage
+
+*Note:* the torquebox-backstage gem cannot be made available on rubygems.org 
+until an official release of the torquebox gems is made. Until then, you will
+need to check out the source and run `jruby -S rake install` to install the gem.
+    
+Then, deploy backstage using the `backstage` command. You can deploy with security
+disabled:
+
+    jruby -S backstage deploy
+    
+Or enable security by providing a username/password pair:
+
+    jruby -S backstage deploy --secure=username:password
+
+### From Source ###
+
+Clone the [git repo](https://github.com/torquebox/backstage),
+then run bundler to install the needed gems (listed in the 
+[Gemfile](https://github.com/torquebox/backstage/blob/master/Gemfile)):
+
+    jruby -S gem install bundler # if you haven't done so already
+    jruby -S bundle install
+    
+Once that's done, you can either deploy a deployment descriptor pointing at 
+the checked out repo:
+
+    jruby -S rake torquebox:deploy
+    
+or archive and deploy it as a .knob (zipfile):
+
+    jruby -S rake torquebox:deploy:archive
+    
+By default, BackStage is deployed to the `/backstage` context (see the `context:` 
+setting in `torquebox.yml`).
+
+## API ##
+
+BackStage also provides a RESTful API that allows you to access almost any of the 
+data or actions of the web UI (browsing messages via the API is not yet available).
+The API provides a top level entry point at `/api` that returns a list of collection 
+urls. The data is returned as JSON, and you must either  pass `format=json` as a
+query parameter, or set the `Accept:` header to `application/json`. `/api` always
+returns JSON, no matter what `Accept:` header or format param you use, and all of 
+the urls returned in the JSON include the `format=json` parameter. 
+
+### Example ###
+
+First, we retrieve the API entry point:
+
+    curl http://localhost:8080/backstage/api 
+
+Returns:
+
+    {
+      "collections":{
+        "apps":"http://localhost:8080/backstage/apps?format=json",
+        "queues":"http://localhost:8080/backstage/queues?format=json",
+        "topics":"http://localhost:8080/backstage/topics?format=json",
+        "message_processors":"http://localhost:8080/backstage/message_processors?format=json",
+        "jobs":"http://localhost:8080/backstage/jobs?format=json",
+        "services":"http://localhost:8080/backstage/services?format=json"
+      }
+    }
+
+Then, we'll use the url for services to retrieve the service index:
+
+    curl http://localhost:8080/backstage/services?format=json
+
+Returns:
+    
+    [
+      {
+        "resource":"http://localhost:8080/backstage/service/dG9ycXVlYm94LnNlcnZpY2VzOmFwcD1raXRjaGVuLXNpbmsudHJxLG5hbWU9QVNlcnZpY2U=?format=json",
+        "name":"AService",
+        "app":"http://localhost:8080/backstage/app/dG9ycXVlYm94LmFwcHM6YXBwPWtpdGNoZW4tc2luay50cnE=?format=json",
+        "app_name":"kitchen-sink",
+        "status":"Started",
+        "actions":{
+          "stop":"http://localhost:8080/backstage/service/dG9ycXVlYm94LnNlcnZpY2VzOmFwcD1raXRjaGVuLXNpbmsudHJxLG5hbWU9QVNlcnZpY2U=/stop?format=json"
+        }
+      }
+    ]
+
+Each index entry contains the full contents of the entry, along with URL
+to access the resource itself. URLs to associated resources are included as
+well (the app in this case).
+
+If a resource has actions that can be performed on it, they will appear in
+the results under `actions`. Action urls must be called via POST, and 
+return the JSON encoded resource:
+
+    curl -X POST http://localhost:8080/backstage/service/dG9ycXVlYm94LnNlcnZpY2VzOmFwcD1raXRjaGVuLXNpbmsudHJxLG5hbWU9QVNlcnZpY2U=/stop?format=json
+    
+Returns:
+
+    {
+      "resource":"http://localhost:8080/backstage/service/dG9ycXVlYm94LnNlcnZpY2VzOmFwcD1raXRjaGVuLXNpbmsudHJxLG5hbWU9QVNlcnZpY2U=?format=json",
+      "name":"AService",
+      "app":"http://localhost:8080/backstage/app/dG9ycXVlYm94LmFwcHM6YXBwPWtpdGNoZW4tc2luay50cnE=?format=json",
+      "app_name":"kitchen-sink",
+      "status":"Stopped",
+      "actions":{
+        "start'":"http://localhost:8080/backstage/service/dG9ycXVlYm94LnNlcnZpY2VzOmFwcD1raXRjaGVuLXNpbmsudHJxLG5hbWU9QVNlcnZpY2U=/start'?format=json"
+      }
+    }
+
+## Contributing ##
+
+Bug reports, feature requests, and patches are always welcome! See
+http://torquebox.org/community/ on how to get in touch with the TorqueBox
+crew.
+
+## License ##
+
+Copyright 2011 Red Hat, Inc.
+
+Licensed under the Apache Software License version 2. See 
+http://www.apache.org/licenses/LICENSE-2.0 for details.

data/Rakefile

@@ -0,0 +1,32 @@
+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 'torquebox-rake-support'
+
+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 = "torquebox-backstage"
+  gem.homepage = "http://github.com/torquebox/backstage"
+  gem.license = "MIT"
+  gem.summary = %Q{BackStage - Queue/Topic/Job viewer for TorqueBox}
+  gem.description = %Q{BackStage - Queue/Topic/Job viewer for TorqueBox}
+  gem.email = "tcrawley@redhat.com"
+  gem.authors = ["Tobias Crawley"]
+  gem.files = FileList["[A-Z]*", 'backstage.rb', 'config.ru', 'bin/*.rb', "{config,lib,spec,views}/**/*"]
+  gem.executables = %w{backstage}
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'thor', '> 0.14'
+  gem.add_runtime_dependency 'bundler', '> 1.0.12'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+

data/TODO

@@ -0,0 +1,9 @@
+TODO
+
+* allow queue browsing from the API
+* link queues/topics to their apps
+* see how backstage behaves in a cluster
+* allow resending DLQ and ExpiryQueue messages
+* store failure backtraces for jobs/tasks in TorqueBox, and display here
+* improve test coverage
+* add stats collection, with memory usage and other bits? ruby runtime stats?

data/TORQUEBOX_VERSION

@@ -0,0 +1 @@
+1.0.0.RC1-SNAPSHOT

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/backstage.rb

@@ -0,0 +1,84 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/setup'
+require 'sinatra/base'
+require 'rack-flash'
+require 'rack/accept'
+require 'haml'
+require 'sass'
+require 'jmx'
+
+$:.unshift File.join( File.dirname( __FILE__ ), 'lib' )
+
+require 'torquebox'
+require 'resource_helpers'
+require 'resource'
+require 'helpers'
+require 'has_mbean'
+require 'torquebox_managed'
+require 'pools'
+require 'apps'
+require 'destinations'
+require 'message_processors'
+require 'jobs'
+require 'services'
+
+
+puts "ENV['REQUIRE_AUTHENTICATION'] is not set, *disabling* authentication" unless ENV['REQUIRE_AUTHENTICATION'] 
+
+module Backstage
+  BACKSTAGE_VERSION = File.readlines( File.join( File.dirname( __FILE__ ), 'VERSION' ) ).first.strip
+  TORQUEBOX_VERSION = File.readlines( File.join( File.dirname( __FILE__ ), 'TORQUEBOX_VERSION' ) ).first.strip
+
+  class Application < Sinatra::Base
+    enable :logging, :sessions
+    use Rack::Accept
+    use Rack::Flash
+
+    include Backstage::Authentication 
+
+    set :views, Proc.new { File.join( File.dirname( __FILE__ ), "views" ) }
+
+    before do
+      require_authentication if ENV['REQUIRE_AUTHENTICATION']
+    end
+
+    get '/api' do
+      content_type :json
+
+      {
+        :collections => [:pools, :apps, :queues, :topics, :message_processors, :jobs, :services].inject({}) do |collections, collection|
+          collections[collection] = json_url_for( collection_path( collection ) )
+          collections
+        end
+      }.to_json
+    end
+    
+    get '/' do
+      redirect_to collection_path( :apps ) 
+    end
+
+    get '/css/style.css' do
+      sass :'css/style'
+    end
+
+    get '/css/html5reset.css' do
+      sass :'css/html5reset'
+    end
+
+  end
+end

data/bin/backstage

@@ -0,0 +1,78 @@
+#!/usr/bin/env jruby
+#-*-ruby-*-
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'thor'
+require 'torquebox-rake-support'
+
+class BackstageCommand < Thor
+
+  DEPLOYMENT_NAME = 'backstage-knob.yml'
+  
+  desc "deploy [--secure=username:password[,username:password]*]", "Deploys backstage to $TORQUEBOX_HOME/apps"
+  method_option :secure, :type => :hash, :default => nil
+  def deploy
+    check
+    descriptor = TorqueBox::DeployUtils.basic_deployment_descriptor( :root => root_dir,
+                                                                     :env => 'production' )
+    if options[:secure]
+      descriptor['environment'] = { 'REQUIRE_AUTHENTICATION' => true }
+      credentials = []
+      options[:secure].each do |user, pass|
+        credentials << [user, pass]
+      end
+      prop_file = TorqueBox::DeployUtils.write_credentials( credentials )
+      puts ">> Wrote user/password entries to #{prop_file}"
+    else
+      puts ">> WARNING: deploying BackStage with no security - use the --secure=username:password option to secure it"
+    end
+
+    name, dir = TorqueBox::DeployUtils.deploy_yaml( descriptor, DEPLOYMENT_NAME )
+    
+    puts ">> Deployed #{name} to #{dir}"
+  end
+
+  desc "undeploy", "Removes backstage from $TORQUEBOX_HOME/apps"
+  def undeploy
+    check
+    name, dir = TorqueBox::DeployUtils.undeploy( DEPLOYMENT_NAME )
+    
+    puts ">> Undeployed #{name} from #{dir}"
+  end
+
+  desc "info", "Prints info about BackStage's status"
+  def info
+    check
+    path = File.join( ENV['TORQUEBOX_HOME'], 'apps', DEPLOYMENT_NAME )
+    if File.exists?( path )
+      puts ">> BackStage deployed to #{path}"
+    else
+      puts ">> BackStage is not deployed"
+    end
+  end
+
+  protected
+  def check
+    raise Exception.new("$TORQUEBOX_HOME must be set") unless ENV['TORQUEBOX_HOME']
+  end
+
+  def root_dir
+    File.expand_path( File.join( File.dirname( __FILE__ ), '..' ) )
+  end
+  
+end
+
+BackstageCommand.start