puppet 3.5.0.rc1-x86-mingw32

data/lib/puppet/face/config.rb

@@ -0,0 +1,106 @@
+require 'puppet/face'
+require 'puppet/settings/ini_file'
+
+Puppet::Face.define(:config, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Interact with Puppet's settings."
+
+  description "This subcommand can inspect and modify settings from Puppet's
+    'puppet.conf' configuration file. For documentation about individual settings,
+    see http://docs.puppetlabs.com/references/latest/configuration.html."
+
+  option "--section SECTION_NAME" do
+    default_to { "main" }
+    summary "The section of the configuration file to interact with."
+    description <<-EOT
+      The section of the puppet.conf configuration file to interact with.
+
+      The three most commonly used sections are 'main', 'master', and 'agent'.
+      'Main' is the default, and is used by all Puppet applications. Other
+      sections can override 'main' values for specific applications --- the
+      'master' section affects puppet master and puppet cert, and the 'agent'
+      section affects puppet agent.
+
+      Less commonly used is the 'user' section, which affects puppet apply. Any
+      other section will be treated as the name of a legacy environment
+      (a deprecated feature), and can only include the 'manifest' and
+      'modulepath' settings.
+    EOT
+  end
+
+  action(:print) do
+    summary "Examine Puppet's current settings."
+    arguments "(all | <setting> [<setting> ...]"
+    description <<-'EOT'
+      Prints the value of a single setting or a list of settings.
+
+      This action is an alternate interface to the information available with
+      `puppet <subcommand> --configprint`.
+    EOT
+    notes <<-'EOT'
+      By default, this action reads the general configuration in the 'main'
+      section. Use the '--section' and '--environment' flags to examine other
+      configuration domains.
+    EOT
+    examples <<-'EOT'
+      Get puppet's runfile directory:
+
+      $ puppet config print rundir
+
+      Get a list of important directories from the master's config:
+
+      $ puppet config print all --section master | grep -E "(path|dir)"
+    EOT
+
+    when_invoked do |*args|
+      options = args.pop
+
+      args = Puppet.settings.to_a.collect(&:first) if args.empty? || args == ['all']
+
+      values = Puppet.settings.values(Puppet[:environment].to_sym, options[:section].to_sym)
+      if args.length == 1
+        puts values.interpolate(args[0].to_sym)
+      else
+        args.each do |setting_name|
+          puts "#{setting_name} = #{values.interpolate(setting_name.to_sym)}"
+        end
+      end
+      nil
+    end
+  end
+
+  action(:set) do
+    summary "Set Puppet's settings."
+    arguments "[setting_name] [setting_value]"
+    description <<-'EOT'
+      Updates values in the `puppet.conf` configuration file.
+    EOT
+    notes <<-'EOT'
+      By default, this action manipulates the configuration in the
+      'main' section. Use the '--section' flag to manipulate other
+      configuration domains.
+    EOT
+    examples <<-'EOT'
+      Set puppet's runfile directory:
+
+      $ puppet config set rundir /var/run/puppet
+
+      Set the vardir for only the agent:
+
+      $ puppet config set vardir /var/lib/puppetagent --section agent
+    EOT
+
+    when_invoked do |name, value, options|
+      path = Puppet::FileSystem.pathname(Puppet.settings.which_configuration_file)
+      Puppet::FileSystem.touch(path)
+      Puppet::FileSystem.open(path, nil, 'r+') do |file|
+        Puppet::Settings::IniFile.update(file) do |config|
+          config.set(options[:section], name, value)
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/puppet/face/facts.rb

@@ -0,0 +1,81 @@
+require 'puppet/indirector/face'
+require 'puppet/node/facts'
+
+Puppet::Indirector::Face.define(:facts, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Retrieve and store facts."
+  description <<-'EOT'
+    This subcommand manages facts, which are collections of normalized system
+    information used by Puppet. It can read facts directly from the local system
+    (with the default `facter` terminus), look up facts reported by other
+    systems, and submit facts to the puppet master.
+
+    When used with the `rest` terminus, this subcommand is essentially a front-end
+    to the inventory service REST API. See the inventory service documentation at
+    <http://docs.puppetlabs.com/guides/inventory_service.html> for more detail.
+  EOT
+
+  find = get_action(:find)
+  find.summary "Retrieve a node's facts."
+  find.arguments "<node_certname>"
+  find.returns <<-'EOT'
+    A hash containing some metadata and (under the "values" key) the set
+    of facts for the requested node. When used from the Ruby API: A
+    Puppet::Node::Facts object.
+
+    RENDERING ISSUES: Facts cannot currently be rendered as a string; use yaml
+    or json.
+  EOT
+  find.notes <<-'EOT'
+    When using the `facter` terminus, the host argument is ignored.
+  EOT
+  find.examples <<-'EOT'
+    Get facts from the local system:
+
+    $ puppet facts find x
+
+    Ask the puppet master for facts for an arbitrary node:
+
+    $ puppet facts find somenode.puppetlabs.lan --terminus rest
+
+    Query a DB-backed inventory directly (bypassing the REST API):
+
+    $ puppet facts find somenode.puppetlabs.lan --terminus inventory_active_record --run_mode master
+  EOT
+
+  get_action(:destroy).summary "Invalid for this subcommand."
+  get_action(:search).summary "Invalid for this subcommand."
+
+  action(:upload) do
+    summary "Upload local facts to the puppet master."
+    description <<-'EOT'
+      Reads facts from the local system using the `facter` terminus, then
+      saves the returned facts using the rest terminus.
+    EOT
+    returns "Nothing."
+    notes <<-'EOT'
+      This action requires that the puppet master's `auth.conf` file
+      allow save access to the `facts` REST terminus. Puppet agent does
+      not use this facility, and it is turned off by default. See
+      <http://docs.puppetlabs.com/guides/rest_auth_conf.html> for more details.
+    EOT
+    examples <<-'EOT'
+      Upload facts:
+
+      $ puppet facts upload
+    EOT
+
+    render_as :yaml
+
+    when_invoked do |options|
+      Puppet::Node::Facts.indirection.terminus_class = :facter
+      facts = Puppet::Node::Facts.indirection.find(Puppet[:certname])
+      Puppet::Node::Facts.indirection.terminus_class = :rest
+      Puppet::Node::Facts.indirection.save(facts)
+      Puppet.notice "Uploaded facts for '#{Puppet[:certname]}'"
+      nil
+    end
+  end
+end

data/lib/puppet/face/file.rb

@@ -0,0 +1,47 @@
+require 'puppet/indirector/face'
+
+Puppet::Indirector::Face.define(:file, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license; see COPYING"
+
+  summary "Retrieve and store files in a filebucket"
+  description <<-'EOT'
+    This subcommand interacts with objects stored in a local or remote
+    filebucket. File objects are accessed by their MD5 sum; see the
+    examples for the relevant syntax.
+  EOT
+  notes <<-'EOT'
+    To retrieve the unmunged contents of a file, you must call find with
+    --render-as s. Rendering as yaml will return a hash of metadata
+    about the file, including its contents.
+
+    This subcommand does not interact with the `clientbucketdir` (the default
+    local filebucket for puppet agent); it interacts with the primary
+    "master"-type filebucket located in the `bucketdir`. If you wish to
+    interact with puppet agent's default filebucket, you'll need to set
+    the <--bucketdir> option appropriately when invoking actions.
+  EOT
+
+  file = get_action(:find)
+  file.summary "Retrieve a file from the filebucket."
+  file.arguments "md5/<md5sum>"
+  file.returns <<-'EOT'
+    The file object with the specified checksum.
+
+    RENDERING ISSUES: Rendering as a string returns the contents of the
+    file object; rendering as yaml returns a hash of metadata about said
+    file, including but not limited to its contents. Rendering as json
+    is currently broken, and returns a hash containing only the contents
+    of the file.
+  EOT
+  file.examples <<-'EOT'
+    Retrieve the contents of a file:
+
+    $ puppet file find md5/9aedba7f413c97dc65895b1cd9421f2c --render-as s
+  EOT
+
+  get_action(:search).summary "Invalid for this subcommand."
+  get_action(:destroy).summary "Invalid for this subcommand."
+
+  set_indirection_name :file_bucket_file
+end

data/lib/puppet/face/file/download.rb

@@ -0,0 +1,54 @@
+# Download a specified file into the local filebucket.
+Puppet::Face.define(:file, '0.0.1') do
+  action :download do |*args|
+    summary "Download a file into the local filebucket."
+    arguments "( {md5}<checksum> | <puppet_url> )"
+    returns "Nothing."
+    description <<-EOT
+      Downloads a file from the puppet master's filebucket and duplicates it in
+      the local filebucket. This action's checksum syntax differs from `find`'s,
+      and it can accept a <puppet:///> URL.
+    EOT
+    examples <<-'EOT'
+      Download a file by URL:
+
+      $ puppet file download puppet:///modules/editors/vim/.vimrc
+
+      Download a file by MD5 sum:
+
+      $ puppet file download {md5}8f798d4e754db0ac89186bbaeaf0af18
+    EOT
+
+    when_invoked do |sum, options|
+      if sum =~ /^puppet:\/\// # it's a puppet url
+        require 'puppet/file_serving'
+        require 'puppet/file_serving/content'
+        raise "Could not find metadata for #{sum}" unless content = Puppet::FileServing::Content.indirection.find(sum)
+        file = Puppet::FileBucket::File.new(content.content)
+      else
+        tester = Object.new
+        tester.extend(Puppet::Util::Checksums)
+
+        type    = tester.sumtype(sum)
+        sumdata = tester.sumdata(sum)
+
+        key = "#{type}/#{sumdata}"
+
+        Puppet::FileBucket::File.indirection.terminus_class = :file
+        if Puppet::FileBucket::File.indirection.head(key)
+          Puppet.info "Content for '#{sum}' already exists"
+          return
+        end
+
+        Puppet::FileBucket::File.indirection.terminus_class = :rest
+        raise "Could not download content for '#{sum}'" unless file = Puppet::FileBucket::File.indirection.find(key)
+      end
+
+
+      Puppet::FileBucket::File.indirection.terminus_class = :file
+      Puppet.notice "Saved #{sum} to filebucket"
+      Puppet::FileBucket::File.indirection.save file
+      return nil
+    end
+  end
+end

data/lib/puppet/face/file/store.rb

@@ -0,0 +1,21 @@
+# Store a specified file in our filebucket.
+Puppet::Face.define(:file, '0.0.1') do
+  action :store do |*args|
+    summary "Store a file in the local filebucket."
+    arguments "<file>"
+    returns "Nothing."
+    examples <<-EOT
+      Store a file:
+
+      $ puppet file store /root/.bashrc
+    EOT
+
+    when_invoked do |path, options|
+      file = Puppet::FileBucket::File.new(Puppet::FileSystem.binread(path))
+
+      Puppet::FileBucket::File.indirection.terminus_class = :file
+      Puppet::FileBucket::File.indirection.save file
+      file.checksum
+    end
+  end
+end

data/lib/puppet/face/help.rb

@@ -0,0 +1,194 @@
+require 'puppet/face'
+require 'puppet/application/face_base'
+require 'puppet/util/constant_inflector'
+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
+
+      return erb('global.erb').result(binding) if args.empty?
+
+      facename, actionname = args
+      if legacy_applications.include? facename then
+        if actionname then
+          raise ArgumentError, "Legacy subcommands don't take actions"
+        end
+        return render_application_help(facename)
+      else
+        return render_face_help(facename, actionname, version)
+      end
+    end
+  end
+
+  def render_application_help(applicationname)
+    return Puppet::Application[applicationname].help
+  end
+
+  def render_face_help(facename, actionname, version)
+    face, action = load_face_help(facename, actionname, version)
+    return template_for(face, action).result(binding)
+  end
+
+  def load_face_help(facename, actionname, version)
+    begin
+      face = Puppet::Face[facename.to_sym, version]
+    rescue Puppet::Error => detail
+      msg = <<-MSG
+Could not load help for the face #{facename}.
+Please check the error logs for more information.
+
+Detail: "#{detail.message}"
+      MSG
+      fail ArgumentError, msg, detail.backtrace
+    end
+    if actionname
+      action = face.get_action(actionname.to_sym)
+      if not action
+        fail ArgumentError, "Unable to load action #{actionname} from #{face}"
+      end
+    end
+
+    [face, action]
+  end
+
+  def template_for(face, action)
+    if action.nil?
+      erb('face.erb')
+    else
+      erb('action.erb')
+    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
+
+  # Return a list of applications that are not simply just stubs for Faces.
+  def legacy_applications
+    Puppet::Application.available_application_names.reject do |appname|
+      (is_face_app?(appname)) or (exclude_from_docs?(appname))
+    end.sort
+  end
+
+  # Return a list of all applications (both legacy and Face applications), along with a summary
+  #  of their functionality.
+  # @return [Array] An Array of Arrays.  The outer array contains one entry per application; each
+  #  element in the outer array is a pair whose first element is a String containing the application
+  #  name, and whose second element is a String containing the summary for that application.
+  def all_application_summaries()
+    Puppet::Application.available_application_names.sort.inject([]) do |result, appname|
+      next result if exclude_from_docs?(appname)
+
+      if (is_face_app?(appname))
+        begin
+          face = Puppet::Face[appname, :current]
+          result << [appname, face.summary]
+        rescue Puppet::Error
+          result << [ "! #{appname}", "! Subcommand unavailable due to error. Check error logs." ]
+        end
+      else
+        result << [appname, horribly_extract_summary_from(appname)]
+      end
+    end
+  end
+
+  def horribly_extract_summary_from(appname)
+    begin
+      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
+  # This should absolutely be a private method, but for some reason it appears
+  #  that you can't use the 'private' keyword inside of a Face definition.
+  #  See #14205.
+  #private :horribly_extract_summary_from
+
+  def exclude_from_docs?(appname)
+    %w{face_base indirection_base}.include? appname
+  end
+  # This should absolutely be a private method, but for some reason it appears
+  #  that you can't use the 'private' keyword inside of a Face definition.
+  #  See #14205.
+  #private :exclude_from_docs?
+
+  def is_face_app?(appname)
+    clazz = Puppet::Application.find(appname)
+
+    clazz.ancestors.include?(Puppet::Application::FaceBase)
+  end
+  # This should probably be a private method, but for some reason it appears
+  #  that you can't use the 'private' keyword inside of a Face definition.
+  #  See #14205.
+  #private :is_face_app?
+
+end