puppet 5.0.0 → 6.0.0

data/lib/puppet/type/cron.rb

@@ -1,475 +0,0 @@
-require 'etc'
-require 'facter'
-require 'puppet/util/filetype'
-
-Puppet::Type.newtype(:cron) do
-  @doc = <<-'EOT'
-    Installs and manages cron jobs.  Every cron resource created by Puppet
-    requires a command and at least one periodic attribute (hour, minute,
-    month, monthday, weekday, or special).  While the name of the cron job is
-    not part of the actual job, the name is stored in a comment beginning with
-    `# Puppet Name: `. These comments are used to match crontab entries created
-    by Puppet with cron resources.
-
-    If an existing crontab entry happens to match the scheduling and command of a
-    cron resource that has never been synched, Puppet will defer to the existing
-    crontab entry and will not create a new entry tagged with the `# Puppet Name: `
-    comment.
-
-    Example:
-
-        cron { 'logrotate':
-          command => '/usr/sbin/logrotate',
-          user    => 'root',
-          hour    => 2,
-          minute  => 0,
-        }
-
-    Note that all periodic attributes can be specified as an array of values:
-
-        cron { 'logrotate':
-          command => '/usr/sbin/logrotate',
-          user    => 'root',
-          hour    => [2, 4],
-        }
-
-    ...or using ranges or the step syntax `*/2` (although there's no guarantee
-    that your `cron` daemon supports these):
-
-        cron { 'logrotate':
-          command => '/usr/sbin/logrotate',
-          user    => 'root',
-          hour    => ['2-4'],
-          minute  => '*/10',
-        }
-
-    An important note: _the Cron type will not reset parameters that are
-    removed from a manifest_. For example, removing a `minute => 10` parameter
-    will not reset the minute component of the associated cronjob to `*`.
-    These changes must be expressed by setting the parameter to
-    `minute => absent` because Puppet only manages parameters that are out of
-    sync with manifest entries.
-
-    **Autorequires:** If Puppet is managing the user account specified by the
-    `user` property of a cron resource, then the cron resource will autorequire
-    that user.
-  EOT
-  ensurable
-
-  # A base class for all of the Cron parameters, since they all have
-  # similar argument checking going on.
-  class CronParam < Puppet::Property
-    class << self
-      attr_accessor :boundaries, :default
-    end
-
-    # We have to override the parent method, because we consume the entire
-    # "should" array
-    def insync?(is)
-      self.is_to_s(is) == self.should_to_s
-    end
-
-    # A method used to do parameter input handling.  Converts integers
-    # in string form to actual integers, and returns the value if it's
-    # an integer or false if it's just a normal string.
-    def numfix(num)
-      if num =~ /^\d+$/
-        return num.to_i
-      elsif num.is_a?(Integer)
-        return num
-      else
-        return false
-      end
-    end
-
-    # Verify that a number is within the specified limits.  Return the
-    # number if it is, or false if it is not.
-    def limitcheck(num, lower, upper)
-      (num >= lower and num <= upper) && num
-    end
-
-    # Verify that a value falls within the specified array.  Does case
-    # insensitive matching, and supports matching either the entire word
-    # or the first three letters of the word.
-    def alphacheck(value, ary)
-      tmp = value.downcase
-
-      # If they specified a shortened version of the name, then see
-      # if we can lengthen it (e.g., mon => monday).
-      if tmp.length == 3
-        ary.each_with_index { |name, index|
-          if tmp.upcase == name[0..2].upcase
-            return index
-          end
-        }
-      else
-        return ary.index(tmp) if ary.include?(tmp)
-      end
-
-      false
-    end
-
-    def should_to_s(value = @should)
-      if value
-        if value.is_a?(Array) && (name == :command || value[0].is_a?(Symbol))
-          value = value[0]
-        end
-        super(value)
-      else
-        nil
-      end
-    end
-
-    def is_to_s(value = @is)
-      if value
-        if value.is_a?(Array) && (name == :command || value[0].is_a?(Symbol))
-          value = value[0]
-        end
-        super(value)
-      else
-        nil
-      end
-    end
-
-    def should
-      if @should and @should[0] == :absent
-        :absent
-      else
-        @should
-      end
-    end
-
-    def should=(ary)
-      super
-      @should.flatten!
-    end
-
-    # The method that does all of the actual parameter value
-    # checking; called by all of the +param<name>=+ methods.
-    # Requires the value, type, and bounds, and optionally supports
-    # a boolean of whether to do alpha checking, and if so requires
-    # the ary against which to do the checking.
-    munge do |value|
-      # Support 'absent' as a value, so that they can remove
-      # a value
-      if value == "absent" or value == :absent
-        return :absent
-      end
-
-      # Allow the */2 syntax
-      if value =~ /^\*\/[0-9]+$/
-        return value
-      end
-
-      # Allow ranges
-      if value =~ /^[0-9]+-[0-9]+$/
-        return value
-      end
-
-      # Allow ranges + */2
-      if value =~ /^[0-9]+-[0-9]+\/[0-9]+$/
-        return value
-      end
-
-      if value == "*"
-        return :absent
-      end
-
-      return value unless self.class.boundaries
-      lower, upper = self.class.boundaries
-      retval = nil
-      if num = numfix(value)
-        retval = limitcheck(num, lower, upper)
-      elsif respond_to?(:alpha)
-        # If it has an alpha method defined, then we check
-        # to see if our value is in that list and if so we turn
-        # it into a number
-        retval = alphacheck(value, alpha)
-      end
-
-      if retval
-        return retval.to_s
-      else
-        self.fail _("%{value} is not a valid %{name}") % { value: value, name: self.class.name }
-      end
-    end
-  end
-
-  # Somewhat uniquely, this property does not actually change anything -- it
-  # just calls +@resource.sync+, which writes out the whole cron tab for
-  # the user in question.  There is no real way to change individual cron
-  # jobs without rewriting the entire cron file.
-  #
-  # Note that this means that managing many cron jobs for a given user
-  # could currently result in multiple write sessions for that user.
-  newproperty(:command, :parent => CronParam) do
-    desc "The command to execute in the cron job.  The environment
-      provided to the command varies by local system rules, and it is
-      best to always provide a fully qualified command.  The user's
-      profile is not sourced when the command is run, so if the
-      user's environment is desired it should be sourced manually.
-
-      All cron parameters support `absent` as a value; this will
-      remove any existing values for that field."
-
-    def retrieve
-      return_value = super
-      return_value = return_value[0] if return_value && return_value.is_a?(Array)
-
-      return_value
-    end
-
-    def should
-      if @should
-        if @should.is_a? Array
-          @should[0]
-        else
-          devfail "command is not an array"
-        end
-      else
-        nil
-      end
-    end
-
-    def munge(value)
-      value.strip
-    end
-  end
-
-  newproperty(:special) do
-    desc "A special value such as 'reboot' or 'annually'.
-       Only available on supported systems such as Vixie Cron.
-       Overrides more specific time of day/week settings.
-       Set to 'absent' to make puppet revert to a plain numeric schedule."
-
-    def specials
-      %w{reboot yearly annually monthly weekly daily midnight hourly absent} +
-        [ :absent ]
-    end
-
-    validate do |value|
-      raise ArgumentError, _("Invalid special schedule %{value}") % { value: value.inspect } unless specials.include?(value)
-    end
-
-    def munge(value)
-      # Support value absent so that a schedule can be
-      # forced to change to numeric.
-      if value == "absent" or value == :absent
-        return :absent
-      end
-      value
-    end
-  end
-
-  newproperty(:minute, :parent => CronParam) do
-    self.boundaries = [0, 59]
-    desc "The minute at which to run the cron job.
-      Optional; if specified, must be between 0 and 59, inclusive."
-  end
-
-  newproperty(:hour, :parent => CronParam) do
-    self.boundaries = [0, 23]
-    desc "The hour at which to run the cron job. Optional;
-      if specified, must be between 0 and 23, inclusive."
-  end
-
-  newproperty(:weekday, :parent => CronParam) do
-    def alpha
-      %w{sunday monday tuesday wednesday thursday friday saturday}
-    end
-    self.boundaries = [0, 7]
-    desc "The weekday on which to run the command.
-      Optional; if specified, must be between 0 and 7, inclusive, with
-      0 (or 7) being Sunday, or must be the name of the day (e.g., Tuesday)."
-  end
-
-  newproperty(:month, :parent => CronParam) do
-    def alpha
-      # The ___placeholder accounts for the fact that month is unique among
-      # "nameable" crontab entries in that it does not use 0-based indexing.
-      # Padding the array with a placeholder introduces the appropriate shift
-      # in indices.
-      %w{___placeholder january february march april may june july
-        august september october november december}
-    end
-    self.boundaries = [1, 12]
-    desc "The month of the year.  Optional; if specified
-      must be between 1 and 12 or the month name (e.g., December)."
-  end
-
-  newproperty(:monthday, :parent => CronParam) do
-    self.boundaries = [1, 31]
-    desc "The day of the month on which to run the
-      command.  Optional; if specified, must be between 1 and 31."
-  end
-
-  newproperty(:environment) do
-    desc "Any environment settings associated with this cron job.  They
-      will be stored between the header and the job in the crontab.  There
-      can be no guarantees that other, earlier settings will not also
-      affect a given cron job.
-
-
-      Also, Puppet cannot automatically determine whether an existing,
-      unmanaged environment setting is associated with a given cron
-      job.  If you already have cron jobs with environment settings,
-      then Puppet will keep those settings in the same place in the file,
-      but will not associate them with a specific job.
-
-      Settings should be specified exactly as they should appear in
-      the crontab, e.g., `PATH=/bin:/usr/bin:/usr/sbin`."
-
-    validate do |value|
-      unless value =~ /^\s*(\w+)\s*=\s*(.*)\s*$/ or value == :absent or value == "absent"
-        raise ArgumentError, _("Invalid environment setting %{value}") % { value: value.inspect }
-      end
-    end
-
-    def insync?(is)
-      if is.is_a? Array
-        return is.sort == @should.sort
-      else
-        return is == @should
-      end
-    end
-
-    def should
-      @should
-    end
-
-    def should_to_s(newvalue = @should)
-      if newvalue
-        newvalue.join(",")
-      else
-        nil
-      end
-    end
-  end
-
-  newparam(:name) do
-    desc "The symbolic name of the cron job.  This name
-      is used for human reference only and is generated automatically
-      for cron jobs found on the system.  This generally won't
-      matter, as Puppet will do its best to match existing cron jobs
-      against specified jobs (and Puppet adds a comment to cron jobs it adds),
-      but it is at least possible that converting from unmanaged jobs to
-      managed jobs might require manual intervention."
-
-    isnamevar
-  end
-
-  newproperty(:user) do
-    desc "The user who owns the cron job.  This user must
-      be allowed to run cron jobs, which is not currently checked by
-      Puppet.
-
-      This property defaults to the user running Puppet or `root`.
-
-      The default crontab provider executes the system `crontab` using
-      the user account specified by this property."
-
-    defaultto {
-      if not provider.is_a?(@resource.class.provider(:crontab))
-        struct = Etc.getpwuid(Process.uid)
-        struct.respond_to?(:name) && struct.name or 'root'
-      end
-    }
-  end
-
-  # Autorequire the owner of the crontab entry.
-  autorequire(:user) do
-    self[:user]
-  end
-
-  newproperty(:target) do
-    desc "The name of the crontab file in which the cron job should be stored.
-
-      This property defaults to the value of the `user` property if set, the
-      user running Puppet or `root`.
-
-      For the default crontab provider, this property is functionally
-      equivalent to the `user` property and should be avoided. In particular,
-      setting both `user` and `target` to different values will result in
-      undefined behavior."
-
-    defaultto {
-      if provider.is_a?(@resource.class.provider(:crontab))
-        if val = @resource.should(:user)
-          val
-        else
-          struct = Etc.getpwuid(Process.uid)
-          struct.respond_to?(:name) && struct.name or 'root'
-        end
-      elsif provider.class.ancestors.include?(Puppet::Provider::ParsedFile)
-        provider.class.default_target
-      else
-        nil
-      end
-    }
-  end
-
-  validate do
-    return true unless self[:special]
-    return true if self[:special] == :absent
-    # there is a special schedule in @should, so we don't want to see
-    # any numeric should values
-    [ :minute, :hour, :weekday, :monthday, :month ].each do |field|
-      next unless self[field]
-      next if self[field] == :absent
-      raise ArgumentError, _("%{cron} cannot specify both a special schedule and a value for %{field}") % { cron: self.ref, field: field }
-    end
-  end
-
-  # We have to reorder things so that :provide is before :target
-
-  attr_accessor :uid
-
-  # Marks the resource as "being purged".
-  #
-  # @api public
-  #
-  # @note This overrides the Puppet::Type method in order to handle
-  #   an edge case that has so far been observed during testing only.
-  #   Without forcing the should-value for the user property to be
-  #   identical to the original cron file, purging from a fixture
-  #   will not work, because the user property defaults to the user
-  #   running the test. It is not clear whether this scenario can apply
-  #   during normal operation.
-  #
-  # @note Also, when not forcing the should-value for the target
-  #   property, unpurged file content (such as comments) can end up
-  #   being written to the default target (i.e. the current login name).
-  def purging
-    self[:target] = provider.target
-    self[:user] = provider.target
-    super
-  end
-
-  def value(name)
-    name = name.intern
-    ret = nil
-    if obj = @parameters[name]
-      ret = obj.should
-
-      ret ||= obj.retrieve
-
-      if ret == :absent
-        ret = nil
-      end
-    end
-
-    unless ret
-      case name
-      when :command
-      when :special
-        # nothing
-      else
-        #ret = (self.class.validproperty?(name).default || "*").to_s
-        ret = "*"
-      end
-    end
-
-    ret
-  end
-end
-

