test: fix flaky test-make-doc

`test-make-doc` fails in CI on Raspberry Pi devices where `test-ci-js`
runs the test but does not build the docs. We do not want to build the
docs in these cases. Move the test to the `doctool` suite and add that
suite to `IGNORED_SUITES` in `test.py`. Specify `doctool` as a test
suite to run with `make test` or `make test-ci` but not with the
`make test-ci-js` job run on cross-compiled fanned CI tests like we do
with Raspberry Pi devices in CI.

PR-URL: https://github.com/nodejs/node/pull/16301
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

1 files changed, 43 insertions, 0 deletions

diff --git a/test/doctool/test-make-doc.js b/test/doctool/test-make-doc.js
new file mode 100644
index 0000000000..06386c0c81
--- /dev/null
+++ b/test/doctool/test-make-doc.js
@@ -0,0 +1,43 @@
+'use strict';
+const common = require('../common');
+if (common.isWindows) {
+  common.skip('`make doc` does not run on Windows');
+}
+
+// This tests that `make doc` generates the documentation properly.
+// Note that for this test to pass, `make doc` must be run first.
+
+const assert = require('assert');
+const fs = require('fs');
+const path = require('path');
+
+const apiPath = path.resolve(common.projectDir, 'out', 'doc', 'api');
+const docs = fs.readdirSync(apiPath);
+assert.ok(docs.includes('_toc.html'));
+
+const toc = fs.readFileSync(path.resolve(apiPath, '_toc.html'), 'utf8');
+const re = /href="([^/]+\.html)"/;
+const globalRe = new RegExp(re, 'g');
+const links = toc.match(globalRe);
+assert.notStrictEqual(links, null);
+
+// Test that all the relative links in the TOC of the documentation
+// work and all the generated documents are linked in TOC.
+const linkedHtmls = links.map((link) => link.match(re)[1]);
+for (const html of linkedHtmls) {
+  assert.ok(docs.includes(html), `${html} does not exist`);
+}
+
+const excludes = ['.json', '_toc', 'assets'];
+const generatedHtmls = docs.filter(function(doc) {
+  for (const exclude of excludes) {
+    if (doc.includes(exclude)) {
+      return false;
+    }
+  }
+  return true;
+});
+
+for (const html of generatedHtmls) {
+  assert.ok(linkedHtmls.includes(html), `${html} is not linked in toc`);
+}