From e2563f2cf0aa7bc3147ffd2ed7e02eb05e336015 Mon Sep 17 00:00:00 2001 From: Varac <varac@varac.net> Date: Mon, 2 Aug 2021 10:52:54 +0200 Subject: [PATCH] Clarify usage of testing resources --- test/pytest/test_resources.py | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/test/pytest/test_resources.py b/test/pytest/test_resources.py index 09af8f174..4d6b09097 100644 --- a/test/pytest/test_resources.py +++ b/test/pytest/test_resources.py @@ -145,9 +145,12 @@ def run_around_tests(): @pytest.mark.kustomizations def test_kustomizations(resource, namespace): """ - Checks if a single or all kustomization(s) installed by weave flux are in + Test if a single or all kustomization(s) installed by weave flux are in 'Ready' state. + If you want to test a single kustomization please provide both name and + namespace, otherwise all kustomizations from all namespaces are tested. + :param name: The resource object's name :type name: str :param namespace: The resource object's namespace @@ -169,9 +172,12 @@ def test_kustomizations(resource, namespace): @pytest.mark.helmreleases def test_helmreleases(resource, namespace): """ - Checks if a single or all HelmRelease(s) installed by weave flux are in + Test if a single or all HelmRelease(s) installed by weave flux are in 'Ready' state. + If you want to test a single helmrelease please provide both name and + namespace, otherwise all helmreleases from all namespaces are tested. + :param name: The resource object's name :type name: str :param namespace: The resource object's namespace @@ -193,7 +199,10 @@ def test_helmreleases(resource, namespace): @pytest.mark.deployments def test_deployments(resource, namespace): """ - Check if a single or all deployment(s) are ready + Test if a single or all deployment(s) are ready + + If you want to test a single deployment please provide both name and + namespace, otherwise all deployments from all namespaces are tested. :param name: The resource object's name :type name: str @@ -233,7 +242,10 @@ def test_deployments(resource, namespace): @pytest.mark.statefulsets def test_statefulsets(resource, namespace): """ - Check if a single or all statefulset(s) are ready + Test if a single or all statefulset(s) are ready + + If you want to test a single statefulset please provide both name and + namespace, otherwise all statefulsets from all namespaces are tested. :param name: The resource object's name :type name: str @@ -270,7 +282,10 @@ def test_statefulsets(resource, namespace): @pytest.mark.daemonsets def test_daemonsets(resource, namespace): """ - Check if a single or all daemonset(s) are ready + Test if a single or all daemonset(s) are ready + + If you want to test a single daemonset please provide both name and + namespace, otherwise all daemonsets from all namespaces are tested. :param name: The resource object's name :type name: str -- GitLab