test/test_task_node.rb website/javascripts/code_highlighter.js website/javascripts/ruby.js @@ -11,3 +11,25 @@ require 'lib/capitate/recipes' require 'erb' +# Test +task :test_egrep do + role :test, "10.0.6.118", :user => "root" + + found = utils.egrep("^mail.\\*", "/etc/syslog.conf") + puts "Found? #{found}" + + found = utils.egrep("^fooo", "/etc/syslog.conf") + puts "Found? #{found}" +end + +task :test_app do + set :application, "sick" + set :deploy_to, "/var/www/apps/sick" + role :web, "10.0.6.118", :user => "root" + role :app, "10.0.6.118", :user => "root" +end + +task :test_install do + load File.dirname(__FILE__) + "/lib/deployment/centos-5.1-64-web/install.rb" + role :test, "10.0.6.118", :user => "root" +end Capfile @@ -12,13 +12,21 @@ module Capitate # establishes connections to them, and then yields that list of # servers. # - # Overriden to handle NoMatchingServersError as NON-FATAL + # If you set: + # + # set :ignore_missing_roles, true + # + # Overriden to handle NoMatchingServersError as NON-FATAL. # - def execute_on_servers_with_capitate(options={}, &block) - begin + def execute_on_servers_with_capitate(options={}, &block) + if exists?(:ignore_missing_roles) && fetch(:ignore_missing_roles) + begin + execute_on_servers_without_capitate(options, &block) + rescue Capistrano::NoMatchingServersError => e + logger.important "`#{current_task.fully_qualified_name}' is only run for servers matching #{current_task.options.inspect}, but no servers matched" + end + else execute_on_servers_without_capitate(options, &block) - rescue Capistrano::NoMatchingServersError => e - logger.important "`#{current_task.fully_qualified_name}' is only run for servers matching #{current_task.options.inspect}, but no servers matched" end end @@ -59,7 +67,7 @@ module Capitate clear_sessions end - # Yields the previous user. + # Perform action as a different user. Yields the previous user to the block. # # ==== Options # +new_user+:: User to become @@ -81,8 +89,7 @@ module Capitate clear_sessions end - # Close all open sessions. - # Will force user to re-login. + # Close all open sessions, and will force user to re-login. def clear_sessions sessions.each do |key, session| logger.info "Closing: #{key}" @@ -91,15 +98,7 @@ module Capitate sessions.clear reset_password end - - # Reset the password. - # Display the current user that is asking for the password. - def reset_password - set :password, Proc.new { - Capistrano::CLI.password_prompt("Password (for user: #{user}): ") - } - end - + end end end lib/capitate/cap_ext/connections.rb @@ -2,6 +2,8 @@ module Capitate::CapExt::RunVia # Invoke command with current run_method setting. # + # Chooses +sudo+ or +run+ based on <tt>:run_method</tt> setting. + # # ==== Options # +cmd+:: Command to run # +options+:: Options (see invoke_command options) lib/capitate/cap_ext/run_via.rb @@ -7,7 +7,7 @@ module Capitate base.send :alias_method, :fetch, :fetch_with_capitate end - # Fetch (alias method chained) variable. + # Fetch. # Displays usage message from recipe docs if variable not found. # # See capistrano fetch for usage info. @@ -72,7 +72,7 @@ module Capitate nil end - # Fetch roles with name and options + # Fetch roles with name and options. # I don't actually use this. # # ==== Options lib/capitate/cap_ext/variables.rb @@ -5,17 +5,16 @@ require 'yaml' module Capitate::Plugins::Base # Project root. Fetch from :project_root, or fall back to RAILS_ROOT. - # def root - if respond_to?(:fetch) - return fetch(:project_root) - else - RAILS_ROOT - end + return fetch(:project_root) if exists?(:project_root) + RAILS_ROOT end # Path relative to project root. - # Project root is set via, set :project_root, "path/to/project" in Capfile. + # + # To set the project root: + # + # set :project_root, "path/to/project" in Capfile. # # ==== Options # +path+:: Relative path @@ -48,7 +47,7 @@ module Capitate::Plugins::Base # Usage for current task. # # ==== Options - # +variable+:: Missing variable setting + # +variable+:: Missing variable setting (to display as not set) # # ==== Examples # usage(:gem_list) => "Description from task definition." @@ -86,7 +85,13 @@ module Capitate::Plugins::Base s.split("\n").collect { |sp| "#{indentation}#{sp}"}.join("\n") end - # Unindent, lifted from capistrano bin/capify + # Unindent. + # + # Lifted from capistrano bin/capify + # + # ==== Options + # +string+:: String to unindent + # def unindent(string) return "" if string.blank? if string =~ /\A(\s*)/ @@ -96,7 +101,7 @@ module Capitate::Plugins::Base string end - # Load all tasks + # Load all tasks into an array. def load_all_tasks tasks = [] top.namespaces.each do |namespace| @@ -105,7 +110,7 @@ module Capitate::Plugins::Base tasks end - # Task tree + # Build a task tree, consisting of task nodes. def task_tree top_node = Capitate::TaskNode.new("top") @@ -116,7 +121,7 @@ module Capitate::Plugins::Base end protected - + def load_tasks(namespace, tasks = []) recipe = namespace.last lib/capitate/plugins/base.rb @@ -4,16 +4,17 @@ module Capitate::Plugins::Build # # ==== Options # +name+:: Name for app - # +options+:: Options - # - +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name - # - +url+:: URL to download package from - # - +configure_options+:: Options for ./configure - # - +symlink+:: After install, list of source, dest pairs to symlink + # +options+:: Options (See Make install options) + # + # ==== Make install options + # +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name + # +url+:: URL to download package from + # +configure_options+:: Options for ./configure + # +symlink+:: After install, list of source, dest pairs to symlink # [ { "/usr/local/sphinx-0.9.8-rc1" => "/usr/local/sphinx" }, ... ] # ln -s /usr/local/sphinx-0.9.8-rc1 /usr/local/sphinx - # - # - +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) - # - +to_log+:: If specified, will redirect output to this path + # +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) + # +to_log+:: If specified, will redirect output to this path # # ==== Examples (in capistrano task) # build.make_install("nginx", { :url => "http://sysoev.ru/nginx/nginx-0.5.35.tar.gz", ... }) @@ -44,9 +45,11 @@ module Capitate::Plugins::Build # # ==== Options # +name+:: Name for app - # +options+:: Options - # - +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name - # - +url+:: URL to download package from + # +options+:: Options (see Install options) + # + # ==== Install options + # +build_dest+:: Place to build from, ex. /usr/src, defaults to /tmp/name + # +url+:: URL to download package from # # ==== Examples (in capistrano task) # script.make("rubygems", { :url => :url => "http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz" }) do |dir| lib/capitate/plugins/build.rb @@ -16,10 +16,12 @@ module Capitate::Plugins::Prompt # # ==== Options # +label+:: Label - # +options+:: Options - # - +verify+:: If true, prompt twice and verify - # - +lazy+:: If true, returns a Proc. _Defaults to true_ - # - +check_hash+:: If present, checks that md5 is same as password md5 + # +options+:: Options (see Password options) + # + # ==== Password options + # +verify+:: If true, prompt twice and verify + # +lazy+:: If true, returns a Proc. _Defaults to true_ + # +check_hash+:: If present, checks that md5 is same as password md5 # def password(label, options = {}) @@ -67,10 +69,6 @@ module Capitate::Plugins::Prompt password_prompt.call end - def check_password_hash(password, hash) - MD5.md5() - end - end Capistrano.plugin :prompt, Capitate::Plugins::Prompt lib/capitate/plugins/prompt.rb @@ -36,9 +36,11 @@ module Capitate::Plugins::Script # ==== Options # +url+:: URL to download # +dest+:: Destination directory - # +options+:: - # - +clean+:: If true will remove the unpacked directory. _Defaults to true_ - # - +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) + # +options+:: Options (see Unpack options) + # + # ==== Unpack options + # +clean+:: If true will remove the unpacked directory. _Defaults to true_ + # +unpack_dir+:: Directory that is unpacked from tgz (if not matching the file name) # # ==== Examples # script.unpack("http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz", "/tmp/rubygems") do @@ -80,7 +82,7 @@ module Capitate::Plugins::Script # # ==== Options # +cmds+:: Commands (separated by newlines) - # +options+:: See invoke_command options + # +options+:: See Capistrano invoke_command options # def run_all(cmds, options = {}, &block) cmds.split("\n").each do |cmd| lib/capitate/plugins/script.rb @@ -1,6 +1,6 @@ module Capitate::Plugins::Templates - # Load template. If extension is erb will be evaluated with binding. + # Load template. If the extension is .erb will be evaluated with binding. # # You can add to the list of places we search for templates by setting: # @@ -17,8 +17,9 @@ module Capitate::Plugins::Templates # +override_binding+:: Binding to override, otherwise uses current (task) binding # # ==== Examples - # template.load("memcached/memcached.monitrc.erb") - # put template.load("memcached/memcached.monitrc.erb"), "/tmp/memcached.monitrc" + # template.load("memcached/memcached.monitrc.erb") => "This is the text of eval'ed template found at ..." + # + # put template.load("memcached/memcached.monitrc.erb"), "/tmp/memcached.monitrc" # Uploads eval'ed template to remote /tmp/ directory # def load(path, override_binding = nil) template_dirs_found = template_dirs.select { |dir| File.exist?("#{dir}/#{path}") } @@ -69,9 +70,16 @@ module Capitate::Plugins::Templates protected - # Load all possible places for templates + # Load all possible places for templates. + # + # Returns: + # * the <tt>:templates_dirs</tt> setting (if set) + # * the current directory + # * the <tt>:project_root</tt> setting (if set) + # * the gem templates path + # def template_dirs - @template_dir ||= begin + @template_dirs ||= begin template_dirs = [] template_dirs += fetch(:templates_dirs) if exists?(:templates_dirs) template_dirs << "." @@ -88,11 +96,12 @@ protected # Get full template path from relative path. # - # Something like <tt>monit/monit.cnf => /usr/lib/..../capitate/lib/templates/monit/monit.cnf</tt>. - # # ==== Options # +template_path+:: Relative path # + # ==== Examples + # gem_template_path("monit/monit.cnf") => /usr/lib/..../capitate/lib/templates/monit/monit.cnf + # def gem_template_path(template_path) File.join(gem_templates_root, template_path) end lib/capitate/plugins/templates.rb @@ -1,11 +1,12 @@ module Capitate::Plugins::Upload # Upload file with source path. + # # Data is streamed. # # ==== Options # +src_path+:: Source path - # +dest_path:: Remote destination path + # +dest_path+:: Remote destination path # +options+:: Options (see capistrano 'put') # # ==== Examples lib/capitate/plugins/upload.rb @@ -27,12 +27,14 @@ module Capitate::Plugins::Utils # ==== Options # +template_path+:: Path to template # +destination+:: Remote path to evaluated template - # +options+:: - # - +user+:: User to install (-o) - # - +mode+:: Mode to install file (-m) + # +options+:: Options (see Install template options) + # + # ==== Install template options + # +user+:: User to install (-o) + # +mode+:: Mode to install file (-m) # # ==== Example - # utils.install_template("monit/memcached.monitrc.erb", "/etc/monit/memcached.monitrc") + # utils.install_template("monit/memcached.monitrc.erb", "/etc/monit/memcached.monitrc", :user => "root", :mode => "600") # def install_template(template_path, destination, options = {}) # Truncate extension @@ -96,7 +98,7 @@ module Capitate::Plugins::Utils # ==== Options # +path+:: Path to file to append to # +data+:: String data to append - # +check+:: If not nil, will check to see if egrep matches "^string_to_check" and will not re-append + # +check+:: If not nil, will check to see if egrep matches this regex and will not re-append # +left_strip+:: If true (default), remove whitespace before lines # +should_exist+:: If true (default), raise error if file does not exist # lib/capitate/plugins/utils.rb @@ -50,13 +50,11 @@ class Capitate::TaskNode end # Get "child" nodes (sorted). - # def sorted_nodes nodes.sort_by(&:name) end # Get tasks (sorted). - # def sorted_tasks tasks.sort_by(&:fully_qualified_name) # { |t| t.name.to_s } end @@ -102,11 +100,16 @@ class Capitate::TaskNode # +title+:: Title and h1 for page, defaults to name # +options+:: Options # + # ==== Write doc options + # +include_source+:: If true, include source + # def write_doc(dir, file_name = nil, title = nil, options = {}, &block) file_name ||= full_name title ||= full_name(":") + + path = "#{dir}/#{file_name}.txt" puts "%10s %-30s" % [ "create", path ] @@ -159,15 +162,26 @@ class Capitate::TaskNode unless tasks.empty? file.puts "\n\nh2. Task documentation\n\n" sorted_tasks.each do |task| + file.puts %{<div class="recipe">\n\n} file.puts "h3(##{task.fully_qualified_name}). #{task.fully_qualified_name}\n\n" - file.puts "#{unindent(task.desc)}\n\n\n\n" + file.puts "#{unindent(task.desc)}\n\n" + + if options[:include_source] + file_name, source, comments = Capitate::TaskNode.find_source(task.fully_qualified_name) + unless source.blank? + file.puts "\n\n<pre><code class='ruby'>#{source}</code></pre>\n\n" + end + end + + file.puts "</div>\n\n\n" end end # # Write doc (recursively for "child" namespace) + # sorted_nodes.each do |snode| - snode.write_doc(dir) + snode.write_doc(dir, nil, nil, options) end # If block then let it do stuff with open file @@ -179,7 +193,6 @@ class Capitate::TaskNode end # Node to string. - # def to_s(level = 0) spaces = " " indent = (0...level).collect { spaces }.join("") @@ -198,36 +211,85 @@ class Capitate::TaskNode end s end + + # Weird way of getting at original source + def self.find_source(full_task_name) - # Class methods - class << self - - # Create nodes and and task to node. - # - # If task is "mysql:centos:install", the nodes will look like: - # - # (top node) -> (mysql node) -> (centos node; w/ tasks: install) - # - # ==== Options - # +top_node+:: Node to start at - # +task+:: Task to add - # - def populate_with_task(top_node, task) - node_names = task.namespace.fully_qualified_name.split(":") - - node = top_node - - node_names.each do |name| - parent_node = node - node = parent_node.find(name) - if !node - node = self.new(name, parent_node) - parent_node.add_node(node) - end + # Load all the recipes into map; I know you think this is cheesy + @@recipes_text_map ||= begin + map = {} + Dir[File.dirname(__FILE__) + "/../recipes/**/*.rb"].each do |file| + file_text = "" + File.open(file) { |f| file_text = f.read } + map[file] = file_text end - node.add_task(task) + map end - + + name_parts = full_task_name.split(":") + pre_namespaces = name_parts.split(":")[0..-3] + namespace_before = name_parts[-2] + task_name = full_task_name.split(":").last + + # Regex attempt #1: Try to un-greedy load up to next task + # Need this because don't know how to be un-greedy for task end and greedy for internal ends + regexs1 = [] + regexs1 += pre_namespaces.collect do |section| + "namespace\\s+:#{section}\\s+do.*" + end + regexs1 << "namespace\\s+:#{namespace_before}\\s+do(.*)" + regexs1 << "(task :#{task_name}.*?do.*end).*task.*" + + + # Regex attempt #2: + regexs2 = [] + regexs2 += pre_namespaces.collect do |section| + "namespace\\s+:#{section}\\s+do.*" + end + regexs2 << "namespace\\s+:#{namespace_before}\\s+do(.*)" + regexs2 << "(task :#{task_name}.*?do.*end).*" + (name_parts.length - 1).times do + regexs2 << ".*end" + end + + @@recipes_text_map.each do |file, file_text| + if file_text =~ /#{regexs1.to_s}/m or file_text =~ /#{regexs2.to_s}/m + comment_section = $1 + source_section = $2 + return [ file, source_section, comment_section ] + end + end + + puts "[WARNING] Source not found for: #{full_task_name}" + + nil + end + + # Create nodes and and task to node. + # + # If task is "mysql:centos:install", the nodes will look like: + # + # (top node) -> (mysql node) -> (centos node; w/ tasks: install) + # + # ==== Options + # +top_node+:: Node to start at + # +task+:: Task to add + # + def self.populate_with_task(top_node, task) + node_names = task.namespace.fully_qualified_name.split(":") + + node = top_node + + node_names.each do |name| + parent_node = node + node = parent_node.find(name) + if !node + node = self.new(name, parent_node) + parent_node.add_node(node) + end + end + node.add_task(task) end + end \ No newline at end of file lib/capitate/task_node.rb @@ -7,9 +7,19 @@ namespace :backgroundrb do pid_file = "\#{CONFIG_FILE[:backgroundrb][:pid_file]}" - *backgroundrb_host*: Backgroundrb host. _Defaults to 0.0.0.0_\n - *backgroundrb_port*: Backgroundrb port. _Defaults to 11006_\n - *backgroundrb_yml_template*: Backgroundrb yml template. _Defaults to @backgroundrb/backgroundrb.yml.erb@ in this gem.\n + <dl> + <dt>backgroundrb_host</dt> + <dd>Backgroundrb host</dd> + <dd class="default">Defaults to @0.0.0.0@</dd> + + <dt>backgroundrb_port</dt> + <dd>Backgroundrb port</dd> + <dd class="default">Defaults to @11006@</dd> + + <dt>backgroundrb_yml_template</dt> + <dd>Backgroundrb yml template</dd> + <dd class="default">Defaults to @backgroundrb/backgroundrb.yml.erb@ in this gem.</dd> + </dl> DESC task :setup do fetch_or_default(:backgroundrb_host, "0.0.0.0") @@ -21,10 +31,10 @@ namespace :backgroundrb do end desc <<-DESC - Symlink backgroundrb config into release path. + Symlink backgroundrb config into current path. DESC task :update_code do - run "ln -nfs #{shared_path}/config/backgroundrb.yml #{release_path}/config/backgroundrb.yml" + run "ln -nfs #{shared_path}/config/backgroundrb.yml #{current_path}/config/backgroundrb.yml" end end \ No newline at end of file lib/recipes/backgroundrb.rb @@ -5,8 +5,14 @@ namespace :backgroundrb do desc <<-DESC Setup backgroundrb for application. - *backgroundrb_bin_path*: Path to start. _Defaults to @{current_path}/script/backgroundrb start@_\n - *backgroundrb_pid_path*: Path to backgroundrb pid file. _Defaults to @{shared_path}/pids/backgroundrb.pid@_\n + <dl> + <dt>backgroundrb_bin_path</dt> + <dd>Path to start. + <dd class="default">Defaults to @\#{current_path}/script/backgroundrb -e production start@</dd> + <dt>backgroundrb_pid_path</dt> + <dd>Path to backgroundrb pid file</dd> + <dd class="default">Defaults to @\#{shared_path}/pids/backgroundrb.pid@</dd> + </dl> DESC task :setup do lib/recipes/centos/backgroundrb.rb @@ -3,6 +3,8 @@ namespace :docs do desc <<-DESC Generate documentation for all currently loaded recipes. Assumes textile formatting. + This recipe generated this documentation. + *docs_recipes_dir*: Destination directory. _Defaults to "docs/recipes"_ @set :docs_recipes_dir, "docs/recipes"@ @@ -24,7 +26,7 @@ namespace :docs do FileUtils.rm_rf(docs_recipes_dir) if docs_recipes_clear FileUtils.mkdir_p(docs_recipes_dir) - top_node.write_doc(docs_recipes_dir, "index", "Recipes") + top_node.write_doc(docs_recipes_dir, "index", "Recipes", :include_source => true) end end lib/recipes/docs.rb @@ -38,6 +38,15 @@ blockquote { font-size: 80%; } +dt { + padding-top:20px; + font-weight:bold; +} + +dd.default { + font-weight:italic; +} + #main { width: 45em; padding: 0; @@ -77,14 +86,19 @@ td { color: #995000; } pre, code { - font-family: monospace; - font-size: 90%; - line-height: 1.4em; - color: #ff8; + font-family: "Bitstream Vera Sans Mono", monospace; + text-align: left; + font-size: 0.9em; + line-height: 1.4em; background-color: #111; - padding: 2px 10px 2px 10px; + padding: 4px 10px 4px 10px; overflow: auto; } + +code { + color: #EEE; +} + .comment { color: #aaa; font-style: italic; } .keyword { color: #eff; font-weight: bold; } .punct { color: #eee; font-weight: bold; } @@ -108,28 +122,26 @@ pre, code { border: 3px solid #141331; } -.landing h1 { - -} - -#recipes { - -} - -.recipes pre, -.recipes code { +.recipes pre { margin: 0 30px; } -.recipes code { - display:block; -} - .recipes h3 { + margin: 0; padding: 4px; background-color: #E6E2AF; } +.recipe { + margin: 0 0 40px 0; + padding: 8px; + border: 1px dashed #555; +} + +h2+ul { + padding-bottom: 20px; +} + #version { float: right; text-align: right; @@ -166,3 +178,77 @@ pre, code { cursor: hand; } +/* Code highlighter */ +pre { + font-family: "Bitstream Vera Sans Mono", monospace; + text-align: left; + font-size: 0.8em; + position: relative; + left: -38px; + width: 698px; + color: #eee; +} + +code.ruby { + color: #eee; +} + +.javascript .comment, .ruby .comment, .css .comment { + color: #707070; + border: 0 solid transparent; +} + +.javascript .string, .ruby .string { + color: #8B9F67; +} + +.ruby .symbol { + color: #DF6447; +} + +.javascript .keywords, .ruby .keywords { + color: #D3A864; + font-weight: bold; +} + +.javascript .global { + color : blue; +} + +.javascript .brackets, .ruby .brackets { + color : #FFF; +} + +.css .properties { + color: #999966; +} + +.css .selectors { + color: #FF6600; + font-weight : bold; +} + +.css .units { + color: black; +} + +.css .urls { + color: black; +} + +.html .tag { + color: purple; +} + +.html .comment { + color : gray; + font-style: italic; +} + +.html .string { + color : navy; +} + +.html .doctype { + color : teal; +} \ No newline at end of file website/stylesheets/screen.css @@ -58,7 +58,15 @@ </p> </div> -<!-- insert site tracking codes here, like Google Urchin --> +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +var pageTracker = _gat._getTracker("UA-1286493-6"); +pageTracker._initData(); +pageTracker._trackPageview(); +</script> </body> </html> website/template.rhtml @@ -11,6 +11,8 @@ Capistrano recipes <% end %> </title> + <script type="text/javascript" src="../javascripts/code_highlighter.js"></script> + <script type="text/javascript" src="../javascripts/ruby.js"></script> </head> <body> <div id="main" class="recipes"> @@ -23,7 +25,16 @@ </p> </div> -<!-- insert site tracking codes here, like Google Urchin --> + +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +var pageTracker = _gat._getTracker("UA-1286493-6"); +pageTracker._initData(); +pageTracker._trackPageview(); +</script> </body> </html> website/template_recipe.rhtml b9a5f1012c42ed66d552cc63252d4a0ca03bc669 Gabe gabrielh@gmail.com http://github.com/gabriel/capitate/commit/32d3ca52dbcd9c9456b7408dafcc36cddb0d199e 32d3ca52dbcd9c9456b7408dafcc36cddb0d199e 2008-03-26T11:43:43-07:00 2008-03-26T11:43:43-07:00 cleaning up comments, including source in documentation (website) 0b0976735b92112cf4bdb54dcb165c07c51d27a1 Gabe gabrielh@gmail.com