tmt t lint should also try to cover adjust rules

[idorax]

Fixes #898. If adjust has some L2 keys, we should pick up those keys when invoking Core.lint_keys().

[lukaszachy]

Doesn't work unfortunately because 'when' (and 'because') are not known to the lint:

/tests/run/worktree
pass test script must be defined
pass directory path must be absolute
pass directory path must exist
fail unknown attribute 'when' is used
fail unknown attribute 'when' is used

It would be also good to add test to show that lint does its job and points about invalid attribute in adjust rules.

[lukaszachy]

Second argument can be tuple of allowed types so you can use

elif isinstance(prop_adjust, (list, tuple)):

[idorax]

Updated, thanks!

[idorax]

Doesn't work unfortunately because 'when' (and 'because') are not known to the lint:

/tests/run/worktree
pass test script must be defined
pass directory path must be absolute
pass directory path must exist
fail unknown attribute 'when' is used
fail unknown attribute 'when' is used

@lukaszachy, Thanks for your quick review. I'm thinking how to get all keywords supported by 'adjust'. Currently known_keys in Core.lint_keys() doesn't include when, because, ...

(Pdb) ll
289  	    def lint_keys(self, additional_keys):
290  	        """ Return list of invalid keys used, empty when all good """
291  	        known_keys = additional_keys + self._keys
292  	        node_keys = list(self.node.get().keys())
293  	        prop_adjust = self.node.get('adjust')
294  	        if prop_adjust is not None:
295 B->	            if isinstance(prop_adjust, dict):
296  	                node_keys.extend(prop_adjust.keys())
......
302  	        return [key for key in node_keys if key not in known_keys]
(Pdb) p additional_keys
['extra-nitrate', 'extra-hardware', 'extra-pepa', 'extra-summary', 'extra-task', 'relevancy', 'coverage', 'adjust']
(Pdb) up
> /home/huanli/.virtualenvs/tmt/lib/python3.10/site-packages/tmt/base.py(572)lint()
-> invalid_keys = self.lint_keys(
(Pdb) l
.......
572  ->	        invalid_keys = self.lint_keys(
573  	            EXTRA_TEST_KEYS + OBSOLETED_TEST_KEYS + ['adjust'])
574  	        if invalid_keys:
......
(Pdb) p EXTRA_TEST_KEYS + OBSOLETED_TEST_KEYS + ['adjust']
['extra-nitrate', 'extra-hardware', 'extra-pepa', 'extra-summary', 'extra-task', 'relevancy', 'coverage', 'adjust']

Any suggestion?

It would be also good to add test to show that lint does its job and points about invalid attribute in adjust rules.

OK, will have a try.

[lukaszachy]

@idorax Hm, it gets more complicated. I think check needs to be done in two steps as "adjust" and "when+because" are mutually exclusive. So lint :

1. test keys + adjust
2. test keys + when + because

Maybe time to add constants with ['adjust'] and another with ['when', 'because']. I don't think we want them hardcoded but naming such constant will be pain (adjust key itself and keys used by adjust).

[psss]

Any plans with this one, @idorax?

[idorax]

Any plans with this one, @idorax?

Currently I don't have bandwidth to work on this issue, let me work on it in 1.32, thanks!

[lukaszachy]

Some test to play with:

test: echo
require:
- something

/valid:
  adjust+:
    - when: distro == fedora
      because: showcase
      enabled: true
      environment+:
        FOO: bar
      require-:
        - something
      recommend+<:
        - anything
        
/wrong:
    adjust:
        - qhen: distro == fedora
          env:
            MAGIC: value
          require<+:
          - foo

There should be no "fail" for /valid.
For /wrong is should report wrong key 'qhen', 'env' and 'require<+' (there is no such operation).

[idorax]

Some test to play with:

test: echo
require:
- something

/valid:
  adjust+:
    - when: distro == fedora
      because: showcase
      enabled: true
      environment+:
        FOO: bar
      require-:
        - something
      recommend+<:
        - anything
        
/wrong:
    adjust:
        - qhen: distro == fedora
          env:
            MAGIC: value
          require<+:
          - foo

There should be no "fail" for /valid. For /wrong is should report wrong key 'qhen', 'env' and 'require<+' (there is no such operation).

Thanks, @lukaszachy! Will have a try :-)