POST /v1/objects: allow array of attrs to undo modifications of

[Al2Klimov]

in addition to the mapping of ones to modify.

Restoration is also a kind of modification I guess.

See changed docs.

fixes #8709
closes #7986

TODO

• concept ok? @julianbrost
• test @Al2Klimov

[julianbrost]

• concept ok? @julianbrost

Looks fine, so you can go ahead with that:

• test @Al2Klimov

[Al2Klimov]

Invalid usages

➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1}'
HTTP/1.1 400 Bad Request
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 166

{
    "error": 400,
    "status": "Missing both 'attrs' and 'restore_attrs'. Or is this a POST query and you missed adding a 'X-HTTP-Method-Override: GET' header?"
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":[]}'
HTTP/1.1 400 Bad Request
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 198

{
    "error": 400,
    "status": "Invalid type for 'attrs' attribute specified. Dictionary type is required.Or is this a POST query and you missed adding a 'X-HTTP-Method-Override: GET' header?"
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"restore_attrs":{}}'
HTTP/1.1 400 Bad Request
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 116

{
    "error": 400,
    "status": "Invalid type for 'restore_attrs' attribute specified. Array type is required."
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"vars.lolcat":42}'
HTTP/1.1 400 Bad Request
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 166

{
    "error": 400,
    "status": "Missing both 'attrs' and 'restore_attrs'. Or is this a POST query and you missed adding a 'X-HTTP-Method-Override: GET' header?"
}
➜  icinga2 git:(restore_attrs)

Valid usages

➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":{}}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 197

{
    "results": [
        {
            "code": 200,
            "name": "alexandersmbp2.int.netways.de",
            "status": "Attributes updated.",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":{"vars.lolcat":42}}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 197

{
    "results": [
        {
            "code": 200,
            "name": "alexandersmbp2.int.netways.de",
            "status": "Attributes updated.",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":{"vars.lolcat":777},"restore_attrs":["vars.lolcat"]}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 197

{
    "results": [
        {
            "code": 200,
            "name": "alexandersmbp2.int.netways.de",
            "status": "Attributes updated.",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X GET -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":["vars"]}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 932

{
    "results": [
        {
            "attrs": {
                "vars": {
                    "disks": {
                        "disk": {},
                        "disk /": {
                            "disk_partitions": "/"
                        }
                    },
                    "http_vhosts": {
                        "http": {
                            "http_uri": "/"
                        }
                    },
                    "lolcat": 777,
                    "notification": {
                        "mail": {
                            "groups": [
                                "icingaadmins"
                            ]
                        }
                    },
                    "os": "Linux"
                }
            },
            "joins": {},
            "meta": {},
            "name": "alexandersmbp2.int.netways.de",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X POST -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"restore_attrs":["vars.lolcat"]}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 197

{
    "results": [
        {
            "code": 200,
            "name": "alexandersmbp2.int.netways.de",
            "status": "Attributes updated.",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs) curl -sSiku root:123456 -X GET -H 'Accept: application/json' 'https://127.0.0.1:5665/v1/objects/hosts' -d '{"pretty":1,"attrs":["vars","original_attributes"]}'
HTTP/1.1 200 OK
Server: Icinga/v2.13.0-720-g57f7f76dd
Content-Type: application/json
Content-Length: 976

{
    "results": [
        {
            "attrs": {
                "original_attributes": {},
                "vars": {
                    "disks": {
                        "disk": {},
                        "disk /": {
                            "disk_partitions": "/"
                        }
                    },
                    "http_vhosts": {
                        "http": {
                            "http_uri": "/"
                        }
                    },
                    "lolcat": null,
                    "notification": {
                        "mail": {
                            "groups": [
                                "icingaadmins"
                            ]
                        }
                    },
                    "os": "Linux"
                }
            },
            "joins": {},
            "meta": {},
            "name": "alexandersmbp2.int.netways.de",
            "type": "Host"
        }
    ]
}
➜  icinga2 git:(restore_attrs)

Admittedly the latter doesn’t work exactly as intended, leaving vars.lolcat=null, but only till the next reload.

[julianbrost]

Temporarily, I was worried whether this would actually work properly in clusters, but seems like this was actually also implemented for v2.4 (that's when ConfigObject::RestoreAttribute() was added):

icinga2/lib/remote/apilistener-configsync.cpp

Lines 179 to 199 in a3dabde

	/* check whether original attributes changed and restore them locally */
	Array::Ptr newOriginalAttributes = params->Get("original_attributes");
	Dictionary::Ptr objOriginalAttributes = object->GetOriginalAttributes();
	if (newOriginalAttributes && objOriginalAttributes) {
	std::vector<String> restoreAttrs;
	{
	ObjectLock xlock(objOriginalAttributes);
	for (const Dictionary::Pair& kv : objOriginalAttributes) {
	/* original attribute was removed, restore it */
	if (!newOriginalAttributes->Contains(kv.first))
	restoreAttrs.push_back(kv.first);
	}
	}
	for (const String& key : restoreAttrs) {
	/* do not update the object version yet. */
	object->RestoreAttribute(key, false);
	}
	}

And it looks like this is actually working fine after being mostly unused for years. I guess you can also get lucky sometimes.

[julianbrost]

@Al2Klimov This should probably fix (or at least ref) some issues. Can you please add that before merging?