OurBigBookThere are two types of test in our test suite:
- These tests don't actually create files in the filesystem, and just mock the filesystem instead with a dictionary.Database access is not mocked however, we just use Sqlite's fantastic in-memory mode.Whenever possible, these tests check their results just from the abstract syntax tree tree returned by the API, which is cleaner than parsing the HTML. But sometimes HTML parsing is inevitable.
- tests that call the
ourbigbookexecutable itself:- their titles are prefixed with
cli: - they tend to be a lot slower than the API test
- can test functionality that is done outside of the
ourbigbook.convertJavaScript API, notably stuff prevent in ourbigbook, so they are more end to end - don't do any mocking, and could therefore be more representative.However, as of 2022, we have basically eliminated all the hard database access mocking and are using the main database methods directly.So all that has to be mocked is basically stuff done in the ourbigbook executable itself.This means that except for more specific options, the key functionality of ourbigbook, which is to convert multiple paths, can be done very well in a non executable test.The only major difference is that instead of passing command line arguments like in
ourbigbook .to convert multiple files in a directory, you have to useconvert_beforeandconvert_before_norenderand specify conversion order one by one.This test robustness is new as of 2022, and many tests were previously written with executable that would now also work as unit tests, and we generally want that to be the case to make the tests go faster. - work by creating an actual physical filesystem under
out/test/<normalized-test-title>with the OurBigBook files and other files likeourbigbook.json, and then running the executable on that directory.npm testfirst deletes theout/testdirectory before running the tests. After running, the generated files are kept so you can inspect them to help debug any issues. - all these tests check their results by parsing the HTML and searching for elements, since here we don't have access to the abstract syntax tree. It wouldn't be impossible to obtain it however, as it is likely already JSON serializable.
- their titles are prefixed with