Skip to content

Commit 45d4a19

Browse files
asottileasottile
committed
Environments are now installed to version-specific locations. Resolves pre-commit#229 
1 parent 154d918 commit 45d4a19

File tree

9 files changed

+71
-44
lines changed

9 files changed

+71
-44
lines changed

‎pre_commit/git.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ def is_in_merge_conflict():
3737
def parse_merge_msg_for_conflicts(merge_msg):
3838
# Conflicted files start with tabs
3939
return [
40-
line.strip()
40+
line.lstrip('#').strip()
4141
for line in merge_msg.splitlines()
42-
if line.startswith('\t')
42+
# '#\t' for git 2.4.1
43+
if line.startswith(('\t', '#\t'))
4344
]
4445

4546

‎pre_commit/languages/helpers.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
import pipes
44

55

6+
def environment_dir(ENVIRONMENT_DIR, language_version):
7+
if ENVIRONMENT_DIR is None:
8+
return None
9+
else:
10+
return '{0}-{1}'.format(ENVIRONMENT_DIR, language_version)
11+
12+
613
def file_args_to_stdin(file_args):
714
return '\0'.join(list(file_args) + [''])
815

@@ -19,8 +26,9 @@ def run_hook(env, hook, file_args):
1926

2027

2128
class Environment(object):
22-
def __init__(self, repo_cmd_runner):
29+
def __init__(self, repo_cmd_runner, language_version):
2330
self.repo_cmd_runner = repo_cmd_runner
31+
self.language_version = language_version
2432

2533
@property
2634
def env_prefix(self):

‎pre_commit/languages/node.py‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,36 @@
1313
class NodeEnv(helpers.Environment):
1414
@property
1515
def env_prefix(self):
16-
return ". '{{prefix}}{0}/bin/activate' &&".format(ENVIRONMENT_DIR)
16+
return ". '{{prefix}}{0}/bin/activate' &&".format(
17+
helpers.environment_dir(ENVIRONMENT_DIR, self.language_version),
18+
)
1719

1820

1921
@contextlib.contextmanager
20-
def in_env(repo_cmd_runner):
21-
yield NodeEnv(repo_cmd_runner)
22+
def in_env(repo_cmd_runner, language_version):
23+
yield NodeEnv(repo_cmd_runner, language_version)
2224

2325

2426
def install_environment(repo_cmd_runner, version='default'):
2527
assert repo_cmd_runner.exists('package.json')
28+
directory = helpers.environment_dir(ENVIRONMENT_DIR, version)
2629

27-
env_dir = repo_cmd_runner.path(ENVIRONMENT_DIR)
30+
env_dir = repo_cmd_runner.path(directory)
2831
with clean_path_on_failure(env_dir):
2932
cmd = [
3033
sys.executable, '-m', 'nodeenv', '--prebuilt',
31-
'{{prefix}}{0}'.format(ENVIRONMENT_DIR),
34+
'{{prefix}}{0}'.format(directory),
3235
]
3336

3437
if version != 'default':
3538
cmd.extend(['-n', version])
3639

3740
repo_cmd_runner.run(cmd)
3841

39-
with in_env(repo_cmd_runner) as node_env:
42+
with in_env(repo_cmd_runner, version) as node_env:
4043
node_env.run("cd '{prefix}' && npm install -g")
4144

4245

4346
def run_hook(repo_cmd_runner, hook, file_args):
44-
with in_env(repo_cmd_runner) as env:
47+
with in_env(repo_cmd_runner, hook['language_version']) as env:
4548
return helpers.run_hook(env, hook, file_args)

‎pre_commit/languages/python.py‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ class PythonEnv(helpers.Environment):
1919
def env_prefix(self):
2020
return ". '{{prefix}}{0}activate' &&".format(
2121
virtualenv.path_locations(
22-
ENVIRONMENT_DIR,
22+
helpers.environment_dir(ENVIRONMENT_DIR, self.language_version)
2323
)[-1].rstrip(os.sep) + os.sep,
2424
'activate',
2525
)
2626

2727

2828
@contextlib.contextmanager
29-
def in_env(repo_cmd_runner):
30-
yield PythonEnv(repo_cmd_runner)
29+
def in_env(repo_cmd_runner, language_version):
30+
yield PythonEnv(repo_cmd_runner, language_version)
3131

3232

3333
def norm_version(version):
@@ -41,20 +41,21 @@ def norm_version(version):
4141

4242
def install_environment(repo_cmd_runner, version='default'):
4343
assert repo_cmd_runner.exists('setup.py')
44+
directory = helpers.environment_dir(ENVIRONMENT_DIR, version)
4445

4546
# Install a virtualenv
46-
with clean_path_on_failure(repo_cmd_runner.path(ENVIRONMENT_DIR)):
47+
with clean_path_on_failure(repo_cmd_runner.path(directory)):
4748
venv_cmd = [
4849
sys.executable, '-m', 'virtualenv',
49-
'{{prefix}}{0}'.format(ENVIRONMENT_DIR)
50+
'{{prefix}}{0}'.format(directory)
5051
]
5152
if version != 'default':
5253
venv_cmd.extend(['-p', norm_version(version)])
5354
repo_cmd_runner.run(venv_cmd)
54-
with in_env(repo_cmd_runner) as env:
55+
with in_env(repo_cmd_runner, version) as env:
5556
env.run("cd '{prefix}' && pip install .")
5657

5758

5859
def run_hook(repo_cmd_runner, hook, file_args):
59-
with in_env(repo_cmd_runner) as env:
60+
with in_env(repo_cmd_runner, hook['language_version']) as env:
6061
return helpers.run_hook(env, hook, file_args)

‎pre_commit/languages/ruby.py‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import contextlib
44
import io
5+
import shutil
56

67
from pre_commit.languages import helpers
78
from pre_commit.util import CalledProcessError
@@ -16,29 +17,36 @@
1617
class RubyEnv(helpers.Environment):
1718
@property
1819
def env_prefix(self):
19-
return '. {{prefix}}{0}/bin/activate &&'.format(ENVIRONMENT_DIR)
20+
return '. {{prefix}}{0}/bin/activate &&'.format(
21+
helpers.environment_dir(ENVIRONMENT_DIR, self.language_version)
22+
)
2023

2124

2225
@contextlib.contextmanager
23-
def in_env(repo_cmd_runner):
24-
yield RubyEnv(repo_cmd_runner)
26+
def in_env(repo_cmd_runner, language_version):
27+
yield RubyEnv(repo_cmd_runner, language_version)
2528

2629

2730
def _install_rbenv(repo_cmd_runner, version='default'):
31+
directory = helpers.environment_dir(ENVIRONMENT_DIR, version)
32+
2833
with tarfile_open(resource_filename('rbenv.tar.gz')) as tf:
2934
tf.extractall(repo_cmd_runner.path('.'))
35+
shutil.move(
36+
repo_cmd_runner.path('rbenv'), repo_cmd_runner.path(directory),
37+
)
3038

3139
# Only install ruby-build if the version is specified
3240
if version != 'default':
3341
# ruby-download
3442
with tarfile_open(resource_filename('ruby-download.tar.gz')) as tf:
35-
tf.extractall(repo_cmd_runner.path('rbenv', 'plugins'))
43+
tf.extractall(repo_cmd_runner.path(directory, 'plugins'))
3644

3745
# ruby-build
3846
with tarfile_open(resource_filename('ruby-build.tar.gz')) as tf:
39-
tf.extractall(repo_cmd_runner.path('rbenv', 'plugins'))
47+
tf.extractall(repo_cmd_runner.path(directory, 'plugins'))
4048

41-
activate_path = repo_cmd_runner.path('rbenv', 'bin', 'activate')
49+
activate_path = repo_cmd_runner.path(directory, 'bin', 'activate')
4250
with io.open(activate_path, 'w') as activate_file:
4351
# This is similar to how you would install rbenv to your home directory
4452
# However we do a couple things to make the executables exposed and
@@ -54,7 +62,7 @@ def _install_rbenv(repo_cmd_runner, version='default'):
5462
# directory
5563
"export GEM_HOME='{0}/gems'\n"
5664
'export PATH="$GEM_HOME/bin:$PATH"\n'
57-
'\n'.format(repo_cmd_runner.path('rbenv'))
65+
'\n'.format(repo_cmd_runner.path(directory))
5866
)
5967

6068
# If we aren't using the system ruby, add a version here
@@ -71,11 +79,12 @@ def _install_ruby(environment, version):
7179

7280

