Add mocha_test rule.

- Rule implementation.
- Add explanation in README.
- Adds transitive_node_modules to node_library.

Author: pcj

README.md

@@ -32,20 +32,8 @@ node_repositories()
 | [npm_repository](#npm_repository) | Install a set of npm dependencies. |
 | [node_library](#node_library) | Define a local npm module. |
 | [node_binary](#node_binary) | Build or execute a nodejs script. |
+| [mocha_test](#mocha_test) |  Run a mocha test script. |
 
-# Example
-
-```python
-load("@org_pubref_rules_node//node:rules.bzl", "node_binary")
-
-node_binary(
-    name = "foo",
-    main = "foo.js",
-    modules = [
-        "@npm_react_stack//:modules",
-    ],
-)
-```
 
 ## node_repositories
 
@@ -152,7 +140,46 @@ makes this very clean and convenient.
 ## node_binary
 
 Creates an executable script that will run the file named in the
-`main_script` attribute.  Paths to dependent `node_library` and
+`main` attribute.  Paths to dependent `node_library` and
 `@npm_repository//:modules` labels are used to construct a `NODE_PATH`
 environment variable that the `node` executable will use to fulfill
 `require` dependencies.
+
+```python
+load("@org_pubref_rules_node//node:rules.bzl", "node_binary")
+
+node_binary(
+    name = "foo",
+    main = "foo.js",
+    modules = [
+        "@npm_react_stack//:modules",
+    ],
+)
+```
+
+
+## mocha_test
+
+Runs a mocha test identified by the start script given in `main`.
+External modules dependencies can be listed in the `modules`
+attribute, while internal module dependencies are named in the `deps`
+attribute.  Additional arguments to the `mocha` script runner can be
+listed in the `mocha_args` attribute.
+
+```python
+load("@org_pubref_rules_node//node:rules.bzl", "mocha_test")
+
+mocha_test(
+    name = "foo_test",
+    main = "foo_test.js",
+    modules = [
+        "@npm_underscore//:modules",
+    ],
+    deps = [
+        "//examples/baz",
+    ],
+    mocha_args = [
+        "--reporter=dot",
+    ]
+)
+```

WORKSPACE

@@ -21,11 +21,19 @@ npm_repository(
 )
 
 npm_repository(
-    name = "npm_webpack",
+    name = "npm_mocha",
     deps = {
-        "webpack": "1.13.2",
+        "mocha": "3.1.0",
     },
-    sha256 = "705fac8595a57368185ac25f0a54bac475f4646285b4bc4af650ae754ac56e2b",
+    sha256 = "9b48987065bb42003bab81b4538afa9ac194d217d8e2e770a5cba782249f7dc8",
+)
+
+npm_repository(
+    name = "npm_underscore",
+    deps = {
+        "underscore": "1.8.3",
+    },
+    sha256 = "7c413345ad4f97024258e5d9fda40e26be0f2c2b73987d13f03352b5c489b1a8",
 )
 
 npm_repository(

examples/foo/BUILD

@@ -1,13 +1,24 @@
-load("//node:rules.bzl", "node_binary")
+load("//node:rules.bzl", "node_binary", "mocha_test")
 
 node_binary(
     name = "foo",
     main = "foo.js",
     modules = [
         "@npm_react_stack//:modules",
-        "@npm_glob//:modules",
     ],
     deps = [
         "//examples/baz",
     ]
 )
+
+mocha_test(
+    name = "foo_test",
+    main = "foo_test.js",
+    modules = ["@npm_underscore//:modules"],
+    deps = [
+        "//examples/baz",
+    ],
+    mocha_args = [
+        "--reporter=dot"
+    ]
+)

examples/foo/foo.js

@@ -1,7 +1,7 @@
 // stdlib dependency
 var process = require("process");
 // npm_repository module dependency
-var glob = require("glob");
+var react = require("react");
 // local module dependency
 var baz = require("examples-baz");
 // relative file dependency

examples/foo/foo_test.js

@@ -0,0 +1,27 @@
+var assert = require('assert');
+var baz = require('examples-baz');
+var _ = require('underscore');
+
+describe('Array', function() {
+  describe('#indexOf()', function() {
+    it('should return -1 when the value is not present', function() {
+      assert.equal(-1, [1,2,3].indexOf(4));
+    });
+  });
+});
+
+describe('baz', function() {
+  describe('#value', function() {
+    it('should return a function', function() {
+      assert.equal("function", typeof(baz));
+      //assert.ok(baz.indexOf("baz") != -1);
+    });
+    it('should resolve to string', function() {
+      assert.equal("string", typeof(baz()));
+      //assert.ok(baz.indexOf("baz") != -1);
+    });
+    it('should resolve to module name', function() {
+      assert.ok(baz().match(/.*[bB]az.*/));
+    });
+  });
+});

examples/webpack/BUILD

@@ -34,5 +34,5 @@ def dar_execute(ctx, dar_root=None):
         "--file", "%s=%s" % (dar_filename, dar_root),
     ]
 
-    print("dar: %s" % cmd)
+    #print("dar: %s" % cmd)
     return execute(ctx, cmd)

node/internal/dar.bzl

@@ -0,0 +1,138 @@
+_js_filetype = FileType([".js"])
+_modules_filetype = FileType(["node_modules"])
+
+BASH_TEMPLATE = """
+#!/usr/bin/env bash
+set -e
+
+# Resolve to 'this' node instance if other scripts
+# have '/usr/bin/env node' shebangs
+export PATH={node_bin_path}:$PATH
+
+# Used by NPM
+export NODE_PATH={node_paths}
+
+# Run it
+"{node}" "{mocha}" {mocha_args} "{script_path}" $@
+"""
+
+
+def _get_abs_sourcepath(file):
+    filename = str(file)
+    #print("filename: %s" % filename)
+    parts = filename.partition("[source]]")
+    prefix = parts[0][len("Artifact:["):]
+    suffix = parts[2]
+    d = "/".join([prefix, suffix])
+    #print("abs filename: %s" % d)
+    return d
+
+
+def _get_node_modules_dir_from_binfile(file):
+    bin = str(file)
+    parts = bin.partition("[source]]")
+    prefix = parts[0][len("Artifact:["):]
+    suffix_parts = parts[2].split("/")
+    #print("prefix: %s, suffix_parts: %s" % (prefix, suffix_parts))
+    return "/".join([prefix] + suffix_parts[0:2] + ["node_modules"])
+
+
+def _get_node_modules_dir_from_package_json(file):
+    filename = str(file)
+    parts = filename.split("]")
+    prefix = parts[0][len("Artifact:[["):]
+    middle = parts[1]
+    suffix = parts[2].split("/")
+    d = "/".join([prefix, middle] + suffix[0:-3] + ["node_modules"])
+    return d
+
+
+
+def mocha_test_impl(ctx):
+    inputs = []
+    srcs = []
+    script = ctx.file.main
+    node = ctx.file._node
+    mocha = ctx.file.mocha
+    node_paths = []
+    node_paths.append(_get_node_modules_dir_from_binfile(mocha))
+
+    mocha_path = _get_abs_sourcepath(mocha)
+
+    for file in ctx.files.modules:
+        #print("file: %s" % file)
+        if not file.basename.endswith("node_modules"):
+            fail("npm_dependency should be a path to a node_modules/ directory.")
+        node_paths += [_get_node_modules_dir_from_binfile(file)]
+
+    for dep in ctx.attr.deps:
+        lib = dep.node_library
+        srcs += lib.transitive_srcs
+        inputs += [lib.package_json, lib.npm_package_json]
+        node_paths += [_get_node_modules_dir_from_package_json(lib.package_json)]
+        for file in lib.transitive_node_modules:
+            node_paths += [file.path]
+            inputs.append(file)
+
+    node_paths = list(set(node_paths))
+
+    ctx.file_action(
+        output = ctx.outputs.executable,
+        executable = True,
+        content = BASH_TEMPLATE.format(
+            node_paths = ":".join(node_paths),
+            node = node.short_path,
+            node_bin_path = node.dirname,
+            script_path = script.short_path,
+            mocha = mocha_path,
+            mocha_args = " ".join(ctx.attr.mocha_args),
+        ),
+    )
+
+    #print("node_paths %s" % "\n".join(node_paths))
+
+    runfiles = [node, script] + inputs + srcs
+
+    return struct(
+        runfiles = ctx.runfiles(
+            files = runfiles,
+        ),
+    )
+
+
+mocha_test = rule(
+    mocha_test_impl,
+    attrs = {
+        "main": attr.label(
+            single_file = True,
+            allow_files = True,
+            #allow_files = _js_filetype,
+        ),
+        "data": attr.label_list(
+            allow_files = True,
+        ),
+        "deps": attr.label_list(
+            providers = ["node_library"],
+        ),
+        "modules": attr.label_list(
+            allow_files = _modules_filetype,
+        ),
+        "_node": attr.label(
+            default = Label("@org_pubref_rules_node_toolchain//:node_tool"),
+            single_file = True,
+            allow_files = True,
+            executable = True,
+            cfg = "host",
+        ),
+        "mocha": attr.label(
+            default = Label("@npm_mocha//:bin/mocha"),
+            allow_files = True,
+            single_file = True,
+        ),
+        "mocha_modules": attr.label(
+            default = Label("@npm_mocha//:modules"),
+        ),
+        "mocha_args": attr.string_list(),
+    },
+    test = True,
+)

node/internal/mocha_test.bzl

@@ -50,9 +50,11 @@ def node_binary_impl(ctx):
     for dep in ctx.attr.deps:
         lib = dep.node_library
         srcs += lib.transitive_srcs
-        inputs += [lib.package_json]
-        inputs += [lib.npm_package_json]
+        inputs += [lib.package_json, lib.npm_package_json]
         node_paths += [_get_node_modules_dir_from_package_json(lib.package_json)]
+        for file in lib.transitive_node_modules:
+            inputs.append(file)
+            node_paths += [file.path]
 
     node_paths = list(set(node_paths))
 

node/internal/node_binary.bzl

@@ -40,6 +40,8 @@ def _copy_to_namespace(base, file):
 def node_library_impl(ctx):
     node = ctx.executable._node
     npm = ctx.executable._npm
+    modules = ctx.attr.modules
+
     lib_name = _get_lib_name(ctx)
     stage_name = lib_name + ".npmfiles"
 
@@ -53,9 +55,7 @@ def node_library_impl(ctx):
     npm_package_json_file = ctx.new_file("lib/node_modules/%s/package.json" % lib_name)
 
     transitive_srcs = []
-
-    modules = ctx.attr.modules
-    transitive_modules = []
+    transitive_node_modules = []
 
     files = []
     for d in ctx.attr.data:
@@ -65,7 +65,7 @@ def node_library_impl(ctx):
     for dep in ctx.attr.deps:
         lib = dep.node_library
         transitive_srcs += lib.transitive_srcs
-        transitive_modules += lib.transitive_modules
+        transitive_node_modules += lib.transitive_node_modules
 
     ctx.template_action(
         template = package_json_template_file,
@@ -125,8 +125,7 @@ def node_library_impl(ctx):
             label = ctx.label,
             srcs = srcs,
             transitive_srcs = srcs + transitive_srcs,
-            modules = modules,
-            transitive_modules = modules + transitive_modules,
+            transitive_node_modules = ctx.files.modules + transitive_node_modules,
             package_json = npm_package_json_file,
             npm_package_json = npm_package_json_file,
         ),