File: local_test.rb

package info (click to toggle)
ruby-train 3.16.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,272 kB
  • sloc: ruby: 10,507; sh: 17; makefile: 8
file content (399 lines) | stat: -rw-r--r-- 13,996 bytes parent folder | download
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
require "helper"
require "train/transports/local"

class TransportHelper
  attr_accessor :transport

  def initialize(user_opts = {})
    opts = { platform_name: "mock", family_hierarchy: ["mock"] }.merge(user_opts)
    plat = Train::Platforms.name(opts[:platform_name])
    plat.family_hierarchy = opts[:family_hierarchy]
    plat.add_platform_methods
    Train::Platforms::Detect.stubs(:scan).returns(plat)
    @transport = Train::Transports::Local.new(user_opts)
  end
end

describe "local transport" do
  let(:transport) { TransportHelper.new.transport }
  let(:connection) { transport.connection }

  it "can be instantiated" do
    _(transport).wont_be_nil
  end

  it "gets the connection" do
    _(connection).must_be_kind_of Train::Transports::Local::Connection
  end

  it "provides a uri" do
    _(connection.uri).must_equal "local://"
  end

  it "doesnt wait to be read" do
    _(connection.wait_until_ready).must_be_nil
  end

  it "inspects with readable output" do
    _(connection.inspect).must_match(/Train::Transports::Local::Connection\[\w+\]/)
  end

  it "can be closed" do
    _(connection.close).must_be_nil
  end

  it "has no login command" do
    _(connection.login_command).must_be_nil
  end

  it "provides a run_command_via_connection method" do
    methods = connection.class.private_instance_methods(false)
    _(methods.include?(:run_command_via_connection)).must_equal true
  end

  it "provides a file_via_connection method" do
    methods = connection.class.private_instance_methods(false)
    _(methods.include?(:file_via_connection)).must_equal true
  end

  describe "when overriding runner selection" do
    it "can select the `GenericRunner`" do
      Train::Transports::Local::Connection::GenericRunner
        .expects(:new)

      Train::Transports::Local::Connection::WindowsPipeRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection::WindowsShellRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection.new(command_runner: :generic)
    end

    it "can select the `WindowsPipeRunner`" do
      Train::Transports::Local::Connection::GenericRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection::WindowsPipeRunner
        .expects(:new)

      Train::Transports::Local::Connection::WindowsShellRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection.new(command_runner: :windows_pipe)
    end

    it "can select the `WindowsShellRunner`" do
      Train::Transports::Local::Connection::GenericRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection::WindowsPipeRunner
        .expects(:new)
        .never

      Train::Transports::Local::Connection::WindowsShellRunner
        .expects(:new)

      Train::Transports::Local::Connection.new(command_runner: :windows_shell)
    end

    it "throws a RuntimeError when an invalid runner type is passed" do
      _ { Train::Transports::Local::Connection.new(command_runner: :nope ) }
        .must_raise(RuntimeError, "Runner type `:nope` not supported")
    end
  end

  describe "when running a local command" do
    let(:cmd_runner) { Minitest::Mock.new }

    def mock_run_cmd(cmd, &block)
      cmd_runner.expect :run_command, nil
      cmd_runner.expect :timeout=, nil, [nil]
      Mixlib::ShellOut.stub :new, cmd_runner do |*args|
        yield
      end
    end

    it "gets stdout" do
      mock_run_cmd(rand) do
        x = rand
        cmd_runner.expect :stdout, x
        cmd_runner.expect :stderr, nil
        cmd_runner.expect :exitstatus, nil
        _(connection.run_command(rand).stdout).must_equal x
      end
    end

    it "gets stderr" do
      mock_run_cmd(rand) do
        x = rand
        cmd_runner.expect :stdout, nil
        cmd_runner.expect :stderr, x
        cmd_runner.expect :exitstatus, nil
        _(connection.run_command(rand).stderr).must_equal x
      end
    end

    it "gets exit_status" do
      mock_run_cmd(rand) do
        x = rand
        cmd_runner.expect :stdout, nil
        cmd_runner.expect :stderr, nil
        cmd_runner.expect :exitstatus, x
        _(connection.run_command(rand).exit_status).must_equal x
      end
    end
  end

  describe "when running on Windows" do
    let(:connection) do
      TransportHelper.new(family_hierarchy: ["windows"]).transport.connection
    end
    let(:runner) { mock }

    it "uses `WindowsPipeRunner` by default" do
      Train::Transports::Local::Connection::WindowsPipeRunner
        .expects(:new)
        .returns(runner)

      Train::Transports::Local::Connection::WindowsShellRunner
        .expects(:new)
        .never

      runner.expects(:run_command).with("not actually executed", {})
      connection.run_command("not actually executed")
    end

    it "uses `WindowsShellRunner` when a named pipe is not available" do
      Train::Transports::Local::Connection::WindowsPipeRunner
        .expects(:new)
        .raises(Train::Transports::Local::PipeError)

      Train::Transports::Local::Connection::WindowsShellRunner
        .expects(:new)
        .returns(runner)

      runner.expects(:run_command).with("not actually executed", {})
      connection.run_command("not actually executed")
    end
  end

  describe "WindowsPipeRunner" do
    let(:pipe_runner_class) { Train::Transports::Local::Connection::WindowsPipeRunner }

    describe "#current_windows_user" do
      let(:runner) do
        pipe_runner_class.allocate.tap do |r|
          r.instance_variable_set(:@powershell_cmd, "powershell")
        end
      end

      it "returns user from WindowsIdentity when available" do
        runner.expects(:`).with('powershell -Command "[System.Security.Principal.WindowsIdentity]::GetCurrent().Name"').returns("DOMAIN\\testuser\n")
        result = runner.send(:current_windows_user)
        _(result).must_equal "DOMAIN\\testuser"
      end

      it "falls back to whoami when WindowsIdentity returns empty" do
        runner.expects(:`).with('powershell -Command "[System.Security.Principal.WindowsIdentity]::GetCurrent().Name"').returns("\n")
        runner.expects(:`).with("whoami").returns("domain\\fallbackuser\n")
        result = runner.send(:current_windows_user)
        _(result).must_equal "domain\\fallbackuser"
      end

      it "falls back to whoami when WindowsIdentity returns nil-like value" do
        runner.expects(:`).with('powershell -Command "[System.Security.Principal.WindowsIdentity]::GetCurrent().Name"').returns("")
        runner.expects(:`).with("whoami").returns("localuser\n")
        result = runner.send(:current_windows_user)
        _(result).must_equal "localuser"
      end

      it "raises error when both methods fail to return a user" do
        runner.expects(:`).with('powershell -Command "[System.Security.Principal.WindowsIdentity]::GetCurrent().Name"').returns("")
        runner.expects(:`).with("whoami").returns("")
        _ { runner.send(:current_windows_user) }.must_raise RuntimeError
      end
    end

    describe "#pipe_owned_by_current_user?" do
      let(:runner) do
        pipe_runner_class.allocate.tap do |r|
          r.instance_variable_set(:@powershell_cmd, "powershell")
        end
      end

      it "returns [nil, current_user, false] when pipe does not exist" do
        runner.expects(:`).with('powershell -Command "Test-Path \\\\.\\pipe\\test_pipe"').returns("false\n")
        runner.expects(:current_windows_user).returns("DOMAIN\\testuser")
        owner, current_user, is_owner = runner.send(:pipe_owned_by_current_user?, "test_pipe")
        _(owner).must_be_nil
        _(current_user).must_equal "DOMAIN\\testuser"
        _(is_owner).must_equal false
      end

      it "returns [owner, current_user, true] when pipe exists and is owned by current user" do
        runner.expects(:`).with('powershell -Command "Test-Path \\\\.\\pipe\\test_pipe"').returns("true\n")
        runner.expects(:current_windows_user).returns("DOMAIN\\testuser")
        runner.expects(:`).with('powershell -Command "(Get-Acl \\\\.\\pipe\\test_pipe).Owner" 2>&1').returns("DOMAIN\\testuser\n")
        owner, current_user, is_owner = runner.send(:pipe_owned_by_current_user?, "test_pipe")
        _(owner).must_equal "DOMAIN\\testuser"
        _(current_user).must_equal "DOMAIN\\testuser"
        _(is_owner).must_equal true
      end

      it "returns [owner, current_user, false] when pipe is owned by different user" do
        runner.expects(:`).with('powershell -Command "Test-Path \\\\.\\pipe\\test_pipe"').returns("true\n")
        runner.expects(:current_windows_user).returns("DOMAIN\\testuser")
        runner.expects(:`).with('powershell -Command "(Get-Acl \\\\.\\pipe\\test_pipe).Owner" 2>&1').returns("DOMAIN\\otheruser\n")
        owner, current_user, is_owner = runner.send(:pipe_owned_by_current_user?, "test_pipe")
        _(owner).must_equal "DOMAIN\\otheruser"
        _(current_user).must_equal "DOMAIN\\testuser"
        _(is_owner).must_equal false
      end

      it "performs case-insensitive comparison for ownership" do
        runner.expects(:`).with('powershell -Command "Test-Path \\\\.\\pipe\\test_pipe"').returns("true\n")
        runner.expects(:current_windows_user).returns("domain\\TESTUSER")
        runner.expects(:`).with('powershell -Command "(Get-Acl \\\\.\\pipe\\test_pipe).Owner" 2>&1').returns("DOMAIN\\testuser\n")
        _owner, _current_user, is_owner = runner.send(:pipe_owned_by_current_user?, "test_pipe")
        _(is_owner).must_equal true
      end
    end

    describe "#acquire_pipe" do
      let(:runner) do
        pipe_runner_class.allocate.tap do |r|
          r.instance_variable_set(:@powershell_cmd, "powershell")
          r.instance_variable_set(:@server_pid, nil)
        end
      end

      before do
        runner.stubs(:require).with("win32/process").returns(true)
      end

      it "raises PipeError when pipe is owned by unauthorized user" do
        runner.expects(:start_pipe_server).with(anything).returns(12345)
        runner.expects(:pipe_owned_by_current_user?).with(anything).returns(["DOMAIN\\otheruser", "DOMAIN\\testuser", false])
        runner.stubs(:close)

        _ { runner.send(:acquire_pipe) }.must_raise Train::Transports::Local::PipeError
      end

      it "waits for pipe to be created before verifying ownership" do
        mock_pipe = mock("pipe")
        runner.expects(:start_pipe_server).with(anything).returns(12345)
        runner.expects(:pipe_owned_by_current_user?).with(anything).twice.returns(
          [nil, "DOMAIN\\testuser", false],
          ["DOMAIN\\testuser", "DOMAIN\\testuser", true]
        )
        runner.expects(:open).with(anything, "r+").returns(mock_pipe)
        runner.stubs(:close)

        result = runner.send(:acquire_pipe)
        _(result).must_equal mock_pipe
      end
    end

    describe "#acquire_pipe retry behavior" do
      let(:runner) do
        pipe_runner_class.allocate.tap do |r|
          r.instance_variable_set(:@powershell_cmd, "powershell")
          r.instance_variable_set(:@server_pid, nil)
        end
      end

      before do
        runner.stubs(:require).with("win32/process").returns(true)
        runner.stubs(:sleep)
      end

      it "retries when pipe is not immediately available" do
        mock_pipe = mock("pipe")
        runner.expects(:start_pipe_server).returns(12345)
        runner.expects(:pipe_owned_by_current_user?).times(3).returns(
          [nil, "DOMAIN\\user", false],
          [nil, "DOMAIN\\user", false],
          ["DOMAIN\\user", "DOMAIN\\user", true]
        )
        runner.expects(:open).returns(mock_pipe)

        result = runner.send(:acquire_pipe)
        _(result).must_equal mock_pipe
      end

      it "retries when pipe open fails transiently" do
        mock_pipe = mock("pipe")
        runner.expects(:start_pipe_server).returns(12345)
        runner.expects(:pipe_owned_by_current_user?).returns(
          ["DOMAIN\\user", "DOMAIN\\user", true]
        )

        open_attempts = 0
        runner.stubs(:open).with { |path, mode|
          open_attempts += 1
          if open_attempts < 3
            raise Errno::ENOENT
          end

          true
        }.returns(mock_pipe)

        result = runner.send(:acquire_pipe)
        _(result).must_equal mock_pipe
      end

      it "returns nil after exhausting all retries" do
        runner.expects(:start_pipe_server).returns(12345)
        runner.expects(:pipe_owned_by_current_user?).at_least_once.returns([nil, "DOMAIN\\user", false])

        result = runner.send(:acquire_pipe)
        _(result).must_be_nil
      end
    end

    describe "#run_command pipe recovery" do
      let(:runner) do
        pipe_runner_class.allocate.tap do |r|
          r.instance_variable_set(:@powershell_cmd, "powershell")
          r.instance_variable_set(:@server_pid, 12345)
        end
      end

      it "retries with new pipe when Errno::EPIPE occurs" do
        old_pipe = mock("old_pipe")
        new_pipe = mock("new_pipe")
        runner.instance_variable_set(:@pipe, old_pipe)

        old_pipe.expects(:puts).raises(Errno::EPIPE)
        runner.expects(:close).once
        runner.expects(:acquire_pipe).returns(new_pipe)

        new_pipe.expects(:puts).with(anything)
        new_pipe.expects(:flush)
        new_pipe.expects(:readline).returns(Base64.encode64('{"stdout":"ok","stderr":"","exitstatus":0}'))

        result = runner.run_command("test-command", {})

        _(result.stdout).must_equal "ok"
        _(result.exit_status).must_equal 0
      end

      it "raises PipeError when recovery fails" do
        old_pipe = mock("old_pipe")
        runner.instance_variable_set(:@pipe, old_pipe)

        old_pipe.expects(:puts).raises(Errno::EPIPE)
        runner.expects(:close).once
        runner.expects(:acquire_pipe).returns(nil)

        _ { runner.run_command("test-command", {}) }.must_raise Train::Transports::Local::PipeError
      end
    end
  end
end