puppet-parse 0.0.1 → 0.0.2

data/lib/vendor/puppet/face/help.rb

@@ -0,0 +1,131 @@
+require 'puppet/face'
+require 'puppet/util/command_line'
+require 'pathname'
+require 'erb'
+
+Puppet::Face.define(:help, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Display Puppet help."
+
+  action(:help) do
+    summary "Display help about Puppet subcommands and their actions."
+    arguments "[<subcommand>] [<action>]"
+    returns "Short help text for the specified subcommand or action."
+    examples <<-'EOT'
+      Get help for an action:
+
+      $ puppet help
+    EOT
+
+    option "--version VERSION" do
+      summary "The version of the subcommand for which to show help."
+    end
+
+    default
+    when_invoked do |*args|
+      # Check our invocation, because we want varargs and can't do defaults
+      # yet.  REVISIT: when we do option defaults, and positional options, we
+      # should rewrite this to use those. --daniel 2011-04-04
+      options = args.pop
+      if options.nil? or args.length > 2 then
+        if args.select { |x| x == 'help' }.length > 2 then
+          c = "\n %'(),-./=ADEFHILORSTUXY\\_`gnv|".split('')
+          i = <<-'EOT'.gsub(/\s*/, '').to_i(36)
+            3he6737w1aghshs6nwrivl8mz5mu9nywg9tbtlt081uv6fq5kvxse1td3tj1wvccmte806nb
+            cy6de2ogw0fqjymbfwi6a304vd56vlq71atwmqsvz3gpu0hj42200otlycweufh0hylu79t3
+            gmrijm6pgn26ic575qkexyuoncbujv0vcscgzh5us2swklsp5cqnuanlrbnget7rt3956kam
+            j8adhdrzqqt9bor0cv2fqgkloref0ygk3dekiwfj1zxrt13moyhn217yy6w4shwyywik7w0l
+            xtuevmh0m7xp6eoswin70khm5nrggkui6z8vdjnrgdqeojq40fya5qexk97g4d8qgw0hvokr
+            pli1biaz503grqf2ycy0ppkhz1hwhl6ifbpet7xd6jjepq4oe0ofl575lxdzjeg25217zyl4
+            nokn6tj5pq7gcdsjre75rqylydh7iia7s3yrko4f5ud9v8hdtqhu60stcitirvfj6zphppmx
+            7wfm7i9641d00bhs44n6vh6qvx39pg3urifgr6ihx3e0j1ychzypunyou7iplevitkyg6gbg
+            wm08oy1rvogcjakkqc1f7y1awdfvlb4ego8wrtgu9vzw4vmj59utwifn2ejcs569dh1oaavi
+            sc581n7jjg1dugzdu094fdobtx6rsvk3sfctvqnr36xctold
+          EOT
+          353.times{i,x=i.divmod(1184);a,b=x.divmod(37);print(c[a]*b)}
+        end
+        raise ArgumentError, "Puppet help only takes two (optional) arguments: a subcommand and an action"
+      end
+
+      version = :current
+      if options.has_key? :version then
+        if options[:version].to_s !~ /^current$/i then
+          version = options[:version]
+        else
+          if args.length == 0 then
+            raise ArgumentError, "Version only makes sense when a Faces subcommand is given"
+          end
+        end
+      end
+
+      # Name those parameters...
+      facename, actionname = args
+
+      if facename then
+        if legacy_applications.include? facename then
+          actionname and raise ArgumentError, "Legacy subcommands don't take actions"
+          return Puppet::Application[facename].help
+        else
+          face = Puppet::Face[facename.to_sym, version]
+          actionname and action = face.get_action(actionname.to_sym)
+        end
+      end
+
+      case args.length
+      when 0 then
+        template = erb 'global.erb'
+      when 1 then
+        face or fail ArgumentError, "Unable to load face #{facename}"
+        template = erb 'face.erb'
+      when 2 then
+        face or fail ArgumentError, "Unable to load face #{facename}"
+        action or fail ArgumentError, "Unable to load action #{actionname} from #{face}"
+        template = erb 'action.erb'
+      else
+        fail ArgumentError, "Too many arguments to help action"
+      end
+
+      # Run the ERB template in our current binding, including all the local
+      # variables we established just above. --daniel 2011-04-11
+      return template.result(binding)
+    end
+  end
+
+  def erb(name)
+    template = (Pathname(__FILE__).dirname + "help" + name)
+    erb = ERB.new(template.read, nil, '-')
+    erb.filename = template.to_s
+    return erb
+  end
+
+  def legacy_applications
+    # The list of applications, less those that are duplicated as a face.
+    Puppet::Util::CommandLine.available_subcommands.reject do |appname|
+      Puppet::Face.face? appname.to_sym, :current or
+        # ...this is a nasty way to exclude non-applications. :(
+        %w{face_base indirection_base}.include? appname
+    end.sort
+  end
+
+  def horribly_extract_summary_from(appname)
+    begin
+      require "puppet/application/#{appname}"
+      help = Puppet::Application[appname].help.split("\n")
+      # Now we find the line with our summary, extract it, and return it.  This
+      # depends on the implementation coincidence of how our pages are
+      # formatted.  If we can't match the pattern we expect we return the empty
+      # string to ensure we don't blow up in the summary. --daniel 2011-04-11
+      while line = help.shift do
+        if md = /^puppet-#{appname}\([^\)]+\) -- (.*)$/.match(line) then
+          return md[1]
+        end
+      end
+    rescue Exception
+      # Damn, but I hate this: we just ignore errors here, no matter what
+      # class they are.  Meh.
+    end
+    return ''
+  end
+end

data/lib/vendor/puppet/face/instrumentation_data.rb

@@ -0,0 +1,28 @@
+require 'puppet/indirector/face'
+
+Puppet::Indirector::Face.define(:instrumentation_data, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Manage instrumentation listener accumulated data."
+  description <<-EOT
+    This subcommand allows to retrieve the various listener data.
+  EOT
+
+  get_action(:destroy).summary "Invalid for this subcommand."
+  get_action(:save).summary "Invalid for this subcommand."
+  get_action(:search).summary "Invalid for this subcommand."
+
+  find = get_action(:find)
+  find.summary "Retrieve listener data."
+  find.render_as = :pson
+  find.returns <<-EOT
+    The data of an instrumentation listener
+  EOT
+  find.examples <<-EOT
+    Retrieve listener data:
+
+    $ puppet instrumentation_data find performance --terminus rest
+  EOT
+
+end

data/lib/vendor/puppet/face/instrumentation_listener.rb

@@ -0,0 +1,96 @@
+require 'puppet/indirector/face'
+
+Puppet::Indirector::Face.define(:instrumentation_listener, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Manage instrumentation listeners."
+  description <<-EOT
+    This subcommand enables/disables or list instrumentation listeners.
+  EOT
+
+  get_action(:destroy).summary "Invalid for this subcommand."
+
+  find = get_action(:find)
+  find.summary "Retrieve a single listener."
+  find.render_as = :pson
+  find.returns <<-EOT
+    The status of an instrumentation listener
+  EOT
+  find.examples <<-EOT
+    Retrieve a given listener:
+
+    $ puppet instrumentation_listener find performance --terminus rest
+  EOT
+
+  search = get_action(:search)
+  search.summary "Retrieve all instrumentation listeners statuses."
+  search.arguments "<dummy_text>"
+  search.render_as = :pson
+  search.returns <<-EOT
+    The statuses of all instrumentation listeners
+  EOT
+  search.short_description <<-EOT
+    This retrieves all instrumentation listeners
+  EOT
+  search.notes <<-EOT
+    Although this action always returns all instrumentation listeners, it requires a dummy search
+    key; this is a known bug.
+  EOT
+  search.examples <<-EOT
+    Retrieve the state of the listeners running in the remote puppet master:
+
+    $ puppet instrumentation_listener search x --terminus rest
+  EOT
+
+  def manage(name, activate)
+    Puppet::Util::Instrumentation::Listener.indirection.terminus_class = :rest
+    listener = Puppet::Face[:instrumentation_listener, '0.0.1'].find(name)
+    if listener
+      listener.enabled = activate
+      Puppet::Face[:instrumentation_listener, '0.0.1'].save(listener)
+    end
+  end
+
+  action :enable do
+    summary "Enable a given instrumentation listener."
+    arguments "<listener>"
+    returns "Nothing."
+    description <<-EOT
+      Enable a given instrumentation listener. After being enabled the listener
+      will start receiving instrumentation notifications from the probes if those
+      are enabled.
+    EOT
+    examples <<-EOT
+      Enable the "performance" listener in the running master:
+
+      $ puppet instrumentation_listener enable performance --terminus rest
+    EOT
+
+    when_invoked do |name, options|
+      manage(name, true)
+    end
+  end
+
+  action :disable do
+    summary "Disable a given instrumentation listener."
+    arguments "<listener>"
+    returns "Nothing."
+    description <<-EOT
+      Disable a given instrumentation listener. After being disabled the listener
+      will stop receiving instrumentation notifications from the probes.
+    EOT
+    examples <<-EOT
+      Disable the "performance" listener in the running master:
+
+      $ puppet instrumentation_listener disable performance --terminus rest
+    EOT
+
+    when_invoked do |name, options|
+      manage(name, false)
+    end
+  end
+
+  get_action(:save).summary "API only: modify an instrumentation listener status."
+  get_action(:save).arguments "<listener>"
+end

data/lib/vendor/puppet/face/instrumentation_probe.rb

@@ -0,0 +1,77 @@
+require 'puppet/indirector/face'
+
+Puppet::Indirector::Face.define(:instrumentation_probe, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Manage instrumentation probes."
+  description <<-EOT
+    This subcommand enables/disables or list instrumentation listeners.
+  EOT
+
+  get_action(:find).summary "Invalid for this subcommand."
+
+  search = get_action(:search)
+  search.summary "Retrieve all probe statuses."
+  search.arguments "<dummy_text>"
+  search.render_as = :pson
+  search.returns <<-EOT
+    The statuses of all instrumentation probes
+  EOT
+  search.short_description <<-EOT
+    This retrieves all instrumentation probes
+  EOT
+  search.notes <<-EOT
+    Although this action always returns all instrumentation probes, it requires a dummy search
+    key; this is a known bug.
+  EOT
+  search.examples <<-EOT
+    Retrieve the state of the probes running in the remote puppet master:
+
+    $ puppet instrumentation_probe search x --terminus rest
+  EOT
+
+  action :enable do
+    summary "Enable all instrumentation probes."
+    arguments "<dummy>"
+    returns "Nothing."
+    description <<-EOT
+      Enable all instrumentation probes. After being enabled, all enabled listeners
+      will start receiving instrumentation notifications from the probes.
+    EOT
+    examples <<-EOT
+      Enable the probes for the running master:
+
+      $ puppet instrumentation_probe enable x --terminus rest
+    EOT
+
+    when_invoked do |name, options|
+      Puppet::Face[:instrumentation_probe, '0.0.1'].save(nil)
+    end
+  end
+
+  action :disable do
+    summary "Disable all instrumentation probes."
+    arguments "<dummy>"
+    returns "Nothing."
+    description <<-EOT
+      Disable all instrumentation probes. After being disabled, no listeners
+      will receive instrumentation notifications.
+    EOT
+    examples <<-EOT
+      Disable the probes for the running master:
+
+      $ puppet instrumentation_probe disable x --terminus rest
+    EOT
+
+    when_invoked do |name, options|
+      Puppet::Face[:instrumentation_probe, '0.0.1'].destroy(nil)
+    end
+  end
+
+  get_action(:save).summary "API only: enable all instrumentation probes."
+  get_action(:save).arguments "<dummy>"
+
+  get_action(:destroy).summary "API only: disable all instrumentation probes."
+  get_action(:destroy).arguments "<dummy>"
+end

data/lib/vendor/puppet/face/key.rb

@@ -0,0 +1,15 @@
+require 'puppet/indirector/face'
+
+Puppet::Indirector::Face.define(:key, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Create, save, and remove certificate keys."
+  description <<-'EOT'
+    This subcommand manages certificate private keys. Keys are created
+    automatically by puppet agent and when certificate requests are generated
+    with 'puppet certificate generate'; it should not be necessary to use this
+    subcommand directly.
+  EOT
+
+end

data/lib/vendor/puppet/face/man.rb

@@ -0,0 +1,93 @@
+require 'puppet/face'
+require 'puppet/util'
+require 'pathname'
+require 'erb'
+
+Puppet::Face.define(:man, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Display Puppet manual pages."
+
+  description <<-EOT
+    This subcommand displays manual pages for all Puppet subcommands. If the
+    `ronn` gem (<https://github.com/rtomayko/ronn/>) is installed on your
+    system, puppet man will display fully-formated man pages. If `ronn` is not
+    available, puppet man will display the raw (but human-readable) source text
+    in a pager.
+  EOT
+
+  notes <<-EOT
+    The pager used for display will be the first found of `$MANPAGER`, `$PAGER`,
+    `less`, `most`, or `more`.
+  EOT
+
+  action(:man) do
+    summary "Display the manual page for a Puppet subcommand."
+    arguments "<subcommand>"
+    returns <<-'EOT'
+      The man data, in Markdown format, suitable for consumption by Ronn.
+
+      RENDERING ISSUES: To skip fancy formatting and output the raw Markdown
+      text (e.g. for use in a pipeline), call this action with '--render-as s'.
+    EOT
+    examples <<-'EOT'
+      View the manual page for a subcommand:
+
+      $ puppet man facts
+    EOT
+
+    default
+    when_invoked do |name, options|
+      if legacy_applications.include? name then
+        return Puppet::Application[name].help
+      end
+
+      face = Puppet::Face[name.to_sym, :current]
+
+      file = (Pathname(__FILE__).dirname + "help" + 'man.erb')
+      erb = ERB.new(file.read, nil, '-')
+      erb.filename = file.to_s
+
+      # Run the ERB template in our current binding, including all the local
+      # variables we established just above. --daniel 2011-04-11
+      return erb.result(binding)
+    end
+
+
+    when_rendering :console do |text|
+      # OK, if we have Ronn on the path we can delegate to it and override the
+      # normal output process.  Otherwise delegate to a pager on the raw text,
+      # otherwise we finally just delegate to our parent.  Oh, well.
+      ENV['LESS'] ||= 'FRSX'    # emulate git...
+
+      ronn  = Puppet::Util.which('ronn')
+      pager = [ENV['MANPAGER'], ENV['PAGER'], 'less', 'most', 'more'].
+        detect {|x| x and x.length > 0 and Puppet::Util.which(x) }
+
+      if ronn then
+        # ronn is a stupid about pager selection, we can be smarter. :)
+        if pager then ENV['PAGER'] = pager end
+
+        args  = "--man --manual='Puppet Manual' --organization='Puppet Labs, LLC'"
+        IO.popen("#{ronn} #{args}", 'w') do |fh| fh.write text end
+
+        ''                      # suppress local output, neh?
+      elsif pager then
+        IO.popen(pager, 'w') do |fh| fh.write text end
+        ''
+      else
+        text
+      end
+    end
+  end
+
+  def legacy_applications
+    # The list of applications, less those that are duplicated as a face.
+    Puppet::Util::CommandLine.available_subcommands.reject do |appname|
+      Puppet::Face.face? appname.to_sym, :current or
+        # ...this is a nasty way to exclude non-applications. :(
+        %w{face_base indirection_base}.include? appname
+    end
+  end
+end

data/lib/vendor/puppet/face/module/build.rb

@@ -0,0 +1,37 @@
+Puppet::Face.define(:module, '1.0.0') do
+  action(:build) do
+    summary "Build a module release package."
+    description <<-EOT
+      Prepares a local module for release on the Puppet Forge by building a
+      ready-to-upload archive file.
+
+      This action uses the Modulefile in the module directory to set metadata
+      used by the Forge. See <http://links.puppetlabs.com/modulefile> for more
+      about writing modulefiles.
+
+      After being built, the release archive file can be found in the module's
+      `pkg` directory.
+    EOT
+
+    returns "Pathname object representing the path to the release archive."
+
+    examples <<-EOT
+      Build a module release:
+
+      $ puppet module build puppetlabs-apache
+      notice: Building /Users/kelseyhightower/puppetlabs-apache for release
+      puppetlabs-apache/pkg/puppetlabs-apache-0.0.1.tar.gz
+    EOT
+
+    arguments "<path>"
+
+    when_invoked do |path, options|
+      Puppet::ModuleTool::Applications::Builder.run(path, options)
+    end
+
+    when_rendering :console do |return_value|
+      # Get the string representation of the Pathname object.
+      return_value.to_s
+    end
+  end
+end

data/lib/vendor/puppet/face/module/changes.rb

@@ -0,0 +1,38 @@
+Puppet::Face.define(:module, '1.0.0') do
+  action(:changes) do
+    summary "Show modified files of an installed module."
+    description <<-EOT
+      Shows any files in a module that have been modified since it was
+      installed. This action compares the files on disk to the md5 checksums
+      included in the module's metadata.
+    EOT
+
+    returns "Array of strings representing paths of modified files."
+
+    examples <<-EOT
+      Show modified files of an installed module:
+
+      $ puppet module changes /etc/puppet/modules/vcsrepo/
+      warning: 1 files modified
+      lib/puppet/provider/vcsrepo.rb
+    EOT
+
+    arguments "<path>"
+
+    when_invoked do |path, options|
+      root_path = Puppet::ModuleTool.find_module_root(path)
+      Puppet::ModuleTool::Applications::Checksummer.run(root_path, options)
+    end
+
+    when_rendering :console do |return_value|
+      if return_value.empty?
+        Puppet.notice "No modified files"
+      else
+        Puppet.warning "#{return_value.size} files modified"
+      end
+      return_value.map do |changed_file|
+        "#{changed_file}"
+      end.join("\n")
+    end
+  end
+end

data/lib/vendor/puppet/face/module/generate.rb

@@ -0,0 +1,42 @@
+Puppet::Face.define(:module, '1.0.0') do
+  action(:generate) do
+    summary "Generate boilerplate for a new module."
+    description <<-EOT
+      Generates boilerplate for a new module by creating the directory
+      structure and files recommended for the Puppet community's best practices.
+
+      A module may need additional directories beyond this boilerplate
+      if it provides plugins, files, or templates.
+    EOT
+
+    returns "Array of Pathname objects representing paths of generated files."
+
+    examples <<-EOT
+      Generate a new module in the current directory:
+
+      $ puppet module generate puppetlabs-ssh
+      notice: Generating module at /Users/kelseyhightower/puppetlabs-ssh
+      puppetlabs-ssh
+      puppetlabs-ssh/tests
+      puppetlabs-ssh/tests/init.pp
+      puppetlabs-ssh/spec
+      puppetlabs-ssh/spec/spec_helper.rb
+      puppetlabs-ssh/spec/spec.opts
+      puppetlabs-ssh/README
+      puppetlabs-ssh/Modulefile
+      puppetlabs-ssh/metadata.json
+      puppetlabs-ssh/manifests
+      puppetlabs-ssh/manifests/init.pp
+    EOT
+
+    arguments "<name>"
+
+    when_invoked do |name, options|
+      Puppet::ModuleTool::Applications::Generator.run(name, options)
+    end
+
+    when_rendering :console do |return_value|
+      return_value.map {|f| f.to_s }.join("\n")
+    end
+  end
+end