[igt-dev] [PATCH i-g-t 2/4] tests/kms_feature_discovery: add testplan documentation

[Modem, Bhanuprakash]

Hi Swati,

On Fri-08-09-2023 12:30 pm, Swati Sharma wrote:
> Add testplan documentation for the subtests.
> 
> Signed-off-by: Swati Sharma <swati2.sharma at intel.com>
> Acked-by: Kamil Konieczny <kamil.konieczny at linux.intel.com>
> ---
>   tests/kms_feature_discovery.c | 53 ++++++++++++++++++++++++++++++++++-
>   1 file changed, 52 insertions(+), 1 deletion(-)
> 
> diff --git a/tests/kms_feature_discovery.c b/tests/kms_feature_discovery.c
> index d1f4b1633..49958fd88 100644
> --- a/tests/kms_feature_discovery.c
> +++ b/tests/kms_feature_discovery.c
> @@ -22,6 +22,58 @@
>    *
>    */
>   
> +/**
> + * TEST: kms feature discovery
> + * Category: Display
> + * Description: A metatest that checks for \"features\" presence.
> + *		The subtests here should only skip or pass,
> + *		anything else means we have a serious problem.
> + *
> + * SUBTEST: display
> + * Description: Make sure that we have display support with
> + * 		some outputs connected.
> + * Driver requirement: i915, xe
> + * Functionality: feature_discovery
> + * Mega feature: General Display Features
> + * Run type: FULL

Please drop Run type for every test.

> + * Test category: functionality test
> + *
> + * SUBTEST: display-%dx

Just for readability purpose, please move this test group to end of the 
list.

> + * Description: Make sure that we have display support with %arg[1]
> + * 		outputs connected.
> + * Driver requirement: i915, xe
> + * Functionality: feature_discovery
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: chamelium
> + * Description: Make sure that Chamelium is configured and reachable.
> + * Driver requirement: i915, xe
> + * Functionality: feature_discovery, chamelium
> + * Mega feature: General Display Features
> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: psr1
> + * Description: Make sure that we have eDP panel with PSR1 support.
> + * Driver requirement: i915, xe
> + * Functionality: feature_discovery, psr1, eDP
> + * Mega feature: General Display Features

Mega feature should be PSR.

> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * SUBTEST: psr2
> + * Description: Make sure that we have eDP panel with PSR2 support.
> + * Driver requirement: i915, xe
> + * Functionality: feature_discovery, psr2, eDP
> + * Mega feature: General Display Features

Mega feature should be PSR.

> + * Run type: FULL
> + * Test category: functionality test
> + *
> + * arg[1].values: 2, 3, 4
> + */
> +
>   #include "igt.h"
>   #ifdef HAVE_CHAMELIUM
>   #include "igt_chamelium.h"
> @@ -46,7 +98,6 @@ igt_main {
>   	}
>   
>   	igt_subtest_group {
> -

Nit: Unrelated change.

- Bhanu

>   		igt_fixture {
>   			igt_display_require(&display, fd);
>   		}