Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Windows support for installing node and npm from prebuilt #173

Merged
merged 2 commits into from
Dec 7, 2016
Merged

Fix Windows support for installing node and npm from prebuilt #173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
487f5b9
Fix Windows support for installing node and npm from prebuilt
gegenschall Nov 8, 2016
c626d74
Revert unintended change to copy_node_from_prebuilt
Nov 8, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 141 additions & 60 deletions nodeenv.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
import tarfile
import pipes
import platform
import zipfile
import shutil

try: # pragma: no cover (py2 only)
from ConfigParser import SafeConfigParser as ConfigParser
Expand Down Expand Up @@ -84,7 +86,7 @@ class Config(object):
# Defaults
node = 'latest'
npm = 'latest'
with_npm = False
with_npm = True if is_WIN else False
jobs = '2'
without_ssl = False
debug = False
Expand Down Expand Up @@ -222,15 +224,42 @@ def parse_args(check=True):
action='store_true', dest='io', default=False,
help='Use iojs instead of nodejs.')

parser.add_option(
'-j', '--jobs', dest='jobs', default=Config.jobs,
help='Sets number of parallel commands at node.js compilation. '
'The default is 2 jobs.')
if not is_WIN:
parser.add_option(
'-j', '--jobs', dest='jobs', default=Config.jobs,
help='Sets number of parallel commands at node.js compilation. '
'The default is 2 jobs.')

parser.add_option(
'--load-average', dest='load_average',
help='Sets maximum load average for executing parallel commands '
'at node.js compilation.')
parser.add_option(
'--load-average', dest='load_average',
help='Sets maximum load average for executing parallel commands '
'at node.js compilation.')

parser.add_option(
'--without-ssl', dest='without_ssl',
action='store_true', default=Config.without_ssl,
help='Build node.js without SSL support')

parser.add_option(
'--debug', dest='debug',
action='store_true', default=Config.debug,
help='Build debug variant of the node.js')

parser.add_option(
'--profile', dest='profile',
action='store_true', default=Config.profile,
help='Enable profiling for node.js')

parser.add_option(
'--make', '-m', dest='make_path',
metavar='MAKE_PATH',
help='Path to make command',
default=Config.make)

parser.add_option(
'--source', dest='prebuilt',
action='store_false', default=Config.prebuilt,
help='Install node.js from the source')

parser.add_option(
'-v', '--verbose',
Expand Down Expand Up @@ -266,27 +295,12 @@ def parse_args(check=True):
action='store_true', default=False,
help='Install npm packages from file without node')

parser.add_option(
'--without-ssl', dest='without_ssl',
action='store_true', default=Config.without_ssl,
help='Build node.js without SSL support')

parser.add_option(
'--debug', dest='debug',
action='store_true', default=Config.debug,
help='Build debug variant of the node.js')

parser.add_option(
'--profile', dest='profile',
action='store_true', default=Config.profile,
help='Enable profiling for node.js')

parser.add_option(
'--with-npm', dest='with_npm',
action='store_true', default=Config.with_npm,
help='Build without installing npm into the new virtual environment. '
'Required for node.js < 0.6.3. By default, the npm included with '
'node.js is used.')
'node.js is used. Under Windows, this defaults to true.')

parser.add_option(
'--npm', dest='npm',
Expand Down Expand Up @@ -316,22 +330,11 @@ def parse_args(check=True):
action='store_true', default=False,
help='Force installation in a pre-existing directory')

parser.add_option(
'--make', '-m', dest='make_path',
metavar='MAKE_PATH',
help='Path to make command',
default=Config.make)

parser.add_option(
'--prebuilt', dest='prebuilt',
action='store_true', default=Config.prebuilt,
help='Install node.js from prebuilt package (default)')

parser.add_option(
'--source', dest='prebuilt',
action='store_false', default=Config.prebuilt,
help='Install node.js from the source')

