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
|
require "common"
class UploadTest < Net::SFTP::TestCase
def setup
prepare_progress!
end
def test_upload_file_should_send_file_contents
expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
assert_scripted_command { sftp.upload("/path/to/local", "/path/to/remote") }
end
def test_upload_file_without_remote_uses_filename_of_local_file
expect_file_transfer("/path/to/local", "local", "here are the contents")
assert_scripted_command do
sftp.upload("/path/to/local") { |*args| record_progress(args) }
end
assert_progress_reported_open(:remote => "local")
assert_progress_reported_put(0, "here are the contents", :remote => "local")
assert_progress_reported_close(:remote => "local")
assert_progress_reported_finish
assert_no_more_reported_events
end
def test_upload_file_with_progress_should_report_progress
expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
assert_scripted_command do
sftp.upload("/path/to/local", "/path/to/remote") { |*args| record_progress(args) }
end
assert_progress_reported_open(:remote => "/path/to/remote")
assert_progress_reported_put(0, "here are the contents", :remote => "/path/to/remote")
assert_progress_reported_close(:remote => "/path/to/remote")
assert_progress_reported_finish
assert_no_more_reported_events
end
def test_upload_file_with_progress_handler_should_report_progress
expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
assert_scripted_command do
sftp.upload("/path/to/local", "/path/to/remote", :progress => ProgressHandler.new(@progress))
end
assert_progress_reported_open(:remote => "/path/to/remote")
assert_progress_reported_put(0, "here are the contents", :remote => "/path/to/remote")
assert_progress_reported_close(:remote => "/path/to/remote")
assert_progress_reported_finish
assert_no_more_reported_events
end
def test_upload_file_should_read_chunks_of_size(requested_size=nil)
size = requested_size || Net::SFTP::Operations::Upload::DEFAULT_READ_SIZE
expect_sftp_session :server_version => 3 do |channel|
channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "a" * size)
channel.sends_packet(FXP_WRITE, :long, 2, :string, "handle", :int64, size, :string, "b" * size)
channel.sends_packet(FXP_WRITE, :long, 3, :string, "handle", :int64, size*2, :string, "c" * size)
channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
channel.sends_packet(FXP_WRITE, :long, 4, :string, "handle", :int64, size*3, :string, "d" * size)
channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
channel.sends_packet(FXP_CLOSE, :long, 5, :string, "handle")
channel.gets_packet(FXP_STATUS, :long, 3, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 4, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 5, :long, 0)
end
expect_file("/path/to/local", "a" * size + "b" * size + "c" * size + "d" * size)
assert_scripted_command do
opts = {}
opts[:read_size] = size if requested_size
sftp.upload("/path/to/local", "/path/to/remote", opts)
end
end
def test_upload_file_with_custom_read_size_should_read_chunks_of_that_size
test_upload_file_should_read_chunks_of_size(100)
end
def test_upload_file_with_custom_requests_should_start_that_many_writes
size = Net::SFTP::Operations::Upload::DEFAULT_READ_SIZE
expect_sftp_session :server_version => 3 do |channel|
channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "a" * size)
channel.sends_packet(FXP_WRITE, :long, 2, :string, "handle", :int64, size, :string, "b" * size)
channel.sends_packet(FXP_WRITE, :long, 3, :string, "handle", :int64, size*2, :string, "c" * size)
channel.sends_packet(FXP_WRITE, :long, 4, :string, "handle", :int64, size*3, :string, "d" * size)
channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
channel.sends_packet(FXP_CLOSE, :long, 5, :string, "handle")
channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 3, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 4, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 5, :long, 0)
end
expect_file("/path/to/local", "a" * size + "b" * size + "c" * size + "d" * size)
assert_scripted_command do
sftp.upload("/path/to/local", "/path/to/remote", :requests => 3)
end
end
def test_upload_directory_should_mirror_directory_structure_remotely
prepare_directory
assert_scripted_command do
sftp.upload("/path/to/local", "/path/to/remote", :mkdir => true)
end
end
def test_upload_directory_with_handler_should_report_progress
prepare_directory
assert_scripted_command do
sftp.upload("/path/to/local", "/path/to/remote", :mkdir => true) { |*args| record_progress(args) }
end
assert_progress_reported_open(:remote => "/path/to/remote/file1")
assert_progress_reported_open(:remote => "/path/to/remote/file2")
assert_progress_reported_open(:remote => "/path/to/remote/file3")
assert_progress_reported_mkdir("/path/to/remote/subdir")
assert_progress_reported_open(:remote => "/path/to/remote/subdir/other1")
assert_progress_reported_open(:remote => "/path/to/remote/subdir/other2")
assert_progress_reported_put(0, "contents of file1", :remote => "/path/to/remote/file1")
assert_progress_reported_put(0, "contents of file2", :remote => "/path/to/remote/file2")
assert_progress_reported_put(0, "contents of file3", :remote => "/path/to/remote/file3")
assert_progress_reported_close(:remote => "/path/to/remote/file1")
assert_progress_reported_put(0, "contents of other1", :remote => "/path/to/remote/subdir/other1")
assert_progress_reported_put(0, "contents of other2", :remote => "/path/to/remote/subdir/other2")
assert_progress_reported_close(:remote => "/path/to/remote/file2")
assert_progress_reported_close(:remote => "/path/to/remote/file3")
assert_progress_reported_close(:remote => "/path/to/remote/subdir/other1")
assert_progress_reported_close(:remote => "/path/to/remote/subdir/other2")
assert_progress_reported_finish
assert_no_more_reported_events
end
def test_upload_io_should_send_io_as_file
expect_sftp_session :server_version => 3 do |channel|
channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "this is some text")
channel.sends_packet(FXP_CLOSE, :long, 2, :string, "handle")
channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
end
assert_scripted_command do
sftp.upload(StringIO.new("this is some text"), "/path/to/remote")
end
end
private
def prepare_directory
expect_directory("/path/to/local", %w(. .. file1 file2 file3 subdir))
expect_directory("/path/to/local/subdir", %w(. .. other1 other2))
expect_file("/path/to/local/file1", "contents of file1")
expect_file("/path/to/local/file2", "contents of file2")
expect_file("/path/to/local/file3", "contents of file3")
expect_file("/path/to/local/subdir/other1", "contents of other1")
expect_file("/path/to/local/subdir/other2", "contents of other2")
expect_sftp_session :server_version => 3 do |ch|
ch.sends_packet(FXP_MKDIR, :long, 0, :string, "/path/to/remote", :long, 0)
ch.gets_packet(FXP_STATUS, :long, 0, :long, 0)
ch.sends_packet(FXP_OPEN, :long, 1, :string, "/path/to/remote/file1", :long, 0x1A, :long, 0)
ch.sends_packet(FXP_OPEN, :long, 2, :string, "/path/to/remote/file2", :long, 0x1A, :long, 0)
ch.sends_packet(FXP_OPEN, :long, 3, :string, "/path/to/remote/file3", :long, 0x1A, :long, 0)
ch.sends_packet(FXP_MKDIR, :long, 4, :string, "/path/to/remote/subdir", :long, 0)
ch.sends_packet(FXP_OPEN, :long, 5, :string, "/path/to/remote/subdir/other1", :long, 0x1A, :long, 0)
ch.sends_packet(FXP_OPEN, :long, 6, :string, "/path/to/remote/subdir/other2", :long, 0x1A, :long, 0)
ch.gets_packet(FXP_HANDLE, :long, 1, :string, "hfile1")
ch.sends_packet(FXP_WRITE, :long, 7, :string, "hfile1", :int64, 0, :string, "contents of file1")
ch.gets_packet(FXP_HANDLE, :long, 2, :string, "hfile2")
ch.sends_packet(FXP_WRITE, :long, 8, :string, "hfile2", :int64, 0, :string, "contents of file2")
ch.gets_packet(FXP_HANDLE, :long, 3, :string, "hfile3")
ch.sends_packet(FXP_WRITE, :long, 9, :string, "hfile3", :int64, 0, :string, "contents of file3")
ch.gets_packet(FXP_STATUS, :long, 4, :long, 0)
ch.gets_packet(FXP_HANDLE, :long, 5, :string, "hother1")
ch.sends_packet(FXP_CLOSE, :long, 10, :string, "hfile1")
ch.sends_packet(FXP_WRITE, :long, 11, :string, "hother1", :int64, 0, :string, "contents of other1")
ch.gets_packet(FXP_HANDLE, :long, 6, :string, "hother2")
ch.sends_packet(FXP_WRITE, :long, 12, :string, "hother2", :int64, 0, :string, "contents of other2")
ch.gets_packet(FXP_STATUS, :long, 7, :long, 0)
ch.sends_packet(FXP_CLOSE, :long, 13, :string, "hfile2")
ch.gets_packet(FXP_STATUS, :long, 8, :long, 0)
ch.sends_packet(FXP_CLOSE, :long, 14, :string, "hfile3")
ch.gets_packet(FXP_STATUS, :long, 9, :long, 0)
ch.sends_packet(FXP_CLOSE, :long, 15, :string, "hother1")
ch.gets_packet(FXP_STATUS, :long, 10, :long, 0)
ch.sends_packet(FXP_CLOSE, :long, 16, :string, "hother2")
ch.gets_packet(FXP_STATUS, :long, 11, :long, 0)
ch.gets_packet(FXP_STATUS, :long, 12, :long, 0)
ch.gets_packet(FXP_STATUS, :long, 13, :long, 0)
ch.gets_packet(FXP_STATUS, :long, 14, :long, 0)
ch.gets_packet(FXP_STATUS, :long, 15, :long, 0)
ch.gets_packet(FXP_STATUS, :long, 16, :long, 0)
end
end
def expect_file(path, data)
File.stubs(:directory?).with(path).returns(false)
File.stubs(:exists?).with(path).returns(true)
file = StringIO.new(data)
file.stubs(:stat).returns(stub("stat", :size => data.length))
File.stubs(:open).with(path, "rb").returns(file)
end
def expect_directory(path, entries)
Dir.stubs(:entries).with(path).returns(entries)
File.stubs(:directory?).with(path).returns(true)
end
def expect_file_transfer(local, remote, data)
expect_sftp_session :server_version => 3 do |channel|
channel.sends_packet(FXP_OPEN, :long, 0, :string, remote, :long, 0x1A, :long, 0)
channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, data)
channel.sends_packet(FXP_CLOSE, :long, 2, :string, "handle")
channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
end
expect_file(local, data)
end
end
|
