summaryrefslogtreecommitdiff
path: root/spec/ruby/core/signal/trap_spec.rb
blob: 867094d6dd00aded01f5f20d1134c366a3be7fb0 (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
require_relative '../../spec_helper'

platform_is_not :windows do
  describe "Signal.trap" do
    before :each do
      ScratchPad.clear

      @proc = lambda { ScratchPad.record :proc_trap }
      @saved_trap = Signal.trap(:HUP, @proc)
    end

    after :each do
      Signal.trap(:HUP, @saved_trap) if @saved_trap
    end

    it "returns the previous handler" do
      Signal.trap(:HUP, @saved_trap).should equal(@proc)
    end

    it "accepts a block in place of a proc/command argument" do
      done = false

      Signal.trap(:HUP) do
        ScratchPad.record :block_trap
        done = true
      end

      Process.kill :HUP, Process.pid
      Thread.pass until done

      ScratchPad.recorded.should == :block_trap
    end

    it "is possible to create a new Thread when the handler runs" do
      done = false

      Signal.trap(:HUP) do
        thr = Thread.new { }
        thr.join
        ScratchPad.record(thr.group == Thread.main.group)

        done = true
      end

      Process.kill :HUP, Process.pid
      Thread.pass until done

      ScratchPad.recorded.should be_true
    end

    it "ignores the signal when passed nil" do
      Signal.trap :HUP, nil
      Signal.trap(:HUP, @saved_trap).should be_nil
    end

    it "accepts 'DEFAULT' as a symbol in place of a proc" do
      Signal.trap :HUP, :DEFAULT
      Signal.trap(:HUP, :DEFAULT).should == "DEFAULT"
    end

    it "accepts 'SIG_DFL' as a symbol in place of a proc" do
      Signal.trap :HUP, :SIG_DFL
      Signal.trap(:HUP, :SIG_DFL).should == "DEFAULT"
    end

    it "accepts 'SIG_IGN' as a symbol in place of a proc" do
      Signal.trap :HUP, :SIG_IGN
      Signal.trap(:HUP, :SIG_IGN).should == "IGNORE"
    end

    it "accepts 'IGNORE' as a symbol in place of a proc" do
      Signal.trap :HUP, :IGNORE
      Signal.trap(:HUP, :IGNORE).should == "IGNORE"
    end

    it "accepts long names as Strings" do
      Signal.trap "SIGHUP", @proc
      Signal.trap("SIGHUP", @saved_trap).should equal(@proc)
    end

    it "acceps short names as Strings" do
      Signal.trap "HUP", @proc
      Signal.trap("HUP", @saved_trap).should equal(@proc)
    end

    it "accepts long names as Symbols" do
      Signal.trap :SIGHUP, @proc
      Signal.trap(:SIGHUP, @saved_trap).should equal(@proc)
    end

    it "accepts short names as Symbols" do
      Signal.trap :HUP, @proc
      Signal.trap(:HUP, @saved_trap).should equal(@proc)
    end

    it "accepts 'SIG_DFL' in place of a proc" do
      Signal.trap :HUP, "SIG_DFL"
      Signal.trap(:HUP, @saved_trap).should == "DEFAULT"
    end

    it "accepts 'DEFAULT' in place of a proc" do
      Signal.trap :HUP, "DEFAULT"
      Signal.trap(:HUP, @saved_trap).should == "DEFAULT"
    end

    it "accepts 'SIG_IGN' in place of a proc" do
      Signal.trap :HUP, "SIG_IGN"
      Signal.trap(:HUP, "SIG_IGN").should == "IGNORE"
    end

    it "accepts 'IGNORE' in place of a proc" do
      Signal.trap :HUP, "IGNORE"
      Signal.trap(:HUP, "IGNORE").should == "IGNORE"
    end
  end

  describe "Signal.trap" do
    cannot_be_trapped = %w[KILL STOP] # See man 2 signal
    reserved_signals = %w[VTALRM]

    if PlatformGuard.implementation?(:ruby)
      reserved_signals += %w[SEGV ILL FPE BUS]
    end

    if PlatformGuard.implementation?(:truffleruby)
      if !TruffleRuby.native?
        reserved_signals += %w[SEGV ILL FPE USR1 QUIT]
      end
    end

    if PlatformGuard.implementation?(:jruby)
      reserved_signals += %w[SEGV ILL FPE BUS USR1 QUIT]
    end

    cannot_be_trapped.each do |signal|
      it "raises ArgumentError or Errno::EINVAL for SIG#{signal}" do
        -> {
          trap(signal, -> {})
        }.should raise_error(StandardError) { |e|
          [ArgumentError, Errno::EINVAL].should include(e.class)
          e.message.should =~ /Invalid argument|Signal already used by VM or OS/
        }
      end
    end

    reserved_signals.each do |signal|
      it "raises ArgumentError for reserved signal: SIG#{signal}" do
        -> {
          trap(signal, -> {})
        }.should raise_error(ArgumentError, /can't trap reserved signal|Signal already used by VM or OS/)
      end
    end

    it "allows to register a handler for all known signals, except reserved signals" do
      excluded = cannot_be_trapped + reserved_signals
      out = ruby_exe(fixture(__FILE__, "trap_all.rb"), args: [*excluded, "2>&1"])
      out.should == "OK\n"
      $?.exitstatus.should == 0
    end

    it "returns SYSTEM_DEFAULT if passed DEFAULT and no handler was ever set" do
      Signal.trap("PROF", "DEFAULT").should == "SYSTEM_DEFAULT"
    end
  end
end

describe "Signal.trap" do
  describe "the special EXIT signal code" do
    it "accepts the EXIT code" do
      code = "trap(:EXIT, proc { print 1 })"
      ruby_exe(code).should == "1"
    end

    it "runs the proc before at_exit handlers" do
      code = "at_exit {print 1}; trap(:EXIT, proc {print 2}); at_exit {print 3}"
      ruby_exe(code).should == "231"
    end

    it "can unset the handler" do
      code = "trap(:EXIT, proc { print 1 }); trap(:EXIT, 'DEFAULT')"
      ruby_exe(code).should == ""
    end
  end
end