options, args = parser.parse_args()
if options.config_file is None:
options.config_file = ["./setup.cfg", "~/.nodeenvrc"]
Expand Down Expand Up @@ -378,7 +381,7 @@ def writefile(dest, content, overwrite=True, append=False):
mode_0755 = (stat.S_IRWXU | stat.S_IXGRP |
stat.S_IRGRP | stat.S_IROTH | stat.S_IXOTH)
content = to_utf8(content)
if is_PY3:
if is_PY3 and type(content) != bytes:
content = bytes(content, 'utf-8')
if not os.path.exists(dest):
logger.debug(' * Writing %s ... ', dest, extra=dict(continued=True))
Expand All @@ -402,9 +405,9 @@ def writefile(dest, content, overwrite=True, append=False):
if append:
logger.info(' * Appending data to %s', dest)
with open(dest, 'ab') as f:
f.write(DISABLE_PROMPT.encode('utf-8'))
if not is_WIN: f.write(DISABLE_PROMPT.encode('utf-8'))
f.write(content)
f.write(ENABLE_PROMPT.encode('utf-8'))
if not is_WIN: f.write(ENABLE_PROMPT.encode('utf-8'))
return

logger.info(' * Overwriting %s with new content', dest)
Expand Down Expand Up @@ -524,18 +527,22 @@ def download_node_src(node_url, src_dir, opt, prefix):
Download source code
"""
logger.info('.', extra=dict(continued=True))
tar_contents = io.BytesIO(urlopen(node_url).read())
dl_contents = io.BytesIO(urlopen(node_url).read())
logger.info('.', extra=dict(continued=True))
with tarfile_open(fileobj=tar_contents) as tarfile_obj:
member_list = tarfile_obj.getmembers()
extract_list = []
for member in member_list:
node_ver = opt.node.replace('.', '\.')
regex_string = "%s-v%s[^/]*/(README\.md|CHANGELOG\.md|LICENSE)" \
% (prefix, node_ver)
if re.match(regex_string, member.name) is None:
extract_list.append(member)
tarfile_obj.extractall(src_dir, extract_list)

if is_WIN:
writefile(join(src_dir, 'node.exe'), dl_contents.read())
else:
with tarfile_open(fileobj=dl_contents) as tarfile_obj:
member_list = tarfile_obj.getmembers()
extract_list = []
for member in member_list:
node_ver = opt.node.replace('.', '\.')
regex_string = "%s-v%s[^/]*/(README\.md|CHANGELOG\.md|LICENSE)" \
% (prefix, node_ver)
if re.match(regex_string, member.name) is None:
extract_list.append(member)
tarfile_obj.extractall(src_dir, extract_list)


def urlopen(url):
Expand All @@ -554,7 +561,10 @@ def copy_node_from_prebuilt(env_dir, src_dir):
"""
logger.info('.', extra=dict(continued=True))
prefix = get_binary_prefix()
callit(['cp', '-a', src_dir + '/%s-v*/*' % prefix, env_dir], True, env_dir)
if is_WIN:
callit(['copy', '/Y', '/L', join(src_dir, 'node.exe'), join(env_dir, 'Scripts', 'node.exe')], False, True)
else:
callit(['cp', '-a', src_dir + '/%s-v*/*' % prefix, env_dir], True, env_dir)
logger.info('.', extra=dict(continued=True))


Expand Down Expand Up @@ -680,6 +690,35 @@ def install_npm(env_dir, src_dir, opt):
logger.info('done.')


def install_npm_win(env_dir, src_dir, opt):
"""
Download source code for npm, unpack it
and install it in virtual environment.
"""
logger.info(' * Install npm.js (%s) ... ' % opt.npm,
extra=dict(continued=True))
npm_contents = io.BytesIO(urlopen('https://github.com/npm/npm/archive/%s.zip' % opt.npm).read())

bin_path = join(env_dir, 'Scripts')
node_modules_path = join(bin_path, 'node_modules', 'npm')

if os.path.exists(node_modules_path):
shutil.rmtree(node_modules_path)

if os.path.exists(join(bin_path, 'npm.cmd')):
os.remove(join(bin_path, 'npm.cmd'))

if os.path.exists(join(bin_path, 'npm-cli.js')):
os.remove(join(bin_path, 'npm-cli.js'))

with zipfile.ZipFile(npm_contents, 'r') as zipf:
zipf.extractall(src_dir)

shutil.copytree(join(src_dir, 'npm-%s' % opt.npm), node_modules_path)
shutil.copy(join(src_dir, 'npm-%s' % opt.npm, 'bin', 'npm.cmd'), join(bin_path, 'npm.cmd'))
shutil.copy(join(src_dir, 'npm-%s' % opt.npm, 'bin', 'npm-cli.js'), join(bin_path, 'npm-cli.js'))


