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

Improve Travis script #51

Open
3 tasks
gschare opened this issue Oct 27, 2020 · 3 comments
Open
3 tasks

Improve Travis script #51

gschare opened this issue Oct 27, 2020 · 3 comments
Assignees
Labels
enhancement New feature or request testing

Comments

@gschare
Copy link
Contributor

gschare commented Oct 27, 2020

Travis currently checks to see if update.py has been run the same day as the push. This doesn't actually tell us much, considering there is nothing about it which actually confirms that the derivatives are generated properly; only the expectation that this was done.
Some alternative/additional checks we could do:

  • All Python files compile without errors
  • Automated unit tests for manuscript.py and entry.py, according to specific test cases outlined in test entries for checking completeness and accuracy #48
  • Sanity checks on the derivatives, e.g. how many files we should expect and XML well-formedness
@gschare gschare self-assigned this Oct 27, 2020
@tcatapano tcatapano added enhancement New feature or request testing labels Nov 2, 2020
@gschare
Copy link
Contributor Author

gschare commented Jan 8, 2021

In addition to basic unit testing, it would be super helpful if editors could suggest specific folios/entries for me to use as individual test cases. Especially ones that are edge cases.
We cannot (should not) generate the entire manuscript during CI, but having 5-10 good test cases would greatly improve our confidence about being correct.
To start with, I'm using a copy of folio 170r.

@gschare
Copy link
Contributor Author

gschare commented Feb 2, 2021

In addition to basic unit testing, it would be super helpful if editors could suggest specific folios/entries for me to use as individual test cases. Especially ones that are edge cases.
We cannot (should not) generate the entire manuscript during CI, but having 5-10 good test cases would greatly improve our confidence about being correct.
To start with, I'm using a copy of folio 170r.

Actually we shouldn't do this. At least not for unit testing. For now we will focus on ensuring that each component works according to specification, which is not guaranteed by hand-picking a few interesting entries.

@gschare
Copy link
Contributor Author

gschare commented Feb 2, 2021

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request testing
Projects
None yet
Development

No branches or pull requests

2 participants