@bazel/jasmine

Jasmine rules for Bazel

WARNING: this is beta-quality software. Breaking changes are likely. Not recommended for production use without expert support.

The Jasmine rules run tests under the Jasmine framework with Bazel.

Installation

Add the @bazel/jasmine npm package to your devDependencies in package.json.

Your WORKSPACE should declare a yarn_install or npm_install rule named npm. It should then install the rules found in the npm packages using the install_bazel_dependencies function.

This causes the @bazel/jasmine package to be installed as a Bazel workspace named npm_bazel_jasmine.

jasmine_node_test

Runs tests in NodeJS using the Jasmine test runner.

To debug the test, see debugging notes in nodejs_test.

Usage

jasmine_node_test(name, srcs, data, deps, expected_exit_code, tags, config_file, coverage, jasmine, jasmine_entry_point, kwargs)

name

Name of the resulting label

srcs

JavaScript source files containing Jasmine specs

Defaults to []

data

Runtime dependencies which will be loaded while the test executes

Defaults to []

deps

Other targets which produce JavaScript, such as ts_library

Defaults to []

expected_exit_code

The expected exit code for the test.

Defaults to 0

tags

Bazel tags applied to test

Defaults to []

config_file

(experimental) label of a file containing Jasmine JSON config.

Note that not all configuration options are honored, and we expect some strange feature interations. For example, the filter for which files are instrumented for code coverage doesn't understand the spec_files setting in the config.

See https://jasmine.github.io/setup/nodejs.html#configuration

Defaults to None

coverage

Enables code coverage collection and reporting.

Defaults to False

jasmine

A label providing the @bazel/jasmine npm dependency.

Defaults to "@npm//@bazel/jasmine"

jasmine_entry_point

A label providing the @bazel/jasmine entry point.

Defaults to "@npm//:node_modules/@bazel/jasmine/jasmine_runner.js"

kwargs

Remaining arguments are passed to the test rule

Changelog

0.41.0 (2019-11-22)

To upgrade:

http_archive(
    name = "build_bazel_rules_nodejs",
    sha256 = "8dc1466f8563f3aa4ac7ab7aa3c96651eb7764108219f40b2d1c918e1a81c601",
    urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/0.41.0/rules_nodejs-0.41.0.tar.gz"],
)

and run yarn upgrade --scope @bazel to update all your @bazel-scoped npm packages to the latest versions. (or manually do the npm equivalent - they don't have a way to update a scope)

BREAKING CHANGES

As mentioned before, we are close to a 1.0 release, so we are making all our breaking changes now to prepare for a period of stability. Sorry for the long list this time!

• web_package rule has been renamed to pkg_web and is now a public API

Update your load statements from

load("@build_bazel_rules_nodejs//internal/web_package:web_package.bzl", "web_package")

to

load("@build_bazel_rules_nodejs//:index.bzl", "pkg_web")

• ts_devserver and pkg_web (previously web_package) no longer have an index_html attribute.

They expect an index.html file to be among the assets, and to already have the script and link tags needed for the app to work.

The feature where those tags were injected into the html dynamically has been moved to its own rule, inject_html.

We are in a transition state where the inject_html rule is not published, because we want this to be a plain npm package and not Bazel-specific. We will publish this functionality soon. If you depend on it, you may want to delay this upgrade.

• internal/rollup_bundle rule is removed. see https://github.com/bazelbuild/rules_nodejs/wiki for migration instructions

• Removed the expand_location_into_runfiles helper from //internal:node.bzl Load it from //internal/common:expand_into_runfiles instead

• npm karma deps for karma_web_test and karma_web_suite are now peer deps so that the versions used can be chosen by the user.

This PR also removes the built-in @io_bazel_rules_webtesting//browsers/sauce:chrome-win10 saucelabs support. It is not very useful as it only tests a single browser and it difficult to use. In the angular repo, saucelabs support was implemented with a custom karma config using karma_web_test. This is the recommended approach.

• --define=DEBUG=1 is no longer functional to request debugging outputs. Use -c dbg instead (this matches Bazel's behavior for C++).

• We renamed some of the generated targets in the @nodejs// workspace:

bazel run @nodejs//:npm is replaced with bazel run @nodejs//:npm_node_repositories and bazel run @nodejs//:yarn is replaced with bazel run @nodejs//:yarn_node_repositories. @nodejs//:yarn and @nodejs//:npm now run yarn & npm in the current working directory instead of on all of the package.json files in node_repositories().

@nodejs//:bin/node & @nodejs//:bin/node.cmd (on Windows) are no longer valid targets. Use @nodejs//:node instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/node.

@nodejs//:bin/yarn & @nodejs//:bin/yarn.cmd (on Windows) are no longer valid targets. Use @nodejs//:yarn instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/yarn.

@nodejs//:bin/npm & @nodejs//:bin/npm.cmd (on Windows) are no longer valid targets. Use @nodejs//:npm instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/npm.

Bug Fixes

• builtin: allow .tsx entry_point in node binary/test (313d484), closes #1351
• terser: call terser binary instead of uglifyjs (#1360) (a100420)
• terser: remove ngDevMode & ngI18nClosureMode global_defs from default terser config (98c8dbc)

chore

• remove deprecated re-export file (148bf8a)
• remove old rollup_bundle (9a824ac), closes #740

Code Refactoring

• move injector feature to own rule (be06d23)

Features

• node-patches\filesystem patcher. (#1332) (0b2f675)
• support --compilation_mode flag (9fa4343)
• builtin: rename @nodejs//:npm and @nodejs//:yarn to @nodejs//:[yarn/npm]_node_repositories (#1369) (01079a3)
• karma: npm peer deps & remove @rules_webtesting//browsers/sauce:chrome-win10 support (318bbf3)
• protractor: protractor npm package is now a peer deps (#1352) (5db7c8e)