torquebox-stompbox 0.1.0

data/Gemfile.lock

@@ -0,0 +1,144 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.5)
+    backports (2.0.3)
+    bcrypt-ruby (2.1.4-java)
+    data_mapper (1.1.0)
+      dm-aggregates (= 1.1.0)
+      dm-constraints (= 1.1.0)
+      dm-core (= 1.1.0)
+      dm-migrations (= 1.1.0)
+      dm-serializer (= 1.1.0)
+      dm-timestamps (= 1.1.0)
+      dm-transactions (= 1.1.0)
+      dm-types (= 1.1.0)
+      dm-validations (= 1.1.0)
+    data_objects (0.10.3)
+      addressable (~> 2.1)
+    diff-lcs (1.1.2)
+    dm-aggregates (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-constraints (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-core (1.1.0)
+      addressable (~> 2.2.4)
+    dm-do-adapter (1.1.0)
+      data_objects (~> 0.10.2)
+      dm-core (~> 1.1.0)
+    dm-migrations (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-observer (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-postgres-adapter (1.1.0)
+      dm-do-adapter (~> 1.1.0)
+      do_postgres (~> 0.10.2)
+    dm-serializer (1.1.0)
+      dm-core (~> 1.1.0)
+      fastercsv (~> 1.5.4)
+      json (~> 1.4.6)
+    dm-timestamps (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-transactions (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-types (1.1.0)
+      bcrypt-ruby (~> 2.1.4)
+      dm-core (~> 1.1.0)
+      fastercsv (~> 1.5.4)
+      json (~> 1.4.6)
+      stringex (~> 1.2.0)
+      uuidtools (~> 2.1.2)
+    dm-validations (1.1.0)
+      dm-core (~> 1.1.0)
+    do_jdbc (0.10.3-java)
+      data_objects (= 0.10.3)
+    do_postgres (0.10.3-java)
+      data_objects (= 0.10.3)
+      do_jdbc (= 0.10.3)
+      jdbc-postgres (>= 8.2)
+    extlib (0.9.15)
+    fastercsv (1.5.4)
+    git (1.2.5)
+    haml (3.0.25)
+    jdbc-postgres (9.0.801)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6-java)
+    json_pure (1.5.1)
+    monkey-lib (0.5.4)
+      backports
+    rack (1.2.2)
+    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)
+    sinatra-advanced-routes (0.5.1)
+      monkey-lib (~> 0.5.0)
+      sinatra (~> 1.0)
+      sinatra-sugar (~> 0.5.0)
+    sinatra-reloader (0.5.0)
+      sinatra (~> 1.0)
+      sinatra-advanced-routes (~> 0.5.0)
+    sinatra-sugar (0.5.0)
+      monkey-lib (~> 0.5.0)
+      sinatra (~> 1.0)
+    state_machine (0.10.3)
+    stringex (1.2.1)
+    thor (0.14.6)
+    tilt (1.2.2)
+    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)
+    uuidtools (2.1.2)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  bundler
+  data_mapper (~> 1.1)
+  dm-core (~> 1.1)
+  dm-migrations (~> 1.1)
+  dm-observer (~> 1.1)
+  dm-postgres-adapter (~> 1.1)
+  dm-timestamps (~> 1.1)
+  extlib
+  git
+  haml (~> 3.0)
+  jeweler
+  json_pure
+  rack-flash (= 0.1.1)
+  rack-test
+  rake
+  rspec
+  sinatra (= 1.1.2)
+  sinatra-reloader (= 0.5.0)
+  state_machine
+  thor
+  torquebox (= 1.0.0.CR1)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010, Red Hat, Inc.
+
+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.md

@@ -0,0 +1,125 @@
+# StompBox : A Deployer for TorqueBox
+
+StompBox is a simple Sinatra app that can be used to manage deployments on
+[TorqueBox][torquebox] by accepting commit notifications from [GitHub][github].
+It provides a user interface for managing one-click deployment and undeployment
+of your github repositories to TorqueBox for specific branches and commit
+points.
+
+## Why?
+
+StompBox is useful for testing and development environments where your code is
+changing frequently and you want to quickly deploy working branches and staging
+instances.  It integrates with your [GitHub][github] repositories to enable
+extremely quick and simple app deployment of any Rack-based application.  And
+it does all this on top of the industrial-strength TorqueBox platform,
+automatically providing your application with enterprise-level functionality
+such as messaging, scheduling, tasks, clustering and more.
+
+## Installation
+
+If you don't already have a TorqueBox instance installed, you should do that
+first.  Head on over to the [TorqueBox][torquebox] web site and follow the
+detailed instructions for downloading, installing, configuring and running
+TorqueBox.  Don't worry - it's easy. 
+
+StompBox hasn't been tested on Windows and may not work in that environment.
+However, if you are running a Unix-y system such as Fedora or Mac OSX, then you
+should be fine.  
+
+Once you've installed TorqueBox, clone the StompBox repository, install the
+gems, and deploy it to your running TorqueBox instance.
+
+    $ git clone git@github.com:lance/stompbox.git
+    Cloning into stompbox...
+    remote: Counting objects: 187, done.
+    remote: Compressing objects: 100% (168/168), done.
+    remote: Total 187 (delta 108), reused 0 (delta 0)
+    Receiving objects: 100% (187/187), 22.96 KiB, done.
+    Resolving deltas: 100% (108/108), done.
+
+    $ cd stompbox && bundle install
+    <output clipped for brevity - you should see this at the end>
+    Your bundle is complete! It was installed into /path/to/gem/home
+    
+    $ rake torquebox:deploy
+    
+## Configuration
+
+Configuration options are found in config/torquebox.yml.  Here are some things
+you'll want to pay attention to.
+
+* **DATABASE_URL** Provide a URI for connecting to your database.  By convention,
+  StompBox uses a database called "stompbox", but you can change this to
+  whatever you want as long as it is supported by DataMapper. Be sure the user
+  specified in the connection URI has appropriate privileges for executing DDL
+  on your database. When the app starts for the first time, the tables will be
+  created and it will fail if your user doesn't have the proper permissions.
+
+* **AUTO_MIGRATE** The first time you run StompBox, you'll want to have this on
+  so that your database is automagically created.  After that, it's most efficient
+  to just unset this option by commenting it out.
+
+* **DEPLOYMENTS** When you deploy an application using StompBox, it clones the
+  git repository into this directory. Make sure that your TorqueBox instance is
+  running as a user with enough privileges to write to this directory.  
+
+* **REQUIRE_AUTHENTICATION** To turn authentication on, set this to any non-nil
+  value.  StompBox uses the built-in JAAS authentication provided by TorqueBox and
+  JBossAS.  See the **Authentication** section below for more information.
+
+* **API_KEY** This should be set to something unguessable like an SHA1 hash.
+  You can generate these any number of ways. 
+  
+Here's one one way to generate a key.
+
+    $ echo "Now is the winter of our discontent made glorious summer by this son of York" | openssl sha1
+    
+    (stdin)= e4ba3556d1d059e2eadca9488b093d6685657e00
+
+## Authentication
+
+StompBox uses the built-in JAAS authentication provided by JBoss and exposed
+via TorqueBox.  If this is a development system (it probably should be), the
+simplest way to set usernames and passwords is to use the builtin rake task.
+
+    $ rake torquebox:auth:adduser username:password
+
+Be sure to set REQUIRE_AUTHENTICATION in config/torquebox.yml as well.
+Voilá, authentication is enabled.
+
+TorqueBox (and subsequently StompBox) can also authenticate with any other
+realm you have configured in your JBossAS. If you have configured JAAS settings
+in your TorqueBox instance, you may authenticate against them by supplying
+the authentication realm in config/torquebox.yml as shown.
+
+    auth:
+      default:
+        domain: my-configured-jaas-realm
+    
+## Usage
+
+Start by telling StompBox what repositories and branches you want to track.
+Once you've got everything configured and deployed, you can start by telling
+StompBox what repositories and branches you want to track. Then, from
+[GitHub][github], browse to the repository admin screen for one of the
+repositories you specified in `config/stompbox.yml`. Select "Service Hooks" ->
+"Post Receive URLs" and enter your StompBox URL plus your api_key (you
+configured it didn't you?).  It should look something like this.
+
+    http://mydomain.com/stompbox/push/3821A95D456134214FAD6FA91A2BAFE574D47151
+    
+After you save your settings, testing the service hook should send a POST
+request to your StompBox.  Play around. 
+
+## Caveats
+
+This project is very immature and there are many features which are outstanding (such as any real authentication).  You should **not** use it in a production environment.  It is currently used for research, development and testing only.  
+
+## License
+
+This software is distributed under an [MIT software license][license].
+
+[torquebox]: http://torquebox.org "TorqueBox"
+[github]: https://github.com "GitHub"
+[license]: 'LICENSE.txt' "MIT License"

data/app/authentication.rb

@@ -0,0 +1,55 @@
+#
+# 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 'torquebox'
+require 'org/torquebox/auth/authentication'
+
+module StompBox
+  module Authentication
+ 
+    def login_path
+      "#{request.script_name}/login"
+    end
+
+    def authenticated?
+      !session[:user].nil?
+    end
+   
+    def authenticate(username, password)
+      return false if username.blank? || password.blank?
+      authenticator = TorqueBox::Authentication.default
+      authenticator.authenticate(username, password) do
+        session[:user] = username
+      end
+    end
+
+    def skip_authentication
+      request.env['SKIP_AUTH'] = true
+    end
+   
+    def require_authentication
+      return if request.env['SKIP_AUTH']
+      return if authenticated?
+      redirect login_path 
+    end
+
+    def logout
+      session[:user] = nil
+      redirect login_path
+    end
+   
+  end
+end

data/app/deployer.rb

@@ -0,0 +1,156 @@
+#
+# 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 'git'
+require 'open3'
+require 'models'
+require 'torquebox-rake-support'
+require 'torquebox/rake/tasks'
+require 'app/tasks/deployer_task'
+
+ENV['DEPLOYMENTS'] ||= '/opt/deployments'
+
+class Deployer
+
+  attr_accessor :push
+
+  def initialize(push)
+    @push = push
+  end
+
+  def self.deploy(push)
+    push.deploy
+    DeployerTask.async(:deploy, :id=>push.id)
+  end
+
+  def self.undeploy(push, async = true)
+    push.undeploy
+    if async
+      DeployerTask.async(:undeploy, :id=>push.id)
+    else
+      Deployer.new(push).undeploy
+    end
+  end
+
+  def self.undeploy_branch(branch)
+    Deployment.all(:branch=>branch).each do |d|
+      Deployer.undeploy(d.push, false)
+    end
+  end
+
+  def undeploy
+    TorqueBox::RakeUtils.undeploy( "#{repository_name}-knob.yml" )
+    remove_repo if ( File.exist?( root ) )
+    push.undeployed
+  end
+
+  def deploy
+    begin
+      clone_repo
+      freeze_gems
+      write_descriptor
+      push.deployed
+      push.save
+      d = Deployment.create(
+        :created_at=>Time.now, 
+        :push=>push,
+        :branch=>push.branch,
+        :path=>deployment_path,
+        :context=>"/#{repository_name}")
+      d.save!
+    rescue Exception => ex
+      puts ex
+      push.failed
+    end
+  end
+
+  # Hack to avoid problems with github responses using git gem over https
+  def git_url
+    push.repo_url.sub('https://github.com/', 'git@github.com:')
+  end
+
+  def deployment_path
+    @deployment_path ||= ENV['DEPLOYMENTS']
+  end
+
+  def repository_name
+    @repo_name ||= push.master? ? push.repo_name : "#{push.repo_name}-#{push.branch}"
+  end
+
+  def root
+    "#{deployment_path}/#{repository_name}"
+  end
+
+  protected
+
+  def remove_repo
+    puts "Removing #{repository_name}"
+    FileUtils.rm_rf( root )
+  end
+
+  def clone_repo
+    remove_repo if ( File.exist?( root ) )
+    puts "Cloning #{git_url} to #{root}"
+    git = Git.clone(git_url, repository_name, :path=>deployment_path)
+    puts "Resetting repo to #{push['after']}"
+    git.reset_hard(push['after'])
+  end
+
+  def freeze_gems
+    puts "Freezing gems"
+    jruby = File.join( RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'] )
+    if ( File.exist?( path_to('Gemfile') ) )
+      exec_cmd( "cd #{root} && #{jruby} -S bundle package" )
+      exec_cmd( "cd #{root} && #{jruby} -S bundle install --local --path vendor/bundle" )
+    else
+      exec_cmd( "cd #{root} && #{jruby} -S rake rails:freeze:gems" )
+    end
+  end
+
+  def write_descriptor
+    name, descriptor = deployment( repository_name, root, "/#{repository_name}" )
+    TorqueBox::RakeUtils.deploy_yaml( name, descriptor )
+  end
+
+  def path_to(file)
+    "#{root}/#{file}"
+  end
+
+  def exec_cmd(cmd)
+    Open3.popen3( cmd ) do |stdin, stdout, stderr|
+      stdin.close
+      stdout_thr = Thread.new(stdout) {|stdout_io|
+        stdout_io.each_line do |l|
+          STDOUT.puts l
+          STDOUT.flush
+        end
+        stdout_io.close
+      }
+      stderr_thr = Thread.new(stderr) {|stderr_io|
+        stderr_io.each_line do |l|
+          STDERR.puts l
+          STDERR.flush
+        end
+      }
+      stdout_thr.join
+      stderr_thr.join
+    end
+  end
+end
+
+
+
+

data/app/helpers.rb

@@ -0,0 +1,59 @@
+#
+# 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.
+#
+
+module StompBox
+  class Application < Sinatra::Base 
+    
+    helpers do 
+  
+      def config(key)
+        ENV[key]
+      end
+  
+      def home_path
+        request.script_name
+      end
+
+      def push_path
+        port = request.port == 80 ? "" : ":#{request.port}"
+        request.scheme + "://" + request.host + port + to( "push/#{config('API_KEY')}" )
+      end
+  
+      def to(location)
+        location.gsub!(/^\//, '')
+        "#{home_path}/#{location}"
+      end
+  
+      def repositories
+        @repositories ||= Repository.ordered
+      end
+  
+      def classes_for(push)
+        track = push.tracked? ? 'tracked' : 'ignored'
+        [push.status, track, classify(push.repo_name), classify(push.branch)]
+      end
+  
+      def selector_for(push)
+        classes_for(push).join('.')
+      end
+  
+      def classify(str)
+        str.gsub('.', '-')
+      end
+  
+    end
+  end
+end

data/app/models.rb

@@ -0,0 +1,150 @@
+#
+# 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 'json'
+require 'state_machine'
+require 'dm-core'
+require 'dm-migrations'
+require 'dm-timestamps'
+
+class Push
+  include DataMapper::Resource
+
+  property :id,         Serial
+  property :status,     String
+  property :payload,    Text, :required => true, :lazy => false
+  property :created_at, DateTime
+
+  has 1, :deployment
+
+  attr_accessor :parsed_payload
+
+  state_machine :status, :initial => :received do
+
+    event :deploy do
+      transition all - [:deploying, :deployed] => :deploying
+    end
+
+    event :deployed do
+      transition :deploying => :deployed
+    end
+
+    event :failed do
+      transition all => :failed
+    end
+
+    event :undeploy do
+      transition :deployed => :undeploying
+    end
+
+    event :undeployed do
+      transition all => :undeployed
+    end
+
+    after_transition all => :undeploying do 
+      self.deployment.destroy unless self.deployment.nil?
+    end
+
+  end
+
+  def tracked?
+    Repository.ordered.any? { |r| r.name == repo_name && r.branch == branch }
+  end
+
+  def [](property)
+    parse_payload[property]
+  end
+
+  def repo_url
+    self['repository']['url']
+  end
+
+  def repo_name
+    self['repository']['name']
+  end
+
+  def branch
+    self['ref'].split('/').last
+  end
+
+  def master?
+    branch == 'master'
+  end
+
+  def short_commit_hash
+    self['after'][0..6]
+  end
+
+  def self.deployed
+    Push.all(:status=>:deployed)
+  end
+
+  protected
+  def parse_payload
+    @parsed_payload ||= JSON.parse(self.payload)
+  end
+
+end
+
+class Deployment
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :path, String
+  property :context, String
+  property :branch, String
+  property :created_at, DateTime
+
+  belongs_to :push
+
+end
+
+class Repository
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+  property :branch, String
+
+  def self.ordered
+    Repository.all(:order => [:name, :branch])
+  end
+
+end
+
+class DeploymentFile
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :path, String
+  property :body, Text
+
+  belongs_to :repository
+
+end
+
+database_url = ENV['DATABASE_URL']
+database_url ||= 'postgres://stompbox:stompbox@localhost/stompbox'
+
+DataMapper::Logger.new($stdout, :info)
+DataMapper.setup(:default, database_url)
+DataMapper::Model.raise_on_save_failure = true 
+DataMapper.finalize
+
+
+if ENV['AUTO_MIGRATE']
+  DataMapper.auto_upgrade!
+end