proctor 0.0.2 → 0.0.3

data/Proctorfile

@@ -0,0 +1,4 @@
+---
+managers:
+  upstart:
+    export_directory: '/tmp/test'

data/README.md

@@ -1,6 +1,15 @@
 # Proctor
 
-TODO: Write a gem description
+Proctor is a configurable process manager that supports:
+* customized upstart/init scripts
+* separate start/stop/restart commands
+* multiple managent tools like monit & upstart
+* lightweight process monitoring
+* config file cleanup
+
+Proctor was inspired by the excellent Foreman gem.  Proctor
+seeks to retain the clean and simple design of Foreman,
+while adding a bit more configurability.
 
 ## Installation
 
@@ -18,7 +27,93 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Start by running 'proctor help'.
+
+Proctor is useful when an application requires a suite of
+independent processes which need to be managed and monitored.
+
+For development, Proctor brings up all your processes in a
+single screen, just like Foreman.
+
+For production, Proctor is designed to work in concert with
+config tools like Puppet/Chef, and with deploy tools like
+Capistrano.  Proctor can create tailored application
+manifests for single or multi-server deployments.
+
+## Background
+
+With Proctor, all of your application processes are described in
+a single YAML file, called a Proctorfile.
+
+In the Proctorfile, you can designate one or more Nodes.  Example
+Nodes include `web`, `db`, `backup`.  Each node has a list of
+Services.
+
+    nodes:
+      web:
+        - passenger
+        - faye
+        - jobq
+        - renderpro
+        - redis
+      db:
+        - postgres-shared
+      backup:
+        - postgres
+
+Services are defined independently.  Example Services include
+`unicorn`, `faye`, `postgres` and `redis`.
+
+    services:
+      unicorn:
+        start_command: "bin/unicorn --log_file shared/log/<%= name %>.log"
+        stop_command:  "qwer"
+      passenger:
+        start_command: "bin/passenger --log_file shared/log/<%= name %>.log"
+        stop_command:  "qwer"
+      faye:
+        start_command: "qwer"
+        export.monit.memory_limit:  "<%= ForemanEnv.production? ? '20MB' : '10MB' %>"
+        exports_to:            ['monit', 'upstart']
+        start_command: "script/faye_script.sh"
+        port: 2343
+
+Services are controlled and monitored by Managers.  Example
+Managers include `upstart`, `monit`, and `foreman`.
+
+    managers:
+      upstart:
+        export_directory: "/etc/init"
+        start_command:    "/sbin/init start <%= app_name %>"
+        stop_command:     "/sbin/init stop <%= app_name %>"
+        status_command:   "/sbin/init status <%= app_name %>"
+      monit:
+        export_directory: "/etc/monit/conf.d"
+        reload_command:   "monit reload"
+        stop_command:     "monit quit"
+        start_command:    "monit"
+        status_command:   "monit summary"
+        pidfile:          "/a/b/c"
+      foreman:
+        start_command:    "foreman start"
+        use_master_template: true
+        use_worker_template: false
+
+In a Proctor run, ERB templates are used to create config
+files that are exported to managers.  Different Templates
+can be established for each type of Service and Manager.
+
+    # Monit config file (template: <%= original_template_file %>)
+    # Generated by Proctor at <%=  Time.now %>
+    #   Hostname: <%= ENV['host'] %>
+    #   Target Directory: <%= export_directory %>
+
+    check process <%= role_name %> with pidfile <%= pidfile %>
+      start program = "<%= start_command %>"
+      stop program = "<%= stop_command %>"
+
+In a Proctor run, multiple Proctorfiles can be referenced, and
+their values will be merged together.
 
 ## Contributing
 

data/Rakefile

@@ -3,7 +3,21 @@ require "bundler/gem_tasks"
 
 desc "Run all specs"
 task :rspec do
-  system "rspec"
+  system "rspec -d"
+end
+
+namespace :rspec do
+
+  desc "Run unit specs"
+  task :unit do
+    system "rspec -d spec/unit"
+  end
+
+  desc "Run acceptance specs"
+  task :acceptance do
+    system "rspec -d spec/acceptance"
+  end
+
 end
 
 task :default => :rspec

data/bin/proctor

@@ -3,26 +3,20 @@
 $: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
 require 'rubygems'
+require 'debugger'
 require 'gli'
 require 'proctor'
 
 include GLI
