Skip to content
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

rebber: "true" test cases? #350

Open
pierre-24 opened this issue Aug 10, 2019 · 1 comment
Open

rebber: "true" test cases? #350

pierre-24 opened this issue Aug 10, 2019 · 1 comment
Labels
status/waiting This needs more information type/request This is great to have

Comments

@pierre-24
Copy link
Member

pierre-24 commented Aug 10, 2019

We run across issues with rebber while trying to export "real-life" contents on ZdS. This is not an easy workflow (but the best we can think of): @artragis uses the internal PM system to send us the log file of LaTeX compilation, and one try to infer what went wrong, then create issue(s), then try to fix it/them (either there or on the template side).

My proposition is to have somewhere (either there or on the template side or ... Somewhere else? see below) some test cases that do the whole Markdown -> LateX -> PDF process (because right now, it is either the two first or last steps that are tested) and report errors. The ideal situation would be to have unit tests (text, block, table ...), which would normally give a better overview of what works and what doesn't (and avoid regression).

On the paper, it seems a good idea, but I have two "issues":

  • I (like to think that I) master the LaTeX side concerning installation and compilation. I, on the other hand, have no idea how to install (and use) a standalone version of zmarkdown to run the tests. I can imagine how to do it based on how it is done on zds-site, though (with a bit of mixing with how it is done here-.
  • Location is also a big question: one would like to run this series of test when changing the template (so on the template side) or changing rebber (so, here). I have no idea of a smart solution for that problem (that would avoid, say, duplication on both side).

Any input is welcomed :)

@pierre-24
Copy link
Member Author

pierre-24 commented Aug 10, 2019

One solution (that I can think of, but without knowing if it is practically possible or easy) would be to have an third repository, only containing the test markdown files (and an execution script), that would be downloaded by both (here + template) CI processes each time.

EDIT: but then, it would add a layer of complexity: if the problematic test case does not exist, then we would need to make a PR on this repository to add the test case ... Then fix it.

@StaloneLab StaloneLab added status/waiting This needs more information type/request This is great to have labels Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/waiting This needs more information type/request This is great to have
Projects
None yet
Development

No branches or pull requests

2 participants