[tarantool-patches] [PATCH v2] lua: fix for option pid_file overwritten by tarantoolctl

[tarantool-patches] [PATCH v2] lua: fix for option pid_file overwritten by tarantoolctl

[Konstantin Belyavskiy]

During startup tarantoolctl ignores 'pid_file' option and set it to
default value.
This cause a fault if user tries to execute config with option set.
In case of being started with tarantoolctl shadow this option with
additional wrapper around box.cfg.

Closes #3214
---
ticket: https://github.com/tarantool/tarantool/issues/3214
branch: https://github.com/tarantool/tarantool/tree/kbelyavs/gh-3214-tarantoolctl-pidfile-fix
 extra/dist/tarantoolctl.in | 11 +++++++++++
 test/box/cfg.result        | 30 ++++++++++++++++++++++++++++++
 test/box/cfg.test.lua      | 12 ++++++++++++
 3 files changed, 53 insertions(+)

diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
index 507ebe8bf..f60c910d8 100755
--- a/extra/dist/tarantoolctl.in
+++ b/extra/dist/tarantoolctl.in
@@ -471,6 +471,15 @@ local function wrapper_cfg(cfg)
     return data
 end
 
+cfg_callback = nil
+
+function wrapper_cfg_reload(old_cfg, cfg)
+    if old_cfg.pid_file ~= nil and cfg ~= nil and cfg.pid_file ~= nil then
+        cfg.pid_file = old_cfg.pid_file
+    end
+    cfg_callback(old_cfg, cfg)
+end
+
 -- It's not 100% result guaranteed function, but it's ok for most cases
 -- Won't help in multiple race-conditions
 -- Returns nil if Tarantool already started, PID otherwise
@@ -527,6 +536,8 @@ local function start()
         end
         os.exit(1)
     end
+    cfg_callback = getmetatable(box.cfg).__call
+    getmetatable(box.cfg).__call = wrapper_cfg_reload
     return 0
 end
 
diff --git a/test/box/cfg.result b/test/box/cfg.result
index cda7aa0d3..a2df83310 100644
--- a/test/box/cfg.result
+++ b/test/box/cfg.result
@@ -365,6 +365,36 @@ test_run:cmd("cleanup server cfg_tester4")
 - true
 ...
 --------------------------------------------------------------------------------
+-- Check fix for pid_file option overwritten by tarantoolctl
+--------------------------------------------------------------------------------
+test_run:cmd('create server cfg_tester5 with script = "box/lua/cfg_test1.lua"')
+---
+- true
+...
+test_run:cmd("start server cfg_tester5")
+---
+- true
+...
+test_run:cmd('switch cfg_tester5')
+---
+- true
+...
+box.cfg{pid_file = "current.pid"}
+---
+...
+test_run:cmd("switch default")
+---
+- true
+...
+test_run:cmd("stop server cfg_tester5")
+---
+- true
+...
+test_run:cmd("cleanup server cfg_tester5")
+---
+- true
+...
+--------------------------------------------------------------------------------
 -- Check that 'vinyl_dir' cfg option is not checked as long as
 -- there is no vinyl indexes (issue #2664)
 --------------------------------------------------------------------------------
diff --git a/test/box/cfg.test.lua b/test/box/cfg.test.lua
index dbb463025..712a165bb 100644
--- a/test/box/cfg.test.lua
+++ b/test/box/cfg.test.lua
@@ -69,6 +69,18 @@ test_run:cmd("switch default")
 test_run:cmd("stop server cfg_tester4")
 test_run:cmd("cleanup server cfg_tester4")
 
+--------------------------------------------------------------------------------
+-- Check fix for pid_file option overwritten by tarantoolctl
+--------------------------------------------------------------------------------
+
+test_run:cmd('create server cfg_tester5 with script = "box/lua/cfg_test1.lua"')
+test_run:cmd("start server cfg_tester5")
+test_run:cmd('switch cfg_tester5')
+box.cfg{pid_file = "current.pid"}
+test_run:cmd("switch default")
+test_run:cmd("stop server cfg_tester5")
+test_run:cmd("cleanup server cfg_tester5")
+
 --------------------------------------------------------------------------------
 -- Check that 'vinyl_dir' cfg option is not checked as long as
 -- there is no vinyl indexes (issue #2664)
-- 
2.14.3 (Apple Git-98)

[tarantool-patches] Re: [PATCH v2] lua: fix for option pid_file overwritten by tarantoolctl

[Georgy Kirichenko]

[-- Attachment #1: Type: text/plain, Size: 4224 bytes --]

It looks more better but there are some comments bellow

On Monday, July 23, 2018 8:07:04 PM MSK Konstantin Belyavskiy wrote:
> During startup tarantoolctl ignores 'pid_file' option and set it to
> default value.
> This cause a fault if user tries to execute config with option set.
> In case of being started with tarantoolctl shadow this option with
> additional wrapper around box.cfg.
> 
> Closes #3214
> ---
> ticket: https://github.com/tarantool/tarantool/issues/3214
> branch:
> https://github.com/tarantool/tarantool/tree/kbelyavs/gh-3214-tarantoolctl-p
> idfile-fix extra/dist/tarantoolctl.in | 11 +++++++++++
>  test/box/cfg.result        | 30 ++++++++++++++++++++++++++++++
>  test/box/cfg.test.lua      | 12 ++++++++++++
>  3 files changed, 53 insertions(+)
> 
> diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
> index 507ebe8bf..f60c910d8 100755
> --- a/extra/dist/tarantoolctl.in
> +++ b/extra/dist/tarantoolctl.in
> @@ -471,6 +471,15 @@ local function wrapper_cfg(cfg)
>      return data
>  end
> 
> +cfg_callback = nil
It would be better if you use local defined closure instead of a global 
function with a variable
> +
> +function wrapper_cfg_reload(old_cfg, cfg)
> +    if old_cfg.pid_file ~= nil and cfg ~= nil and cfg.pid_file ~= nil then
> +        cfg.pid_file = old_cfg.pid_file
> +    end
> +    cfg_callback(old_cfg, cfg)
> +end
> +
>  -- It's not 100% result guaranteed function, but it's ok for most cases
>  -- Won't help in multiple race-conditions
>  -- Returns nil if Tarantool already started, PID otherwise
> @@ -527,6 +536,8 @@ local function start()
>          end
>          os.exit(1)
>      end
> +    cfg_callback = getmetatable(box.cfg).__call
> +    getmetatable(box.cfg).__call = wrapper_cfg_reload
something like:
local old_call = getmetatable(box.cfg).__call
 getmetatable(box.cfg).__call = function (old_cfg, cfg) ... old_call(...) end
>      return 0
>  end
> 
> diff --git a/test/box/cfg.result b/test/box/cfg.result
> index cda7aa0d3..a2df83310 100644
> --- a/test/box/cfg.result
> +++ b/test/box/cfg.result
> @@ -365,6 +365,36 @@ test_run:cmd("cleanup server cfg_tester4")
>  - true
>  ...
>  ---------------------------------------------------------------------------
> ----- +-- Check fix for pid_file option overwritten by tarantoolctl
> +---------------------------------------------------------------------------
> ----- +test_run:cmd('create server cfg_tester5 with script =
> "box/lua/cfg_test1.lua"') +---
> +- true
> +...
> +test_run:cmd("start server cfg_tester5")
> +---
> +- true
> +...
> +test_run:cmd('switch cfg_tester5')
> +---
> +- true
> +...
> +box.cfg{pid_file = "current.pid"}
> +---
> +...
> +test_run:cmd("switch default")
> +---
> +- true
> +...
> +test_run:cmd("stop server cfg_tester5")
> +---
> +- true
> +...
> +test_run:cmd("cleanup server cfg_tester5")
> +---
> +- true
> +...
> +---------------------------------------------------------------------------
> ----- -- Check that 'vinyl_dir' cfg option is not checked as long as
>  -- there is no vinyl indexes (issue #2664)
>  ---------------------------------------------------------------------------
> ----- diff --git a/test/box/cfg.test.lua b/test/box/cfg.test.lua
> index dbb463025..712a165bb 100644
> --- a/test/box/cfg.test.lua
> +++ b/test/box/cfg.test.lua
> @@ -69,6 +69,18 @@ test_run:cmd("switch default")
>  test_run:cmd("stop server cfg_tester4")
>  test_run:cmd("cleanup server cfg_tester4")
> 
> +---------------------------------------------------------------------------
> ----- +-- Check fix for pid_file option overwritten by tarantoolctl
> +---------------------------------------------------------------------------
> ----- +
> +test_run:cmd('create server cfg_tester5 with script =
> "box/lua/cfg_test1.lua"') +test_run:cmd("start server cfg_tester5")
> +test_run:cmd('switch cfg_tester5')
> +box.cfg{pid_file = "current.pid"}
> +test_run:cmd("switch default")
> +test_run:cmd("stop server cfg_tester5")
> +test_run:cmd("cleanup server cfg_tester5")
> +
>  ---------------------------------------------------------------------------
> ----- -- Check that 'vinyl_dir' cfg option is not checked as long as
>  -- there is no vinyl indexes (issue #2664)


[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[tarantool-patches] [PATCH v2] lua: fix for option pid_file overwritten by tarantoolctl

[Konstantin Belyavskiy]

During startup tarantoolctl ignores 'pid_file' option and set it to
default value.
This cause a fault if user tries to execute config with option set.
In case of being started with tarantoolctl shadow this option with
additional wrapper around box.cfg.

Changes in V2:
 Use local defined closure instead of a global function with a
 variable (based on @GeorgyKirichenko proposal).

Closes #3214
---
ticket: https://github.com/tarantool/tarantool/issues/3214
branch: https://github.com/tarantool/tarantool/tree/kbelyavs/gh-3214-tarantoolctl-pidfile-fix
 extra/dist/tarantoolctl.in |  7 +++++++
 test/box/cfg.result        | 30 ++++++++++++++++++++++++++++++
 test/box/cfg.test.lua      | 12 ++++++++++++
 3 files changed, 49 insertions(+)

diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
index 507ebe8bf..4c7dfa2f1 100755
--- a/extra/dist/tarantoolctl.in
+++ b/extra/dist/tarantoolctl.in
@@ -527,6 +527,13 @@ local function start()
         end
         os.exit(1)
     end
+    local old_call = getmetatable(box.cfg).__call
+    getmetatable(box.cfg).__call = function(old_cfg, cfg)
+        if old_cfg.pid_file ~= nil and cfg ~= nil and cfg.pid_file ~= nil then
+            cfg.pid_file = old_cfg.pid_file
+        end
+        old_call(old_cfg, cfg)
+    end
     return 0
 end
 
diff --git a/test/box/cfg.result b/test/box/cfg.result
index cda7aa0d3..a2df83310 100644
--- a/test/box/cfg.result
+++ b/test/box/cfg.result
@@ -365,6 +365,36 @@ test_run:cmd("cleanup server cfg_tester4")
 - true
 ...
 --------------------------------------------------------------------------------
+-- Check fix for pid_file option overwritten by tarantoolctl
+--------------------------------------------------------------------------------
+test_run:cmd('create server cfg_tester5 with script = "box/lua/cfg_test1.lua"')
+---
+- true
+...
+test_run:cmd("start server cfg_tester5")
+---
+- true
+...
+test_run:cmd('switch cfg_tester5')
+---
+- true
+...
+box.cfg{pid_file = "current.pid"}
+---
+...
+test_run:cmd("switch default")
+---
+- true
+...
+test_run:cmd("stop server cfg_tester5")
+---
+- true
+...
+test_run:cmd("cleanup server cfg_tester5")
+---
+- true
+...
+--------------------------------------------------------------------------------
 -- Check that 'vinyl_dir' cfg option is not checked as long as
 -- there is no vinyl indexes (issue #2664)
 --------------------------------------------------------------------------------
diff --git a/test/box/cfg.test.lua b/test/box/cfg.test.lua
index dbb463025..712a165bb 100644
--- a/test/box/cfg.test.lua
+++ b/test/box/cfg.test.lua
@@ -69,6 +69,18 @@ test_run:cmd("switch default")
 test_run:cmd("stop server cfg_tester4")
 test_run:cmd("cleanup server cfg_tester4")
 
+--------------------------------------------------------------------------------
+-- Check fix for pid_file option overwritten by tarantoolctl
+--------------------------------------------------------------------------------
+
+test_run:cmd('create server cfg_tester5 with script = "box/lua/cfg_test1.lua"')
+test_run:cmd("start server cfg_tester5")
+test_run:cmd('switch cfg_tester5')
+box.cfg{pid_file = "current.pid"}
+test_run:cmd("switch default")
+test_run:cmd("stop server cfg_tester5")
+test_run:cmd("cleanup server cfg_tester5")
+
 --------------------------------------------------------------------------------
 -- Check that 'vinyl_dir' cfg option is not checked as long as
 -- there is no vinyl indexes (issue #2664)
-- 
2.14.3 (Apple Git-98)

[tarantool-patches] Re: [PATCH v2] lua: fix for option pid_file overwritten by tarantoolctl

[Georgy Kirichenko]

[-- Attachment #1: Type: text/plain, Size: 3758 bytes --]

LGTM, thanks

On Tuesday, July 31, 2018 5:35:49 PM MSK Konstantin Belyavskiy wrote:
> During startup tarantoolctl ignores 'pid_file' option and set it to
> default value.
> This cause a fault if user tries to execute config with option set.
> In case of being started with tarantoolctl shadow this option with
> additional wrapper around box.cfg.
> 
> Changes in V2:
>  Use local defined closure instead of a global function with a
>  variable (based on @GeorgyKirichenko proposal).
> 
> Closes #3214
> ---
> ticket: https://github.com/tarantool/tarantool/issues/3214
> branch:
> https://github.com/tarantool/tarantool/tree/kbelyavs/gh-3214-tarantoolctl-p
> idfile-fix extra/dist/tarantoolctl.in |  7 +++++++
>  test/box/cfg.result        | 30 ++++++++++++++++++++++++++++++
>  test/box/cfg.test.lua      | 12 ++++++++++++
>  3 files changed, 49 insertions(+)
> 
> diff --git a/extra/dist/tarantoolctl.in b/extra/dist/tarantoolctl.in
> index 507ebe8bf..4c7dfa2f1 100755
> --- a/extra/dist/tarantoolctl.in
> +++ b/extra/dist/tarantoolctl.in
> @@ -527,6 +527,13 @@ local function start()
>          end
>          os.exit(1)
>      end
> +    local old_call = getmetatable(box.cfg).__call
> +    getmetatable(box.cfg).__call = function(old_cfg, cfg)
> +        if old_cfg.pid_file ~= nil and cfg ~= nil and cfg.pid_file ~= nil
> then +            cfg.pid_file = old_cfg.pid_file
> +        end
> +        old_call(old_cfg, cfg)
> +    end
>      return 0
>  end
> 
> diff --git a/test/box/cfg.result b/test/box/cfg.result
> index cda7aa0d3..a2df83310 100644
> --- a/test/box/cfg.result
> +++ b/test/box/cfg.result
> @@ -365,6 +365,36 @@ test_run:cmd("cleanup server cfg_tester4")
>  - true
>  ...
>  ---------------------------------------------------------------------------
> ----- +-- Check fix for pid_file option overwritten by tarantoolctl
> +---------------------------------------------------------------------------
> ----- +test_run:cmd('create server cfg_tester5 with script =
> "box/lua/cfg_test1.lua"') +---
> +- true
> +...
> +test_run:cmd("start server cfg_tester5")
> +---
> +- true
> +...
> +test_run:cmd('switch cfg_tester5')
> +---
> +- true
> +...
> +box.cfg{pid_file = "current.pid"}
> +---
> +...
> +test_run:cmd("switch default")
> +---
> +- true
> +...
> +test_run:cmd("stop server cfg_tester5")
> +---
> +- true
> +...
> +test_run:cmd("cleanup server cfg_tester5")
> +---
> +- true
> +...
> +---------------------------------------------------------------------------
> ----- -- Check that 'vinyl_dir' cfg option is not checked as long as
>  -- there is no vinyl indexes (issue #2664)
>  ---------------------------------------------------------------------------
> ----- diff --git a/test/box/cfg.test.lua b/test/box/cfg.test.lua
> index dbb463025..712a165bb 100644
> --- a/test/box/cfg.test.lua
> +++ b/test/box/cfg.test.lua
> @@ -69,6 +69,18 @@ test_run:cmd("switch default")
>  test_run:cmd("stop server cfg_tester4")
>  test_run:cmd("cleanup server cfg_tester4")
> 
> +---------------------------------------------------------------------------
> ----- +-- Check fix for pid_file option overwritten by tarantoolctl
> +---------------------------------------------------------------------------
> ----- +
> +test_run:cmd('create server cfg_tester5 with script =
> "box/lua/cfg_test1.lua"') +test_run:cmd("start server cfg_tester5")
> +test_run:cmd('switch cfg_tester5')
> +box.cfg{pid_file = "current.pid"}
> +test_run:cmd("switch default")
> +test_run:cmd("stop server cfg_tester5")
> +test_run:cmd("cleanup server cfg_tester5")
> +
>  ---------------------------------------------------------------------------
> ----- -- Check that 'vinyl_dir' cfg option is not checked as long as
>  -- there is no vinyl indexes (issue #2664)


[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 488 bytes --]