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
|
# Copyright 2015 gRPC authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'grpc'
require 'grpc/health/v1/health_pb'
require 'grpc/health/checker'
require 'open3'
require 'tmpdir'
def can_run_codegen_check
system('which grpc_ruby_plugin') && system('which protoc')
end
describe 'Health protobuf code generation' do
context 'the health service file used by grpc/health/checker' do
if !can_run_codegen_check
skip 'protoc || grpc_ruby_plugin missing, cannot verify health code-gen'
else
it 'should already be loaded indirectly i.e, used by the other specs' do
expect(require('grpc/health/v1/health_services_pb')).to be(false)
end
it 'should have the same content as created by code generation' do
root_dir = File.join(File.dirname(__FILE__), '..', '..', '..', '..')
pb_dir = File.join(root_dir, 'proto')
# Get the current content
service_path = File.join(root_dir, 'ruby', 'pb', 'grpc',
'health', 'v1', 'health_services_pb.rb')
want = nil
File.open(service_path) { |f| want = f.read }
# Regenerate it
plugin, = Open3.capture2('which', 'grpc_ruby_plugin')
plugin = plugin.strip
got = nil
Dir.mktmpdir do |tmp_dir|
gen_out = File.join(tmp_dir, 'grpc', 'health', 'v1',
'health_services_pb.rb')
pid = spawn(
'protoc',
'-I.',
'grpc/health/v1/health.proto',
"--grpc_out=#{tmp_dir}",
"--plugin=protoc-gen-grpc=#{plugin}",
chdir: pb_dir)
Process.wait(pid)
File.open(gen_out) { |f| got = f.read }
end
expect(got).to eq(want)
end
end
end
end
describe Grpc::Health::Checker do
StatusCodes = GRPC::Core::StatusCodes
ServingStatus = Grpc::Health::V1::HealthCheckResponse::ServingStatus
HCResp = Grpc::Health::V1::HealthCheckResponse
HCReq = Grpc::Health::V1::HealthCheckRequest
success_tests =
[
{
desc: 'the service is not specified',
service: ''
}, {
desc: 'the service is specified',
service: 'fake-service-1'
}
]
context 'initialization' do
it 'can be constructed with no args' do
checker = Grpc::Health::Checker.new
expect(checker).to_not be(nil)
end
end
context 'method `add_status` and `check`' do
success_tests.each do |t|
it "should succeed when #{t[:desc]}" do
checker = Grpc::Health::Checker.new
checker.add_status(t[:service], ServingStatus::NOT_SERVING)
got = checker.check(HCReq.new(service: t[:service]), nil)
want = HCResp.new(status: ServingStatus::NOT_SERVING)
expect(got).to eq(want)
end
end
end
context 'method `add_statuses`' do
it 'should add status to each service' do
checker = Grpc::Health::Checker.new
checker.add_statuses(
'service1' => ServingStatus::SERVING,
'service2' => ServingStatus::NOT_SERVING
)
service1_health = checker.check(HCReq.new(service: 'service1'), nil)
service2_health = checker.check(HCReq.new(service: 'service2'), nil)
expect(service1_health).to eq(HCResp.new(status: ServingStatus::SERVING))
expect(service2_health).to eq(HCResp.new(status: ServingStatus::NOT_SERVING))
end
end
context 'method `set_status_for_services`' do
it 'should add given status to all given services' do
checker = Grpc::Health::Checker.new
checker.set_status_for_services(
ServingStatus::SERVING,
'service1',
'service2'
)
service1_health = checker.check(HCReq.new(service: 'service1'), nil)
service2_health = checker.check(HCReq.new(service: 'service2'), nil)
expect(service1_health).to eq(HCResp.new(status: ServingStatus::SERVING))
expect(service2_health).to eq(HCResp.new(status: ServingStatus::SERVING))
end
end
context 'method `check`' do
success_tests.each do |t|
it "should fail with NOT_FOUND when #{t[:desc]}" do
checker = Grpc::Health::Checker.new
blk = proc do
checker.check(HCReq.new(service: t[:service]), nil)
end
expected_msg = /#{StatusCodes::NOT_FOUND}/
expect(&blk).to raise_error GRPC::NotFound, expected_msg
end
end
end
context 'method `clear_status`' do
success_tests.each do |t|
it "should fail after clearing status when #{t[:desc]}" do
checker = Grpc::Health::Checker.new
checker.add_status(t[:service], ServingStatus::NOT_SERVING)
got = checker.check(HCReq.new(service: t[:service]), nil)
want = HCResp.new(status: ServingStatus::NOT_SERVING)
expect(got).to eq(want)
checker.clear_status(t[:service])
blk = proc do
checker.check(HCReq.new(service: t[:service]), nil)
end
expected_msg = /#{StatusCodes::NOT_FOUND}/
expect(&blk).to raise_error GRPC::NotFound, expected_msg
end
end
end
context 'method `clear_all`' do
it 'should return NOT_FOUND after being invoked' do
checker = Grpc::Health::Checker.new
success_tests.each do |t|
checker.add_status(t[:service], ServingStatus::NOT_SERVING)
got = checker.check(HCReq.new(service: t[:service]), nil)
want = HCResp.new(status: ServingStatus::NOT_SERVING)
expect(got).to eq(want)
end
checker.clear_all
success_tests.each do |t|
blk = proc do
checker.check(HCReq.new(service: t[:service]), nil)
end
expected_msg = /#{StatusCodes::NOT_FOUND}/
expect(&blk).to raise_error GRPC::NotFound, expected_msg
end
end
end
describe 'running on RpcServer' do
RpcServer = GRPC::RpcServer
CheckerStub = Grpc::Health::Checker.rpc_stub_class
before(:each) do
server_host = '0.0.0.0:0'
@client_opts = { channel_override: @ch }
server_opts = {
poll_period: 1
}
@srv = RpcServer.new(**server_opts)
server_port = @srv.add_http2_port(server_host, :this_port_is_insecure)
@host = "localhost:#{server_port}"
@ch = GRPC::Core::Channel.new(@host, nil, :this_channel_is_insecure)
end
after(:each) do
@srv.stop
end
it 'should receive the correct status', server: true do
Thread.abort_on_exception = true
checker = Grpc::Health::Checker.new
@srv.handle(checker)
checker.add_status('', ServingStatus::NOT_SERVING)
t = Thread.new { @srv.run }
@srv.wait_till_running
stub = CheckerStub.new(@host, :this_channel_is_insecure, **@client_opts)
got = stub.check(HCReq.new)
want = HCResp.new(status: ServingStatus::NOT_SERVING)
expect(got).to eq(want)
@srv.stop
t.join
end
it 'should fail on unknown services', server: true do
checker = Grpc::Health::Checker.new
@srv.handle(checker)
t = Thread.new { @srv.run }
@srv.wait_till_running
blk = proc do
stub = CheckerStub.new(@host, :this_channel_is_insecure, **@client_opts)
stub.check(HCReq.new(service: 'unknown'))
end
expected_msg = /#{StatusCodes::NOT_FOUND}/
expect(&blk).to raise_error GRPC::NotFound, expected_msg
@srv.stop
t.join
end
end
end
|
