build, test: skip addon build by default and test separately

joyeecheung · joyeecheung · commit 2ea0f678f80e · 2018-07-04T18:26:24.000+08:00
- Split tests to test/addon and test/plugin
- Skip building addons and running addon tests in nightly and
  canary builds in Travis
diff --git a/.travis.yml b/.travis.yml
@@ -7,26 +7,35 @@ matrix:
       before_install:
         - sudo apt-get -qq update
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
+      install: npm install --llnode_build_addon=true
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm test
       node_js: "6"
     - sudo: required
       dist: trusty
       before_install:
         - sudo apt-get -qq update
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
+      install: npm install --llnode_build_addon=true
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm test
       node_js: "8"
     - sudo: required
       dist: trusty
       before_install:
         - sudo apt-get -qq update
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
+      install: npm install --llnode_build_addon=true
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm test
       node_js: "9"
     - sudo: required
       dist: trusty
       before_install:
         - sudo apt-get -qq update
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
+      install: npm install --llnode_build_addon=true
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm test
       node_js: "10"
     # Test Node.js master nightly build
+    # Addon is not tested due to lack of node-addon-api
     - node_js: "node"
       sudo: required
       dist: trusty
@@ -35,10 +44,12 @@ matrix:
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
       install:
         - npm install --nodedir=$(dirname $(dirname $(which node)))/include/node
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm run test-plugin
       env:
         - NVM_NODEJS_ORG_MIRROR=https://nodejs.org/download/nightly
         - NODEJS_ORG_MIRROR=https://nodejs.org/download/nightly
     # Test Node.js v8-canary nightly build
+    # Addon is not tested due to lack of node-addon-api
     - node_js: "node"
       sudo: required
       dist: trusty
@@ -47,21 +58,30 @@ matrix:
         - sudo apt-get install lldb-3.9 liblldb-3.9-dev -y
       install:
         - npm install --nodedir=$(dirname $(dirname $(which node)))/include/node
+      script: TEST_LLDB_BINARY=`which lldb-3.9` npm run test-plugin
       env:
         - NVM_NODEJS_ORG_MIRROR=https://nodejs.org/download/v8-canary
         - NODEJS_ORG_MIRROR=https://nodejs.org/download/v8-canary
     # Test on OS X
     - os: osx
       osx_image: xcode9.3
+      install: npm install --llnode_build_addon=true
+      script: npm test
       node_js: "6"
     - os: osx
       osx_image: xcode9.3
+      install: npm install --llnode_build_addon=true
+      script: npm test
       node_js: "8"
     - os: osx
       osx_image: xcode9.3
+      install: npm install --llnode_build_addon=true
+      script: npm test
       node_js: "9"
     - os: osx
       osx_image: xcode9.3
+      install: npm install --llnode_build_addon=true
+      script: npm test
       node_js: "10"
   allow_failures:
     # Allow the nightly installs to fail
@@ -80,4 +100,3 @@ matrix:
 branches:
   only:
     - master
-script: make _travis
diff --git a/Makefile b/Makefile
@@ -1,5 +1,3 @@
-TEST_LLDB_BINARY ?= $(shell which lldb-3.9)
-
 .PHONY: all
 all:
 	@echo "Please take a look at README.md"
@@ -41,11 +39,6 @@ plugin: configure
 addon: configure
 	node-gyp rebuild
 
-.PHONY: _travis
-_travis:
-	TEST_LLDB_BINARY="$(TEST_LLDB_BINARY)" \
-	npm test
-
 .PHONY: clean
 clean:
 	$(RM) -r build
diff --git a/binding.gyp b/binding.gyp
@@ -8,7 +8,8 @@
       # gyp does not appear to let you test for undefined variables, so define
       # lldb_lib_dir as empty so we can test it later.
       "lldb_lib_dir%": "",
-      "lldb_lib_so%": ""
+      "lldb_lib_so%": "",
+      "build_addon": "false",
   },
 
   "target_defaults": {
@@ -85,47 +86,53 @@
         ],
       }]
     ]