+include Proctor
+
+APP_CONFIG=
 
 # ---- global options ----------------------------------------------------
 
 version Proctor::VERSION
 program_desc 'proctor - an application process manager'
 
-desc 'Root Directory'
-default_value Dir.pwd
-arg_name 'APP_ROOT'
-flag [:d,'app-root']
-
-desc 'Application Environment'
-default_value "production"
-arg_name 'ENV'
-flag [:e,:environment]
-
 desc 'Select Proctorfile'
 default_value 'Proctorfile'
 arg_name 'PROCTORFILE'
@@ -32,93 +26,106 @@ flag [:f,:proctorfile]
 
 desc 'Validates your application Proctorfile'
 command :check do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN CHECK"
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
+  c.action do |global,options,args|
+    puts "OK"
   end
 end
 
-desc 'Clean up generated files'
+desc 'Removes exported proctor assets'
+long_desc <<-EOF
+Requires a NODE and a MANAGER name.  To see
+all NODEs and MANAGERs, use 'proctor list'.
+EOF
+arg_name "NODE MANAGER"
 command :cleanup do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN CHECK"
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
+  c.action do |global,options,args|
+    puts "CLEANUP"
   end
 end
 
-desc 'Exports the app to another tool'
-arg_name 'Describe arguments to export here'
+desc 'Exports assets to a management tool'
+long_desc <<-EOF
+Requires a NODE and a MANAGER name.  To see
+all NODEs and MANAGERs, use 'proctor list'.
+EOF
+arg_name "NODE MANAGER"
 command :export do |c|
-
-  c.desc 'Format'
-  c.default_value 'upstart'
-  c.arg_name 'FORMAT'
-  c.flag [:f, :format]
-
-  c.desc 'Location'
-  c.default_value Dir.pwd
-  c.arg_name 'DIRECTORY'
-  c.flag [:d, :directory]
-
-  c.action do |global_options,options,args|
-    puts "I AM IN EXPORT"
+  c.action do |global,options,args|
+    puts "EXPORT"
   end
-
 end
 
-desc 'Generates local templates'
-arg_name 'Describe arguments to init here'
-command :generate do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN INIT"
-  end
-end
+desc 'Lists handles, names and paths for proctor assets'
+long_desc <<-EOF
+Lists the name or path of each Proctor asset.  Asset types include Templates,
+AppFiles, Managers, Services, and Nodes.  Managers, Services and Nodes are
+defined within an AppFile.
 
-desc 'Creates a starter Procfile '
-arg_name 'Describe arguments to init here'
-command :init do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN INIT"
+AppFile values from multiple files are merged together.  When there is a conflict,
+the last value take precedence.
+EOF
+command :list do |c|
+  opt_arr = %w(templates appfiles managers services manifest all)
+  opt_str = opt_arr.join('|')
+  c.desc "One of: [#{opt_str}]"
+  c.default_value 'all'
+  c.arg_name 'ASSET_TYPE'
+  c.flag [:t, :type]
+  c.action do |global,options,args|
+    unless opt_arr.include?(options[:type])
+      raise "unrecognized type (#{options[:type]}) must be one of [#{opt_str}]"
+    end
+    Presenter::List.new(global, options, args).render
   end
 end
 
-desc 'Lists available formats'
-arg_name 'Describe arguments to init here'
-command :list do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN LIST"
+desc 'Renders an ERB template to the console'
+arg_name 'MANAGER SERVICE'
+long_desc <<-EOF
+Requires a MANAGER and a SERVICE.  To see all
+MANAGERs and SERVICEs, use 'proctor list'.
+EOF
+command :render do |c|
+  c.action do |global,options,args|
+    raise "usage 'render ROLE MANAGER'" unless args.length == 2
+
+    Presenter::Render.new(global, options, args).render
   end
 end
 
-desc 'Run the application (development mode)'
-arg_name 'Describe arguments to run here'
-command :run do |c|
-  c.action do |global_options,options,args|
-    puts "I AM IN RUN"
+desc 'Shows content of a proctor asset'
+long_desc <<-EOF
+Displays a raw asset (Template, AppFile, Manager, Service, Node)
+to the console.  View asset handles using 'proctor list'.  (asset
+handles are three character strings at the start of each line)
+EOF
+arg_name 'HANDLE'
+command :show do |c|
+  c.action do |global,options,args|
+    raise "need a handle!" if args.length != 1
+    Presenter::Show.new(global, options, args).show
   end
 end
 
