mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
win_scheduled_task: Added frequency: once and check_mode support (#22611)
* win_scheduled_task: Added frequency: once and check_mode support This patch includes: - Renamed `execute:` parameter to `executable:` - Renamed `argument:` parameter to `arguments:` - Implemented `frequency: once` support - Implemented check_mode support - Fix idempotency issue related to empty description - Added integration tests * Improve the integration test structure I think this is a great way to test normal mode and check-mode from the same playbook. * Small fixes after review
This commit is contained in:
Dag Wieers
Matt Davis
parent
34498590e3
commit
72e7927dd5
5 changed files with 149 additions and 82 deletions
|
|
@ -22,47 +22,35 @@ $ErrorActionPreference = "Stop"
|
|||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
$params = Parse-Args $args;
|
||||
|
||||
$days_of_week = Get-AnsibleParam $params -name "days_of_week"
|
||||
$enabled = Get-AnsibleParam $params -name "enabled" -default $true
|
||||
$enabled = $enabled | ConvertTo-Bool
|
||||
$description = Get-AnsibleParam $params -name "description" -default " "
|
||||
$path = Get-AnsibleParam $params -name "path" -type "path"
|
||||
$argument = Get-AnsibleParam $params -name "argument"
|
||||
|
||||
$result = New-Object PSObject;
|
||||
Set-Attr $result "changed" $false;
|
||||
|
||||
#Required vars
|
||||
$name = Get-AnsibleParam -obj $params -name name -failifempty $true -resultobj $result
|
||||
$state = Get-AnsibleParam -obj $params -name state -failifempty $true -resultobj $result -validateSet "present","absent"
|
||||
|
||||
#Vars conditionally required
|
||||
$present_args_required = $state -eq "present"
|
||||
$execute = Get-AnsibleParam -obj $params -name execute -failifempty $present_args_required -resultobj $result
|
||||
$frequency = Get-AnsibleParam -obj $params -name frequency -failifempty $present_args_required -resultobj $result
|
||||
$time = Get-AnsibleParam -obj $params -name time -failifempty $present_args_required -resultobj $result
|
||||
$user = Get-AnsibleParam -obj $params -name user -failifempty $present_args_required -resultobj $result
|
||||
|
||||
|
||||
# Mandatory Vars
|
||||
if ($frequency -eq "weekly")
|
||||
{
|
||||
if (!($days_of_week))
|
||||
{
|
||||
Fail-Json $result "missing required argument: days_of_week"
|
||||
}
|
||||
$result = @{
|
||||
changed = $false
|
||||
}
|
||||
|
||||
if ($path)
|
||||
{
|
||||
$path = "\{0}\" -f $path
|
||||
}
|
||||
else
|
||||
{
|
||||
$path = "\" #default
|
||||
}
|
||||
$params = Parse-Args $args -supports_check_mode $true
|
||||
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false
|
||||
|
||||
$arguments = Get-AnsibleParam -obj $params -name "arguments" -type "str" -aliases "argument"
|
||||
$description = Get-AnsibleParam -obj $params -name "description" -type "str" -default "No description."
|
||||
$enabled = Get-AnsibleParam -obj $params -name "enabled" -type "bool" -default $true
|
||||
# TODO: We do not create the TaskPath if missing
|
||||
$path = Get-AnsibleParam -obj $params -name "path" -type "str" -default '\'
|
||||
|
||||
# Required vars
|
||||
$name = Get-AnsibleParam -obj $params -name "name" -type "str" -failifempty $true
|
||||
$state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "present","absent"
|
||||
|
||||
# Vars conditionally required
|
||||
$present = $state -eq "present"
|
||||
$executable = Get-AnsibleParam -obj $params -name "executable" -type "str" -aliases "execute" -failifempty $present
|
||||
$frequency = Get-AnsibleParam -obj $params -name "frequency" -type "str" -validateset "once","daily","weekly" -failifempty $present
|
||||
$time = Get-AnsibleParam -obj $params -name "time" -type "str" -failifempty $present
|
||||
|
||||
# TODO: We should default to the current user
|
||||
$user = Get-AnsibleParam -obj $params -name "user" -type "str" -failifempty $present
|
||||
|
||||
$weekly = $frequency -eq "weekly"
|
||||
$days_of_week = Get-AnsibleParam -obj $params -name "days_of_week" -type "str" -failifempty $weekly
|
||||
|
||||
|
||||
try {
|
||||
$task = Get-ScheduledTask -TaskPath "$path" | Where-Object {$_.TaskName -eq "$name"}
|
||||
|
|
@ -85,7 +73,9 @@ try {
|
|||
$exists = $true
|
||||
}
|
||||
elseif ( ($measure.count -eq 0) -and ($state -eq "absent") ){
|
||||
Set-Attr $result "msg" "Task does not exist"
|
||||
# Nothing to do
|
||||
$result.exists = $false
|
||||
$result.msg = "Task does not exist"
|
||||
Exit-Json $result
|
||||
}
|
||||
elseif ($measure.count -eq 0){
|
||||
|
|
@ -96,69 +86,76 @@ try {
|
|||
Fail-Json $result "$($measure.count) scheduled tasks found"
|
||||
}
|
||||
|
||||
Set-Attr $result "exists" "$exists"
|
||||
$result.exists = $exists
|
||||
|
||||
if ($frequency){
|
||||
if ($frequency -eq "daily") {
|
||||
$trigger = New-ScheduledTaskTrigger -Daily -At $time
|
||||
if ($frequency -eq "once") {
|
||||
$trigger = New-ScheduledTaskTrigger -Once -At $time
|
||||
}
|
||||
elseif ($frequency -eq "daily") {
|
||||
$trigger = New-ScheduledTaskTrigger -Daily -At $time
|
||||
}
|
||||
elseif ($frequency -eq "weekly"){
|
||||
$trigger = New-ScheduledTaskTrigger -Weekly -At $time -DaysOfWeek $days_of_week
|
||||
$trigger = New-ScheduledTaskTrigger -Weekly -At $time -DaysOfWeek $days_of_week
|
||||
}
|
||||
else {
|
||||
Fail-Json $result "frequency must be daily or weekly"
|
||||
}
|
||||
}
|
||||
|
||||
if ( ($state -eq "absent") -and ($exists -eq $true) ) {
|
||||
Unregister-ScheduledTask -TaskName $name -Confirm:$false
|
||||
if ( ($state -eq "absent") -and ($exists) ) {
|
||||
Unregister-ScheduledTask -TaskName $name -Confirm:$false -WhatIf:$check_mode
|
||||
$result.changed = $true
|
||||
Set-Attr $result "msg" "Deleted task $name"
|
||||
$result.msg = "Deleted task $name"
|
||||
Exit-Json $result
|
||||
}
|
||||
elseif ( ($state -eq "absent") -and ($exists -eq $false) ) {
|
||||
Set-Attr $result "msg" "Task $name does not exist"
|
||||
elseif ( ($state -eq "absent") -and (-not $exists) ) {
|
||||
$result.msg = "Task $name does not exist"
|
||||
Exit-Json $result
|
||||
}
|
||||
|
||||
$principal = New-ScheduledTaskPrincipal -UserId "$user" -LogonType ServiceAccount
|
||||
|
||||
if ($enabled -eq $false){
|
||||
$settings = New-ScheduledTaskSettingsSet -Disable
|
||||
}
|
||||
else {
|
||||
if ($enabled){
|
||||
$settings = New-ScheduledTaskSettingsSet
|
||||
}
|
||||
else {
|
||||
$settings = New-ScheduledTaskSettingsSet -Disable
|
||||
}
|
||||
|
||||
if ($argument) {
|
||||
$action = New-ScheduledTaskAction -Execute $execute -Argument $argument
|
||||
if ($arguments) {
|
||||
$action = New-ScheduledTaskAction -Execute $executable -Argument $arguments
|
||||
}
|
||||
else {
|
||||
$action = New-ScheduledTaskAction -Execute $execute
|
||||
$action = New-ScheduledTaskAction -Execute $executable
|
||||
}
|
||||
|
||||
if ( ($state -eq "present") -and ($exists -eq $false) ){
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName $name -Description $description -TaskPath $path -Settings $settings -Principal $principal
|
||||
$task = Get-ScheduledTask -TaskName $name
|
||||
Set-Attr $result "msg" "Added new task $name"
|
||||
if ( ($state -eq "present") -and (-not $exists) ){
|
||||
if (-not $check_mode) {
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName $name -Description $description -TaskPath $path -Settings $settings -Principal $principal
|
||||
# $task = Get-ScheduledTask -TaskName $name
|
||||
}
|
||||
$result.changed = $true
|
||||
$result.msg = "Added new task $name"
|
||||
}
|
||||
elseif( ($state -eq "present") -and ($exists -eq $true) ) {
|
||||
if ($task.Description -eq $description -and $task.TaskName -eq $name -and $task.TaskPath -eq $path -and $task.Actions.Execute -eq $execute -and $taskState -eq $enabled -and $task.Principal.UserId -eq $user) {
|
||||
#No change in the task
|
||||
Set-Attr $result "msg" "No change in task $name"
|
||||
elseif( ($state -eq "present") -and ($exists) ) {
|
||||
if ($task.Description -eq $description -and $task.TaskName -eq $name -and $task.TaskPath -eq $path -and $task.Actions.Execute -eq $executable -and $taskState -eq $enabled -and $task.Principal.UserId -eq $user) {
|
||||
# No change in the task
|
||||
$result.msg = "No change in task $name"
|
||||
}
|
||||
else {
|
||||
Unregister-ScheduledTask -TaskName $name -Confirm:$false
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName $name -Description $description -TaskPath $path -Settings $settings -Principal $principal
|
||||
Set-Attr $result "msg" "Updated task $name"
|
||||
Unregister-ScheduledTask -TaskName $name -Confirm:$false -WhatIf:$check_mode
|
||||
if (-not $check_mode) {
|
||||
Register-ScheduledTask -Action $action -Trigger $trigger -TaskName $name -Description $description -TaskPath $path -Settings $settings -Principal $principal
|
||||
}
|
||||
$result.changed = $true
|
||||
$result.msg = "Updated task $name"
|
||||
}
|
||||
}
|
||||
|
||||
Exit-Json $result;
|
||||
Exit-Json $result
|
||||
}
|
||||
catch
|
||||
{
|
||||
Fail-Json $result $_.Exception.Message
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue