From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 14 Jul 2019 22:17:54 +0000 (+0200)
Subject: documentation/doxygen: update JS tests and ensure it doesn't happen again.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=b084555c0887d4d78a436c75c844eb07c47a51dd;p=blog.git

documentation/doxygen: update JS tests and ensure it doesn't happen again.

Ugh. The flags got reordered in 1a10e178fbf4d370ba1ae3026e5492c757cfef2e
(HALF A YEAR AGO!) but the JS test data were never adapted to that, so
the JS test was still working with the old stuff.

The Travis CI job was modified to execute the python script during
the JS test run and verify there's no git diff after that.
---

diff --git a/documentation/test_doxygen/js-test-data/nested.bin b/documentation/test_doxygen/js-test-data/nested.bin
index 3d1b9a72..8cc87696 100644
Binary files a/documentation/test_doxygen/js-test-data/nested.bin and b/documentation/test_doxygen/js-test-data/nested.bin differ
diff --git a/documentation/test_doxygen/js-test-data/searchdata.b85 b/documentation/test_doxygen/js-test-data/searchdata.b85
index fb582afa..a8ca3584 100644
--- a/documentation/test_doxygen/js-test-data/searchdata.b85
+++ b/documentation/test_doxygen/js-test-data/searchdata.b85
@@ -1 +1 @@
-O+!-v2LONp003kG000310RR921ONaj009U904M+f4gdgd009&L0BHdL0{{R4AOHX<00ATb04M+fDgXd(00A%n0BHaLHUI!^00BGz06GBy0suk)fI0vHNB{tG00B?{0B-;RRsaBW00CS80Am0FVgLYT0RRO600C|Q04V?gasU7*00DRa0B!&QegFVz00D#m0BryPiU0sQ0RaR6kN|)>00EW&0A&CHo&W%600E=`0B!&QssI3C00SBT0BvXh0Cund0CE5Uwg3P+0RaF2!~lRg00GJX0B8UK(f|N-0{{U40{{g800G_r04V?g<^TXF00Ha(0B!&R*Z=@w@&Ev70RRU8009C40A&CH1_1zU009gE0A~OJ5&-~i0RadA7y$rb00ABW0CWHWCIJ9r00OE20AVZv0A&FH1^@s7JOKb@00BS&0A~OJMgag}00B$^0B`^SQUL&B00CG50CfNa_y7QHXaE3qG64W`UI74eC;$KuKL7w}R{#JidjJ4wkpKWFvj6~X$p8Sr<p2Nx@Bjb_{r~^~O<{Cs0B&JzWpi+0V`WWYbZ9PUbZu+^01^l~I&EogC~0nVEFfuabSVHMZE0=*0025VR%K&!Z*l-*Y+-YAO<{CsUol@XR%K&!Z*neZbZu+`02l^3I&EogC@COgZ*FsR03&T_ZU6uPIyzEeZf9ixV{Bn_b4_7%XkRg3F;Zb}XJsyEbZu+|02c;2I&EogC@COgZ*FsR03&T_Zct%oWgx=4AX9Z>aA9X<0CRO>aA9X<E@*UZYy<#OWn*+<Zf9&|1ONvB00KHXQe|UwC@BB{
\ No newline at end of file
+O+!-v2LONp003kG000310RR921ONaj009U904M+f4gdgd009&L0BHdL0{{R4AOHX<00ATb04M+fDgXd(00A%n0BHaLHUI!^00BGz06GBy0suk)fI0vHNB{tG00B?{0B-;RRsaBW00CS80Am0FVgLYT0RRO600C|Q04V?gasU7*00DRa0B!&QegFVz00D#m0BryPiU0sQ0RaR6kN|)>00EW&0A&CHo&W%600E=`0B!&QssI3C00SBT0BvXh0Cund0CE5Uwg3P+0RaF2!~lRg00GJX0B8UK(f|N-0{{U40{{g800G_r04V?g<^TXF00Ha(0B!&R*Z=@w@&Ev70RRU8009C40A&CH1_1zU009gE0A~OJ5&-~i0RadA7y$rb00ABW0CWHWCIJ9r00OE20AVZv0A&FH1^@s7JOKb@00BS&0A~OJMgag}00B$^0B`^SQUL&B00CG50CfNa_y7QHXaE3qG64W`UI74eC;$K;KL7x!R{#J?djJ5bkpKWlvj70C$p8Ql<p2Nx@Bjb_{r~^~O<{Cs0B&JzWpi+0V`WWYbZ9PUbZu+^01^l~I&EogC~0nVEFfuabSVHMZE0=*0025VR%K&!Z*l-*Y+-YAO<{CsUol@XR%K&!Z*neZbZu+`02l^3I&EogC@COgZ*FsR03&T_ZU6uPIyzEeZf9ixV{Bn_b4_7%XkRg3F;Zb}XJsyEbZu+|02c;2I&EogC@COgZ*FsR03&T_Zct%oWgx=4AX9Z>aA9X<0CRO>aA9X<E@*UZYy<#OWn*+<Zf9&|1ONvB00KHXQe|UwC@BB{
\ No newline at end of file
diff --git a/documentation/test_doxygen/js-test-data/searchdata.bin b/documentation/test_doxygen/js-test-data/searchdata.bin
index d9a2f9a6..884306d7 100644
Binary files a/documentation/test_doxygen/js-test-data/searchdata.bin and b/documentation/test_doxygen/js-test-data/searchdata.bin differ
diff --git a/documentation/test_doxygen/js-test-data/unicode.bin b/documentation/test_doxygen/js-test-data/unicode.bin
index 914fd4a5..ce221155 100644
Binary files a/documentation/test_doxygen/js-test-data/unicode.bin and b/documentation/test_doxygen/js-test-data/unicode.bin differ
diff --git a/documentation/test_doxygen/test-search.js b/documentation/test_doxygen/test-search.js
index 62615b7f..eca92af4 100644
--- a/documentation/test_doxygen/test-search.js
+++ b/documentation/test_doxygen/test-search.js
@@ -122,19 +122,19 @@ const { StringDecoder } = require('string_decoder');
     let resultsForM = [[
         { name: 'Math',
           url: 'namespaceMath.html',
-          flags: 16,
+          flags: 32,
           suffixLength: 3 },
         { name: 'Math::min(int, int)',
           url: 'namespaceMath.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 12 },
         { name: 'Math::Vector::min() const',
           url: 'classMath_1_1Vector.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 10 },
         { name: 'Math::Range::min() const',
           url: 'classMath_1_1Range.html#min',
-          flags: 109,
+          flags: 173,
           suffixLength: 10 }], ''];
     assert.deepEqual(Search.search('m'), resultsForM);
 
@@ -142,15 +142,15 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('min'), [[
         { name: 'Math::min(int, int)',
           url: 'namespaceMath.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 10 },
         { name: 'Math::Vector::min() const',
           url: 'classMath_1_1Vector.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 8 },
         { name: 'Math::Range::min() const',
           url: 'classMath_1_1Range.html#min',
-          flags: 109,
+          flags: 173,
           suffixLength: 8 }], '()']);
 
     /* Go back, get the same thing */
@@ -160,7 +160,7 @@ const { StringDecoder } = require('string_decoder');
     let resultsForVec = [[
         { name: 'Math::Vector',
           url: 'classMath_1_1Vector.html',
-          flags: 40|2, /* Deprecated */
+          flags: 72|2, /* Deprecated */
           suffixLength: 3 }], 'tor'];
     assert.deepEqual(Search.search('vec'), resultsForVec);
 
@@ -174,7 +174,7 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('su'), [[
         { name: Search.toUtf8('Page » Subpage'),
           url: 'subpage.html',
-          flags: 192,
+          flags: 16,
           suffixLength: 5 }], 'bpage']);
 
     /* Alias */
@@ -182,16 +182,16 @@ const { StringDecoder } = require('string_decoder');
         { name: 'Rectangle::Rect()',
           alias: 'Math::Range',
           url: 'classMath_1_1Range.html',
-          flags: 40,
+          flags: 72,
           suffixLength: 5 },
         { name: 'Math::Range',
           url: 'classMath_1_1Range.html',
-          flags: 40,
+          flags: 72,
           suffixLength: 4 },
         { name: 'Rectangle',
           alias: 'Math::Range',
           url: 'classMath_1_1Range.html',
-          flags: 40,
+          flags: 72,
           suffixLength: 8 }], '']);
 }
 
@@ -205,15 +205,15 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('m'), [[
         { name: 'Math',
           url: 'namespaceMath.html',
-          flags: 16,
+          flags: 32,
           suffixLength: 3 },
         { name: 'Math::min(int, int)',
           url: 'namespaceMath.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 12 },
         { name: 'Math::Vector::min() const',
           url: 'classMath_1_1Vector.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 10 }], '']);
 }
 
@@ -227,15 +227,15 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('min'), [[
         { name: 'Math::min(int, int)',
           url: 'namespaceMath.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 10 },
         { name: 'Math::Vector::min() const',
           url: 'classMath_1_1Vector.html#min',
-          flags: 105,
+          flags: 169,
           suffixLength: 8 },
         { name: 'Math::Range::min() const',
           url: 'classMath_1_1Range.html#min',
-          flags: 109,
+          flags: 173,
           suffixLength: 8 }], '()']);
 }
 
@@ -250,22 +250,22 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('h'), [[
         { name: Search.toUtf8('Hárá'),
           url: '#b',
-          flags: 192,
+          flags: 16,
           suffixLength: 5 },
         { name: Search.toUtf8('Hýždě'),
           url: '#a',
-          flags: 192,
+          flags: 16,
           suffixLength: 7 }], '']);
     /* These autocompletions are valid UTF-8, so nothing gets truncated */
     assert.deepEqual(Search.search('hý'), [[
         { name: Search.toUtf8('Hýždě'),
           url: '#a',
-          flags: 192,
+          flags: 16,
           suffixLength: 5 }], 'ždě']);
     assert.deepEqual(Search.search('há'), [[
         { name: Search.toUtf8('Hárá'),
           url: '#b',
-          flags: 192,
+          flags: 16,
           suffixLength: 3 }], 'rá']);
 }
 
@@ -278,13 +278,13 @@ const { StringDecoder } = require('string_decoder');
     assert.deepEqual(Search.search('geo'), [[
         { name: 'Magnum::Math::Geometry',
           url: 'namespaceMagnum_1_1Math_1_1Geometry.html',
-          flags: 24,
+          flags: 40,
           suffixLength: 5 }], 'metry']);
 
     assert.deepEqual(Search.search('ra'), [[
         { name: 'Magnum::Math::Range',
           url: 'classMagnum_1_1Math_1_1Range.html',
-          flags: 40,
+          flags: 72,
           suffixLength: 3 }], 'nge']);
 }
 
diff --git a/package/ci/travis.yml b/package/ci/travis.yml
index b88b4794..a7e6d7f7 100644
--- a/package/ci/travis.yml
+++ b/package/ci/travis.yml
@@ -87,6 +87,12 @@ script:
   - if [ "$WITH_THEME" == "ON" ]; then cd $TRAVIS_BUILD_DIR/css && ./postprocess.sh && git diff --color=always . | cat; fi
   - if [ "$WITH_THEME" == "ON" ]; then cd $TRAVIS_BUILD_DIR/css && git diff-index --exit-code HEAD -- .; fi
 
+  # Test that JS search test data are up-to-date as well. Would be best to do
+  # it on the Node.js job but that one has just Python 3.5 which doesn't know
+  # enum.Flag.
+  - if [ "$WITH_DOCUMENTATION" == "ON" ]; then cd $TRAVIS_BUILD_DIR/documentation/test_doxygen && ./populate-js-test-data.py && git diff --color=always . | cat; fi
+  - if [ "$WITH_DOCUMENTATION" == "ON" ]; then cd $TRAVIS_BUILD_DIR/documentation/test_doxygen/js-test-data && git diff-index --exit-code HEAD -- .; fi
+
 # Cache the downloaded doxygen and pybind11
 cache:
   directories: