appserver 0.0.1 → 0.0.2

data/lib/appserver/command.rb

@@ -15,25 +15,53 @@ module Appserver
     def run!
       Dir.chdir(options[:dir]) if options[:dir]
 
-      Server.initialize_dir(options) if command == 'init'
+      if command == 'init'
+        ServerDir.init(arguments[0], options)
+        Dir.chdir(arguments[0])
+      end
 
-      server = Server.new(options)
+      server_dir = ServerDir.discover
 
       case command
         when 'init'
-          server.write_configs
+          server_dir.write_configs
           puts 'Initialized appserver directory.'
-          puts 'Wrote Monit and Nginx configuration snippets. Make sure to include them into'
-          puts 'your system\'s Monit and Nginx configuration to become active.'
+          puts 'Wrote configuration snippets. Make sure to include them into your'
+          puts 'system\'s Monit/Nginx/Logrotate configuration to become active.'
+
+        when 'update'
+          server_dir.write_configs
+          puts 'Wrote configuration snippets.'
 
         when 'deploy'
-          repository = server.repository(arguments[0])
-          # TODO
+          repository = server_dir.repository(arguments[0])
           repository.install_hook
+          # Second and third arguments are used by git update hooks and contain
+          # the ref name and the new ref that just have been updated
+          ref = repository.app.branch
+          if arguments[1] && arguments[2]
+            return unless arguments[1] =~ %r(refs/heads/#{ref})
+            ref = arguments[2]
+          end
+          puts 'Deploying application...'
+          repository.deploy(ref)
+          puts 'Done.'
 
-        when 'update'
-          server.write_configs
-          puts 'Wrote Monit and Nginx configuration snippets.'
+        when 'start'
+          app = server_dir.app(arguments[0])
+          app.start_server
+
+        when 'stop'
+          app = server_dir.app(arguments[0])
+          app.stop_server
+
+        when 'restart'
+          app = server_dir.app(arguments[0])
+          app.restart_server
+
+        when 'reopen'
+          app = server_dir.app(arguments[0])
+          app.reopen_server_log
 
         else
           raise UnknownCommandError

data/lib/appserver/configurator.rb

@@ -0,0 +1,38 @@
+module Appserver
+  class Configurator < Struct.new(:settings, :global_keys, :context_keys)
+
+    def initialize (config_file, global_keys = nil, context_keys = nil)
+      self.settings = {}
+      self.global_keys = global_keys
+      self.context_keys = context_keys
+      instance_eval(File.read(config_file), config_file) if config_file
+    end
+
+    def apply! (target, context = nil)
+      settings = (self.settings[nil] || {}).dup
+      settings.update(self.settings[context] || {}) if context
+      target.class.const_get(:SETTINGS_DEFAULTS).each do |key, default_value|
+        value = settings[key] || default_value
+        value = File.expand_path(value, target.path) if value && target.class.const_get(:SETTINGS_EXPAND).include?(key)
+        target.send("#{key}=", value)
+      end
+    end
+
+    def context (context)
+      saved_context = @context
+      @context = context.to_s
+      yield
+      @context = saved_context
+    end
+    alias_method :app, :context
+
+  protected
+
+    def method_missing (method, *args)
+      return super if !@context && global_keys && !global_keys.include?(method)
+      return super if @context && context_keys && !context_keys.include?(method)
+      self.settings[@context] ||= {}
+      self.settings[@context][method] = args[0] if args.size > 0
+    end
+  end
+end

data/lib/appserver/logrotate.rb

@@ -0,0 +1,46 @@
+module Appserver
+  class Logrotate < Struct.new(:server_dir)
+
+    def self.write_config (server_dir)
+      new(server_dir).write_config
+    end
+
+    def initialize (server_dir)
+      self.server_dir = server_dir
+    end
+
+    def write_config
+      Utils.safe_replace_file(server_dir.logrotate_conf) do |f|
+        f.puts "# Logrotate configuration automagically generated by the \"appserver\" gem using"
+        f.puts "# the appserver directory config #{server_dir.config_file}"
+        f.puts "# Include this file into your system's logrotate.conf (using an include statement)"
+        f.puts "# to use it. See http://github.com/zargony/appserver for details."
+        # Handle access logs of Nginx in one statement, so Nginx only needs to reopen once
+        access_logs = server_dir.apps.map { |app| app.access_log }.compact
+        f.puts "#{access_logs.join(' ')} {"
+        f.puts "  missingok"
+        f.puts "  delaycompress"
+        f.puts "  sharedscripts"
+        f.puts "  postrotate"
+        f.puts "    #{server_dir.nginx_reopen}"
+        f.puts "  endscript"
+        f.puts "}"
+        # Add application-specific Logrotate configuration
+        server_dir.apps.each do |app|
+          f.puts ""
+          f.puts "# Application: #{app.name}"
+          if app.server_log
+            f.puts "#{app.server_log} {"
+            f.puts "  missingok"
+            f.puts "  delaycompress"
+            f.puts "  sharedscripts"
+            f.puts "  postrotate"
+            f.puts "    #{server_dir.appserver_cmd('reload', app.name)}"
+            f.puts "  endscript"
+            f.puts "}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appserver/monit.rb

@@ -0,0 +1,45 @@
+module Appserver
+  class Monit < Struct.new(:server_dir)
+
+    def self.write_config (server_dir)
+      new(server_dir).write_config
+    end
+
+    def initialize (server_dir)
+      self.server_dir = server_dir
+    end
+
+    def write_config
+      Utils.safe_replace_file(server_dir.monit_conf) do |f|
+        f.puts "# Monit configuration automagically generated by the \"appserver\" gem using"
+        f.puts "# the appserver directory config #{server_dir.config_file}"
+        f.puts "# Include this file into your system's monitrc (using an include statement)"
+        f.puts "# to use it. See http://github.com/zargony/appserver for details."
+        # Let Monit reload itself if this configuration changes
+        f.puts "check file monit_conf with path #{server_dir.monit_conf}"
+        f.puts "  if changed checksum then exec \"#{server_dir.monit_reload}\""
+        # Reload Nginx if its configuration changes
+        f.puts "check file nginx_conf with path #{server_dir.nginx_conf}"
+        f.puts "  if changed checksum then exec \"#{server_dir.nginx_reload}\""
+        # Add application-specific Monit configuration
+        server_dir.apps.each do |app|
+          f.puts ""
+          f.puts "# Application: #{app.name}"
+          if app.pid_file && app.start_server?
+            cyclecheck = app.usage_check_cycles ? " for #{app.usage_check_cycles} cycles" : ''
+            f.puts "check process #{app.name} with pidfile #{app.pid_file}"
+            f.puts "  start program = \"#{server_dir.appserver_cmd('start', app.name)}\""
+            f.puts "  stop program = \"#{server_dir.appserver_cmd('stop', app.name)}\""
+            f.puts "  if totalcpu usage > #{app.max_cpu_usage}#{cyclecheck} then restart" if app.max_cpu_usage
+            f.puts "  if totalmemory usage > #{app.max_memory_usage}#{cyclecheck} then restart" if app.max_memory_usage
+            f.puts "  if failed unixsocket #{app.socket} protocol http request \"/\" timeout #{app.http_check_timeout} seconds then restart" if app.http_check_timeout
+            f.puts "  if 5 restarts within 5 cycles then timeout"
+            f.puts "  group appserver"
+            f.puts "check file #{app.name}_revision with path #{app.revision_file}"
+            f.puts "  if changed checksum then exec \"#{server_dir.appserver_cmd('restart', app.name)}\""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appserver/nginx.rb

@@ -0,0 +1,71 @@
+module Appserver
+  class Nginx < Struct.new(:server_dir)
+
+    def self.write_config (server_dir)
+      new(server_dir).write_config
+    end
+
+    def initialize (server_dir)
+      self.server_dir = server_dir
+    end
+
+    def write_config
+      Utils.safe_replace_file(server_dir.nginx_conf) do |f|
+        f.puts "# Nginx configuration automagically generated by the \"appserver\" gem using"
+        f.puts "# the appserver directory config #{server_dir.config_file}"
+        f.puts "# Include this file into your system's nginx.conf (using an include statement"
+        f.puts "# inside a http statement) to use it. See http://github.com/zargony/appserver"
+        f.puts "# for details."
+        # The default server always responds with 403 Forbidden
+        f.puts "server {"
+        f.puts "  listen 80 default;"
+        f.puts "  server_name _;"
+        f.puts "  deny all;"
+        f.puts "}"
+        # Add application-specific Nginx configuration
+        server_dir.apps.each do |app|
+          f.puts ""
+          f.puts "# Application: #{app.name}"
+          if app.socket
+            f.puts "upstream #{app.name} {"
+            f.puts "  server unix:#{app.socket} fail_timeout=0;"
+            f.puts "}"
+            write_server_definition(f, app)
+            write_server_definition(f, app, true) if app.ssl?
+          end
+        end
+      end
+    end
+
+  protected
+
+    def write_server_definition (f, app, ssl = false)
+      f.puts "server {"
+      f.puts "  listen #{ssl ? 443 : 80};"
+      f.puts "  server_name #{app.hostname};"
+      if ssl
+        f.puts "  ssl on;"
+        f.puts "  ssl_certificate #{app.ssl_cert};"
+        f.puts "  ssl_certificate_key #{app.ssl_key};"
+        f.puts "  ssl_session_timeout 5m;"
+        f.puts "  ssl_protocols SSLv2 SSLv3 TLSv1;"
+        f.puts "  ssl_ciphers ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;"
+        f.puts "  ssl_prefer_server_ciphers on;"
+      end
+      f.puts "  root #{app.public_path};"
+      f.puts "  access_log #{app.access_log};"
+      # TODO: maintenance mode rewriting
+      f.puts "  try_files $uri/index.html $uri.html $uri @#{app.name};"
+      f.puts "  location @#{app.name} {"
+      f.puts "    proxy_set_header X-Real-IP $remote_addr;"
+      f.puts "    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;"
+      f.puts "    proxy_set_header X-Forwarded-Proto https;" if ssl
+      f.puts "    proxy_set_header Host $http_host;"
+      f.puts "    proxy_redirect off;"
+      f.puts "    proxy_pass http://#{app.name};"
+      f.puts "  }"
+      f.puts "  error_page 500 502 503 504 /500.html;" if File.exist?(File.join(app.public_path, '500.html'))
+      f.puts "}"
+    end
+  end
+end

data/lib/appserver/repository.rb

@@ -1,48 +1,107 @@
+require 'fileutils'
+require 'git'
+
 module Appserver
-  class Repository < Struct.new(:server, :dir)
-    class InvalidRepositoryError < RuntimeError; end
+  class InvalidRepositoryError < RuntimeError; end
+  class ExecError < RuntimeError; end
 
-    include Utils
+  class Repository < Struct.new(:server_dir, :path)
 
-    def initialize (server, dir, config)
-      self.server, self.dir = server, dir.chomp('/')
+    def initialize (server_dir, path, config)
+      self.server_dir, self.path = server_dir, path.chomp('/')
       raise InvalidRepositoryError unless valid?
     end
 
     def name
-      File.basename(dir, '.git')
+      File.basename(path, '.git')
+    end
+
+    def app
+      # The app for this repository (app of same name)
+      @app ||= server_dir.app(name)
     end
 
     def valid?
-      File.directory?(File.join(dir, 'hooks')) && File.directory?(File.join(dir, 'refs'))
+      name && name != '' &&
+      File.directory?(File.join(path, 'hooks')) &&
+      File.directory?(File.join(path, 'refs'))
     end
 
-    def post_receive_hook
-      File.join(dir, 'hooks', 'post-receive')
+    def update_hook
+      File.join(path, 'hooks', 'update')
     end
 
     def install_hook
-      deploy_cmd = "#{File.expand_path($0)} -d #{server.dir} deploy #{dir}"
-      puts deploy_cmd
-      if !File.exist?(post_receive_hook) || !File.executable?(post_receive_hook)
-        puts "Installing git post-receive hook to repository #{dir}..."
-        safe_replace_file(post_receive_hook) do |f|
+      deploy_cmd = server_dir.appserver_cmd('deploy')
+      if !File.exist?(update_hook) || !File.executable?(update_hook)
+        puts "Installing git update hook to repository #{path}..."
+        Utils.safe_replace_file(update_hook) do |f|
           f.puts '#!/bin/sh'
-          f.puts deploy_cmd
-          f.chown File.stat(dir).uid, File.stat(dir).gid
+          f.puts "#{deploy_cmd} #{path} $1 $3"
+          f.chown File.stat(path).uid, File.stat(path).gid
           f.chmod 0755
         end
-      elsif !File.readlines(post_receive_hook).any? { |line| line =~ /^#{Regexp.escape(deploy_cmd)}/ }
-        puts "Couldn't install post-receive hook. Foreign hook script already present in repository #{dir}!"
+      elsif !File.readlines(update_hook).any? { |line| line =~ /^#{Regexp.escape(deploy_cmd)}/ }
+        puts "Couldn't install update hook. Foreign hook script already present in repository #{path}!"
       else
-        #puts "Hook already installed in repository #{dir}"
+        #puts "Hook already installed in repository #{path}"
+      end
+    end
+
+    def deploy (ref = nil)
+      # Choose a temporary build directory on the same filesystem so that it
+      # can be easily renamed/moved to be the real application directory later
+      build_path, old_path = "#{app.path}.new", "#{app.path}.old"
+      begin
+        # Check out the current code
+        ref ||= app.branch
+        checkout(build_path, ref)
+        # Install gem bundle if a Gemfile exists
+        install_bundle(build_path)
+
+        # TODO: more deploy setup (write database config, ...)
+
+        # Replace the current application directory with the newly built one
+        FileUtils.rm_rf old_path
+        FileUtils.mv app.path, old_path if File.exist?(app.path)
+        FileUtils.mv build_path, app.path
+      ensure
+        # If anything broke and the build directory still exists, remove it
+        FileUtils.rm_rf build_path
+        # If anything broke and the app directory doesn't exist anymore, put the old directory in place
+        FileUtils.mv old_path, app.path if !File.exist?(app.path) && File.exist?(old_path)
       end
     end
 
   protected
 
-    def expand_path (path)
-      File.expand_path(path, dir)
+    def checkout (target_path, ref = 'master')
+      # There seem to be two ways to "export" the tip of a branch from a repository
+      # 1. clone the repository, check out the branch and remove the .git directory afterwards
+      #system("git clone --depth 1 --branch master #{path} #{target_path} && rm -rf #{target_path}/.git")
+      # 2. do a hard reset while pointing GIT_DIR to the repository and GIT_WORK_TREE to an empty dir
+      #system("mkdir #{target_path} && git --git-dir=#{path} --work-tree=#{target_path} reset --hard #{branch}")
+      git = Git.clone(path, target_path, :depth => 1)
+      ref = git.revparse(ref)
+      git.checkout(ref)
+      Dir.chdir(target_path) do
+        FileUtils.rm_rf '.git'
+        Utils.safe_replace_file 'REVISION' do |f|
+          f.puts ref
+        end
+      end
+    end
+
+    def install_bundle (target_path)
+      Dir.chdir(target_path) do
+        # Remove any .bundle subdirectory (it shouldn't be in the repository anyway)
+        FileUtils.rm_rf '.bundle'
+        # If there's a Gemfile, run "bundle install"
+        if File.exist?('Gemfile')
+          system "#{app.ruby} -S -- bundle install .bundle --without development test"
+          raise ExecError if $?.exitstatus > 0
+        end
+      end
     end
   end
 end

data/lib/appserver/server_dir.rb

@@ -0,0 +1,100 @@
+require 'fileutils'
+
+module Appserver
+  class DirectoryAlreadyExistError < RuntimeError; end
+  class NotInitializedError < RuntimeError; end
+
+  class ServerDir < Struct.new(:path, :monit_conf, :monit_reload, :nginx_conf, :nginx_reload, :nginx_reopen, :logrotate_conf)
+
+    CONFIG_FILE_NAME = 'appserver.conf.rb'
+
+    SETTINGS_DEFAULTS = {
+      :monit_conf => 'monitrc',
+      :monit_reload => '/usr/sbin/monit reload',
+      :nginx_conf => 'nginx.conf',
+      :nginx_reload => '/usr/sbin/nginx -s reload',
+      :nginx_reopen => '/usr/sbin/nginx -s reopen',
+      :logrotate_conf => 'logrotate.conf',
+    }
+
+    SETTINGS_EXPAND = [ :monit_conf, :nginx_conf, :logrotate_conf ]
+
+    def self.config_file_template
+      File.expand_path("../#{CONFIG_FILE_NAME}", __FILE__)
+    end
+
+    def self.discover (path = '.', options = {})
+      if File.exist?(File.join(path, CONFIG_FILE_NAME))
+        new(path, options)
+      elsif path != '/'
+        discover(File.expand_path('..', path), options)
+      else
+        raise NotInitializedError
+      end
+    end
+
+    def self.init (path, options = {})
+      raise DirectoryAlreadyExistError if File.exist?(path) && !options[:force]
+      FileUtils.mkdir_p path
+      Dir.chdir(path) do
+        FileUtils.cp config_file_template, CONFIG_FILE_NAME
+        FileUtils.mkdir_p ['apps', 'tmp', 'log']
+      end
+      new(path, options)
+    end
+
+    def initialize (path, options = {})
+      self.path = File.expand_path(path)
+      # Load and apply configuration settings
+      app_keys = App::SETTINGS_DEFAULTS.keys
+      global_keys = SETTINGS_DEFAULTS.keys + App::SETTINGS_DEFAULTS.keys
+      @config = Configurator.new(File.exist?(config_file) ? config_file : nil, global_keys, app_keys)
+      @config.apply!(self)
+    end
+
+    def config_file
+      File.join(path, CONFIG_FILE_NAME)
+    end
+
+    def appserver_cmd (*args)
+      cmd = File.expand_path('../../../bin/appserver', __FILE__)
+      "#{cmd} -d #{path} #{args.join(' ')}"
+    end
+
+    def apps_path
+      File.join(path, 'apps')
+    end
+
+    def tmp_path
+      File.join(path, 'tmp')
+    end
+
+    def log_path
+      File.join(path, 'log')
+    end
+
+    def app (name)
+      @apps ||= {}
+      @apps[name] ||= App.new(self, name, @config)
+    end
+
+    def apps
+      Dir.glob(File.join(apps_path, '*')).
+        select { |f| File.directory?(f) }.
+        map { |f| File.basename(f) }.
+        reject { |f| f =~ /\.(tmp|old|new)$/ }.
+        map { |name| app(name) }
+    end
+
+    def repository (path)
+      @repositories ||= {}
+      @repositories[File.expand_path(path, self.path)] ||= Repository.new(self, path, @config)
+    end
+
+    def write_configs
+      Monit.write_config(self)
+      Nginx.write_config(self)
+      Logrotate.write_config(self)
+    end
+  end
+end