From 2c6010d886884f3888d78afdec2fb54699a9c638 Mon Sep 17 00:00:00 2001
From: Igor Alexandrov <igor.alexandrov@gmail.com>
Date: Thu, 26 Sep 2024 23:02:43 +0400
Subject: [PATCH] Added tests for accessory configuration with proxy

---
 lib/kamal/cli/accessory.rb                 |  2 +-
 lib/kamal/configuration/accessory.rb       |  2 +-
 lib/kamal/configuration/docs/accessory.yml | 85 ++++++++++++++++++++++
 test/configuration/accessory_test.rb       |  8 ++
 4 files changed, 95 insertions(+), 2 deletions(-)

diff --git a/lib/kamal/cli/accessory.rb b/lib/kamal/cli/accessory.rb
index 2d71e3661..6538ed42a 100644
--- a/lib/kamal/cli/accessory.rb
+++ b/lib/kamal/cli/accessory.rb
@@ -87,7 +87,7 @@ def stop(name)
         on(hosts) do
           execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
           execute *accessory.stop, raise_on_non_zero_exit: false
-          # execute *accessory.remove if accessory.running_proxy?
+          execute *accessory.remove if accessory.running_proxy?
         end
       end
     end
diff --git a/lib/kamal/configuration/accessory.rb b/lib/kamal/configuration/accessory.rb
index 7f78dbd6a..afd0f856c 100644
--- a/lib/kamal/configuration/accessory.rb
+++ b/lib/kamal/configuration/accessory.rb
@@ -19,7 +19,7 @@ def initialize(name, config:)
       secrets: config.secrets,
       context: "accessories/#{name}/env"
 
-    # initialize_proxy if running_proxy?
+    initialize_proxy if running_proxy?
   end
 
   def service_name
diff --git a/lib/kamal/configuration/docs/accessory.yml b/lib/kamal/configuration/docs/accessory.yml
index 931b80a4c..9937c1af3 100644
--- a/lib/kamal/configuration/docs/accessory.yml
+++ b/lib/kamal/configuration/docs/accessory.yml
@@ -88,3 +88,88 @@ accessories:
     # They are not created or copied before mounting
     volumes:
       - /path/to/mysql-logs:/var/log/mysql
+
+    # Proxy
+    #
+    proxy:
+      # Host
+      #
+      # The hosts that will be used to serve the app. The proxy will only route requests
+      # to this host to your app.
+      #
+      # If no hosts are set, then all requests will be forwarded, except for matching
+      # requests for other apps deployed on that server that do have a host set.
+      host: foo.example.com
+
+      # App port
+      #
+      # The port the application container is exposed on
+      #
+      # Defaults to 80
+      app_port: 3000
+
+      # SSL
+      #
+      # kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
+      #
+      # This requires that we are deploying to a one server and the host option is set.
+      # The host value must point to the server we are deploying to and port 443 must be
+      # open for the Let's Encrypt challenge to succeed.
+      #
+      # Defaults to false
+      ssl: true
+
+      # Response timeout
+      #
+      # How long to wait for requests to complete before timing out, defaults to 30 seconds
+      response_timeout: 10
+
+      # Healthcheck
+      #
+      # When deploying, the proxy will by default hit /up once every second until we hit
+      # the deploy timeout, with a 5 second timeout for each request.
+      #
+      # Once the app is up, the proxy will stop hitting the healthcheck endpoint.
+      healthcheck:
+        interval: 3
+        path: /health
+        timeout: 3
+
+      # Buffering
+      #
+      # Whether to buffer request and response bodies in the proxy
+      #
+      # By default buffering is enabled with a max request body size of 1GB and no limit
+      # for response size.
+      #
+      # You can also set the memory limit for buffering, which defaults to 1MB, anything
+      # larger than that is written to disk.
+      buffering:
+        requests: true
+        responses: true
+        max_request_body: 40_000_000
+        max_response_body: 0
+        memory: 2_000_000
+
+      # Logging
+      #
+      # Configure request logging for the proxy
+      # You can specify request and response headers to log.
+      # By default, Cache-Control, Last-Modified and User-Agent request headers are logged
+      logging:
+        request_headers:
+          - Cache-Control
+          - X-Forwarded-Proto
+        response_headers:
+          - X-Request-ID
+          - X-Request-Start
+
+      # Forward headers
+      #
+      # Whether to forward the X-Forwarded-For and X-Forwarded-Proto headers.
+      #
+      # If you are behind a trusted proxy, you can set this to true to forward the headers.
+      #
+      # By default kamal-proxy will not forward the headers the ssl option is set to true, and
+      # will forward them if it is set to false.
+      forward_headers: true
\ No newline at end of file
diff --git a/test/configuration/accessory_test.rb b/test/configuration/accessory_test.rb
index 2615dab60..adc78f170 100644
--- a/test/configuration/accessory_test.rb
+++ b/test/configuration/accessory_test.rb
@@ -63,6 +63,9 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
           "options" => {
             "cpus" => "4",
             "memory" => "2GB"
+          },
+          "proxy" => {
+            "host" => "monitoring.example.com"
           }
         }
       }
@@ -152,4 +155,9 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
   test "options" do
     assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
   end
+
+  test "proxy" do
+    assert @config.accessory(:monitoring).running_proxy?
+    assert_equal "monitoring.example.com", @config.accessory(:monitoring).proxy.host
+  end
 end