aboutsummaryrefslogtreecommitdiffstats
path: root/tests/mason-core/spawn_spec.lua
blob: db8f957596308328fa0808518155dba6e50bd888 (plain) (blame)
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
227
local a = require "mason-core.async"
local match = require "luassert.match"
local platform = require "mason-core.platform"
local process = require "mason-core.process"
local spawn = require "mason-core.spawn"
local spy = require "luassert.spy"
local stub = require "luassert.stub"

describe("async spawn", function()
    local snapshot

    before_each(function()
        snapshot = assert.snapshot()
    end)

    after_each(function()
        snapshot:revert()
    end)

    it("should spawn commands and return stdout & stderr", function()
        local result = a.run_blocking(spawn.env, {
            env_raw = { "FOO=bar" },
        })
        assert.is_true(result:is_success())
        assert.equals("FOO=bar\n", result:get_or_nil().stdout)
        assert.equals("", result:get_or_nil().stderr)
    end)

    it("should use provided stdio_sink", function()
        local stdout = spy.new()
        local stdio = process.StdioSink:new {
            stdout = stdout,
        }
        local result = a.run_blocking(spawn.env, {
            env_raw = { "FOO=bar" },
            stdio_sink = stdio,
        })
        assert.is_true(result:is_success())
        assert.equals(nil, result:get_or_nil())
        -- Not 100 %guaranteed it's only called once because output is always buffered, but it's extremely likely
        assert.spy(stdout).was_called(1)
        assert.spy(stdout).was_called_with "FOO=bar\n"
    end)

    it("should pass command arguments", function()
        local result = a.run_blocking(spawn.bash, {
            "-c",
            'echo "Hello $VAR"',
            env = { VAR = "world" },
        })

        assert.is_true(result:is_success())
        assert.equals("Hello world\n", result:get_or_nil().stdout)
        assert.equals("", result:get_or_nil().stderr)
    end)

    it("should ignore vim.NIL args", function()
        spy.on(process, "spawn")
        local result = a.run_blocking(spawn.bash, {
            vim.NIL,
            vim.NIL,
            "-c",
            { vim.NIL, vim.NIL },
            'echo "Hello $VAR"',
            env = { VAR = "world" },
        })

        assert.is_true(result:is_success())
        assert.equals("Hello world\n", result:get_or_nil().stdout)
        assert.equals("", result:get_or_nil().stderr)
        assert.spy(process.spawn).was_called(1)
        assert.spy(process.spawn).was_called_with(
            "bash",
            match.tbl_containing {
                stdio_sink = match.instanceof(process.BufferedSink),
                env = match.list_containing "VAR=world",
                args = match.tbl_containing {
                    "-c",
                    'echo "Hello $VAR"',
                },
            },
            match.is_function()
        )
    end)

    it("should flatten table args", function()
        local result = a.run_blocking(spawn.bash, {
            { "-c", 'echo "Hello $VAR"' },
            env = { VAR = "world" },
        })

        assert.is_true(result:is_success())
        assert.equals("Hello world\n", result:get_or_nil().stdout)
        assert.equals("", result:get_or_nil().stderr)
    end)

    it("should call on_spawn", function()
        local on_spawn = spy.new(function(_, stdio)
            local stdin = stdio[1]
            stdin:write "im so piped rn"
            stdin:close()
        end)

        local result = a.run_blocking(spawn.cat, {
            { "-" },
            on_spawn = on_spawn,
        })

        assert.spy(on_spawn).was_called(1)
        assert.spy(on_spawn).was_called_with(match.is_not.is_nil(), match.is_table(), match.is_number())
        assert.is_true(result:is_success())
        assert.equals("im so piped rn", result:get_or_nil().stdout)
    end)

    it("should not call on_spawn if spawning fails", function()
        local on_spawn = spy.new()

        local result = a.run_blocking(spawn.this_cmd_doesnt_exist, {
            on_spawn = on_spawn,
        })

        assert.spy(on_spawn).was_called(0)
        assert.is_true(result:is_failure())
    end)

    it("should handle failure to spawn process", function()
        stub(process, "spawn", function(_, _, callback)
            callback(false)
        end)

        local result = a.run_blocking(spawn.my_cmd, {})
        assert.is_true(result:is_failure())
        assert.is_nil(result:err_or_nil().exit_code)
    end)

    it("should format failure message", function()
        stub(process, "spawn", function(cmd, opts, callback)
            opts.stdio_sink:stderr(("This is an error message for %s!"):format(cmd))
            callback(false, 127)
        end)

        local result = a.run_blocking(spawn.bash, {})
        assert.is_true(result:is_failure())
        assert.equals(
            "spawn: bash failed with exit code 127 and signal -. This is an error message for bash!",
            tostring(result:err_or_nil())
        )
    end)

    describe("Windows", function()
        before_each(function()
            platform.is.win = true
        end)

        after_each(function()
            platform.is.win = nil
        end)

        it("should use exepath to get absolute path to executable", function()
            stub(process, "spawn", function(_, _, callback)
                callback(true, 0, 0)
            end)

            local result = a.run_blocking(spawn.bash, { "arg1" })
            assert.is_true(result:is_success())
            assert.spy(process.spawn).was_called(1)
            assert.spy(process.spawn).was_called_with(
                vim.fn.exepath "bash",
                match.tbl_containing {
                    args = match.same { "arg1" },
                },
                match.is_function()
            )
        end)

        it("should not use exepath if env.PATH is set", function()
            stub(process, "spawn", function(_, _, callback)
                callback(true, 0, 0)
            end)

            local result = a.run_blocking(spawn.bash, { "arg1", env = { PATH = "C:\\some\\path" } })
            assert.is_true(result:is_success())
            assert.spy(process.spawn).was_called(1)
            assert.spy(process.spawn).was_called_with(
                "bash",
                match.tbl_containing {
                    args = match.same { "arg1" },
                },
                match.is_function()
            )
        end)

        it("should not use exepath if env_raw.PATH is set", function()
            stub(process, "spawn", function(_, _, callback)
                callback(true, 0, 0)
            end)

            local result = a.run_blocking(spawn.bash, { "arg1", env_raw = { "PATH=C:\\some\\path" } })
            assert.is_true(result:is_success())
            assert.spy(process.spawn).was_called(1)
            assert.spy(process.spawn).was_called_with(
                "bash",
                match.tbl_containing {
                    args = match.same { "arg1" },
                },
                match.is_function()
            )
        end)

        it("should not use exepath if with_paths is provided", function()
            stub(process, "spawn", function(_, _, callback)
                callback(true, 0, 0)
            end)

            local result = a.run_blocking(spawn.bash, { "arg1", with_paths = { "C:\\some\\path" } })
            assert.is_true(result:is_success())
            assert.spy(process.spawn).was_called(1)
            assert.spy(process.spawn).was_called_with(
                "bash",
                match.tbl_containing {
                    args = match.same { "arg1" },
                },
                match.is_function()
            )
        end)
    end)
end)