-  }, {
-    "target_name": "addon",
-    "type": "loadable_module",
-    "include_dirs": [
-      "<!@(node -p \"require('node-addon-api').include\")"
-    ],
-    "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
-    "sources": [
-      "src/addon.cc",
-      "src/llnode_module.cc",
-      "src/llnode_api.cc",
-      "src/constants.cc",
-      "src/error.cc",
-      "src/llv8.cc",
-      "src/llv8-constants.cc",
-      "src/llscan.cc",
-      "src/node-constants.cc",
-    ],
-    "cflags!": [ "-fno-exceptions" ],
-    "cflags_cc!": [ "-fno-exceptions" ],
-    "conditions": [
-      [ "OS=='linux' or OS=='freebsd'", {
+  }],
+
+  "conditions": [
+    [ "build_addon == 'true'", {
+      "targets": [{
+        "target_name": "addon",
+        "type": "loadable_module",
+        "include_dirs": [
+          "<!@(node -p \"require('node-addon-api').include\")"
+        ],
+        "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
+        "sources": [
+          "src/addon.cc",
+          "src/llnode_module.cc",
+          "src/llnode_api.cc",
+          "src/constants.cc",
+          "src/error.cc",
+          "src/llv8.cc",
+          "src/llv8-constants.cc",
+          "src/llscan.cc",
+          "src/node-constants.cc",
+        ],
+        "cflags!": [ "-fno-exceptions" ],
+        "cflags_cc!": [ "-fno-exceptions" ],
         "conditions": [
-          # If we could not locate the lib dir, then we will have to search
-          # from the global search paths during linking and at runtime
-          [ "lldb_lib_dir != ''", {
-            "ldflags": [
-              "-L<(lldb_lib_dir)",
-              "-Wl,-rpath,<(lldb_lib_dir)"
+          [ "OS=='linux' or OS=='freebsd'", {
+            "conditions": [
+              # If we could not locate the lib dir, then we will have to search
+              # from the global search paths during linking and at runtime
+              [ "lldb_lib_dir != ''", {
+                "ldflags": [
+                  "-L<(lldb_lib_dir)",
+                  "-Wl,-rpath,<(lldb_lib_dir)"
+                ]
+              }],
+              # If we cannot find a non-versioned library liblldb(-x.y).so,
+              # then we will have to link to the versioned library
+              # liblldb(-x.y).so.z loaded by the detected lldb executable
+              [ "lldb_lib_so != ''", {
+                "libraries": ["<(lldb_lib_so)"]
+              }, {
+                "libraries": ["-l<(lldb_lib)"]
+              }]
             ]
-          }],
-          # If we cannot find a non-versioned library liblldb(-x.y).so,
-          # then we will have to link to the versioned library
-          # liblldb(-x.y).so.z loaded by the detected lldb executable
-          [ "lldb_lib_so != ''", {
-            "libraries": ["<(lldb_lib_so)"]
-          }, {
-            "libraries": ["-l<(lldb_lib)"]
           }]
         ]
       }]
-    ]
-  }]
+    }]
+  ]
 }
diff --git a/package.json b/package.json
@@ -13,7 +13,9 @@
     "preinstall": "node scripts/configure.js",
     "install": "node scripts/install.js",
     "postinstall": "node scripts/cleanup.js",
-    "test": "tape test/*-test.js"
+    "test-plugin": "tape test/plugin/*-test.js",
+    "test-addon": "tape test/addon/*-test.js",
+    "test": "npm run test-addon && npm run test-plugin"
   },
   "repository": {
     "type": "git",
diff --git a/scripts/configure.js b/scripts/configure.js
@@ -9,15 +9,27 @@ function main() {
   const buildDir = process.cwd();
   console.log('Build dir is: ' + buildDir);
   const osName = os.type();
-  const result = configureInstallation(osName, buildDir);
-  writeConfig(result.config);
-  writeLlnodeScript(buildDir, result.executable, osName);
+  const { config, executable } = configureInstallation(osName, buildDir);
+  configureBuildOptions(config);
+  writeConfig(config);
+  writeLlnodeScript(buildDir, executable, osName);
   // Exit with success.
   process.exit(0);
 }
 
 main();
 
+// Do not build addon by default until it's less experimental
+function configureBuildOptions(config) {
+  const build_addon = (process.env.npm_config_llnode_build_addon ||
+    process.env.LLNODE_BUILD_ADDON);
+  if (build_addon) {
+    config.variables.build_addon = build_addon;
+  } else {
+    config.variables.build_addon = 'false';
+  }
+}
+
 /**
  * Get and configure the lldb installation. The returned prefix
  * should be linked to ./lldb
diff --git a/test/addon/jsapi-test.js b/test/addon/jsapi-test.js
@@ -1,11 +1,11 @@
 'use strict';
 
-const fromCoredump = require('../').fromCoredump;
+const fromCoredump = require('../../').fromCoredump;
 
 const debug = process.env.TEST_LLNODE_DEBUG ?
   console.log.bind(console) : () => { };
 
-const common = require('./common');
+const common = require('../common');
 const tape = require('tape');
 
 tape('llnode API', (t) => {
diff --git a/test/plugin/frame-test.js b/test/plugin/frame-test.js
@@ -2,7 +2,7 @@
 
 const tape = require('tape');
 
-const common = require('./common');
+const common = require('../common');
 
 tape('v8 stack', (t) => {
   t.timeoutAfter(15000);
diff --git a/test/plugin/inspect-test.js b/test/plugin/inspect-test.js
@@ -2,7 +2,7 @@
 
 const tape = require('tape');
 
-const common = require('./common');
+const common = require('../common');
 
 // <Object: Object elements {
 const hashMapTests = {
diff --git a/test/plugin/scan-test.js b/test/plugin/scan-test.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const tape = require('tape');
-const common = require('./common');
+const common = require('../common');
 const versionMark = common.versionMark;
 
 tape('v8 findrefs and friends', (t) => {
diff --git a/test/plugin/stack-test.js b/test/plugin/stack-test.js
@@ -2,7 +2,7 @@
 
 const tape = require('tape');
 
-const common = require('./common');
+const common = require('../common');
 
 tape('v8 stack', (t) => {
   t.timeoutAfter(15000);
diff --git a/test/plugin/usage-test.js b/test/plugin/usage-test.js
@@ -1,6 +1,6 @@
 'use strict';
 const tape = require('tape');
-const common = require('./common');
+const common = require('../common');
 
 function containsLine(lines, re) {
   return lines.some(line => re.test(line.trim()));