-desc 'Start the application (production mode)'
-arg_name 'Describe arguments to start here'
+desc 'Starts the application'
+arg_name "NODE MANAGER"
+long_desc <<-EOF
+Requires a NODE and a MANAGER name.  To see
+all NODEs and MANAGERs, use 'proctor list'.
+EOF
 command :start do |c|
-  c.desc 'Describe a switch to start'
-  c.switch :s
 
-  c.desc 'Describe a flag to start'
-  c.default_value 'default'
-  c.flag :f
   c.action do |global_options,options,args|
-    puts "I AM IN START"
-
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
+    puts "START"
   end
 end
 
-desc 'Stops the application (production mode)'
-arg_name 'Describe arguments to start here'
+desc 'Stops the application'
+arg_name "NODE MANAGER"
+long_desc <<-EOF
+Requires a NODE and a MANAGER name.  To see
+all NODEs and MANAGERs, use 'proctor list'.
+EOF
 command :stop do |c|
   c.desc 'Describe a switch to start'
   c.switch :s
@@ -127,15 +134,17 @@ command :stop do |c|
   c.default_value 'default'
   c.flag :f
   c.action do |global_options,options,args|
-    puts "I AM IN START"
-
-    # If you have any errors, just raise them
+    puts "I AM IN STOP"
     # raise "that command made no sense"
   end
 end
 
-desc 'Shows the application status (production mode)'
-arg_name 'Describe arguments to start here'
+desc 'Displays the application status'
+arg_name "NODE MANAGER"
+long_desc <<-EOF
+Requires a NODE and a MANAGER name.  To see
+all NODEs and MANAGERs, use 'proctor list'.
+EOF
 command :status do |c|
   c.desc 'Describe a switch to start'
   c.switch :s
@@ -143,11 +152,8 @@ command :status do |c|
   c.desc 'Describe a flag to start'
   c.default_value 'default'
   c.flag :f
-  c.action do |global_options,options,args|
-    puts "I AM IN START"
-
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
+  c.action do |global,options,args|
+    puts "I AM IN STATUS"
   end
 end
 
@@ -155,18 +161,16 @@ end
 # ----- pre/post --------------------------------------------------------------
 
 pre do |global,command,options,args|
-  # Pre logic here
-  # Return true to proceed; false to abort and not call the
-  # chosen command
-  # Use skips_pre before a command to skip this block
-  # on that command only
+  options[:app_config] = AppConfig.load(global)      unless command.nil? || command.name == :help
+  options[:templates]  = TemplateConfig.load(global) unless command.nil? || command.name == :help
+
+  # Return true to proceed; false to abort and not call the chosen command
+  # Use skips_pre before a command to skip this block on that command only
   true
 end
 
 post do |global,command,options,args|
-  # Post logic here
-  # Use skips_post before a command to skip this
-  # block on that command only
+  # Use skips_post before a command to skip this block on that command only
 end
 
 on_error do |exception|

data/lib/proctor/app_config.rb

@@ -0,0 +1,23 @@
+require 'hash_deep_merge'
+
+module Proctor
+  class AppConfig
+
+    def self.load(global_options = {:f => "Proctorfile"})
+      app_files = self.app_files(global_options).map {|f| AppFile.new(f)}
+      app_files.reduce({}) { |a,v| a.deep_merge(v.config_data) }
+    end
+
+    def self.app_files(global_options)
+      proctorfile = global_options[:f]
+      ["#{base_dir}/proctor/Proctorfile", "#{Dir.pwd}/#{proctorfile}", ]
+    end
+
+    private
+
+    def self.base_dir
+      File.expand_path(File.dirname(File.expand_path(__FILE__)) + '/../..')
+    end
+
+  end
+end

data/lib/proctor/app_file.rb

@@ -1,5 +1,44 @@
+require 'yaml'
+
 module Proctor
-  module AppFile
+  class AppFile
+    attr_reader :config_data
+
+    def initialize(filename)
+      check_file_existence(filename)
+      @config_data = load_data(filename)
+      check_data_format(filename)
+    end
+
+    private
+
+    def load_data(file)
+      begin
+        @config_data = YAML.load_file(file)
+      rescue Psych::SyntaxError
+        error_msg = "invalid file format (expecting YAML - #{file})"
+        raise InvalidYamlException.new, error_msg
+      end
+    end
+
+    def check_data_format(file)
+      raise InvalidDataType, "expecting hash data (#{file})" unless @config_data.is_a?(Hash)
+    end
+
+    def check_file_existence(file)
+      error_msg = "missing app file (#{file})"
+      raise MissingFileException, error_msg unless File.exist?(file)
+    end
+
+  end
+  
+  class MissingFileException < RuntimeError
+  end
+  
+  class InvalidYamlException < RuntimeError
+  end
 
