You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Each branch on this repository should correspond to the matching branch (i.e. the one with the same name) in the main repository. That is, all the tests should pass when run against that branch with TeX Live 2020. Thus all new development in the main repository should create a corresponding branch here. The exception to this is a branch which should not break any existing test and requires no new tests. In this instance, it's acceptable to simply indicate that all tests on the develop (or ctan) branch here should pass.
The gabc-output/bar-substitution.gabc test makes use of gregorio.ttf and thus
will fail if the supplemental fonts are not installed.
Use ./gregorio-test.sh to run the full test suite with default options.
Pass the name(s) of desired tests to run those tests specifically. Pass the
-h option to get a summary of available options.
gregorio-test.sh will read a gregorio-test.rc file, if it exists, to set
up some features such as color. Please read the gregorio-test.sh file
itself for more information. See example.gregorio-test.rc for an example.
This project provides a harness for repeatable testing of Gregorio. Tests
should be placed in one of the tests, longtests, or backwards
directories, within the proper subdirectory depending on type.
Tests in the tests directory and backwards directory are run normally.
Tests in the longtests directory are only run when the -L flag is
passed to gregorio-test.sh.
The following test types are supported:
This test runs gregorio against each gabc file in this directory to produce a GregorioTeX file and compares it with an expected output file.
Requirements:
- Every gabc file must have a corresponding "expected" tex file.
Notes:
The first two lines are stripped from the "expected" tex file as well as from the file produced by running gregorio during the test before the comparison.
This test runs gregorio against each gabc file in this directory to produce an text dump file and compares it with an expected output file.
Requirements:
- Every gabc file must have a corresponding "expected" dump file.
This test runs gregorio against each gabc file in this directory to
produce a gabc file (as interpreted by gregorio) and compares it with an
expected output file (with a .exp extension).
Requirements:
- Every gabc file must have a corresponding "expected" gabc file (with a
.expextension).
This test creates a simple TeX driver file which invokes \includescore
on each gabc file in this directory in order to compile it and produce a
PDF, which is then compared with an expected PDF file.
Requirements:
- Every gabc file must have a corresponding "expected" PDF file.
Notes:
The gabc file may be accompanied by a preamble file which can inject
additional TeX settings for processing. If provided, the preamble file
must be the gabc base filename with -preamble.tex appended. For
example, the preamble file for mytest.gabc should be named
mytest-preamble.tex.
The PDFs are compared by first converting the pages to PNG files with imagemagick's convert and then compared using imagemagick's compare and the AE metric.
This test runs lualatex on every tex file in this directory in order to compile it and produce a PDF, which is then compared with an expected PDF file. It is recommended, due to the nature of this test, that each test be in a separate subdirectory. Unless necessary for a particular test, use the provided Alegreya fonts for rendering.
Requirements:
- Every tex file must have a corresponding "expected" PDF file.
- All other files needed by the tex file (i.e., gabc files) must also be included.
- Use of the provided Alegreya fonts is recommended.
- Filenames for the test must not have the format
gap-*.tex. Files with this naming pattern are assumed to be space configuration files, not independent tests.
Notes:
The PDFs are compared by first converting the pages to PNG files with imagemagick's convert and then compared using imagemagick's compare and the AE metric.
The plain TeX version of tex-output. This test runs luatex on every
tex file in this directory in order to compile it and produce a PDF,
which is then compared with an expected PDF file. It is recommended,
due to the nature of this test, that each test be in a separate
subdirectory. Unless necessary for a particular test, use the provided
Alegreya fonts for rendering.
Requirements:
- Every tex file must have a corresponding "expected" PDF file.
- All other files needed by the tex file (i.e., gabc files) must also be included.
- Use of the provided Alegreya fonts is recommended.
Notes:
The PDFs are compared by first converting the pages to PNG files with imagemagick's convert and then compared using imagemagick's compare and the AE metric.
This test runs every shell script (.sh extension) in this directory
and passes the test if the script exits with a 0 return code. This
places the responsibility for checking for success on the script
itself. These tests have no "expected" files and the results may not
be viewed by using gregorio-test.sh.
Requirements:
- Each shell script should check for success and exit with the
0return code if the test is successful.
Tests that are under the backwards top-level directory should test
that deprecated features are working correctly. They should be named
with _B before the extension of the filename (or -preamble.tex for such
files). This naming convention causes gregorio-test.sh to allow deprecated
usage so that deprecated features may be tested correctly.
If a test is in a directory named should-fail somewhere underneath
the test type directory, gregorio-test.sh will run the test as usual,
but assert that the test fails to compile the test document. Should
compilation fail, the test will pass.
For a new test:
- Run
./gregorio-test.sh -n {subdirectory/under/tests} - Run
./gregorio-test.sh -a {subdirectory/under/tests}
For an existing test, where the new output is deemed to be correct.
- Run
./gregorio-test.sh -a {subdirectory/under/tests}
- Bash
- Imagemagick
- Gregorio
- TeX Live
Each kind of test must have seven functions defined in harness.sh, prefixed
by a common prefix:
- find
- test
- accept
- view_log
- view_diff
- view_expected
- view_output
Be sure to pass the prefix to the register function after declaring the new functions.
All tests contributed must be licensed under GPLv3 with the "or later" option.
Put comments in test cases to describe what they test. They are
free-form for now, but start the comment with %issue: to give the
GitHub issue number and with %notes: to summarize the test case.
Such magic comments may be harvested in the future.
Gregorio Tests
Copyright (C) 2015-2016 The Gregorio Project
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
The Alegreya fonts in the fonts directory are bundled with these
tests in order to set a reasonably complete, stable font for the
majority of the PDF-based tests. These fonts are Copyright (C) 2011,
Juan Pablo del Peral, and are licensed under the SIL Open Font License.
See the SIL Open Font License.txt file in the fonts directory for
details.