test: added test case to check the addon building process.

.gitignore

@@ -2,3 +2,4 @@
 /build
 /benchmark/build
 /benchmark/src
+/test/addon_build/addons

common.gypi

@@ -15,7 +15,7 @@
       }
     }]
   ],
-  'include_dirs': ["<!@(node -p \"require('../').include\")"],
+  'include_dirs': ["<!(node -p \"require('../').include_dir\")"],
   'cflags': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ],
   'cflags_cc': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ]
 }

doc/setup.md

@@ -26,7 +26,7 @@ To use **N-API** in a native module:
   2. Reference this package's include directory and gyp file in `binding.gyp`:
 
 ```gyp
-  'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"],
+  'include_dirs': ["<!(node -p \"require('node-addon-api').include_dir\")"],
 ```
 
   3. Decide whether the package will enable C++ exceptions in the N-API wrapper.

index.js

@@ -1,10 +1,11 @@
 const path = require('path');
 
-const include = path.relative('.', __dirname);
+const include_dir = path.relative('.', __dirname);
 
 module.exports = {
-  include: include,
-  gyp: path.join(include, 'node_api.gyp:nothing'),
+  include: `"${__dirname}"`, // deprecated, can be removed as part of 4.0.0
+  include_dir,
+  gyp: path.join(include_dir, 'node_api.gyp:nothing'),
   isNodeApiBuiltin: true,
   needsFlag: false
 };

package.json

@@ -252,6 +252,7 @@
   "description": "Node.js API (N-API)",
   "devDependencies": {
     "benchmark": "^2.1.4",
+    "fs-extra": "^9.0.1",
     "bindings": "^1.5.0",
     "safe-buffer": "^5.1.1"
   },

test/addon_build/index.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const { promisify } = require('util');
+const  exec  = promisify(require('child_process').exec);
+const { copy, remove } = require('fs-extra');
+const path = require('path');
+const assert = require('assert')
+
+const ADDONS_FOLDER = path.join(__dirname, 'addons');
+
+const addons = [
+  'echo addon',
+  'echo-addon'
+]
+
+async function beforeAll(addons) {
+  console.log('   >Preparing native addons to build')
+  for (const addon of addons) {
+    await remove(path.join(ADDONS_FOLDER, addon));
+    await copy(path.join(__dirname, 'tpl'), path.join(ADDONS_FOLDER, addon));
+  }
+}
+
+async function test(addon) {
+  console.log(`   >Building addon: '${addon}'`);
+  const { stderr, stdout } = await exec('npm install', {
+    cwd: path.join(ADDONS_FOLDER, addon)
+  })
+  console.log(`   >Runting test for: '${addon}'`);
+  // Disabled the checks on stderr and stdout because of this issuue on npm:
+  // Stop using process.umask(): https://github.com/npm/cli/issues/1103
+  // We should enable the following checks again after the resolution of 
+  // the reported issue.
+  // assert.strictEqual(stderr, '');
+  // assert.ok(stderr.length === 0);
+  // assert.ok(stdout.length > 0);
+  const binding = require(`${ADDONS_FOLDER}/${addon}`);
+  assert.strictEqual(binding.except.echo('except'), 'except');
+  assert.strictEqual(binding.except.echo(101), 101);
+  assert.strictEqual(binding.noexcept.echo('noexcept'), 'noexcept');
+  assert.strictEqual(binding.noexcept.echo(103), 103);
+}
+
+
+module.exports = (async function() {
+  await beforeAll(addons);
+  for (const addon of addons) {
+    await test(addon);
+  }
+})()

test/addon_build/tpl/.npmrc

@@ -0,0 +1 @@
+package-lock=false

test/addon_build/tpl/addon.cc

@@ -0,0 +1,17 @@
+#include <napi.h>
+
+Napi::Value Echo(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  if (info.Length() != 1) {
+    Napi::TypeError::New(env, "Wrong number of arguments. One argument expected.")
+        .ThrowAsJavaScriptException();
+  }
+  return info[0].As<Napi::Value>();
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  exports.Set(Napi::String::New(env, "echo"), Napi::Function::New(env, Echo));
+  return exports;
+}
+
+NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)

test/addon_build/tpl/binding.gyp