7381
def install_environment(repo_cmd_runner, version='default'):
74-
with clean_path_on_failure(repo_cmd_runner.path('rbenv')):
82+
directory = helpers.environment_dir(ENVIRONMENT_DIR, version)
83+
with clean_path_on_failure(repo_cmd_runner.path(directory)):
7584
# TODO: this currently will fail if there's no version specified and
7685
# there's no system ruby installed. Is this ok?
7786
_install_rbenv(repo_cmd_runner, version=version)
78-
with in_env(repo_cmd_runner) as ruby_env:
87+
with in_env(repo_cmd_runner, version) as ruby_env:
7988
if version != 'default':
8089
_install_ruby(ruby_env, version)
8190
ruby_env.run(
@@ -84,5 +93,5 @@ def install_environment(repo_cmd_runner, version='default'):
8493

8594

8695
def run_hook(repo_cmd_runner, hook, file_args):
87-
with in_env(repo_cmd_runner) as env:
96+
with in_env(repo_cmd_runner, hook['language_version']) as env:
8897
return helpers.run_hook(env, hook, file_args)

‎pre_commit/repository.py‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
from pre_commit.clientlib.validate_manifest import MANIFEST_JSON_SCHEMA
1111
from pre_commit.jsonschema_extensions import apply_defaults
1212
from pre_commit.languages.all import languages
13+
from pre_commit.languages.helpers import environment_dir
1314
from pre_commit.manifest import Manifest
1415
from pre_commit.prefixed_command_runner import PrefixedCommandRunner
1516

@@ -73,16 +74,19 @@ def require_installed(self):
7374

7475
def install(self):
7576
"""Install the hook repository."""
76-
def language_is_installed(language_name):
77+
def language_is_installed(language_name, language_version):
7778
language = languages[language_name]
79+
directory = environment_dir(
80+
language.ENVIRONMENT_DIR, language_version,
81+
)
7882
return (
79-
language.ENVIRONMENT_DIR is None or
80-
self.cmd_runner.exists(language.ENVIRONMENT_DIR, '.installed')
83+
directory is None or
84+
self.cmd_runner.exists(directory, '.installed')
8185
)
8286

8387
if not all(
84-
language_is_installed(language_name)
85-
for language_name, _ in self.languages
88+
language_is_installed(language_name, language_version)
89+
for language_name, language_version in self.languages
8690
):
8791
logger.info(
8892
'Installing environment for {0}.'.format(self.repo_url)
@@ -92,20 +96,20 @@ def language_is_installed(language_name):
9296

9397
for language_name, language_version in self.languages:
9498
language = languages[language_name]
95-
if language_is_installed(language_name):
99+
if language_is_installed(language_name, language_version):
96100
continue
97101

102+
directory = environment_dir(
103+
language.ENVIRONMENT_DIR, language_version,
104+
)
98105
# There's potentially incomplete cleanup from previous runs
99106
# Clean it up!
100-
if self.cmd_runner.exists(language.ENVIRONMENT_DIR):
101-
shutil.rmtree(self.cmd_runner.path(language.ENVIRONMENT_DIR))
107+
if self.cmd_runner.exists(directory):
108+
shutil.rmtree(self.cmd_runner.path(directory))
102109

103110
language.install_environment(self.cmd_runner, language_version)
104111
# Touch the .installed file (atomic) to indicate we've installed
105-
open(
106-
self.cmd_runner.path(language.ENVIRONMENT_DIR, '.installed'),
107-
'w',
108-
).close()
112+
open(self.cmd_runner.path(directory, '.installed'), 'w').close()
109113

110114
def run_hook(self, hook, file_args):
111115
"""Run a hook.

‎tests/languages/ruby_test.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@
1010
def test_install_rbenv(cmd_runner):
1111
_install_rbenv(cmd_runner)
1212
# Should have created rbenv directory
13-
assert os.path.exists(cmd_runner.path('rbenv'))
13+
assert os.path.exists(cmd_runner.path('rbenv-default'))
1414
# We should have created our `activate` script
15-
activate_path = cmd_runner.path('rbenv', 'bin', 'activate')
15+
activate_path = cmd_runner.path('rbenv-default', 'bin', 'activate')
1616
assert os.path.exists(activate_path)
1717

1818
# Should be able to activate using our script and access rbenv
1919
cmd_runner.run(
2020
[
2121
'bash',
2222
'-c',
23-
". '{prefix}rbenv/bin/activate' && rbenv --help",
23+
". '{prefix}rbenv-default/bin/activate' && rbenv --help",
2424
],
2525
)
2626

@@ -34,6 +34,6 @@ def test_install_rbenv_with_version(cmd_runner):
3434
[
3535
'bash',
3636
'-c',
37-
". '{prefix}rbenv/bin/activate' && rbenv install --help",
37+
". '{prefix}rbenv-1.9.3p547/bin/activate' && rbenv install --help",
3838
],
3939
)

‎tests/repository_test.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ class MyKeyboardInterrupt(KeyboardInterrupt):
338338
repo.run_hook(hook, [])
339339

340340
# Should have made an environment, however this environment is broken!
341-
assert os.path.exists(repo.cmd_runner.path('py_env'))
341+
assert os.path.exists(repo.cmd_runner.path('py_env-default'))
342342

343343
# However, it should be perfectly runnable (reinstall after botched
344344
# install)

‎tox.ini‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ envlist = py26,py27,py33,py34,pypy
66
[testenv]
77
install_command = pip install --use-wheel {opts} {packages}
88
deps = -rrequirements-dev.txt
9+
passenv = HOME HOMEPATH LANG TERM
910
commands =
1011
coverage erase
1112
coverage run -m pytest {posargs:tests}

0 commit comments

Comments
 (0)