ApiActions: Remove child downtimes recursively

[yhabteab]

Services downtimes scheduled via the all_services flag get already removed automatically when removing their parent downtimes (introduced with #8913). Now, this commit makes it possible to perform the same actions for all child downtimes, i.e. not only for those of service objects, but for all child objects represented in the dependency tree.

Config

template Host "default" default {
	check_command = "dummy"
	check_interval = 120s
	vars.dummy_text = "I'm just testing something"
	vars.dummy_state = 2
}

object Host "father" {}
object Host "mother" {}
object Host "grandfather" {}
object Host "sister" {}
object Host "brother" {}

apply Dependency "father" to Host {
	parent_host_name = "father"
	redundancy_group = "Parents"
	assign where host.name == "sister" || host.name == "brother"
}

apply Dependency "mother" to Host {
 	parent_host_name = "mother"
 	redundancy_group = "Parents"
 	assign where host.name == "sister" || host.name == "brother"
}

apply Dependency "grandfather" to Host {
 	parent_host_name = "grandfather"
 	redundancy_group = "Grand Parents"
 	assign where host.name == "mother" || host.name == "father"
}

$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/downtimes' | jq '.results | length'
0
$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/hosts' | jq '.results | length'
5
$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/dependencies' | jq '.results | length'
6

Tests

Before:

$ curl -k -s -S -i -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5667/v1/actions/schedule-downtime' \
 -d @<(cat <<EOF
{ "type": "Host", "filter": "host.name == \"grandfather\"", "start_time": $(date +%s), "end_time": $(date -v+30M +%s), "child_options": "DowntimeTriggeredChildren", "author": "icingaadmin", "comment": "IPv4 network maintenance", "pretty": true }
EOF
)
HTTP/1.1 200 OK
...
$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/downtimes' | jq '.results | length'
5
$ curl -k -s -S -i -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5667/v1/actions/remove-downtime' \
 -d '{ "filter": "host.name == \"grandfather\"", "pretty": true, "type": "Host" }'
{
    "results": [
        {
            "code": 200,
            "status": "Successfully removed all downtimes for object 'grandfather' and 0 child downtimes."
        }
    ]
}
$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/downtimes' | jq '.results | length'
4

After:

$ curl -k -s -S -i -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5667/v1/actions/schedule-downtime' \
 -d @<(cat <<EOF
{ "type": "Host", "filter": "host.name == \"grandfather\"", "start_time": $(date +%s), "end_time": $(date -v+30M +%s), "child_options": "DowntimeTriggeredChildren", "author": "icingaadmin", "comment": "IPv4 network maintenance", "pretty": true }
EOF
)

$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/downtimes' | jq '.results | length'
5
$ curl -k -s -S -i -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5667/v1/actions/remove-downtime' \
 -d '{ "filter": "host.name == \"grandfather\"", "pretty": true, "type": "Host" }'
{
    "results": [
        {
            "code": 200,
            "status": "Successfully removed all downtimes for object 'grandfather' and 4 child downtimes."
        }
    ]
}
$ curl -ksSu root:icinga 'https://localhost:5667/v1/objects/downtimes' | jq '.results | length'
0

fixes #10333

[julianbrost]

Now, this commit makes it possible to perform the same actions for all child downtimes

Not only performing the same action but also using the very same code, hence the diff is so small. So this just makes use of the existing parent-tracking mechanism for downtimes. It's probably noteworthy (for the changelog for example) that this will only work for new downtimes.

ScheduledDowntime has an child_options attribute as well that's handled somewhere else:

icinga2/lib/icinga/scheduleddowntime.cpp

Lines 304 to 305 in b4baf1c

	Downtime::Ptr childDowntime = Downtime::AddDowntime(child, GetAuthor(), GetComment(),
	segment.first, segment.second, GetFixed(), trigger, GetDuration(), GetName(), GetName());

Did you intentionally leave that as-is? Maybe due to the following?

icinga2/lib/icinga/downtime.cpp

Lines 372 to 375 in b4baf1c

	if (!config_owner.IsEmpty() && removalReason == DowntimeRemovedByUser) {
	BOOST_THROW_EXCEPTION(invalid_downtime_removal_error("Cannot remove downtime '" + downtime->GetName() +
	"'. It is owned by scheduled downtime object '" + config_owner + "'"));
	}