Skip to content

Commit

Permalink
Provide grunt npm:test for verifying NPM package functionality.
Browse files Browse the repository at this point in the history
This basically calls `npm pack`, installs the resulting package in a temporary directory, then requires it and attempts to use the .transform method.

Closes facebook#12.
  • Loading branch information
benjamn committed May 31, 2013
1 parent 2d253fe commit 60a6665
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var jsxTask = require('./grunt/tasks/jsx');
var browserifyTask = require('./grunt/tasks/browserify');
var wrapupTask = require('./grunt/tasks/wrapup');
var phantomTask = require('./grunt/tasks/phantom');
var npmTask = require('./grunt/tasks/npm');
var releaseTasks = require('./grunt/tasks/release');

module.exports = function(grunt) {
Expand All @@ -16,6 +17,7 @@ module.exports = function(grunt) {
browserify: require('./grunt/config/browserify'),
wrapup: require('./grunt/config/wrapup'),
phantom: require('./grunt/config/phantom'),
npm: require('./grunt/config/npm'),
clean: ['./build', './*.gem', './docs/_site', './examples/shared/*.js'],
jshint: require('./grunt/config/jshint'),
compare_size: require('./grunt/config/compare_size')
Expand Down Expand Up @@ -44,6 +46,8 @@ module.exports = function(grunt) {

grunt.registerMultiTask('phantom', phantomTask);

grunt.registerMultiTask('npm', npmTask);

grunt.registerTask('build:basic', ['jsx:debug', 'browserify:basic']);
grunt.registerTask('build:transformer', ['jsx:debug', 'browserify:transformer']);
grunt.registerTask('build:min', ['jsx:release', 'browserify:min']);
Expand All @@ -54,6 +58,7 @@ module.exports = function(grunt) {
]);

grunt.registerTask('test', ['build:test', 'phantom:run']);
grunt.registerTask('npm:test', ['build', 'npm:pack']);

// Optimized build task that does all of our builds. The subtasks will be run
// in order so we can take advantage of that and only run jsx:debug once.
Expand Down
1 change: 1 addition & 0 deletions grunt/config/npm.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
exports.pack = {};
102 changes: 102 additions & 0 deletions grunt/tasks/npm.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
'use strict';

var assert = require("assert");
var path = require("path");
var fs = require("fs");
var tmp = require("tmp");
var grunt = require("grunt");
var spawn = grunt.util.spawn;

module.exports = function() {
var config = this.data;
var done = this.async();

function run(cmd, args, opts, callback) {
assert.strictEqual(typeof cmd, "string");
assert.ok(args instanceof Array);

if (typeof opts === "function" && !callback) {
callback = opts;
opts = {};
}

assert.strictEqual(typeof opts, "object");
assert.strictEqual(typeof callback, "function");

grunt.log.writeln("> " + cmd + " " + args.join(" "));

var proc = spawn({
cmd: cmd,
args: args,
opts: opts
}, function(error, result, code) {
if (error) {
grunt.log.error(error);
done(false);
} else {
callback(result, code);
}
});

// Uncomment these to see the output of the commands.
// proc.stdout.pipe(process.stdout);
// proc.stderr.pipe(process.stderr);
}

var pkg = grunt.config.data.pkg;
var tgz = pkg.name + "-" + pkg.version + ".tgz";

grunt.log.writeln("Packing " + tgz + " (this could take a while)...");

run("npm", ["pack", "--verbose", "."], function() {
tmp.dir(function(err, dir) {
if (err) {
grunt.log.error(err);
done(false);
return;
}

run("cp", [tgz, dir], function() {
run("npm", [
"install",
"--production",
tgz
], { cwd: dir }, function() {
var nodePath = path.join(dir, "node_modules");
var pkgDir = path.join(nodePath, pkg.name);
var doneCount = 2;

// Make sure that bin/jsx is runnable by echoing main.js.
run("bin/jsx", ["main.js"], {
cwd: pkgDir
}, function(result) {
assert.ok(result.stdout.indexOf("transform") >= 0, result.stdout);

if (--doneCount === 0) {
done();
}
});

// Make sure the .transform package method works.
run("node", [
"--print",
'require("react-tools").transform(' +
JSON.stringify(
"/** @jsx React.DOM */ <div>oyez</div>;"
) + ')'
], {
env: { NODE_PATH: nodePath }
}, function(result, code) {
assert.ok(result.stdout.indexOf(
'React.DOM.div(null, "oyez");'
) >= 0, result.stdout);

if (--doneCount === 0) {
done();
}
});
});
});
});
});
};
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"grunt-contrib-clean": "~0.4.1",
"grunt-compare-size": "~0.4.0",
"gzip-js": "~0.3.2",
"tmp": "~0.0.18",
"grunt-contrib-compress": "~0.5.1"
},
"preferGlobal": true
Expand Down

0 comments on commit 60a6665

Please sign in to comment.