Source code for fabtools.nodejs
"""
Node.js
=======
This module provides tools for installing `Node.js`_ and managing
packages using `npm`_.
.. note: the ``simplejson`` module is required on Python 2.5
.. _Node.js: http://nodejs.org/
.. _npm: http://npmjs.org/
"""
from __future__ import with_statement
try:
import json
except ImportError:
import simplejson as json
from fabric.api import run, cd, settings, hide
from fabtools.utils import run_as_root
DEFAULT_VERSION = '0.8.19'
[docs]def install_from_source(version=DEFAULT_VERSION):
"""
Install Node JS from source.
::
import fabtools
# Install Node.js
fabtools.nodejs.install_nodejs()
.. note:: This function may not work for old versions of Node.js.
"""
from fabtools import require
require.deb.packages([
'build-essential',
'python',
'libssl-dev',
])
filename = 'node-v%s.tar.gz' % version
foldername = filename[0:-7]
res = run('python -c "import multiprocessing ; print(multiprocessing.cpu_count())"')
cpus = int(res)
require.file(url='http://nodejs.org/dist/v%(version)s/%(filename)s' % {
'version': version,
'filename': filename,
})
run('tar -xzf %s' % filename)
with cd(foldername):
run('./configure')
run('make -j%d' % (cpus + 1))
run_as_root('make install')
run('rm -rf %(filename)s %(foldername)s' % locals())
[docs]def version():
"""
Get the version of Node.js currently installed.
Returns ``None`` if it is not installed.
"""
with settings(hide('running', 'stdout'), warn_only=True):
res = run('/usr/local/bin/node --version')
if res.failed:
return None
else:
return res[1:]
[docs]def install_package(package, version=None, local=False):
"""
Install a Node.js package.
If *local* is ``True``, the package will be installed locally.
::
import fabtools
# Install package globally
fabtools.nodejs.install_package('express')
# Install package locally
fabtools.nodejs.install_package('underscore', local=False)
"""
if version:
package += '@%s' % version
if local:
run('npm install -l %s' % package)
else:
run_as_root('HOME=/root npm install -g %s' % package)
[docs]def install_dependencies():
"""
Install Node.js package dependencies.
This function calls ``npm install``, which will locally install all
packages specified as dependencies in the ``package.json`` file
found in the current directory.
::
from fabric.api import cd
from fabtools import nodejs
with cd('/path/to/nodejsapp/'):
nodejs.install_dependencies()
"""
run('npm install')
[docs]def package_version(package, local=False):
"""
Get the installed version of a Node.js package.
Returns ``None``is the package is not installed. If *local* is
``True``, returns the version of the locally installed package.
"""
options = ['--json true', '--silent']
if local:
options.append('-l')
else:
options.append('-g')
options = ' '.join(options)
with hide('running', 'stdout'):
res = run('npm list %s' % options)
dependencies = json.loads(res)['dependencies']
pkg_data = dependencies.get(package)
if pkg_data:
return pkg_data['version']
else:
return None
[docs]def update_package(package, local=False):
"""
Update a Node.js package.
If *local* is ``True``, the package will be updated locally.
"""
if local:
run('npm update -l %s' % package)
else:
run_as_root('HOME=/root npm update -g %s' % package)
[docs]def uninstall_package(package, version=None, local=False):
"""
Uninstall a Node.js package.
If *local* is ``True``, the package will be uninstalled locally.
::
import fabtools
# Uninstall package globally
fabtools.nodejs.uninstall_package('express')
# Uninstall package locally
fabtools.nodejs.uninstall_package('underscore', local=False)
"""
if version:
package += '@%s' % version
if local:
run('npm uninstall -l %s' % package)
else:
run_as_root('HOME=/root npm uninstall -g %s' % package)