5b78c22813b75f174eacca40fd0b1564db0e5432
[ruby_posix_mq.git] / test / test_posix_mq.rb
blob5b78c22813b75f174eacca40fd0b1564db0e5432
1 # -*- encoding: binary -*-
2 require 'test/unit'
3 require 'thread'
4 require 'fcntl'
5 $stderr.sync = $stdout.sync = true
6 require "dl"
7 begin
8   require "dl/func"
9 rescue LoadError
10 end
11 $-w = true
12 require 'posix_mq'
14 class Test_POSIX_MQ < Test::Unit::TestCase
16   POSIX_MQ.method_defined?(:to_io) or
17     warn "POSIX_MQ#to_io not supported on this platform: #{RUBY_PLATFORM}"
18   POSIX_MQ.method_defined?(:notify) or
19     warn "POSIX_MQ#notify not supported on this platform: #{RUBY_PLATFORM}"
21   def setup
22     @mq = nil
23     @path = "/posix_mq.rb.#{Time.now.to_i}.#$$.#{rand}"
24   end
26   def teardown
27     @mq or return
28     assert_equal @mq, @mq.unlink
29     assert ! @mq.closed?
30     assert_nil @mq.close
31     assert @mq.closed?
32   end
34   def test_open_with_null_byte
35     assert_raises(ArgumentError) { POSIX_MQ.open("/hello\0world", :rw) }
36   end
38   def test_unlink_with_null_byte
39     assert_raises(ArgumentError) { POSIX_MQ.open("/hello\0world", :rw) }
40   end
42   def test_gc
43     assert_nothing_raised do
44       2025.times { POSIX_MQ.new(@path, :rw) }
45       2025.times {
46         @mq = POSIX_MQ.new(@path, :rw)
47         @mq.to_io if @mq.respond_to?(:to_io)
48       }
49     end
50   end unless defined?RUBY_ENGINE && RUBY_ENGINE == "rbx"
52   def test_name_clobber_proof
53     @mq = POSIX_MQ.new(@path, :rw)
54     tmp = @mq.name
55     tmp.freeze
56     assert_nothing_raised { @mq.name.gsub!(/\A/, "foo") }
57     assert_equal tmp, @mq.name
58     assert tmp.object_id != @mq.name.object_id
59   end
61   def test_dup_clone
62     @mq = POSIX_MQ.new(@path, :rw)
63     dup = @mq.dup
64     assert_equal @mq.object_id, dup.object_id
65     clone = @mq.clone
66     assert_equal @mq.object_id, clone.object_id
67   end
69   def test_timed_receive_float
70     interval = 0.01
71     @mq = POSIX_MQ.new(@path, :rw)
72     assert ! @mq.nonblock?
73     t0 = Time.now
74     maybe_timeout { @mq.receive "", interval } or return
75     elapsed = Time.now - t0
76     assert elapsed > interval, elapsed.inspect
77     assert elapsed < 0.02, elapsed.inspect
78   end
80   def test_timed_receive_divmod
81     interval = Object.new
82     def interval.divmod(num)
83       num == 1 ? [ 0, 0.01 ] : nil
84     end
85     @mq = POSIX_MQ.new(@path, :rw)
86     assert ! @mq.nonblock?
87     t0 = Time.now
88     maybe_timeout { @mq.receive "", interval } or return
89     elapsed = Time.now - t0
90     assert elapsed >= 0.01, elapsed.inspect
91     assert elapsed <= 0.02, elapsed.inspect
92   end
94   def test_timed_receive_fixnum
95     interval = 1
96     @mq = POSIX_MQ.new(@path, :rw)
97     assert ! @mq.nonblock?
98     t0 = Time.now
99     maybe_timeout { @mq.receive "", interval } or return
100     elapsed = Time.now - t0
101     assert elapsed >= interval, elapsed.inspect
102     assert elapsed < 1.10, elapsed.inspect
103   end
105   def test_alarm_signal_safe
106     libc = alarm = nil
107     libcs = %w(libc.so.6 libc.so.0.1 libc.so.7 /usr/lib/libc.sl)
108     libcs.each do |name|
109       libc = DL::Handle.new(name) rescue next
110       if defined?(DL::Function)
111         alarm = libc["alarm"]
112         alarm = DL::CFunc.new(alarm, DL::TYPE_INT, "alarm")
113         alarm = DL::Function.new(alarm, [DL::TYPE_INT])
114       else
115         alarm = libc["alarm", "II"]
116       end
117       break
118     end
119     alarm or return warn "alarm() not found in #{libcs.inspect}"
120     alarms = 0
121     trap("ALRM") { alarms += 1 }
122     interval = 1
123     alarm.call interval
124     @mq = POSIX_MQ.new(@path, :rw)
125     assert ! @mq.nonblock?
126     t0 = Time.now
127     a = nil
128     assert_raises(Errno::EINTR) { a = @mq.receive }
129     elapsed = Time.now - t0
130     assert_nil a
131     assert elapsed >= interval, elapsed.inspect
132     assert elapsed < 1.10, elapsed.inspect
133     assert_equal 1, alarms
134   end
136   def test_timed_send
137     interval = 0.01
138     @mq = POSIX_MQ.new(@path, :rw, 0666, POSIX_MQ::Attr[0, 1, 1, 0])
139     assert ! @mq.nonblock?
140     assert_nothing_raised {
141       begin
142         @mq.send "A", 1, interval
143       rescue NotImplementedError
144         return
145       end
146     }
147     t0 = Time.now
148     maybe_timeout { @mq.send "B", 1, interval } or return
149     elapsed = Time.now - t0
150     assert elapsed > interval
151   end
153   def test_open
154     POSIX_MQ.open(@path, IO::CREAT|IO::WRONLY, 0666) do |mq|
155       @mq = mq
156       assert mq.kind_of?(POSIX_MQ)
157       assert_equal @path, mq.name
158       assert_equal true, mq.send("HI", 0)
159       assert_equal 1, mq.attr.curmsgs
160       assert_nil mq.close
161       assert_raises(IOError) { mq.close }
162     end
163     assert @mq.closed?
164     @mq = nil
165     POSIX_MQ.unlink(@path)
166   end
168   def test_name
169     path = "" << @path.dup
170     path.freeze
171     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
172     assert_equal path, @mq.name
173   end
175   def test_new_readonly
176     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
177     rd = POSIX_MQ.new @path, IO::RDONLY
178     assert_equal @mq.name, rd.name
179     assert_nil rd.close
180   end
182   def test_send0_receive
183     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
184     assert_equal(@mq, @mq << "hello")
185     assert_equal [ "hello", 0 ], @mq.receive
186   end
188   def test_send0_chain
189     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
190     @mq << "hello" << "world"
191     assert_equal [ "hello", 0 ], @mq.receive
192     assert_equal [ "world", 0 ], @mq.receive
193   end
195   def test_shift
196     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
197     @mq << "hello"
198     assert_equal "hello", @mq.shift
199   end
201   def test_shift_buf
202     buf = ""
203     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
204     @mq << "hello"
205     assert_equal "hello", @mq.shift(buf)
206     assert_equal "hello", buf
207   end
209   def test_send_receive
210     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
211     assert_equal true, @mq.send("hello", 0)
212     assert_equal [ "hello", 0 ], @mq.receive
213   end
215   def test_send_receive_buf
216     buf = ""
217     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
218     assert_equal true, @mq.send("hello", 0)
219     assert_equal [ "hello", 0 ], @mq.receive(buf)
220     assert_equal "hello", buf
221   end
223   def test_send_receive_prio
224     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
225     assert_equal true, @mq.send("hello", 2)
226     assert_equal [ "hello", 2 ], @mq.receive
227   end
229   def test_getattr
230     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
231     mq_attr = @mq.attr
232     assert_equal POSIX_MQ::Attr, mq_attr.class
233     assert mq_attr.flags.kind_of?(Integer)
234     assert mq_attr.maxmsg.kind_of?(Integer)
235     assert mq_attr.msgsize.kind_of?(Integer)
236     assert mq_attr.curmsgs.kind_of?(Integer)
237   end
239   def test_to_io
240     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
241     assert @mq.to_io.kind_of?(IO)
242     assert_nothing_raised { IO.select([@mq], nil, nil, 0) }
243   end if POSIX_MQ.method_defined?(:to_io)
245   def test_notify
246     rd, wr = IO.pipe
247     orig = trap(:USR1) { wr.syswrite('.') }
248     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
249     assert_nothing_raised { @mq.notify = :SIGUSR1 }
250     assert_nothing_raised { @mq.send("hello", 0) }
251     assert_equal [[rd], [], []], IO.select([rd], nil, nil, 10)
252     assert_equal '.', rd.sysread(1)
253     assert_nil(@mq.notify = nil)
254     assert_nothing_raised { @mq.send("hello", 0) }
255     assert_nil IO.select([rd], nil, nil, 0.1)
256     ensure
257       trap(:USR1, orig)
258   end
260   def test_notify_none
261     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
262     assert_nothing_raised { @mq.notify = false }
263     pid = fork do
264       begin
265         @mq.notify = :USR1
266       rescue Errno::EBUSY
267         exit 0
268       rescue => e
269         p e
270       end
271       exit! 1
272     end
273     _, status = Process.waitpid2(pid)
274     assert status.success?, status.inspect
275   end
277   def test_setattr
278     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
279     mq_attr = POSIX_MQ::Attr.new(IO::NONBLOCK)
280     @mq.attr = mq_attr
281     assert_equal IO::NONBLOCK, @mq.attr.flags
282     assert mq_attr.flags.kind_of?(Integer)
284     mq_attr.flags = 0
285     @mq.attr = mq_attr
286     assert_equal 0, @mq.attr.flags
287   end
289   def test_setattr_fork
290     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
291     mq_attr = POSIX_MQ::Attr.new(IO::NONBLOCK)
292     @mq.attr = mq_attr
293     assert @mq.nonblock?
295     pid = fork { @mq.nonblock = false }
296     assert Process.waitpid2(pid)[1].success?
297     assert ! @mq.nonblock?
298   end
300   def test_new_nonblocking
301     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY|IO::NONBLOCK, 0666
302     assert @mq.nonblock?
303   end
305   def test_new_blocking
306     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
307     assert ! @mq.nonblock?
308   end
310   def test_nonblock_toggle
311     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
312     assert ! @mq.nonblock?
313     @mq.nonblock = true
314     assert @mq.nonblock?
315     @mq.nonblock = false
316     assert ! @mq.nonblock?
317     assert_raises(ArgumentError) { @mq.nonblock = nil }
318   end
320   def test_new_sym_w
321     @mq = POSIX_MQ.new @path, :w
322     assert_equal IO::WRONLY, @mq.to_io.fcntl(Fcntl::F_GETFL)
323   end if POSIX_MQ.method_defined?(:to_io)
325   def test_new_sym_r
326     @mq = POSIX_MQ.new @path, :w
327     mq = nil
328     assert_nothing_raised { mq = POSIX_MQ.new @path, :r }
329     assert_equal IO::RDONLY, mq.to_io.fcntl(Fcntl::F_GETFL)
330     assert_nil mq.close
331   end if POSIX_MQ.method_defined?(:to_io)
333   def test_new_path_only
334     @mq = POSIX_MQ.new @path, :w
335     mq = nil
336     assert_nothing_raised { mq = POSIX_MQ.new @path }
337     assert_equal IO::RDONLY, mq.to_io.fcntl(Fcntl::F_GETFL)
338     assert_nil mq.close
339   end if POSIX_MQ.method_defined?(:to_io)
341   def test_new_sym_wr
342     @mq = POSIX_MQ.new @path, :rw
343     assert_equal IO::RDWR, @mq.to_io.fcntl(Fcntl::F_GETFL)
344   end if POSIX_MQ.method_defined?(:to_io)
346   def test_new_attr
347     mq_attr = POSIX_MQ::Attr.new(IO::NONBLOCK, 1, 1, 0)
348     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666, mq_attr
349     assert @mq.nonblock?
350     assert_equal mq_attr, @mq.attr
352     assert_raises(Errno::EAGAIN) { @mq.receive }
353     assert_raises(Errno::EMSGSIZE) { @mq << '..' }
354     assert_nothing_raised { @mq << '.' }
355     assert_equal [ '.', 0 ], @mq.receive
356     assert_nothing_raised { @mq << '.' }
357     assert_raises(Errno::EAGAIN) { @mq << '.' }
358   end
360   def test_try
361     mq_attr = POSIX_MQ::Attr.new(IO::NONBLOCK, 1, 1, 0)
362     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666, mq_attr
364     assert_nil @mq.tryreceive
365     assert_nil @mq.tryshift
366     assert_equal true, @mq.trysend("a")
367     assert_equal [ "a", 0 ], @mq.tryreceive
368     assert_equal true, @mq.trysend("b")
369     assert_equal "b", @mq.tryshift
370     assert_equal true, @mq.trysend("c")
371     assert_equal false, @mq.trysend("d")
372   end
374   def test_prio_max
375     min_posix_mq_prio_max = 31 # defined by POSIX
376     assert POSIX_MQ::PRIO_MAX >= min_posix_mq_prio_max
377   end
379   def test_open_max
380     assert POSIX_MQ::OPEN_MAX.kind_of?(Integer)
381   end
383   def test_notify_block_replace
384     q = Queue.new
385     @mq = POSIX_MQ.new(@path, :rw)
386     assert_nothing_raised { @mq.notify { |mq| q << mq } }
387     assert_nothing_raised { Process.waitpid2(fork { @mq << "hi" }) }
388     assert_equal @mq.object_id, q.pop.object_id
389     assert_equal "hi", @mq.receive.first
390     assert_nothing_raised { @mq.notify { |mq| q << "hi" } }
391     assert_nothing_raised { Process.waitpid2(fork { @mq << "bye" }) }
392     assert_equal "hi", q.pop
393   end if POSIX_MQ.method_defined?(:notify)
395   def test_notify_thread
396     q = Queue.new
397     @mq = POSIX_MQ.new(@path, :rw)
398     @mq.notify { |mq| q << Thread.current }
399     @mq << "."
400     x = q.pop
401     assert x.instance_of?(Thread)
402     assert Thread.current != x
403   end if POSIX_MQ.method_defined?(:notify)
405   def test_bad_open_mode
406     assert_raises(ArgumentError) { POSIX_MQ.new(@path, "rw") }
407   end
409   def test_bad_open_attr
410     assert_raises(TypeError) { POSIX_MQ.new(@path, :rw, 0666, [0, 1, 1, 0]) }
411   end
413   def test_bad_setattr
414     @mq = POSIX_MQ.new @path, IO::CREAT|IO::WRONLY, 0666
415     assert_raises(TypeError) { @mq.attr = {} }
416     assert_raises(TypeError) { @mq.attr = Struct.new(:a,:b,:c,:d).new }
417   end
419   def maybe_timeout
420     yield
421     assert_raises(exc) { } # FAIL
422     return true
423     rescue Errno::ETIMEDOUT => e
424       return true
425     rescue NotImplementedError => e
426       warn "E: #{e}"
427       return false
428   end