gha: run ruby e2e tests in github (#2558)

Author: svix-jbrown

.github/workflows/ruby-lint.yml

@@ -1,11 +1,11 @@
-name: Ruby Lint
+name: Ruby Lint and Tests
 
 on:
   workflow_call:
 
 jobs:
   ruby:
-    name: Ruby Lint
+    name: Ruby Lint and Tests and Tests
     runs-on: ubuntu-24.04
 
     strategy:
@@ -15,22 +15,23 @@ jobs:
     steps:
       - uses: actions/checkout@v7
 
+      - name: Pull svix server image (and dependencies)
+        run: docker compose pull
+        working-directory: ./client-integration-tests
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby-version }}
 
       - name: Install dependencies
-        run: |
-          cd ruby
-          bundler install
+        working-directory: ruby
+        run: bundle install
 
       - name: Build
-        run: |
-          cd ruby
-          bundler exec rake build
+        working-directory: ruby
+        run: bundle exec rake build
 
       - name: Test
-        run: |
-          cd ruby
-          bundler exec rspec spec
+        working-directory: ruby
+        run: bundle exec rspec spec

ruby/Gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 gem 'base64'
 gem 'logger'
 gem 'ostruct'
+gem "irb"
 
 gemspec

ruby/Gemfile.lock

@@ -16,11 +16,33 @@ GEM
       bigdecimal
       rexml
     diff-lcs (1.6.2)
+    erb (6.0.7)
     hashdiff (1.2.1)
+    io-console (0.9.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     logger (1.7.0)
     ostruct (0.6.3)
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
     public_suffix (7.0.5)
     rake (13.4.1)
+    rbs (4.1.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    reline (0.7.0)
+      io-console (~> 0.5)
     rexml (3.4.4)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -35,6 +57,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
+    subprocess (1.5.7)
+    tsort (0.2.0)
     webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -45,10 +69,12 @@ PLATFORMS
 
 DEPENDENCIES
   base64
+  irb (~> 1.18)
   logger
   ostruct
   rake (~> 13.0)
   rspec (~> 3.2)
+  subprocess (~> 1.5)
   svix!
   webmock (~> 3.25)
 

ruby/spec/kitchen_sink_spec.rb

@@ -1,46 +1,99 @@
 # frozen_string_literal: true
 
 require_relative "../lib/svix"
+require 'subprocess'
 
-token = ENV["SVIX_TOKEN"]
-server_url = ENV["SVIX_SERVER_URL"]
-test_client = nil
+SVIX_ORG_ID = "org_svix_ruby_tests"
+DOCKER_COMPOSE_DIR = File.join(File.dirname(__FILE__), '..', '..', 'client-integration-tests')
 
-if token.nil? || server_url.nil?
-  warn("Unable to instantiate test client without both `SVIX_TOKEN` and `SVIX_SERVER_URL`")
-else
-  opts = Svix::SvixOptions.new(false, server_url)
-  test_client = Svix::Client.new(token, opts)
+def docker_compose(*args)
+  args = ['docker', 'compose', *args]
+  process = Subprocess::Process.new(args, {cwd: DOCKER_COMPOSE_DIR, stdout: Subprocess::PIPE, stderr: Subprocess::PIPE})
+  stdout, stderr = process.communicate
+  status = process.wait
+  if !status.success?
+    $stderr.puts "#{args} failed with status #{status}"
+    $stderr.puts stderr
+    raise "Called process failed"
+  end
+  stdout
+end
+
+def docker_generate_token
+  raw_output = docker_compose('exec', '-T', 'backend', 'svix-server', 'jwt', 'generate', SVIX_ORG_ID)
+  if (md = /Token \(Bearer\): (.*)/.match(raw_output))
+    md[1]
+  else
+    raise "Failed to generate JWT: #{raw_output}"
+  end
+end
+
+def docker_compose_port_for(service_name, container_port)
+  docker_compose('ps', '--format=json').split("\n").filter_map do |line|
+    json = JSON.parse(line)
+    if json["Service"] == service_name
+      if port_row = json["Publishers"].find { |row| row["TargetPort"] == container_port }
+        port_row["PublishedPort"]
+      end
+    end
+  end.first
 end
 
+
 RSpec.describe Svix::Client do
-  describe "Endpoint CRUD", {if: !test_client.nil?} do
+  before :all do
+    if ENV["SVIX_TOKEN"].nil?
+      docker_compose "up", "-d", "--quiet-pull"
+      $token = docker_generate_token
+      $server_url = "http://localhost:#{docker_compose_port_for("backend", 8071)}"
+    else
+      $token = ENV["SVIX_TOKEN"]
+      $server_url = ENV["SVIX_SERVER_URL"]
+    end
+  end
+
+  after :all do
+    if ENV["SVIX_TOKEN"].nil?
+      docker_compose("down", "-v")
+    end
+  end
+
+  before :each do
+    if ENV["SVIX_TOKEN"].nil?
+      docker_compose('exec', '-T', 'backend', 'svix-server', 'wipe', '--yes-i-know-what-im-doing', SVIX_ORG_ID)
+    end
+
+    opts = Svix::SvixOptions.new(false, $server_url)
+    @test_client = Svix::Client.new($token, opts)
+  end
+
+  describe "Endpoint CRUD" do
     it "seems to work okay" do
-      app = test_client.application.create(Svix::ApplicationIn.new(name: "App"))
+      app = @test_client.application.create(Svix::ApplicationIn.new(name: "App"))
 
       begin
-        test_client.event_type.create(Svix::EventTypeIn.new(name: "event.started", description: "Something started"))
+        @test_client.event_type.create(Svix::EventTypeIn.new(name: "event.started", description: "Something started"))
       rescue Svix::ApiError => err
         # Conflicts are expected from test run to test run, but other statuses are not.
         expect(err.code).to(eq(409))
       end
 
       begin
-        test_client.event_type.create(Svix::EventTypeIn.new(name: "event.ended", description: "Something ended"))
+        @test_client.event_type.create(Svix::EventTypeIn.new(name: "event.ended", description: "Something ended"))
       rescue Svix::ApiError => err
         # Conflicts are expected from test run to test run, but other statuses are not.
         expect(err.code).to(eq(409))
       end
 
-      ep = test_client.endpoint.create(
+      ep = @test_client.endpoint.create(
         app.id,
         Svix::EndpointIn.new(url: "https://example.svix.com/", channels: %w[ch0 ch1])
       )
 
       expect(ep.channels.to_set).to(eq(%w[ch0 ch1].to_set))
       expect(ep.event_types).to(be_nil)
 
-      ep_patched = test_client.endpoint.patch(
+      ep_patched = @test_client.endpoint.patch(
         app.id,
         ep.id,
         Svix::EndpointPatch.new(event_types: %w[event.started event.ended])
@@ -50,7 +103,7 @@
       expect(ep_patched.event_types.to_set).to(eq(%w[event.started event.ended].to_set))
 
       # If the serialization is handling empty response bodies, this should not throw an exception
-      test_client.endpoint.delete(app.id, ep.id)
+      @test_client.endpoint.delete(app.id, ep.id)
     end
   end
 end

ruby/svix.gemspec

@@ -48,5 +48,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency 'webmock', '~> 3.25'
+  spec.add_development_dependency "webmock", "~> 3.25"
+  spec.add_development_dependency "subprocess", "~> 1.5"
 end