llnl / llnl/maestrowf

Text encoding breaks yaml validation

Open
#466 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
161
Forks
49
PR merge metrics
No merged PRs in 30d

Description

Encountered interesting issue via copying spec's out of the documentation and trying to run it. This worked fine, until the downloaded specification was edited to add some new keys, a depends key, which resulted in immediate yaml validation errors about that being an invalid key. The only recourse was manually retyping the whole specification. That, combined with throwing a 'not-ascii' regex at the buffer that marked nearly every character suggests a text encoding issue? More investigation required to ensure examples can actually be taken from the documentation directly.

Initial testing/issue discovered on MacOS.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with a specification copied from the documentation, then edit it to add a depends key and run YAML validation on macOS. Trace the validation entry point and inspect how text is decoded before the key check and not-ascii regex run. Done means copied documentation examples remain valid after editing and non-ASCII text is handled correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.