crypto | ||
patches | ||
src | ||
.gitignore | ||
avatar-js.gyp | ||
build.xml | ||
common.xml | ||
CONTRIBUTORS | ||
LICENSE | ||
project.properties | ||
README.md | ||
THIRD_PARTY_README | ||
win32-test-exclusions.txt |
Build Instructions
-
Setup build environment. Install a git client, jdk8, ant, python, C++ compiler and linker
- Install the latest jdk8u20
- Ensure ant is installed and
ant -version
is 1.8+ - Ensure python is installed and
python --version
is 2.7.5+
tip: python3 does not work - Ensure ant, jdk8, python and appropriate platform-specific C++ compiler and linker are in the
PATH
- If needed, install a git client for your OS. Windows users see below
- Extra steps for Windows users
- Install a unix emulation like cygwin or mingw/msys. If using Git for Windows, a version of msys is already included. This unix emulation provides the gnu diff and patch utilities.
- Install Microsoft Visual Studio. Any recent version should be OK (2010, 2012, 2013 have been known to work). Express versions will do.
- Ensure that link.exe is the one from Visual Studio and not from cygwin or mingw/msys.
- If a unix user, start
bash --login
from within a Visual Studio Command Prompt to ensure that the Visual Studio environment is inherited.
-
Download node.js source
git clone https://github.com/joyent/node.git source
cd source
git checkout v0.10.28
tip: rungit pull
to refresh the repo if you get an error saying that this version is unknowncd ..
-
Clone dependencies. Substitute
<id>
with your java.net id in the URLs below. Use the read-only URLs below if you do not have a java.net id. It is strongly recommended that all dependencies be cloned at the same level as node.js as in step 2.1 above-
git clone git://java.net/avatar-js~libuv-java libuv-java
(read-only)
git clone ssh://<id>@git.java.net/avatar-js~libuv-java libuv-java
-
git clone git://java.net/avatar-js~http-parser-java http-parser-java
(read-only)
git clone ssh://<id>@git.java.net/avatar-js~http-parser-java http-parser-java
-
git clone git://java.net/avatar-js~src avatar-js
(read-only)
git clone ssh://<id>@git.java.net/avatar-js~src avatar-js
-
Download test-ng. Unzip the downloaded bundle and place testng jar somewhere in your workspace
-
-
Edit
~/.avatar-js.properties
to set various locations. Ensure that there are no double slashes and no trailing slash, for examplesource.home = /ws/source
(from 2.1)
libuv.home = /ws/libuv-java
(from 3.1)
http-parser.home = /ws/http-parser-java
(from 3.2)
avatar-js.home = /ws/avatar-js
(from 3.3)
testng.jar = /ws/lib/testng.jar
(from 3.4) -
Setup your environment so that native libraries can be found
export LD_LIBRARY_PATH=$PWD/dist:$LD_LIBRARY_PATH
(linux)
export DYLD_LIBRARY_PATH=$PWD/dist:$DYLD_LIBRARY_PATH
(mac)
export PATH=%CWD%/dist;%PATH%
(windows) -
Configure
cd avatar-js
ant setup
-
Build
ant clean-all
ant jar-all
tip:ant -Dbuild.type=Release jar-all
builds the Release configuration -
Test
java -jar dist/avatar-js.jar src/test/js/test-runner.js test/simple
(runs the unit tests)
java -jar dist/avatar-js.jar src/test/js/test-runner.js test/crypto
(runs the crypto tests)
java -jar dist/avatar-js.jar src/test/js/test-runner.js -timeout 180 test/pummel
(runs the pummel tests)tip: Some crypto tests require Java Cryptography Extension Unlimited Jurisdiction Policy Files. Follow the instructions in the download. Files for Java7 work in Java8.
tip: Might need to set
LANG=en_US.UTF-8
tip:
test-runner.js
supports many options, run it with-help
or look at its source for more information -
Running applications. For example
java -jar dist/avatar-js.jar app.js
or
java -Djava.library.path=dist -jar dist/avatar-js.jar app.js
or
java -Xmx4g -Djava.library.path=dist -jar dist/avatar-js.jar app.js
Release Notes
-
Compatible with Node.js v0.10.28
-
Platforms tested. 32-bit variants have not been tested at all
- Ubuntu Linux x64
- Oracle Enterprise Linux x64
- Mac OS X Mountain Lion
- Windows 7 & 8 x64
-
Missing Features
- the
debugger
module is not supported
- the
-
Known failures
- some tests fail on windows. These are listed in
win32-test-exclusions.txt
with associated issue
- some tests fail on windows. These are listed in
-
Globals. Some additional globals are exposed
- javax.script.ScriptContext
__avatar
(non-iterable), a container for some avatar-specific globals for internal use
-
Limitations of the
vm
module. Objects loaded in a new context and accessed from the current context have some strong limitations -- Only a subset of JavaScript API is available on these objects
- equality (==, ===) will not work as expected
-
Limitations on
__proto__
__proto__
cannot be set toundefined
. Affects theejs
module used byexpress
-
No
const
keyword- the
const
keyword is not supported, replace withvar
. Affects themongodb
andgrunt
modules
- the
-
No signal handlers installed by default
- the JVM installs some of its own and we do not want to cause conflicts
- an app can install signal handlers as needed using
process.signals.start('SIGUSR1');
orprocess.signals.start(43);