Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add naive and untested version of Lua language support.
- Loading branch information
Showing
13 changed files
with
286 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
import contextlib | ||
import os | ||
import re | ||
from typing import Generator | ||
from typing import Sequence | ||
from typing import Tuple | ||
|
||
import pre_commit.constants as C | ||
from pre_commit.envcontext import envcontext | ||
from pre_commit.envcontext import PatchesT | ||
from pre_commit.envcontext import Var | ||
from pre_commit.hook import Hook | ||
from pre_commit.languages import helpers | ||
from pre_commit.parse_shebang import find_executable | ||
from pre_commit.prefix import Prefix | ||
from pre_commit.util import clean_path_on_failure | ||
from pre_commit.util import cmd_output | ||
|
||
ENVIRONMENT_DIR = 'lua_env' | ||
get_default_version = helpers.basic_get_default_version | ||
healthy = helpers.basic_healthy | ||
|
||
|
||
def _find_lua(language_version: str) -> str: # pragma: win32 no cover | ||
"""Find a lua executable. | ||
Lua doesn't always have a plain `lua` executable. | ||
Some OS vendors will ship the binary as `lua#.#` (e.g., lua5.3) | ||
so discovery is needed to find a valid executable. | ||
""" | ||
if language_version == C.DEFAULT: | ||
choices = ['lua'] | ||
for path in os.environ.get('PATH', '').split(os.pathsep): | ||
try: | ||
candidates = os.listdir(path) | ||
except OSError: | ||
# Invalid path on PATH or lacking permissions. | ||
continue | ||
|
||
for candidate in candidates: | ||
# The Lua executable might look like `lua#.#` or `lua-#.#`. | ||
if re.search(r'^lua[-]?\d+\.\d+', candidate): | ||
choices.append(candidate) | ||
else: | ||
# Prefer version specific executables first if available. | ||
# This should avoid the corner case where a user requests a language | ||
# version, gets a `lua` executable, but that executable is actually | ||
# for a different version and package.path would patch LUA_PATH | ||
# incorrectly. | ||
choices = [f'lua{language_version}', 'lua-{language_version}', 'lua'] | ||
|
||
found_exes = [exe for exe in choices if find_executable(exe)] | ||
if found_exes: | ||
return found_exes[0] | ||
|
||
raise ValueError( | ||
'No lua executable found on the system paths ' | ||
f'for {language_version} version.', | ||
) | ||
|
||
|
||
def _get_lua_path_version( | ||
lua_executable: str, | ||
) -> str: # pragma: win32 no cover | ||
"""Get the Lua version used in file paths.""" | ||
# This could sniff out from _VERSION, but checking package.path should | ||
# provide an answer for *exactly* where lua is looking for packages. | ||
_, stdout, _ = cmd_output(lua_executable, '-e', 'print(package.path)') | ||
sep = os.sep if os.name != 'nt' else os.sep * 2 | ||
match = re.search(fr'{sep}lua{sep}(.*?){sep}', stdout) | ||
if match: | ||
return match[1] | ||
|
||
raise ValueError('Cannot determine lua version for file paths.') | ||
|
||
|
||
def get_env_patch( | ||
env: str, language_version: str, | ||
) -> PatchesT: # pragma: win32 no cover | ||
lua = _find_lua(language_version) | ||
version = _get_lua_path_version(lua) | ||
return ( | ||
('PATH', (os.path.join(env, 'bin'), os.pathsep, Var('PATH'))), | ||
( | ||
'LUA_PATH', ( | ||
os.path.join(env, 'share', 'lua', version, '?.lua;'), | ||
os.path.join(env, 'share', 'lua', version, '?', 'init.lua;;'), | ||
), | ||
), | ||
( | ||
'LUA_CPATH', ( | ||
os.path.join(env, 'lib', 'lua', version, '?.so;;'), | ||
), | ||
), | ||
) | ||
|
||
|
||
def _envdir(prefix: Prefix, version: str) -> str: # pragma: win32 no cover | ||
directory = helpers.environment_dir(ENVIRONMENT_DIR, version) | ||
return prefix.path(directory) | ||
|
||
|
||
@contextlib.contextmanager # pragma: win32 no cover | ||
def in_env( | ||
prefix: Prefix, | ||
language_version: str, | ||
) -> Generator[None, None, None]: | ||
with envcontext( | ||
get_env_patch( | ||
_envdir(prefix, language_version), language_version, | ||
), | ||
): | ||
yield | ||
|
||
|
||
def install_environment( | ||
prefix: Prefix, | ||
version: str, | ||
additional_dependencies: Sequence[str], | ||
) -> None: # pragma: win32 no cover | ||
helpers.assert_version_default('lua', version) | ||
|
||
envdir = _envdir(prefix, version) | ||
with clean_path_on_failure(envdir): | ||
with in_env(prefix, version): | ||
# luarocks doesn't bootstrap a tree prior to installing | ||
# so ensure the directory exists. | ||
os.makedirs(envdir, exist_ok=True) | ||
|
||
make_cmd = ['luarocks', '--tree', envdir, 'make'] | ||
# Older luarocks (e.g., 2.4.2) expect the rockspec as an argument. | ||
filenames = prefix.star('.rockspec') | ||
make_cmd.extend(filenames[:1]) | ||
|
||
helpers.run_setup_cmd(prefix, tuple(make_cmd)) | ||
|
||
# luarocks can't install multiple packages at once | ||
# so install them individually. | ||
for dependency in additional_dependencies: | ||
cmd = ('luarocks', '--tree', envdir, 'install', dependency) | ||
helpers.run_setup_cmd(prefix, cmd) | ||
|
||
|
||
def run_hook( | ||
hook: Hook, | ||
file_args: Sequence[str], | ||
color: bool, | ||
) -> Tuple[int, bytes]: # pragma: win32 no cover | ||
with in_env(hook.prefix, hook.language_version): | ||
return helpers.run_xargs(hook, hook.cmd, file_args, color=color) |
12 changes: 12 additions & 0 deletions
12
pre_commit/resources/empty_template_pre-commit-package-dev-1.rockspec
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
package = "pre-commit-package" | ||
version = "dev-1" | ||
|
||
source = { | ||
url = "git+ssh://git@github.com/pre-commit/pre-commit.git" | ||
} | ||
description = {} | ||
dependencies = {} | ||
build = { | ||
type = "builtin", | ||
modules = {}, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
#!/usr/bin/env bash | ||
set -euo pipefail | ||
|
||
# Install the runtime and package manager. | ||
sudo apt install lua5.3 liblua5.3-dev luarocks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
- id: hello-world-lua | ||
name: hello world lua | ||
entry: hello-world-lua | ||
language: lua |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
#!/usr/bin/env lua | ||
|
||
print('hello world') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package = "hello" | ||
version = "dev-1" | ||
|
||
source = { | ||
url = "git+ssh://git@github.com/pre-commit/pre-commit.git" | ||
} | ||
description = {} | ||
dependencies = {} | ||
build = { | ||
type = "builtin", | ||
modules = {}, | ||
install = { | ||
bin = {"bin/hello-world-lua"} | ||
}, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import os | ||
from unittest import mock | ||
|
||
import pytest | ||
|
||
import pre_commit.constants as C | ||
from pre_commit.languages import lua | ||
from testing.util import xfailif_windows | ||
|
||
|
||
@pytest.mark.parametrize( | ||
'lua_name', ('lua', 'lua5.4', 'lua-5.4', 'lua5.4.exe'), | ||
) | ||
def test_find_lua(tmp_path, lua_name): | ||
"""The language support can find common lua executable names.""" | ||
lua_file = tmp_path / lua_name | ||
lua_file.touch(0o555) | ||
with mock.patch.dict(os.environ, {'PATH': str(tmp_path)}): | ||
lua_executable = lua._find_lua(C.DEFAULT) | ||
assert lua_name in lua_executable | ||
|
||
|
||
def test_find_lua_language_version(tmp_path): | ||
"""Language discovery can find a specific version.""" | ||
lua_file = tmp_path / 'lua5.99' | ||
lua_file.touch(0o555) | ||
with mock.patch.dict(os.environ, {'PATH': str(tmp_path)}): | ||
lua_executable = lua._find_lua('5.99') | ||
assert 'lua5.99' in lua_executable | ||
|
||
|
||
@pytest.mark.parametrize( | ||
('invalid', 'mode'), | ||
( | ||
('foobar', 0o555), | ||
('luac', 0o555), | ||
# Windows doesn't respect the executable checking. | ||
pytest.param('lua5.4', 0o444, marks=xfailif_windows), | ||
), | ||
) | ||
def test_find_lua_fail(tmp_path, invalid, mode): | ||
"""No lua executable on the system will fail.""" | ||
non_lua_file = tmp_path / invalid | ||
non_lua_file.touch(mode) | ||
with mock.patch.dict(os.environ, {'PATH': str(tmp_path)}): | ||
with pytest.raises(ValueError): | ||
lua._find_lua(C.DEFAULT) | ||
|
||
|
||
@mock.patch.object(lua, 'cmd_output') | ||
def test_bad_package_path(mock_cmd_output): | ||
"""A package path missing path info returns an unknown version.""" | ||
mock_cmd_output.return_value = (0, '', '') | ||
with pytest.raises(ValueError): | ||
lua._get_lua_path_version('lua') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters