Skip to content

Commit 068c18d

Browse files
asottileasottile
committed
Add first class support for golang hooks
1 parent 2093395 commit 068c18d

11 files changed

Lines changed: 151 additions & 7 deletions

File tree

‎pre_commit/git.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ def get_git_dir(git_root):
3232
))
3333

3434

35+
def get_remote_url(git_root):
36+
ret = cmd_output('git', 'config', 'remote.origin.url', cwd=git_root)[1]
37+
return ret.strip()
38+
39+
3540
def is_in_merge_conflict():
3641
git_dir = get_git_dir('.')
3742
return (

‎pre_commit/languages/all.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
from __future__ import unicode_literals
22

33
from pre_commit.languages import docker
4+
from pre_commit.languages import golang
45
from pre_commit.languages import node
56
from pre_commit.languages import pcre
67
from pre_commit.languages import python
@@ -43,6 +44,7 @@
4344

4445
languages = {
4546
'docker': docker,
47+
'golang': golang,
4648
'node': node,
4749
'pcre': pcre,
4850
'python': python,

‎pre_commit/languages/docker.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,8 @@ def install_environment(
6060
assert repo_cmd_runner.exists('Dockerfile'), (
6161
'No Dockerfile was found in the hook repository'
6262
)
63-
assert version == 'default', (
64-
'Pre-commit does not support language_version for docker '
65-
)
63+
helpers.assert_version_default('docker', version)
64+
helpers.assert_no_additional_deps('docker', additional_dependencies)
6665
assert_docker_available()
6766

6867
directory = repo_cmd_runner.path(

‎pre_commit/languages/golang.py‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
from __future__ import unicode_literals
2+
3+
import contextlib
4+
import os.path
5+
6+
from pre_commit import git
7+
from pre_commit.envcontext import envcontext
8+
from pre_commit.envcontext import Var
9+
from pre_commit.languages import helpers
10+
from pre_commit.util import clean_path_on_failure
11+
from pre_commit.util import cmd_output
12+
from pre_commit.xargs import xargs
13+
14+
15+
ENVIRONMENT_DIR = 'golangenv'
16+
17+
18+
def get_env_patch(venv): # pragma: windows no cover
19+
return (
20+
('PATH', (os.path.join(venv, 'bin'), os.pathsep, Var('PATH'))),
21+
)
22+
23+
24+
@contextlib.contextmanager
25+
def in_env(repo_cmd_runner): # pragma: windows no cover
26+
envdir = repo_cmd_runner.path(
27+
helpers.environment_dir(ENVIRONMENT_DIR, 'default'),
28+
)
29+
with envcontext(get_env_patch(envdir)):
30+
yield
31+
32+
33+
def guess_go_dir(remote_url):
34+
if remote_url.endswith('.git'):
35+
remote_url = remote_url[:-1 * len('.git')]
36+
remote_url = remote_url.replace(':', '/')
37+
looks_like_url = '//' in remote_url or '@' in remote_url
38+
if looks_like_url:
39+
_, _, remote_url = remote_url.rpartition('//')
40+
_, _, remote_url = remote_url.rpartition('@')
41+
return remote_url
42+
else:
43+
return 'unknown_src_dir'
44+
45+
46+
def install_environment(
47+
repo_cmd_runner,
48+
version='default',
49+
additional_dependencies=(),
50+
): # pragma: windows no cover
51+
helpers.assert_version_default('golang', version)
52+
helpers.assert_no_additional_deps('golang', additional_dependencies)
53+
directory = repo_cmd_runner.path(
54+
helpers.environment_dir(ENVIRONMENT_DIR, 'default'),
55+
)
56+
57+
with clean_path_on_failure(directory):
58+
remote = git.get_remote_url(repo_cmd_runner.path())
59+
repo_src_dir = os.path.join(directory, 'src', guess_go_dir(remote))
60+
61+
# Clone into the goenv we'll create
62+
helpers.run_setup_cmd(
63+
repo_cmd_runner, ('git', 'clone', '.', repo_src_dir),
64+
)
65+
66+
env = dict(os.environ, GOPATH=directory)
67+
cmd_output('go', 'get', './...', cwd=repo_src_dir, env=env)
68+
69+
70+
def run_hook(repo_cmd_runner, hook, file_args): # pragma: windows no cover
71+
with in_env(repo_cmd_runner):
72+
return xargs(helpers.to_cmd(hook), file_args)

‎pre_commit/languages/helpers.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,18 @@ def environment_dir(ENVIRONMENT_DIR, language_version):
1818

1919
def to_cmd(hook):
2020
return tuple(shlex.split(hook['entry'])) + tuple(hook['args'])
21+
22+
23+
def assert_version_default(binary, version):
24+
if version != 'default':
25+
raise AssertionError(
26+
'For now, pre-commit requires system-installed {}'.format(binary),
27+
)
28+
29+
30+
def assert_no_additional_deps(lang, additional_deps):
31+
if additional_deps:
32+
raise AssertionError(
33+
'For now, pre-commit does not support '
34+
'additional_dependencies for {}'.format(lang),
35+
)

‎pre_commit/languages/swift.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@ def install_environment(
3333
version='default',
3434
additional_dependencies=(),
3535
): # pragma: windows no cover
36-
assert version == 'default', (
37-
'Pre-commit does not support language_version for docker '
38-
)
36+
helpers.assert_version_default('swift', version)
37+
helpers.assert_no_additional_deps('swift', additional_dependencies)
3938
directory = repo_cmd_runner.path(
4039
helpers.environment_dir(ENVIRONMENT_DIR, 'default'),
4140
)

‎testing/resources/golang_hooks_repo/.pre-commit-hooks.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- id: golang-hook
2+
name: golang example hook
3+
entry: golang-hello-world
4+
language: golang
5+
files: ''

‎testing/resources/golang_hooks_repo/golang-hello-world/main.go‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
package main
2+
3+
4+
import (
5+
"fmt"
6+
"github.com/BurntSushi/toml"
7+
)
8+
9+
type Config struct {
10+
What string
11+
}
12+
13+
func main() {
14+
var conf Config
15+
toml.Decode("What = 'world'\n", &conf)
16+
fmt.Printf("hello %v\n", conf.What)
17+
}

‎tests/languages/golang_test.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
from __future__ import absolute_import
2+
from __future__ import unicode_literals
3+
4+
import pytest
5+
6+
from pre_commit.languages.golang import guess_go_dir
7+
8+
9+
@pytest.mark.parametrize(
10+
('url', 'expected'),
11+
(
12+
('/im/a/path/on/disk', 'unknown_src_dir'),
13+
('git@github.com:golang/lint', 'github.com/golang/lint'),
14+
('git://github.com/golang/lint', 'github.com/golang/lint'),
15+
('http://github.com/golang/lint', 'github.com/golang/lint'),
16+
('https://github.com/golang/lint', 'github.com/golang/lint'),
17+
('ssh://git@github.com/golang/lint', 'github.com/golang/lint'),
18+
('git@github.com:golang/lint.git', 'github.com/golang/lint'),
19+
),
20+
)
21+
def test_guess_go_dir(url, expected):
22+
assert guess_go_dir(url) == expected

‎tests/repository_test.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,14 @@ def test_swift_hook(tempdir_factory, store):
257257
)
258258

259259

260+
@pytest.mark.integration
261+
def test_golang_hook(tempdir_factory, store):
262+
_test_hook_repo(
263+
tempdir_factory, store, 'golang_hooks_repo',
264+
'golang-hook', [], b'hello world\n',
265+
)
266+
267+
260268
@pytest.mark.integration
261269
def test_missing_executable(tempdir_factory, store):
262270
_test_hook_repo(

0 commit comments

Comments
 (0)