[kamal-proxy](https://github.com/basecamp/kamal-proxy) is a custom minimal proxy designed specifically for Kamal. It has some advantages over Traefik: 1. Imperative deployments - we tell it to switch from container A to container B, and it waits for container B to start then switches. No need to poll for health checks ourselves or mess around with forcing health checks to fail. 2. Support for multiple apps - as much as possible, configuration is supplied at runtime by the deploy command, allowing us to have multiple apps share a proxy without conflicting config. 3. First class support for Kamal operations - rather than trying to work out how to make Traefik do what we want, we can build features directly into the proxy, making configuration simpler and avoiding obscure errors
168 lines
5.6 KiB
Ruby
168 lines
5.6 KiB
Ruby
require_relative "integration_test"
|
|
|
|
class IntegrationMainTest < IntegrationTest
|
|
test "envify, deploy, redeploy, rollback, details and audit" do
|
|
kamal :server, :bootstrap
|
|
kamal :envify
|
|
assert_env_files
|
|
remove_local_env_file
|
|
|
|
first_version = latest_app_version
|
|
|
|
assert_app_is_down response_code: "502"
|
|
|
|
kamal :deploy
|
|
assert_app_is_up version: first_version
|
|
assert_hooks_ran "pre-connect", "pre-build", "pre-deploy", "post-deploy"
|
|
assert_envs version: first_version
|
|
|
|
second_version = update_app_rev
|
|
|
|
kamal :redeploy
|
|
assert_app_is_up version: second_version
|
|
assert_hooks_ran "pre-connect", "pre-build", "pre-deploy", "post-deploy"
|
|
|
|
assert_accumulated_assets first_version, second_version
|
|
|
|
kamal :rollback, first_version
|
|
assert_hooks_ran "pre-connect", "pre-deploy", "post-deploy"
|
|
assert_app_is_up version: first_version
|
|
|
|
details = kamal :details, capture: true
|
|
assert_match /Proxy Host: vm1/, details
|
|
assert_match /Proxy Host: vm2/, details
|
|
assert_match /App Host: vm1/, details
|
|
assert_match /App Host: vm2/, details
|
|
assert_match /basecamp\/kamal-proxy:latest/, details
|
|
assert_match /registry:4443\/app:#{first_version}/, details
|
|
|
|
audit = kamal :audit, capture: true
|
|
assert_match /Booted app version #{first_version}.*Booted app version #{second_version}.*Booted app version #{first_version}.*/m, audit
|
|
|
|
kamal :env, :delete
|
|
assert_no_remote_env_file
|
|
end
|
|
|
|
test "app with roles" do
|
|
@app = "app_with_roles"
|
|
|
|
kamal :server, :bootstrap
|
|
kamal :envify
|
|
|
|
version = latest_app_version
|
|
|
|
assert_app_is_down response_code: "502"
|
|
|
|
kamal :deploy
|
|
|
|
assert_app_is_up version: version
|
|
assert_hooks_ran "pre-connect", "pre-build", "pre-deploy", "post-deploy"
|
|
assert_container_running host: :vm3, name: "app-workers-#{version}"
|
|
|
|
second_version = update_app_rev
|
|
|
|
kamal :redeploy
|
|
assert_app_is_up version: second_version
|
|
assert_container_running host: :vm3, name: "app-workers-#{second_version}"
|
|
end
|
|
|
|
test "config" do
|
|
config = YAML.load(kamal(:config, capture: true))
|
|
version = latest_app_version
|
|
|
|
assert_equal [ "web" ], config[:roles]
|
|
assert_equal [ "vm1", "vm2" ], config[:hosts]
|
|
assert_equal "vm1", config[:primary_host]
|
|
assert_equal version, config[:version]
|
|
assert_equal "registry:4443/app", config[:repository]
|
|
assert_equal "registry:4443/app:#{version}", config[:absolute_image]
|
|
assert_equal "app-#{version}", config[:service_with_version]
|
|
assert_equal [], config[:volume_args]
|
|
assert_equal({ user: "root", port: 22, keepalive: true, keepalive_interval: 30, log_level: :fatal }, config[:ssh_options])
|
|
assert_equal({ "multiarch" => false, "args" => { "COMMIT_SHA" => version } }, config[:builder])
|
|
assert_equal [ "--log-opt", "max-size=\"10m\"" ], config[:logging]
|
|
end
|
|
|
|
test "setup and remove" do
|
|
# Check remove completes when nothing has been setup yet
|
|
kamal :remove, "-y"
|
|
assert_no_images_or_containers
|
|
|
|
kamal :envify
|
|
kamal :setup
|
|
assert_images_and_containers
|
|
|
|
kamal :remove, "-y"
|
|
assert_no_images_or_containers
|
|
end
|
|
|
|
private
|
|
def assert_local_env_file(contents)
|
|
assert_equal contents, deployer_exec("cat .env", capture: true)
|
|
end
|
|
|
|
def assert_envs(version:)
|
|
assert_env :CLEAR_TOKEN, "4321", version: version, vm: :vm1
|
|
assert_env :HOST_TOKEN, "abcd", version: version, vm: :vm1
|
|
assert_env :SECRET_TOKEN, "1234 with \"中文\"", version: version, vm: :vm1
|
|
assert_no_env :CLEAR_TAG, version: version, vm: :vm1
|
|
assert_no_env :SECRET_TAG, version: version, vm: :vm11
|
|
assert_env :CLEAR_TAG, "tagged", version: version, vm: :vm2
|
|
assert_env :SECRET_TAG, "TAGME", version: version, vm: :vm2
|
|
end
|
|
|
|
def assert_env(key, value, vm:, version:)
|
|
assert_equal "#{key}=#{value}", docker_compose("exec #{vm} docker exec app-web-#{version} env | grep #{key}", capture: true)
|
|
end
|
|
|
|
def assert_no_env(key, vm:, version:)
|
|
assert_raises(RuntimeError, /exit 1/) do
|
|
docker_compose("exec #{vm} docker exec app-web-#{version} env | grep #{key}", capture: true)
|
|
end
|
|
end
|
|
|
|
def assert_env_files
|
|
assert_local_env_file "SECRET_TOKEN='1234 with \"中文\"'\nSECRET_TAG='TAGME'"
|
|
assert_remote_env_file "SECRET_TOKEN=1234 with \"中文\"", vm: :vm1
|
|
assert_remote_env_file "SECRET_TOKEN=1234 with \"中文\"\nSECRET_TAG=TAGME", vm: :vm2
|
|
end
|
|
|
|
def remove_local_env_file
|
|
deployer_exec("rm .env")
|
|
end
|
|
|
|
def assert_remote_env_file(contents, vm:)
|
|
assert_equal contents, docker_compose("exec #{vm} cat /root/.kamal/env/roles/app-web.env", capture: true)
|
|
end
|
|
|
|
def assert_no_remote_env_file
|
|
assert_equal "nofile", docker_compose("exec vm1 stat /root/.kamal/env/roles/app-web.env 2> /dev/null || echo nofile", capture: true)
|
|
end
|
|
|
|
def assert_accumulated_assets(*versions)
|
|
versions.each do |version|
|
|
assert_equal "200", Net::HTTP.get_response(URI.parse("http://localhost:12345/versions/#{version}")).code
|
|
end
|
|
|
|
assert_equal "200", Net::HTTP.get_response(URI.parse("http://localhost:12345/versions/.hidden")).code
|
|
end
|
|
|
|
def vm1_image_ids
|
|
docker_compose("exec vm1 docker image ls -q", capture: true).strip.split("\n")
|
|
end
|
|
|
|
def vm1_container_ids
|
|
docker_compose("exec vm1 docker ps -a -q", capture: true).strip.split("\n")
|
|
end
|
|
|
|
def assert_no_images_or_containers
|
|
assert vm1_image_ids.empty?
|
|
assert vm1_container_ids.empty?
|
|
end
|
|
|
|
def assert_images_and_containers
|
|
assert vm1_image_ids.any?
|
|
assert vm1_container_ids.any?
|
|
end
|
|
end
|