1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
#
# Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
# Copyright:: Copyright 2008-2016, 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"
class Chef
class Resource
class WindowsTask < Chef::Resource
provides :windows_task, os: "windows"
allowed_actions :create, :delete, :run, :end, :enable, :disable
default_action :create
def initialize(name, run_context = nil)
super
@resource_name = :windows_task
@task_name = name
@action = :create
end
property :task_name, String, regex: [/\A[^\/\:\*\?\<\>\|]+\z/]
property :command, String
property :cwd, String
property :user, String, default: "SYSTEM"
property :password, String
property :run_level, equal_to: [:highest, :limited], default: :limited
property :force, [TrueClass, FalseClass], default: false
property :interactive_enabled, [TrueClass, FalseClass], default: false
property :frequency_modifier, [Integer, String], default: 1
property :frequency, equal_to: [:minute,
:hourly,
:daily,
:weekly,
:monthly,
:once,
:on_logon,
:onstart,
:on_idle,
:none], default: :hourly
property :start_day, String
property :start_time, String
property :day, [String, Integer]
property :months, String
property :idle_time, Integer
property :random_delay, String
property :execution_time_limit, String
attr_accessor :exists, :status, :enabled
def after_created
if random_delay
validate_random_delay(random_delay, frequency)
duration = sec_to_dur(random_delay)
random_delay(duration)
end
if execution_time_limit
raise ArgumentError, "Invalid value passed for `execution_time_limit`. Please pass seconds as a String e.g. '60'." if execution_time_limit.to_i == 0
duration = sec_to_dur(execution_time_limit)
execution_time_limit(duration)
else
# schtask sets execution_time_limit as PT72H by default
# We are setting the default value here so that we can do idempotency check later
# Note: We can't use `default` in the property
# because it will raise error for Invalid values passed as "PT72H" is not in seconds
execution_time_limit("PT72H")
end
validate_start_time(start_time, frequency)
validate_start_day(start_day, frequency) if start_day
validate_user_and_password(user, password)
validate_interactive_setting(interactive_enabled, password)
validate_create_frequency_modifier(frequency, frequency_modifier)
validate_create_day(day, frequency) if day
validate_create_months(months, frequency) if months
validate_idle_time(idle_time, frequency) if idle_time
end
private
def validate_random_delay(random_delay, frequency)
if [:once, :on_logon, :onstart, :on_idle, :none].include? frequency
raise ArgumentError, "`random_delay` property is supported only for frequency :minute, :hourly, :daily, :weekly and :monthly"
end
raise ArgumentError, "Invalid value passed for `random_delay`. Please pass seconds as a String e.g. '60'." if random_delay.to_i == 0
end
def validate_start_day(start_day, frequency)
if [:once, :on_logon, :onstart, :on_idle, :none].include? frequency
raise ArgumentError, "`start_day` property is not supported with frequency: #{frequency}"
end
end
def validate_start_time(start_time, frequency)
if frequency == :once
raise ArgumentError, "`start_time` needs to be provided with `frequency :once`" unless start_time
elsif frequency == :none
raise ArgumentError, "`start_time` property is not supported with `frequency :none`" if start_time
end
end
SYSTEM_USERS = ['NT AUTHORITY\SYSTEM', "SYSTEM", 'NT AUTHORITY\LOCALSERVICE', 'NT AUTHORITY\NETWORKSERVICE', 'BUILTIN\USERS', "USERS"].freeze
def validate_user_and_password(user, password)
if user && use_password?(user)
if password.nil?
raise ArgumentError, "Can't specify a non-system user without a password!"
end
end
end
def use_password?(user)
@use_password ||= !SYSTEM_USERS.include?(user.upcase)
end
def validate_interactive_setting(interactive_enabled, password)
if interactive_enabled && password.nil?
raise ArgumentError, "Please provide the password when attempting to set interactive/non-interactive."
end
end
def validate_create_frequency_modifier(frequency, frequency_modifier)
# Currently is handled in create action 'frequency_modifier_allowed' line. Does not allow for frequency_modifier for once,onstart,onlogon,onidle,none
# Note that 'OnEvent' is not a supported frequency.
unless frequency.nil? || frequency_modifier.nil?
case frequency
when :minute
unless frequency_modifier.to_i > 0 && frequency_modifier.to_i <= 1439
raise ArgumentError, "frequency_modifier value #{frequency_modifier} is invalid. Valid values for :minute frequency are 1 - 1439."
end
when :hourly
unless frequency_modifier.to_i > 0 && frequency_modifier.to_i <= 23
raise ArgumentError, "frequency_modifier value #{frequency_modifier} is invalid. Valid values for :hourly frequency are 1 - 23."
end
when :daily
unless frequency_modifier.to_i > 0 && frequency_modifier.to_i <= 365
raise ArgumentError, "frequency_modifier value #{frequency_modifier} is invalid. Valid values for :daily frequency are 1 - 365."
end
when :weekly
unless frequency_modifier.to_i > 0 && frequency_modifier.to_i <= 52
raise ArgumentError, "frequency_modifier value #{frequency_modifier} is invalid. Valid values for :weekly frequency are 1 - 52."
end
when :monthly
unless ("1".."12").to_a.push("FIRST", "SECOND", "THIRD", "FOURTH", "LAST", "LASTDAY").include?(frequency_modifier.to_s.upcase)
raise ArgumentError, "frequency_modifier value #{frequency_modifier} is invalid. Valid values for :monthly frequency are 1 - 12, 'FIRST', 'SECOND', 'THIRD', 'FOURTH', 'LAST', 'LASTDAY'."
end
end
end
end
def validate_create_day(day, frequency)
unless [:weekly, :monthly].include?(frequency)
raise "day attribute is only valid for tasks that run monthly or weekly"
end
if day.is_a?(String) && day.to_i.to_s != day
days = day.split(",")
days.each do |d|
unless ["mon", "tue", "wed", "thu", "fri", "sat", "sun", "*"].include?(d.strip.downcase)
raise "day attribute invalid. Only valid values are: MON, TUE, WED, THU, FRI, SAT, SUN and *. Multiple values must be separated by a comma."
end
end
end
end
def validate_create_months(months, frequency)
unless [:monthly].include?(frequency)
raise "months attribute is only valid for tasks that run monthly"
end
if months.is_a? String
months.split(",").each do |month|
unless ["JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC", "*"].include?(month.strip.upcase)
raise "months attribute invalid. Only valid values are: JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC and *. Multiple values must be separated by a comma."
end
end
end
end
def validate_idle_time(idle_time, frequency)
unless [:on_idle].include?(frequency)
raise "idle_time attribute is only valid for tasks that run on_idle"
end
unless idle_time.to_i > 0 && idle_time.to_i <= 999
raise "idle_time value #{idle_time} is invalid. Valid values for :on_idle frequency are 1 - 999."
end
end
# Convert the number of seconds to an ISO8601 duration format
# @see http://tools.ietf.org/html/rfc2445#section-4.3.6
# @param [Integer] seconds The amount of seconds for this duration
def sec_to_dur(seconds)
seconds = seconds.to_i
return if seconds == 0
iso_str = "P"
if seconds > 604_800 # more than a week
weeks = seconds / 604_800
seconds -= (604_800 * weeks)
iso_str << "#{weeks}W"
end
if seconds > 86_400 # more than a day
days = seconds / 86_400
seconds -= (86_400 * days)
iso_str << "#{days}D"
end
if seconds > 0
iso_str << "T"
if seconds > 3600 # more than an hour
hours = seconds / 3600
seconds -= (3600 * hours)
iso_str << "#{hours}H"
end
if seconds > 60 # more than a minute
minutes = seconds / 60
seconds -= (60 * minutes)
iso_str << "#{minutes}M"
end
iso_str << "#{seconds}S"
end
iso_str
end
end
end
end
|