data/lib/puppet/type/host.rb

@@ -1,95 +0,0 @@
-require 'puppet/property/ordered_list'
-
-module Puppet
-  Type.newtype(:host) do
-    ensurable
-
-    newproperty(:ip) do
-      desc "The host's IP address, IPv4 or IPv6."
-
-
-      def valid_v4?(addr)
-        if /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ =~ addr
-          return $~.captures.all? {|i| i = i.to_i; i >= 0 and i <= 255 }
-        end
-        return false
-      end
-
-      def valid_v6?(addr)
-        # http://forums.dartware.com/viewtopic.php?t=452
-        # ...and, yes, it is this hard. Doing it programmatically is harder.
-        return true if addr =~ /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/
-
-        return false
-      end
-      def valid_newline?(addr)
-        return false if (addr =~ /\n/ || addr =~ /\r/)
-        return true
-      end
-
-      validate do |value|
-        return true if ((valid_v4?(value) || valid_v6?(value)) && (valid_newline?(value)))
-        raise Puppet::Error, _("Invalid IP address %{value}") % { value: value.inspect }
-      end
-    end
-
-    # for now we use OrderedList to indicate that the order does matter.
-    newproperty(:host_aliases, :parent => Puppet::Property::OrderedList) do
-      desc "Any aliases the host might have.  Multiple values must be
-        specified as an array."
-
-      def delimiter
-        " "
-      end
-
-      def inclusive?
-        true
-      end
-
-      validate do |value|
-        # This regex already includes newline check.
-        raise Puppet::Error, _("Host aliases cannot include whitespace") if value =~ /\s/
-        raise Puppet::Error, _("Host aliases cannot be an empty string. Use an empty array to delete all host_aliases ") if value =~ /^\s*$/
-      end
-
-    end
-
-    newproperty(:comment) do
-      desc "A comment that will be attached to the line with a # character."
-      validate do |value|
-        raise Puppet::Error, _("Comment cannot include newline") if (value =~ /\n/ || value =~ /\r/)
-      end
-    end
-
-    newproperty(:target) do
-      desc "The file in which to store service information.  Only used by
-        those providers that write to disk. On most systems this defaults to `/etc/hosts`."
-
-      defaultto { if @resource.class.defaultprovider.ancestors.include?(Puppet::Provider::ParsedFile)
-        @resource.class.defaultprovider.default_target
-        else
-          nil
-        end
-      }
-    end
-
-    newparam(:name) do
-      desc "The host name."
-
-      isnamevar
-
-      validate do |value|
-        value.split('.').each do |hostpart|
-          unless hostpart =~ /^([\d\w]+|[\d\w][\d\w\-]+[\d\w])$/
-            raise Puppet::Error, _("Invalid host name")
-          end
-        end
-        raise Puppet::Error, _("Hostname cannot include newline") if (value =~ /\n/ || value =~ /\r/)
-      end
-    end
-
-    @doc = "Installs and manages host entries.  For most systems, these
-      entries will just be in `/etc/hosts`, but some systems (notably OS X)
-      will have different solutions."
-  end
-end

data/lib/puppet/type/interface.rb

@@ -1,121 +0,0 @@
-#
-# Manages an interface on a given router or switch
-#
-
-require 'puppet/util/network_device/ipcalc'
-
-Puppet::Type.newtype(:interface) do
-
-    @doc = "This represents a router or switch interface. It is possible to manage
-    interface mode (access or trunking, native vlan and encapsulation) and
-    switchport characteristics (speed, duplex)."
-
-    apply_to_device
-
-    ensurable do
-      defaultvalues
-
-      aliasvalue :shutdown, :absent
-      aliasvalue :no_shutdown, :present
-
-      defaultto { :no_shutdown }
-    end
-
-    newparam(:name) do
-      desc "The interface's name."
-    end
-
-    newparam(:device_url) do
-      desc "The URL at which the router or switch can be reached."
-    end
-
-    newproperty(:description) do
-      desc "Interface description."
-
-      defaultto { @resource[:name] }
-    end
-
-    newproperty(:speed) do
-      desc "Interface speed."
-      newvalues(:auto, /^\d+/)
-    end
-
-    newproperty(:duplex) do
-      desc "Interface duplex."
-      newvalues(:auto, :full, :half)
-    end
-
-    newproperty(:access_vlan) do
-      desc "Interface static access vlan."
-      newvalues(/^\d+/)
-    end
-
-    newproperty(:native_vlan) do
-      desc "Interface native vlan when trunking."
-      newvalues(/^\d+/)
-    end
-
-    newproperty(:encapsulation) do
-      desc "Interface switchport encapsulation."
-      newvalues(:none, :dot1q, :isl, :negotiate)
-    end
-
-    newproperty(:mode) do
-      desc "Interface switchport mode."
-      newvalues(:access, :trunk, 'dynamic auto', 'dynamic desirable')
-    end
-
-    newproperty(:allowed_trunk_vlans) do
-      desc "Allowed list of Vlans that this trunk can forward."
-      newvalues(:all, /./)
-    end
-
-    newproperty(:etherchannel) do
-      desc "Channel group this interface is part of."
-      newvalues(/^\d+/)
-    end
-
-    newproperty(:ipaddress, :array_matching => :all) do
-      include Puppet::Util::NetworkDevice::IPCalc
-
-      desc "IP Address of this interface. Note that it might not be possible to set
-      an interface IP address; it depends on the interface type and device type.
-
-      Valid format of ip addresses are:
-
-      * IPV4, like 127.0.0.1
-      * IPV4/prefixlength like 127.0.1.1/24
-      * IPV6/prefixlength like FE80::21A:2FFF:FE30:ECF0/128
-      * an optional suffix for IPV6 addresses from this list: `eui-64`, `link-local`
-
-      It is also possible to supply an array of values.
-      "
-
-      validate do |values|
-        values = [values] unless values.is_a?(Array)
-        values.each do |value|
-          self.fail _("Invalid interface ip address") unless parse(value.gsub(/\s*(eui-64|link-local)\s*$/,''))
-        end
-      end
-
-      munge do |value|
-        option = value =~ /eui-64|link-local/i ? value.gsub(/^.*?\s*(eui-64|link-local)\s*$/,'\1') : nil
-        [parse(value.gsub(/\s*(eui-64|link-local)\s*$/,'')), option].flatten
-      end
-
-      def value_to_s(value)
-        value = [value] unless value.is_a?(Array)
-        value.map{ |v| "#{v[1].to_s}/#{v[0]} #{v[2]}"}.join(",")
-      end
-
-      def change_to_s(currentvalue, newvalue)
-        currentvalue = value_to_s(currentvalue) if currentvalue != :absent
-        newvalue = value_to_s(newvalue)
-        super(currentvalue, newvalue)
-      end
-    end
-
-  def present?(current_values)
-    super && current_values[:ensure] != :shutdown
-  end
-end