[igt-dev] [PATCH i-g-t 3/3] scripts/test_list.py: better name testlist include/exclude config fields

[Kamil Konieczny]

Hi Mauro,
On 2023-10-13 at 11:29:29 +0200, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab at kernel.org>
> 
> The config names "testlists" and "blocklists" are confusing, as they
> don't have the same concept of such lists used within IGT.
> 
> What the test_list logic does, instead, is to fill a field with
> a value for all tests included from a file, except for the ones
> marked on an exclude testlist.
> 
> Use the name "include" for the tag defining the file name
> containing a list of tests to be included.
> 
> On a similar way, use "exclude" to mean the file name containg
> a list of tests to be excluded.
> 
> While here, remove two class variables originally planned for
> the testlist/blocklist logic that aren't actually used.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>

Exclude seems ok but include may be somewhat confusing.
I hope it will not mislead people.

Reviewed-by: Kamil Konieczny <kamil.konieczny at linux.intel.com>

> ---
>  scripts/test_list.py             | 24 +++++++++++-------------
>  tests/intel/kms_test_config.json |  4 ++--
>  tests/intel/xe_test_config.json  |  4 ++--
>  3 files changed, 15 insertions(+), 17 deletions(-)
> 
> diff --git a/scripts/test_list.py b/scripts/test_list.py
> index c75d15bfca73..e54873f07e20 100644
> --- a/scripts/test_list.py
> +++ b/scripts/test_list.py
> @@ -260,8 +260,6 @@ class TestList:
>          self.igt_build_path = igt_build_path
>          self.level_count = 0
>          self.field_list = {}
> -        self.testlist = {}
> -        self.blocklist = {}
>          self.title = None
>          self.filters = {}
>          self.subtest_separator = subtest_separator
> @@ -335,22 +333,22 @@ class TestList:
>                      del item["_properties_"]["sublevel"]
>  
>              # Read testlist files if any
> -            if "testlists" in item["_properties_"]:
> +            if "include" in item["_properties_"]:
>                  testlist = {}
> -                for value in item["_properties_"]["testlists"]:
> +                for value in item["_properties_"]["include"]:
>                      for name in value.keys():
>                          self.read_testlist(testlist, name, cfg_path + value[name], flags)
>  
> -                item["_properties_"]["testlist"] = testlist
> +                item["_properties_"]["include"] = testlist
>  
>              # Read blocklist files if any
> -            if "blocklists" in item["_properties_"]:
> -                blocklist = {}
> -                for value in item["_properties_"]["blocklists"]:
> +            if "exclude" in item["_properties_"]:
> +                testlist = {}
> +                for value in item["_properties_"]["exclude"]:
>                      for name in value.keys():
>                          self.read_testlist(testlist, name, cfg_path + value[name], flags)
>  
> -                item["_properties_"]["blocklist"] = blocklist
> +                item["_properties_"]["exclude"] = testlist
>  
>          if "_properties_" in self.props:
>              del self.props["_properties_"]
> @@ -490,7 +488,7 @@ class TestList:
>              if "_properties_" not in self.props[field]:
>                  continue
>  
> -            if "testlist" not in self.props[field]["_properties_"]:
> +            if "include" not in self.props[field]["_properties_"]:
>                  continue
>  
>              default_value = self.props[field]["_properties_"].get("default-testlist")
> @@ -503,7 +501,7 @@ class TestList:
>              else:
>                  values = set()
>  
> -            for names, regex_array in self.props[field]["_properties_"]["testlist"].items():
> +            for names, regex_array in self.props[field]["_properties_"]["include"].items():
>                  name = set(re.split(",\s*", names))
>                  for regex in regex_array:
>                      if regex.match(testname):
> @@ -512,8 +510,8 @@ class TestList:
>  
>              # If test is at a global blocklist, ignore it
>              set_full_if_empty = True
> -            if "blocklist" in self.props[field]["_properties_"]:
> -                for names, regex_array in self.props[field]["_properties_"]["testlist"].items():
> +            if "exclude" in self.props[field]["_properties_"]:
> +                for names, regex_array in self.props[field]["_properties_"]["exclude"].items():
>                      deleted_names = set(re.split(",\s*", names))
>                      for regex in regex_array:
>                          if regex.match(testname):
> diff --git a/tests/intel/kms_test_config.json b/tests/intel/kms_test_config.json
> index 6c9b7194a58f..40cf69dd0904 100644
> --- a/tests/intel/kms_test_config.json
> +++ b/tests/intel/kms_test_config.json
> @@ -24,7 +24,7 @@
>                  "_properties_": {
>                      "description": "Defines what category of testlist it belongs",
>                      "default-testlist": "FULL",
> -                    "testlists": [
> +                    "include": [
>                          { "i915 BAT": "../intel-ci/fast-feedback.testlist" },
>                          { "i915 BAT chamelium": "../intel-ci/fast-feedback-chamelium-only.testlist" },
>                          { "i915 chamelium": "../intel-ci/chamelium-only.testlist" },
> @@ -32,7 +32,7 @@
>                          { "Xe BAT": "../intel-ci/xe-fast-feedback.testlist" },
>                          { "Xe BAT chamelium": "../intel-ci/xe-fast-feedback-chamelium-only.testlist" }
>                      ],
> -                    "blocklists": [
> +                    "exclude": [
>                          { "i915 BAT, i915 BAT chamelium, i915 chamelium": "../intel-ci/blacklist.txt" },
>                          { "Xe BAT, Xe BAT chamelium": "../intel-ci/xe.blocklist.txt" }
>                      ]
> diff --git a/tests/intel/xe_test_config.json b/tests/intel/xe_test_config.json
> index 89df8a1a3ad2..20faf73b7270 100644
> --- a/tests/intel/xe_test_config.json
> +++ b/tests/intel/xe_test_config.json
> @@ -33,10 +33,10 @@
>                              "mandatory": true,
>                              "description": "Defines what category of testlist it belongs",
>                              "default-testlist": "FULL",
> -                            "testlists": [
> +                            "include": [
>                                  { "Xe BAT": "../intel-ci/xe-fast-feedback.testlist" }
>                              ],
> -                            "blocklists": [
> +                            "exclude": [
>                                  { "Xe BAT": "../intel-ci/xe.blocklist.txt" }
>                              ],
>                              "order": [
> -- 
> 2.41.0
>