Skip to content

Create l3build testing for tagging structure of example documents #858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 21, 2025

Conversation

zauguin
Copy link
Member

@zauguin zauguin commented May 25, 2025

Add l3build configuration to use latex3/pdf_structure to do automated test of the XML representation of the tagging of all test documents in tagging-status.

Currently no special extensions are used, the tests end with .tex to reduce differences.

@FrankMittelbach
Copy link
Member

a bit overwhelming that :-)

Right now we have tests that fail (or give wrong results). So I wonder if we should not distinguish the good and the bad ones in some way. Now sure how. Perhaps we should have an extension like .lxt instead of .tex and only change to that for files where we consider the result already "good"?

Or what would you suggest?

@davidcarlisle
Copy link
Member

@FrankMittelbach (@zauguin ) possibly we should not commit the reference xml files for bad cases so only the good xml are checked in?

Apart from that, I couldn't get these tests to fail locally, it doesn't seem to be diffing the xml at any stage?

@FrankMittelbach
Copy link
Member

The reason why I was suggesting to have a special extension other than .tex is that then it is easy to find files that fail (or are not yet checked = those that are still .tex). Of course you can also look for files that don't have an xml output but that is much more complicated to to imo

@davidcarlisle
Copy link
Member

@FrankMittelbach yes we should probably do both: checked in wrong xml trees probably end up being confusing.

@zauguin
Copy link
Member Author

zauguin commented May 31, 2025

@davidcarlisle

yes we should probably do both: checked in wrong xml trees probably end up being confusing.

I like having even wrong XML trees checked in since this makes it clearer how they are broken and also makes it more visible more these are affected by changes.

Maybe we could have both types checked in but separated? Something like

  • Unknown state: .tex tests with .draft.xml reference
  • Known good: .lst tests with .struct.xml reference
  • Known broken: .bad tests with .broken.xml references

or three testfiles directories to allow running them separately?

@zauguin
Copy link
Member Author

zauguin commented May 31, 2025

Apart from that, I couldn't get these tests to fail locally, it doesn't seem to be diffing the xml at any stage?

That should be fixed now, it triggered a l3build issue before.

@FrankMittelbach
Copy link
Member

@davidcarlisle

yes we should probably do both: checked in wrong xml trees probably end up being confusing.

I like having even wrong XML trees checked in since this makes it clearer how they are broken and also makes it more visible more these are affected by changes.

Maybe we could have both types checked in but separated? Something like

* Unknown state: `.tex` tests with `.draft.xml` reference

* Known good: `.lst` tests with `.struct.xml` reference

* Known broken: `.bad` tests with `.broken.xml` references

how should that work? I mean conceptually?

You would manually change the name? but the test would still work?

or three testfiles directories to allow running them separately?

I think it would be simpler do do it this way. It still means some manual moving, but if we then all all 3 test dirs we would even notice if a formally broken file suddenly changes (for the better hopefull).

@zauguin zauguin force-pushed the l3build branch 4 times, most recently from 1d21b65 to c8ab1b9 Compare June 10, 2025 06:23
@zauguin zauguin force-pushed the l3build branch 2 times, most recently from 052edb4 to 864b276 Compare June 10, 2025 21:36
@FrankMittelbach
Copy link
Member

Hi @zauguin, what is the status here?

@zauguin
Copy link
Member Author

zauguin commented Jun 20, 2025

Hi @zauguin, what is the status here?

I'm trying to get this to pass (which keeps breaking due to being slow and the repo involving). Once I have this in a state where the Workflow passes and the branch is up to date with main I will merge and then due optimization after merging to avoid further rebasing.

@FrankMittelbach
Copy link
Member

Hi @zauguin, what is the status here?

I'm trying to get this to pass (which keeps breaking due to being slow and the repo involving). Once I have this in a state where the Workflow passes and the branch is up to date with main I will merge and then due optimization after merging to avoid further rebasing.

We can refrain to do updates or additions to test files for a while if that helps, ie hold merging an new stuff by @mbertucci47 or me or anybody else.

@zauguin zauguin force-pushed the l3build branch 4 times, most recently from 5f41bb6 to e95961f Compare June 21, 2025 08:26
@zauguin zauguin force-pushed the l3build branch 3 times, most recently from 506471e to 1ba7e2f Compare June 21, 2025 09:58
@zauguin zauguin merged commit 02e52b3 into main Jun 21, 2025
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants