test: use addon.md block headings as test dir names

instead of doc-* PR-URL: #4412 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Johan Bergström <[email protected]>
nodejs · Jan 28, 2016 · f5783c8 · f5783c8
1 parent da1350b
commit f5783c8
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 19 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,5 +1,5 @@
 lib/punycode.js
-test/addons/doc-*/
+test/addons/??_*/
 test/fixtures
 test/**/node_modules
 test/disabled

diff --git a/.gitignore b/.gitignore
@@ -50,7 +50,7 @@ ipch/
 /npm.wxs
 /tools/msvs/npm.wixobj
 /tools/osx-pkg.pmdoc/index.xml
-/test/addons/doc-*/
+/test/addons/??_*/
 email.md
 deps/v8-*
 deps/icu

diff --git a/Makefile b/Makefile
@@ -105,12 +105,12 @@ test/gc/node_modules/weak/build/Release/weakref.node: $(NODE_EXE)
 
 # Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
 test/addons/.docbuildstamp: doc/api/addons.markdown
-	$(RM) -r test/addons/doc-*/
+	$(RM) -r test/addons/??_*/
 	$(NODE) tools/doc/addon-verify.js
 	touch $@
 
 ADDONS_BINDING_GYPS := \
-	$(filter-out test/addons/doc-*/binding.gyp, \
+	$(filter-out test/addons/??_*/binding.gyp, \
 		$(wildcard test/addons/*/binding.gyp))
 
 # Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
@@ -520,7 +520,7 @@ CPPLINT_EXCLUDE += src/node_win32_perfctr_provider.cc
 CPPLINT_EXCLUDE += src/queue.h
 CPPLINT_EXCLUDE += src/tree.h
 CPPLINT_EXCLUDE += src/v8abbr.h
-CPPLINT_EXCLUDE += $(wildcard test/addons/doc-*/*.cc test/addons/doc-*/*.h)
+CPPLINT_EXCLUDE += $(wildcard test/addons/??_*/*.cc test/addons/??_*/*.h)
 
 CPPLINT_FILES = $(filter-out $(CPPLINT_EXCLUDE), $(wildcard \
 	deps/debugger-agent/include/* \

diff --git a/tools/doc/addon-verify.js b/tools/doc/addon-verify.js
@@ -1,31 +1,36 @@
-var fs = require('fs');
-var path = require('path');
-var marked = require('marked');
+'use strict';
 
-var doc = path.resolve(__dirname, '..', '..', 'doc', 'api', 'addons.markdown');
-var verifyDir = path.resolve(__dirname, '..', '..', 'test', 'addons');
+const fs = require('fs');
+const path = require('path');
+const marked = require('marked');
 
-var contents = fs.readFileSync(doc).toString();
+const doc = path.resolve(__dirname, '..', '..', 'doc', 'api', 'addons.markdown');
+const verifyDir = path.resolve(__dirname, '..', '..', 'test', 'addons');
 
-var tokens = marked.lexer(contents, {});
-var files = null;
-var id = 0;
+const contents = fs.readFileSync(doc).toString();
+
+let tokens = marked.lexer(contents, {});
+let files = null;
+let blockName;
+let id = 0;
 
 // Just to make sure that all examples will be processed
 tokens.push({ type: 'heading' });
 
 var oldDirs = fs.readdirSync(verifyDir);
 oldDirs = oldDirs.filter(function(dir) {
-  return /^doc-/.test(dir);
+  return /^\d{2}_/.test(dir);
 }).map(function(dir) {
   return path.resolve(verifyDir, dir);
 });
 
 for (var i = 0; i < tokens.length; i++) {
   var token = tokens[i];
-  if (token.type === 'heading') {
+  if (token.type === 'heading' && token.text) {
+    blockName = token.text
     if (files && Object.keys(files).length !== 0) {
       verifyFiles(files,
+                  blockName,
                   console.log.bind(null, 'wrote'),
                   function(err) { if (err) throw err; });
     }
@@ -48,15 +53,16 @@ function once(fn) {
   };
 }
 
-function verifyFiles(files, onprogress, ondone) {
-  var dir = path.resolve(verifyDir, 'doc-' + id++);
-
+function verifyFiles(files, blockName, onprogress, ondone) {
   // must have a .cc and a .js to be a valid test
   if (!Object.keys(files).some((name) => /\.cc$/.test(name)) ||
       !Object.keys(files).some((name) => /\.js$/.test(name))) {
     return;
   }
 
+  blockName = blockName.toLowerCase().replace(/\s/g, '_').replace(/[^a-z\d_]/g, '')
+  let dir = path.resolve(verifyDir, `${(++id < 10 ? '0' : '') + id}_${blockName}`);
+
   files = Object.keys(files).map(function(name) {
     return {
       path: path.resolve(dir, name),