Files
lix/tests/functional2/eval/test_attr_paths.py
T
Jade Lovelace faf00ad022 libexpr: significantly improve error messages for bad attr paths
This commit makes Lix include the summarized content of the value being
indexed when it is bad.

lix/lix2 » nix eval --expr '{x.y = 2;}' 'x.y.z'
error: the value being indexed in the selection path 'x.y.z' at 'x.y' should be a set but is an integer: 2

lix/lix2 » nix eval --expr '{x.y = { a = 3; };}' 'x.y.z'
error: attribute 'z' in selection path 'x.y.z' not found inside path 'x.y', whose contents are: { a = 3; }
       Did you mean a?

lix/lix2 » nix eval --expr '{x.y = { a = 3; };}' 'x.y.1'
error: the expression selected by the selection path 'x.y.1' should be a list but is a set: { a = 3; }

Change-Id: I3202aba0e437e00b4c6d3ee287a2d9a7c6892dbf
2024-12-10 15:43:31 -08:00

57 lines
2.0 KiB
Python

from functional2.testlib.fixtures import Nix
import pytest
from typing import NamedTuple
from textwrap import dedent
class ShouldError(NamedTuple):
expr: str
attr: str
error: str
ERR_CASES: list[ShouldError] = [
# FIXME(jade): expect-test system for pytest that allows for updating these easily
ShouldError('{}', '"x',
"""error: missing closing quote in selection path '"x'"""),
ShouldError(
'[]', 'x',
"""error: the value being indexed in the selection path 'x' at '' should be a set but is a list: [ ]"""
),
ShouldError(
'{}', '1',
"""error: the expression selected by the selection path '1' should be a list but is a set: { }"""
),
ShouldError('{}', '.',
"""error: empty attribute name in selection path '.'"""),
ShouldError('{ x."" = 2; }', 'x.""',
"""error: empty attribute name in selection path 'x.""'"""),
ShouldError('{ x."".y = 2; }', 'x."".y',
"""error: empty attribute name in selection path 'x."".y'"""),
ShouldError(
'[]', '1',
"""error: list index 1 in selection path '1' is out of range for list [ ]"""
),
ShouldError(
'{ x.y = { z = 2; a = 3; }; }', 'x.y.c',
dedent("""\
error: attribute 'c' in selection path 'x.y.c' not found inside path 'x.y', whose contents are: { a = 3; z = 2; }
Did you mean one of a or z?""")
),
]
# I do not know why it does this, but I guess it makes sense as allowing a tool
# to pass -A unconditionally and then allow a blank attribute to mean the whole
# thing
def test_attrpath_accepts_empty_attr_as_no_attr(nix: Nix):
assert nix.nix_instantiate(['--eval', '--expr', '{}', '-A',
'']).run().ok().stdout_plain == '{ }'
@pytest.mark.parametrize(['expr', 'attr', 'error'], ERR_CASES)
def test_attrpath_error(nix: Nix, expr: str, attr: str, error: str):
res = nix.nix_instantiate(['--eval', '--expr', expr, '-A', attr]).run()
assert res.expect(1).stderr_plain == error