Do not send HTTP request when mock mode is on

Author: Verseth

.github/workflows/ci_ruby.yml

@@ -31,3 +31,19 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run unit tests
         run: bundle exec rake test
+  typecheck_and_lint:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Lint
+        run: bundle exec rubocop --parallel --color
+      - name: Typecheck
+        run: bundle exec srb tc

lib/data_plane_api/configuration.rb

@@ -1,6 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
+require 'booleans/kernel_extension'
 require 'faraday'
 require 'logger'
 

lib/data_plane_api/server.rb

@@ -14,7 +14,7 @@ class << self
       # @param name: Name of the server whose settings will be returned.
       #   If `nil` then an array of settings of all servers under the passed `backend`
       #   will be returned.
-      #: (String?, String?, Configuration?) -> Faraday::Response
+      #: (String?, String?, Configuration?) -> Faraday::Response?
       def get_runtime_settings(backend:, name: nil, config: nil)
         config ||= CONFIG
         if backend.nil? || backend.empty?
@@ -30,7 +30,7 @@ def get_runtime_settings(backend:, name: nil, config: nil)
 
       # @param backend: Name of the backend
       # @param name: Name of the server whose transient settings should be updated.
-      #: (String?, String?, Hash[top, top], Configuration?) -> Faraday::Response
+      #: (String?, String?, Hash[top, top], Configuration?) -> Faraday::Response?
       def update_transient_settings(backend:, name:, settings:, config: nil)
         config ||= CONFIG
         if backend.nil? || backend.empty?
@@ -48,37 +48,44 @@ def update_transient_settings(backend:, name:, settings:, config: nil)
 
       private
 
-      #: (Symbol, String | Pathname, Configuration) { (Faraday::Request) -> void } -> Faraday::Response
+      #: (Symbol, String | Pathname, Configuration) { (Faraday::Request) -> void } -> Faraday::Response?
       def send_request(method:, path:, config:, &block)
         request = T.let(nil, T.nilable(Faraday::Request))
-        response = config.connection.public_send(method, path) do |req|
+        conn = config.connection
+        response = conn.public_send(method, path) do |req|
           block.call(req)
           req.options.timeout = config.timeout
           request = req
+          break if config.mock?
         end
 
-        log_communication(T.must(request), response, logger: config.logger)
+        log_communication(
+          conn.build_url(path),
+          T.must(request),
+          response,
+          logger: config.logger,
+        )
 
         response
       end
 
-      #: (Faraday::Request, Faraday::Response, Logger?) -> void
-      def log_communication(request, response, logger:)
+      #: (String, Faraday::Request, Faraday::Response?, Logger?) -> void
+      def log_communication(url, request, response, logger:)
         request_hash = {
           method:  request.http_method,
-          url:     response.env.url,
+          url:     url,
           params:  request.params,
           headers: request.headers,
           body:    request.body,
         }
         response_hash = {
-          status:  response.status,
-          body:    response.body,
-          headers: response.headers,
+          status:  response&.status,
+          body:    response&.body,
+          headers: response&.headers,
         }
 
         logger&.debug <<~REQ
-          HAProxy #{request.http_method.to_s.upcase} #{response.env.url}
+          HAProxy #{request.http_method.to_s.upcase} #{url}
           -----REQUEST-----
           #{::JSON.pretty_generate request_hash}
           -----RESPONSE-----

test/data_plane_api/server_test.rb

@@ -5,20 +5,32 @@
 
 module DataPlaneApi
   class ServerTest < ::TestCase
+    should 'not send the request in mock mode' do
+      conf = config.tap do |c|
+        c.mock = true
+      end
+
+      response =
+        Server.get_runtime_settings(backend: 'lolo', config: conf)
+
+      assert_nil response
+    end
+
     should 'get runtime settings of all servers when backend does not exist' do
-      response = http_cassette do
+      response = T.must(http_cassette do
         Server.get_runtime_settings(backend: 'lolo', config: config)
-      end
+      end)
+
 
       assert_equal 200, response.status
       assert response.body.is_a?(::Array)
       assert_equal 0, response.body.length
     end
 
     should 'get runtime settings of all servers' do
-      response = http_cassette do
+      response = T.must(http_cassette do
         Server.get_runtime_settings(backend: 'foo_bar', config: config)
-      end
+      end)
 
       assert_equal 200, response.status
       assert response.body.is_a?(::Array)
@@ -40,9 +52,9 @@ class ServerTest < ::TestCase
     end
 
     should 'get runtime settings of one server' do
-      response = http_cassette do
+      response = T.must(http_cassette do
         Server.get_runtime_settings(backend: 'foo_bar', name: 'foo_bar1', config: config)
-      end
+      end)
 
       assert_equal 200, response.status
       assert response.body.is_a?(::Hash)
@@ -56,9 +68,9 @@ class ServerTest < ::TestCase
     end
 
     should 'get runtime settings of one server which does not exist' do
-      response = http_cassette do
+      response = T.must(http_cassette do
         Server.get_runtime_settings(backend: 'foo_bar', name: 'lolo', config: config)
-      end
+      end)
 
       assert_equal 500, response.status
       assert response.body.is_a?(::Hash)
@@ -70,7 +82,7 @@ class ServerTest < ::TestCase
 
     should 'update admin_state of a server' do
       http_cassette do
-        response = Server.get_runtime_settings(backend: 'foo_bar', name: 'foo_bar1', config: config)
+        response = T.must Server.get_runtime_settings(backend: 'foo_bar', name: 'foo_bar1', config: config)
 
         assert_equal 200, response.status
         assert response.body.is_a?(::Hash)
@@ -82,13 +94,14 @@ class ServerTest < ::TestCase
         assert_equal '12.0.5.102', server['address']
         assert_equal 4512, server['port']
 
-        response =
+        response = T.must(
           Server.update_transient_settings(
             backend:  'foo_bar',
             name:     'foo_bar1',
             settings: { admin_state: :drain },
             config:   config,
-          )
+          ),
+        )
 
         assert_equal 200, response.status
         assert response.body.is_a?(::Hash)
@@ -104,6 +117,7 @@ class ServerTest < ::TestCase
 
     private
 
+    #: -> Configuration
     def config
       Configuration.new(
         url:            'http://example.com',