chef 14.3.37-universal-mingw32 → 14.4.56-universal-mingw32

data/lib/chef/resource/cron.rb

@@ -1,155 +1,155 @@
-#
-# Author:: Bryan McLellan (btm@loftninjas.org)
-# Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2009-2016, Bryan McLellan
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require "chef/resource"
-require "chef/provider/cron" # do not remove. we actually need this below
-
-class Chef
-  class Resource
-    class Cron < Chef::Resource
-      resource_name :cron
-      provides :cron
-
-      description "Use the cron resource to manage cron entries for time-based job scheduling. Properties for a schedule will default to * if not provided. The cron resource requires access to a crontab program, typically cron."
-
-      state_attrs :minute, :hour, :day, :month, :weekday, :user
-
-      default_action :create
-      allowed_actions :create, :delete
-
-      def initialize(name, run_context = nil)
-        super
-        @minute = "*"
-        @hour = "*"
-        @day = "*"
-        @month = "*"
-        @weekday = "*"
-      end
-
-      def minute(arg = nil)
-        if arg.is_a?(Integer)
-          converted_arg = arg.to_s
-        else
-          converted_arg = arg
-        end
-        begin
-          if integerize(arg) > 59 then raise RangeError end
-        rescue ArgumentError
-        end
-        set_or_return(
-          :minute,
-          converted_arg,
-          kind_of: String
-        )
-      end
-
-      def hour(arg = nil)
-        if arg.is_a?(Integer)
-          converted_arg = arg.to_s
-        else
-          converted_arg = arg
-        end
-        begin
-          if integerize(arg) > 23 then raise RangeError end
-        rescue ArgumentError
-        end
-        set_or_return(
-          :hour,
-          converted_arg,
-          kind_of: String
-        )
-      end
-
-      def day(arg = nil)
-        if arg.is_a?(Integer)
-          converted_arg = arg.to_s
-        else
-          converted_arg = arg
-        end
-        begin
-          if integerize(arg) > 31 then raise RangeError end
-        rescue ArgumentError
-        end
-        set_or_return(
-          :day,
-          converted_arg,
-          kind_of: String
-        )
-      end
-
-      def month(arg = nil)
-        if arg.is_a?(Integer)
-          converted_arg = arg.to_s
-        else
-          converted_arg = arg
-        end
-        begin
-          if integerize(arg) > 12 then raise RangeError end
-        rescue ArgumentError
-        end
-        set_or_return(
-          :month,
-          converted_arg,
-          kind_of: String
-        )
-      end
-
-      def weekday(arg = nil)
-        if arg.is_a?(Integer)
-          converted_arg = arg.to_s
-        else
-          converted_arg = arg
-        end
-        begin
-          error_message = "You provided '#{arg}' as a weekday, acceptable values are "
-          error_message << Provider::Cron::WEEKDAY_SYMBOLS.map { |sym| ":#{sym}" }.join(", ")
-          error_message << " and a string in crontab format"
-          if (arg.is_a?(Symbol) && !Provider::Cron::WEEKDAY_SYMBOLS.include?(arg)) ||
-              (!arg.is_a?(Symbol) && integerize(arg) > 7) ||
-              (!arg.is_a?(Symbol) && integerize(arg) < 0)
-            raise RangeError, error_message
-          end
-        rescue ArgumentError
-        end
-        set_or_return(
-          :weekday,
-          converted_arg,
-          kind_of: [String, Symbol]
-        )
-      end
-
-      property :time, Symbol, equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
-      property :mailto, String
-      property :path, String
-      property :home, String
-      property :shell, String
-      property :command, String, identity: true
-      property :user, String, default: "root"
-      property :environment, Hash, default: lazy { Hash.new }
-
-      private
-
-      def integerize(integerish)
-        Integer(integerish)
-      rescue TypeError
-        0
-      end
-    end
-  end
-end
+#
+# Author:: Bryan McLellan (btm@loftninjas.org)
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# Copyright:: Copyright 2009-2016, Bryan McLellan
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef/resource"
+require "chef/provider/cron" # do not remove. we actually need this below
+
+class Chef
+  class Resource
+    class Cron < Chef::Resource
+      resource_name :cron
+      provides :cron
+
+      description "Use the cron resource to manage cron entries for time-based job scheduling. Properties for a schedule will default to * if not provided. The cron resource requires access to a crontab program, typically cron."
+
+      state_attrs :minute, :hour, :day, :month, :weekday, :user
+
+      default_action :create
+      allowed_actions :create, :delete
+
+      def initialize(name, run_context = nil)
+        super
+        @minute = "*"
+        @hour = "*"
+        @day = "*"
+        @month = "*"
+        @weekday = "*"
+      end
+
+      def minute(arg = nil)
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        begin
+          if integerize(arg) > 59 then raise RangeError end
+        rescue ArgumentError
+        end
+        set_or_return(
+          :minute,
+          converted_arg,
+          kind_of: String
+        )
+      end
+
+      def hour(arg = nil)
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        begin
+          if integerize(arg) > 23 then raise RangeError end
+        rescue ArgumentError
+        end
+        set_or_return(
+          :hour,
+          converted_arg,
+          kind_of: String
+        )
+      end
+
+      def day(arg = nil)
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        begin
+          if integerize(arg) > 31 then raise RangeError end
+        rescue ArgumentError
+        end
+        set_or_return(
+          :day,
+          converted_arg,
+          kind_of: String
+        )
+      end
+
+      def month(arg = nil)
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        begin
+          if integerize(arg) > 12 then raise RangeError end
+        rescue ArgumentError
+        end
+        set_or_return(
+          :month,
+          converted_arg,
+          kind_of: String
+        )
+      end
+
+      def weekday(arg = nil)
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        begin
+          error_message = "You provided '#{arg}' as a weekday, acceptable values are "
+          error_message << Provider::Cron::WEEKDAY_SYMBOLS.map { |sym| ":#{sym}" }.join(", ")
+          error_message << " and a string in crontab format"
+          if (arg.is_a?(Symbol) && !Provider::Cron::WEEKDAY_SYMBOLS.include?(arg)) ||
+              (!arg.is_a?(Symbol) && integerize(arg) > 7) ||
+              (!arg.is_a?(Symbol) && integerize(arg) < 0)
+            raise RangeError, error_message
+          end
+        rescue ArgumentError
+        end
+        set_or_return(
+          :weekday,
+          converted_arg,
+          kind_of: [String, Symbol]
+        )
+      end
+
+      property :time, Symbol, equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
+      property :mailto, String
+      property :path, String
+      property :home, String
+      property :shell, String
+      property :command, String, identity: true
+      property :user, String, default: "root"
+      property :environment, Hash, default: lazy { Hash.new }
+
+      private
+
+      def integerize(integerish)
+        Integer(integerish)
+      rescue TypeError
+        0
+      end
+    end
+  end
+end

data/lib/chef/resource/cron_access.rb

@@ -0,0 +1,70 @@
+#
+# Author:: Sander Botman <sbotman@schubergphilis.com>
+# Author:: Tim Smith <tsmith@chef.io>
+#
+# Copyright:: 2014-2018, Sander Botman
+# Copyright:: 2018, Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef/resource"
+
+class Chef
+  class Resource
+    class CronAccess < Chef::Resource
+      preview_resource true
+      resource_name :cron_access
+      provides(:cron_manage) # legacy name @todo in Chef 15 we should { true } this so it wins over the cookbook
+
+      introduced "14.4"
+      description "Use the cron_access resource to manage the /etc/cron.allow and /etc/cron.deny files."
+
+      property :user, String,
+               description: "The user to allow or deny. If not provided we'll use the resource name.",
+               name_property: true
+
+      action :allow do
+        description "Add the user to the cron.allow file."
+
+        with_run_context :root do
+          edit_resource(:template, "/etc/cron.allow") do |new_resource|
+            source ::File.expand_path("../support/cron_access.erb", __FILE__)
+            local true
+            mode "0600"
+            variables["users"] ||= []
+            variables["users"] << new_resource.user
+            action :nothing
+            delayed_action :create
+          end
+        end
+      end
+
+      action :deny do
+        description "Add the user to the cron.deny file."
+
+        with_run_context :root do
+          edit_resource(:template, "/etc/cron.deny") do |new_resource|
+            source ::File.expand_path("../support/cron_access.erb", __FILE__)
+            local true
+            mode "0600"
+            variables["users"] ||= []
+            variables["users"] << new_resource.user
+            action :nothing
+            delayed_action :create
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/cron_d.rb

