Adds in a BUILD_ONLY environment variable

tbranyen · John Haley · commit 9432ae05ac6c · 2014-11-24T16:44:24.000-07:00
By default the module will attempt to install from a prebuilt binary
from S3.  If this fails it will attempt a native compile.

For our continuous integration and local development we'll always run
with `BUILD_ONLY=true`.
diff --git a/.travis.yml b/.travis.yml
@@ -14,7 +14,7 @@ before_install:
       export CXX='g++-4.8';
     fi
   - "export JOBS=4"
-  - npm install
+  - BUILD_ONLY=true npm install
 # This is a random private key used purely for testing.
 before_script:
  - echo -e "Host *\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
diff --git a/appveyor.yml b/appveyor.yml
@@ -27,6 +27,7 @@ install:
   - cmd: SET PATH=C:\Program Files (x86)\MSBuild\12.0\bin\;%PATH%
   - cmd: SET PATH=c:\python27;%PATH%
   - cmd: SET JOBS=4
+  - cmd: SET BUILD_ONLY=true
   - cmd: SET GIT_SSH=c:\projects\nodegit\vendor\plink.exe
   - ps: Start-Process c:\projects\nodegit\vendor\pageant.exe c:\projects\nodegit\vendor\private.ppk
   - cmd: npm install -g node-gyp
diff --git a/generate/index.js b/generate/index.js
@@ -100,7 +100,9 @@ fse.remove(path.resolve(__dirname, "../src")).then(function() {
       }
     }
     catch (e) {
-      console.log(e);
+      if (process.env.BUILD_ONLY) {
+        console.log(e);
+      }
     }
   });
 
diff --git a/generate/setup.js b/generate/setup.js
@@ -58,12 +58,16 @@ libgit2.types.forEach(function(current) {
 var previous = "";
 enums = _(enums).sortBy("name").reduce(function(enumMemo, enumerable) {
   if (previous == enumerable.typeName) {
-    console.log('WARNING: duplicate definition for enum ' + enumerable.typeName +
-      ". skipped.");
+    if (process.env.BUILD_ONLY) {
+      console.warn('Duplicate definition for enum ' + enumerable.typeName +
+        ". skipped.");
+    }
   }
   else if (!enumerable.fields) {
-    console.log('WARNING: incomplete definition for enum ' + enumerable.typeName +
-      ". skipped.");
+    if (process.env.BUILD_ONLY) {
+      console.warn('Incomplete definition for enum ' + enumerable.typeName +
+        ". skipped.");
+    }
   }
   else {
     enumMemo[enumerable.typeName] = {
diff --git a/generate/utils.js b/generate/utils.js
@@ -136,7 +136,9 @@ var Utils = {
       _.merge(field, callbackDefs[field.type]);
     }
     else {
-      console.log("WARNING: Couldn't find callback definition for " + field.type);
+      if (process.env.BUILD_ONLY) {
+        console.warn("Couldn't find callback definition for " + field.type);
+      }
     }
   },
 
diff --git a/install.js b/install.js
@@ -10,13 +10,8 @@ var which = require("which");
 var rimraf = require("rimraf");
 var NODE_VERSION = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 
-// If the build only flag is set
-var buildOnly = process.argv.indexOf("--build-only") > -1;
-
-if (buildOnly) {
-  console.log("buildOnly");
-  return;
-}
+// If the build only flag is set.
+var buildOnly = process.env.BUILD_ONLY;
 
 // This will take in an object and find any matching keys in the environment
 // to use as overrides.
@@ -71,13 +66,34 @@ if (NODE_VERSION === 0.1) {
   pkg.http_parser = pkg.http_parser["0.10"];
 }
 
-// Ensure all dependencies are available.
-var dependencies = Q.allSettled([
-  // This will prioritize `python2` over `python`, because we always want to
-  // work with Python 2.* if it"s available.
-  Q.nfcall(which, "python2"),
-  Q.nfcall(which, "python")
-])
+// Attempt to fallback on a prebuilt binary.
+function fetchPrebuilt() {
+  if (!buildOnly) {
+    console.info("[nodegit] Fetching binary from S3.");
+
+    // Using the node-pre-gyp module, attempt to fetch a compatible build.
+    return Q.nfcall(exec, "node-pre-gyp install");
+  }
+
+  throw new Error("Build only");
+}
+
+// Attempt to fetch prebuilt binary.
+Q.ninvoke(fs, "mkdir", paths.release).then(fetchPrebuilt, fetchPrebuilt)
+
+.fail(function() {
+  if (!buildOnly) {
+    console.info("[nodegit] Failed to install prebuilt, attempting compile.");
+  }
+
+  // Ensure all dependencies are available.
+  return Q.allSettled([
+    // This will prioritize `python2` over `python`, because we always want to
+    // work with Python 2.* if it"s available.
+    Q.nfcall(which, "python2"),
+    Q.nfcall(which, "python")
+  ])
+})
 
 // Determine if all the dependency requirements are met.
 .then(function(results) {
@@ -226,25 +242,6 @@ var dependencies = Q.allSettled([
   });
 })
 
-// Attempt to fallback on a prebuilt binary.
-.fail(function(message) {
-  console.info("[nodegit] Failed to build nodegit.");
-  console.info("[nodegit] Attempting to fallback on a prebuilt binary.");
-
-  console.log(message.stack);
-
-  function fetchPrebuilt() {
-    console.info("[nodegit] Fetching binary from S3.");
-
-    // Using the node-pre-gyp module, attempt to fetch a compatible build.
-    return Q.nfcall(exec, "node-pre-gyp install");
-  }
-
-  // Attempt to fetch prebuilt binary.
-  return Q.ninvoke(fs, "mkdir", paths.release)
-    .then(fetchPrebuilt, fetchPrebuilt);
-})
-
 // Display a warning message about failing to build native node module.
 .fail(function(message) {
   console.info("[nodegit] Failed to build and install nodegit.");
diff --git a/package.json b/package.json
@@ -96,6 +96,6 @@
     "publish": "node-pre-gyp package && node-pre-gyp publish",
     "generate": "node generate/setup && node generate",
     "install": "npm run generate && node install",
-    "rebuild": "npm run generate && node-gyp configure build"
+    "rebuild": "BUILD_ONLY=true npm run generate && node-gyp configure build"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,9 @@ fse.remove(path.resolve(__dirname, "../src")).then(function() {`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`	`catch (e) {`
`103`		`- console.log(e);`
	`103`	`+ if (process.env.BUILD_ONLY) {`
	`104`	`+ console.log(e);`
	`105`	`+ }`
`104`	`106`	`}`
`105`	`107`	`});`
`106`	`108`
Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,9 @@ var Utils = {`
`136`	`136`	`_.merge(field, callbackDefs[field.type]);`
`137`	`137`	`}`
`138`	`138`	`else {`
`139`		`- console.log("WARNING: Couldn't find callback definition for " + field.type);`
	`139`	`+ if (process.env.BUILD_ONLY) {`
	`140`	`+ console.warn("Couldn't find callback definition for " + field.type);`
	`141`	`+ }`
`140`	`142`	`}`
`141`	`143`	`},`
`142`	`144`
Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,6 @@`
`96`	`96`	`"publish": "node-pre-gyp package && node-pre-gyp publish",`
`97`	`97`	`"generate": "node generate/setup && node generate",`
`98`	`98`	`"install": "npm run generate && node install",`
`99`		`- "rebuild": "npm run generate && node-gyp configure build"`
	`99`	`+ "rebuild": "BUILD_ONLY=true npm run generate && node-gyp configure build"`
`100`	`100`	`}`
`101`	`101`	`}`