@@ -0,0 +1,62 @@
+{
+  'target_defaults': {
+    'include_dirs': [
+        "<!(node -p \"require('node-addon-api').include_dir\")"
+    ],
+    'variables': {
+      'NAPI_VERSION%': "<!(node -p \"process.versions.napi\")",
+      'disable_deprecated': "<!(node -p \"process.env['npm_config_disable_deprecated']\")"
+    },
+    'conditions': [
+      ['NAPI_VERSION!=""', { 'defines': ['NAPI_VERSION=<@(NAPI_VERSION)'] } ],
+      ['disable_deprecated=="true"', {
+        'defines': ['NODE_ADDON_API_DISABLE_DEPRECATED']
+      }],
+      ['OS=="mac"', {
+        'cflags+': ['-fvisibility=hidden'],
+        'xcode_settings': {
+          'OTHER_CFLAGS': ['-fvisibility=hidden']
+        }
+      }]
+    ],
+    'sources': [
+      'addon.cc',
+    ],  
+  },
+  'targets': [
+    {
+      'target_name': 'addon',
+      'defines': [ 'NAPI_CPP_EXCEPTIONS' ],
+      'cflags!': [ '-fno-exceptions' ],
+      'cflags_cc!': [ '-fno-exceptions' ],
+      'msvs_settings': {
+        'VCCLCompilerTool': {
+          'ExceptionHandling': 1,
+          'EnablePREfast': 'true',
+        },
+      },
+      'xcode_settings': {
+        'CLANG_CXX_LIBRARY': 'libc++',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7',
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+      },
+    },
+    {
+      'target_name': 'addon_noexcept',
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+      'cflags': [ '-fno-exceptions' ],
+      'cflags_cc': [ '-fno-exceptions' ],
+      'msvs_settings': {
+        'VCCLCompilerTool': {
+          'ExceptionHandling': 0,
+          'EnablePREfast': 'true',
+        },
+      },
+      'xcode_settings': {
+        'CLANG_CXX_LIBRARY': 'libc++',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7',
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'NO',
+      },
+    },
+  ],
+}

test/addon_build/tpl/index.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const except = require('bindings')('addon')
+const noexcept = require('bindings')('addon_noexcept')
+
+module.exports = {
+  except,
+  noexcept
+}
+

test/addon_build/tpl/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "addon",
+  "version": "0.0.0",
+  "description": "Node.js addon",
+  "private": true,
+  "scripts": {},
+  "dependencies": {
+    "node-addon-api": "file:../../../../"
+  },
+  "gypfile": true
+}

test/index.js

@@ -8,6 +8,7 @@ process.config.target_defaults.default_configuration =
 // FIXME: We might need a way to load test modules automatically without
 // explicit declaration as follows.
 let testModules = [
+  'addon_build',
   'addon',
   'addon_data',
   'arraybuffer',

tools/conversion.js

@@ -22,8 +22,8 @@ if (disable != "--disable" && dir != "--disable") {
        [ /[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '' ]
     ],
     'binding.gyp': [
-       [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!@(node -p "require(\\\'node-addon-api\\\').include")\',' ],
-       [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!@(node -p \\"require(\'node-addon-api\').include\\")",' ],
+       [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\',' ],
+       [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!(node -p \\"require(\'node-addon-api\').include_dir\\")",' ],
        [ /[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, '' ],
        [ /([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n      $2cflags!$2: [ $2-fno-exceptions$2 ],\n      $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n      $2xcode_settings$2: { $2GCC_ENABLE_CPP_EXCEPTIONS$2: $2YES$2,\n        $2CLANG_CXX_LIBRARY$2: $2libc++$2,\n        $2MACOSX_DEPLOYMENT_TARGET$2: $210.7$2,\n      },\n      $2msvs_settings$2: {\n        $2VCCLCompilerTool$2: { $2ExceptionHandling$2: 1 },\n      },' ],
     ]
@@ -35,8 +35,8 @@ if (disable != "--disable" && dir != "--disable") {
       [ /[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '' ]
     ],
     'binding.gyp': [
-      [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!@(node -p "require(\\\'node-addon-api\\\').include")\',' ],
-      [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!@(node -p \'require(\\\"node-addon-api\\\").include\')",' ],
+      [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\',' ],
+      [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!(node -p \'require(\\\"node-addon-api\\\").include_dir\')",' ],
       [ /[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, '' ],
       [ /([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n      $2cflags!$2: [ $2-fno-exceptions$2 ],\n      $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n      $2defines$2: [ $2NAPI_DISABLE_CPP_EXCEPTIONS$2 ],\n      $2conditions$2: [\n        [\'OS==\"win\"\', { $2defines$2: [ $2_HAS_EXCEPTIONS=1$2 ] }]\n      ]' ],
     ]