harfbuzz/test/shaping
Behdad Esfahbod e359a4b8f5 [indic] Disable automatic ZWNJ handling for Indic features
Fixes https://github.com/behdad/harfbuzz/issues/294

Also fixes a bunch of other Indic issues.  Test results after:

BENGALI: 353725 out of 354188 tests passed. 463 failed (0.130722%)
DEVANAGARI: 707307 out of 707394 tests passed. 87 failed (0.0122987%)
GUJARATI: 366355 out of 366457 tests passed. 102 failed (0.0278341%)
GURMUKHI: 60732 out of 60747 tests passed. 15 failed (0.0246926%)
KANNADA: 951201 out of 951913 tests passed. 712 failed (0.0747968%)
KHMER: 299071 out of 299124 tests passed. 53 failed (0.0177184%)
MALAYALAM: 1048136 out of 1048334 tests passed. 198 failed (0.0188871%)
ORIYA: 42320 out of 42329 tests passed. 9 failed (0.021262%)
SINHALA: 271662 out of 271847 tests passed. 185 failed (0.068053%)
TAMIL: 1091754 out of 1091754 tests passed. 0 failed (0%)
TELUGU: 970555 out of 970573 tests passed. 18 failed (0.00185457%)

Before:

BENGALI: 353725 out of 354188 tests passed. 463 failed (0.130722%)
DEVANAGARI: 707307 out of 707394 tests passed. 87 failed (0.0122987%)
GUJARATI: 366349 out of 366457 tests passed. 108 failed (0.0294714%)
GURMUKHI: 60732 out of 60747 tests passed. 15 failed (0.0246926%)
KANNADA: 951190 out of 951913 tests passed. 723 failed (0.0759523%)
KHMER: 299070 out of 299124 tests passed. 54 failed (0.0180527%)
MALAYALAM: 1048136 out of 1048334 tests passed. 198 failed (0.0188871%)
ORIYA: 42320 out of 42329 tests passed. 9 failed (0.021262%)
SINHALA: 271662 out of 271847 tests passed. 185 failed (0.068053%)
TAMIL: 1091753 out of 1091754 tests passed. 1 failed (9.15957e-05%)
TELUGU: 970555 out of 970573 tests passed. 18 failed (0.00185457%)
2017-07-14 14:22:52 +01:00
..
fonts/sha1sum [indic] Disable automatic ZWNJ handling for Indic features 2017-07-14 14:22:52 +01:00
tests [indic] Disable automatic ZWNJ handling for Indic features 2017-07-14 14:22:52 +01:00
texts/in-tree [indic/use] Move Javanese from Indic shaper to USE 2016-05-06 15:52:27 +01:00
Makefile.am [indic] Disable automatic ZWNJ handling for Indic features 2017-07-14 14:22:52 +01:00
README.md Small doc fix: `make check` runs the tests (#469) 2017-04-15 12:17:05 -07:00
hb-diff [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-diff-colorize [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-diff-filter-failures [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-diff-ngrams [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-diff-stat [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-manifest-read [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-manifest-update [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-unicode-decode [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-unicode-encode [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb-unicode-prettyname [test] Use /usr/bin/env python instead of /usr/bin/python 2015-04-06 14:51:31 -07:00
hb_test_tools.py [tools] Make hb-unicode-code work with Python 3 2017-03-26 10:50:32 +02:00
record-test.sh Current fonttools (3.9.1) generate subset-file called font.subset.ttf instead of older font.ttf.subset 2017-03-27 12:05:35 +02:00
run-tests.sh [tests] Fix for multiple options in test runner scripts 2016-02-24 16:06:23 +09:00

README.md

Adding tests

You can test shaping of a unicode sequence against a font like this:

$ ./hb-unicode-encode 41 42 43 627 | ../../util/hb-shape font.ttf

assuming an in-tree build. The 41 42 43 627 here is a sequence of Unicode codepoints: U+0041,0042,0043,0627. When you are happy with the shape results, you can use the record-test.sh script to add this to the test suite. record-test.sh requires pyftsubset to be installed. You can get pyftsubset by installing FontTools from https://github.com/behdad/fonttools.

To use record-test.sh, just put it right before the hb-shape invocation:

$ ./hb-unicode-encode 41 42 43 627 | ./record-test.sh ../../util/hb-shape font.ttf

what this does is:

  • Subset the font for the sequence of Unicode characters requested,
  • Compare the hb-shape output of the original font versus the subset font for the input sequence,
  • If the outputs differ, perhaps it is because the font does not have glyph names; it then compares the output of hb-view for both fonts.
  • If the outputs differ, recording fails. Otherwise, it will move the subset font file into fonts/sha1sum and name it after its hash, and prints out the test case input, which you can then redirect to an existing or new test file in tests, eg.:
$ ./hb-unicode-encode 41 42 43 627 | ./record-test.sh ../../util/hb-shape font.ttf >> tests/test-name.test

If you created a new test file, add it to Makefile.am so it is run. Check that make check does indeed run it, and that the test passes. When everything looks good, git add the new font as well as new test file if you created any. You can see what new files are there by running git status tests fonts/sha1sum. And commit!

Note! Please only add tests using Open Source fonts, preferably under OFL or similar license.