XSD: the tool id attribute allows any string as per the schema definition

[davelopez]

The current definition in the XSD file for the tool id attribute allows any string while the attribute documentation states:

should be lowercase and contain only letters, numbers, and underscores.

and the IUC best practices recommendations states:

• Tool IDs should contain only [a-z0-9_-].
• Multiple words should be separated by underscore or dashes

I propose adding a <xs:simpleType> with a pattern restriction that complies with these requirements. Or should the schema not enforce this rule to validate the XML document?

[bgruening]

Plus one for enforcing.

[mvdbeek]

As long as this is just a warning in the linter I think that's fine ... keep in mind that changing tool ids break tool lineages.

[davelopez]

Adding this restriction and providing an invalid id will probably result in planemo lint displaying Invalid XML found in file with the corresponding error message and the Galaxy Tools Extension showing an issue in the problems tab similar to this:

As far as I know, it should not break any existing tool id, since this is only used when linting tools, but probably will mark planemo lint as failed in the CI when making a PR against a tool repository.
Is this behavior undesired?

[mvdbeek]

I think so, since that means we can't update the tool for fixes.

[davelopez]

Oops... Understand! 😅
Then do not add the restriction to the XSD and probably include an additional custom validation to the extension and/or planemo linter that will check this pattern and treat it only as a Warning.

I will close this then :)

[bgruening]

I think so, since that means we can't update the tool for fixes.

I think we should lint tools like this, to avoid people adding more "tools with spaces in IDs". The old tools are then failing, that is another problem we should fix elsewhere, e.g. skipping lints in shed.yml ... but the correct thing is to warn users about a "wrong" ID, isn't it?

[mvdbeek]

I think David suggested the right thing here. The XSD linting doesn't allow this amount of flexibility.