+  class InvalidDataType < RuntimeError
   end
+  
 end

data/lib/proctor/cmd_state.rb

@@ -0,0 +1,39 @@
+module Proctor
+
+  class CmdState
+
+    def self.app_files(global, options, args)
+      AppConfig.app_files(global)
+    end
+
+    def self.templates(global, options, args)
+      options[:templates].values.sort
+    end
+
+    def self.nodes(global, options, args)
+      options[:app_config]['nodes']
+    end
+
+    def self.node_names(global, options, args)
+      options[:app_config]['nodes'].keys
+    end
+
+    def self.services(global, options, args)
+      options[:app_config]['services']
+    end
+
+    def self.service_names(global, options, args)
+      options[:app_config]['services'].keys
+    end
+
+    def self.managers(global, options, args)
+      options[:app_config]['managers']
+    end
+
+    def self.manager_names(global, options, args)
+      options[:app_config]['managers'].keys
+    end
+
+  end
+
+end

data/lib/proctor/manager.rb

@@ -1,5 +1,11 @@
 module Proctor
-  module Manager
+  class Manager
+    attr_reader :input_hash, :opts
+
+    def initialize(hash = {})
+      @input_hash = hash
+    end
 
   end
-end
+end
+

data/lib/proctor/presenter/list.rb

@@ -0,0 +1,67 @@
+require 'digest/md5'
+
+module Proctor
+  module Presenter
+    class List
+
+      def initialize(global, options, args)
+        @global  = global
+        @options = options
+        @args    = args
+      end
+
+      def render
+        case @options[:type]
+          when "appfiles"    then render_appfiles
+          when "managers"    then render_managers
+          when "services"    then render_services
+          when "templates"   then render_templates
+          when "node"        then render_node
+          when "all"         then render_all
+        end
+      end
+
+      def handle(string)
+        Digest::MD5.hexdigest(string)[0..2]
+      end
+
+      def puts_handle(string)
+        puts "#{handle(string)}: #{string}"
+      end
+
+      def render_templates
+        puts "[Templates]"
+        CmdState.templates(@global, @options, @args).each {|v| puts_handle(v)}
+      end
+
+      def render_appfiles
+        puts "[AppFiles]"
+        CmdState.app_files(@global, @options, @args).each { |f| puts "#{handle(f)}: #{f}" }
+      end
+
+      def render_managers
+        puts "[Managers]"
+        CmdState.managers(@global, @options, @args).keys.each {|k| puts_handle(k)}
+      end
+
+      def render_services
+        puts "[Services]"
+        CmdState.services(@global, @options, @args).keys.each {|k| puts_handle(k)}
+      end
+
+      def render_node
+        puts "[Nodes]"
+        CmdState.nodes(@global, @options, @args).keys.each {|k| puts_handle(k)}
+      end
+
+      def render_all
+        render_templates
+        render_appfiles
+        render_managers
+        render_services
+        render_node
+      end
+
+    end
+  end
+end

data/lib/proctor/presenter/render.rb

@@ -0,0 +1,39 @@
+module Proctor
+  module Presenter
+    class Render
+
+      def initialize(global, options, args)
+        @global  = global
+        @options = options
+        @args    = args
+        @role    = args[0]
+        @manager = args[1]
+        check_for_valid_role(@role)
+        check_for_valid_manager(@manager)
+      end
+
+      def check_for_valid_role(role)
+        roles = CmdState.roles(@global, @options, @args) + ["manifest"]
+        unless roles.include? role
+          raise "Invalid ROLE (#{role}) - use one of [#{roles.join('|')}]"
+        end
+      end
+
+      def check_for_valid_manager(manager)
+        managers = CmdState.manager_names(@global, @options, @args)
+        unless managers.include? manager
+          raise "Invalid MANAGER (#{manager}) - use one of [#{managers.join('|')}]"
+        end
+      end
+
+      def render_template
+        puts "# Template #{@role} #{@manager}"
+      end
+
+      def render
+        render_template
+      end
+
+    end
+  end
+end