Files
kumomta/crates/integration-tests/source.lua
T
Wez Furlong 0e339a2b9e egress_source: add integration tests and fixup source_selection_rate
Add test coverage for source_selection_rate and tidy up how we reflect
being throttled due to source_selection_rate; in the first cut
we made it look like the ready queue was full, but now we're a
bit more deliberate:

* If any of the candidate queues were full, we report that the
  ready queue was full so that the message can be retried again
  "soon".
* If we hit a source_selection_rate throttle, we use the throttle
  delay to adjust the min delay period and if we run out of candidate
  sources, we'll have the same sort of return value as we would
  for a suspension with a definite duration; the message will
  log that transient failure in the same way with the same sort
  of retry schedule.  I've revised the wording in that case to be
  "no sources for SITE pool=`POOL` are eligible for selection at this time"
  (the important part being `at this time`) to suggest at the
  transient nature of the unavailability.
* If we exhaust all sources for other reasons, we'll treat this
  as the NoSources case. In practice, this should mean that the
  source has zero weight. We'll now report "no sources available for SITE
  pool=`POOL`" in this case instead of the more precise but wordy
  "no non-zero-weighted sources available for SITE" that we used
  prior to this commit.
2025-03-11 08:37:09 -07:00

327 lines
9.0 KiB
Lua

