Add boot test for sagittarius grpc server

Author: Taucher2003

.gitlab/ci/container-boot.gitlab-ci.yml

@@ -17,6 +17,7 @@
   variables:
     SAGITTARIUS_IMAGE: ghcr.io/code0-tech/reticulum/ci-builds/sagittarius:${CI_PIPELINE_ID}-${VARIANT}
     CURL_IMAGE: curlimages/curl:8.5.0
+    DOCKER_ARGS: ""
   before_script:
     - docker network create boot
     - >
@@ -37,6 +38,7 @@
       --network boot
       --network-alias sagittarius
       --volume $(pwd)/container/sagittarius/sagittarius.yml:/sagittarius/config/sagittarius.yml
+      $DOCKER_ARGS
       $SAGITTARIUS_IMAGE
       $SAGITTARIUS_CMD &
 
@@ -58,3 +60,18 @@ container:boot:sagittarius:rails-web:
       --retry-delay 3
       --retry-connrefused
       http://sagittarius:3000/health/liveness
+
+container:boot:sagittarius:grpc:
+  extends:
+    - .container:boot:sagittarius
+  variables:
+    SAGITTARIUS_CMD: "bin/grpc_server"
+    DOCKER_ARGS: "--publish 127.0.0.1:50051:50051 --env SAGITTARIUS_PREPARE_DATABASE=true"
+  before_script:
+    - apk add libc6-compat
+    - bundle config set --local force_ruby_platform true
+    - bundle install
+    - !reference [.container:boot:sagittarius, before_script]
+  script:
+    - scripts/grpc_check_health --host 127.0.0.1:50051 --service liveness --retries 20
+    - scripts/grpc_check_health --host 127.0.0.1:50051 --service readiness --retries 20

Gemfile

@@ -3,3 +3,7 @@
 source "https://rubygems.org"
 
 gem "erb"
+
+gem "grpc", "~> 1.73"
+
+gem "optparse", "~> 0.6.0"

Gemfile.lock

@@ -1,13 +1,26 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    bigdecimal (3.2.2)
     erb (5.0.1)
+    google-protobuf (4.31.1)
+      bigdecimal
+      rake (>= 13)
+    googleapis-common-protos-types (1.20.0)
+      google-protobuf (>= 3.18, < 5.a)
+    grpc (1.73.0)
+      google-protobuf (>= 3.25, < 5.0)
+      googleapis-common-protos-types (~> 1.0)
+    optparse (0.6.0)
+    rake (13.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   erb
+  grpc (~> 1.73)
+  optparse (~> 0.6.0)
 
 BUNDLED WITH
    2.6.6

scripts/grpc_check_health

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'grpc'
+require 'optparse'
+require 'grpc/health/v1/health_services_pb'
+
+options = {
+  retries: 5,
+  backoff: 3,
+  service: '',
+}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: grpc_check_health [options]'
+
+  opts.on('-h', '--host [HOST]', String, 'Host of the grpc server to check') do |host|
+    options[:host] = host
+  end
+
+  opts.on('-r', '--retries [RETRIES]', Integer, "Amount of retries (Default: #{options[:retries]})") do |retries|
+    options[:retries] = retries
+  end
+
+  opts.on('-b', '--backoff [BACKOFF]', Integer, "Backoff in seconds for each attempt (Default: #{options[:backoff]})") do |backoff|
+    options[:backoff] = backoff
+  end
+
+  opts.on('-s', '--service [SERVICE]', String, "Service check health for (Default: '#{options[:service]}')") do |service|
+    options[:service] = service
+  end
+end
+optparse.parse!
+
+missing = %i[host].select{ |param| options[param].nil? }
+unless missing.empty?
+  puts "Missing arguments: #{missing.join(', ')}"
+  puts
+  puts optparse
+  exit
+end
+
+RetryException = Class.new(StandardError)
+
+attempt = 0
+
+stub = Grpc::Health::V1::Health::Stub.new(options[:host], :this_channel_is_insecure)
+begin
+  message = Grpc::Health::V1::HealthCheckRequest.new(service: options[:service])
+
+  response = stub.check(message)
+
+  if response.status == :SERVING
+    puts "Service '#{options[:service]}' on #{options[:host]} is #{response.status}"
+  else
+    raise RetryException
+  end
+rescue GRPC::BadStatus, RetryException => e
+  if e.is_a?(GRPC::BadStatus)
+    message = e.inspect
+  else
+    message = "Service #{options[:service]} on #{options[:host]} is not SERVING (status is #{response&.status})"
+  end
+
+  attempt += 1
+  if attempt <= options[:retries]
+    puts message
+    puts "Retrying in #{options[:backoff]}s"
+    sleep options[:backoff]
+    retry
+  end
+
+  abort message
+end