roles: delete server if it is not in use

There was a but if the server is not used (for example, it was removed
from the configuration), it will still be running after the configuration
is reloaded.

This patch fixes it.

Closes #212

Author: themilchenko

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
+- Removing the server if it is not in use (#212).
+
 ## [1.7.0] - 2024-11-15
 
 The release introduces a TLS support.

roles/httpd.lua

@@ -130,9 +130,21 @@ M.apply = function(conf)
     -- a meaningful error if something goes wrong.
     M.validate(conf)
 
+    local actual_servers = {}
+
     for name, node in pairs(conf or {}) do
+        actual_servers[name] = true
+
         apply_http(name, node)
     end
+
+    -- Stop server if it is not used anymore.
+    for name, server in pairs(servers) do
+        if actual_servers[name] == nil then
+            server.httpd:stop()
+            servers[name] = nil
+        end
+    end
 end
 
 M.stop = function()

test/helpers.lua

@@ -130,4 +130,12 @@ helpers.update_lua_env_variables = function(server)
         ROOT .. '/.rocks/lib/tarantool/?/?.so;'
 end
 
+helpers.tcp_connection_exists = function(host, port)
+    local tcp = socket.tcp()
+    tcp:settimeout(0.3)
+    local ok, _ = tcp:connect(host, port)
+    tcp:close()
+    return ok
+end
+
 return helpers

test/integration/httpd_role_test.lua

@@ -115,3 +115,17 @@ g.test_httpd_role_usage = function(cg)
         'return require("test.mocks.mock_role").get_server_port(2)'
     ), 13001)
 end
+
+g.test_stop_server_after_remove = function(cg)
+    local resp = http_client:get('http://localhost:13001/ping')
+    t.assert_equals(resp.status, 200, 'response not 200')
+    t.assert_equals(resp.body, 'pong')
+
+    local cfg = table.deepcopy(config)
+    cfg.groups['group-001'].replicasets['replicaset-001'].roles_cfg['roles.httpd'].additional = nil
+    treegen.write_file(cg.server.chdir, 'config.yaml', yaml.encode(cfg))
+    local _, err = cg.server:eval("require('config'):reload()")
+    t.assert_not(err)
+
+    t.assert_not(helpers.tcp_connection_exists('localhost', 13001))
+end

test/mocks/mock_role.lua

@@ -8,11 +8,13 @@ M.apply = function(conf)
     for _, server in pairs(conf) do
         servers[server.id] = require('roles.httpd').get_server(server.name)
 
-        servers[server.id]:route({
-            path = '/ping',
-        }, function(tx)
-            return tx:render({text = 'pong'})
-        end)
+        if servers[server.id] ~= nil then
+            servers[server.id]:route({
+                path = '/ping',
+            }, function(tx)
+                return tx:render({text = 'pong'})
+            end)
+        end
     end
 end
 

test/unit/httpd_role_test.lua

@@ -268,3 +268,26 @@ g['test_get_server_bad_type'] = function()
     t.assert_not(ok)
     t.assert_str_contains(res, '?string expected, got table')
 end
+
+g.test_stop_unused_servers = function()
+    local cfg = {
+        [httpd_role.DEFAULT_SERVER_NAME] = {
+            listen = 13001,
+        },
+        additional = {
+            listen = 13002,
+        },
+    }
+
+    httpd_role.apply(cfg)
+    for name, body in pairs(cfg) do
+        local res = httpd_role.get_server(name)
+        t.assert(res)
+        t.assert_equals(res.port, body.listen)
+    end
+
+    cfg.additional = nil
+    httpd_role.apply(cfg)
+    t.assert(httpd_role.get_server())
+    t.assert_equals(httpd_role.get_server('additional'))
+end