local kumo = require 'kumo'
package.path = '../../assets/?.lua;' .. package.path
log_hooks = require 'policy-extras.log_hooks'
local TEST_DIR = os.getenv 'KUMOD_TEST_DIR'
local SINK_PORT = tonumber(os.getenv 'KUMOD_SMTP_SINK_PORT')
local WEBHOOK_PORT = os.getenv 'KUMOD_WEBHOOK_PORT'
local AMQPHOOK_URL = os.getenv 'KUMOD_AMQPHOOK_URL'
local AMQP_HOST_PORT = os.getenv 'KUMOD_AMQP_HOST_PORT'
local LISTENER_MAP = os.getenv 'KUMOD_LISTENER_DOMAIN_MAP'
local DEFERRED_SMTP_SERVER_MSG_INJECT =
os.getenv 'KUMOD_DEFERRED_SMTP_SERVER_MSG_INJECT'
kumo.on('init', function()
kumo.configure_accounting_db_path(TEST_DIR .. '/accounting.db')
local relay_hosts = { '0.0.0.0/0' }
local RELAY_HOSTS = os.getenv 'KUMOD_RELAY_HOSTS'
if RELAY_HOSTS then
relay_hosts = kumo.json_parse(RELAY_HOSTS)
end
kumo.start_esmtp_listener {
listen = '127.0.0.1:0',
relay_hosts = relay_hosts,
deferred_queue = (DEFERRED_SMTP_SERVER_MSG_INJECT and true) or false,
}
kumo.start_http_listener {
listen = '127.0.0.1:0',
}
kumo.configure_local_logs {
log_dir = TEST_DIR .. '/logs',
max_segment_duration = '1s',
headers = { 'X-*', 'Y-*', 'Subject' },
}
if WEBHOOK_PORT then
kumo.configure_log_hook {
name = 'webhook',
headers = { 'Subject', 'X-*' },
}
end
kumo.define_spool {
name = 'data',
path = TEST_DIR .. '/data-spool',
}
kumo.define_spool {
name = 'meta',
path = TEST_DIR .. '/meta-spool',
}
end)
if AMQPHOOK_URL then
log_hooks:new {
name = 'amqp',
constructor = function(domain, tenant, campaign)
local sender = {}
local client = kumo.amqp.build_client(AMQPHOOK_URL)
function sender:send(msg)
local result = client:publish_with_timeout({
routing_key = 'woot',
payload = msg:get_data(),
}, 20000)
if result.status == 'Ack' or result.status == 'NotRequested' then
return string.format('250 %s', kumo.json_encode(result))
end
-- result.status must be `Nack`; log the full result
kumo.reject(500, kumo.json_encode(result))
end
function sender:close()
client:close()
end
return sender
end,
}
elseif AMQP_HOST_PORT then
log_hooks:new {
name = 'amqp',
constructor = function(domain, tenant, campaign)
local sender = {}
local host, port = table.unpack(kumo.string.split(AMQP_HOST_PORT, ':'))
function sender:send(msg)
kumo.amqp.basic_publish {
routing_key = 'woot',
payload = msg:get_data(),
connection = {
host = host,
port = tonumber(port),
},
}
return '250 ok'
end
return sender
end,
}
end
if WEBHOOK_PORT then
local min_batch_size = tonumber(os.getenv 'KUMOD_WEBHOOK_MIN_BATCH_SIZE')
local max_batch_size = tonumber(os.getenv 'KUMOD_WEBHOOK_MAX_BATCH_SIZE')
local max_batch_latency = os.getenv 'KUMOD_WEBHOOK_MAX_BATCH_LATENCY'
if max_batch_size > 1 then
log_hooks:new {
name = 'webhookbatch',
batch_size = max_batch_size,
min_batch_size = min_batch_size,
max_batch_latency = max_batch_latency,
constructor = function(domain, tenant, campaign)
local sender = {}
local client = kumo.http.build_client {}
function sender:send_batch(messages)
local payload = {}
for _, msg in ipairs(messages) do
table.insert(payload, msg:get_meta 'log_record')
end
print(
string.format(
'batch size is %d *************** min=%d max=%d latency=%s',
#payload,
min_batch_size,
max_batch_size,
max_batch_latency
)
)
local response = client
:post(
string.format('http://127.0.0.1:%d/log-batch', WEBHOOK_PORT)
)
:header('Content-Type', 'application/json')
:body(kumo.serde.json_encode(payload))
:send()
local disposition = string.format(
'%d %s: %s',
response:status_code(),
response:status_reason(),
response:text()
)
if response:status_is_success() then
return disposition
end
kumo.reject(500, disposition)
end
return sender
end,
}
else
kumo.on('should_enqueue_log_record', function(msg)
local log_record = msg:get_meta 'log_record'
-- avoid an infinite loop caused by logging that we logged
if log_record.queue ~= 'webhook' then
msg:set_meta('queue', 'webhook')
return true
end
return false
end)
kumo.on('make.webhook', function(_domain, _tenant, _campaign)
local sender = {}
local client = kumo.http.build_client {}
function sender:send(message)
local response = client
:post(string.format('http://127.0.0.1:%d/log', WEBHOOK_PORT))
:header('Content-Type', 'application/json')
:body(message:get_data())
:send()
local disposition = string.format(
'%d %s: %s',
response:status_code(),
response:status_reason(),
response:text()
)
if response:status_is_success() then
return disposition
end
kumo.reject(500, disposition)
end
return sender
end)
end
end
kumo.on('get_listener_domain', function(domain, listener, conn_meta)
if LISTENER_MAP then
local map = kumo.json_parse(LISTENER_MAP)
local params = map[domain]
if params then
return kumo.make_listener_domain(params)
end
end
return kumo.make_listener_domain {
relay_to = true,
log_oob = true,
log_arf = true,
}
end)
kumo.on('smtp_server_message_received', function(msg) end)
kumo.on('get_queue_config', function(domain, _tenant, _campaign)
if domain == 'webhook' then
return kumo.make_queue_config {
protocol = {
custom_lua = {
constructor = 'make.webhook',
},
},
}
end
local protocol = {
-- Redirect traffic to the sink
smtp = {
mx_list = { 'localhost' },
},
}
if domain == 'nxdomain' then
-- this nxdomain domain is a special domain that is assumed not
-- to resolve. It is generated by the retry_schedule integration
-- test. for this domain, we don't want to short-circuit dns
-- and go to the sink, because we DO want the dns resolution
-- to successfully return nxdomain in order for the test to
-- exercise the appropriate logic.
protocol = nil
end
return kumo.make_queue_config {
protocol = protocol,
retry_interval = os.getenv 'KUMOD_RETRY_INTERVAL',
strategy = os.getenv 'KUMOD_QUEUE_STRATEGY',
egress_pool = os.getenv 'KUMOD_POOL_NAME',
}
end)
kumo.on('get_egress_pool', function(pool_name)
if pool_name == 'warming' then
-- coupled with source_selection_rate_pool.rs
return kumo.make_egress_pool {
name = pool_name,
entries = {
{ name = 'warming_a' },
{ name = 'warming_b' },
},
}
end
error('integration-tests/source.lua: unhandled pool ' .. pool_name)
end)
kumo.on('get_egress_source', function(source_name)
return kumo.make_egress_source {
name = source_name,
}
end)
kumo.on('get_egress_path_config', function(domain, source_name, _site_name)
-- Allow sending to a sink
local params = {
enable_tls = os.getenv 'KUMOD_ENABLE_TLS' or 'OpportunisticInsecure',
reconnect_strategy = os.getenv 'KUMOD_RECONNECT_STRATEGY'
or 'ConnectNextHost',
smtp_port = SINK_PORT,
prohibited_hosts = {},
opportunistic_tls_reconnect_on_failed_handshake = (
(os.getenv 'KUMOD_OPPORTUNISTIC_TLS_RECONNECT') and true
) or false,
source_selection_rate = os.getenv 'KUMOD_SOURCE_SELECTION_RATE',
}
-- See if there is a source-specific rate exported to us via the environment.
-- We assign this using additional_source_selection_rates regardless of
-- whether we have a more generate rate specified above so that we can
-- excercise the additional_source_selection_rates collection logic in the core.
local source_rate_name = 'KUMOD_SOURCE_SELECTION_RATE_'
.. source_name:upper()
local source_rate = os.getenv(source_rate_name)
if source_rate then
params.additional_source_selection_rates =
{ [source_rate_name] = source_rate }
end
local username = os.getenv 'KUMOD_SMTP_AUTH_USERNAME'
local password = os.getenv 'KUMOD_SMTP_AUTH_PASSWORD'
if username and password then
params.smtp_auth_plain_username = username
params.smtp_auth_plain_password = {
key_data = password,
}
end
if domain == 'webhookbatch.log_hook' then
-- If we allow more connections, then we can end up
-- with batches smaller than desired because we split
-- them among multiple connections
params.connection_limit = 1
end
print('get_egress_path_config *******************', domain)
return kumo.make_egress_path(params)
end)
if os.getenv 'KUMOD_WANT_REBIND' then
kumo.on('rebind_message', function(message, data)
message:set_meta('queue', data.queue)
end)
end