def install_packages(env_dir, opt):
"""
Install node.js packages via npm
Expand Down Expand Up @@ -711,15 +750,23 @@ def install_activate(env_dir, opt):
"""
Install virtual environment activation script
"""
files = {'activate': ACTIVATE_SH, 'shim': SHIM}
if is_WIN:
files = {'activate.bat': ACTIVATE_BAT}
bin_dir = join(env_dir, 'Scripts')
shim_node = join(bin_dir, "node.exe")
shim_nodejs = join(bin_dir, "nodejs.exe")
else:
files = {'activate': ACTIVATE_SH, 'shim': SHIM}
bin_dir = join(env_dir, 'bin')
shim_node = join(bin_dir, "node")
shim_nodejs = join(bin_dir, "nodejs")

if opt.node == "system":
files["node"] = SHIM
bin_dir = join(env_dir, 'bin')

mod_dir = join('lib', 'node_modules')
prompt = opt.prompt or '(%s)' % os.path.basename(os.path.abspath(env_dir))

shim_node = join(bin_dir, "node")
shim_nodejs = join(bin_dir, "nodejs")
if opt.node == "system":
env = os.environ.copy()
env.update({'PATH': remove_env_bin_from_path(env['PATH'], bin_dir)})
Expand Down Expand Up @@ -750,12 +797,16 @@ def install_activate(env_dir, opt):
writefile(file_path, content, append=need_append)

if not os.path.exists(shim_nodejs):
os.symlink("node", shim_nodejs)
if is_WIN:
callit(['mklink', shim_nodejs, 'node.exe'], True, True)
else:
os.symlink("node", shim_nodejs)


def set_predeactivate_hook(env_dir):
with open(join(env_dir, 'bin', 'predeactivate'), 'a') as hook:
hook.write(PREDEACTIVATE_SH)
if not is_WIN:
with open(join(env_dir, 'bin', 'predeactivate'), 'a') as hook:
hook.write(PREDEACTIVATE_SH)


def create_environment(env_dir, opt):
Expand All @@ -780,14 +831,15 @@ def create_environment(env_dir, opt):
# for install
install_activate(env_dir, opt)
if node_version_from_opt(opt) < parse_version("0.6.3") or opt.with_npm:
install_npm(env_dir, src_dir, opt)
instfunc = install_npm_win if is_WIN else install_npm
instfunc(env_dir, src_dir, opt)
if opt.requirements:
install_packages(env_dir, opt)
if opt.python_virtualenv:
set_predeactivate_hook(env_dir)
# Cleanup
if opt.clean_src:
callit(['rm -rf', pipes.quote(src_dir)], opt.verbose, True, env_dir)
shutil.rmtree(src_dir)


class GetsAHrefs(HTMLParser):
Expand Down Expand Up @@ -917,6 +969,10 @@ def main():

opt, args = parse_args()

if opt.node.lower() == 'system' and is_WIN:
logger.error('Installing system node.js on win32 is not supported!')
exit(1)

if opt.io:
global src_domain
src_domain = "iojs.org"
Expand Down Expand Up @@ -955,6 +1011,31 @@ def main():
exec __SHIM_NODE__ "$@"
"""

ACTIVATE_BAT = """\
@echo off
set NODE_VIRTUAL_ENV="__NODE_VIRTUAL_ENV__"
if defined _OLD_VIRTUAL_PROMPT (
set "PROMPT=%_OLD_VIRTUAL_PROMPT%"
) else (
if not defined PROMPT (
set "PROMPT=$P$G"
)
set "_OLD_VIRTUAL_PROMPT=%PROMPT%"
)
set "PROMPT=__NODE_VIRTUAL_PROMPT__ %PROMPT%"
if not defined _OLD_VIRTUAL_NODE_PATH (
set "_OLD_VIRTUAL_NODE_PATH=%NODE_PATH%"
)
set NODE_PATH=__NODE_VIRTUAL_ENV__\\lib\\node_modules
if defined _OLD_VIRTUAL_NODE_PATH (
set "PATH=%_OLD_VIRTUAL_NODE_PATH%"
) else (
set "_OLD_VIRTUAL_NODE_PATH=%PATH%"
)
set "PATH=%NODE_VIRTUAL_ENV%\\Scripts;%PATH%"
:END
"""

ACTIVATE_SH = """

# This file must be used with "source bin/activate" *from bash*
Expand Down