appserver 0.0.1 → 0.0.2

data/lib/appserver/unicorn.conf.rb

@@ -1,18 +1,18 @@
 require File.expand_path('../../appserver', __FILE__)
-# We assume that the last argument to unicorn is the full path to config.ru
-Dir.chdir(File.expand_path('..', Unicorn::HttpServer::START_CTX[:argv][-1]))
-app = Appserver::Server.new.app(File.basename(Dir.pwd))
+# We assume that the last argument to unicorn is the full path to the app's config.ru
+app_path = File.dirname(Unicorn::HttpServer::START_CTX[:argv][-1])
+app = Appserver::ServerDir.discover(app_path).app(File.basename(app_path))
 
-working_directory app.dir
+working_directory app.path
 stderr_path app.server_log
 stdout_path app.server_log
-puts "Appserver unicorn configuration for #{app.dir}"
+app.setup_env!
 pid app.pid_file
 listen "unix:#{app.socket}", :backlog => 64
-#user 'user', 'group'
+user app.user, app.group
 worker_processes app.instances
+preload_app app.preload
 timeout 30
-preload_app true
 
 # Use COW-friendly REE for memory saving, especially with preloaded apps
 # http://rubyenterpriseedition.com/faq.html#adapt_apps_for_cow
@@ -25,26 +25,22 @@ before_fork do |server, worker|
     ActiveRecord::Base.connection.disconnect! if defined?(ActiveRecord::Base)
   end
 
-  # The following is only recommended for memory/DB-constrained
-  # installations.  It is not needed if your system can house
-  # twice as many worker_processes as you have configured.
-  #
-  # # This allows a new master process to incrementally
-  # # phase out the old master process with SIGTTOU to avoid a
-  # # thundering herd (especially in the "preload_app false" case)
-  # # when doing a transparent upgrade.  The last worker spawned
-  # # will then kill off the old master process with a SIGQUIT.
-  # old_pid = "#{server.config[:pid]}.oldbin"
-  # if old_pid != server.pid
-  #   begin
-  #     sig = (worker.nr + 1) >= server.worker_processes ? :QUIT : :TTOU
-  #     Process.kill(sig, File.read(old_pid).to_i)
-  #   rescue Errno::ENOENT, Errno::ESRCH
-  #   end
-  # end
-  #
-  # # *optionally* throttle the master from forking too quickly by sleeping
-  # sleep 1
+  # This allows a new master process to incrementally
+  # phase out the old master process with SIGTTOU to avoid a
+  # thundering herd (especially in the "preload_app false" case)
+  # when doing a transparent upgrade.  The last worker spawned
+  # will then kill off the old master process with a SIGQUIT.
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if old_pid != server.pid
+    begin
+      sig = (worker.nr + 1) >= server.worker_processes ? :QUIT : :TTOU
+      Process.kill(sig, File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+    end
+  end
+
+  # *optionally* throttle the master from forking too quickly by sleeping
+  sleep 1
 end
 
 after_fork do |server, worker|

data/lib/appserver/utils.rb

@@ -1,15 +1,32 @@
+require 'socket'
 require 'tempfile'
 
 module Appserver
   module Utils
-    def self.included (base)
-      base.class_eval do
-        extend Methods
-        include Methods
+
+    class << self
+      def find_in_path (name)
+        ENV['PATH'].split(':').each do |path|
+          fn = File.join(path, name)
+          return fn if File.executable?(fn)
+        end
+        nil
+      end
+
+      def system_hostname
+        Socket.gethostname
+      end
+
+      def system_domainname
+        system_hostname.sub(/^[^.]+\./, '')
+      end
+
+      def number_of_cpus
+        if File.exist?('/proc/cpuinfo')
+          File.readlines('/proc/cpuinfo').grep(/^processor\s+:\s+\d+/).size
+        end
       end
-    end
 
-    module Methods
       def safe_replace_file (filename)
         tempfile = Tempfile.new(File.basename(filename) + '.', File.dirname(filename))
         if File.exist?(filename)
@@ -19,15 +36,7 @@ module Appserver
         yield tempfile
         tempfile.close
         File.unlink(filename) if File.exist?(filename)
-        File.rename(tempfile, filename)
-      end
-
-      def symbolize_keys (hash)
-        hash.inject({}) do |memo, (key, value)|
-          value = symbolize_keys(value) if Hash === value
-          memo[key.to_sym] = value
-          memo
-        end
+        File.rename(tempfile.path, filename)
       end
     end
   end

data/test/apps/rack-simple/config.ru

@@ -0,0 +1,7 @@
+class HelloWorld
+  def call (env)
+    [200, { 'Content-Type' => 'text/plain' }, ['Hello world!']]
+  end
+end
+
+run HelloWorld.new

data/test/apps/sinatra/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+gem 'sinatra', '>= 1.0'
+gem 'sinatra-erb'

data/test/apps/sinatra/config.ru

@@ -0,0 +1,2 @@
+require ::File.expand_path('../hello', __FILE__)
+run Sinatra::Application

data/test/apps/sinatra/hello.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'sinatra'
+require 'erb'
+
+set :app_file, __FILE__
+
+get '/' do
+  erb :index
+end

data/test/apps/sinatra/views/index.erb

@@ -0,0 +1 @@
+Hello world from Sinatra

data/test/helper.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'mocha'
+
+require 'appserver'
+require 'tmpdir'
+require 'git'
+
+class Test::Unit::TestCase
+
+  SAMPLE_APPS_PATH = File.expand_path('../apps', __FILE__)
+
+  # Runs the given block in an empty, temporary direcory
+  def in_empty_dir (&block)
+    Dir.mktmpdir do |tmpdir|
+      Dir.chdir(tmpdir) do
+        yield
+      end
+    end
+  end
+
+  # Runs the given block in an initialized appserver directory
+  def in_server_dir (&block)
+    in_empty_dir do
+      yield Appserver::ServerDir.init('.', :force => true)
+    end
+  end
+
+  # Copies the named sample app to the given path
+  def create_app (name, path)
+    raise 'Target path already exist' if File.exist?(path)
+    FileUtils.cp_r File.join(SAMPLE_APPS_PATH, name), path
+  end
+
+  # Creates a bare git repository of the named sample app
+  def create_app_repo (name, path)
+    raise 'Target path already exist' if File.exist?(path)
+    path = File.expand_path(path)
+    Dir.chdir(File.join(SAMPLE_APPS_PATH, name)) do
+      raise 'Already a git repository' if File.exist?('.git')
+      git = Git.init('.')
+      git.add('.')
+      git.commit('Initial commit')
+      git.config('core.bare', true)
+      FileUtils.mv '.git', path
+    end
+  end
+end

data/test/unit/test_app.rb

@@ -0,0 +1,72 @@
+require 'helper'
+require 'bundler'
+
+class TestApp < Test::Unit::TestCase
+
+  def setup
+    @env = { 'PATH' => '/some/where:/no/where', 'FOO_KEY' => 'FooFoo', 'MY_DIR' => '/no/where' }
+    Appserver::App.send(:const_set, :ENV, @env)
+  end
+
+  def teardown
+    Appserver::App.send(:remove_const, :ENV)
+  end
+
+  def test_default_hostname
+    in_server_dir do |server_dir|
+      Appserver::App::SETTINGS_DEFAULTS[:domain] = 'example.com'
+      app = server_dir.app('myapp')
+      assert_equal 'example.com', app.domain
+      assert_equal 'myapp.example.com', app.hostname
+    end
+  end
+
+  def test_setup_env_default_environment
+    in_server_dir do |server_dir|
+      app = server_dir.app('myapp')
+      assert_equal([], app.env_whitelist)
+      assert_equal({}, app.env)
+      app.setup_env!
+      assert_equal({ 'PATH' => '/some/where:/no/where' }, @env)
+    end
+  end
+
+  def test_setup_env_whitelist
+    in_server_dir do |server_dir|
+      app = server_dir.app('myapp')
+      app.stubs(:env_whitelist => ['MY_DIR'])
+      app.setup_env!
+      assert_equal({ 'PATH' => '/some/where:/no/where', 'MY_DIR' => '/no/where' }, @env)
+    end
+  end
+
+  def test_setup_env_full_environment
+    in_server_dir do |server_dir|
+      app = server_dir.app('myapp')
+      app.stubs(:env_whitelist => '*')
+      app.setup_env!
+      assert_equal({ 'PATH' => '/some/where:/no/where', 'FOO_KEY' => 'FooFoo', 'MY_DIR' => '/no/where' }, @env)
+    end
+  end
+
+  def test_setup_env_additions
+    in_server_dir do |server_dir|
+      app = server_dir.app('myapp')
+      app.stubs(:env => { 'SOME_KEY' => 'secret' })
+      app.setup_env!
+      assert_equal({ 'PATH' => '/some/where:/no/where', 'SOME_KEY' => 'secret' }, @env)
+    end
+  end
+
+  def test_setup_env_sets_up_gem_bundle
+    in_server_dir do |server_dir|
+      app = server_dir.app('myapp')
+      File.stubs(:exist?).with(app.gem_file).returns(true)
+      File.stubs(:directory?).with(app.bundle_path).returns(true)
+      Bundler.expects(:setup)
+      app.setup_env!
+      assert_not_nil @env['BUNDLE_PATH']
+      assert_not_nil @env['GEM_HOME']
+    end
+  end
+end

data/test/unit/test_appserver.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestAppserver < Test::Unit::TestCase
+
+  def appserver (*args)
+    cmd = File.expand_path('../../../bin/appserver', __FILE__)
+    bind = TOPLEVEL_BINDING.dup
+    bind.eval("Object.send(:remove_const, :ARGV); ARGV = #{args.inspect}", __FILE__, __LINE__)
+    bind.eval(File.read(cmd), cmd)
+  end
+
+  def test_command
+    Appserver::Command.expects(:run!).with('doit', ['anarg', 'anotherarg'], {})
+    appserver('doit', 'anarg', 'anotherarg')
+  end
+
+  def test_dir_option
+    Appserver::Command.expects(:run!).with('doit', [], { :dir => '/path/to/anywhere' })
+    appserver('--dir', '/path/to/anywhere', 'doit')
+  end
+
+  def test_force_option
+    Appserver::Command.expects(:run!).with('doit', [], { :force => true })
+    appserver('--force', 'doit')
+  end
+end

data/test/unit/test_command.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+class TestCommand < Test::Unit::TestCase
+
+  def setup
+    @app = stub('App', :branch => 'thebranch')
+    @repository = stub('Repository', :app => @app)
+    @server_dir = stub('ServerDir', :repository => @repository)
+    Appserver::ServerDir.stubs(:discover => @server_dir)
+    # FIXME: This is currently needed to silence appserver output during tests :(
+    Appserver::Command.any_instance.stubs(:puts)
+  end
+
+  def test_unknown_command
+    assert_raise Appserver::UnknownCommandError do
+      Appserver::Command.run!('foo', [])
+    end
+  end
+
+  def test_dir_option
+    Dir.expects(:chdir).with('thedir')
+    @server_dir.stubs(:write_configs)
+    Appserver::Command.run!('update', [], :dir => 'thedir')
+  end
+
+  def test_init
+    Appserver::ServerDir.expects(:init).with('thedir', {})
+    Dir.expects(:chdir).with('thedir')
+    @server_dir.expects(:write_configs)
+    Appserver::Command.run!('init', ['thedir'])
+  end
+
+  def test_command_discovers
+    Appserver::ServerDir.expects(:discover).returns(@server_dir)
+    @server_dir.expects(:write_configs)
+    Appserver::Command.run!('update', [])
+  end
+
+  def test_update
+    @server_dir.expects(:write_configs)
+    Appserver::Command.run!('update', [])
+  end
+
+  def test_deploy_manually
+    @server_dir.expects(:repository).with('repo.git').returns(@repository)
+    @repository.expects(:install_hook)
+    @repository.expects(:deploy).with('thebranch')
+    Appserver::Command.run!('deploy', ['repo.git'])
+  end
+
+  def test_deploy_on_update
+    @server_dir.expects(:repository).with('repo.git').returns(@repository)
+    @repository.expects(:install_hook)
+    @repository.expects(:deploy).with('0123456789abcdef')
+    Appserver::Command.run!('deploy', ['repo.git', '/refs/heads/thebranch', '0123456789abcdef'])
+  end
+
+  def test_deploy_on_update_of_different_branch_does_nothing
+    @server_dir.expects(:repository).with('repo.git').returns(@repository)
+    @repository.expects(:install_hook)
+    @repository.expects(:deploy).never
+    Appserver::Command.run!('deploy', ['repo.git', '/refs/heads/xyz', '0123456789abcdef'])
+  end
+end

data/test/unit/test_configurator.rb

@@ -0,0 +1,116 @@
+require 'helper'
+
+class TestConfigurator < Test::Unit::TestCase
+
+  DEFAULTS = {
+    :alpha => 'aaa',
+    :beta => 'bbb',
+    :gamma => 'ccc',
+    :delta => 'ddd',
+  }
+
+  CONFIG_TEXT = <<-EOF
+    alpha 'anna'
+    beta 'bob'
+    context 'weird' do
+      beta 'betty'
+      gamma 'georg'
+    end
+  EOF
+
+  class ConfigTarget < Struct.new(:alpha, :beta, :gamma, :delta)
+    SETTINGS_DEFAULTS = DEFAULTS
+    SETTINGS_EXPAND = []
+  end
+
+  def configurator (config_text, *args)
+    config_file = '/tmp/some/path/test.conf.rb'
+    File.stubs(:read).with(config_file).returns(config_text)
+    Appserver::Configurator.new(config_file, *args)
+  end
+
+  def setup
+    @config = configurator(CONFIG_TEXT)
+  end
+
+  def test_default_setting
+    assert_no_match /delta/, CONFIG_TEXT
+    @config.apply!(target = ConfigTarget.new)
+    assert_equal DEFAULTS[:delta], target.delta
+    @config.apply!(target = ConfigTarget.new, 'weird')
+    assert_equal DEFAULTS[:delta], target.delta
+    @config.apply!(target = ConfigTarget.new, 'away')
+    assert_equal DEFAULTS[:delta], target.delta
+  end
+
+  def test_global_setting_is_global
+    @config.apply!(target = ConfigTarget.new)
+    assert_equal 'anna', target.alpha
+    @config.apply!(target = ConfigTarget.new, 'weird')
+    assert_equal 'anna', target.alpha
+    @config.apply!(target = ConfigTarget.new, 'away')
+    assert_equal 'anna', target.alpha
+  end
+
+  def test_context_setting_overrides_global_setting
+    @config.apply!(target = ConfigTarget.new)
+    assert_equal 'bob', target.beta
+    @config.apply!(target = ConfigTarget.new, 'weird')
+    assert_equal 'betty', target.beta
+    @config.apply!(target = ConfigTarget.new, 'away')
+    assert_equal 'bob', target.beta
+  end
+
+  def test_context_setting_overrides_default
+    @config.apply!(target = ConfigTarget.new)
+    assert_equal DEFAULTS[:gamma], target.gamma
+    @config.apply!(target = ConfigTarget.new, 'weird')
+    assert_equal 'georg', target.gamma
+    @config.apply!(target = ConfigTarget.new, 'away')
+    assert_equal DEFAULTS[:gamma], target.gamma
+  end
+
+  class ConfigTargetWithExpand < ConfigTarget
+    SETTINGS_EXPAND = [ :beta, :gamma ]
+    def path; '/tmp/some/path'; end
+  end
+
+  def test_settings_expand
+    @config.apply!(target = ConfigTargetWithExpand.new)
+    assert_equal 'anna', target.alpha
+    assert_equal '/tmp/some/path/bob', target.beta
+    assert_equal '/tmp/some/path/ccc', target.gamma
+    assert_equal 'ddd', target.delta
+  end
+
+  def test_any_setting_is_possible_by_default
+    config = configurator("alpha 'anna'; beta 'bob'")
+    config.apply!(target = ConfigTarget.new)
+    assert_equal 'anna', target.alpha
+    assert_equal 'bob', target.beta
+  end
+
+  def test_allowed_global_settings
+    assert_nothing_raised do
+      configurator("alpha 'anna'; beta 'bob'", [ :alpha, :beta ])
+    end
+  end
+
+  def test_allowed_global_settings_fail_on_invalid_setting
+    assert_raise NoMethodError do
+      configurator("alpha 'anna'; beta 'bob'", [ :alpha ])
+    end
+  end
+
+  def test_allowed_context_settings
+    assert_nothing_raised do
+      configurator("context 'foo' do; alpha 'anna'; beta 'bob'; end", nil, [ :alpha, :beta ])
+    end
+  end
+
+  def test_allowed_context_settings_fail_on_invalid_setting
+    assert_raise NoMethodError do
+      configurator("context 'foo' do; alpha 'anna'; beta 'bob'; end", nil, [ :alpha ])
+    end
+  end
+end