summaryrefslogtreecommitdiff
path: root/tests/test_shell.py
blob: a39c0f20faaf2e5c543c3c09837e2acbf41a0861 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# -*- coding: utf-8 -*-
"""
    Basic Shell Tests
    ~~~~~~~~~~~~~~~~~

    :copyright: Copyright 2006-2020 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import pytest

from pygments.token import Token
from pygments.lexers import BashLexer, BashSessionLexer, MSDOSSessionLexer, PowerShellSessionLexer


@pytest.fixture(scope='module')
def lexer_bash():
    yield BashLexer()


@pytest.fixture(scope='module')
def lexer_session():
    yield BashSessionLexer()


@pytest.fixture(scope='module')
def lexer_msdos():
    yield MSDOSSessionLexer()


@pytest.fixture(scope='module')
def lexer_powershell_session():
    yield PowerShellSessionLexer()


def test_curly_no_escape_and_quotes(lexer_bash):
    fragment = 'echo "${a//["b"]/}"\n'
    tokens = [
        (Token.Name.Builtin, 'echo'),
        (Token.Text, ' '),
        (Token.Literal.String.Double, '"'),
        (Token.String.Interpol, '${'),
        (Token.Name.Variable, 'a'),
        (Token.Punctuation, '//['),
        (Token.Literal.String.Double, '"b"'),
        (Token.Punctuation, ']/'),
        (Token.String.Interpol, '}'),
        (Token.Literal.String.Double, '"'),
        (Token.Text, '\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_curly_with_escape(lexer_bash):
    fragment = 'echo ${a//[\\"]/}\n'
    tokens = [
        (Token.Name.Builtin, 'echo'),
        (Token.Text, ' '),
        (Token.String.Interpol, '${'),
        (Token.Name.Variable, 'a'),
        (Token.Punctuation, '//['),
        (Token.Literal.String.Escape, '\\"'),
        (Token.Punctuation, ']/'),
        (Token.String.Interpol, '}'),
        (Token.Text, '\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_parsed_single(lexer_bash):
    fragment = "a=$'abc\\''\n"
    tokens = [
        (Token.Name.Variable, 'a'),
        (Token.Operator, '='),
        (Token.Literal.String.Single, "$'abc\\''"),
        (Token.Text, '\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_short_variable_names(lexer_bash):
    fragment = 'x="$"\ny="$_"\nz="$abc"\n'
    tokens = [
        # single lone $
        (Token.Name.Variable, 'x'),
        (Token.Operator, '='),
        (Token.Literal.String.Double, '"'),
        (Token.Text, '$'),
        (Token.Literal.String.Double, '"'),
        (Token.Text, '\n'),
        # single letter shell var
        (Token.Name.Variable, 'y'),
        (Token.Operator, '='),
        (Token.Literal.String.Double, '"'),
        (Token.Name.Variable, '$_'),
        (Token.Literal.String.Double, '"'),
        (Token.Text, '\n'),
        # multi-letter user var
        (Token.Name.Variable, 'z'),
        (Token.Operator, '='),
        (Token.Literal.String.Double, '"'),
        (Token.Name.Variable, '$abc'),
        (Token.Literal.String.Double, '"'),
        (Token.Text, '\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_array_nums(lexer_bash):
    fragment = 'a=(1 2 3)\n'
    tokens = [
        (Token.Name.Variable, 'a'),
        (Token.Operator, '='),
        (Token.Operator, '('),
        (Token.Literal.Number, '1'),
        (Token.Text, ' '),
        (Token.Literal.Number, '2'),
        (Token.Text, ' '),
        (Token.Literal.Number, '3'),
        (Token.Operator, ')'),
        (Token.Text, '\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_end_of_line_nums(lexer_bash):
    fragment = 'a=1\nb=2 # comment\n'
    tokens = [
        (Token.Name.Variable, 'a'),
        (Token.Operator, '='),
        (Token.Literal.Number, '1'),
        (Token.Text, '\n'),
        (Token.Name.Variable, 'b'),
        (Token.Operator, '='),
        (Token.Literal.Number, '2'),
        (Token.Text, ' '),
        (Token.Comment.Single, '# comment\n'),
    ]
    assert list(lexer_bash.get_tokens(fragment)) == tokens


def test_newline_in_echo(lexer_session):
    fragment = '$ echo \\\nhi\nhi\n'
    tokens = [
        (Token.Text, ''),
        (Token.Generic.Prompt, '$'),
        (Token.Text, ' '),
        (Token.Name.Builtin, 'echo'),
        (Token.Text, ' '),
        (Token.Literal.String.Escape, '\\\n'),
        (Token.Text, 'hi'),
        (Token.Text, '\n'),
        (Token.Generic.Output, 'hi\n'),
    ]
    assert list(lexer_session.get_tokens(fragment)) == tokens


def test_msdos_gt_only(lexer_msdos):
    fragment = '> py\nhi\n'
    tokens = [
        (Token.Text, ''),
        (Token.Generic.Prompt, '>'),
        (Token.Text, ' '),
        (Token.Text, 'py'),
        (Token.Text, '\n'),
        (Token.Generic.Output, 'hi\n'),
    ]
    assert list(lexer_msdos.get_tokens(fragment)) == tokens


def test_powershell_session(lexer_powershell_session):
    fragment = 'PS C:\\> Get-ChildItem\n'
    tokens = [
        (Token.Name.Builtin, ''),
        (Token.Generic.Prompt, 'PS C:\\> '),
        (Token.Name.Builtin, 'Get-ChildItem'),
        (Token.Text, '\n')
    ]
    assert list(lexer_powershell_session.get_tokens(fragment)) == tokens

    fragment = 'PS> Get-ChildItem\n'
    tokens = [
        (Token.Name.Builtin, ''),
        (Token.Generic.Prompt, 'PS> '),
        (Token.Name.Builtin, 'Get-ChildItem'),
        (Token.Text, '\n')
    ]
    assert list(lexer_powershell_session.get_tokens(fragment)) == tokens

    fragment = 'PS > Get-ChildItem\n'
    tokens = [
        (Token.Name.Builtin, ''),
        (Token.Generic.Prompt, 'PS > '),
        (Token.Name.Builtin, 'Get-ChildItem'),
        (Token.Text, '\n')
    ]
    assert list(lexer_powershell_session.get_tokens(fragment)) == tokens


def test_powershell_remoting_session(lexer_powershell_session):
    fragment = '[Long-NetBIOS-Hostname]: PS C:\\> Get-ChildItem\n'
    tokens = [
        (Token.Name.Builtin, ''),
        (Token.Generic.Prompt, '[Long-NetBIOS-Hostname]: PS C:\\> '),
        (Token.Name.Builtin, 'Get-ChildItem'),
        (Token.Text, '\n')
    ]
    assert list(lexer_powershell_session.get_tokens(fragment)) == tokens


def test_virtualenv(lexer_session):
    fragment = '(env) [~/project]$ foo -h\n'
    tokens = [
        (Token.Text, ''),
        (Token.Generic.Prompt.VirtualEnv, '(env)'),
        (Token.Text, ''),
        (Token.Text, ' '),
        (Token.Text, ''),
        (Token.Generic.Prompt, '[~/project]$'),
        (Token.Text, ' '),
        (Token.Text, 'foo'),
        (Token.Text, ' '),
        (Token.Text, '-h'),
        (Token.Text, '\n'),
    ]
    assert list(lexer_session.get_tokens(fragment)) == tokens