internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-03-26 19:03:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(modules): Add hidden_fields argument

Browse Source 
Add the hidden_fields argument to kubevirt_vm and kubevirt_{vm,vmi}_info
which allows to hide and ignore certain fields in the returned definition
of a VM or VMI. By default this argument is set to ignore changes to the
kubemacpool.io/transaction-timestamp annotation and managed fields, which
may change at any time and cause the modules to return a changed status
although nothing has changed other than their values.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
This commit is contained in:
Felix Matouschek
2025-04-28 10:27:50 +02:00
parent fe822b3352
commit a9d7fa22aa
7 changed files with 137 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
tests/unit/plugins/modules/test_kubevirt_vm.py
View File

@@ -210,12 +210,26 @@ MODULE_PARAMS_DELETE = MODULE_PARAMS_DEFAULT | {
"wait": True,
}
MODULE_PARAMS_HIDDEN_FIELDS = MODULE_PARAMS_DEFAULT | {
"name": "testvm",
"namespace": "default",
"running": False,
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]",
],
}
K8S_MODULE_PARAMS_CREATE = MODULE_PARAMS_CREATE | {
"generate_name": None,
"running": None,
"run_strategy": None,
"resource_definition": VM_DEFINITION_CREATE,
"wait_condition": {"type": "Ready", "status": True},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
K8S_MODULE_PARAMS_RUNNING = MODULE_PARAMS_RUNNING | {
@@ -223,6 +237,10 @@ K8S_MODULE_PARAMS_RUNNING = MODULE_PARAMS_RUNNING | {
"run_strategy": None,
"resource_definition": VM_DEFINITION_RUNNING,
"wait_condition": {"type": "Ready", "status": True},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
K8S_MODULE_PARAMS_STOPPED = MODULE_PARAMS_STOPPED | {
@@ -230,6 +248,10 @@ K8S_MODULE_PARAMS_STOPPED = MODULE_PARAMS_STOPPED | {
"run_strategy": None,
"resource_definition": VM_DEFINITION_STOPPED,
"wait_condition": {"type": "Ready", "status": False, "reason": "VMINotExists"},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
K8S_MODULE_PARAMS_HALTED = MODULE_PARAMS_HALTED | {
@@ -237,6 +259,10 @@ K8S_MODULE_PARAMS_HALTED = MODULE_PARAMS_HALTED | {
"running": None,
"resource_definition": VM_DEFINITION_HALTED,
"wait_condition": {"type": "Ready", "status": False, "reason": "VMINotExists"},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
K8S_MODULE_PARAMS_DELETE = MODULE_PARAMS_DELETE | {
@@ -245,6 +271,17 @@ K8S_MODULE_PARAMS_DELETE = MODULE_PARAMS_DELETE | {
"run_strategy": None,
"resource_definition": VM_DEFINITION_RUNNING,
"wait_condition": {"type": "Ready", "status": True},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
K8S_MODULE_PARAMS_HIDDEN_FIELDS = MODULE_PARAMS_HIDDEN_FIELDS | {
"generate_name": None,
"run_strategy": None,
"resource_definition": VM_DEFINITION_STOPPED,
"wait_condition": {"type": "Ready", "status": False, "reason": "VMINotExists"},
}
@@ -281,6 +318,12 @@ K8S_MODULE_PARAMS_DELETE = MODULE_PARAMS_DELETE | {
VM_DEFINITION_RUNNING,
"delete",
),
(
MODULE_PARAMS_HIDDEN_FIELDS,
K8S_MODULE_PARAMS_HIDDEN_FIELDS,
VM_DEFINITION_STOPPED,
"update",
),
],
)
def test_module(mocker, module_params, k8s_module_params, vm_definition, method):

20
tests/unit/plugins/modules/test_kubevirt_vm_info.py
View File

@@ -52,6 +52,10 @@ FIND_ARGS_DEFAULT = {
"wait_sleep": 5,
"wait_timeout": 120,
"condition": {"type": "Ready", "status": True},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
FIND_ARGS_NAME_NAMESPACE = FIND_ARGS_DEFAULT | {
@@ -77,6 +81,13 @@ FIND_ARGS_STOPPED = FIND_ARGS_DEFAULT | {
"condition": {"type": "Ready", "status": False, "reason": "VMINotExists"},
}
FIND_ARGS_HIDDEN_FIELDS = FIND_ARGS_DEFAULT | {
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]",
],
}
@pytest.mark.parametrize(
"module_args,find_args",
@@ -87,6 +98,15 @@ FIND_ARGS_STOPPED = FIND_ARGS_DEFAULT | {
({"field_selectors": "app=test"}, FIND_ARGS_FIELD_SELECTOR),
({"wait": True, "running": True}, FIND_ARGS_RUNNING),
({"wait": True, "running": False}, FIND_ARGS_STOPPED),
(
{
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]",
]
},
FIND_ARGS_HIDDEN_FIELDS,
),
],
)
def test_module(mocker, module_args, find_args):

20
tests/unit/plugins/modules/test_kubevirt_vmi_info.py
View File

@@ -43,6 +43,10 @@ FIND_ARGS_DEFAULT = {
"wait_sleep": 5,
"wait_timeout": 120,
"condition": {"type": "Ready", "status": True},
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.managedFields",
],
}
FIND_ARGS_NAME_NAMESPACE = FIND_ARGS_DEFAULT | {
@@ -58,6 +62,13 @@ FIND_ARGS_FIELD_SELECTOR = FIND_ARGS_DEFAULT | {
"field_selectors": ["app=test"],
}
FIND_ARGS_HIDDEN_FIELDS = FIND_ARGS_DEFAULT | {
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]",
],
}
@pytest.mark.parametrize(
"module_args,find_args",
@@ -66,6 +77,15 @@ FIND_ARGS_FIELD_SELECTOR = FIND_ARGS_DEFAULT | {
({"name": "testvm", "namespace": "default"}, FIND_ARGS_NAME_NAMESPACE),
({"label_selectors": "app=test"}, FIND_ARGS_LABEL_SELECTOR),
({"field_selectors": "app=test"}, FIND_ARGS_FIELD_SELECTOR),
(
{
"hidden_fields": [
"metadata.annotations[kubemacpool.io/transaction-timestamp]",
"metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]",
]
},
FIND_ARGS_HIDDEN_FIELDS,
),
],
)
def test_module(mocker, module_args, find_args):