@@ -0,0 +1,238 @@
+#
+# Copyright:: 2008-2018, Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef/resource"
+require "shellwords"
+
+class Chef
+  class Resource
+    class CronD < Chef::Resource
+      preview_resource true
+      resource_name :cron_d
+
+      introduced "14.4"
+      description "Use the cron_d resource to manage cron definitions in /etc/cron.d. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
+
+      # validate a provided value is between two other provided values
+      # we also allow * as a valid input
+      # @param spec the value to validate
+      # @param min the lowest value allowed
+      # @param max the highest value allowed
+      # @return [Boolean] valid or not?
+      def self.validate_numeric(spec, min, max)
+        return true if spec == "*"
+        #  binding.pry
+        if spec.respond_to? :to_int
+          return false unless spec >= min && spec <= max
+          return true
+        end
+
+        # Lists of invidual values, ranges, and step values all share the validity range for type
+        spec.split(%r{\/|-|,}).each do |x|
+          next if x == "*"
+          return false unless x =~ /^\d+$/
+          x = x.to_i
+          return false unless x >= min && x <= max
+        end
+        true
+      end
+
+      # validate the provided month value to be jan - dec, 1 - 12, or *
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def self.validate_month(spec)
+        return true if spec == "*"
+        if spec.respond_to? :to_int
+          validate_numeric(spec, 1, 12)
+        elsif spec.respond_to? :to_str
+          return true if spec == "*"
+          # Named abbreviations are permitted but not as part of a range or with stepping
+          return true if %w{jan feb mar apr may jun jul aug sep oct nov dec}.include? spec.downcase
+          # 1-12 are legal for months
+          validate_numeric(spec, 1, 12)
+        else
+          false
+        end
+      end
+
+      # validate the provided day of the week is sun-sat, 0-7, or *
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def self.validate_dow(spec)
+        return true if spec == "*"
+        if spec.respond_to? :to_int
+          validate_numeric(spec, 0, 7)
+        elsif spec.respond_to? :to_str
+          return true if spec == "*"
+          # Named abbreviations are permitted but not as part of a range or with stepping
+          return true if %w{sun mon tue wed thu fri sat}.include? spec.downcase
+          # 0-7 are legal for days of week
+          validate_numeric(spec, 0, 7)
+        else
+          false
+        end
+      end
+
+      property :cron_name, String,
+               description: "Set the name of the cron job. If this isn't specified we'll use the resource name.",
+               name_property: true
+
+      property :cookbook, String
+
+      property :predefined_value, String,
+               description: 'Schedule your cron job with one of the special predefined value instead of ** * pattern. This correspond to "@reboot", "@yearly", "@annually", "@monthly", "@weekly", "@daily", "@midnight" or "@hourly".',
+               equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
+
+      property :minute, [Integer, String],
+               description: "The minute to schedule the cron job to run at. Valid values: 0-59.",
+               default: "*", callbacks: {
+                 "should be a valid minute spec" => ->(spec) { validate_numeric(spec, 0, 59) },
+               }
+
+      property :hour, [Integer, String],
+               description: "The hour to schedule the cron job to run at. Valid values: 0-23.",
+               default: "*", callbacks: {
+                 "should be a valid hour spec" => ->(spec) { validate_numeric(spec, 0, 23) },
+               }
+
+      property :day, [Integer, String],
+               description: "The day to schedule the cron job to run at. Valid values: 1-31.",
+               default: "*", callbacks: {
+                 "should be a valid day spec" => ->(spec) { validate_numeric(spec, 1, 31) },
+               }
+
+      property :month, [Integer, String],
+               description: "The month to schedule the cron job to run at. Valid values: 1-12, jan-dec, or *.",
+               default: "*", callbacks: {
+                 "should be a valid month spec" => ->(spec) { validate_month(spec) },
+               }
+
+      property :weekday, [Integer, String],
+               description: "The day to schedule the cron job to run at. Valid values: 0-7, mon-sun, or *.",
+               default: "*", callbacks: {
+                 "should be a valid weekday spec" => ->(spec) { validate_dow(spec) },
+               }
+
+      property :command, String,
+               description: "The command to run.",
+               required: true
+
+      property :user, String,
+               description: "The user to run the cron job as.",
+               default: "root"
+
+      property :mailto, String,
+               description: "Set the MAILTO environment variable in the cron.d file."
+
+      property :path, String,
+               description: "Set the PATH environment variable in the cron.d file."
+
+      property :home, String,
+               description: "Set the HOME environment variable in the cron.d file."
+
+      property :shell, String,
+               description: "Set the SHELL environment variable in the cron.d file."
+
+      property :comment, String,
+               description: "A comment to place in the cron.d file."
+
+      property :environment, Hash,
+               description: "A Hash containing additional arbitrary environment variables under which the cron job will be run.",
+               default: lazy { Hash.new }
+
+      property :mode, [String, Integer],
+               description: "The octal mode of the generated crontab file.",
+               default: "0600"
+
+      property :random_delay, Integer,
+               description: "Set the RANDOM_DELAY environment variable in the cron.d file."
+
+      # warn if someone passes the deprecated cookbook property
+      def after_created
+        raise ArgumentError, "The 'cookbook' property for the cron_d resource is no longer supported now that this resource ships in Chef itself." if cookbook
+      end
+
+      action :create do
+        description "Add a cron definition file to /etc/cron.d."
+
+        create_template(:create)
+      end
+
+      action :create_if_missing do
+        description "Add a cron definition file to /etc/cron.d, but do not update an existing file."
+
+        create_template(:create_if_missing)
+      end
+
+      action :delete do
+        description "Remove a cron definition file from /etc/cron.d if it exists."
+
+        # cleanup the legacy named job if it exists
+        file "legacy named cron.d file" do
+          path "/etc/cron.d/#{new_resource.cron_name}"
+          action :delete
+        end
+
+        file "/etc/cron.d/#{sanitized_name}" do
+          action :delete
+        end
+      end
+
+      action_class do
+        # @return [String] cron_name property with . replaced with -
+        def sanitized_name
+          new_resource.cron_name.tr(".", "-")
+        end
+
+        def create_template(create_action)
+          # cleanup the legacy named job if it exists
+          file "#{new_resource.cron_name} legacy named cron.d file" do
+            path "/etc/cron.d/#{new_resource.cron_name}"
+            action :delete
+            only_if { new_resource.cron_name != sanitized_name }
+          end
+
+          # @todo this is Chef 12 era cleanup. Someday we should remove it all
+          template "/etc/cron.d/#{sanitized_name}" do
+            source ::File.expand_path("../support/cron.d.erb", __FILE__)
+            local true
+            mode new_resource.mode
+            variables(
+              name: sanitized_name,
+              predefined_value: new_resource.predefined_value,
+              minute: new_resource.minute,
+              hour: new_resource.hour,
+              day: new_resource.day,
+              month: new_resource.month,
+              weekday: new_resource.weekday,
+              command: new_resource.command,
+              user: new_resource.user,
+              mailto: new_resource.mailto,
+              path: new_resource.path,
+              home: new_resource.home,
+              shell: new_resource.shell,
+              comment: new_resource.comment,
+              random_delay: new_resource.random_delay,
+              environment: new_resource.environment
+            )
+            action create_action
+          end
+        end
+      end
+    end
+  end
+end